sevencop 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319d9ad3cd53f54122dd36a4d53d4ba2b1e496831c3c26022b2a8494f5a95fdc
-  data.tar.gz: b54dd12e0177a48827cb87f35fa6af902e256f996c96a990933c08c22e8b91f5
+  metadata.gz: f744cb31d07cadbb924e1ce690b85ee2c771ff9264333c153fcc52244d596dd6
+  data.tar.gz: c594faf493963d8f188559ca1f77b7b8570c05b5936356d6fc259de2417200a7
 SHA512:
-  metadata.gz: 07d68c578fa6807867b0caa213706484ff8c04475e1f17ce0f3121a37307f0cb48962a1ee7c1782dcbaedbff34748a075a41522e8d9c79dcdf24e9d4b8aa581a
-  data.tar.gz: e47791134b21b41a4d9fcae6503db43cefb2d377391b7e3c5a7537bd5944fecd444164931df15035d628b939ce6fe5e6fac50694aef76c856c66c3a97763b04a
+  metadata.gz: ee20da1638b96c6256a257b6602afcc90a22b33c4988fd8a44b50d5f93b7ab311e7ce052f3aeef4dd0b08c40028cb1c371184a3569e8656086a96b685b62d4d9
+  data.tar.gz: 266bdf4e223ce62e269da6e850b22491d8b1dc052a8f686b972c895a86d29d067b4105e1716c78c9b5f7c2cd231b567ac1b26e58cac656f45843f2dabf5b432f

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## Unreleased
 
+## 0.6.1 - 2022-07-04
+
+### Fixed
+
+- Fix `Sevencop/HashLiteralOrder` on surrounding-space-less Hash.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.5.0)
+    sevencop (0.6.1)
       rubocop
 
 GEM
@@ -53,4 +53,4 @@ DEPENDENCIES
   sevencop!
 
 BUNDLED WITH
-   2.3.6
+   2.3.16

data/README.md

@@ -57,6 +57,26 @@ 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`.

data/config/default.yml

@@ -5,20 +5,29 @@ Sevencop/BelongsToOptional:
   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.
+  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

@@ -29,15 +29,15 @@ module RuboCop
         ].freeze
 
         def_node_matcher :without_options?, <<~PATTERN
-          (send _ _ _)
+          (send _ _ _ (block ...)?)
         PATTERN
 
         def_node_matcher :with_hash_options?, <<~PATTERN
-          (send _ _ _ (hash ...))
+          (send _ _ _ (block ...)? (hash ...))
         PATTERN
 
         def_node_matcher :with_optional?, <<~PATTERN
-          (send _ _ _ (hash <(pair (sym :optional) _) ...>))
+          (send _ _ _ (block ...)? (hash <(pair (sym :optional) _) ...>))
         PATTERN
 
         # @param [RuboCop::AST::SendNode] node
@@ -45,11 +45,7 @@ module RuboCop
           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
+            corrector.insert_after(node.arguments[-1], ', optional: true')
           end
         end
       end

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

@@ -0,0 +1,116 @@
+# 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_leading(node),
+            sort(node.pairs).map(&:source).join(",#{whitespace_between(node)}"),
+            whitespace_trailing(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_between(node)
+          if node.pairs.length >= 2
+            node.source[node.pairs[0].location.expression.end_pos + 1...node.pairs[1].location.expression.begin_pos]
+          else
+            ' '
+          end
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [String]
+        #   {    a: 1,   b: 1  }
+        #                    ^^
+        def whitespace_trailing(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.5.0'
+  VERSION = '0.6.1'
 end

data/lib/sevencop.rb

@@ -7,6 +7,7 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -42,6 +42,7 @@ files:
 - 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
@@ -72,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.