sevencop 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58fe0254e47cc59376f53d38640a163d0ba80dfba6f3f41998350b1b049010fd
-  data.tar.gz: 969301c9b0ef1af7ab3170c63fd72f5f8d6b095de2c84f2818917a003afe59cb
+  metadata.gz: 021c0c8e909037a665540671725553ec8a0a071aea513ea2ad39e62a104141cc
+  data.tar.gz: af3cbb3aaae938b0fa209995ca76dd65622aed3a4039d48a91dd4eaada3108eb
 SHA512:
-  metadata.gz: be7586aef6236eab74b74494893ed7af665f01c4879ea36f63d6695250170174175859c439e7a6dd39775095b1ae210fa80a8d4e2e4f8a3c177e6ccc060c9c81
-  data.tar.gz: 7003edbafb17736c0e0bdfaaf65c1e1340fb45b684b31b1d573d6977f19e8c192700fb8bb4b57d0003f32753d2438110b6de937da42832a06641118c6e2b0c08
+  metadata.gz: df542292fe608cc072d4770263cbcaa3df4ad040d3b59c93362b3188ac54ab56285a36199451a95476927b85cbb92d67c164d3cf5b184834c87a78d3745ef343
+  data.tar.gz: 7289c90669cbe86f3eb025b71d2083fd60b1993ba8e5035bea7f06aecb2f1ccd8c274e53b29daea81358ac5d641a5be325189cda929035fae8b0dd127a4b360a

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,24 @@
 
 ## Unreleased
 
+## 0.8.0 - 2022-07-20
+
+### Added
+
+ - Add `Sevencop/ToSWithArgument` cop.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.6.0)
+    sevencop (0.8.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.
@@ -59,7 +69,7 @@ This is useful for migration of `config.active_record.belongs_to_required_by_def
 
 ### Sevencop/HashLiteralOrder
 
-Sort Hash literal by key.
+Sort Hash literal entries by key.
 
 ```ruby
 # bad
@@ -135,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

@@ -25,9 +25,23 @@ Sevencop/RedundantExistenceCheck:
   Safe: false
   VersionAdded: '0.1'
 
+Sevencop/ToSWithArgument:
+  Description: |
+    Identifies passing any argument to `#to_s`.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.8'
+
 Sevencop/UniquenessValidatorExplicitCaseSensitivity:
   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

@@ -54,22 +54,15 @@ module RuboCop
         # @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),
+            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)
@@ -86,15 +79,27 @@ module RuboCop
 
         # @param [RuboCop::AST::HashNode] node
         # @return [String]
-        #   {    a: 1,    b: 1  }
-        #                     ^^
-        def whitespace_ending(node)
+        #   {    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  }
+        #   {    a: 1,   b: 1  }
         #    ^^^^
         def whitespace_leading(node)
           node.source[node.location.begin.end_pos...node.pairs[0].location.expression.begin_pos]

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Identifies passing any argument to `#to_s`.
+      #
+      # @example
+      #
+      #   # bad
+      #   to_s(:delimited)
+      #
+      #   # good
+      #   to_formatted_s(:delimited)
+      #
+      class ToSWithArgument < Base
+        extend AutoCorrector
+
+        MSG = 'Use `to_formatted_s(...)` instead of `to_s(...)`.'
+
+        def_node_matcher :to_s_with_any_argument?, <<~PATTERN
+          (call _ :to_s _+)
+        PATTERN
+
+        def on_send(node)
+          return unless to_s_with_any_argument?(node)
+
+          add_offense(node) do |rewriter|
+            rewriter.replace(
+              node.loc.selector,
+              'to_formatted_s'
+            )
+          end
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

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.6.0'
+  VERSION = '0.8.0'
 end

data/lib/sevencop.rb

@@ -10,7 +10,9 @@ 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/to_s_with_argument'
 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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -45,7 +45,9 @@ files:
 - 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/to_s_with_argument.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