factory_bot-blueprint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89384db0522f5262709df19f70d39b08af7c7eadd26e252560590e536a83d817
+  data.tar.gz: 2be455b31165be74a8a2fd2f6008d6424287c9aeefbef4b4499d2b061d70d374
+SHA512:
+  metadata.gz: c1b9a4ccf44e9dcef033bcbe83180f3f34b5650f53f033e73d5bb2c157ada4b8fdf10a98e0ec963c585f689c913252cdf5c270be018af4eb72c101f5c1af696a
+  data.tar.gz: 7b16fa3b35e416ae46f7e9db4bebec026a387cb2556ad670e96e6c6c5d2de3168403a39340d50436d19b05d22cc943a1dc78cecef8c4dcec3f7a1f93c5e831be

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 yubrot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# `factory_bot-blueprint` gem
+
+This is a part of [FactoryBot::Blueprint](https://github.com/yubrot/factory_bot-blueprint) library.
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/factory_bot/blueprint/dsl.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FactoryBot
+  module Blueprint
+    # A declarative DSL for building {Factrey::Blueprint}.
+    # This DSL automatically recognizes factories defined in FactoryBot as types.
+    class DSL < Factrey::DSL
+      # Internals:
+      # Here we rely on some of FactoryBot's internal APIs.
+      # We would like to minimize these dependencies as much as possible.
+
+      # @!visibility private
+      def respond_to_missing?(type_name, _)
+        FactoryBot.factories.registered? type_name
+      end
+
+      def method_missing(type_name, ...)
+        raise NoMethodError, "Unknown type #{type_name}" unless FactoryBot.factories.registered? type_name
+
+        factory = FactoryBot.factories.find(type_name)
+        self.class.add_type(self.class.type_from_factory_bot_factory(type_name, factory))
+        __send__(type_name, ...)
+      end
+
+      class << self
+        # @!visibility private
+        def type_from_factory_bot_factory(type_name, factory)
+          # NOTE: We consider aliases to be incompatible with each other
+          compatible_types = []
+          auto_references = {}
+
+          while factory.is_a?(FactoryBot::Factory)
+            compatible_types << factory.name
+            # Here, we use reverse_each to prioritize the upper association
+            factory.with_traits(factory.defined_traits.map(&:name)).associations.reverse_each do |assoc|
+              auto_references[Array(assoc.factory)[0].to_sym] = assoc.name
+            end
+
+            factory = factory.__send__(:parent)
+          end
+
+          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)
+        }
+
+        private_constant :FACTORY
+      end
+    end
+  end
+end

data/lib/factory_bot/blueprint/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FactoryBot
+  module Blueprint
+    VERSION = "0.1.0"
+  end
+end

data/lib/factory_bot/blueprint.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "factrey"
+require "factory_bot"
+require_relative "blueprint/version"
+require_relative "blueprint/dsl"
+
+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>,
+  # 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}.
+  # 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}.
+      # @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
+      # @return [Factrey::Blueprint] the built or extended blueprint
+      # @example
+      #   # In this example, we have three factories in FactoryBot:
+      #   FactoryBot.define do
+      #     factory(:blog)
+      #     factory(:article) { association :blog }
+      #     factory(:comment) { association :article }
+      #   end
+      #
+      #   bp =
+      #     FactoryBot::Blueprint.plan do
+      #       let.blog do
+      #         article(title: "Article 1")
+      #         article(title: "Article 2")
+      #         article(title: "Article 3") do
+      #           comment(name: "John")
+      #           comment(name: "Doe")
+      #         end
+      #       end
+      #     end
+      #
+      #   # Create a set of objects in FactoryBot (with `build` strategy) from the blueprint:
+      #   instance = FactoryBot::Blueprint.build(bp)
+      #
+      #   # This behaves as:
+      #   instance = {}
+      #   instance[:blog] = blog = FactoryBot.build(:blog)
+      #   instance[gen_random_sym] = FactoryBot.build(:article, title: "Article 1", blog:)
+      #   instance[gen_random_sym] = FactoryBot.build(:article, title: "Article 2", blog:)
+      #   instance[gen_random_sym] = article3 = FactoryBot.build(:article, title: "Article 3", blog:)
+      #   instance[gen_random_sym] = FactoryBot.build(:comment, name: "John", article: article3)
+      #   instance[gen_random_sym] = FactoryBot.build(:comment, name: "Doe", article: article3)
+      def plan(blueprint = nil, ext: nil, &) = Factrey.blueprint(blueprint, ext:, dsl: DSL, &)
+
+      # Create a set of objects by <code>build</code> 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
+      # @yield Write Blueprint DSL code here
+      # @return [Hash{Symbol => Object}]
+      def build(blueprint = nil, ext: nil, &) = instantiate(:build, blueprint, ext:, &)
+
+      # Create a set of objects by <code>create</code> 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
+      # @yield Write Blueprint DSL code here
+      # @return [Hash{Symbol => Object}]
+      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)
+
+        plan(blueprint, ext:, &).instantiate(strategy:)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot-blueprint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yubrot
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: factrey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.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.
+email:
+- yubrot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/factory_bot/blueprint.rb
+- lib/factory_bot/blueprint/dsl.rb
+- lib/factory_bot/blueprint/version.rb
+homepage: https://github.com/yubrot/factory_bot-blueprint
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yubrot/factory_bot-blueprint
+  source_code_uri: https://github.com/yubrot/factory_bot-blueprint
+  changelog_uri: https://github.com/yubrot/factory_bot-blueprint/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: FactoryBot extension for building structured objects using a declarative
+  DSL
+test_files: []