faker_maker 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f341f27ec954b732dde7141c9ad532346c09dadbbed4ea469894b10cac652f8
-  data.tar.gz: 61919d74b140d82fba2750bcf0e1c25473ebe21e02a2b213bd1109d94f22d9e2
+  metadata.gz: '09021d0ce98cccbc475dccc29d71e75d6554eeeba2589cae32ba3f1b455146fb'
+  data.tar.gz: 2694b0fece8d0853b86cc98f40f175b46a3c6671585c8150462dee2991b9d346
 SHA512:
-  metadata.gz: de3ae09ed6b848612d3fc23533d04f4633eaa4be42f7f7be9fc3f3938f8b86afa2a495f6928a66f38207d63233e2b37ce88897178688a4f3aa2c6c5f524b51e4
-  data.tar.gz: cdc3c4509819316bc389d2bf1857883ddfa62b14b93a8f794a043af70bd603dec46f7e0a0c37d29d8814ff447ac2762cd3d56a92fc917338bc3458b4113263c9
+  metadata.gz: 3017220049faf7e81b824bf3250cae33cbb9094c76e9016f1f49931299dd2df4b572a1be740b5e8fd39afa4166bdb5fd49c21c81a6591b67b51b3647764ec6d0
+  data.tar.gz: d809da52da4aa002cd0a06fa5d479df8da9e3a8b1b569c484e411c8aef53c648050db60f13a186403e383f3de9197c3773f0e0cb5701d9aa9e1d5427c28ee9aa

data/lib/faker_maker/factory.rb

@@ -208,6 +208,13 @@ module FakerMaker
       FakerMaker[parent].populate_instance(instance, attr_override_values, chaos:) if parent?
 
       attributes = chaos ? chaos_select(chaos) : @attributes
+      # When chaos is enabled, protect explicitly overridden attributes from being affected by chaos;
+      # what you pass in is what you get.
+      if chaos
+        override_attrs = @attributes.select { |attr| attr_override_values.key?( attr.name ) }
+        attributes = (attributes + override_attrs).uniq
+        attributes = @attributes.select { |attr| attributes.include?( attr ) }
+      end
 
       attributes.each do |attribute|
         value = value_for_attribute( instance, attribute, attr_override_values, chaos: )

data/lib/faker_maker/version.rb

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

data/lib/faker_maker.rb

@@ -29,7 +29,10 @@ module FakerMaker
   class NoSuchAttributeError < StandardError; end
   class ChaosConflictingAttributeError < StandardError; end
   class NoSuchAttributeNamingStrategy < StandardError; end
-  # Your code goes here...
+
+  # Token value for marking attributes as omittable from generated JSON.
+  # Usage in factory definitions: `omit: FakerMaker::OMIT`
+  OMIT = '__OMIT__'.freeze
 
   module_function
 

data/usefakermaker.com.site/site/src/docs/usage/chaos/index.page.md

@@ -36,3 +36,15 @@ You can also specify which attributes Chaos can use when instantiating your obje
 ```ruby
 result = FakerMaker[:item].build( chaos: %i[name manufacturer] )
 ```
+
+## Overrides are preserved
+
+When you pass override attributes at build time, Chaos will not touch them. What you pass in is what you get.
+
+```ruby
+result = FakerMaker[:item].build( attributes: { name: 'Specific Name' }, chaos: true )
+result.name
+=> "Specific Name"
+```
+
+Even though `name` is optional and Chaos might otherwise remove it, explicitly overriding it guarantees it will be present with the value you specified.

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

@@ -25,7 +25,7 @@ FakerMaker.factory :user do
 end
 
 FM[:user].as_json
- => {:name=>"Patsy Stone"}
+=> {:name=>"Patsy Stone"}
 ```
 
 On the other hand, sometimes you really, really want to destroy a factory and start again (especially if you are experimenting in a REPL for example). FakerMaker allows you to shut a factory which will de-register it from the list of available factories and attempt to unload the class it has built from the Ruby interpreter.
@@ -43,7 +43,7 @@ FakerMaker.factory :user do
 end
 
 FM[:user].as_json
- => {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk"}
- ```
+=> {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk"}
+```
 
  It also provides the `shut_all!` method to remove all factories.

data/usefakermaker.com.site/site/src/docs/usage/getting-started/index.page.md

@@ -53,5 +53,5 @@ FakerMaker.factory :request do
 end
 
 FakerMaker[:request].build.body
-# => nil
+=> nil
 ```

data/usefakermaker.com.site/site/src/docs/usage/json-field-names/index.page.md

@@ -23,7 +23,7 @@ v.engine_capacity = 125
 
 v.to_json
 
-=> "{\"wheels\":4,\"colour\":\"blue\",\"engineCapacity\":125}"
+ => "{\"wheels\":4,\"colour\":\"blue\",\"engineCapacity\":125}"
 ```
 
 ## Per-attribute naming

data/usefakermaker.com.site/site/src/docs/usage/omitting-fields/index.page.md

@@ -12,17 +12,18 @@ end
 FM[:user].build.as_json
 => {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk", :admin=>false}
 
-FM[:user].build(email: nil).as_json
+FM[:user].build( attributes: { email: nil } ).as_json
 => {:name=>"Patsy Stone", :admin=>false}
 ```
 
 The `omit` modifier can take a single value or an array. If it is passed a value and the attribute equals this value, it will not be included in the output from `as_json` (which returns a Ruby Hash) or in `to_json` methods.
 
-There are three special modifiers:
+There are four special modifiers:
 
-* `:nil` (symbol) to omit output when the attribute is set to nil
-* `:empty` to omit output when the value is an empty string, an empty array or an empty hash
+* `:nil` (symbol) to omit output when the attribute is set to nil.
+* `:empty` to omit output when the value is an empty string, an empty array or an empty hash.
 * `:always` to never output this attribute.
+* `FakerMaker::OMIT` to omit output only when the attribute is set to this token value.
 
 These can be mixed with real values, e.g.
 
@@ -33,3 +34,26 @@ FakerMaker.factory :user do
   admin {false}
 end
 ```
+
+## Using the omit token
+
+You may want to exclude a field but still allow it to be set to `nil`, an empty string/array/hash, or any other value.
+
+`FakerMaker::OMIT` is a token value that can provide this flexibility, e.g.
+
+```ruby
+FakerMaker.factory :user do
+  name(omit: FakerMaker::OMIT) {'Patsy Stone'}
+  email(omit: :nil) {'patsy@fabulous.co.uk'}
+  admin(omit: :empty) {false}
+end
+
+FM[:user].build( attributes: { name: FakerMaker::OMIT } ).as_json
+=> {:email=>"patsy@fabulous.co.uk", :admin=>false}
+
+FM[:user].build( attributes: { name: nil, email: nil } ).as_json
+=> {:name=>nil, :admin=>false}
+
+FM[:user].build( attributes: { name: '', admin: '' } ).as_json
+=> {:name=>"", :email=>"patsy@fabulous.co.uk"}
+```

metadata

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