sevencop 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc5d0adbf2ac9b5c3aa8ac43e1e375f82efa0906710ca38bd41c145c3a2bb41
-  data.tar.gz: fd8b73bcc7ea73410c6634a3dbd5fcb3b38f3af26570482b22a2d05b2f42f6b3
+  metadata.gz: ed778fc5bb1459cd5c3c35812b5274177e48515b434b2581c897f40ae6d47448
+  data.tar.gz: 179393f59351517e7d510cdf5a1a4c0762d2b2f64186f0f8470017125ae42d77
 SHA512:
-  metadata.gz: 9024936b3ef659bae3242f40c793e72249edde9d6838f65edf570039077aad0abebe18ad8e2be52dad270ef4322bce2b841ffc33d42323a151b55b97d86cdc5a
-  data.tar.gz: 19450fde029f352c3bba68362bb8a0db0c2ec01ceb319702565083768d281613b9bd123b34345f1096350a6bd3eab7efdb89079cd0f63526406f8d6b0b404b9c
+  metadata.gz: cc12be9dc75e7507094a9349560ce08f8e9d5e61755837d2747fd101763b51885383b4d4f3416571303ea9e8e593ed0dc99cc6581206c248a82a41c5ce53a874
+  data.tar.gz: 96286dac7849f571eac18cfde45e76b81044f0381246943082f003abab28109b9f1b19c9127e013a260d1deb7654b6e67a03133714caa9d86b02dc6830645660

data/Gemfile.lock

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

data/README.md

@@ -49,7 +49,7 @@ All cops are `Enabled: false` by default.
 
 ### Sevencop/AutoloadOrdered
 
-Sort `autoload` in alphabetical order.
+Sort `autoload` in alphabetical order within their section.
 
 ```ruby
 # bad
@@ -59,6 +59,13 @@ autoload :A, 'a'
 # good
 autoload :A, 'a'
 autoload :B, 'b'
+
+# good
+autoload :B, 'b'
+autoload :D, 'd'
+
+autoload :A, 'a'
+autoload :C, 'a'
 ```
 
 ### Sevencop/BelongsToOptional
@@ -81,25 +88,6 @@ 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.
@@ -138,6 +126,24 @@ RSpec.describe User
 RSpec.describe User, type: :request
 ```
 
+### Sevencop/MethodDefinitionKeywordArgumentsOrdered
+
+Sort method definition keyword arguments in alphabetical order.
+
+```ruby
+# bad
+def foo(b:, a:); end
+
+# good
+def foo(a:, b:); end
+
+# bad
+def foo(c:, d:, b: 1, a: 2); end
+
+# good
+def foo(c:, d:, a: 2, b: 1); end
+```
+
 ### Sevencop/MethodDefinitionMultilineArguments
 
 Inserts new lines between method definition parameters.
@@ -176,24 +182,6 @@ reorder('field(id, ?)', a)
 reorder(Arel.sql('field(id, ?)'), a)
 ```
 
-### Sevencop/RedundantExistenceCheck
-
-Identifies redundant existent check before file operation.
-
-```ruby
-# bad
-FileUtils.mkdir(a) unless FileTest.exist?(a)
-
-# good
-FileUtils.mkdir_p(a)
-
-# bad
-FileUtils.rm(a) if FileTest.exist?(a)
-
-# good
-FileUtils.rm_f(a)
-```
-
 ### Sevencop/UniquenessValidatorExplicitCaseSensitivity
 
 Identifies use of UniquenessValidator without :case_sensitive option.

data/config/default.yml

@@ -2,7 +2,7 @@ Sevencop/AutoloadOrdered:
   Description: |
     Sort `autoload` in alphabetical order.
   Enabled: false
-  VersionAdded: '0.12.0'
+  VersionAdded: '0.12'
 
 Sevencop/BelongsToOptional:
   Description: |
@@ -11,12 +11,6 @@ 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.
@@ -29,6 +23,12 @@ Sevencop/InferredSpecType:
   Enabled: false
   VersionAdded: '0.9'
 
+Sevencop/MethodDefinitionKeywordArgumentsOrdered:
+  Description: |
+    Sort method definition keyword arguments in alphabetical order.
+  Enabled: false
+  VersionAdded: '0.13'
+
 Sevencop/MethodDefinitionMultilineArguments:
   Description: |
     Inserts new lines between method definition parameters.
@@ -42,13 +42,6 @@ Sevencop/OrderField:
   Safe: false
   VersionAdded: '0.4'
 
