factrey 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16dba45f9a86cdb78925559b08fe048a8cb1b8004a5206e2a103aa8df2889fe3
-  data.tar.gz: e84a1b67bce17d637837ecc3e1882e1b7dce4b96267652cc0e23c8bc97c46441
+  metadata.gz: 3103ae36a9bc66cf15aa05d6f2731cbaa783bfb0139105a9636b865c762e427f
+  data.tar.gz: 51b7561b137fe05e919bf9e13cf517ad9208d5c9237573b0acb198a7dffcd169
 SHA512:
-  metadata.gz: 001c21f917a7c52d76191005a127889f6ed067c0d440d4f42b6879e252224b0ffa0e585a7458ba999ec753feb7e03b4bc29c79d8f35fe0265450e56ffd48b285
-  data.tar.gz: 45e4982f36da43ff79aa9dcb316b82c8551f30034ba223aee39a321b19f01f0deddbb7ac901e842fd60ded4bd9ac26a04e2b58097b0f94f713a5a035e16a6103
+  metadata.gz: 44b1d62bc324437ab8a587b6906044711d7b65659b103bed1d6f789a3a5dd9cd2ca7caeb6ff69fd74e48ae0872627945276c3c58c03b28fd450b6af96d7763a0
+  data.tar.gz: d49aaed8a5f83620638b44ebe3963b1c68c6ef7d4effd9bfe9254e4e39de50c4859c7e33eb8be5e3a82d6b6fdbb9f04ecfa22f3fda7daeab042ed3a6e0ed5210

data/lib/factrey/blueprint/instantiator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module Factrey
   class Blueprint
     # An internal class used by {Blueprint#instantiate}.
@@ -14,12 +12,14 @@ module Factrey
       def initialize(context, blueprint)
         @context = context
         @objects = {}
-        @visited = Set.new
         @blueprint = blueprint
+
+        # Intermediate state
+        @creating_objects = Set.new
       end
 
       def instantiate_objects
-        @blueprint.nodes.each_value { ensure_object_instantiated(_1) }
+        @blueprint.nodes.each_value { ensure_object_created(_1) }
         @objects
       end
 
@@ -27,16 +27,16 @@ module Factrey
 
       # @param node [Node]
       # @return [Object]
-      def ensure_object_instantiated(node)
+      def ensure_object_created(node)
         @objects.fetch(node.name) do
-          unless @visited.add?(node.name)
+          unless @creating_objects.add?(node.name)
             raise ArgumentError, "Circular references detected around #{node.type_annotated_name}"
           end
 
           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)
+          node.auto_referenced_ancestors.each { kwargs[_1] = ensure_object_created(_2) }
+          @objects[node.name] = node.type.create_object(@context, *args, **kwargs)
         end
       end
 
@@ -44,31 +44,7 @@ module Factrey
       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
-
-      # @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_node, index = referenceable_nodes.reverse_each.with_index.find do |node, _|
-            node.type.compatible_types.include?(type_name)
-          end
-          next unless compatible_node
-
-          # the node closest to the end of the array has priority
-          next if candidates.member?(attribute) && candidates[attribute][1] <= index
-
-          candidates[attribute] = [compatible_node, index]
-        end
-
-        candidates.each do |attribute, (node, _)|
-          dest[attribute] = ensure_object_instantiated(node)
+          ensure_object_created(node)
         end
       end
     end

data/lib/factrey/blueprint/node.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
 require "securerandom"
 
 module Factrey
@@ -16,34 +15,32 @@ module Factrey
       attr_reader :name
       # @return [Type] type of the object
       attr_reader :type
-      # @return [Array<Node>] list of ancestor nodes, from root to terminal nodes
-      attr_reader :ancestors
+      # @return [Node, nil] parent node
+      attr_reader :parent
       # @return [Array<Object>] positional arguments to be passed to the factory
       attr_reader :args
       # @return [Hash{Object => Object}] keyword arguments to be passed to the factory
       attr_reader :kwargs
 
-      def initialize(name, type, ancestors: [], args: [], kwargs: {})
+      def initialize(name, type, parent: nil, args: [], kwargs: {})
         raise TypeError, "name must be a Symbol" if name && !name.is_a?(Symbol)
         raise TypeError, "type must be a Blueprint::Type" unless type.is_a? Blueprint::Type
-        unless ancestors.is_a?(Array) && ancestors.all? { _1.is_a?(Node) }
-          raise TypeError, "ancestors must be an Array of Nodes"
-        end
+        raise TypeError, "parent must be a Node" if parent && !parent.is_a?(Node)
         raise TypeError, "args must be an Array" unless args.is_a? Array
         raise TypeError, "kwargs must be a Hash" unless kwargs.is_a? Hash
 
         @name = name || :"#{ANONYMOUS_NAME_PREFIX}#{SecureRandom.hex(6)}"
         @type = type
-        @ancestors = ancestors
+        @parent = parent
         @args = args
         @kwargs = kwargs
       end
 
       # @param name [Symbol, nil]
       # @param value [Object]
-      # @param ancestors [Array<Node>]
-      def self.computed(name, value, ancestors: [])
-        new(name, Blueprint::Type::COMPUTED, ancestors:, args: [value])
+      # @param parent [Node, nil]
+      def self.computed(name, value, parent: nil)
+        new(name, Blueprint::Type::COMPUTED, parent:, args: [value])
       end
 
       # @return [Boolean]
@@ -57,7 +54,7 @@ module Factrey
 
       # @return [Ref, nil] if this node works as an alias to another node, return the reference to the node
       def alias_ref
-        case [@type, args]
+        case [type, args]
         in Blueprint::Type::COMPUTED, [Ref => ref]
           ref
         else
@@ -65,6 +62,29 @@ module Factrey
         end
       end
 
+      # @return [Array<Node>] a list of ancestor nodes
+      def ancestors = parent ? [parent].concat(parent.ancestors) : []
+
+      # @return [Hash{Symbol => Node}] a map from attributes to auto-referenced ancestor nodes
+      def auto_referenced_ancestors
+        ancestors = self.ancestors
+        candidates = {}
+        type.auto_references.each do |type_name, attribute|
+          next if kwargs.member? attribute # this attribute is explicitly specified
+
+          # closer ancestors have higher (lower integer) priority
+          compatible_node, priority = ancestors.each_with_index.find do |node, _|
+            node.type.compatible_types.include?(type_name)
+          end
+          next unless compatible_node
+          next if candidates.member?(attribute) && candidates[attribute][0] <= priority
+
+          candidates[attribute] = [priority, compatible_node]
+        end
+
+        candidates.transform_values { _2 }
+      end
+
       # Used for debugging and error reporting.
       # @return [String]
       def type_annotated_name = "#{name}(#{type.name})"

data/lib/factrey/blueprint/type.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module Factrey
   class Blueprint
     # A type representation on Factrey blueprints.
@@ -14,13 +12,12 @@ module Factrey
       attr_reader :compatible_types
       # @return [Hash{Symbol => Symbol}] a name-to-attribute mapping for auto-referencing
       attr_reader :auto_references
-      # @return [Proc] procedure that actually creates an object. See {Blueprint::Instantiator} implementation
-      attr_reader :factory
 
       # @param name [Symbol]
       # @param compatible_types [Array<Symbol>, Symbol]
       # @param auto_references [Hash{Symbol => Symbol}, Array<Symbol>, Symbol]
       # @yield [type, context, *args, **kwargs]
+      #   procedure that actually creates an object. See {Blueprint::Instantiator} implementation
       def initialize(name, compatible_types: [], auto_references: {}, &factory)
         compatible_types = [compatible_types] if compatible_types.is_a? Symbol
         auto_references = [auto_references] if auto_references.is_a? Symbol
@@ -43,8 +40,16 @@ module Factrey
         @factory = factory
       end
 
-      # A special type that represents values computed from other objects.
-      COMPUTED = Type.new(:_computed) { |_, _, arg| arg }
+      # Create an object of this type.
+      # @param context [Object] the context object that is passed to the factory
+      # @param args [Array<Object>] positional arguments for the factory
+      # @param kwargs [Hash{Symbol => Object}] keyword arguments for the factory
+      def create_object(context, *, **)
+        @factory.call(self, context, *, **)
+      end
+
+      # A special type that represents values computed from other objects. See {Node.computed}.
+      COMPUTED = new(:_computed) { |_, _, arg| arg }
     end
   end
 end

data/lib/factrey/blueprint.rb

@@ -25,7 +25,7 @@ module Factrey
           node.name,
           node.type,
           # This is OK since Hash insertion order in Ruby is retained
-          ancestors: node.ancestors.map { result.nodes[_1.name] },
+          parent: node.parent&.then { result.nodes[_1.name] },
           args: node.args.dup,
           kwargs: node.kwargs.dup,
         )

data/lib/factrey/dsl.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module Factrey
   # {Blueprint} DSL implementation.
   class DSL
@@ -37,7 +35,7 @@ module Factrey
     # @yieldparam ref [Ref]
     # @return [Ref]
     def object_node(name, type, ...)
-      node = @blueprint.add_node(Blueprint::Node.new(name, type, ancestors: @ancestors))
+      node = @blueprint.add_node(Blueprint::Node.new(name, type, parent: @ancestors.last))
       on(node.name, ...)
     end
 
@@ -47,7 +45,7 @@ module Factrey
     # @param name [Symbol, nil]
     # @param value [Object]
     def computed_node(name, value)
-      node = @blueprint.add_node(Blueprint::Node.computed(name, value, ancestors: @ancestors))
+      node = @blueprint.add_node(Blueprint::Node.computed(name, value, parent: @ancestors.last))
       node.to_ref
     end
 

data/lib/factrey/proxy.rb

@@ -15,16 +15,18 @@ module Factrey
   class Proxy < BasicObject
     # @param receiver [Object]
     # @param method [Symbol]
-    def initialize(receiver, method)
+    # @param preargs [Array<Object>]
+    def initialize(receiver, method, *preargs)
       @receiver = receiver
       @method = method
+      @preargs = preargs
     end
 
     # @!visibility private
     def respond_to_missing?(_method_name, _) = true
 
     def method_missing(method_name, ...)
-      @receiver.__send__(@method, method_name, ...)
+      @receiver.__send__(@method, *@preargs, method_name, ...)
     end
   end
 end

data/lib/factrey/ref/defer.rb

@@ -2,9 +2,9 @@
 
 module Factrey
   class Ref
-    # A thin wrapper around {Proc} to represent the procedure using the results of the reference resolution.
+    # A thin wrapper around <code>Proc</coode> to represent the procedure using the results of the reference resolution.
     # Each argument name is considered as a reference.
-    # These references are resolved and the results are passed to the {Proc}.
+    # These references are resolved and the results are passed to the <code>Proc</code>.
     #
     # {Ref}s and {Defer}s are usually created through {ShorthandMethods#ref}.
     class Defer

data/lib/factrey/ref/resolver.rb

@@ -13,7 +13,8 @@ module Factrey
 
       # Traverse data recursively and resolve all {Ref}s and {Defer}s.
       #
-      # This method supports recursive traversal for {Array} and {Hash}. For other structures, consider using {Defer}.
+      # This method supports recursive traversal for <code>Array</code> and <code>Hash</code>. For other structures,
+      # consider using {Defer}.
       # @param object [Object]
       # @param recursion_count [Integer]
       def resolve(object, recursion_count: 0)

data/lib/factrey/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factrey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - yubrot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies: []
 description: |
   Factrey provides a declarative DSL to represent the creation plan of objects, for FactoryBot::Blueprint.
@@ -50,14 +50,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: Provides a declarative DSL to represent the creation plan of objects