sevencop 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18546d00ceb4ff7f756715ecdbe89e7941a51855df542b4ad2a8a05843ebc46a
-  data.tar.gz: b968132f755f723217b47fd81126bb11242e0702b267fcc9ef49eac054c9c22a
+  metadata.gz: 319d9ad3cd53f54122dd36a4d53d4ba2b1e496831c3c26022b2a8494f5a95fdc
+  data.tar.gz: b54dd12e0177a48827cb87f35fa6af902e256f996c96a990933c08c22e8b91f5
 SHA512:
-  metadata.gz: d1e87a57863fe1881b6fc0c923213d9d563cdeba24c1ab92715bab58004efbdaf3b011319b1ddc3215b5b20f443a40c99cd515754312a0ba920ff601cd6eb7ab
-  data.tar.gz: ae482542aa0d259384cba3bfd04932ae1811b9ed686245ebd3de5f1e1fa7deac48a90fcea0b2f0276afcd9244846b7b59fd4ba1ceef846d1217b505b183877c4
+  metadata.gz: 07d68c578fa6807867b0caa213706484ff8c04475e1f17ce0f3121a37307f0cb48962a1ee7c1782dcbaedbff34748a075a41522e8d9c79dcdf24e9d4b8aa581a
+  data.tar.gz: e47791134b21b41a4d9fcae6503db43cefb2d377391b7e3c5a7537bd5944fecd444164931df15035d628b939ce6fe5e6fac50694aef76c856c66c3a97763b04a

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 ## Unreleased
 
+## 0.5.0 - 2022-06-27
+
+### Added
+
+- Add `Sevencop/BelongsToOptional` cop.
+
+### Changed
+
+- Make `Sevencop/RedundantExistenceCheck` cop disabled by default.
+
+### Removed
+
+- Remove rubocop version dependency.
+
+## 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

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    sevencop (0.3.0)
-      rubocop (>= 1.27)
+    sevencop (0.5.0)
+      rubocop
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -35,7 +35,47 @@ require:
 
 ## Cops
 
-### `Sevencop/RedundantExistenceCheck`
+All cops are `Enabled: false` by default.
+
+### Sevencop/BelongsToOptional
+
+Force `belongs_to` with `optional: true` option.
+
+```ruby
+# bad
+belongs_to :group
+
+# good
+belongs_to :group, optional: true
+
+# good
+belongs_to :group, optional: false
+
+# good
+belongs_to :group, options
+```
+
+This is useful for migration of `config.active_record.belongs_to_required_by_default`.
+
+### 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)
+```
+
+### Sevencop/RedundantExistenceCheck
 
 Identifies redundant existent check before file operation.
 
@@ -53,7 +93,7 @@ FileUtils.rm(a) if FileTest.exist?(a)
 FileUtils.rm_f(a)
 ```
 
-### `Sevencop/UniquenessValidatorExplicitCaseSensitivity`
+### Sevencop/UniquenessValidatorExplicitCaseSensitivity
 
 Identifies use of UniquenessValidator without :case_sensitive option.
 
@@ -75,5 +115,3 @@ 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.

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,6 +1,19 @@
+Sevencop/BelongsToOptional:
+  Description: |
+    Force `belongs_to` with `optional: true` option.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.5'
+
+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
+  Enabled: false
   Safe: false
   VersionAdded: '0.1'
 

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Force `belongs_to` with `optional: true` option.
+      #
+      # @example
+      #
+      #   # bad
+      #   belongs_to :group
+      #
+      #   # good
+      #   belongs_to :group, optional: true
+      #
+      #   # good
+      #   belongs_to :group, optional: false
+      #
+      #   # good (We cannot identify offenses in this case.)
+      #   belongs_to :group, options
+      #
+      class BelongsToOptional < Base
+        extend AutoCorrector
+
+        MSG = 'Specify :optional option.'
+
+        RESTRICT_ON_SEND = %i[
+          belongs_to
+        ].freeze
+
+        def_node_matcher :without_options?, <<~PATTERN
+          (send _ _ _)
+        PATTERN
+
+        def_node_matcher :with_hash_options?, <<~PATTERN
+          (send _ _ _ (hash ...))
+        PATTERN
+
+        def_node_matcher :with_optional?, <<~PATTERN
+          (send _ _ _ (hash <(pair (sym :optional) _) ...>))
+        PATTERN
+
+        # @param [RuboCop::AST::SendNode] node
+        def on_send(node)
+          return unless without_options?(node) || (with_hash_options?(node) && !with_optional?(node))
+
+          add_offense(node) do |corrector|
+            if node.arguments[-1].hash_type?
+              corrector.insert_after(node.arguments[-1], ', optional: true')
+            elsif node.arguments.length == 1
+              corrector.insert_after(node.arguments.first, ', optional: true')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -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.5.0'
 end

data/lib/sevencop.rb

@@ -6,6 +6,8 @@ require 'yaml'
 require_relative 'sevencop/inject'
 require_relative 'sevencop/version'
 
+require_relative 'rubocop/cop/sevencop/belongs_to_optional'
+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'
 

data/{rubocop-rails_deprecation.gemspec → sevencop.gemspec}

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '>= 1.27'
+  spec.add_runtime_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '0'
 description:
 email:
 - r7kamura@gmail.com
@@ -41,12 +41,14 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
+- lib/rubocop/cop/sevencop/belongs_to_optional.rb
+- 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
@@ -70,7 +72,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.