Merge pull request #975 from koic/allow_create_table_with_timestamps_for_id_false

[Fix #34] Allow `CreateTableWithTimestamps` when using `id: false` and not include `timestamps`

Author: koic

changelog/change_allow_create_table_with_timestamps_for_id_false.md

@@ -0,0 +1 @@
+* [#34](https://github.com/rubocop/rubocop-rails/issues/34): Allow `CreateTableWithTimestamps` when using `id: false` and not include `timestamps`. ([@koic][])

lib/rubocop/cop/rails/create_table_with_timestamps.rb

@@ -3,10 +3,12 @@
 module RuboCop
   module Cop
     module Rails
-      # Checks the migration for which timestamps are not included
-      # when creating a new table.
+      # Checks the migration for which timestamps are not included when creating a new table.
       # In many cases, timestamps are useful information and should be added.
       #
+      # NOTE: Allow `timestamps` not written when `id: false` because this emphasizes respecting
+      # user's editing intentions.
+      #
       # @example
       #   # bad
       #   create_table :users
@@ -40,12 +42,23 @@ module Rails
       #
       #     t.datetime :updated_at, default: -> { 'CURRENT_TIMESTAMP' }
       #   end
+      #
+      #   # good
+      #   create_table :users, articles, id: false do |t|
+      #     t.integer :user_id
+      #     t.integer :article_id
+      #   end
+      #
       class CreateTableWithTimestamps < Base
         include ActiveRecordMigrationsHelper
 
         MSG = 'Add timestamps when creating a new table.'
         RESTRICT_ON_SEND = %i[create_table].freeze
 
+        def_node_search :use_id_false_option?, <<~PATTERN
+          (pair (sym :id) (false))
+        PATTERN
+
         def_node_matcher :create_table_with_timestamps_proc?, <<~PATTERN
           (send nil? :create_table (sym _) ... (block-pass (sym :timestamps)))
         PATTERN
@@ -61,7 +74,7 @@ class CreateTableWithTimestamps < Base
         PATTERN
 
         def on_send(node)
-          return unless node.command?(:create_table)
+          return if !node.command?(:create_table) || use_id_false_option?(node)
 
           parent = node.parent
 

spec/rubocop/cop/rails/create_table_with_timestamps_spec.rb

@@ -108,4 +108,13 @@
       end
     RUBY
   end
+
+  it 'does not register an offense when using `id: false` option and not including `timestamps` in block' do
+    expect_no_offenses(<<~RUBY)
+      create_table :users, :articles, id: false do |t|
+        t.integer :user_id
+        t.integer :article_id
+      end
+    RUBY
+  end
 end