faker_maker 5.0.2 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb0b495c6d3cbcfcb4f833e8446bd8cb3a3119643e2281e09000e751027000e
-  data.tar.gz: bc8465e73262915db5807e48c523de100d33169e82d5529051725b10ea10bc9a
+  metadata.gz: 513de304bb5e07889bc3ebcfa0f79264aedca13b7d01ab29fc1fb5559d3d5266
+  data.tar.gz: 9e5475d85f6a5eb58934450f4d7d4075e8c3778d678dffa9e9ace40b074e23d8
 SHA512:
-  metadata.gz: 8c95a76906f98b03896be2e1b1b99196d3b745eccfcb84fde9c00000e6a4d32ce566491e88af6ddbcd5b0ab48dbeb3ad0291527db702913db6364ce5afdf511f
-  data.tar.gz: 3ea216e352581c7a33b7741862bf0b2f232b4b5cafda4521dc11756b92460d628e3ee943dd538877925854b9ef75c0f903798a102e274db73d85f389abcf4f26
+  metadata.gz: a190cd322a17ccf3ad4376e80ba27584bfd8f821432539dc738e39c9ec9bfae7dada1de12db82fa866d799daaa4c13746218142e20f534da5c5f3abfa5b4e44a
+  data.tar.gz: fada3749b0b6a767a7134375e7732ab8a14b545d7b118f6ef07365c397274ae3d3ef927791fb6be7a146cb1e358965f275d420edba60df6ba1406c05ddd6cc5b

data/lib/faker_maker/factory.rb

@@ -66,7 +66,6 @@ module FakerMaker
       @instance = nil
       before_build if respond_to? :before_build
 
-      # TODO: make this cleverer to handle nested attributes
       assert_only_known_attributes_for_override( attributes )
 
       assert_chaos_options chaos if chaos
@@ -238,7 +237,7 @@ module FakerMaker
     def assert_only_known_and_optional_attributes_for_chaos( chaos_attr_values )
       chaos_attr_values = chaos_attr_values.map(&:to_sym)
       unknown_attrs = chaos_attr_values - attribute_names.flat_map do |item|
-        item.is_a?(Hash) ? item.keys : item
+        non_empty_hash?(item) ? item.keys : item
       end
       issue = "Can't build an instance of '#{class_name}' " \
               "setting '#{unknown_attrs.join( ', ' )}', no such attribute(s)"
@@ -255,7 +254,12 @@ module FakerMaker
     end
 
     def value_for_attribute( instance, attr, attr_override_values, chaos: false )
-      if overridden_value?( attr, attr_override_values ) && !attr_override_values[attr.name].is_a?( Hash )
+      # Note: This is a behaviour change on the 5.x branch
+      # If the attribute is overriden, that value will be supplied UNLESS
+      # - the value is a Hash, in which case FM will attempt to set nested parameters
+      # EXCEPT if the hash is empty, in which case the assumptions is that the user intends to always
+      # return an empty hash value
+      if overridden_value?( attr, attr_override_values ) && !non_empty_hash?(attr_override_values[attr.name])
         attr_override_values[attr.name]
       elsif attr.array?
         [].tap do |a|
@@ -275,15 +279,11 @@ module FakerMaker
     def manufacture_from_embedded_factory( attr, attributes = {}, chaos: false )
       attributes ||= {}
       # The name of the embedded factory randomly selected from the list of embedded factories.
-      embedded_factory = attr.embedded_factories.sample
+      embedded_factory = select_embedded_factory_or_sample(attr, attributes)
 
-      # filter out attributes for non-chosen embedded factories to avoid triggering
-      # the NoSuchAttribute exception
-      attributes = attr
-                   .embedded_factories
-                   .reject { |e| e == embedded_factory }
-                   .flat_map { |f| f.attributes(include_embeddings: false).map(&:name) }
-                   .then { |excl| attributes.delete_if { |k, _v| excl.include?(k) } }
+      if !embedded_factory && !attr.embedded_factories.empty?
+        raise NoSuchFactoryError, "Unable to match given attributes to an embedded factory. Atributes: #{attributes.keys}"
+      end
 
       # The object that is being manufactured by the factory.
       # If an embedded factory name is provided, it builds the object using FakerMaker.
@@ -293,6 +293,23 @@ module FakerMaker
       embedded_factory&.build(attributes:, chaos: embedded_chaos)
     end
 
+    # Given an attribute, see if there are one or more factory embeddings to choose from.
+    # If there are more than one, examine the fields and select the most appropriate facotry
+    # otherwise return a random factory
+    def select_embedded_factory_or_sample(attr, attribute_overrides)
+      factory_options = attr.embedded_factories
+      return nil unless !factory_options&.empty?
+
+      factory_options.filter { |factory_option|
+        attribute_overrides
+          .keys
+          .all? { |attribute_name|
+            factory_option
+              .attributes(include_embeddings: false)
+              .map(&:name).include?(attribute_name) }
+      }.sample
+    end
+
     def instantiate
       assemble.new
     end
@@ -341,6 +358,12 @@ module FakerMaker
       @optional_attributes ||= @attributes.select(&:optional)
     end
 
+    # Return true is the item is a Hash object and it is non-empty.
+    # Convenience method to improve readability elsewhere
+    def non_empty_hash?(item)
+      item.is_a?(Hash) && !item.empty?
+    end
+
     # Randomly selects optional attributes
     # Attributes selected from parent will also be selected for the child
     # @param [Array || TrueClass] chaos_attrs

data/lib/faker_maker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FakerMaker
-  VERSION = '5.0.2'
+  VERSION = '5.0.3'
 end

data/usefakermaker.com.site/site/src/docs/usage/embedding-factories/index.page.md

@@ -65,7 +65,7 @@ end
 This will build a object of the form (in its `as_json` guise):
 
 ```ruby
-{item: {name: "toothpaste", price: 0.99}, quantity: 10} 
+{item: {name: "toothpaste", price: 0.99}, quantity: 10}
 ```
 
 When it comes to overriding values at build time, a hash can be passed to set the nested values:
@@ -74,6 +74,8 @@ When it comes to overriding values at build time, a hash can be passed to set th
 FM[:inventory].build( attributes: { item: { name: 'floor cleaner' } } )
 ```
 
+There is **one exception** to this. Passing in an empty Hash will always set the attribute to an empty Hash. This is by-design to support the testing of invalid message formats with JSON APIs.
+
 When you allow Faker Maker to make a choice of factory by giving it an array:
 
 ```ruby
@@ -83,7 +85,9 @@ FakerMaker.factory :inventory do
 end
 ```
 
-...either the `item` or `coupon` fields could be added to each build of the `inventory` factory. Faker Maker will ignore any fields for the non-chosen factory if they are paseed in the overrides hash. This means that a `NoSuchAttribute` error will not be raised.
+...either the `item` or `coupon` fields could be added to each build of the `inventory` factory.
+
+**Since v5.0.3** when passing override values to `#build` and where the factory has a choice of embedded factory, as in the example above where an inventory may contain either an item or a coupon, Faker Maker will attempt to locate the embedded factory which most matches the values give in the override. For example, if the attributes given to build the `item` field most match `coupon` fields, that embedded factory will be chosen. If there are still several choices which match the given attributes, a random selection will be made.
 
 ## Alternative method
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 bindir: exe
 cert_chain: []
-date: 2026-07-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport