momocop 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125920382da157b5f151d8d7de60a05df4943fbbdf521db3b082001891f7af25
-  data.tar.gz: 8860b388475b79b0eec94ee28e9635a2c288b662bdcdbe33a5172b8959d969c9
+  metadata.gz: 711882a976895992e975ef619137dfe75d05cecdd82b249d3d5607aa87bff05d
+  data.tar.gz: 86b276769f8e043d927b556f245bea1d4c80cea5cae8a2a04b05cbd89f9e14f7
 SHA512:
-  metadata.gz: f538d288ad3858eb9c5c6bbd0c6576b6e8bd0811282da99215b295426e83b4d51f5b111fa256d1c6246eb1577209a114d8745c28c0568e8fc93b5f774774b93b
-  data.tar.gz: e49a4e8e1ab9ad2ce341566257730d7eab510002319a8c4c48db179f2be5dbdfc6ee7ddecec9552debef73360729546e6eb954eee14c2489f8c8037f950ac891
+  metadata.gz: 4276e49e54c3833cc3a7b701c06fd482ead664d22b3e4add6d7326ba88b78f7dd331f911aac1e9dd1c2e139945f945d766a23d6bfeb484514059ddb5bae0f3b7
+  data.tar.gz: d6155319eb7e442b886dc8768e88442e86527eefa1af48105d1bcc955a87ed460016122f90e502190978032a88d5724807f4dd4d28400bdc0569b3b5acde21dc

data/lib/momocop/helpers/factory_bot_helper.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Momocop
+  module Helpers
+    module FactoryBotHelper
+      # @type method inside_factory_bot_factory?(RuboCop::AST::Node): bool
+      private def inside_factory_bot_factory?(node)
+        context = node.each_ancestor(:block).first
+        send_node = context.block_type? ? context.send_node : context
+
+        return send_node.method_name == :factory
+      end
+
+      # @type method inside_factory_bot_define?(RuboCop::AST::Node): bool
+      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
+
+      # @type method factory_bot_define?(RuboCop::AST::Node): bool
+      private def factory_bot_define?(node)
+        node.send_type? && node.method_name == :define && node.receiver&.const_name == 'FactoryBot'
+      end
+
+      RUBOCOP_HELPER_METHODS = %i[trait transient before after].freeze
+
+      # @type method definition_node?(RuboCop::AST::Node): bool
+      private def definition_node?(node)
+        if node.send_type?
+          return !RUBOCOP_HELPER_METHODS.include?(node.method_name)
+        elsif node.block_type? && node.children.first.send_type?
+          return !RUBOCOP_HELPER_METHODS.include?(node.children.first.method_name)
+        end
+
+        return false
+      end
+
+      # @type method definition_type(RuboCop::AST::Node): (:association | :property | :sequence)
+      private def definition_type(node)
+        send_node = node.send_type? ? node : node.children.first
+        has_association_body =
+          send_node
+          .block_node
+          &.children
+          &.last
+          # sinble-statement block or multi-statement block
+          &.then { _1.send_type? ? [_1] : _1.children }
+          &.any? { _1.is_a?(Parser::AST::Node) && _1.send_type? && _1.method_name == :association }
+        if %i[association sequence].include? send_node.method_name
+          send_node.method_name
+        elsif has_association_body
+          :association
+        else
+          :property
+        end
+      end
+
+      # @type method definition_name(RuboCop::AST::Node): Symbol
+      private def definition_name(node)
+        send_node = node.send_type? ? node : node.children.first
+        if %i[association sequence].include? send_node.method_name
+          send_node.arguments.first.value
+        else
+          send_node.method_name.to_sym
+        end
+      end
+
+      # @type method defined_properties(RuboCop::AST::Node): Array[RuboCop::AST::Node]
+      private def defined_properties(node)
+        block_node = node.block_type? ? node : node.block_node
+        body_node = block_node&.children&.last
+
+        # empty block
+        return [] unless body_node
+
+        # begin
+        if body_node.begin_type?
+          body_node&.children&.select { |node| definition_node?(node) } || []
+        # block
+        elsif body_node.send_type? && definition_node?(body_node)
+          [body_node]
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/momocop/helpers/rails_helper.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Momocop
+  module Helpers
+    module RailsHelper
+      include RuboCop::Cop::ActiveRecordHelper
+
+      private def model_file_path(class_name)
+        "app/models/#{class_name.underscore}.rb"
+      end
+
+      private def model_file_source(class_name)
+        path = model_file_path(class_name)
+        return File.read(path) if File.exist?(path)
+      end
+
+      private def get_model_association_names(class_name)
+        source = model_file_source(class_name)
+        return [] unless source
+
+        extractor = ::Momocop::AssociationExtractor.new
+        associations = extractor.extract(source)
+        belongs_to_associations =
+          associations
+          .select { _1[:type] == :belongs_to }
+          .map { _1[:name].to_s }
+        return belongs_to_associations
+      end
+
+      private def get_model_enum_property_names(class_name)
+        source = model_file_source(class_name)
+        return [] unless source
+
+        extractor = ::Momocop::EnumExtractor.new
+        enums = extractor.extract(source)
+        return enums.map(&:to_sym)
+      end
+
+      private def get_model_foreign_key_column_names(class_name)
+        source = model_file_source(class_name)
+        return [] unless source
+
+        extractor = ::Momocop::AssociationExtractor.new
+        associations = extractor.extract(source)
+        foreign_key_names =
+          associations
+          .select { _1[:type] == :belongs_to }
+          .map { |association|
+            options = association[:options]
+            options[:foreign_key] || "#{association[:name]}_id"
+          }
+          .compact
+        return foreign_key_names.map(&:to_sym)
+      end
+
+      RESTRICTED_COLUMNS = %w[created_at updated_at].freeze
+
+      private def get_model_property_names(class_name)
+        table = schema.table_by(name: table_name(class_name))
+        return [] unless table
+
+        column_names = table.columns.reject { _1.type == :references }.map(&:name) - RESTRICTED_COLUMNS
+        return column_names.map(&:to_sym)
+      end
+
+      # e.g.)
+      # 'User' -> ['users']
+      # 'Admin::User' -> ['admin_users', 'users']
+      private def table_name(class_name)
+        # TODO: parse model class file and try to get table_name_prefix and table_name_suffix
+        class_name.tableize.gsub('/', '_')
+      end
+
+      # e.g.)
+      # 'User' -> ['users']
+      # 'Admin::User' -> ['admin_users', 'users']
+      private def foreign_key_name(class_name)
+        # TODO: parse model class file and try to get table_name_prefix and table_name_suffix
+        "#{class_name.underscore.gsub('/', '_')}_id"
+      end
+    end
+  end
+end

data/lib/momocop/version.rb

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

data/lib/momocop.rb

@@ -17,6 +17,10 @@ require_relative 'momocop/config_injector'
 require_relative 'momocop/enum_extractor'
 require_relative 'momocop/version'
 
+Dir[File.join(__dir__, 'momocop/helpers', '*.rb')].each do |file|
+  require file
+end
+
 Momocop::ConfigInjector.inject_default_config!
 
 Dir[File.join(__dir__, 'rubocop/cop/momocop', '*.rb')].each do |file|

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

@@ -15,6 +15,8 @@ module RuboCop
       #   end
       class FactoryBotClassExistence < RuboCop::Cop::Base
         extend AutoCorrector
+        include ::Momocop::Helpers::FactoryBotHelper
+        include ::Momocop::Helpers::RailsHelper
 
         MSG = 'Specified class does not exist. Please make sure that the class exists.'
 
@@ -42,18 +44,9 @@ module RuboCop
           add_offense(class_node)
         end
 
-        private def model_file_path(class_name)
-          "app/models/#{class_name.underscore}.rb"
-        end
-
         private def class_exists?(class_name)
           File.exist?(model_file_path(class_name))
         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

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

@@ -21,6 +21,7 @@ module RuboCop
       #   end
       class FactoryBotConsistentFileName < RuboCop::Cop::Base
         include RangeHelp
+        include ::Momocop::Helpers::FactoryBotHelper
 
         MSG = 'Factory name should match the file name.'
 
@@ -42,11 +43,6 @@ module RuboCop
 
           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

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

@@ -8,15 +8,18 @@ module RuboCop
       # @example
       #   # bad
       #   factory :blog_post do
-      #     association(:user)
+      #     association(:user, factory: :foo)
+      #     association(:admin, factory: [:foo, :trait])
       #   end
       #
       #   # good
       #   factory :blog_post do
-      #     user { association :user }
+      #     user { association :foo }
+      #     admin { association :foo, :trait }
       #   end
       class FactoryBotInlineAssociation < RuboCop::Cop::Base
         extend AutoCorrector
+        include ::Momocop::Helpers::FactoryBotHelper
 
         MSG = 'Use inline association definition instead of separate `association` method call.'
 
@@ -37,7 +40,7 @@ module RuboCop
             convert_options(options) in {
               factory_option:, rest_options:
             }
-            factory = factory_option&.source || ":#{association_name}"
+            factory = factory_option || ":#{association_name}"
             replacement =
               if rest_options.empty?
                 "#{association_name} { association #{factory} }"
@@ -51,7 +54,12 @@ module RuboCop
 
         # `association :foo, factory: :bar, baz: 1 ...` => `foo { association :bar, baz: 1 ...}`
         private def convert_options(options)
-          factory_option = options&.pairs&.find { |pair| pair.key.value == :factory }&.value
+          factory_option =
+            options
+            &.pairs
+            &.find { |pair| pair.key.value == :factory }
+            &.value
+            &.then { _1.array_type? ? _1.values.map(&:source).join(', ') : _1.source }
           rest_options = options&.pairs&.reject { |pair| pair.key.value == :factory } || []
 
           return {
@@ -59,18 +67,6 @@ module RuboCop
             rest_options:
           }
         end
-
-        private def inside_factory_bot_factory?(node)
-          context = node.each_ancestor(:block).first
-          send_node = context.block_type? ? context.send_node : context
-
-          return send_node.method_name == :factory
-        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

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

@@ -24,8 +24,10 @@ module RuboCop
       #     end
       #   end
       class FactoryBotMissingAssociations < RuboCop::Cop::Base
-        include RuboCop::Cop::ActiveRecordHelper
         extend AutoCorrector
+        include RuboCop::Cop::ActiveRecordHelper
+        include ::Momocop::Helpers::FactoryBotHelper
+        include ::Momocop::Helpers::RailsHelper
 
         MSG = 'Ensure all associations of the model class are defined in the factory.'
 
@@ -79,34 +81,12 @@ module RuboCop
           end
         end
 
-        private def model_file_path(class_name)
-          "app/models/#{class_name.underscore}.rb"
-        end
-
         private def one_line_block?(block_node)
           return false if block_node.nil?
 
           block_node.loc.begin.line == block_node.loc.end.line
         end
 
-        private def model_file_source(class_name)
-          path = model_file_path(class_name)
-          return File.read(path) if File.exist?(path)
-        end
-
-        private def get_model_association_names(class_name)
-          source = model_file_source(class_name)
-          return [] unless source
-
-          extractor = ::Momocop::AssociationExtractor.new
-          associations = extractor.extract(source)
-          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)
           body_node = block_node&.children&.last
           return [] unless body_node
@@ -126,22 +106,10 @@ module RuboCop
           return send_node.method_name.to_s
         end
 
-        private def inside_factory_bot_factory?(node)
-          context = node.each_ancestor(:block).first
-          send_node = context.block_type? ? context.send_node : context
-
-          return send_node.method_name == :factory
-        end
-
         private def generate_association_definition(property)
           "#{property} { association :#{property} }"
         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
-
         private def get_class_name(node)
           options_hash = node.arguments[1]
           return nil unless options_hash&.type == :hash

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

@@ -15,6 +15,7 @@ module RuboCop
       #   end
       class FactoryBotMissingClassOption < RuboCop::Cop::Base
         extend AutoCorrector
+        include ::Momocop::Helpers::FactoryBotHelper
 
         MSG = 'Specify a class option explicitly in FactoryBot factory.'
 
@@ -37,11 +38,6 @@ module RuboCop
             corrector.insert_after(node.first_argument.loc.expression, ", class: '#{class_name}'")
           end
         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

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

@@ -27,8 +27,10 @@ module RuboCop
       #     end
       #   end
       class FactoryBotMissingProperties < RuboCop::Cop::Base
-        include RuboCop::Cop::ActiveRecordHelper
         extend AutoCorrector
+        include RuboCop::Cop::ActiveRecordHelper
+        include ::Momocop::Helpers::FactoryBotHelper
+        include ::Momocop::Helpers::RailsHelper
 
         MSG = 'Ensure all properties of the model class are defined in the factory.'
 
@@ -106,71 +108,10 @@ module RuboCop
           end
         end
 
-        private def model_file_path(class_name)
-          "app/models/#{class_name.underscore}.rb"
-        end
-
         private def one_line_block?(block_node)
           block_node.loc.begin.line == block_node.loc.end.line
         end
 
-        private def model_file_source(class_name)
-          path = model_file_path(class_name)
-          return File.read(path) if File.exist?(path)
-        end
-
-        private def get_model_enum_property_names(class_name)
-          source = model_file_source(class_name)
-          return [] unless source
-
-          extractor = ::Momocop::EnumExtractor.new
-          enums = extractor.extract(source)
-          return enums.map(&:to_sym)
-        end
-
-        private def get_model_foreign_key_column_names(class_name)
-          source = model_file_source(class_name)
-          return [] unless source
-
-          extractor = ::Momocop::AssociationExtractor.new
-          associations = extractor.extract(source)
-          foreign_key_names =
-            associations
-            .select { _1[:type] == :belongs_to }
-            .map { |association|
-              options = association[:options]
-              options[:foreign_key] || "#{association[:name]}_id"
-            }
-            .compact
-          return foreign_key_names.map(&:to_sym)
-        end
-
-        RESTRICTED_COLUMNS = %w[created_at updated_at].freeze
-
-        private def get_model_property_names(class_name)
-          table = schema.table_by(name: table_name(class_name))
-          return [] unless table
-
-          column_names = table.columns.reject { _1.type == :references }.map(&:name) - RESTRICTED_COLUMNS
-          return column_names.map(&:to_sym)
-        end
-
-        # e.g.)
-        # 'User' -> ['users']
-        # 'Admin::User' -> ['admin_users', 'users']
-        private def table_name(class_name)
-          # TODO: parse model class file and try to get table_name_prefix and table_name_suffix
-          class_name.tableize.gsub('/', '_')
-        end
-
-        # e.g.)
-        # 'User' -> ['users']
-        # 'Admin::User' -> ['admin_users', 'users']
-        private def foreign_key_name(class_name)
-          # TODO: parse model class file and try to get table_name_prefix and table_name_suffix
-          "#{class_name.underscore.gsub('/', '_')}_id"
-        end
-
         private def get_defined_sequence_names(block_node)
           body_node = block_node&.children&.last
           return [] unless body_node
@@ -192,11 +133,6 @@ module RuboCop
           return property_names
         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
-
         private def get_class_name(node)
           options_hash = node.arguments[1]
           return nil unless options_hash&.type == :hash

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

@@ -38,8 +38,8 @@ module RuboCop
       class FactoryBotPropertyOrder < RuboCop::Cop::Base
         extend AutoCorrector
         include RangeHelp
-
-        include ::Sevencop::CopConcerns::Ordered
+        include Sevencop::CopConcerns::Ordered
+        include ::Momocop::Helpers::FactoryBotHelper
 
         MSG = 'Sort properties and associations alphabetically.'
 
@@ -84,67 +84,6 @@ module RuboCop
           index = definition_name(node)
           [group, index]
         end
-
-        private def defined_properties(block_node)
-          body_node = block_node&.children&.last
-
-          # empty block
-          return [] unless body_node
-
-          # begin
-          if body_node.begin_type?
-            body_node&.children&.select { |node| definition_node?(node) } || []
-          # block
-          elsif body_node.send_type? && definition_node?(body_node)
-            [body_node]
-          else
-            []
-          end
-        end
-
-        RUBOCOP_HELPER_METHODS = %i[trait transient before after].freeze
-
-        private def definition_node?(node)
-          if node.send_type?
-            return !RUBOCOP_HELPER_METHODS.include?(node.method_name)
-          elsif node.block_type? && node.children.first.send_type?
-            return !RUBOCOP_HELPER_METHODS.include?(node.children.first.method_name)
-          end
-
-          return false
-        end
-
-        private def definition_type(node)
-          send_node = node.send_type? ? node : node.children.first
-          has_association_body =
-            send_node
-            .block_node
-            &.children
-            &.last
-            &.children
-            &.any? { _1.is_a?(Parser::AST::Node) && _1.send_type? && _1.method_name == :association }
-          if %i[association sequence].include? send_node.method_name
-            send_node.method_name
-          elsif has_association_body
-            :association
-          else
-            :property
-          end
-        end
-
-        private def definition_name(node)
-          send_node = node.send_type? ? node : node.children.first
-          if %i[association sequence].include? send_node.method_name
-            send_node.arguments.first.value
-          else
-            send_node.method_name.to_sym
-          end
-        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

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

@@ -27,6 +27,8 @@ module RuboCop
       #     end
       #   end
       class FactoryBotSingleDefinePerFile < RuboCop::Cop::Base
+        include ::Momocop::Helpers::FactoryBotHelper
+
         MSG = 'Only one `FactoryBot.define` block is allowed per file.'
 
         def on_new_investigation
@@ -44,10 +46,6 @@ module RuboCop
             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

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

@@ -43,13 +43,15 @@ module RuboCop
       #     end
       #   end
       class FactoryBotSingleFactoryPerDefine < RuboCop::Cop::Base
+        include ::Momocop::Helpers::FactoryBotHelper
+
         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)
+          return unless factory_bot_define?(node)
 
           factories = top_level_factories(node)
 
@@ -61,11 +63,6 @@ module RuboCop
           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 =

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

@@ -21,6 +21,7 @@ module RuboCop
       #   end
       class FactoryBotSingularFactoryName < RuboCop::Cop::Base
         extend AutoCorrector
+        include ::Momocop::Helpers::FactoryBotHelper
 
         MSG = 'Factory name should be singular, not plural.'
 
@@ -44,12 +45,6 @@ module RuboCop
             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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momocop
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - supermomonga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,6 +90,8 @@ files:
 - lib/momocop/association_extractor.rb
 - lib/momocop/config_injector.rb
 - lib/momocop/enum_extractor.rb
+- lib/momocop/helpers/factory_bot_helper.rb
+- lib/momocop/helpers/rails_helper.rb
 - lib/momocop/version.rb
 - lib/rubocop/cop/momocop/factory_bot_class_existence.rb
 - lib/rubocop/cop/momocop/factory_bot_consistent_file_name.rb