sevencop 0.32.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99cfa839ba240b0658ca3ad2953a282fbccde556da6fc73cd3d1f4d654cd1270
-  data.tar.gz: 2956e369895d1a8062815fa8fa7599bc8ebb318a2aae7a220b314d46b41eab0a
+  metadata.gz: 2aa8a2d8e7e48840c1bfdfd2c512e4117d52c5d525663ba0d25dbfe815ca1f70
+  data.tar.gz: 9d3a6b87ee268c2dddc82b7eaaf85bc431bce6a36dfb401717986a16e4445b79
 SHA512:
-  metadata.gz: 9ee70f31ce7c10a739c451355a07cbfe2108b3890ca36c892b1b1688a616eb26f2c1d75c4f51c8c99f5c9b86a7151addf235032bccf7bfe0d6e0d8db4ae4d079
-  data.tar.gz: 2b7cc9b909aa8485d1e78be547d32ac29e408ad1d8f0916c1745be792e411fd5fcd88d172d6cdb094af8c0e18d730e65c9eb79f71eca93c9f66df8da7f0d73f5
+  metadata.gz: 14a1f39bda2b687ff9784812eb8600ce792f5bca38a7eb542f268ebb7f23b20b482ef424f50e953cd0f268fee652f787de4f556192ba479d90543521c9a955cd
+  data.tar.gz: '08a48ae20f4716f2ea593054e74c684f31e8392a70177eb9076cd4b41fde6bd800000c4655545ade7385b366cd82d7fc985bbc66c0a69d1d1220e22e3a342f5b'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.32.1)
+    sevencop (0.33.0)
       activesupport
       rubocop
 
@@ -25,7 +25,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -40,7 +40,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.38.0)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -52,7 +52,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.0)
+    rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)

data/README.md

@@ -39,7 +39,7 @@ Note that all cops are `Enabled: false` by default.
 - [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
 - [Sevencop/RailsBelongsToOptional](lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb)
 - [Sevencop/RailsDateAndTimeCalculation](lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb)
-- [Sevencop/RailsOrderField](lib/rubocop/cop/sevencop/rails_order_field.rb)
+- [Sevencop/RailsOrderFieldArelSql](lib/rubocop/cop/sevencop/rails_order_field_arel_sql.rb)
 - [Sevencop/RailsOrderFieldInOrderOf](lib/rubocop/cop/sevencop/rails_order_field_in_order_of.rb)
 - [Sevencop/RailsSpecificActionName](lib/rubocop/cop/sevencop/rails_specific_action_name.rb)
 - [Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb)

data/config/default.yml

@@ -3,26 +3,22 @@ Sevencop/AutoloadOrdered:
     Sort `autoload` in alphabetical order.
   Enabled: false
   Safe: false
-  VersionAdded: '0.12'
 
 Sevencop/ConstantBase:
   Description: |
     Avoid unnecessary `::` prefix on constant.
   Enabled: false
-  VersionAdded: '0.31'
 
 Sevencop/FactoryBotAssociationOption:
   Description: |
     Avoid redundant options on FactoryBot associations.
   Enabled: false
-  VersionAdded: '0.21'
 
 Sevencop/FactoryBotAssociationStyle:
   Description: |
     Use consistent style in FactoryBot associations.
   Enabled: false
   Safe: false
-  VersionAdded: '0.21'
   EnforcedStyle: implicit
   SupportedStyles:
     - explicit
@@ -45,68 +41,58 @@ Sevencop/HashElementOrdered:
     Sort Hash elements by key.
   Enabled: false
   Safe: false
-  VersionAdded: '0.6'
 
 Sevencop/MethodDefinitionArgumentsMultiline:
   Description: |
     Inserts new lines between method definition arguments.
   Enabled: false
-  VersionAdded: '0.11'
 
 Sevencop/MethodDefinitionInIncluded:
   Description: |
     Do not define methods in `included` blocks.
   Enabled: false
   Safe: false
-  VersionAdded: '0.19'
 
 Sevencop/MethodDefinitionOrdered:
   Description: |
     Sort method definitions in alphabetical order.
   Enabled: false
   Safe: false
-  VersionAdded: '0.14'
 
 Sevencop/MethodDefinitionKeywordArgumentOrdered:
   Description: |
     Sort method definition keyword arguments in alphabetical order.
   Enabled: false
   Safe: false
-  VersionAdded: '0.13'
 
 Sevencop/RailsBelongsToOptional:
   Description: |
     Force `belongs_to` with `optional: true` option.
   Enabled: false
   Safe: false
-  VersionAdded: '0.5'
 
 Sevencop/RailsDateAndTimeCalculation:
   Description: |
     Prefer ActiveSupport date and time helper.
   Enabled: false
   Safe: false
-  VersionAdded: '0.26'
 
-Sevencop/RailsOrderField:
+Sevencop/RailsOrderFieldArelSql:
   Description: |
     Wrap safe SQL String by `Arel.sql`.
   Enabled: false
   Safe: false
-  VersionAdded: '0.4'
 
 Sevencop/RailsOrderFieldInOrderOf:
   Description: |
-    Prefer `in_order_of` to MySQL `FIELD` function.
+    Prefer `in_order_of` to MySQL `FIELD` function if possible.
   Enabled: false
-  VersionAdded: '0.32'
+  Safe: false
 
 Sevencop/RailsSpecificActionName:
   Description: |
     Use only specific action names.
   Enabled: false
-  VersionAdded: '0.24'
-  VersionChanged: '0.29'
   ActionNames:
     - create
     - destroy
@@ -123,27 +109,23 @@ Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity:
     Specify :case_sensitivity option on use of UniquenessValidator.
   Enabled: false
   Safe: false
-  VersionAdded: '0.3'
 
 Sevencop/RailsWhereNot:
   Description: |
     Identifies passing multi-elements Hash literal to `where.not`.
   Enabled: false
   Safe: false
-  VersionAdded: '0.7'
 
 Sevencop/RequireOrdered:
   Description: |
     Sort `require` and `require_relative` in alphabetical order.
   Enabled: false
   Safe: false
-  VersionAdded: '0.16'
 
 Sevencop/RSpecDescribeHttpEndpoint:
   Description: |
     Pass HTTP endpoint identifier (e.g. `GET /users`) to top-level `describe` on request-specs.
   Enabled: false
-  VersionAdded: '0.18'
   Include:
     - spec/requests/**/*.rb
 
@@ -151,7 +133,6 @@ Sevencop/RSpecEmptyLineAfterLet:
   Description: |
     Insert empty line after `let`.
   Enabled: false
-  VersionAdded: '0.27'
   Include:
     - spec/**/*
 
@@ -159,7 +140,6 @@ Sevencop/RSpecExamplesInSameGroup:
   Description: |
     Combine examples in the same groups in the time-consuming kinds of specs.
   Enabled: false
-  VersionAdded: '0.17'
   IncludeSharedExamples: false
   Include:
     - spec/controllers/**/*
@@ -169,7 +149,6 @@ Sevencop/RSpecMemoizedHelperBlockDelimiter:
   Description: |
     Use do-end block delimiter on RSpec memoized helper.
   Enabled: false
-  VersionAdded: '0.27'
   Include:
     - spec/**/*
 
@@ -178,7 +157,6 @@ Sevencop/RSpecRailsResponseParsedBody:
     Prefer `response.parsed_body` to `JSON.parse(response.body)`.
   Enabled: false
   Safe: false
-  VersionAdded: '0.28'
   Include:
     - spec/controllers/**/*
     - spec/requests/**/*

data/lib/rubocop/cop/sevencop/autoload_ordered.rb

@@ -41,14 +41,8 @@ module RuboCop
 
           add_offense(node) do |corrector|
             swap(
-              range_by_whole_lines(
-                previous_older_sibling.location.expression,
-                include_final_newline: true
-              ),
-              range_by_whole_lines(
-                node.location.expression,
-                include_final_newline: true
-              ),
+              range_with_comments_and_lines(previous_older_sibling),
+              range_with_comments_and_lines(node),
               corrector: corrector
             )
           end

data/lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module RuboCop
   module Cop
     module Sevencop
@@ -110,42 +108,36 @@ module RuboCop
       class RailsDateAndTimeCalculation < Base
         extend AutoCorrector
 
-        CALCULATION_METHOD_NAMES = ::Set.new(
-          %i[
-            -
-            +
-          ]
-        ).freeze
-
-        COMPARISON_METHOD_NAMES = ::Set.new(
-          %i[
-            <
-            >
-            after?
-            before?
-          ]
-        ).freeze
-
-        DURATION_METHOD_NAMES = ::Set.new(
-          %i[
-            day
-            days
-            fortnight
-            fortnights
-            hour
-            hours
-            minute
-            minutes
-            month
-            months
-            second
-            seconds
-            week
-            weeks
-            year
-            years
-          ]
-        ).freeze
+        CALCULATION_METHOD_NAMES = %i[
+          -
+          +
+        ].to_set.freeze
+
+        COMPARISON_METHOD_NAMES = %i[
+          <
+          >
+          after?
+          before?
+        ].to_set.freeze
+
+        DURATION_METHOD_NAMES = %i[
+          day
+          days
+          fortnight
+          fortnights
+          hour
+          hours
+          minute
+          minutes
+          month
+          months
+          second
+          seconds
+          week
+          weeks
+          year
+          years
+        ].to_set.freeze
 
         MSG = 'Prefer ActiveSupport date and time helper.'
 

data/lib/rubocop/cop/sevencop/{rails_order_field.rb → rails_order_field_arel_sql.rb}

@@ -22,7 +22,7 @@ module RuboCop
       #   # good
       #   reorder(Arel.sql('field(id, ?)'), a)
       #
-      class RailsOrderField < Base
+      class RailsOrderFieldArelSql < Base
         extend AutoCorrector
 
         MSG = 'Wrap safe SQL String by `Arel.sql`.'

data/lib/rubocop/cop/sevencop/rails_order_field_in_order_of.rb

@@ -3,7 +3,26 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Prefer `in_order_of` to MySQL `FIELD` function.
+      # Prefer `in_order_of` to MySQL `FIELD` function if possible.
+      #
+      # @safety
+      #   This cop is unsafe because `in_order_of` also adds `WHERE` clause.
+      #
+      #   This cop's autocorrection is unsafe because in the original code the array value is interpolated as
+      #   literals on SQL query, but after its autocorrection, the value will be now passed directly to in_order_of,
+      #   which may produce different results.
+      #
+      #   For example, the following code is valid where the id column is a integer column:
+      #
+      #     ids = %w[1 2 3]
+      #     order("FIELD(id, #{ids.join(', ')})") # "FIELD(id, 1, 2, 3)"
+      #
+      #   But after its autocorrection, it will be like this:
+      #
+      #     ids = %w[1 2 3]
+      #     in_order_of(:id, ids) # We need to change this code as `ids.map(&:to_i)`.
+      #
+      #   And this code will raise an error because `ids` is not an array of Integer but an array of String.
       #
       # @example
       #   # bad
@@ -37,7 +56,7 @@ module RuboCop
           \s*
           field\(
             \s*
-            (?<column_name>\w+)
+            (?<column_name>[^,]+)
             ,\s*
           \z
         /ix.freeze
@@ -59,7 +78,7 @@ module RuboCop
           \s*
           field\(
             \s*
-            (?<column_name>\w+)
+            (?<column_name>[^,]+)
             ,\s*
             (?<values>.+)
             \s*
@@ -72,7 +91,7 @@ module RuboCop
           \z
         /ix.freeze
 
-        MSG = 'Prefer `in_order_of` to MySQL `FIELD` function.'
+        MSG = 'Prefer `in_order_of` to MySQL `FIELD` function if possible.'
 
         RESTRICT_ON_SEND = %i[
           order
@@ -84,7 +103,9 @@ module RuboCop
         def on_send(node)
           return unless bad?(node)
 
-          add_offense(node) do |corrector|
+          add_offense(
+            convert_to_autocorrected_range(node)
+          ) do |corrector|
             autocorrect(corrector, node)
           end
         end
@@ -148,17 +169,23 @@ module RuboCop
           node
         )
           corrector.replace(
-            node.location.expression.with(
-              begin_pos: node.location.selector.begin_pos
-            ),
+            convert_to_autocorrected_range(node),
             format_in_order_of(node)
           )
         end
 
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Parser::Source::Range]
+        def convert_to_autocorrected_range(node)
+          node.location.expression.with(
+            begin_pos: node.location.selector.begin_pos
+          )
+        end
+
         # @param node [RuboCop::AST::SendNode]
         # @return [String, nil]
         def extract_column_name(node)
-          if node.each_descendant(:dstr).any?
+          if search_from_arguments(node, type: :dstr).any?
             extract_column_name_from_dstr(node)
           else
             extract_column_name_from_str(node)
@@ -168,25 +195,25 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [String]
         def extract_column_name_from_dstr(node)
-          node.each_descendant(:str).first.value[REGEXP_FIELD_DSTR_HEAD, :column_name]
+          search_from_arguments(node, type: :str).first.value[REGEXP_FIELD_DSTR_HEAD, :column_name].delete('`')
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [String]
         def extract_column_name_from_str(node)
-          node.each_descendant(:str).first.value[REGEXP_FIELD_STR, :column_name]
+          search_from_arguments(node, type: :str).first.value[REGEXP_FIELD_STR, :column_name].delete('`')
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [String, nil]
         def extract_order_from_dstr(node)
-          node.each_descendant(:str).to_a.last.value[REGEXP_FIELD_DSTR_TAIL, :order]
+          search_from_arguments(node, type: :str).to_a.last.value[REGEXP_FIELD_DSTR_TAIL, :order]
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [String, nil]
         def extract_order_from_str(node)
-          node.each_descendant(:str).first.value[REGEXP_FIELD_STR, :order]
+          search_from_arguments(node, type: :str).first.value[REGEXP_FIELD_STR, :order]
         end
 
         # @param node [RuboCop::AST::SendNode]
@@ -216,7 +243,7 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [String]
         def extract_values_from_dstr(node)
-          node.each_descendant.find do |descendant|
+          search_from_arguments(node).find do |descendant|
             match_field_dstr_body?(descendant)
           end.children.first.receiver.source
         end
@@ -226,14 +253,14 @@ module RuboCop
         def extract_values_from_str(node)
           format(
             '[%<values>s]',
-            values: node.each_descendant(:str).first.value[REGEXP_FIELD_STR, :values].split(',').map(&:strip).join(', ')
+            values: search_from_arguments(node, type: :str).first.value[REGEXP_FIELD_STR, :values].split(',').map(&:strip).join(', ')
           )
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [String]
         def format_in_order_of(node)
-          if node.each_descendant(:dstr).any?
+          if search_from_arguments(node, type: :dstr).any?
             format_in_order_of_on_dstr(node)
           else
             format_in_order_of_on_str(node)
@@ -244,7 +271,7 @@ module RuboCop
         # @return [String]
         def format_in_order_of_on_dstr(node)
           format(
-            'in_order_of(:%<column_name>s, %<values>s)%<reverse_order>s%<rest_order>s',
+            "in_order_of(:'%<column_name>s', %<values>s)%<reverse_order>s%<rest_order>s",
             column_name: extract_column_name_from_dstr(node),
             rest_order: extract_rest_order(node),
             reverse_order: extract_reverse_order_from_dstr(node),
@@ -256,7 +283,7 @@ module RuboCop
         # @return [String]
         def format_in_order_of_on_str(node)
           format(
-            'in_order_of(:%<column_name>s, %<values>s)%<reverse_order>s%<rest_order>s',
+            "in_order_of(:'%<column_name>s', %<values>s)%<reverse_order>s%<rest_order>s",
             column_name: extract_column_name_from_str(node),
             rest_order: extract_rest_order(node),
             reverse_order: extract_reverse_order_from_str(node),
@@ -310,6 +337,17 @@ module RuboCop
           node.str_type? &&
             node.value.match?(REGEXP_FIELD_STR)
         end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @param type [Symbol]
+        def search_from_arguments(
+          node,
+          type: nil
+        )
+          node.arguments.flat_map do |argument|
+            argument.each_node(*Array(type)).to_a
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/sevencop/rspec_empty_line_after_let.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module RuboCop
   module Cop
     module Sevencop

data/lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb

@@ -36,19 +36,19 @@ module RuboCop
       #     includes_examples 'creates Foo'
       #   end
       class RSpecExamplesInSameGroup < Base
-        METHOD_NAMES_FOR_REGULAR_EXAMPLE = ::Set[
-          :example,
-          :it,
-          :its,
-          :scenario,
-          :specify
-        ].freeze
+        METHOD_NAMES_FOR_REGULAR_EXAMPLE = %i[
+          example
+          it
+          its
+          scenario
+          specify
+        ].to_set.freeze
 
-        METHOD_NAMES_FOR_SHARED_EXAMPLES = ::Set[
-          :include_examples,
-          :it_behaves_like,
-          :it_should_behave_like
-        ]
+        METHOD_NAMES_FOR_SHARED_EXAMPLES = %i[
+          include_examples
+          it_behaves_like
+          it_should_behave_like
+        ].to_set.freeze
 
         MSG = 'Combine examples in the same group in the time-consuming kinds of specs.'
 

data/lib/rubocop/cop/sevencop/rspec_memoized_helper_block_delimiter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module RuboCop
   module Cop
     module Sevencop

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.32.1'
+  VERSION = '0.33.0'
 end

data/lib/sevencop.rb

@@ -15,7 +15,7 @@ require_relative 'rubocop/cop/sevencop/method_definition_keyword_argument_ordere
 require_relative 'rubocop/cop/sevencop/method_definition_ordered'
 require_relative 'rubocop/cop/sevencop/rails_belongs_to_optional'
 require_relative 'rubocop/cop/sevencop/rails_date_and_time_calculation'
-require_relative 'rubocop/cop/sevencop/rails_order_field'
+require_relative 'rubocop/cop/sevencop/rails_order_field_arel_sql'
 require_relative 'rubocop/cop/sevencop/rails_order_field_in_order_of'
 require_relative 'rubocop/cop/sevencop/rails_specific_action_name'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.33.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,7 +67,7 @@ files:
 - lib/rubocop/cop/sevencop/method_definition_ordered.rb
 - lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb
 - lib/rubocop/cop/sevencop/rails_date_and_time_calculation.rb
-- lib/rubocop/cop/sevencop/rails_order_field.rb
+- lib/rubocop/cop/sevencop/rails_order_field_arel_sql.rb
 - lib/rubocop/cop/sevencop/rails_order_field_in_order_of.rb
 - lib/rubocop/cop/sevencop/rails_specific_action_name.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Opinionated custom cops for RuboCop.