faker_maker 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9201db222f65f8df79f92edc882d9d76e5ca21c6220b377f5e86ce9414d287
-  data.tar.gz: d4601f347ce1231fd287d33addde2bb83c00a1a770783eec8007dd7417c6c2f3
+  metadata.gz: a077bc198db9d38ed9784aa30231b51955197b1ae28c0fc790aad28bd5c07f9f
+  data.tar.gz: f8eea37df0773cf0abb16f57e104a45941e24577c3ca0eb9ff19fa7922cad93a
 SHA512:
-  metadata.gz: ce1be4538d82898bb1accd89585485e6072974350088261dece5f0481a3d1950cbf1462dba6363231e2b25019632d8f1aa649e04cab5c4a0a752c6ca9e428c7f
-  data.tar.gz: 2d442d69c483b0aa5ba5f7bc9fd26396376edbc2ff700c9d47305d27f2fc809d42d4971bf8ef8b09c67f7f4912395e6eb0127c0d105e6763708f342916e2ae85
+  metadata.gz: d2423079545d812ca8434016d2e34399ac4c72be3cabdb237a36fe4f645de606c87f308cbcb082ad8dda0638f49fbd84a409421ee447fa0b67297475c1724f87
+  data.tar.gz: f6ead79d10a9f82bffc4a031629ce3c1c3b7885563db2c9ff00a6fc671e5d207bc4405cde40af11cee0261e95d5dbbd64b7cb5e7087749898d7d42587e626125

data/docs/usage/embedding_factories.md

@@ -15,9 +15,59 @@ FakerMaker.factory :item do
   price { Faker::Commerce.price }
 end
 
+FakerMaker.factory :basket do
+  items( has: 10, factory: :item )
+end
+```
+
+In this example, FakerMaker will build an `item` (well, 10 `item`s in this case) using item factory as it is building a `basket`. The advantage of this method is that `item` factory can be declared *after* the `basket` factory.
+
+If you want to select randomly from one or more factories, provide an array of factory names:
+
+```ruby
+FakerMaker.factory :coupon do
+  discount { Faker::Commerce.price }
+end
+
+FakerMaker.factory :item do
+  name { Faker::Commerce.product_name }
+  price { Faker::Commerce.price }
+end
+
+FakerMaker.factory :basket do
+  items( has: 10, factory: [:item, :discount] )
+end
+```
+
+In this example, through 10 iterations, one of `item` and `discount` factories will be called to build their objects.
+
+Blocks can still be provided and the referenced factory built object will be passed to the block:
+
+```ruby
+FakerMaker.factory :item do
+  name { Faker::Commerce.product_name }
+  price { Faker::Commerce.price }
+end
+
+FakerMaker.factory :basket do
+  items( has: 10, factory: :item ) { |item| item.price = 10.99 ; item}
+end
+```
+**Important:** the value for the attribute will be the value returned from the block. If you want to modify the contents of the referenced factory's object, don't forget to return it at the end of the block (as above).
+
+## Alternative method
+
+There is an alternative style which might be of use:
+
+```ruby
+FakerMaker.factory :item do
+  name { Faker::Commerce.product_name }
+  price { Faker::Commerce.price }
+end
+
 FakerMaker.factory :basket do
   items( has: 10 ) { FakerMaker[:item].build }
 end
 ```
 
-You might have to [manage your dependencies]({% link usage/dependencies.md %}) and `require` your referenced factory.
+With this pattern, you might have to [manage your dependencies]({% link usage/dependencies.md %}) and `require` your referenced factory.

data/docs/usage/index.md

@@ -49,4 +49,15 @@ FakerMaker.factory :user, class: 'EmailUser' do
   email {'patsy@fabulous.co.uk'}
   admin {false}
 end
+```
+
+Fields with no block (or reference to another factory) will be nil.
+
+```ruby
+FakerMaker.factory :request do 
+  body
+end
+
+FakerMaker[:request].build.body
+# => nil
 ```

data/faker_maker.gemspec

@@ -53,6 +53,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',          '~> 13.0'
   spec.add_development_dependency 'rspec',         '~> 3.8'
   spec.add_development_dependency 'rubocop',       '~> 1.0'
+  spec.add_development_dependency 'racc',          '~> 1.0'
 
   spec.required_ruby_version = '>= 3.0'
 end

data/lib/faker_maker/attribute.rb

@@ -3,18 +3,19 @@
 module FakerMaker
   # Attributes describe the fields of classes
   class Attribute
-    attr_reader :name, :block, :translation, :required, :optional, :optional_weighting
+    attr_reader :name, :block, :translation, :required, :optional, :optional_weighting, :embedded_factories
 
     DEFAULT_OPTIONAL_WEIGHTING = 0.5
 
     def initialize( name, block = nil, options = {} )
       assert_valid_options options
       @name = name
-      @block = block || proc {}
+      @block = block || nil
       @cardinality = options[:has] || 1
       @translation = options[:json]
       @omit = *options[:omit]
       @array = options[:array] == true
+      @embedded_factories = *options[:factory]
 
       if options[:required].to_s.downcase.eql?('true') || options[:optional].to_s.downcase.eql?('false')
         @required = true
@@ -58,7 +59,7 @@ module FakerMaker
     end
 
     def assert_valid_options( options )
-      options.assert_valid_keys :has, :array, :json, :omit, :required, :optional
+      options.assert_valid_keys :has, :array, :json, :omit, :required, :optional, :factory
     end
 
     def determine_optional_weighting( value )

data/lib/faker_maker/factory.rb

@@ -81,6 +81,7 @@ module FakerMaker
     def as_json(*_args)
       build.as_json
     end
+    alias to_h as_json
 
     def parent?
       !@parent.nil?
@@ -163,12 +164,28 @@ module FakerMaker
       if attribute_hash_overridden_value?( attr, attr_override_values )
         attr_override_values[attr.name]
       elsif attr.array?
-        [].tap { |a| attr.cardinality.times { a << instance.instance_eval(&attr.block) } }
+        [].tap do |a|
+          attr.cardinality.times do
+            manufacture = manufacture_from_embedded_factory( attr )
+            # if manufacture has been build and there is a block, instance_exec the block
+            # otherwise just add the manufacture to the array
+            a << (attr.block ? instance.instance_exec(manufacture, &attr.block) : manufacture)
+          end
+        end
       else
-        instance.instance_eval(&attr.block)
+        manufacture = manufacture_from_embedded_factory( attr )
+        attr.block ? instance.instance_exec(manufacture, &attr.block) : manufacture
       end
     end
 
+    def manufacture_from_embedded_factory( attr )
+      # The name of the embedded factory randomly selected from the list of embedded factories.
+      embedded_factory_name = attr.embedded_factories.sample
+      # The object that is being manufactured by the factory.
+      # If an embedded factory name is provided, it builds the object using FakerMaker.
+      embedded_factory_name ? FakerMaker[embedded_factory_name].build : nil
+    end
+
     def instantiate
       assemble.new
     end
@@ -186,6 +203,7 @@ module FakerMaker
           .transform_keys { |key| @fm_factory.json_key_map[key] || key }
           .filter { |key, value| !@fm_factory.find_attribute(key)&.omit?( value ) }
       end
+      @klass.alias_method :to_h, :as_json
     end
 
     def assert_valid_options( options )

data/lib/faker_maker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: FakerMaker is a simple factory builder so you can throw away your fixtures
   and generate test data instead.
 email:
@@ -248,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: FakerMaker bakes fakes.