sevencop 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c9e682c02d43b65dbeefd01c07c467881b43bb8a1344289f85584f21e998c9
-  data.tar.gz: fd1dd656e25801d5748b28edcb85d0286c042d29d3b2d065761fa030876c492c
+  metadata.gz: db281c40f5207dfc9759c52c60d4e2799d772e8d612364c4afa9b72eb935c90a
+  data.tar.gz: f84b8ca1a7d8cdb598c170b9c04b98b2358750ced29a8d3b3fb011b8a629449c
 SHA512:
-  metadata.gz: 60b0f9acd29d904cc77cc7fbc20023fdc050298ef51022802e815287e9fd8ea5a3823f849a718a2b76fe1a563c3932c5e5e553be9e18cdac16cb22d813ff9e30
-  data.tar.gz: ada45750a1964ee08629bdac329029b169f77aa68999c8c7bf3cd0d983e8eacadb9925d0140fb418a1e9cd0f071b9c1d75f0f8b4dd36ff07e0984c0e21c0a673
+  metadata.gz: 4597d82f8b5dd02a575d4720c10f495e6ebf16bfe47ef88c9557e5cb474c83bc35505861e2a1e5fdbc3b1d062fac6a06d3cfe94a05593ee9638a0aecf1034125
+  data.tar.gz: 3e9c4206cec1f67a0ab9176814f4405fe6d7fbe83c8571d0759788206b67569a8ad144f0cb934dbc2ddf30df29d529906f7160c5b029fbc13a60464229f2a8d6

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 ## Unreleased
 
+## 0.5.1 - 2022-06-28
+
+### Fixed
+
+- Fix `Sevencop/BelongsToOptional` scope bug.
+
+## 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

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    sevencop (0.4.0)
-      rubocop (>= 1.27)
+    sevencop (0.5.1)
+      rubocop
 
 GEM
   remote: https://rubygems.org/
@@ -53,4 +53,4 @@ DEPENDENCIES
   sevencop!
 
 BUNDLED WITH
-   2.3.6
+   2.3.16

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

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,54 @@
+# 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 _ _ _ (block ...)?)
+        PATTERN
+
+        def_node_matcher :with_hash_options?, <<~PATTERN
+          (send _ _ _ (block ...)? (hash ...))
+        PATTERN
+
+        def_node_matcher :with_optional?, <<~PATTERN
+          (send _ _ _ (block ...)? (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|
+            corrector.insert_after(node.arguments[-1], ', optional: true')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -37,7 +37,10 @@ module RuboCop
         def_node_matcher :order_with_field?, <<~PATTERN
           (send
             _ ORDER_METHOD_NAMES
-            (str /field\(.+\)/)
+            {
+              (str /field\(.+\)/) |
+              (dstr <(str /field\(.+\)/) ...>)
+            }
             ...
           )
         PATTERN

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 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/{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.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-18 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,13 +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