momocop 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65a6e94746e124b9b4b7faa9f87effebbbe8f75f7a23ac9f80ee71ef0fee674c
-  data.tar.gz: e32490d4c0fc3e2f02d96ad154db9ff52ef17f56ba993ac7260bc04169fa0e01
+  metadata.gz: acef3c7f38f87034b619c4b5e9ca7ca77ac880a0a665f46abff3a19455ef2d5f
+  data.tar.gz: 4e06a90596825134bdad568b41b38ebdb93056d0fab4f58d381c8ffd6d16e6e5
 SHA512:
-  metadata.gz: 3aae3b5142feb84c7bc741a0d988e715c9101fc16f362e71325abbe330a7952e7ccaaa1ec99f260227b5e14c967341c57a3855810da3034d12e04dadb0c2dbaa
-  data.tar.gz: 31a58eb60a8f1cd43dadd62d0be672620157070f00b441171db634fdd24d65b0b6967c75cf743bff77a1ae5baa4776a2d84147f7b8b99ca86f5e5087effd019e
+  metadata.gz: 7c18582cdb50926ee4bbc7074c076d90f06504cdec64d0dc4a1389dadac1ad000864cdcea4e9e4322a7fcc2bc6bbb8aadd381a29cef2e4bdee1dee3f751833a9
+  data.tar.gz: 6ca756d9793ca03ef4ca8ea88e37d9169bea071641464af88f36e96688a613fa5dc09c3e50b252c56e79e1cf9376f46db1717e0b4dfa7d46be8352fbb656582a

data/README.ja.md

@@ -26,8 +26,24 @@ gem 'momocop', require: false
 require:
   - momocop
 
+Momocop/FactoryBotClassExistence:
+  Enabled: true
+Momocop/FactoryBotConsistentFileName:
+  Enabled: true
 Momocop/FactoryBotMissingAssociations:
   Enabled: true
+Momocop/FactoryBotMissingClassOption:
+  Enabled: true
+Momocop/FactoryBotMissingProperties:
+  Enabled: true
+Momocop/FactoryBotPropertyOrder:
+  Enabled: true
+Momocop/FactoryBotSingleDefinePerFile:
+  Enabled: true
+Momocop/FactoryBotSingleFactoryPerDefine:
+  Enabled: true
+Momocop/FactoryBotSingularFactoryName:
+  Enabled: true
 ```
 
 ## Cop一覧
@@ -35,10 +51,14 @@ Momocop/FactoryBotMissingAssociations:
 |Cop|Rails|FactoryBot|
 |---|:-:|:-:|
 |[`Momocop/FactoryBotClassExistence`](lib/rubocop/cop/momocop/factory_bot_class_existence.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotConsistentFileName`](lib/rubocop/cop/momocop/factory_bot_consistent_file_name.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingAssociations`](lib/rubocop/cop/momocop/factory_bot_missing_associations.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingClassOption`](lib/rubocop/cop/momocop/factory_bot_missing_class_option.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingProperties`](lib/rubocop/cop/momocop/factory_bot_missing_properties.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotPropertyOrder`](lib/rubocop/cop/momocop/factory_bot_property_order.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingleDefinePerFile`](lib/rubocop/cop/momocop/factory_bot_single_define_per_file.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingleFactoryPerDefine`](lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingularFactoryName`](lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb)|:white_check_mark:|:white_check_mark:|
 
 ## 貢献
 

data/README.ja.md.erb

@@ -26,8 +26,16 @@ gem 'momocop', require: false
 require:
   - momocop
 
-Momocop/FactoryBotMissingAssociations:
+<%
+  files = Dir.glob('lib/rubocop/cop/momocop/*.rb').sort_by { |f| File.basename(f)}
+  files.each do |cop_file_path|
+  base_name = File.basename(cop_file_path, '.rb')
+  cop_class_name = "Momocop/#{base_name.camelize}"
+
+-%>
+<%= cop_class_name %>:
   Enabled: true
+<% end -%>
 ```
 
 ## Cop一覧

data/README.md

@@ -26,8 +26,24 @@ All cops are disabled by default.
 require:
   - momocop
 
+Momocop/FactoryBotClassExistence:
+  Enabled: true
+Momocop/FactoryBotConsistentFileName:
+  Enabled: true
 Momocop/FactoryBotMissingAssociations:
   Enabled: true
+Momocop/FactoryBotMissingClassOption:
+  Enabled: true
+Momocop/FactoryBotMissingProperties:
+  Enabled: true
+Momocop/FactoryBotPropertyOrder:
+  Enabled: true
+Momocop/FactoryBotSingleDefinePerFile:
+  Enabled: true
+Momocop/FactoryBotSingleFactoryPerDefine:
+  Enabled: true
+Momocop/FactoryBotSingularFactoryName:
+  Enabled: true
 ```
 
 ## Cops
@@ -35,10 +51,14 @@ Momocop/FactoryBotMissingAssociations:
 |Cop|Rails|FactoryBot|
 |---|:-:|:-:|
 |[`Momocop/FactoryBotClassExistence`](lib/rubocop/cop/momocop/factory_bot_class_existence.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotConsistentFileName`](lib/rubocop/cop/momocop/factory_bot_consistent_file_name.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingAssociations`](lib/rubocop/cop/momocop/factory_bot_missing_associations.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingClassOption`](lib/rubocop/cop/momocop/factory_bot_missing_class_option.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotMissingProperties`](lib/rubocop/cop/momocop/factory_bot_missing_properties.rb)|:white_check_mark:|:white_check_mark:|
 |[`Momocop/FactoryBotPropertyOrder`](lib/rubocop/cop/momocop/factory_bot_property_order.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingleDefinePerFile`](lib/rubocop/cop/momocop/factory_bot_single_define_per_file.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingleFactoryPerDefine`](lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb)|:white_check_mark:|:white_check_mark:|
+|[`Momocop/FactoryBotSingularFactoryName`](lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb)|:white_check_mark:|:white_check_mark:|
 
 ## Contributing
 

data/README.md.erb

@@ -26,8 +26,16 @@ All cops are disabled by default.
 require:
   - momocop
 
-Momocop/FactoryBotMissingAssociations:
+<%
+  files = Dir.glob('lib/rubocop/cop/momocop/*.rb').sort_by { |f| File.basename(f)}
+  files.each do |cop_file_path|
+  base_name = File.basename(cop_file_path, '.rb')
+  cop_class_name = "Momocop/#{base_name.camelize}"
+
+-%>
+<%= cop_class_name %>:
   Enabled: true
+<% end -%>
 ```
 
 ## Cops

data/lib/momocop/association_extractor.rb

@@ -32,9 +32,15 @@ module Momocop
           option_hash = node.children[3]
           option_hash&.children&.each do |option|
             key_node, value_node = option.children
-            if value_node.type == :sym || value_node.type == :str
+            # rubocop:disable Lint/BooleanSymbol
+            if %i[sym str].include?(value_node.type)
               options[key_node.children[0]] = value_node.children[0]
+            elsif value_node.type == :true
+              options[key_node.children[0]] = true
+            elsif value_node.type == :false
+              options[key_node.children[0]] = false
             end
+            # rubocop:enable Lint/BooleanSymbol
           end
         end
 

data/lib/momocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Momocop
-  VERSION = '0.1.10'
+  VERSION = '0.1.12'
 end

data/lib/rubocop/cop/momocop/factory_bot_consistent_file_name.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      # Ensures that FactoryBot factory names match their filenames.
+      #
+      # @example
+      #   # bad
+      #   # in a file named user.rb
+      #   FactoryBot.define do
+      #     factory :admin_user do
+      #     end
+      #   end
+      #
+      #   # good
+      #   # in a file named admin_user.rb
+      #   FactoryBot.define do
+      #     factory :admin_user do
+      #     end
+      #   end
+      class FactoryBotConsistentFileName < RuboCop::Cop::Base
+        include RangeHelp
+
+        MSG = 'Factory name should match the file name.'
+
+        RESTRICT_ON_SEND = %i[factory].freeze
+
+        def_node_matcher :factory_bot_definition, <<~PATTERN
+          (send nil? :factory ({sym str} $_) ...)
+        PATTERN
+
+        def on_send(node)
+          factory_name = factory_bot_definition(node)
+          return unless factory_name
+
+          return unless inside_factory_bot_define?(node)
+
+          expected_file_name = "#{factory_name}.rb"
+          actual_file_name = File.basename(processed_source.file_path)
+          return unless actual_file_name != expected_file_name
+
+          add_offense(node.source_range, message: MSG)
+        end
+
+        private def inside_factory_bot_define?(node)
+          ancestors = node.each_ancestor(:block).to_a
+          ancestors.any? { |ancestor| ancestor.method_name == :define && ancestor.receiver&.const_name == 'FactoryBot' }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/momocop/factory_bot_missing_associations.rb

@@ -100,7 +100,11 @@ module RuboCop
 
           extractor = ::Momocop::AssociationExtractor.new
           associations = extractor.extract(source)
-          return associations.map { _1[:name].to_s }
+          belongs_to_associations =
+            associations
+            .select { _1[:type] == :belongs_to }
+            .map { _1[:name].to_s }
+          return belongs_to_associations
         end
 
         private def get_defined_association_names(block_node)

data/lib/rubocop/cop/momocop/factory_bot_missing_properties.rb

@@ -139,13 +139,7 @@ module RuboCop
             .select { _1[:type] == :belongs_to }
             .map { |association|
               options = association[:options]
-              if options[:foreign_key]
-                options[:foreign_key]
-              elsif options[:class_name]
-                foreign_key_name(options[:class_name])
-              else
-                "#{association[:name]}_id"
-              end
+              options[:foreign_key] || "#{association[:name]}_id"
             }
             .compact
           return foreign_key_names.map(&:to_sym)

data/lib/rubocop/cop/momocop/factory_bot_single_define_per_file.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      # This cop checks for multiple `FactoryBot.define` blocks in a single file.
+      # It's recommended to have only one `FactoryBot.define` block per file to keep
+      # factory definitions clear and maintainable.
+      #
+      # @example
+      #   # bad
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #   end
+      #
+      #   FactoryBot.define do
+      #     factory :admin do
+      #     end
+      #   end
+      #
+      #   # good
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #     factory :admin do
+      #     end
+      #   end
+      class FactoryBotSingleDefinePerFile < RuboCop::Cop::Base
+        MSG = 'Only one `FactoryBot.define` block is allowed per file.'
+
+        def on_new_investigation
+          factory_bot_define_blocks =
+            processed_source
+            .ast
+            .descendants
+            .select { |node|
+              factory_bot_define?(node)
+            }
+
+          return if factory_bot_define_blocks.size <= 1
+
+          factory_bot_define_blocks[1..].each do |factory_bot_define_block|
+            add_offense(factory_bot_define_block, message: MSG)
+          end
+        end
+
+        private def factory_bot_define?(node)
+          node.send_type? && node.method_name == :define && node.receiver&.const_name == 'FactoryBot'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Momocop
+      # Ensures that each file contains only one top-level FactoryBot factory.
+      # Nested factories within a parent factory are allowed.
+      #
+      # @example
+      #   # bad
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #   end
+      #
+      #   FactoryBot.define do
+      #     factory :profile do
+      #     end
+      #   end
+      #
+      #   # good
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #   end
+      #
+      #   # bad
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #   end
+      #
+      #   FactoryBot.define do
+      #     factory :admin_user, class: ‘User' do
+      #     end
+      #   end
+      #
+      #   # good
+      #   FactoryBot.define do
+      #     factory :user do
+      #       factory :admin_user do
+      #       end
+      #     end
+      #   end
+      class FactoryBotSingleFactoryPerDefine < RuboCop::Cop::Base
+        MSG = 'Only one top-level factory is allowed per FactoryBot.define.'
+
+        RESTRICT_ON_SEND = %i[define].freeze
+
+        # Define the investigation method to be called during cop processing.
+        def on_send(node)
+          return unless factory_bot_define_block?(node)
+
+          factories = top_level_factories(node)
+
+          return if factories.size <= 1
+
+          # Register an offense for each factory beyond the first one.
+          factories[1..].each do |factory|
+            add_offense(factory.loc.expression, message: MSG)
+          end
+        end
+
+        # Checks if the node is a FactoryBot definition block.
+        private def factory_bot_define_block?(node)
+          node.receiver&.const_name == 'FactoryBot'
+        end
+
+        # Returns all top-level factories within a FactoryBot.define block.
+        private def top_level_factories(node)
+          factory_nodes =
+            node
+            .block_node
+            .body.each_descendant(:send)
+            .select { |n| n.method_name == :factory }
+          factory_nodes.select { |factory_node|
+            base_node = factory_node.block_node || factory_node
+            context =
+              base_node
+              .each_ancestor(:block)
+              .map { _1.send_node&.method_name&.to_sym }
+              .find { %i[define factory].include? _1 }
+            context == :define
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module RuboCop
+  module Cop
+    module Momocop
+      # Ensures that FactoryBot factories have singular names.
+      #
+      # @example
+      #   # bad
+      #   FactoryBot.define do
+      #     factory :users do
+      #     end
+      #   end
+      #
+      #   # good
+      #   FactoryBot.define do
+      #     factory :user do
+      #     end
+      #   end
+      class FactoryBotSingularFactoryName < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        MSG = 'Factory name should be singular, not plural.'
+
+        RESTRICT_ON_SEND = %i[factory].freeze
+
+        def on_send(node)
+          return unless inside_factory_bot_define?(node)
+
+          factory_name = node.first_argument.value.to_s
+          return if factory_name.singularize == factory_name
+
+          add_offense(node.first_argument) do |corrector|
+            p node.first_argument
+            if node.first_argument.type == :sym
+              corrector.replace(node.first_argument.loc.expression, ":#{factory_name.singularize}")
+            elsif node.first_argument.type == :str
+              if node.first_argument.source.start_with?("'")
+                corrector.replace(node.first_argument.loc.expression, "'#{factory_name.singularize}'")
+              elsif node.first_argument.source.start_with?('"')
+                corrector.replace(node.first_argument.loc.expression, "\"#{factory_name.singularize}\"")
+              end
+            end
+          end
+        end
+
+        # Checks if the node is inside a FactoryBot definition block.
+        private def inside_factory_bot_define?(node)
+          ancestors = node.each_ancestor(:block).to_a
+          ancestors.any? { |ancestor| ancestor.method_name == :define && ancestor.receiver&.const_name == 'FactoryBot' }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momocop
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.12
 platform: ruby
 authors:
 - supermomonga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,10 +92,14 @@ files:
 - lib/momocop/enum_extractor.rb
 - lib/momocop/version.rb
 - lib/rubocop/cop/momocop/factory_bot_class_existence.rb
+- lib/rubocop/cop/momocop/factory_bot_consistent_file_name.rb
 - lib/rubocop/cop/momocop/factory_bot_missing_associations.rb
 - lib/rubocop/cop/momocop/factory_bot_missing_class_option.rb
 - lib/rubocop/cop/momocop/factory_bot_missing_properties.rb
 - lib/rubocop/cop/momocop/factory_bot_property_order.rb
+- lib/rubocop/cop/momocop/factory_bot_single_define_per_file.rb
+- lib/rubocop/cop/momocop/factory_bot_single_factory_per_define.rb
+- lib/rubocop/cop/momocop/factory_bot_singular_factory_name.rb
 - sig/momocop.rbs
 homepage: https://github.com/supermomonga/momocop
 licenses: