sevencop 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021c0c8e909037a665540671725553ec8a0a071aea513ea2ad39e62a104141cc
-  data.tar.gz: af3cbb3aaae938b0fa209995ca76dd65622aed3a4039d48a91dd4eaada3108eb
+  metadata.gz: 405e633edd8f28955ac15fa662affb4ff70e0296d45dbdc43c75426fa51c7280
+  data.tar.gz: c943dd42168df6e02e9630ed7eb80050da6d81ed1ea8ac333d19e933b9966a8e
 SHA512:
-  metadata.gz: df542292fe608cc072d4770263cbcaa3df4ad040d3b59c93362b3188ac54ab56285a36199451a95476927b85cbb92d67c164d3cf5b184834c87a78d3745ef343
-  data.tar.gz: 7289c90669cbe86f3eb025b71d2083fd60b1993ba8e5035bea7f06aecb2f1ccd8c274e53b29daea81358ac5d641a5be325189cda929035fae8b0dd127a4b360a
+  metadata.gz: 8ff7ec748e6078d83c4e5215ade19f42eadffeb46a1fdcdb653712d8a8f8834bfabebbb9d21253a864384fec30c06e19bd7e120fd58c2d334ca362fbf0b985ba
+  data.tar.gz: a60a3173ab3b6010563f80860ad6b591e39ba8260b2fe05ba6f0b5230d2e69d9d2441e29d4d2fb2fd5f53e5d32fe27107357a75b9d2e9db3955e63104e1dc6ca

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.8.0)
+    sevencop (0.9.1)
       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/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.include?(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

@@ -18,6 +18,9 @@ module RuboCop
 
         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

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.8.0'
+  VERSION = '0.9.1'
 end

data/lib/sevencop.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 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,6 +43,7 @@ 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

data/CHANGELOG.md

@@ -1,87 +0,0 @@
-# Changelog
-
-## 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
-
-- 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.