sevencop 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef38866fd82173f9e717566ed4ddacaa43571eda5760cc72b37ec615256e32cc
-  data.tar.gz: cf4aa55ea75a1eeebfae8a1d4ac311e83611a54b365911d4bf8d244fafbc587d
+  metadata.gz: 319d9ad3cd53f54122dd36a4d53d4ba2b1e496831c3c26022b2a8494f5a95fdc
+  data.tar.gz: b54dd12e0177a48827cb87f35fa6af902e256f996c96a990933c08c22e8b91f5
 SHA512:
-  metadata.gz: 744673cf9ae424e870f5a7526a61c19f3b124597e83554c81967544cfdf617992bc2d46c464347cef5f654a5aca1654486511abb85afb0c3123719b6214411f6
-  data.tar.gz: 81873ee0905b64eb4aa51cf7d0f93e62a87d2fd616a8c18756fe8d1ac68f023e0e8c0d5b6a2e77847bdf482edee2036956afc15248975292c10f1965488009d5
+  metadata.gz: 07d68c578fa6807867b0caa213706484ff8c04475e1f17ce0f3121a37307f0cb48962a1ee7c1782dcbaedbff34748a075a41522e8d9c79dcdf24e9d4b8aa581a
+  data.tar.gz: e47791134b21b41a4d9fcae6503db43cefb2d377391b7e3c5a7537bd5944fecd444164931df15035d628b939ce6fe5e6fac50694aef76c856c66c3a97763b04a

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## 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

data/Gemfile.lock

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

data/README.md

@@ -35,6 +35,28 @@ require:
 
 ## Cops
 
+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`.
@@ -53,8 +75,6 @@ reorder('field(id, ?)', a)
 reorder(Arel.sql('field(id, ?)'), a)
 ```
 
-`Enabled: false` by default.
-
 ### Sevencop/RedundantExistenceCheck
 
 Identifies redundant existent check before file operation.
@@ -95,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.
-
-`Enabled: false` by default.

data/config/default.yml

@@ -1,3 +1,10 @@
+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
@@ -6,7 +13,7 @@ Sevencop/OrderField:
 
 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/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.4.1'
+  VERSION = '0.5.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/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/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.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-23 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,6 +41,7 @@ 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