factory_bot-blueprint 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbfd3f2bba8aa92e21a6e375970c77d48e6634cef9cf39085f5e2648f5415b37
-  data.tar.gz: 55177d1b09287b9b0857614700410db2109333c05b4f5d624028ce15eaa06988
+  metadata.gz: e01f7a2b8a4f8b2940edd4c7793e941274356fe21fc294acb3afd27c1eacab73
+  data.tar.gz: b57c70a58ea87edbc8d9a66d6a87b16c63051d5d12eec86ce02c26b6ec1339bc
 SHA512:
-  metadata.gz: b4a37fb4bfd61893df1a4301244fd0d3f1bf4c55d4ed3962e62bccfc541a94df9f6b5164fdfc5bfecacd8d6bc42094b21b55c46ae17c59ce0242f573be6ded35
-  data.tar.gz: 78519c9aff90307fc68485847bd7c76bbe635ef1d08c154c596ea1b683f3c9dea4ad4f9e830356fb652f2ae6b29061f84fdb1a4fbb8a56cb280854602f1e64fb
+  metadata.gz: 3e07e0eb13aa6098f34e280b88eeaa4db272432965084da60bd135c481523fadae22edf1bd1678224376ed9ff89b646c3c859f31083e7f05b9b4443a0690e00d
+  data.tar.gz: df80db74e368bea0faa790160ac1d7597163ad45e460bbaa1979d00af5a408fede439efa01dd755387799286031a577459210a8a51662ee59e2f1a9d45d0d02f

data/lib/factory_bot/blueprint/dsl.rb

@@ -2,7 +2,7 @@
 
 module FactoryBot
   module Blueprint
-    # A declarative DSL for building {Factrey::Blueprint}.
+    # A declarative DSL for building {https://rubydoc.info/gems/factrey/Factrey/Blueprint Factrey::Blueprint}.
     # This DSL automatically recognizes factories defined in FactoryBot as types.
     class DSL < Factrey::DSL
       # Internals:
@@ -10,16 +10,38 @@ module FactoryBot
       # We would like to minimize these dependencies as much as possible.
 
       # @!visibility private
-      def respond_to_missing?(type_name, _)
-        FactoryBot.factories.registered? type_name
+      def respond_to_missing?(name, _)
+        _autocompleted_method_names(name).any? do |method_name|
+          self.class.method_defined?(method_name) || FactoryBot.factories.registered?(method_name)
+        end
+      end
+
+      def method_missing(name, ...)
+        _autocompleted_method_names(name).each do |method_name|
+          if self.class.method_defined?(method_name)
+            return __send__(method_name, ...)
+          elsif FactoryBot.factories.registered?(method_name)
+            factory = FactoryBot.factories.find(method_name)
+            self.class.add_type(self.class.type_from_factory_bot_factory(method_name, factory))
+            return __send__(method_name, ...)
+          end
+        end
+
+        raise NoMethodError,
+              "Undefined method `#{name}' for #{self} and cannot be resolved from FactoryBot factories"
       end
 
-      def method_missing(type_name, ...)
-        raise NoMethodError, "Unknown type #{type_name}" unless FactoryBot.factories.registered? type_name
+      private
+
+      def _autocompleted_method_names(name)
+        return enum_for(__method__, name) unless block_given?
 
-        factory = FactoryBot.factories.find(type_name)
-        self.class.add_type(self.class.type_from_factory_bot_factory(type_name, factory))
-        __send__(type_name, ...)
+        @ancestors.reverse_each do |ancestor|
+          ancestor.type.compatible_types.each do |ancestor_type|
+            yield :"#{ancestor_type}_#{name}"
+          end
+        end
+        yield name
       end
 
       class << self
@@ -42,9 +64,9 @@ module FactoryBot
           Factrey::Blueprint::Type.new(type_name, compatible_types:, auto_references:, &FACTORY)
         end
 
-        FACTORY = lambda { |type, context, *args, **kwargs|
-          FactoryBot.__send__(context[:strategy], type.name, *args, **kwargs)
-        }
+        FACTORY = lambda do |type, context, *args, **kwargs|
+          FactoryBot.__send__(context[:build_strategy], type.name, *args, **kwargs)
+        end
 
         private_constant :FACTORY
       end

