rubocop-rails 2.14.2 → 2.15.2

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for enums written with array syntax.
+      # Looks for enums written with array syntax.
       #
       # When using array syntax, adding an element in a
       # position other than the last causes all previous
@@ -20,8 +20,7 @@ module RuboCop
       class EnumHash < Base
         extend AutoCorrector
 
-        MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. '\
-              'Use hash syntax instead.'
+        MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. Use hash syntax instead.'
         RESTRICT_ON_SEND = %i[enum].freeze
 
         def_node_matcher :enum?, <<~PATTERN

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for duplicate values in enum declarations.
+      # Looks for duplicate values in enum declarations.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that Rails.env is compared using `.production?`-like
+      # Checks that Rails.env is compared using `.production?`-like
       # methods instead of equality against a string or symbol.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for direct access to environment variables through the
+      # Looks for direct access to environment variables through the
       # `ENV` variable within the application code. This can lead to runtime
       # errors due to misconfiguration that could have been discovered at boot
       # time if the environment variables were loaded as part of initialization

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that `exit` calls are not used within a rails app.
+      # Enforces that `exit` calls are not used within a rails app.
       # Valid options are instead to raise an error, break, return, or some
       # other form of stopping execution of current request.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for expanded date range. It only compatible `..` range is targeted.
+      # Checks for expanded date range. It only compatible `..` range is targeted.
       # Incompatible `...` range is ignored.
       #
       # @example
@@ -29,14 +29,6 @@ module RuboCop
 
         minimum_target_rails_version 5.1
 
-        def_node_matcher :expanded_date_range, <<~PATTERN
-          (irange
-            (send
-              $_ {:beginning_of_day :beginning_of_week :beginning_of_month :beginning_of_quarter :beginning_of_year})
-            (send
-              $_ {:end_of_day :end_of_week :end_of_month :end_of_quarter :end_of_year}))
-        PATTERN
-
         PREFERRED_METHODS = {
           beginning_of_day: 'all_day',
           beginning_of_week: 'all_week',
@@ -54,31 +46,55 @@ module RuboCop
         }.freeze
 
         def on_irange(node)
-          return unless expanded_date_range(node)
-
           begin_node = node.begin
           end_node = node.end
-          return unless same_receiver?(begin_node, end_node)
-
-          beginning_method = begin_node.method_name
-          end_method = end_node.method_name
-          return unless use_mapped_methods?(beginning_method, end_method)
+          return if allow?(begin_node, end_node)
 
-          preferred_method = "#{begin_node.receiver.source}.#{PREFERRED_METHODS[beginning_method]}"
+          preferred_method = preferred_method(begin_node)
+          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one?
+            return unless same_argument?(begin_node, end_node)
 
-          add_offense(node, message: format(MSG, preferred_method: preferred_method)) do |corrector|
-            corrector.replace(node, preferred_method)
+            preferred_method << "(#{begin_node.first_argument.source})"
+          elsif any_arguments?(begin_node, end_node)
+            return
           end
+
+          register_offense(node, preferred_method)
         end
 
         private
 
-        def same_receiver?(begin_node, end_node)
-          begin_node.receiver.source == end_node.receiver.source
+        def allow?(begin_node, end_node)
+          return true unless (begin_source = receiver_source(begin_node))
+          return true unless (end_source = receiver_source(end_node))
+
+          begin_source != end_source || MAPPED_DATE_RANGE_METHODS[begin_node.method_name] != end_node.method_name
+        end
+
+        def receiver_source(node)
+          return if !node&.send_type? || node.receiver.nil?
+
+          node.receiver.source
         end
 
-        def use_mapped_methods?(beginning_method, end_method)
-          MAPPED_DATE_RANGE_METHODS[beginning_method] == end_method
+        def same_argument?(begin_node, end_node)
+          begin_node.first_argument.source == end_node.first_argument.source
+        end
+
+        def preferred_method(begin_node)
+          +"#{begin_node.receiver.source}.#{PREFERRED_METHODS[begin_node.method_name]}"
+        end
+
+        def any_arguments?(begin_node, end_node)
+          begin_node.arguments.any? || end_node.arguments.any?
+        end
+
+        def register_offense(node, preferred_method)
+          message = format(MSG, preferred_method: preferred_method)
+
+          add_offense(node, message: message) do |corrector|
+            corrector.replace(node, preferred_method)
+          end
         end
       end
     end

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

@@ -3,27 +3,27 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of file path joining process
+      # Identifies usages of file path joining process
       # to use `Rails.root.join` clause. It is used to add uniformity when
       # joining paths.
       #
-      # @example EnforcedStyle: arguments
+      # @example EnforcedStyle: slashes (default)
       #   # bad
-      #   Rails.root.join('app/models/goober')
+      #   Rails.root.join('app', 'models', 'goober')
       #   File.join(Rails.root, 'app/models/goober')
       #   "#{Rails.root}/app/models/goober"
       #
       #   # good
-      #   Rails.root.join('app', 'models', 'goober')
+      #   Rails.root.join('app/models/goober')
       #
-      # @example EnforcedStyle: slashes (default)
+      # @example EnforcedStyle: arguments
       #   # bad
-      #   Rails.root.join('app', 'models', 'goober')
+      #   Rails.root.join('app/models/goober')
       #   File.join(Rails.root, 'app/models/goober')
       #   "#{Rails.root}/app/models/goober"
       #
       #   # good
-      #   Rails.root.join('app/models/goober')
+      #   Rails.root.join('app', 'models', 'goober')
       #
       class FilePath < Base
         include ConfigurableEnforcedStyle
@@ -48,8 +48,11 @@ module RuboCop
         def on_dstr(node)
           return unless rails_root_nodes?(node)
           return unless node.children.last.str_type?
-          return unless node.children.last.source.start_with?('.') ||
-                        node.children.last.source.include?(File::SEPARATOR)
+
+          last_child_source = node.children.last.source
+          return unless last_child_source.start_with?('.') ||
+                        last_child_source.include?(File::SEPARATOR)
+          return if last_child_source.start_with?(':')
 
           register_offense(node)
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of `where.take` and change them to use `find_by` instead.
+      # Identifies usages of `where.take` and change them to use `find_by` instead.
       #
       # And `where(...).first` can return different results from `find_by`.
       # (They order records differently, so the "first" record can be different.)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that `ActiveRecord#find` is used instead of
+      # Enforces that `ActiveRecord#find` is used instead of
       # `where.take!`, `find_by!`, and `find_by_id!` to retrieve a single record
       # by primary key when you expect it to be found.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of `all.each` and
+      # Identifies usages of `all.each` and
       # change them to use `all.find_each` instead.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of the has_and_belongs_to_many macro.
+      # Checks for the use of the has_and_belongs_to_many macro.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for `has_many` or `has_one` associations that don't
+      # Looks for `has_many` or `has_one` associations that don't
       # specify a `:dependent` option.
       #
       # It doesn't register an offense if `:through` or `dependent: nil`
@@ -116,7 +116,7 @@ module RuboCop
         def valid_options?(options)
           return false if options.nil?
 
-          options = options.first.children.first.pairs if options.first.kwsplat_type?
+          options = extract_option_if_kwsplat(options)
 
           return true unless options
           return true if options.any? do |o|
@@ -126,6 +126,14 @@ module RuboCop
           false
         end
 
+        def extract_option_if_kwsplat(options)
+          if options.first.kwsplat_type? && options.first.children.first.hash_type?
+            return options.first.children.first.pairs
+          end
+
+          options
+        end
+
         def active_resource?(node)
           return false if node.nil?
 

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

@@ -3,14 +3,14 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for use of the helper methods which reference
+      # Checks for use of the helper methods which reference
       # instance variables.
       #
       # Relying on instance variables makes it difficult to re-use helper
       # methods.
       #
       # If it seems awkward to explicitly pass in each dependent
-      # variable, consider moving the behaviour elsewhere, for
+      # variable, consider moving the behavior elsewhere, for
       # example to a model, decorator or presenter.
       #
       # Provided that a class inherits `ActionView::Helpers::FormBuilder`,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of http methods like `get`, `post`,
+      # Identifies usages of http methods like `get`, `post`,
       # `put`, `patch` without the usage of keyword arguments in your tests and
       # change them to use keyword args. This cop only applies to Rails >= 5.
       # If you are running Rails < 5 you should disable the

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for places where I18n "lazy" lookup can be used.
+      # Checks for places where I18n "lazy" lookup can be used.
       #
       # @example
       #   # en.yml

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of `I18n.locale=` method.
+      # Checks for the use of `I18n.locale=` method.
       #
       # The `locale` attribute persists for the rest of the Ruby runtime, potentially causing
       # unexpected behavior at a later time.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that `if` and `only` (or `except`) are not used together
+      # Checks that `if` and `only` (or `except`) are not used together
       # as options of `skip_*` action filter.
       #
       # The `if` option will be ignored when `if` and `only` are used together.
@@ -80,7 +80,7 @@ module RuboCop
         def options_hash(options)
           options.pairs
                  .select { |pair| pair.key.sym_type? }
-                 .map { |pair| [pair.key.value, pair] }.to_h
+                 .to_h { |pair| [pair.key.value, pair] }
         end
 
         def if_and_only?(options)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for uses of `each_with_object({}) { ... }`,
+      # Looks for uses of `each_with_object({}) { ... }`,
       # `map { ... }.to_h`, and `Hash[map { ... }]` that are transforming
       # an enumerable into a hash where the values are the original elements.
       # Rails provides the `index_by` method for this purpose.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for uses of `each_with_object({}) { ... }`,
+      # Looks for uses of `each_with_object({}) { ... }`,
       # `map { ... }.to_h`, and `Hash[map { ... }]` that are transforming
       # an enumerable into a hash where the keys are the original elements.
       # Rails provides the `index_with` method for this purpose.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that Active Support's `inquiry` method is not used.
+      # Checks that Active Support's `inquiry` method is not used.
       #
       # @example
       #   # bad - String#inquiry

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for has_(one|many) and belongs_to associations where
+      # Looks for has_(one|many) and belongs_to associations where
       # Active Record can't automatically determine the inverse association
       # because of a scope or the options used. Using the blog with order scope
       # example below, traversing the a Blog's association in both directions

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that methods specified in the filter's `only` or
+      # Checks that methods specified in the filter's `only` or
       # `except` options are defined within the same class or module.
       #
       # @safety
@@ -12,7 +12,7 @@ module RuboCop
       #   methods that are defined in other classes or modules, you should
       #   define the filter in that class or module.
       #
-      #   If you rely on behaviour defined in the superclass actions, you must
+      #   If you rely on behavior defined in the superclass actions, you must
       #   remember to invoke `super` in the subclass actions.
       #
       # @example
@@ -71,7 +71,7 @@ module RuboCop
       #   class ArticlesController < ContentController
       #     before_action :load_article, only: [:update]
       #
-      #     # the cop requires this method, but it relies on behaviour defined
+      #     # the cop requires this method, but it relies on behavior defined
       #     # in the superclass, so needs to invoke `super`
       #     def update
       #       super

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for calls to `link_to` that contain a
+      # Checks for calls to `link_to` that contain a
       # `target: '_blank'` but no `rel: 'noopener'`. This can be a security
       # risk as the loaded page will have control over the previous page
       # and could change its location for phishing purposes.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that mailer names end with `Mailer` suffix.
+      # Enforces that mailer names end with `Mailer` suffix.
       #
       # Without the `Mailer` suffix it isn't immediately apparent what's a mailer
       # and which views are related to the mailer.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where defining routes with `match`
+      # Identifies places where defining routes with `match`
       # can be replaced with a specific HTTP method.
       #
       # Don't use `match` to define any routes unless there is a need to map multiple request types

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop makes sure that each migration file defines a migration class
+      # Makes sure that each migration file defines a migration class
       # whose name matches the file name.
       # (e.g. `20220224111111_create_users.rb` should define `CreateUsers` class.)
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `collection.exclude?(obj)`
+      # Enforces the use of `collection.exclude?(obj)`
       # over `!collection.include?(obj)`.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for add_column call with NOT NULL constraint
+      # Checks for add_column call with NOT NULL constraint
       # in migration file.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for places where ordering by `id` column is used.
+      # Checks for places where ordering by `id` column is used.
       #
       # Don't use the `id` column for ordering. The sequence of ids is not guaranteed
       # to be in any particular order, despite often (incidentally) being chronological.
@@ -23,8 +23,7 @@ module RuboCop
       class OrderById < Base
         include RangeHelp
 
-        MSG = 'Do not use the `id` column for ordering. '\
-              'Use a timestamp column to order chronologically.'
+        MSG = 'Do not use the `id` column for ordering. Use a timestamp column to order chronologically.'
         RESTRICT_ON_SEND = %i[order].freeze
 
         def_node_matcher :order_by_id?, <<~PATTERN

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of output calls like puts and print
+      # Checks for the use of output calls like puts and print
       #
       # @safety
       #   This cop's autocorrection is unsafe because depending on the Rails log level configuration,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of output safety calls like `html_safe`,
+      # Checks for the use of output safety calls like `html_safe`,
       # `raw`, and `safe_concat`. These methods do not escape content. They
       # simply return a SafeBuffer containing the content as is. Instead,
       # use `safe_join` to join content and escape it and concat to

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `pick` over `pluck(...).first`.
+      # Enforces the use of `pick` over `pluck(...).first`.
       #
       # Using `pluck` followed by `first` creates an intermediate array, which
       # `pick` avoids. When called on an Active Record relation, `pick` adds a

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `pluck` over `map`.
+      # Enforces the use of `pluck` over `map`.
       #
       # `pluck` can be used instead of `map` to extract a single key from each
       # element in an enumerable. When called on an Active Record relation, it

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `ids` over `pluck(:id)` and `pluck(primary_key)`.
+      # Enforces the use of `ids` over `pluck(:id)` and `pluck(primary_key)`.
       #
       # @safety
       #   This cop is unsafe if the receiver object is not an Active Record object.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where `pluck` is used in `where` query methods
+      # Identifies places where `pluck` is used in `where` query methods
       # and can be replaced with `select`.
       #
       # Since `pluck` is an eager method and hits the database immediately,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for correct grammar when using ActiveSupport's
+      # Checks for correct grammar when using ActiveSupport's
       # core extensions to the numeric classes.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks code that can be written more easily using
+      # Checks code that can be written more easily using
       # `Object#presence` defined by Active Support.
       #
       # @example

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

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for code that can be written with simpler conditionals
+      # Checks for code that can be written with simpler conditionals
       # using `Object#present?` defined by Active Support.
       #
       # Interaction with `Style/UnlessElse`:
       # The configuration of `NotBlank` will not produce an offense in the
       # context of `unless else` if `Style/UnlessElse` is inabled. This is
-      # to prevent interference between the auto-correction of the two cops.
+      # to prevent interference between the autocorrection of the two cops.
       #
       # @example NotNilAndNotEmpty: true (default)
       #   # Converts usages of `!nil? && !empty?` to `present?`

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for Rake tasks without the `:environment` task
+      # Checks for Rake tasks without the `:environment` task
       # dependency. The `:environment` task loads application code for other
       # Rake tasks. Without it, tasks cannot make use of application code like
       # models.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of the `read_attribute` or `write_attribute`
+      # Checks for the use of the `read_attribute` or `write_attribute`
       # methods and recommends square brackets instead.
       #
       # If an attribute is missing from the instance (for example, when

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop detects cases where the `:foreign_key` option on associations
+      # Detects cases where the `:foreign_key` option on associations
       # is redundant.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for redundant receiver in `with_options`.
+      # Checks for redundant receiver in `with_options`.
       # Receiver is implicit from Rails 4.2 or higher.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for redundant `travel_back` calls.
+      # Checks for redundant `travel_back` calls.
       # Since Rails 5.2, `travel_back` is automatically called at the end of the test.
       #
       # @example