sevencop 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6671a53ba1051be4f4ea86dc41b3c4d4adfef282c8ca1078ea4271161e0e54ac
-  data.tar.gz: aea5e2be6ae30fe9ca7ba5237e3444cebe5e71ab7352b03f2929fef8c71fccd9
+  metadata.gz: 18546d00ceb4ff7f756715ecdbe89e7941a51855df542b4ad2a8a05843ebc46a
+  data.tar.gz: b968132f755f723217b47fd81126bb11242e0702b267fcc9ef49eac054c9c22a
 SHA512:
-  metadata.gz: 1ad6a03a60543e5171f8d41a0d8b257d7fe7b0141c1f2922556b89e8b1e068e3e68ea5db5ef1a941acdb4b2674898d25077e98c5f1c6e0abebb0d73b3aa7ffc2
-  data.tar.gz: af5b8df28c323361fe79082e26dc6d3910b1bc1d7bf8f1bb9d6d9321ba2a525615bc5fc65cbc24e47a5fccab2cd2a1271315c461cf32495b55a9494363c2b934
+  metadata.gz: d1e87a57863fe1881b6fc0c923213d9d563cdeba24c1ab92715bab58004efbdaf3b011319b1ddc3215b5b20f443a40c99cd515754312a0ba920ff601cd6eb7ab
+  data.tar.gz: ae482542aa0d259384cba3bfd04932ae1811b9ed686245ebd3de5f1e1fa7deac48a90fcea0b2f0276afcd9244846b7b59fd4ba1ceef846d1217b505b183877c4

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 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.3.0)
       rubocop (>= 1.27)
 
 GEM

data/README.md

@@ -44,11 +44,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.
+
+Note that this cop is `Enabled: false` by default.

data/config/default.yml

@@ -3,3 +3,9 @@ Sevencop/RedundantExistenceCheck:
   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/uniqueness_validator_explicit_case_sensitivity.rb

@@ -0,0 +1,92 @@
+# 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.'
+
+        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)
+
+          add_offense(node) do |corrector|
+            uniqueness_value = find_uniqueness_value(node)
+            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.3.0'
 end

data/lib/sevencop.rb

@@ -7,6 +7,7 @@ require_relative 'sevencop/inject'
 require_relative 'sevencop/version'
 
 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.3.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -42,6 +42,7 @@ files:
 - Rakefile
 - config/default.yml
 - 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