sevencop 0.32.0 → 0.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73ab476e9b75a7c542283153fb21a6e34bc065305f174ad7fc360d8d4fe83ab
-  data.tar.gz: 36704b1877d0042042c91112699c201566a60bfc84e9bea4eb00824f910d6516
+  metadata.gz: f4a4965c23bf272ebe52214f0c8a37c6bd989638560cbf7e079b3af2e9782622
+  data.tar.gz: 134934de2b553fabf8b07b63c5e10364178fd007866bb45cea8ff8e357985c77
 SHA512:
-  metadata.gz: b6d0f76043cf888387a230e1de66233a0ba68be0b647883bd8dac259f7cd7c97b504a3ce24577a14fd15fc590f146e17ff605223e2616e6c13992ec4e9a855d0
-  data.tar.gz: ac8f462e97a095a80c612318d9eb69373c0b3c9ce11a3fc49c8143ba92d40adcdfc2279b6ad0edb0eaf07a6c12ac500a8090b12969feee0529ec91c981a1a72f
+  metadata.gz: 6bf335fbbf8fc003e83369b98b67c2af236bdfd2cee48b6a142ff13a34cea3d0f633a142f340924c61411755adb771171e1fb87498a70edc0e3c4d241f96ca22
+  data.tar.gz: a5592277696b87dc3ec141b8d2155681da27d7d1f8369d919fd5d24dc1da8d1c2d8ca1070315083e334217f1ecf9d7e77e8879efcbcdc86ed9639ec4aeed0500

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.32.0)
+    sevencop (0.32.2)
       activesupport
       rubocop
 

data/config/default.yml

@@ -99,6 +99,7 @@ Sevencop/RailsOrderFieldInOrderOf:
   Description: |
     Prefer `in_order_of` to MySQL `FIELD` function.
   Enabled: false
+  SafeAutoCorrect: false
   VersionAdded: '0.32'
 
 Sevencop/RailsSpecificActionName:

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

@@ -70,7 +70,7 @@ module RuboCop
           class_node:
         )
           class_node.parent_class&.each_descendant(:cbase)&.any? do |descendant|
-            descendant.eql?(node)
+            descendant.equal?(node)
           end
         end
       end

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

@@ -5,6 +5,23 @@ module RuboCop
     module Sevencop
       # Prefer `in_order_of` to MySQL `FIELD` function.
       #
+      # @safety
+      #   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
       #   order('FIELD(id, 1, 2, 3)')
@@ -37,7 +54,7 @@ module RuboCop
           \s*
           field\(
             \s*
-            (?<column_name>\w+)
+            (?<column_name>[^,]+)
             ,\s*
           \z
         /ix.freeze
@@ -59,7 +76,7 @@ module RuboCop
           \s*
           field\(
             \s*
-            (?<column_name>\w+)
+            (?<column_name>[^,]+)
             ,\s*
             (?<values>.+)
             \s*
@@ -84,7 +101,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 +167,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 +193,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 +241,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 +251,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 +269,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 +281,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 +335,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/sevencop/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.32.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport