rubocop-rails 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492db5e3433993952c5b4b1df25b1a5b1a43531603eee5295d2c48f8d705b2c3
-  data.tar.gz: 33d65e499186e463cf38b03397510fded02216053078289c639e80077c731b50
+  metadata.gz: f18a288648626076787a00773149df97edce3b5330a5dc650cf662af46214bd5
+  data.tar.gz: f945d031d0a5bc98eb0af95a6cdf8e931cb5a469a1c1ced6ab11c1fb20f09bb5
 SHA512:
-  metadata.gz: 61cede5d16b9e4ec2451035108c7bf9e51ddf257ae2bc637d57827bc6eb16d4cb6e3408535ed4b47e39dbccbbc20ff881a076847e5e541980479ecb8867f10bb
-  data.tar.gz: e80b95b67271d8e7708a0da90550afe30678dfb52ca20edd4e094ef21f414759ce5e09f141f83e34f9f0af0a3bb10d23982ca70e531ee57f88e1ffecad44d15c
+  metadata.gz: 24f03fcf8cd683c5ed3e2afc9243f113afaa8641fc5cbd938d5d2ff916b7eeed95a994b69b48509b20618341c5b5c39286bde009f1dc5b369f94dc249a65b148
+  data.tar.gz: 57d3fff4181c71750d0eccdde094607ad63f79b7a6b273f698224dcc687a707879df82a264df063b4ac8f133fff3f4fe23dfcb820b4d2863cbae6792c6e38906

data/config/default.yml

@@ -9,6 +9,9 @@ AllCops:
   # application.  If neither of those files exist, RuboCop will use Rails 5.0
   # as the default.
   TargetRailsVersion: ~
+  # When specifying style guide URLs, any paths and/or fragments will be
+  # evaluated relative to the base URL.
+  StyleGuideBaseURL: https://rails.rubystyle.guide
 
 Rails/ActionFilter:
   Description: 'Enforces consistent use of action filter methods.'
@@ -28,6 +31,7 @@ Rails/ActiveRecordAliases:
                   Use `update!` instead of `update_attributes!`.
   Enabled: true
   VersionAdded: '0.53'
+  SafeAutoCorrect: false
 
 Rails/ActiveRecordOverride:
   Description: >-
@@ -136,12 +140,20 @@ Rails/DelegateAllowBlank:
 
 Rails/DynamicFindBy:
   Description: 'Use `find_by` instead of dynamic `find_by_*`.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#find_by'
+  StyleGuide: '#find_by'
   Enabled: true
   VersionAdded: '0.44'
   Whitelist:
     - find_by_sql
 
+Rails/EnumHash:
+  Description: 'Prefer hash syntax over array syntax when defining enums.'
+  StyleGuide: '#enums'
+  Enabled: true
+  VersionAdded: '2.3'
+  Include:
+    - app/models/**/*.rb
+
 Rails/EnumUniqueness:
   Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
   Enabled: true
@@ -180,7 +192,7 @@ Rails/FilePath:
 
 Rails/FindBy:
   Description: 'Prefer find_by over where.first.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#find_by'
+  StyleGuide: '#find_by'
   Enabled: true
   VersionAdded: '0.30'
   Include:
@@ -188,7 +200,7 @@ Rails/FindBy:
 
 Rails/FindEach:
   Description: 'Prefer all.find_each over all.find.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#find-each'
+  StyleGuide: '#find-each'
   Enabled: true
   VersionAdded: '0.30'
   Include:
@@ -196,7 +208,7 @@ Rails/FindEach:
 
 Rails/HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#has-many-through'
+  StyleGuide: '#has-many-through'
   Enabled: true
   VersionAdded: '0.12'
   Include:
@@ -204,7 +216,7 @@ Rails/HasAndBelongsToMany:
 
 Rails/HasManyOrHasOneDependent:
   Description: 'Define the dependent option to the has_many and has_one associations.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#has_many-has_one-dependent-option'
+  StyleGuide: '#has_many-has_one-dependent-option'
   Enabled: true
   VersionAdded: '0.50'
   Include:
@@ -251,7 +263,7 @@ Rails/InverseOf:
 
 Rails/LexicallyScopedActionFilter:
   Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the controller."
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#lexically-scoped-action-filter'
+  StyleGuide: '#lexically-scoped-action-filter'
   Enabled: true
   Safe: false
   VersionAdded: '0.52'
@@ -316,7 +328,7 @@ Rails/ReadWriteAttribute:
   Description: >-
                  Checks for read_attribute(:attr) and
                  write_attribute(:attr, val).
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#read-attribute'
+  StyleGuide: '#read-attribute'
   Enabled: true
   VersionAdded: '0.20'
   VersionChanged: '0.29'
@@ -367,7 +379,7 @@ Rails/RequestReferer:
 
 Rails/ReversibleMigration:
   Description: 'Checks whether the change method of the migration file is reversible.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#reversible-migration'
+  StyleGuide: '#reversible-migration'
   Reference: 'https://api.rubyonrails.org/classes/ActiveRecord/Migration/CommandRecorder.html'
   Enabled: true
   VersionAdded: '0.47'
@@ -386,12 +398,13 @@ Rails/SafeNavigation:
 
 Rails/SaveBang:
   Description: 'Identifies possible cases where Active Record save! or related should be used.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#save-bang'
+  StyleGuide: '#save-bang'
   Enabled: false
   VersionAdded: '0.42'
   VersionChanged: '0.59'
   AllowImplicitReturn: true
   AllowedReceivers: []
+  SafeAutoCorrect: false
 
 Rails/ScopeArgs:
   Description: 'Checks the arguments of ActiveRecord scopes.'
@@ -424,7 +437,7 @@ Rails/SkipsModelValidations:
 
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
-  StyleGuide: 'https://github.com/rubocop-hq/rails-style-guide#time'
+  StyleGuide: '#time'
   Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
   Safe: false

data/lib/rubocop/cop/rails/dynamic_find_by.rb

@@ -5,7 +5,7 @@ module RuboCop
     module Rails
       # This cop checks dynamic `find_by_*` methods.
       # Use `find_by` instead of dynamic method.
-      # See. https://github.com/rubocop-hq/rails-style-guide#find_by
+      # See. https://rails.rubystyle.guide#find_by
       #
       # @example
       #   # bad

data/lib/rubocop/cop/rails/enum_hash.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop looks for enums written with array syntax.
+      #
+      # When using array syntax, adding an element in a
+      # position other than the last causes all previous
+      # definitions to shift. Explicitly specifying the
+      # value for each key prevents this from happening.
+      #
+      # @example
+      #   # bad
+      #   enum status: [:active, :archived]
+      #
+      #   # good
+      #   enum status: { active: 0, archived: 1 }
+      #
+      class EnumHash < Cop
+        MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. '\
+              'Use hash syntax instead.'
+
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash $...))
+        PATTERN
+
+        def_node_matcher :array_pair?, <<~PATTERN
+          (pair $_ $array)
+        PATTERN
+
+        def on_send(node)
+          enum?(node) do |pairs|
+            pairs.each do |pair|
+              key, array = array_pair?(pair)
+              next unless key
+
+              add_offense(array, message: format(MSG, enum: enum_name(key)))
+            end
+          end
+        end
+
+        def autocorrect(node)
+          range = node.loc.expression
+          hash = node
+                 .children
+                 .each_with_index
+                 .map { |elem, index| [elem.children.first, index] }.to_h
+
+          ->(corrector) { corrector.replace(range, hash.to_s) }
+        end
+
+        private
+
+        def enum_name(key)
+          case key.type
+          when :sym, :str
+            key.value
+          else
+            key.source
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/enum_uniqueness.rb

@@ -23,22 +23,42 @@ module RuboCop
         MSG = 'Duplicate value `%<value>s` found in `%<enum>s` ' \
               'enum declaration.'
 
-        def_node_matcher :enum_declaration, <<-PATTERN
-          (send nil? :enum (hash (pair (_ $_) ${array hash})))
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash $...))
+        PATTERN
+
+        def_node_matcher :enum_values, <<~PATTERN
+          (pair $_ ${array hash})
         PATTERN
 
         def on_send(node)
