factrey 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30e4d58ea43d66a45f4d22cb563acaa3a5f7811d09cd6e7bb3a6f617c57f4223
-  data.tar.gz: a0ba9e04f9d0a387d3cf643e27c7ae8d7ace5529c5dd7bca75f0ae7cbe3d1819
+  metadata.gz: b1b0e688509760fb4e5a6c8c9426015e5168ebcaf58dee51c1457580d62d219f
+  data.tar.gz: 8447962706952260936adc9d386edaeeb4d85750f33266e5702fa42c87e5bfc2
 SHA512:
-  metadata.gz: 765c317be9294d3837c19e172ef05093b16b08d6903313f43ffaeeec9d39dc9e46e08fca2d07dddde9010595909f44bebe8cdcd735d8dd5f940760c6226fe829
-  data.tar.gz: 2fcc20ada4f208d4341cc5165241349690bb08131eb18e11b7623ff9ed8374326fc79012f88ec4b2429870175f33ac029a644b5ba67806f17f84809118a2dd54
+  metadata.gz: 7b5b370ec393ebd9a9a99dc68c4c824b8e9e4af42a120a1c686e6db3c0558a9525164c64ac93dee49c323fbebfdc5cc5c9a158d15e4fb1e58576d9c15db22c8f
+  data.tar.gz: 447931fcff3033dfeb0b308c7012e23d85bfce06c26c1f5b429248518d9e41a339cd8e6f8e2dfbfea692c94a2e1e809ecec66ceba2bdc9e99d5ca28bc993b99f

data/lib/factrey/blueprint/instantiator.rb

@@ -18,50 +18,63 @@ module Factrey
         @blueprint = blueprint
       end
 
+      def instantiate_objects
+        @blueprint.nodes.each_value { ensure_object_instantiated(_1) }
+        @objects
+      end
+
+      def instantiate_result
+        instantiate_objects # To keep consistency in the order of instantiation
+        resolver.resolve(@blueprint.result)
+      end
+
+      private
+
       # @param node [Node]
       # @return [Object]
-      def visit(node)
+      def ensure_object_instantiated(node)
         @objects.fetch(node.name) do
           unless @visited.add?(node.name)
             raise ArgumentError, "Circular references detected around #{node.type_annotated_name}"
           end
 
-          @objects[node.name] = instantiate_object(node)
+          args = resolver.resolve(node.args)
+          kwargs = resolver.resolve(node.kwargs)
+          resolve_auto_references(node.type.auto_references, node.ancestors, kwargs)
+          @objects[node.name] = node.type.factory.call(node.type, @context, *args, **kwargs)
         end
       end
 
-      private
-
-      # @param node [Node]
-      # @return [Object]
-      def instantiate_object(node)
-        resolver = Ref::Resolver.new(recursion_limit: 5) do |name|
-          visit(
-            @blueprint.nodes.fetch(name) do
-              raise ArgumentError, "Missing definition #{name} around #{node.type_annotated_name}"
-            end,
-          )
+      # @return [Ref::Resolver]
+      def resolver
+        @resolver ||= Ref::Resolver.new(recursion_limit: 5) do |name|
+          node = @blueprint.nodes.fetch(name) { raise ArgumentError, "Missing definition: #{name}" }
+          ensure_object_instantiated(node)
         end
+      end
 
-        args = resolver.resolve(node.args)
-        kwargs = resolver.resolve(node.kwargs)
-
-        # Resolve auto references to the ancestors
-        auto_references = {}
-        node.type.auto_references.each do |type_name, attribute|
-          next if kwargs.member? attribute # explicitly specified
+      # @param auto_references [Hash{Symbol => Symbol}]
+      # @param referenceable_nodes [Array<Node>]
+      # @param dest [Hash{Symbol => Object}]
+      def resolve_auto_references(auto_references, referenceable_nodes, dest)
+        candidates = {}
+        auto_references.each do |type_name, attribute|
+          next if dest.member? attribute # this attribute is explicitly specified
 
-          compatible_ancestor, index = node.ancestors.reverse_each.with_index.find do |ancestor, _|
-            ancestor.type.compatible_types.include?(type_name)
+          compatible_node, index = referenceable_nodes.reverse_each.with_index.find do |node, _|
+            node.type.compatible_types.include?(type_name)
           end
-          next unless compatible_ancestor
-          next if auto_references.member?(attribute) && auto_references[attribute][1] <= index
+          next unless compatible_node
+
+          # the node closest to the end of the array has priority
+          next if candidates.member?(attribute) && candidates[attribute][1] <= index
 
