rubocop-petal 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27cd3572987b7a6238883f593b73622d58c578dd2c3c71b242b218dc2acabba9
-  data.tar.gz: 28eaba65472713af02487e2b2d7c058cd6cd0442a023347d29d02d55684d1329
+  metadata.gz: aa2179fb3df37d962557546e94f204ee9a8789d2850cda31a53e7375b47edb50
+  data.tar.gz: dfeedd44694e75eab2c78f7205d93701a356378d147d6dca9e5adf68bf1e805f
 SHA512:
-  metadata.gz: 9634d631a31346febfa80b63603c46865866502b9bfbbc7db6e6ef7136fba7e0fd1a44b226fde3cb680521d94a6d9d61cf427d57cb76712688b1f0f0c95a0864
-  data.tar.gz: 80d383f97fe9f0b3a7bb2c8df6c1be422168fc3a5a025e4c8c0c810931871dd929216a0624a3d377b5d2c72534984675ba009e3aaaf1175eee93504a5aabd42b
+  metadata.gz: df124d64a0b69c1311c86e47393fd94379f89fac39d5f6752ec8af6f97df783764fcf581de9c5e11d79d5245bba37f8f07464d29d86f102c9b07056c610ffb8c
+  data.tar.gz: dec1a550aa7fbfdfeae58457bd668d671b21a0db0933685d253c18408b913bde81ccbf0e7fbb6ab1b5966741a6d4b3590956fc2641a11a0fda40d55c9980bc9a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 # main
 
+#v0.5.0
+
+* Added cop `Rails/ValidateUniquenessCase` ([#20](https://github.com/petalmd/rubocop-petal/pull/20))
+
 #v0.4.1
 
 * Fix typo default config SafeAutoCorrect RSpec/StubProducts ([#19](https://github.com/petalmd/rubocop-petal/pull/19))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-petal (0.4.1)
+    rubocop-petal (0.5.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-rails (~> 2.10)
 

data/config/default.yml

@@ -70,3 +70,11 @@ Rails/TableName:
 Chewy/ResetOnType:
   Description: 'Prevent using reset! methods on Chewy type class'
   Enabled: true
+
+Rails/ValidateUniquenessCase:
+  Description: 'Enforce setting uniqueness case sensitive option.'
+  Enabled: true
+  SafeAutoCorrect: false
+  StyleGuide: 'https://guides.rubyonrails.org/6_1_release_notes.html#active-record-notable-changes'
+  Include:
+    - app/models/**/*

data/lib/rubocop/cop/rails/validate_uniqueness_case.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces to specify a case sensitive or case insensitive option
+      # to the uniqueness validation.
+      #
+      # The default value in Rails 5 is `case_sensitive: true`. Which does not
+      # reflect MySQL's default behavior. In Rails 6.1 the default value will be
+      # `case_sensitive: false` to reflect MySQL's default behavior
+      # (https://guides.rubyonrails.org/6_1_release_notes.html#active-record-notable-changes).
+      #
+      # # bad
+      # validates :name, uniqueness: true
+      # validates :name, uniqueness: { scope: :user_id }
+      #
+      # # good
+      # validates :name, uniqueness: { case_sensitive: true }
+      # validates :name, uniqueness: { scope: :user_id, case_sensitive: false }
+      #
+      class ValidateUniquenessCase < Base
+        extend AutoCorrector
+
+        # Don't force to add the `case_sensitive` option when
+        # the default value is already `false` in Rails 6.
+        MAXIMUM_RAILS_VERSION = 6.1
+        MSG = 'Pass `case_sensitive: true|false` to uniqueness options.'
+        RESTRICT_ON_SEND = %i[validates].freeze
+
+        def_node_search :uniqueness?, <<~PATTERN
+          (sym :uniqueness)
+        PATTERN
+
+        def_node_matcher :have_case_sensitive_options?, <<~PATTERN
+          (pair (sym :case_sensitive) ${true false})
+        PATTERN
+
+        def on_send(node)
+          return unless support_target_rails_version?
+
+          uniqueness_options = match_uniqueness_options(node)
+          return unless uniqueness_options
+
+          uniqueness_child_options = uniqueness_options.children.last
+
+          # When it's just `uniqueness: true`
+          if uniqueness_child_options.boolean_type?
+            boolean_uniqueness(uniqueness_options)
+            return
+          end
+
+          case_sensitive_options = uniqueness_child_options.pairs.detect { |c| have_case_sensitive_options?(c) }
+          hash_uniqueness_offense(uniqueness_options, case_sensitive_options)
+        end
+
+        private
+
+        def match_uniqueness_options(node)
+          node.children.last.children.detect do |c|
+            # Skip if not a hash
+            next if c.is_a?(Symbol)
+
+            uniqueness?(c)
+          end
+        end
+
+        def boolean_uniqueness(node)
+          # When it's just `uniqueness: true`
+          add_offense(node) do |corrector|
+            corrector.replace(node, 'uniqueness: { case_sensitive: false }')
+          end
+        end
+
+        def hash_uniqueness_offense(node, sensitive_options)
+          return if sensitive_options
+
+          add_offense(node) do |corrector|
+            corrector.insert_after(node.loc.expression.adjust(end_pos: -2), ', case_sensitive: false')
+          end
+        end
+
+        def support_target_rails_version?
+          target_rails_version < MAXIMUM_RAILS_VERSION
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '0.4.1'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -75,6 +75,7 @@ files:
 - lib/rubocop/cop/rails/enum_prefix.rb
 - lib/rubocop/cop/rails/risky_activerecord_invocation.rb
 - lib/rubocop/cop/rails/table_name.rb
+- lib/rubocop/cop/rails/validate_uniqueness_case.rb
 - lib/rubocop/cop/rspec/authenticated_as.rb
 - lib/rubocop/cop/rspec/create_list_max.rb
 - lib/rubocop/cop/rspec/stub_products.rb