sevencop 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c8749d14f3f47fd27af7e3f83f5a31ab99c393082cc6b6a054dfdb78cc1d584
-  data.tar.gz: 183cfc453319b5cceda49fa1764c604c667c9ba82325c5f2b0db3d61ecb23309
+  metadata.gz: 97218861b57331e3ffaa577f6a7a7a7d9ec05d0b7f6d7a8034e41ab831854a5d
+  data.tar.gz: 076a2bb553cd96314b4c10144e943cd67a3c8bee532950d9945d54a8cbad96ad
 SHA512:
-  metadata.gz: a00296da37481256fa87d3188bf86234c9e0bffed432d211c0d563c544d99b6e3db90545bf3a253e07320538cb2d34785e5d186c491e9258bf14b0ab904b0820
-  data.tar.gz: 88c879ff1c21fcd60e25fcf2cb1c06947175baaa84a7877d583225e3cdb76c040af926a9a348e6b8dc920f3b86fd931d88a1f4201af162b3dbef729b4c14549a
+  metadata.gz: 7dbc8187110fae79a6c21c61e2292d7f6e6d42a0f51bdf35066d281a2b44fa47e1b6a2fcc920fa192cda30dfd9c77b73836e57a518d61e5de1a7ff6fc97c3576
+  data.tar.gz: 0ad3d66a1ecbbec56054a771626e8cb22eb2bc425501fbe0b6f38290be315110de2875a73670bfead59e3cd854d41214f919178622e0807a07c91b2dac8a283e

data/Gemfile.lock

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

data/README.md

