sevencop 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 435ef77ac8fd3b1e598c538068a02cf91bce3e1d3143bd1e48b45ed80b9a8cd1
-  data.tar.gz: 8bc5d65cde82f92a7f6457041cd49a1448af80d1915841a44a4fc2c22b7b0877
+  metadata.gz: 823af30bd6e2d7b7c9b9a433125915e5fcd002dfb9b332206dea852d8fc8c711
+  data.tar.gz: 59c81c197e486e596a43402497555718cc660f08d63e7827ca98f82bb351798c
 SHA512:
-  metadata.gz: f53c512de8a6c32b2c4a409dc274dc22149c3ef15b680c8223e58a74bcac0015ccb3dd2d2e397fbb410bdf6f949e9f3d1de645c8332204a88dce7ab6ca5194da
-  data.tar.gz: 2fd6cc8caf282c894b41744ae7df09d54017ce02d82ac3ab4925c85cde00a1aa0b8fd0ebc0fac5ec70f25dd8ab5fbfa79160102456a2a58ffafd3da1ffb92689
+  metadata.gz: 0de80f55882209fc927e0db5840e74a970af9d49504cf11013cd3e6da8f9a0195eaa7875fb794f2f8823402264b506ca7d77b0af7ac99cee9b15412d93d67805
+  data.tar.gz: 27c7ff5b059a95ca7b6dde3e3bc6814767e7d10db67c17504e1953fe4db6ae6ac1f3cc3b1d2ec91415630688d6614b7d53b138e622eb688c0e4745bebbb22236

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop/cop/internal_affairs
+
 AllCops:
   NewCops: enable
   SuggestExtensions: false

data/.yardopts

@@ -0,0 +1 @@
+--tag safety:"Cop Safety Information"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.7.0)
+    sevencop (0.9.0)
       rubocop
 
 GEM

data/README.md