-          auto_references[attribute] = [compatible_ancestor, index]
+          candidates[attribute] = [compatible_node, index]
         end
-        auto_references.each { |attribute, (ancestor, _)| kwargs[attribute] = visit(ancestor) }
 
-        node.type.factory.call(node.type, @context, *args, **kwargs)
+        candidates.each do |attribute, (node, _)|
+          dest[attribute] = ensure_object_instantiated(node)
+        end
       end
     end
   end

data/lib/factrey/blueprint/node.rb

@@ -35,6 +35,9 @@ module Factrey
         @kwargs = kwargs
       end
 
+      # @return [Ref]
+      def to_ref = Ref.new(name)
+
       # @return [Boolean]
       def root? = ancestors.empty?
 

data/lib/factrey/blueprint.rb

@@ -10,6 +10,8 @@ module Factrey
   class Blueprint
     # @return [Hash{Symbol => Node}] a set of nodes
     attr_reader :nodes
+    # @return [Object] the result of the DSL code is defined here
+    attr_reader :result
 
     # Creates an empty blueprint.
     def initialize
@@ -34,10 +36,6 @@ module Factrey
       result
     end
 
-    # Get the last root node.
-    # @return [Node, nil]
-    def representative_node = nodes.each_value.reverse_each.find(&:root?)
-
     # Add a node. This method is used by {DSL} and usually does not need to be called directly.
     # @return [Node]
     def add_node(...)
@@ -48,15 +46,23 @@ module Factrey
       node
     end
 
-    # Create a set of objects based on this blueprint.
+    # Define the result. This method is used by {DSL} and usually does not need to be called directly.
+    # @param result [Object]
+    # @param overwrite [Boolean] whether to overwrite the existing result
+    def define_result(result, overwrite: false)
+      return if defined?(@result) && !overwrite
+
+      @result = result
+    end
+
+    # Create a set of objects and compute the result based on this blueprint.
     # @param context [Object] context object to be passed to the factories
-    # @return [Hash{Symbol => Object}]
+    # @return [(Object, {Symbol => Object})] the result and the created objects
     def instantiate(context = nil)
       instantiator = Instantiator.new(context, self)
-
-      nodes.each_value { instantiator.visit(_1) }
-
-      instantiator.objects
+      objects = instantiator.instantiate_objects
+      result = instantiator.instantiate_result
+      [result, objects]
     end
   end
 end

data/lib/factrey/dsl.rb

@@ -89,6 +89,8 @@ module Factrey
     #
     # This method is usually not called directly. Use the shorthand method defined by {.add_type} instead.
     # @param type [Blueprint::Type]
+    # @yieldparam ref [Ref]
+    # @return [Ref]
     def node(type, ...)
       name = @let_scope ? (@let_scope.name || type.name) : nil
       @let_scope = nil # consumed
@@ -98,6 +100,8 @@ module Factrey
     end
 
     # Enter the node to configure arguments and child nodes.
+    # @yieldparam ref [Ref]
+    # @return [Ref]
     # @example
     #   Factrey.blueprint do
     #     let.blog do
@@ -110,7 +114,7 @@ module Factrey
     #     # Add title to `article2`
     #     on.article2(title: "This is an article 2")
     #   end
-    def on(name = nil, ...)
+    def on(name = nil, *args, **kwargs)
       return On.new(self) if name.nil? && !block_given?
 
       node = @blueprint.nodes[name]
@@ -118,9 +122,10 @@ module Factrey
 
       stashed_ancestors = @ancestors
       @ancestors = node.ancestors + [node]
-      args(...)
+      args(*args, **kwargs)
+      yield node.to_ref if block_given?
       @ancestors = stashed_ancestors
-      node
+      node.to_ref
     end
 
     # Add arguments to the current node.
@@ -137,7 +142,6 @@ module Factrey
 
       @ancestors.last.args.concat(args)
       @ancestors.last.kwargs.update(kwargs)
-      yield if block_given?
     end
 
     class << self

data/lib/factrey/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Factrey
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/factrey.rb

@@ -37,7 +37,7 @@ module Factrey
       raise TypeError, "dsl must be a subclass of DSL" unless dsl <= DSL
 
       blueprint ||= Blueprint.new
-      dsl.new(blueprint:, ext:).instance_exec(&) if block_given?
+      blueprint.define_result dsl.new(blueprint:, ext:).instance_exec(&) if block_given?
       blueprint
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factrey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yubrot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies: []
 description: |
   Factrey provides a declarative DSL to represent the creation plan of objects, for FactoryBot::Blueprint.