factory_bot-with 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330ba97b29d7109bb0cb89cf0493cced5300e17c3a1465066405e46c66cbcd76
-  data.tar.gz: 504cbcee6a16323d2a9494f10bcb68754d84130b343c316eab7a9f4c01432a0c
+  metadata.gz: 880e6e75c055c95bf4c8afab93288afaeb01f1a8ea7d162ecec04c3adaba1498
+  data.tar.gz: d59eb2dbc2c24256e1c1b4053d194de41378cdd3773c06375bf8617ae63af642
 SHA512:
-  metadata.gz: 11ed1a26a0ebd2590398eef94ebbf8aaeb23419cdd2b0d5e3979f3a64bbe4179e1f96d731804ccbd042535806a4999de62f5a6d5b72cf7ff5c2fbf379cd30372
-  data.tar.gz: 5da17d95d18e8c746ddd5ce0a1213a8cf24dec8766753655ea912bc91a6b7c38dde9c7d85d73bca4165b7d17f126af31c2a4fd71be3cdbb5807c40a0434ef259
+  metadata.gz: 74ee4b6d1718cfef30a3ddfaaca2486f854c8c6db5c4b1fa63c1947f2ae3f2430e8ec67afd8dac052ff049df4d61c7f091b66a0080d187e51e58c4795534b66f
+  data.tar.gz: f01718b24e04fe024189d77cec858f0aad8ec88fac9de520ced36bf954863775e6c0ecb079d0831016fac2d863edec204c8a23bec82f304ecd2b8c4186c9ab5e

data/.github/workflows/main.yml

@@ -14,7 +14,8 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '3.3.6'
+          - '3.4.2'
+          - '3.3.7'
           - '3.2.6'
 
     steps:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.4.0]
+
+- Fixed: Improved error message for incorrect factory usage
+- Added: Added `with` scope syntax for automatic association resolution
+
 ## [0.3.0] - 2024-12-09
 
 - Added: Added `FactoryBot::With.register_strategy` to support custom strategies

data/README.md

@@ -5,6 +5,8 @@
 
 FactoryBot::With is a FactoryBot extension that wraps `FactoryBot::Syntax::Methods` to make it a little easier to use.
 
+[FactoryBot における関連の扱いと、factory_bot-with gem を作った話 (Japanese)](https://zenn.dev/yubrot/articles/032447068e308e)
+
 For example, with these factories:
 
 ```ruby
@@ -143,16 +145,18 @@ create.blog(with.article) # autocomplete to :blog_article
 
 </details>
 
+## Additional features
+
 ### `with` as a template
 
-`with` can also be used stand-alone. It works as a template for factory method calls.
+`with` can also be used stand-alone. Stand-alone `with` can be used in place of the factory name. It works as a template for factory method calls.
 
 Instead of writing:
 
 ```ruby
 let(:story) { create(:story, *story_args, **story_kwargs) }
 let(:story_args) { [] }
-let(:story_kwargs) { {} }
+let(:story_kwargs) { { category: "SF" } }
 
 context "when published more than one year ago" do
   let(:story_args) { [*super(), :published] }
@@ -167,7 +171,7 @@ You can write like this:
 ```ruby
 # Factory methods accept a With instance as a first argument:
 let(:story) { create(story_template) }
-let(:story_template) { with.story }
+let(:story_template) { with.story(category: "SF") }
 
 context "when published more than one year ago" do
   let(:story_template) { with(super(), :published, start_at: 2.year.ago) }
@@ -176,6 +180,22 @@ context "when published more than one year ago" do
 end
 ```
 
+### `with` scope for automatic association resolution
+
+By calling `with` without positional arguments, but with keyword arguments that define the relationship between factory names and objects, along with a block, `factory_bot-with` creates a scope where those objects become candidates for automatic association resolution.
+
+```ruby
+let(:blog) { create.blog }
+
+before do
+  with(blog:) do
+    # Just like when using create.blog, blog is automatically resolved when create.article is called
+    create.article(with.comment)
+    create.article(with_list.comment(3))
+  end
+end
+```
+
 ## Development
 
 ```bash

data/lib/factory_bot/with/proxy.rb

@@ -4,31 +4,28 @@ module FactoryBot
   class With
     # An intermediate object to provide some notation combined with <code>method_missing</code>.
     # @example
-    #   class Foo
-    #     def foo(name = nil)
+    #   class Example
+    #     def foo(name = nil, ...)
     #       return FactoryBot::With::Proxy.new(self, __method__) unless name
     #
     #       name
     #     end
     #   end
     #
-    #   Foo.new.foo.bar #=> :bar
+    #   ex = Example.new
+    #   ex.foo.bar #=> :bar
     class Proxy < BasicObject
       # @param receiver [Object]
       # @param method [Symbol]
-      # @param preargs [Array]
-      def initialize(receiver, method, *preargs)
+      def initialize(receiver, method)
         @receiver = receiver
         @method = method
-        @preargs = preargs
       end
 
       # @!visibility private
       def respond_to_missing?(_method_name, _) = true
 
-      def method_missing(method_name, ...)
-        @receiver.__send__(@method, *@preargs, method_name, ...)
-      end
+      def method_missing(method_name, ...) = @receiver.__send__(@method, method_name, ...)
     end
   end
 end

data/lib/factory_bot/with/version.rb

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

data/lib/factory_bot/with.rb

@@ -96,7 +96,7 @@ module FactoryBot
     # @param build_strategy [Symbol]
     # @param ancestors [Array<Array(AssocInfo, Object)>, nil]
     # @return [Object]
-    def instantiate(build_strategy, ancestors = nil)
+    def instantiate(build_strategy, ancestors = self.class.scoped_ancestors)
       return self if build_strategy == :with
 
       factory_bot_method =
@@ -148,12 +148,40 @@ module FactoryBot
           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)
+            if factory
+              # <__method__>(<factory_name>, ...)
+              With.build(variation, factory, *args, **kwargs, &block).instantiate(build_strategy)
+            elsif args.empty? && kwargs.empty? && !block
+              # <__method__>.<factory_name>(...)
+              Proxy.new(self, __method__)
+            elsif __method__ == :with && args.empty? && !kwargs.empty?
+              # with(<factory_name>: <object>, ...) { ... }
+              With.with_scoped_ancestors(kwargs, &block)
+            else
+              raise ArgumentError, "Invalid use of #{__method__}"
+            end
           end
         end
       end
+
+      # @!visibility private
+      # @param objects [{Symbol => Object}]
+      def with_scoped_ancestors(objects)
+        return unless block_given?
+
+        tmp_scoped_ancestors = scoped_ancestors
+        Thread.current[:factory_bot_with_scoped_ancestors] = [
+          *objects.map { [AssocInfo.get(_1), _2] },
+          *tmp_scoped_ancestors || [],
+        ]
+        result = yield
+        Thread.current[:factory_bot_with_scoped_ancestors] = tmp_scoped_ancestors
+        result
+      end
+
+      # @!visibility private
+      # @return [Array<Array(AssocInfo, Object)>, nil]
+      def scoped_ancestors = Thread.current[:factory_bot_with_scoped_ancestors]
     end
 
     %i[build build_stubbed create attributes_for with].each { register_strategy _1 }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot-with
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - yubrot
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -52,7 +51,6 @@ metadata:
   source_code_uri: https://github.com/yubrot/factory_bot-with
   changelog_uri: https://github.com/yubrot/factory_bot-with/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: FactoryBot extension that wraps FactoryBot::Syntax::Methods to make it a
   little easier to use