sevencop 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee749fe11f72d661269fa08344e0b5f578a21517375a75d58f5c2bab1877fdcd
-  data.tar.gz: 15a392c82cc473f1a5c327e2b1a6f0e1620d3b8e405aa6e548b020559bd24afd
+  metadata.gz: b73ab476e9b75a7c542283153fb21a6e34bc065305f174ad7fc360d8d4fe83ab
+  data.tar.gz: 36704b1877d0042042c91112699c201566a60bfc84e9bea4eb00824f910d6516
 SHA512:
-  metadata.gz: 9c2ea95803821697a72157ab0608459b44467cb2ec868ba66dc21f2613f7ac4eb52745d69d19d5ea43dff6fb40e70ebc2b59110a7bd58ff9ece189b401532c74
-  data.tar.gz: f3e26944c43c61b5ccf1f0875117ce77aba7b1ca8f223e5b174ea7a2d4737407b949bc1e362aa1363ee350106b60dc1852ee89af55b5953393b5d7dec432c8d2
+  metadata.gz: b6d0f76043cf888387a230e1de66233a0ba68be0b647883bd8dac259f7cd7c97b504a3ce24577a14fd15fc590f146e17ff605223e2616e6c13992ec4e9a855d0
+  data.tar.gz: ac8f462e97a095a80c612318d9eb69373c0b3c9ce11a3fc49c8143ba92d40adcdfc2279b6ad0edb0eaf07a6c12ac500a8090b12969feee0529ec91c981a1a72f

data/Gemfile.lock

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

data/README.md

@@ -40,6 +40,7 @@ Note that all cops are `Enabled: false` by default.
 - [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/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)
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)

data/config/default.yml

@@ -7,13 +7,13 @@ Sevencop/AutoloadOrdered:
 
 Sevencop/ConstantBase:
   Description: |
-    Remove unnecessary `::` prefix from constant.
+    Avoid unnecessary `::` prefix on constant.
   Enabled: false
   VersionAdded: '0.31'
 
 Sevencop/FactoryBotAssociationOption:
   Description: |
-    Remove redundant options from FactoryBot associations.
+    Avoid redundant options on FactoryBot associations.
   Enabled: false
   VersionAdded: '0.21'
 
@@ -95,6 +95,12 @@ Sevencop/RailsOrderField:
   Safe: false
   VersionAdded: '0.4'
 
+Sevencop/RailsOrderFieldInOrderOf:
+  Description: |
+    Prefer `in_order_of` to MySQL `FIELD` function.
+  Enabled: false
+  VersionAdded: '0.32'
+
 Sevencop/RailsSpecificActionName:
   Description: |
     Use only specific action names.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Remove unnecessary `::` prefix from constant.
+      # Avoid unnecessary `::` prefix on constant.
       #
       # @example
       #   # bad
@@ -23,18 +23,18 @@ module RuboCop
       #   end
       #
       #   # good
-      #   class Klass
+      #   class A
       #     ::Const
       #   end
       #
       #   # good
-      #   class module
+      #   class A
       #     ::Const
       #   end
       class ConstantBase < Base
         extend AutoCorrector
 
-        MSG = 'Remove unnecessary `::` prefix from constant.'
+        MSG = 'Avoid unnecessary `::` prefix on constant.'
 
         # @param node [RuboCop::AST::CbaseNode]
         # @return [void]
@@ -48,17 +48,30 @@ module RuboCop
 
         private
 
-        # @!method named_class_or_module?(node)
-        #   @param node [RuboCop::AST::Node]
-        #   @return [Boolean]
-        def_node_matcher :named_class_or_module?, <<~PATTERN
-          ({class module} const ...)
-        PATTERN
-
         # @param node [RuboCop::AST::CbaseNode]
         # @return [Boolean]
         def bad?(node)