-          enum_declaration(node) do |name, args|
-            items = args.values
+          enum?(node) do |pairs|
+            pairs.each do |pair|
+              enum_values(pair) do |key, args|
+                items = args.values
 
-            return unless duplicates?(items)
+                next unless duplicates?(items)
 
-            consecutive_duplicates(items).each do |item|
-              add_offense(item, message: format(MSG, value: item.source,
-                                                     enum: name))
+                consecutive_duplicates(items).each do |item|
+                  add_offense(item, message: format(
+                    MSG, value: item.source, enum: enum_name(key)
+                  ))
+                end
+              end
             end
           end
         end
+
+        private
+
+        def enum_name(key)
+          case key.type
+          when :sym, :str
+            key.value
+          else
+            key.source
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/rails/save_bang.rb

@@ -8,6 +8,7 @@ module RuboCop
       # save and an exception is better than unhandled failure.
       #
       # This will allow:
+      #
       # - update or save calls, assigned to a variable,
       #   or used as a condition in an if/unless/case statement.
       # - create calls, assigned to a variable that then has a
@@ -107,7 +108,7 @@ module RuboCop
         CREATE_CONDITIONAL_MSG = '`%<current>s` returns a model which is ' \
                                  'always truthy.'
 
-        CREATE_PERSIST_METHODS = %i[create
+        CREATE_PERSIST_METHODS = %i[create create_or_find_by
                                     first_or_create find_or_create_by].freeze
         MODIFY_PERSIST_METHODS = %i[save
                                     update update_attributes destroy].freeze
@@ -139,9 +140,9 @@ module RuboCop
         def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
           return unless persist_method?(node)
           return if return_value_assigned?(node)
+          return if implicit_return?(node)
           return if check_used_in_conditional(node)
           return if argument?(node)
-          return if implicit_return?(node)
           return if explicit_return?(node)
 
           add_offense_for_node(node)
@@ -276,10 +277,18 @@ module RuboCop
           return false unless cop_config['AllowImplicitReturn']
 
           node = assignable_node(node)
-          method = node.parent
+          method, sibling_index = find_method_with_sibling_index(node.parent)
           return unless method && (method.def_type? || method.block_type?)
 
-          method.children.size == node.sibling_index + 1
+          method.children.size == node.sibling_index + sibling_index
+        end
+
+        def find_method_with_sibling_index(node, sibling_index = 1)
+          return node, sibling_index unless node&.or_type?
+
+          sibling_index += 1
+
+          find_method_with_sibling_index(node.parent, sibling_index)
         end
 
         def argument?(node)

data/lib/rubocop/cop/rails/time_zone.rb

@@ -5,7 +5,7 @@ module RuboCop
     module Rails
       # This cop checks for the use of Time methods without zone.
       #
-      # Built on top of Ruby on Rails style guide (https://github.com/rubocop-hq/rails-style-guide#time)
+      # Built on top of Ruby on Rails style guide (https://rails.rubystyle.guide#time)
       # and the article http://danilenko.org/2012/7/6/rails_timezones/
       #
       # Two styles are supported for this cop. When EnforcedStyle is 'strict'

data/lib/rubocop/cop/rails_cops.rb

@@ -17,6 +17,7 @@ require_relative 'rails/date'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
 require_relative 'rails/dynamic_find_by'
+require_relative 'rails/enum_hash'
 require_relative 'rails/enum_uniqueness'
 require_relative 'rails/environment_comparison'
 require_relative 'rails/exit'

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.2.1'
+      STRING = '2.3.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -71,6 +71,7 @@ files:
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.rb
 - lib/rubocop/cop/rails/dynamic_find_by.rb
+- lib/rubocop/cop/rails/enum_hash.rb
 - lib/rubocop/cop/rails/enum_uniqueness.rb
 - lib/rubocop/cop/rails/environment_comparison.rb
 - lib/rubocop/cop/rails/exit.rb