sevencop 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18546d00ceb4ff7f756715ecdbe89e7941a51855df542b4ad2a8a05843ebc46a
-  data.tar.gz: b968132f755f723217b47fd81126bb11242e0702b267fcc9ef49eac054c9c22a
+  metadata.gz: b2c9e682c02d43b65dbeefd01c07c467881b43bb8a1344289f85584f21e998c9
+  data.tar.gz: fd1dd656e25801d5748b28edcb85d0286c042d29d3b2d065761fa030876c492c
 SHA512:
-  metadata.gz: d1e87a57863fe1881b6fc0c923213d9d563cdeba24c1ab92715bab58004efbdaf3b011319b1ddc3215b5b20f443a40c99cd515754312a0ba920ff601cd6eb7ab
-  data.tar.gz: ae482542aa0d259384cba3bfd04932ae1811b9ed686245ebd3de5f1e1fa7deac48a90fcea0b2f0276afcd9244846b7b59fd4ba1ceef846d1217b505b183877c4
+  metadata.gz: 60b0f9acd29d904cc77cc7fbc20023fdc050298ef51022802e815287e9fd8ea5a3823f849a718a2b76fe1a563c3932c5e5e553be9e18cdac16cb22d813ff9e30
+  data.tar.gz: ada45750a1964ee08629bdac329029b169f77aa68999c8c7bf3cd0d983e8eacadb9925d0140fb418a1e9cd0f071b9c1d75f0f8b4dd36ff07e0984c0e21c0a673

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## 0.4.0 - 2022-06-18
+
+### Added
+
+- Add `Sevencop/OrderField` cop.
+
+### Changed
+
+- Improve performance of `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
+- Improve offense location of `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
+
 ## 0.3.0 - 2022-06-18
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.3.0)
+    sevencop (0.4.0)
       rubocop (>= 1.27)
 
 GEM

data/README.md

@@ -35,6 +35,26 @@ require:
 
 ## Cops
 
+### Sevencop/OrderField
+
+Identifies a String including "field" is passed to `order` or `reorder`.
+
+```ruby
+# bad
+articles.order('field(id, ?)', a)
+
+# good
+articles.order(Arel.sql('field(id, ?)'), a)
+
+# bad
+reorder('field(id, ?)', a)
+
+# good
+reorder(Arel.sql('field(id, ?)'), a)
+```
+
+`Enabled: false` by default.
+
 ### `Sevencop/RedundantExistenceCheck`
 
 Identifies redundant existent check before file operation.
@@ -76,4 +96,4 @@ validates :name, uniqueness: { allow_nil: true, scope: :user_id, case_sensitive:
 
 Useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
 
-Note that this cop is `Enabled: false` by default.
+`Enabled: false` by default.

data/Rakefile

@@ -24,7 +24,7 @@ task :new_cop, [:cop] do |_task, args|
 
   generator.write_source
   generator.write_spec
-  generator.inject_require(root_file_path: 'lib/rubocop/cop/rails_deprecation_cops.rb')
+  generator.inject_require(root_file_path: 'lib/sevencop.rb')
   generator.inject_config(config_file_path: 'config/default.yml')
 
   puts generator.todo

data/config/default.yml

@@ -1,3 +1,9 @@
+Sevencop/OrderField:
+  Description: Wrap safe SQL String by `Arel.sql`.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.4'
+
 Sevencop/RedundantExistenceCheck:
   Description: Avoid redundant existent check before file operation.
   Enabled: true

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Identifies a String including "field" is passed to `order` or `reorder`.
+      #
+      # @safety
+      #   This cop is unsafe because it can register a false positive.
+      #
+      # @example
+      #
+      #   # bad
+      #   articles.order('field(id, ?)', a)
+      #
+      #   # good
+      #   articles.order(Arel.sql('field(id, ?)'), a)
+      #
+      #   # bad
+      #   reorder('field(id, ?)', a)
+      #
+      #   # good
+      #   reorder(Arel.sql('field(id, ?)'), a)
+      #
+      class OrderField < Base
+        extend AutoCorrector
+
+        MSG = 'Wrap safe SQL String by `Arel.sql`.'
+
+        RESTRICT_ON_SEND = %i[
+          order
+          reorder
+        ].freeze
+
+        ORDER_METHOD_NAMES = RESTRICT_ON_SEND.to_set.freeze
+
+        def_node_matcher :order_with_field?, <<~PATTERN
+          (send
+            _ ORDER_METHOD_NAMES
+            (str /field\(.+\)/)
+            ...
+          )
+        PATTERN
+
+        # @param [RuboCop::AST::SendNode] node
+        def on_send(node)
+          return unless order_with_field?(node)
+
+          first_argument_node = node.arguments.first
+          add_offense(first_argument_node) do |corrector|
+            corrector.replace(
+              node.arguments.first,
+              "Arel.sql(#{first_argument_node.source})"
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -31,6 +31,8 @@ module RuboCop
 
         MSG = 'Specify :case_sensitivity option on use of UniquenessValidator.'
 
+        RESTRICT_ON_SEND = %i[validates].freeze
+
         def_node_matcher :validates_uniqueness?, <<~PATTERN
           (send nil? :validates
             _
@@ -65,8 +67,8 @@ module RuboCop
         def on_send(node)
           return unless validates_uniqueness?(node) && !validates_uniqueness_with_case_sensitivity?(node)
 
-          add_offense(node) do |corrector|
-            uniqueness_value = find_uniqueness_value(node)
+          uniqueness_value = find_uniqueness_value(node)
+          add_offense(uniqueness_value) do |corrector|
             if uniqueness_value.true_type?
               corrector.replace(
                 uniqueness_value.source_range,

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -6,6 +6,7 @@ require 'yaml'
 require_relative 'sevencop/inject'
 require_relative 'sevencop/version'
 
+require_relative 'rubocop/cop/sevencop/order_field'
 require_relative 'rubocop/cop/sevencop/redundant_existence_check'
 require_relative 'rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -41,6 +41,7 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
+- lib/rubocop/cop/sevencop/order_field.rb
 - lib/rubocop/cop/sevencop/redundant_existence_check.rb
 - lib/rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity.rb
 - lib/sevencop.rb