data/lib/factory_bot/blueprint/methods.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FactoryBot
+  module Blueprint
+    # This module provides a shortcut to FactoryBot::Blueprint.
+    # @example
+    #   # Configure the same way as FactoryBot::Syntax::Methods
+    #   RSpec.configure do |config|
+    #     config.include FactoryBot::Syntax::Methods
+    #     config.include FactoryBot::Blueprint::Methods
+    #   end
+    #
+    #   # You can use `bp` in your spec files
+    #   RSpec.describe "something" do
+    #     before do
+    #       bp.create do
+    #         blog do
+    #           article(title: "Article 1")
+    #           article(title: "Article 2")
+    #           article(title: "Article 3") do
+    #             comment(name: "John")
+    #             comment(name: "Doe")
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    module Methods
+      # @return [Class<FactoryBot::Blueprint>]
+      def bp = FactoryBot::Blueprint
+    end
+  end
+end

data/lib/factory_bot/blueprint/version.rb

@@ -2,6 +2,6 @@
 
 module FactoryBot
   module Blueprint
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/factory_bot/blueprint.rb

@@ -4,21 +4,25 @@ require "factrey"
 require "factory_bot"
 require_relative "blueprint/version"
 require_relative "blueprint/dsl"
+require_relative "blueprint/methods"
 
 module FactoryBot
   # A FactoryBot extension for building structured objects using a declarative DSL.
-  # First we can build (or extend) a creation plan for a set of objects as <code>Blueprint</code>,
+  # First we can build (or extend) a creation plan for a set of objects as
+  # {https://rubydoc.info/gems/factrey/Factrey/Blueprint Factrey::Blueprint},
   # and then we can create actual objects from it.
   #
-  # <code>Blueprint</code>s can be built using a declarative DSL provided by a core library called {Factrey}.
+  # <code>Blueprint</code>s can be built using a declarative DSL provided by a core library called <code>Factrey</code>.
   # Each node declaration in the DSL code is automatically correspond to the FactoryBot's factory. For example,
   # a declaration <code>user(name: 'John')</code> corresponds to <code>FactoryBot.create(:user, name: 'John')</code>.
   module Blueprint
     class << self
-      # Entry point to build or extend a {Factrey::Blueprint}.
+      # Entry point to build or extend a {https://rubydoc.info/gems/factrey/Factrey/Blueprint Factrey::Blueprint}.
       # @param blueprint [Factrey::Blueprint, nil] to extend an existing blueprint
-      # @param ext [Object] an external object that can be accessed using {DSL#ext} in the DSL
-      # @yield Write Blueprint DSL code here. See {Factrey::DSL} methods for DSL details
+      # @param ext [Object] an external object that can be accessed using <code>DSL#ext</code> in the DSL
+      # @yield
+      #   Write Blueprint DSL code here. See {https://rubydoc.info/gems/factrey/Factrey/DSL Factrey::DSL} documents for
+      #   more details
       # @return [Factrey::Blueprint] the built or extended blueprint
       # @example
       #   # In this example, we have three factories in FactoryBot:
@@ -40,41 +44,51 @@ module FactoryBot
       #       end
       #     end
       #
-      #   # Create a set of objects in FactoryBot (with `build` strategy) from the blueprint:
-      #   result, objects = FactoryBot::Blueprint.build(bp)
+      #   # Create a set of objects in FactoryBot (with `build` build strategy) from the blueprint:
+      #   objects = FactoryBot::Blueprint.build(bp)
       #
       #   # This behaves as:
       #   objects = {}
       #   objects[:blog] = blog = FactoryBot.build(:blog)
