Merge pull request #999 from r7kamura/date-autocorrect

Add autocorrection for `Rails/Date`

Author: koic

changelog/new_add_autocorrection_for_rails_date.md

@@ -0,0 +1 @@
+* [#999](https://github.com/rubocop/rubocop-rails/pull/999): Add autocorrection for `Rails/Date`. ([@r7kamura][])

config/default.yml

@@ -301,6 +301,7 @@ Rails/Date:
                   Checks the correct usage of date aware methods,
                   such as Date.today, Date.current etc.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.30'
   VersionChanged: '2.11'
   # The value `strict` disallows usage of `Date.today`, `Date.current`,

lib/rubocop/cop/rails/date.rb

@@ -22,6 +22,9 @@ module Rails
       # And you can set a warning for `to_time` with `AllowToTime: false`.
       # `AllowToTime` is `true` by default to prevent false positive on `DateTime` object.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may change handling time.
+      #
       # @example EnforcedStyle: flexible (default)
       #   # bad
       #   Date.today
@@ -51,6 +54,8 @@ module Rails
       #   # bad
       #   date.to_time
       class Date < Base
+        extend AutoCorrector
+
         include ConfigurableEnforcedStyle
 
         MSG = 'Do not use `Date.%<method_called>s` without zone. Use `Time.zone.%<day>s` instead.'
@@ -92,7 +97,9 @@ def check_deprecated_methods(node)
 
             message = format(DEPRECATED_MSG, deprecated: method[:deprecated], relevant: method[:relevant])
 
-            add_offense(node.loc.selector, message: message)
+            add_offense(node.loc.selector, message: message) do |corrector|
+              corrector.replace(node.loc.selector, method[:relevant].to_s)
+            end
           end
         end
 
@@ -108,7 +115,9 @@ def check_date_node(node)
 
           message = format(MSG, method_called: method_name, day: day)
 
-          add_offense(node.loc.selector, message: message)
+          add_offense(node.loc.selector, message: message) do |corrector|
+            corrector.replace(node.receiver.loc.name, 'Time.zone')
+          end
         end
 
         def extract_method_chain(node)

spec/rubocop/cop/rails/date_spec.rb

@@ -54,6 +54,10 @@
           date.to_time_in_current_zone
                ^^^^^^^^^^^^^^^^^^^^^^^ `to_time_in_current_zone` is deprecated. Use `in_time_zone` instead.
         RUBY
+
+        expect_correction(<<~RUBY)
+          date.in_time_zone
+        RUBY
       end
 
       context 'when using safe navigation operator' do
@@ -62,6 +66,10 @@
             date&.to_time_in_current_zone
                   ^^^^^^^^^^^^^^^^^^^^^^^ `to_time_in_current_zone` is deprecated. Use `in_time_zone` instead.
           RUBY
+
+          expect_correction(<<~RUBY)
+            date&.in_time_zone
+          RUBY
         end
       end
 
@@ -137,6 +145,8 @@
             date.to_time
                  ^^^^^^^ Do not use `to_time` on Date objects, because they know nothing about the time zone in use.
           RUBY
+
+          expect_no_corrections
         end
 
         context 'when using safe navigation operator' do
@@ -145,6 +155,8 @@
               date&.to_time
                     ^^^^^^^ Do not use `to_time` on Date objects, because they know nothing about the time zone in use.
             RUBY
+
+            expect_no_corrections
           end
         end
 
@@ -162,6 +174,8 @@
               "2016-07-12 14:36:31".to_time(:utc)
                                     ^^^^^^^ Do not use `to_time` on Date objects, because they know nothing about the time zone in use.
             RUBY
+
+            expect_no_corrections
           end
         end
 
@@ -189,6 +203,10 @@
         "2016-07-12 14:36:31".to_time_in_current_zone
                               ^^^^^^^^^^^^^^^^^^^^^^^ `to_time_in_current_zone` is deprecated. Use `in_time_zone` instead.
       RUBY
+
+      expect_correction(<<~RUBY)
+        "2016-07-12 14:36:31".in_time_zone
+      RUBY
     end
   end
 
@@ -206,6 +224,21 @@
         Date.today
              ^^^^^ Do not use `Date.today` without zone. Use `Time.zone.today` instead.
       RUBY
+
+      expect_correction(<<~RUBY)
+        Time.zone.today
+      RUBY
+    end
+
+    it 'registers an offense for ::Date.today' do
+      expect_offense(<<~RUBY)
+        ::Date.today
+               ^^^^^ Do not use `Date.today` without zone. Use `Time.zone.today` instead.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        ::Time.zone.today
+      RUBY
     end
 
     RuboCop::Cop::Rails::TimeZone::ACCEPTED_METHODS.each do |a_method|
@@ -219,6 +252,10 @@
         "2016-07-12 14:36:31".to_time_in_current_zone
                               ^^^^^^^^^^^^^^^^^^^^^^^ `to_time_in_current_zone` is deprecated. Use `in_time_zone` instead.
       RUBY
+
+      expect_correction(<<~RUBY)
+        "2016-07-12 14:36:31".in_time_zone
+      RUBY
     end
   end
 end