sevencop 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6671a53ba1051be4f4ea86dc41b3c4d4adfef282c8ca1078ea4271161e0e54ac
-  data.tar.gz: aea5e2be6ae30fe9ca7ba5237e3444cebe5e71ab7352b03f2929fef8c71fccd9
+  metadata.gz: ef38866fd82173f9e717566ed4ddacaa43571eda5760cc72b37ec615256e32cc
+  data.tar.gz: cf4aa55ea75a1eeebfae8a1d4ac311e83611a54b365911d4bf8d244fafbc587d
 SHA512:
-  metadata.gz: 1ad6a03a60543e5171f8d41a0d8b257d7fe7b0141c1f2922556b89e8b1e068e3e68ea5db5ef1a941acdb4b2674898d25077e98c5f1c6e0abebb0d73b3aa7ffc2
-  data.tar.gz: af5b8df28c323361fe79082e26dc6d3910b1bc1d7bf8f1bb9d6d9321ba2a525615bc5fc65cbc24e47a5fccab2cd2a1271315c461cf32495b55a9494363c2b934
+  metadata.gz: 744673cf9ae424e870f5a7526a61c19f3b124597e83554c81967544cfdf617992bc2d46c464347cef5f654a5aca1654486511abb85afb0c3123719b6214411f6
+  data.tar.gz: 81873ee0905b64eb4aa51cf7d0f93e62a87d2fd616a8c18756fe8d1ac68f023e0e8c0d5b6a2e77847bdf482edee2036956afc15248975292c10f1965488009d5

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 ## Unreleased
 
+## 0.4.1 - 2022-06-23
+
+### Fixed
+
+- Fix `Sevencop/OrderField` on dstr.
+
+## 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
+
+- Add `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
+
 ## 0.2.0 - 2022-06-07
 
 ### Changed

data/Gemfile.lock

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

data/README.md

@@ -35,7 +35,27 @@ require:
 
 ## Cops
 
-### `Sevencop/RedundantExistenceCheck`
+### 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.
 
@@ -44,11 +64,36 @@ Identifies redundant existent check before file operation.
 FileUtils.mkdir(a) unless FileTest.exist?(a)
 
 # good
-FileUtils.mkdir(a)
+FileUtils.mkdir_p(a)
 
 # bad
 FileUtils.rm(a) if FileTest.exist?(a)
 
 # good
-FileUtils.rm(a)
+FileUtils.rm_f(a)
 ```
+
+### Sevencop/UniquenessValidatorExplicitCaseSensitivity
+
+Identifies use of UniquenessValidator without :case_sensitive option.
+
+```ruby
+# bad
+validates :name, uniqueness: true
+
+# good
+validates :name, uniqueness: { case_sensitive: true }
+
+# good
+validates :name, uniqueness: { case_sensitive: false }
+
+# bad
+validates :name, uniqueness: { allow_nil: true, scope: :user_id }
+
+# good
+validates :name, uniqueness: { allow_nil: true, scope: :user_id, case_sensitive: true }
+```
+
+Useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
+
+`Enabled: false` by default.

data/Rakefile

@@ -16,7 +16,7 @@ task :new_cop, [:cop] do |_task, args|
   require 'rubocop'
 
   cop_name = args.fetch(:cop) do
-    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    warn "usage: bundle exec rake 'new_cop[Department/Name]'"
     exit!
   end
 
@@ -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,5 +1,17 @@
+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
   Safe: false
   VersionAdded: '0.1'
+
+Sevencop/UniquenessValidatorExplicitCaseSensitivity:
+  Description: Specify :case_sensitivity option on use of UniquenessValidator.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.3'

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

@@ -0,0 +1,63 @@
+# 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\(.+\)/) |
+              (dstr <(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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Identifies use of UniquenessValidator without :case_sensitive option.
+      # This is useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
+      #
+      # @safety
+      #   This cop is unsafe because it can register a false positive.
+      #
+      # @example
+      #
+      #   # bad
+      #   validates :name, uniqueness: true
+      #
+      #   # good
+      #   validates :name, uniqueness: { case_sensitive: true }
+      #
+      #   # good
+      #   validates :name, uniqueness: { case_sensitive: false }
+      #
+      #   # bad
+      #   validates :name, uniqueness: { allow_nil: true, scope: :user_id }
+      #
+      #   # good
+      #   validates :name, uniqueness: { allow_nil: true, scope: :user_id, case_sensitive: true }
+      #
+      class UniquenessValidatorExplicitCaseSensitivity < Base
+        extend AutoCorrector
+
+        MSG = 'Specify :case_sensitivity option on use of UniquenessValidator.'
+
+        RESTRICT_ON_SEND = %i[validates].freeze
+
+        def_node_matcher :validates_uniqueness?, <<~PATTERN
+          (send nil? :validates
+            _
+            (hash
+              <
+                (pair
+                  (sym :uniqueness)
+                  {true | (hash ...)}
+                )
+              >
+              ...
+            )
+          )
+        PATTERN
+
+        def_node_matcher :validates_uniqueness_with_case_sensitivity?, <<~PATTERN
+          (send nil? :validates
+            _
+            (hash
+              <
+                (pair
+                  (sym :uniqueness)
+                  (hash <(pair (sym :case_sensitive) _) ...>)
+                )
+                ...
+              >
+            )
+          )
+        PATTERN
+
+        # @param [RuboCop::AST::SendNode] node
+        def on_send(node)
+          return unless validates_uniqueness?(node) && !validates_uniqueness_with_case_sensitivity?(node)
+
+          uniqueness_value = find_uniqueness_value(node)
+          add_offense(uniqueness_value) do |corrector|
+            if uniqueness_value.true_type?
+              corrector.replace(
+                uniqueness_value.source_range,
+                '{ case_sensitive: true }'
+              )
+            else
+              corrector.insert_after(
+                uniqueness_value.pairs.last.source_range,
+                ', case_sensitive: true'
+              )
+            end
+          end
+        end
+
+        # @param [RuboCop::AST::SendNode] node
+        # @param [RuboCop::AST::Node]
+        def find_uniqueness_value(node)
+          node.arguments[1].pairs.find { |pair| pair.key.value == :uniqueness }.value
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -6,7 +6,9 @@ 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'
 
 module Sevencop
   PROJECT_ROOT = ::Pathname.new(__dir__).parent.expand_path.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -41,11 +41,13 @@ 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
 - lib/sevencop/inject.rb
 - lib/sevencop/version.rb
-- rubocop-rails_deprecation.gemspec
+- sevencop.gemspec
 homepage: https://github.com/r7kamura/sevencop
 licenses:
 - MIT
@@ -69,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Custom cops for RuboCop.