-          node.each_ancestor(:class, :module).none?
+          module_nesting_ancestors_of(node).none?
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Enumerable<RuboCop::AST::Node>]
+        def module_nesting_ancestors_of(node)
+          node.each_ancestor(:class, :module).reject do |ancestor|
+            ancestor.class_type? && used_in_super_class_part?(node, class_node: ancestor)
+          end
+        end
+
+        # @param class_node [RuboCop::AST::Node]
+        # @param node [RuboCop::AST::CbaseNode]
+        # @return [Boolean]
+        def used_in_super_class_part?(
+          node,
+          class_node:
+        )
+          class_node.parent_class&.each_descendant(:cbase)&.any? do |descendant|
+            descendant.eql?(node)
+          end
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Remove redundant options from FactoryBot associations.
+      # Avoid redundant options on FactoryBot associations.
       #
       # @example
       #   # bad
@@ -16,7 +16,7 @@ module RuboCop
 
         include RangeHelp
 
-        MSG = 'Remove redundant options from FactoryBot associations.'
+        MSG = 'Avoid redundant options on FactoryBot associations.'
 
         RESTRICT_ON_SEND = %i[association].freeze
 

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

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Prefer `in_order_of` to MySQL `FIELD` function.
+      #
+      # @example
+      #   # bad
+      #   order('FIELD(id, 1, 2, 3)')
+      #
+      #   # good
+      #   in_order_of(:id, [1, 2, 3])
+      #
+      #   # bad
+      #   order(Arel.sql('FIELD(id, 1, 2, 3)'))
+      #
+      #   # good
+      #   in_order_of(:id, [1, 2, 3])
+      #
+      #   # bad
+      #   order('FIELD(id, 1, 2, 3) DESC')
+      #
+      #   # good
+      #   in_order_of(:id, [1, 2, 3]).reverse_order
+      #
+      #   # bad
+      #   order("FIELD(id, #{ids.join(', ')})")
+      #
+      #   # good
+      #   in_order_of(:id, ids)
+      class RailsOrderFieldInOrderOf < Base
+        extend AutoCorrector
+
+        REGEXP_FIELD_DSTR_HEAD = /
+          \A
+          \s*
+          field\(
+            \s*
+            (?<column_name>\w+)
+            ,\s*
+          \z
+        /ix.freeze
+
+        REGEXP_FIELD_DSTR_TAIL = /
+          \A
+          \s*
+          \)
+          \s*
+          (?:
+            \s+
+            (?<order>asc|desc)
+          )?
+          \z
+        /ix.freeze
+
+        REGEXP_FIELD_STR = /
+          \A
+          \s*
+          field\(
+            \s*
+            (?<column_name>\w+)
+            ,\s*
+            (?<values>.+)
+            \s*
+          \)
+          (?:
+            \s+
+            (?<order>asc|desc)
+          )?
+          \s*
+          \z
+        /ix.freeze
+
+        MSG = 'Prefer `in_order_of` to MySQL `FIELD` function.'
+
+        RESTRICT_ON_SEND = %i[
+          order
+          reorder
+        ].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          return unless bad?(node)
+
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        # @!method match_arel_sql_field?(node)
+        #   @param node [RuboCop::AST::Node, nil]
+        #   @return [Boolean]
+        def_node_matcher :match_arel_sql_field?, <<~PATTERN
+          (send
+            (const {nil? cbase} :Arel)
+            :sql
+            #match_field?
+          )
+        PATTERN
+
+        # @!method match_field?(node)
+        #   @param node [RuboCop::AST::Node, nil]
+        #   @return [Boolean]
+        def_node_matcher :match_field?, <<~PATTERN
+          {
+            #match_field_dstr?
+            #match_field_str?
+          }
+        PATTERN
+
+        # @!method match_field_dstr_body?(node)
+        #   @param node [RuboCop::AST::Node, nil]
+        #   @return [Boolean]
+        def_node_matcher :match_field_dstr_body?, <<~PATTERN
+          (begin
+            (send
+              _
+              :join
+              (str #match_field_dstr_body_separator?)
+            )
+          )
+        PATTERN
+
+        # @!method match_order_with_field?(node)
+        #   @param node [RuboCop::AST::Node, nil]
+        #   @return [Boolean]
+        def_node_matcher :match_order_with_field?, <<~PATTERN
+          (send
+            _
+            _
+            {
+              #match_arel_sql_field?
+              #match_field?
+            }
+            ...
+          )
+        PATTERN
+        alias bad? match_order_with_field?
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        def autocorrect(
+          corrector,
+          node
+        )
+          corrector.replace(
+            node.location.expression.with(
+              begin_pos: node.location.selector.begin_pos
+            ),
+            format_in_order_of(node)
+          )
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String, nil]
+        def extract_column_name(node)
+          if node.each_descendant(:dstr).any?
+            extract_column_name_from_dstr(node)
+          else
+            extract_column_name_from_str(node)
+          end
+        end
+
+        # @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]
+        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]
+        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]
+        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]
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String, nil]
+        def extract_rest_order(node)
+          rest_order_arguments = node.arguments[1..]
+          return if rest_order_arguments.empty?
+
+          format(
+            '.order(%<rest_order_arguments>s)',
+            rest_order_arguments: rest_order_arguments.map(&:source).join(', ')
+          )
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String, nil]
+        def extract_reverse_order_from_dstr(node)
+          '.reverse_order' if match_desc_on_dstr?(node)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String, nil]
+        def extract_reverse_order_from_str(node)
+          '.reverse_order' if match_desc_on_str?(node)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String]
+        def extract_values_from_dstr(node)
+          node.each_descendant.find do |descendant|
+            match_field_dstr_body?(descendant)
+          end.children.first.receiver.source
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String]
+        def extract_values_from_str(node)
+          format(
+            '[%<values>s]',
+            values: node.each_descendant(: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?
+            format_in_order_of_on_dstr(node)
+          else
+            format_in_order_of_on_str(node)
+          end
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @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',
+            column_name: extract_column_name_from_dstr(node),
+            rest_order: extract_rest_order(node),
+            reverse_order: extract_reverse_order_from_dstr(node),
+            values: extract_values_from_dstr(node)
+          )
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @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',
+            column_name: extract_column_name_from_str(node),
+            rest_order: extract_rest_order(node),
+            reverse_order: extract_reverse_order_from_str(node),
+            values: extract_values_from_str(node)
+          )
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def match_desc_on_dstr?(node)
+          extract_order_from_dstr(node).to_s.casecmp('desc').zero?
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def match_desc_on_str?(node)
+          extract_order_from_str(node).to_s.casecmp('desc').zero?
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def match_field_dstr?(node)
+          node.dstr_type? &&
+            node.children.size == 3 &&
+            match_field_dstr_head?(node.children[0]) &&
+            match_field_dstr_body?(node.children[1]) &&
+            match_field_dstr_tail?(node.children[2])
+        end
+
+        # @param separator [String]
+        # @return [Boolean]
+        def match_field_dstr_body_separator?(separator)
+          separator.strip == ','
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def match_field_dstr_head?(node)
+          node&.str_type? &&
+            node.value.match?(REGEXP_FIELD_DSTR_HEAD)
+        end
+
+        def match_field_dstr_tail?(node)
+          node&.str_type? &&
+            node.value.match?(REGEXP_FIELD_DSTR_TAIL)
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def match_field_str?(node)
+          node.str_type? &&
+            node.value.match?(REGEXP_FIELD_STR)
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -16,6 +16,7 @@ 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_in_order_of'
 require_relative 'rubocop/cop/sevencop/rails_specific_action_name'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'
 require_relative 'rubocop/cop/sevencop/rails_where_not'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,6 +68,7 @@ files:
 - 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_in_order_of.rb
 - lib/rubocop/cop/sevencop/rails_specific_action_name.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb