factory_bot-with 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b5be917f74ffbdc5643be7bb5f9c9e7f1009484f688a8442aed6dda8dc5a0b
-  data.tar.gz: d773865f81b4aad3e87dea573db938b5393f0ecc988b5810b827741051ee6864
+  metadata.gz: 330ba97b29d7109bb0cb89cf0493cced5300e17c3a1465066405e46c66cbcd76
+  data.tar.gz: 504cbcee6a16323d2a9494f10bcb68754d84130b343c316eab7a9f4c01432a0c
 SHA512:
-  metadata.gz: 93c900afe0c21747d9837a5c8e1b31b11a7ae3e127873cdf86f43f5f83fac4ba10be0295e7b43542d3399a78be377fd240f57a9251a8433471015767170d96a5
-  data.tar.gz: 1af4669b1afb19783332b2bed70d7cb76d210bb205766dcc3aae06bd07de0a4a614da1aadc0841e6cca0bf8c3b3965241a05703a898172a0c575ddcd93f8d273
+  metadata.gz: 11ed1a26a0ebd2590398eef94ebbf8aaeb23419cdd2b0d5e3979f3a64bbe4179e1f96d731804ccbd042535806a4999de62f5a6d5b72cf7ff5c2fbf379cd30372
+  data.tar.gz: 5da17d95d18e8c746ddd5ce0a1213a8cf24dec8766753655ea912bc91a6b7c38dde9c7d85d73bca4165b7d17f126af31c2a4fd71be3cdbb5807c40a0434ef259

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-12-09
+
+- Added: Added `FactoryBot::With.register_strategy` to support custom strategies
+
+## [0.2.1] - 2024-11-29
+
+- Fixed: Adjusted priority of factory names autocompletion
+
 ## [0.2.0] - 2024-11-29
 
 - Fixed: Fixed an incorrect factory resolution problem after factory names autocompletion

data/lib/factory_bot/with/assoc_info.rb

@@ -46,8 +46,6 @@ module FactoryBot
         # @param partial_factory_name [Symbol]
         # @return [Symbol]
         def autocomplete_fully_qualified_factory_name(ancestors, partial_factory_name)
-          return partial_factory_name if exists?(partial_factory_name)
-
           ancestors.each do |(ancestor_assoc_info, _)|
             ancestor_assoc_info.factory_names.each do |ancestor_factory_name|
               factory_name = :"#{ancestor_factory_name}_#{partial_factory_name}"
@@ -55,6 +53,10 @@ module FactoryBot
             end
           end
 
+          # Attempt to resolve with the autocompleted names, then attempt to resolve with the original name.
+          # If we want to avoid autocompletion, we should be able to simply use a factory such as build or create.
+          return partial_factory_name if exists?(partial_factory_name)
+
           raise ArgumentError, "FactoryBot factory #{partial_factory_name} is not defined"
         end
 

data/lib/factory_bot/with/methods.rb

@@ -5,23 +5,6 @@ module FactoryBot
     # A <code>FactoryBot::Syntax::Methods</code> replacement to enable <code>factory_bot-with</code> features.
     module Methods
       include FactoryBot::Syntax::Methods
-
-      BUILD_STRATEGIES = %i[build build_stubbed create attributes_for with].freeze
-      VARIATIONS = {
-        unit: BUILD_STRATEGIES.to_h { [_1, _1] }.freeze,
-        pair: BUILD_STRATEGIES.to_h { [_1, :"#{_1}_pair"] }.freeze,
-        list: BUILD_STRATEGIES.to_h { [_1, :"#{_1}_list"] }.freeze,
-      }.freeze
-
-      VARIATIONS.each do |variation, build_strategies|
-        build_strategies.each do |build_strategy, method_name|
-          define_method(method_name) do |factory = nil, *args, **kwargs, &block|
-            return Proxy.new(self, __method__) unless factory
-
-            With.build(variation, factory, *args, **kwargs, &block).instantiate(build_strategy)
-          end
-        end
-      end
     end
   end
 end

data/lib/factory_bot/with/version.rb

@@ -2,6 +2,6 @@
 
 module FactoryBot
   class With
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/factory_bot/with.rb

@@ -9,7 +9,7 @@ require_relative "with/methods"
 module FactoryBot
   # An intermediate state for <code>with</code> operator.
   class With
-    # @return [:unit, :pair, :list]
+    # @return [:singular, :pair, :list]
     attr_reader :variation
     # @return [Symbol]
     attr_reader :factory_name
@@ -24,7 +24,7 @@ module FactoryBot
 
     # @!visibility private
     def initialize(variation, factory_name, withes: [], traits: [], attrs: {}, &block)
-      raise ArgumentError unless %i[unit pair list].include? variation
+      raise ArgumentError unless %i[singular pair list].include? variation
       raise TypeError unless factory_name.is_a? Symbol
       raise TypeError unless withes.is_a?(Array) && withes.all? { _1.is_a? self.class }
       raise TypeError unless traits.is_a?(Array) && traits.all? { _1.is_a?(Symbol) || _1.is_a?(Numeric) }
@@ -59,18 +59,48 @@ module FactoryBot
         withes: [*withes, *other.withes],
         traits: [*traits, *other.traits],
         attrs: { **attrs, **other.attrs },
-        &self.class.merge_block(block, other.block)
+        &lambda do |first, second|
+          return first unless second
+          return second unless first
+
+          lambda do |*args|
+            first.call(*args)
+            second.call(*args)
+          end
+        end.call(block, other.block)
       )
     end
 
     # @!visibility private
-    # @param build_strategy [:build, :build_stubbed, :create, :attributes_for, :with]
+    def extend!(*args)
+      args.each do |arg|
+        case arg
+        when self.class
+          withes << arg
+        when Symbol, Numeric
+          traits << arg
+        when Array
+          extend!(*arg)
+        when Hash
+          attrs.merge!(arg)
+        when false, nil
+          # Ignored. This behavior is useful for conditional arguments like `is_premium && :premium`
+        else
+          raise ArgumentError, "Unsupported type for factory argument: #{arg}"
+        end
+      end
+      self
+    end
+
+    # @!visibility private
+    # @param build_strategy [Symbol]
     # @param ancestors [Array<Array(AssocInfo, Object)>, nil]
     # @return [Object]
     def instantiate(build_strategy, ancestors = nil)
       return self if build_strategy == :with
 
-      factory_bot_method = Methods::VARIATIONS[variation][build_strategy]
+      factory_bot_method =
+        variation == :singular ? build_strategy : :"#{build_strategy}_#{variation}"
       factory_name, attrs =
         if ancestors
           attrs = @attrs.dup
@@ -83,7 +113,7 @@ module FactoryBot
       result = FactoryBot.__send__(factory_bot_method, factory_name, *traits, **attrs, &block)
 
       unless withes.empty?
-        parents = variation == :unit ? [result] : result
+        parents = variation == :singular ? [result] : result
         assoc_info = AssocInfo.get(factory_name)
         parents.each do |parent|
           ancestors_for_children = [[assoc_info, parent], *ancestors || []]
@@ -96,51 +126,36 @@ module FactoryBot
 
     class << self
       # @!visibility private
-      # @param variation [:unit, :pair, :list]
+      # @param variation [:singular, :pair, :list]
       # @param factory [Symbol, With]
       # @param args [Array<Object>]
       # @param kwargs [{Symbol => Object}]
       def build(variation, factory, *, **, &)
         return factory.merge(build(variation, factory.factory_name, *, **, &)) if factory.is_a? self
 
-        with = new(variation, factory, &)
-        insert_args!(with, *)
-        with.attrs.merge!(**)
-        with
+        new(variation, factory, &).extend!(*, { ** })
       end
 
-      def insert_args!(with, *args)
-        args.each do |arg|
-          case arg
-          when self
-            with.withes << arg
-          when Symbol, Numeric
-            with.traits << arg
-          when Array
-            insert_args!(with, *arg)
-          when Hash
-            with.attrs.merge!(arg)
-          when false, nil
-            # Ignored. This behavior is useful for conditional arguments like `is_premium && :premium`
-          else
-            raise ArgumentError, "Unsupported type for factory argument: #{arg}"
+      # If you want to use a custom strategy, call this along with <code>FactoryBot.register_strategy</code>.
+      # @param build_strategy [Symbol]
+      # @example
+      #   FactoryBot.register_strategy(:json, JsonStrategy)
+      #   FactoryBot::With.register_strategy(:json)
+      def register_strategy(build_strategy)
+        {
+          singular: build_strategy,
+          pair: :"#{build_strategy}_pair",
+          list: :"#{build_strategy}_list",
+        }.each do |variation, method_name|
+          Methods.define_method(method_name) do |factory = nil, *args, **kwargs, &block|
+            return Proxy.new(self, __method__) unless factory
+
+            With.build(variation, factory, *args, **kwargs, &block).instantiate(build_strategy)
           end
         end
       end
-
-      # @!visibility private
-      # @param first [Proc, nil]
-      # @param second [Proc, nil]
-      # @return [Proc, nil]
-      def merge_block(first, second)
-        return first unless second
-        return second unless first
-
-        lambda do |*args|
-          first.call(*args)
-          second.call(*args)
-        end
-      end
     end
+
+    %i[build build_stubbed create attributes_for with].each { register_strategy _1 }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot-with
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yubrot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot