sevencop 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 405e633edd8f28955ac15fa662affb4ff70e0296d45dbdc43c75426fa51c7280
-  data.tar.gz: c943dd42168df6e02e9630ed7eb80050da6d81ed1ea8ac333d19e933b9966a8e
+  metadata.gz: ee9785d463d0e83d3f55dc1554e250e826a9cbd5aa6aacb510f11a4bdfb1947a
+  data.tar.gz: 9ca8456b525226ba8a599c4ef87f08ea208000268fa73ccf9f1501531682d294
 SHA512:
-  metadata.gz: 8ff7ec748e6078d83c4e5215ade19f42eadffeb46a1fdcdb653712d8a8f8834bfabebbb9d21253a864384fec30c06e19bd7e120fd58c2d334ca362fbf0b985ba
-  data.tar.gz: a60a3173ab3b6010563f80860ad6b591e39ba8260b2fe05ba6f0b5230d2e69d9d2441e29d4d2fb2fd5f53e5d32fe27107357a75b9d2e9db3955e63104e1dc6ca
+  metadata.gz: edc7f9620eaa81224e47c8e8785df67bc29c51a0c6969f30bd24a3d6869a64be26686ccce7c3b43c89bc89f06b9283b67030587c86eb0b7ef5598d42ee1dc90b
+  data.tar.gz: 9a3bf2ecc2eed54ae8dd6207d0f0cd93c13f577bbcab69cdc9992e42f87687e416d9612136f1483952cfb51bdf22890727b14d6d66653e9294732dcb1da8d389

data/Gemfile.lock

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

data/README.md

@@ -67,6 +67,25 @@ belongs_to :group, options
 
 This is useful for migration of `config.active_record.belongs_to_required_by_default`.
 
+### Sevencop/FactoryBotCreateList
+
+Finds possible substitutions for `FactoryBot.create_list`.
+
+```ruby
+# bad
+Array.new(2) do
+  create(:user)
+end
+
+# good
+create_list(:user, 2)
+
+# good
+Array.new(2) do |i|
+  create(:user, order: i)
+end
+```
+
 ### Sevencop/HashLiteralOrder
 
 Sort Hash literal entries by key.

data/config/default.yml

@@ -5,12 +5,24 @@ Sevencop/BelongsToOptional:
   Safe: false
   VersionAdded: '0.5'
 
+Sevencop/FactoryBotCreateList:
+  Description: |
+    Finds possible substitutions for `FactoryBot.create_list`.
+  Enabled: false
+  VersionAdded: '0.10'
+
 Sevencop/HashLiteralOrder:
   Description: |
     Sort Hash literal entries by key.
   Enabled: false
   VersionAdded: '0.6'
 
+Sevencop/InferredSpecType:
+  Description: |
+    Identifies redundant spec type.
+  Enabled: false
+  VersionAdded: '0.9'
+
 Sevencop/OrderField:
   Description: |
     Wrap safe SQL String by `Arel.sql`.

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Finds possible substitutions for `FactoryBot.create_list`.
+      #
+      # @example
+      #
+      #   # bad
+      #   Array.new(2) do
+      #     create(:user)
+      #   end
+      #
+      #   # good
+      #   create_list(:user, 2)
+      #
+      #   # good
+      #   Array.new(2) do |i|
+      #     create(:user, order: i)
+      #   end
+      #
+      # @note
+      #   This cop does not support `Integer#times` intentionally because it
+      #   should be treated by `Performance/TimesMap` cop.
+      #
+      class FactoryBotCreateList < Base
+        extend AutoCorrector
+
+        MSG = 'Use `create_list` instead.'
+
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def on_block(node)
+          count_node, factory_name_node, extra_argument_nodes = extract(node)
+          return unless count_node
+
+          add_offense(node) do |corrector|
+            corrector.replace(
+              node,
+              format(
+                'create_list(%<arguments>s)',
+                arguments: [
+                  factory_name_node,
+                  count_node,
+                  *extra_argument_nodes
+                ].map(&:source).join(', ')
+              )
+            )
+          end
+        end
+
+        private
+
+        # @!method extract(node)
+        #   @param node [RuboCop::AST::BlockNode]
+        #   @return [Array(Integer, RuboCop::AST::SendNode)]
+        def_node_matcher :extract, <<~PATTERN
+          (block
+            (send
+              (const {nil? | cbase} :Array)
+              :new
+              $(int _)
+            )
+            (args)
+            (send
+              nil?
+              :create
+              $(sym _) $(...)?
+            )
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::BlockNode]
+        # @return [void]
+        def autocorrect(corrector, node)
+          count_node, factory_name_node, extra_argument_nodes = extract(node)
+          corrector.replace(
+            node,
+            format(
+              'create_list(%<arguments>s)',
+              arguments: [
+                factory_name_node,
+                count_node,
+                *extra_argument_nodes
+              ].map(&:source).join(', ')
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -55,13 +55,13 @@ module RuboCop
         # @param [RuboCop::AST::HashNode] node
         # @return [String]
         def autocorrect(node)
-          [
-            '{',
+          parts = [
             whitespace_leading(node),
             sort(node.pairs).map(&:source).join(",#{whitespace_between(node)}"),
-            whitespace_trailing(node),
-            '}'
-          ].join
+            whitespace_trailing(node)
+          ]
+          parts = ['{', *parts, '}'] if node.braces?
+          parts.join
         end
 
         # @param [Array<RuboCop::AST::PairNode>] pairs
@@ -84,7 +84,9 @@ module RuboCop
         #             ^^^
         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]
+            processed_source.raw_source[
+              node.pairs[0].location.expression.end_pos + 1...node.pairs[1].location.expression.begin_pos
+            ]
           else
             ' '
           end
@@ -95,7 +97,9 @@ module RuboCop
         #   {    a: 1,   b: 1  }
         #                    ^^
         def whitespace_trailing(node)
-          node.source[node.pairs[-1].location.expression.end_pos...node.location.end.begin_pos]
+          processed_source.raw_source[
+            node.pairs[-1].location.expression.end_pos...node.location.expression.end.begin_pos - offset_for(node)
+          ]
         end
 
         # @param [RuboCop::AST::HashNode] node
@@ -103,7 +107,19 @@ module RuboCop
         #   {    a: 1,   b: 1  }
         #    ^^^^
         def whitespace_leading(node)
-          node.source[node.location.begin.end_pos...node.pairs[0].location.expression.begin_pos]
+          processed_source.raw_source[
+            node.location.expression.begin.end_pos + offset_for(node)...node.pairs[0].location.expression.begin_pos
+          ]
+        end
+
+        # @param [RuboCop::AST::HashNode] node
+        # @return [Integer]
+        def offset_for(node)
+          if node.braces?
+            1
+          else
+            0
+          end
         end
       end
     end

data/lib/sevencop/config_loader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Sevencop
+  # Merge default RuboCop config with plugin config.
+  class ConfigLoader
+    PLUGIN_CONFIG_PATH = ::File.expand_path(
+      '../../config/default.yml',
+      __dir__
+    )
+
+    class << self
+      # @return [RuboCop::Config]
+      def call
+        new.call
+      end
+    end
+
+    # @return [RuboCop::Config]
+    def call
+      ::RuboCop::ConfigLoader.merge_with_default(
+        plugin_config,
+        PLUGIN_CONFIG_PATH
+      )
+    end
+
+    private
+
+    # @return [RuboCop::Config]
+    def plugin_config
+      config = ::RuboCop::Config.new(
+        plugin_config_hash,
+        PLUGIN_CONFIG_PATH
+      )
+      config.make_excludes_absolute
+      config
+    end
+
+    # @return [Hash]
+    def plugin_config_hash
+      ::RuboCop::ConfigLoader.send(
+        :load_yaml_configuration,
+        PLUGIN_CONFIG_PATH
+      )
+    end
+  end
+end

data/lib/sevencop/rubocop_extension.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'config_loader'
+
+RuboCop::ConfigLoader.instance_variable_set(
+  :@default_configuration,
+  Sevencop::ConfigLoader.call
+)

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'yaml'
-
-require_relative 'sevencop/inject'
+require_relative 'sevencop/rubocop_extension'
 require_relative 'sevencop/version'
 
 require_relative 'rubocop/cop/sevencop/belongs_to_optional'
+require_relative 'rubocop/cop/sevencop/factory_bot_create_list'
 require_relative 'rubocop/cop/sevencop/hash_literal_order'
 require_relative 'rubocop/cop/sevencop/inferred_spec_type'
 require_relative 'rubocop/cop/sevencop/order_field'
@@ -14,15 +12,3 @@ 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
-
-  CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-
-  CONFIG = ::YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-  private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-end
-
-Sevencop::Inject.defaults!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -42,6 +42,7 @@ files:
 - Rakefile
 - config/default.yml
 - lib/rubocop/cop/sevencop/belongs_to_optional.rb
+- lib/rubocop/cop/sevencop/factory_bot_create_list.rb
 - lib/rubocop/cop/sevencop/hash_literal_order.rb
 - lib/rubocop/cop/sevencop/inferred_spec_type.rb
 - lib/rubocop/cop/sevencop/order_field.rb
@@ -50,7 +51,8 @@ files:
 - 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/config_loader.rb
+- lib/sevencop/rubocop_extension.rb
 - lib/sevencop/version.rb
 - sevencop.gemspec
 homepage: https://github.com/r7kamura/sevencop

data/lib/sevencop/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/main/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/main/MIT-LICENSE.md
-module Sevencop
-  module Inject
-    def self.defaults!
-      path = CONFIG_DEFAULT.to_s
-      hash = ::RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
-      config = ::RuboCop::Config.new(hash, path).tap(&:make_excludes_absolute)
-      puts "configuration from #{path}" if ::RuboCop::ConfigLoader.debug?
-      config = ::RuboCop::ConfigLoader.merge_with_default(config, path)
-      ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
-  end
-end