-      #   objects[gen_random_sym] = FactoryBot.build(:article, title: "Article 1", blog:)
-      #   objects[gen_random_sym] = FactoryBot.build(:article, title: "Article 2", blog:)
-      #   objects[gen_random_sym] = article3 = FactoryBot.build(:article, title: "Article 3", blog:)
-      #   objects[gen_random_sym] = FactoryBot.build(:comment, name: "John", article: article3)
-      #   objects[gen_random_sym] = FactoryBot.build(:comment, name: "Doe", article: article3)
-      #   result = blog
+      #   objects[random_anon_sym] = FactoryBot.build(:article, title: "Article 1", blog:)
+      #   objects[random_anon_sym] = FactoryBot.build(:article, title: "Article 2", blog:)
+      #   objects[random_anon_sym] = article3 = FactoryBot.build(:article, title: "Article 3", blog:)
+      #   objects[random_anon_sym] = FactoryBot.build(:comment, name: "John", article: article3)
+      #   objects[random_anon_sym] = FactoryBot.build(:comment, name: "Doe", article: article3)
+      #   objects[Factrey::Blueprint::Node::RESULT_NAME] = blog
       def plan(blueprint = nil, ext: nil, &) = Factrey.blueprint(blueprint, ext:, dsl: DSL, &)
 
-      # Create a set of objects and compute the result by <code>build</code> strategy in FactoryBot.
+      # Create a set of objects by <code>build</code> build strategy in FactoryBot.
       # See {.plan} for more details.
       # @param blueprint [Factrey::Blueprint, nil]
-      # @param ext [Object] an external object that can be accessed using {DSL#ext} in the DSL
+      # @param ext [Object] an external object that can be accessed using <code>DSL#ext</code> in the DSL
       # @yield Write Blueprint DSL code here
-      # @return [(Object, {Symbol => Object})] the result and the created objects
+      # @return [Hash{Symbol => Object}] the created objects
       def build(blueprint = nil, ext: nil, &) = instantiate(:build, blueprint, ext:, &)
 
-      # Create a set of objects and compute the result by <code>create</code> strategy in FactoryBot.
+      # Create a set of objects by <code>build_stubbed</code> build strategy in FactoryBot.
       # See {.plan} for more details.
       # @param blueprint [Factrey::Blueprint, nil]
-      # @param ext [Object] an external object that can be accessed using {DSL#ext} in the DSL
+      # @param ext [Object] an external object that can be accessed using <code>DSL#ext</code> in the DSL
       # @yield Write Blueprint DSL code here
-      # @return [(Object, {Symbol => Object})] the result and the created objects
+      # @return [Hash{Symbol => Object}] the created objects
+      def build_stubbed(blueprint = nil, ext: nil, &) = instantiate(:build_stubbed, blueprint, ext:, &)
+
+      # Create a set of objects by <code>create</code> build strategy in FactoryBot.
+      # See {.plan} for more details.
+      # @param blueprint [Factrey::Blueprint, nil]
+      # @param ext [Object] an external object that can be accessed using <code>DSL#ext</code> in the DSL
+      # @yield Write Blueprint DSL code here
+      # @return [Hash{Symbol => Object}] the created objects
       def create(blueprint = nil, ext: nil, &) = instantiate(:create, blueprint, ext:, &)
 
       # @!visibility private
-      def instantiate(strategy, blueprint = nil, ext: nil, &)
-        raise ArgumentError, "Unsupported strategy: #{strategy}" unless %i[create build].include?(strategy)
+      def instantiate(build_strategy, blueprint = nil, ext: nil, &)
+        unless %i[create build build_stubbed].include?(build_strategy)
+          raise ArgumentError, "Unsupported build strategy: #{build_strategy}"
+        end
 
-        plan(blueprint, ext:, &).instantiate(strategy:)
+        plan(blueprint, ext:, &).instantiate(build_strategy:)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - yubrot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
 description: |
   FactoryBot::Blueprint is a FactoryBot extension for building structured objects using a declarative DSL.
   On the DSL, the factories defined in FactoryBot can be used without any additional configuration.
@@ -51,6 +51,7 @@ files:
 - README.md
 - lib/factory_bot/blueprint.rb
 - lib/factory_bot/blueprint/dsl.rb
+- lib/factory_bot/blueprint/methods.rb
 - lib/factory_bot/blueprint/version.rb
 homepage: https://github.com/yubrot/factory_bot-blueprint
 licenses:
@@ -68,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: FactoryBot extension for building structured objects using a declarative