sevencop 0.6.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f744cb31d07cadbb924e1ce690b85ee2c771ff9264333c153fcc52244d596dd6
-  data.tar.gz: c594faf493963d8f188559ca1f77b7b8570c05b5936356d6fc259de2417200a7
+  metadata.gz: 7ed10e2f4687671a6868a81d9c550490d309bc0f604c7b2f596db6efa9ef7ef9
+  data.tar.gz: a097023dd73739464bc3c55f0d30cc89166eb8caa22201b3419a1ccaa778295c
 SHA512:
-  metadata.gz: ee20da1638b96c6256a257b6602afcc90a22b33c4988fd8a44b50d5f93b7ab311e7ce052f3aeef4dd0b08c40028cb1c371184a3569e8656086a96b685b62d4d9
-  data.tar.gz: 266bdf4e223ce62e269da6e850b22491d8b1dc052a8f686b972c895a86d29d067b4105e1716c78c9b5f7c2cd231b567ac1b26e58cac656f45843f2dabf5b432f
+  metadata.gz: 3037aad57ef04821ea70c518a5d1cbc4bd69bbfb8460ac22887bee480ae9d599c871ed77226944ca29f1cdd24060558b3358513919c486af4bdce7e5d8980e08
+  data.tar.gz: 956951c7a21d5c1315bee2e6a77ce21307c8889cbdeebca5931a40c5f8a21bdb8c89703054e2304ca2760f5878b0d211ed92613a27b2825ab514a9a9657192b4

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,22 @@
 
 ## Unreleased
 
+### Changed
+
+- Improve `Sevencop/ToSWithArgument` performance.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.6.1)
+    sevencop (0.8.1)
       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

@@ -63,12 +63,6 @@ module RuboCop
           ].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)

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

@@ -36,8 +36,8 @@ module RuboCop
           (send
             _ _
             {
-              (str /field\(.+\)/) |
-              (dstr <(str /field\(.+\)/) ...>)
+              (str /field\(.+\)/i) |
+              (dstr <(str /field\(.+\)/i) ...>)
             }
             ...
           )

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

@@ -0,0 +1,41 @@
+# 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(...)`.'
+
+        RESTRICT_ON_SEND = %i[to_s].freeze
+
+        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.1'
+  VERSION = '0.8.1'
 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.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2022-08-11 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