@@ -87,6 +87,24 @@ Sort Hash literal entries by key.
 }
 ```
 
+### Sevencop/InferredSpecType
+
+Identifies redundant spec type.
+
+```ruby
+# bad
+# spec/models/user_spec.rb
+RSpec.describe User, type: :model
+
+# good
+# spec/models/user_spec.rb
+RSpec.describe User
+
+# good
+# spec/models/user_spec.rb
+RSpec.describe User, type: :request
+```
+
 ### Sevencop/OrderField
 
 Identifies a String including "field" is passed to `order` or `reorder`.

data/config/default.yml

@@ -25,6 +25,13 @@ 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.

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

@@ -28,14 +28,17 @@ module RuboCop
           belongs_to
         ].freeze
 
+        # @!method without_options?(node)
         def_node_matcher :without_options?, <<~PATTERN
           (send _ _ _ (block ...)?)
         PATTERN
 
+        # @!method with_hash_options?(node)
         def_node_matcher :with_hash_options?, <<~PATTERN
           (send _ _ _ (block ...)? (hash ...))
         PATTERN
 
+        # @!method with_optional?(node)
         def_node_matcher :with_optional?, <<~PATTERN
           (send _ _ _ (block ...)? (hash <(pair (sym :optional) _) ...>))
         PATTERN

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

@@ -26,6 +26,7 @@ module RuboCop
 
         MSG = 'Sort Hash literal entries by key.'
 
+        # @!method hash_literal?(node)
         def_node_matcher :hash_literal?, <<~PATTERN
           (hash
             (pair

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Identifies redundant spec type.
+      # This is automatically set by `config.infer_spec_type_from_file_location!`.
+      #
+      # @example
+      #
+      #   # bad
+      #   # spec/models/user_spec.rb
+      #   RSpec.describe User, type: :model
+      #
+      #   # good
+      #   # spec/models/user_spec.rb
+      #   RSpec.describe User
+      #
+      #   # good
+      #   # spec/models/user_spec.rb
+      #   RSpec.describe User, type: :request
+      #
+      class InferredSpecType < Base
+        extend AutoCorrector
+
+        # @return [Array<Hash>]
+        INFERENCES = [
+          { prefix: 'spec/channels/', type: :channel },
+          { prefix: 'spec/controllers/', type: :controller },
+          { prefix: 'spec/features/', type: :feature },
+          { prefix: 'spec/generator/', type: :generator },
+          { prefix: 'spec/helpers/', type: :helper },
+          { prefix: 'spec/jobs/', type: :job },
+          { prefix: 'spec/mailboxes/', type: :mailbox },
+          { prefix: 'spec/mailers/', type: :mailer },
+          { prefix: 'spec/models/', type: :model },
+          { prefix: 'spec/requests/', type: :request },
+          { prefix: 'spec/integration/', type: :request },
+          { prefix: 'spec/api/', type: :request },
+          { prefix: 'spec/routing/', type: :routing },
+          { prefix: 'spec/system/', type: :system },
+          { prefix: 'spec/views/', type: :view }
+        ].freeze
+
+        MSG = 'Remove redundant spec type.'
+
+        RESTRICT_ON_SEND = %i[
+          describe
+        ].freeze
+
+        # @param [RuboCop::AST::SendNode] node
+        def on_send(node)
+          pair_node = describe_with_type(node)
+          return unless pair_node
+          return unless inferred_type?(pair_node)
+
+          removable_node = detect_removable_node(pair_node)
+          add_offense(removable_node) do |corrector|
+            autocorrect(corrector, removable_node)
+          end
+        end
+
+        private
+
+        # @!method describe_with_type(node)
+        #   @param [RuboCop::AST::SendNode] node
+        #   @return [RuboCop::AST::PairNode, nil]
+        def_node_matcher :describe_with_type, <<~PATTERN
+          (send
+            { (const nil? :RSpec) | nil? }
+            _
+            _
+            _*
+            ({ hash | kwargs }
+              (pair ...)*
+              $(pair (sym :type) (sym _))
+              (pair ...)*
+            )
+          )
+        PATTERN
+
+        # @param [RuboCop::AST::Corrector] corrector
+        # @param [RuboCop::AST::Node] node
+        def autocorrect(corrector, node)
+          corrector.remove(
+            node.location.expression.with(
+              begin_pos: node.left_sibling.location.expression.end_pos
+            )
+          )
+        end
+
+        # @param [RuboCop::AST::PairNode] node
+        # @return [RuboCop::AST::Node]
+        def detect_removable_node(node)
+          if node.parent.pairs.size == 1
+            node.parent
+          else
+            node
+          end
+        end
+
+        # @return [String]
+        def file_path
+          processed_source.file_path
+        end
+
+        # @param [RuboCop::AST::PairNode] node
+        # @return [Boolean]
+        def inferred_type?(node)
+          inferred_type_from_file_path.inspect == node.value.source
+        end
+
+        # @return [Symbol, nil]
+        def inferred_type_from_file_path
+          INFERENCES.find do |inference|
+            break inference[:type] if file_path.start_with?(inference[:prefix])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,12 +32,13 @@ module RuboCop
           reorder
         ].freeze
 
+        # @!method order_with_field?(node)
         def_node_matcher :order_with_field?, <<~PATTERN
           (send
             _ _
             {
-              (str /field\(.+\)/) |
-              (dstr <(str /field\(.+\)/) ...>)
+              (str /field\(.+\)/i) |
+              (dstr <(str /field\(.+\)/i) ...>)
             }
             ...
           )

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

@@ -84,6 +84,7 @@ module RuboCop
 
         MSG = 'Avoid redundant existent check before file operation.'
 
+        # @!method make_unless_exist?(node)
         def_node_matcher :make_unless_exist?, <<~PATTERN
           (if
             (send (const nil? CLASS_NAMES_FOR_EXIST) METHOD_NAMES_FOR_EXIST _)
@@ -92,6 +93,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method remove_if_exist?(node)
         def_node_matcher :remove_if_exist?, <<~PATTERN
           (if
             (send (const nil? CLASS_NAMES_FOR_EXIST) METHOD_NAMES_FOR_EXIST _)

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

@@ -0,0 +1,42 @@
+# 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
+
+        # @!method to_s_with_any_argument?(node)
+        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

@@ -33,6 +33,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[validates].freeze
 
+        # @!method validates_uniqueness?(node)
         def_node_matcher :validates_uniqueness?, <<~PATTERN
           (send nil? :validates
             _
@@ -48,6 +49,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method validates_uniqueness_with_case_sensitivity?(node)
         def_node_matcher :validates_uniqueness_with_case_sensitivity?, <<~PATTERN
           (send nil? :validates
             _
@@ -84,7 +86,6 @@ module RuboCop
         end
 
         # @param [RuboCop::AST::SendNode] node
-        # @param [RuboCop::AST::Node]
         def find_uniqueness_value(node)
           node.arguments[1].pairs.find { |pair| pair.key.value == :uniqueness }.value
         end

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

@@ -18,6 +18,7 @@ module RuboCop
 
         MSG = 'Use `where.not(key1: value1).where.not(key2: value2)` style.'
 
+        # @!method where_not_with_multiple_elements_hash?(node)
         def_node_matcher :where_not_with_multiple_elements_hash?, <<~PATTERN
           (send
             (send _ :where) :not

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -8,8 +8,10 @@ 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/inferred_spec_type'
 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'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -33,7 +33,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -43,8 +43,10 @@ files:
 - config/default.yml
 - lib/rubocop/cop/sevencop/belongs_to_optional.rb
 - lib/rubocop/cop/sevencop/hash_literal_order.rb
+- lib/rubocop/cop/sevencop/inferred_spec_type.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

data/CHANGELOG.md

@@ -1,81 +0,0 @@
-# Changelog
-
-## 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
-
-- 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
-
-- Fix `Sevencop/OrderField` on dstr.
-
-## 0.4.0 - 2022-06-18
-
-### Added
-
-- Add `Sevencop/OrderField` cop.
-
-### Changed
-
-- Improve performance of `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
-- Improve offense location of `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
-
-## 0.3.0 - 2022-06-18
-
-### Added
-
-- Add `Sevencop/UniquenessValidatorExplicitCaseSensitivity` cop.
-
-## 0.2.0 - 2022-06-07
-
-### Changed
-
-- Correct to enforced operation at `Sevencop/RedundantExistenceCheck`.
-
-## 0.1.0 - 2022-06-07
-
-### Added
-
-- Initial release.
-- Add `Sevencop/RedundantExistenceCheck` cop.