sevencop 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef38866fd82173f9e717566ed4ddacaa43571eda5760cc72b37ec615256e32cc
-  data.tar.gz: cf4aa55ea75a1eeebfae8a1d4ac311e83611a54b365911d4bf8d244fafbc587d
+  metadata.gz: 58fe0254e47cc59376f53d38640a163d0ba80dfba6f3f41998350b1b049010fd
+  data.tar.gz: 969301c9b0ef1af7ab3170c63fd72f5f8d6b095de2c84f2818917a003afe59cb
 SHA512:
-  metadata.gz: 744673cf9ae424e870f5a7526a61c19f3b124597e83554c81967544cfdf617992bc2d46c464347cef5f654a5aca1654486511abb85afb0c3123719b6214411f6
-  data.tar.gz: 81873ee0905b64eb4aa51cf7d0f93e62a87d2fd616a8c18756fe8d1ac68f023e0e8c0d5b6a2e77847bdf482edee2036956afc15248975292c10f1965488009d5
+  metadata.gz: be7586aef6236eab74b74494893ed7af665f01c4879ea36f63d6695250170174175859c439e7a6dd39775095b1ae210fa80a8d4e2e4f8a3c177e6ccc060c9c81
+  data.tar.gz: 7003edbafb17736c0e0bdfaaf65c1e1340fb45b684b31b1d573d6977f19e8c192700fb8bb4b57d0003f32753d2438110b6de937da42832a06641118c6e2b0c08

data/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 ## Unreleased
 
+## 0.6.0 - 2022-07-04
+
+### Added
+
+- Add `Sevencop/HashLiteralOrder` cop.
+
+### Removed
+
+- Remove unnecessary method names check on `Sevencop/OrderField`.
+
+## 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

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    sevencop (0.4.1)
-      rubocop (>= 1.27)
+    sevencop (0.6.0)
+      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,48 @@ 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/HashLiteralOrder
+
+Sort Hash literal by key.
+
+```ruby
+# bad
+{
+  b: 1,
+  a: 1,
+  c: 1
+}
+
+# good
+{
+  a: 1,
+  b: 1,
+  c: 1
+}
+```
+
 ### Sevencop/OrderField
 
 Identifies a String including "field" is passed to `order` or `reorder`.
@@ -53,8 +95,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 +135,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,17 +1,33 @@
+Sevencop/BelongsToOptional:
+  Description: |
+    Force `belongs_to` with `optional: true` option.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.5'
+
+Sevencop/HashLiteralOrder:
+  Description: |
+    Sort Hash literal entries by key.
+  Enabled: false
+  VersionAdded: '0.6'
+
 Sevencop/OrderField:
-  Description: Wrap safe SQL String by `Arel.sql`.
+  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
+  Description: |
+    Avoid redundant existent check before file operation.
+  Enabled: false
   Safe: false
   VersionAdded: '0.1'
 
 Sevencop/UniquenessValidatorExplicitCaseSensitivity:
-  Description: Specify :case_sensitivity option on use of UniquenessValidator.
+  Description: |
+    Specify :case_sensitivity option on use of UniquenessValidator.
   Enabled: false
   Safe: false
   VersionAdded: '0.3'

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/hash_literal_order.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Sort Hash literal entries by key.
+      #
+      # @example
+      #
+      #   # bad
+      #   {
+      #     b: 1,
+      #     a: 1,
+      #     c: 1
+      #   }
+      #
+      #   # good
+      #   {
+      #     a: 1,
+      #     b: 1,
+      #     c: 1
+      #   }
+      #
+      class HashLiteralOrder < Base
+        extend AutoCorrector
+
+        MSG = 'Sort Hash literal entries by key.'
+
+        def_node_matcher :hash_literal?, <<~PATTERN
+          (hash
+            (pair
+              {sym | str}
+              _
+            )+
+          )
+        PATTERN
+
+        # @param [RuboCop::AST::HashNode] node
+        def on_hash(node)
+          return unless hash_literal?(node)
+
+          return if sorted?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(
+              node,
+              autocorrect(node)
+            )
+          end
+        end
+
+        private
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [String]
+        def autocorrect(node)
+          whitespace = whitespace_leading(node)
+          [
+            '{',
+            whitespace,
+            sort(node.pairs).map(&:source).join(",#{whitespace}"),
+            whitespace_ending(node),
+            '}'
+          ].join
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [Boolean]
+        def multi_line?(node)
+          node.source.include?("\n")
+        end
+
+        # @param [Array<RuboCop::AST::PairNode>] pairs
+        # @return [Array<RuboCop::AST::PairNode>]
+        def sort(pairs)
+          pairs.sort_by do |pair|
+            pair.key.value
+          end
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [Boolean]
+        def sorted?(node)
+          node.pairs.map(&:source) == sort(node.pairs).map(&:source)
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [String]
+        #   {    a: 1,    b: 1  }
+        #                     ^^
+        def whitespace_ending(node)
+          node.source[node.pairs[-1].location.expression.end_pos...node.location.end.begin_pos]
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [String]
+        #   {    a: 1,    b: 1  }
+        #    ^^^^
+        def whitespace_leading(node)
+          node.source[node.location.begin.end_pos...node.pairs[0].location.expression.begin_pos]
+        end
+      end
+    end
+  end
+end

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

@@ -32,11 +32,9 @@ module RuboCop
           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\(.+\)/) ...>)

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.4.1'
+  VERSION = '0.6.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/hash_literal_order'
 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.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-07-03 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,8 @@ files:
 - README.md
 - Rakefile
 - config/default.yml
+- lib/rubocop/cop/sevencop/belongs_to_optional.rb
+- lib/rubocop/cop/sevencop/hash_literal_order.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
@@ -71,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Custom cops for RuboCop.