sevencop 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db281c40f5207dfc9759c52c60d4e2799d772e8d612364c4afa9b72eb935c90a
-  data.tar.gz: f84b8ca1a7d8cdb598c170b9c04b98b2358750ced29a8d3b3fb011b8a629449c
+  metadata.gz: 435ef77ac8fd3b1e598c538068a02cf91bce3e1d3143bd1e48b45ed80b9a8cd1
+  data.tar.gz: 8bc5d65cde82f92a7f6457041cd49a1448af80d1915841a44a4fc2c22b7b0877
 SHA512:
-  metadata.gz: 4597d82f8b5dd02a575d4720c10f495e6ebf16bfe47ef88c9557e5cb474c83bc35505861e2a1e5fdbc3b1d062fac6a06d3cfe94a05593ee9638a0aecf1034125
-  data.tar.gz: 3e9c4206cec1f67a0ab9176814f4405fe6d7fbe83c8571d0759788206b67569a8ad144f0cb934dbc2ddf30df29d529906f7160c5b029fbc13a60464229f2a8d6
+  metadata.gz: f53c512de8a6c32b2c4a409dc274dc22149c3ef15b680c8223e58a74bcac0015ccb3dd2d2e397fbb410bdf6f949e9f3d1de645c8332204a88dce7ab6ca5194da
+  data.tar.gz: 2fd6cc8caf282c894b41744ae7df09d54017ce02d82ac3ab4925c85cde00a1aa0b8fd0ebc0fac5ec70f25dd8ab5fbfa79160102456a2a58ffafd3da1ffb92689

data/.rubocop.yml

@@ -3,15 +3,8 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.6
 
-Layout/LineLength:
-  Enabled: false
-
 Metrics:
   Enabled: false
 
-Naming/FileName:
- Exclude:
-   - lib/sevencop.rb
-
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## Unreleased
 
+## 0.7.0 - 2022-07-15
+
+### Added
+
+- Add `Sevencop/WhereNot` cop.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.5.1)
+    sevencop (0.7.0)
       rubocop
 
 GEM
@@ -9,12 +9,13 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -25,23 +26,24 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.27.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   x86_64-linux
@@ -53,4 +55,4 @@ DEPENDENCIES
   sevencop!
 
 BUNDLED WITH
-   2.3.16
+   2.3.17

data/README.md

@@ -27,12 +27,22 @@ gem install sevencop
 
 ## Usage
 
+Require sevencop from your .rubocop.yml:
+
 ```yaml
 # .rubocop.yml
 require:
   - sevencop
 ```
 
+then enable the cops you want to use:
+
+```yaml
+# .rubocop.yml
+Sevencop/BelongsToOptional:
+  Enabled: true
+```
+
 ## Cops
 
 All cops are `Enabled: false` by default.
@@ -57,6 +67,26 @@ belongs_to :group, options
 
 This is useful for migration of `config.active_record.belongs_to_required_by_default`.
 
+### Sevencop/HashLiteralOrder
+
+Sort Hash literal entries 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`.
@@ -115,3 +145,15 @@ 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.
+
+### Sevencop/WhereNot
+
+Identifies passing multi-elements Hash literal to `where.not`.
+
+```ruby
+# bad
+where.not(key1: value1, key2: value2)
+
+# good
+where.not(key1: value1).where.not(key2: value2)
+```

data/config/default.yml

@@ -5,20 +5,36 @@ 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'
+
+Sevencop/WhereNot:
+  Description: |
+    Identifies passing multi-elements Hash literal to `where.not`.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.7'

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

@@ -0,0 +1,110 @@
+# 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 [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/rubocop/cop/sevencop/uniqueness_validator_explicit_case_sensitivity.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Sevencop
       # Identifies use of UniquenessValidator without :case_sensitive option.
-      # This is useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
+      # Useful to keep the same behavior between Rails 6.0 and 6.1 where case insensitive collation is used in MySQL.
       #
       # @safety
       #   This cop is unsafe because it can register a false positive.

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Identifies passing multi-elements Hash literal to `where.not`.
+      #
+      # @example
+      #
+      #   # bad
+      #   where.not(key1: value1, key2: value2)
+      #
+      #   # good
+      #   where.not(key1: value1).where.not(key2: value2)
+      #
+      class WhereNot < Base
+        extend AutoCorrector
+
+        MSG = 'Use `where.not(key1: value1).where.not(key2: value2)` style.'
+
+        def_node_matcher :where_not_with_multiple_elements_hash?, <<~PATTERN
+          (send
+            (send _ :where) :not
+            ({ hash | kwargs }
+              (pair _ _)
+              (pair _ _)+))
+        PATTERN
+
+        def on_send(node)
+          return unless where_not_with_multiple_elements_hash?(node)
+
+          add_offense(node) do |corrector|
+            pairs = node.children[2].children
+            last_end_pos = pairs[0].location.expression.end_pos
+            pairs[1..].each do |pair|
+              corrector.remove(pair.location.expression.with(begin_pos: last_end_pos))
+              last_end_pos = pair.location.expression.end_pos
+              corrector.insert_after(node.location.expression, ".where.not(#{pair.source})")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.5.1'
+  VERSION = '0.7.0'
 end

data/lib/sevencop.rb

@@ -7,9 +7,11 @@ 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'
+require_relative 'rubocop/cop/sevencop/where_not'
 
 module Sevencop
   PROJECT_ROOT = ::Pathname.new(__dir__).parent.expand_path.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -42,9 +42,11 @@ 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
+- lib/rubocop/cop/sevencop/where_not.rb
 - lib/sevencop.rb
 - lib/sevencop/inject.rb
 - lib/sevencop/version.rb