-Sevencop/RedundantExistenceCheck:
-  Description: |
-    Avoid redundant existent check before file operation.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.1'
-
 Sevencop/ToSWithArgument:
   Description: |
     Identifies passing any argument to `#to_s`.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Sort `autoload` in alphabetical order.
+      # Sort `autoload` in alphabetical order within their section.
       #
       # @example
       #   # bad
@@ -13,12 +13,19 @@ module RuboCop
       #   # good
       #   autoload :A, 'a'
       #   autoload :B, 'b'
+      #
+      #   # good
+      #   autoload :A, 'a'
+      #   autoload :D, 'd'
+      #
+      #   autoload :B, 'b'
+      #   autoload :C, 'c'
       class AutoloadOrdered < Base
         extend AutoCorrector
 
         include RangeHelp
 
-        MSG = 'Sort `autoload` in alphabetical order.'
+        MSG = 'Sort `autoload` in alphabetical order within their section.'
 
         RESTRICT_ON_SEND = %i[
           autoload
@@ -52,11 +59,21 @@ module RuboCop
           node.left_siblings.find do |sibling|
             next unless sibling.send_type?
             next unless sibling.method?(:autoload)
+            next unless in_same_section?(sibling, node)
 
             node.first_argument.source < sibling.first_argument.source
           end
         end
 
+        # @param node1 [RuboCop::AST::SendNode]
+        # @param node2 [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def in_same_section?(node1, node2)
+          !node1.location.expression.with(
+            end_pos: node2.location.expression.end_pos
+          ).source.include?("\n\n")
+        end
+
         # @param range1 [Paresr::Source::Range]
         # @param range2 [Paresr::Source::Range]
         # @param corrector [RuboCop::AST::Corrector]

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Sort method definition keyword arguments in alphabetical order.
+      #
+      # @example
+      #   # bad
+      #   def foo(b:, a:); end
+      #
+      #   # good
+      #   def foo(a:, b:); end
+      #
+      #   # bad
+      #   def foo(c:, d:, b: 1, a: 2); end
+      #
+      #   # good
+      #   def foo(c:, d:, a: 2, b: 1); end
+      class MethodDefinitionKeywordArgumentsOrdered < Base
+        extend AutoCorrector
+
+        MSG = 'Sort method definition keyword arguments in alphabetical order.'
+
+        # @param node [RuboCop::AST::ArgNode]
+        def on_kwarg(node)
+          previous_older_kwarg = find_previous_older_sibling(node)
+          return unless previous_older_kwarg
+
+          add_offense(node) do |corrector|
+            corrector.insert_before(
+              previous_older_kwarg,
+              "#{node.source}, "
+            )
+            corrector.remove(
+              node.location.expression.with(
+                begin_pos: node.left_sibling.location.expression.end_pos
+              )
+            )
+          end
+        end
+        alias on_kwoptarg on_kwarg
+
+        private
+
+        # @param node [RuboCop::AST::ArgNode]
+        # @return [RuboCop::AST::ArgNode]
+        def find_previous_older_sibling(node)
+          node.left_siblings.find do |sibling|
+            next if sibling.type != node.type
+
+            sibling.name > node.name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -5,12 +5,11 @@ require_relative 'sevencop/version'
 
 require_relative 'rubocop/cop/sevencop/autoload_ordered'
 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/method_definition_keyword_arguments_ordered'
 require_relative 'rubocop/cop/sevencop/method_definition_multiline_arguments'
 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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -43,12 +43,11 @@ files:
 - config/default.yml
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
 - 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/method_definition_keyword_arguments_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_multiline_arguments.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

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

@@ -1,95 +0,0 @@
-# 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
-        alias on_numblock on_block
-
-        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/redundant_existence_check.rb

@@ -1,188 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Identifies redundant existent check before file operation.
-      #
-      # @safety
-      #   This cop is unsafe because it can register a false positive where the check is truly needed.
-      #
-      # @example
-      #
-      #   # bad
-      #   FileUtils.mkdir(a) unless FileTest.exist?(a)
-      #
-      #   # good
-      #   FileUtils.mkdir_p(a)
-      #
-      #   # bad
-      #   FileUtils.rm(a) if File.exist?(a)
-      #
-      #   # good
-      #   FileUtils.rm_f(a)
-      #
-      class RedundantExistenceCheck < Base
-        extend AutoCorrector
-
-        CLASS_NAMES_FOR_EXIST = ::Set[
-          :File,
-          :FileTest,
-        ]
-
-        CLASS_NAMES_FOR_OPERATION = ::Set[
-          :File,
-          :FileUtils,
-        ]
-
-        METHOD_NAMES_FOR_MAKE = ::Set[
-          :makedirs,
-          :mkdir,
-          :mkdir_p,
-          :mkpath,
-          :touch,
-        ]
-
-        METHOD_NAMES_FOR_REMOVE = ::Set[
-          :delete,
-          :remove,
-          :remove_dir,
-          :remove_entry,
-          :remove_entry_secure,
-          :remove_file,
-          :rm,
-          :rm_f,
-          :rm_r,
-          :rm_rf,
-          :rmdir,
-          :rmtree,
-          :safe_unlink,
-          :unlink,
-        ]
-
-        METHOD_NAMES_FOR_EXIST = ::Set[
-          :exist?,
-          :exists?,
-        ]
-
-        METHOD_NAMES_FOR_FORCE_OPERATION = ::Set[
-          :makedirs,
-          :mkdir_p,
-          :mkpath,
-          :rm_f,
-          :rm_rf,
-          :rm_tree,
-          :safe_unlink,
-          :touch,
-        ]
-
-        METHOD_MAPPING_FOR_FORCE_REPLACEMENT = {
-          'FileUtils.mkdir' => 'FileUtils.mkdir_p',
-          'File.delete' => 'FileUtils.rm_f',
-          'File.unlink' => 'FileUtils.rm_f'
-        }.freeze
-
-        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 _)
-            nil?
-            (send (const nil? CLASS_NAMES_FOR_OPERATION) METHOD_NAMES_FOR_MAKE ...)
-          )
-        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 _)
-            (send (const nil? CLASS_NAMES_FOR_OPERATION) METHOD_NAMES_FOR_REMOVE ...)
-            nil?
-          )
-        PATTERN
-
-        def on_if(node)
-          return unless redundant_on_if(node) || redundant_on_unless(node)
-
-          add_offense(node) do |corrector|
-            corrector.replace(
-              node.location.expression,
-              enforce(node)
-            )
-          end
-        end
-
-        private
-
-        def enforce(node)
-          if force_operation?(node)
-            node.if_branch.source
-          elsif force_replaceable_method?(node)
-            enforce_by_replacement(node)
-          else
-            enforce_by_force_option(node)
-          end
-        end
-
-        def enforce_by_force_option(node)
-          arguments = node.if_branch.arguments.map(&:source)
-          arguments << 'force: true' unless force_operation?(node)
-          format(
-            '%<receiver>s.%<method_name>s(%<arguments>s)',
-            arguments: arguments.join(', '),
-            method_name: node.if_branch.method_name,
-            receiver: node.if_branch.receiver.source
-          )
-        end
-
-        def enforce_by_replacement(node)
-          format(
-            '%<signature>s(%<arguments>s)',
-            arguments: node.if_branch.arguments.map(&:source).join(', '),
-            signature: METHOD_MAPPING_FOR_FORCE_REPLACEMENT[operation_method_signature(node)]
-          )
-        end
-
-        def force_operation?(node)
-          force_operation_method_name?(node) || force_operation_argument?(node)
-        end
-
-        def force_operation_argument?(node)
-          node.if_branch.last_argument.hash_type? &&
-            node.if_branch.last_argument.pairs.any? do |pair|
-              pair.key.value == :force && pair.value.true_type?
-            end
-        end
-
-        def force_operation_method_name?(node)
-          METHOD_NAMES_FOR_FORCE_OPERATION.include?(node.if_branch.method_name)
-        end
-
-        def redundant_on_if(node)
-          remove_if_exist?(node) && same_argument?(node)
-        end
-
-        def redundant_on_unless(node)
-          make_unless_exist?(node) && same_argument?(node)
-        end
-
-        def force_replaceable_method?(node)
-          METHOD_MAPPING_FOR_FORCE_REPLACEMENT.key?(operation_method_signature(node))
-        end
-
-        def operation_method_signature(node)
-          format(
-            '%<receiver>s.%<method_name>s',
-            method_name: node.if_branch.method_name,
-            receiver: node.if_branch.receiver.source
-          )
-        end
-
-        def same_argument?(node)
-          node.condition.first_argument == node.if_branch.first_argument
-        end
-      end
-    end
-  end
-end