@@ -29,6 +29,8 @@ Sevencop/MethodDefinitionOrdered:
 Choose the cops you want to use and enable them on your .rubocop.yml.
 
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
+- [Sevencop/FactoryBotAssociationOption](lib/rubocop/cop/sevencop/factory_bot_association_option.rb)
+- [Sevencop/FactoryBotAssociationStyle](lib/rubocop/cop/sevencop/factory_bot_association_style.rb)
 - [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
 - [Sevencop/MethodDefinitionArgumentsMultiline](lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb)
 - [Sevencop/MethodDefinitionInIncluded](lib/rubocop/cop/sevencop/method_definition_in_included.rb)

data/config/default.yml

@@ -5,6 +5,35 @@ Sevencop/AutoloadOrdered:
   Safe: false
   VersionAdded: '0.12'
 
+Sevencop/FactoryBotAssociationOptions:
+  Description: |
+    Remove redundant options from FactoryBot associations.
+  Enabled: false
+  VersionAdded: '0.21'
+
+Sevencop/FactoryBotAssociationStyle:
+  Description: |
+    Use consistent style in FactoryBot associations.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.21'
+  EnforcedStyle: implicit
+  SupportedStyles:
+    - explicit
+    - implicit
+  inherit_mode:
+    merge:
+      - NonImplicitAssociationMethodNames
+  NonImplicitAssociationMethodNames:
+    - skip_create
+  Include:
+    - factories.rb
+    - factories/*.rb
+    - spec/factories.rb
+    - spec/factories/*.rb
+    - test/factories.rb
+    - test/factories/*.rb
+
 Sevencop/HashElementOrdered:
   Description: |
     Sort Hash elements by key.
@@ -59,6 +88,8 @@ Sevencop/RailsMigrationReservedWordMysql:
   Enabled: false
   Safe: false
   VersionAdded: '0.20'
+  Include:
+    - db/migrate/**/*.rb
 
 Sevencop/RailsOrderField:
   Description: |

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Remove redundant options from FactoryBot associations.
+      #
+      # @example
+      #   # bad
+      #   association :user, factory: :user
+      #
+      #   # good
+      #   association :user
+      class FactoryBotAssociationOption < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        include RangeHelp
+
+        MSG = 'Remove redundant options from FactoryBot associations.'
+
+        RESTRICT_ON_SEND = %i[association].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          association_name = association_name_from(node)
+          factory_option = factory_option_from(node)
+          return if !factory_option || association_name != factory_option.value.value
+
+          add_offense(factory_option) do |corrector|
+            autocorrect(corrector, factory_option)
+          end
+        end
+
+        private
+
+        # @!method association_name_from(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Symbol, nil]
+        def_node_matcher :association_name_from, <<~PATTERN
+          (send
+            nil?
+            _
+            (sym $_)
+            ...
+          )
+        PATTERN
+
+        # @!method factory_option_from(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [RuboCop::AST::PairNode, nil]
+        def_node_matcher :factory_option_from, <<~PATTERN
+          (send
+            nil?
+            _
+            _
+            (hash
+              <
+                $(pair
+                  (sym :factory)
+                  (sym _)
+                )
+                ...
+              >
+            )
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::PairNode]
+        # @return [void]
+        def autocorrect(
+          corrector,
+          node
+        )
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.location.expression,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Use consistent style in FactoryBot associations.
+      #
+      # @safety
+      #   This cop may cause false-positives in `EnforcedStyle: explicit` case.
+      #   It recognizes any method call that has no arguments as an implicit association
+      #   but it might be a user-defined trait call.
+      #
+      # @example EnforcedStyle: implicit (default)
+      #   # bad
+      #   association :user
+      #
+      #   # good
+      #   user
+      #
+      #   # good
+      #   association :author, factory: user
+      #
+      # @example EnforcedStyle: explicit
+      #   # bad
+      #   user
+      #
+      #   # good
+      #   association :user
+      #
+      #   # good (defined in NonImplicitAssociationMethodNames)
+      #   skip_create
+      class FactoryBotAssociationStyle < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Use consistent style in FactoryBot associations.'
+
+        RESTRICT_ON_SEND = %i[factory].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          wrong_associations_in(node).each do |association|
+            add_offense(association) do |corrector|
+              autocorrect(corrector, association)
+            end
+          end
+        end
+
+        private
+
+        # @!method explicit_association?(node)
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean]
+        def_node_matcher :explicit_association?, <<~PATTERN
+          (send
+            nil?
+            :association
+            ...
+          )
+        PATTERN
+
+        # @!method implicit_association?(node)
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean]
+        def_node_matcher :implicit_association?, <<~PATTERN
+          (send
+            nil?
+            !#non_implicit_association_method_name?
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        def autocorrect(
+          corrector,
+          node
+        )
+          case style
+          when :explicit
+            autocorrect_to_explicit_style(corrector, node)
+          when :implicit
+            autocorrect_to_implicit_style(corrector, node)
+          end
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_to_explicit_style(
+          corrector,
+          node
+        )
+          corrector.replace(node, "association :#{node.method_name}")
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_to_implicit_style(
+          corrector,
+          node
+        )
+          corrector.replace(node, node.first_argument.value.to_s)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def autocorrectable_to_implicit_style?(node)
+          node.arguments.one?
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::Node>]
+        def children_of_factory_block(node)
+          block = node.parent
+          return [] unless block
+          return [] unless block.block_type?
+
+          if block.body.begin_type?
+            block.body.children
+          else
+            [block.body]
+          end
+        end
+
+        # @param method_name [Symbol]
+        # @return [Boolean]
+        def non_implicit_association_method_name?(method_name)
+          cop_config['NonImplicitAssociationMethodNames'].include?(method_name.to_s)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def wrong?(node)
+          case style
+          when :explicit
+            wrong_to_explicit_style?(node)
+          when :implicit
+            wrong_to_implicit_style?(node)
+          end
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::SendNode>]
+        def wrong_associations_in(node)
+          children_of_factory_block(node).select do |child|
+            wrong?(child)
+          end
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def wrong_to_explicit_style?(node)
+          implicit_association?(node)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def wrong_to_implicit_style?(node)
+          explicit_association?(node) && autocorrectable_to_implicit_style?(node)
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -5,6 +5,8 @@ require_relative 'sevencop/rubocop_extension'
 require_relative 'sevencop/version'
 
 require_relative 'rubocop/cop/sevencop/autoload_ordered'
+require_relative 'rubocop/cop/sevencop/factory_bot_association_option'
+require_relative 'rubocop/cop/sevencop/factory_bot_association_style'
 require_relative 'rubocop/cop/sevencop/hash_element_ordered'
 require_relative 'rubocop/cop/sevencop/method_definition_arguments_multiline'
 require_relative 'rubocop/cop/sevencop/method_definition_in_included'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -43,6 +43,8 @@ files:
 - config/default.yml
 - data/reserved_words_mysql.txt
 - lib/rubocop/cop/sevencop/autoload_ordered.rb
+- lib/rubocop/cop/sevencop/factory_bot_association_option.rb
+- lib/rubocop/cop/sevencop/factory_bot_association_style.rb
 - lib/rubocop/cop/sevencop/hash_element_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb
 - lib/rubocop/cop/sevencop/method_definition_in_included.rb