faker_maker 2.1.2 → 4.0.0.beta1

data/usefakermaker.com/_site/assets/js/lunr/lunr-store.js

@@ -1,10 +1 @@
-var store = [{
-        "title": "Welcome to Jekyll!",
-        "excerpt":"You’ll find this post in your _posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.   Jekyll requires blog post files to be named according to the following format:   YEAR-MONTH-DAY-title.MARKUP   Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.   Jekyll also offers powerful support for code snippets:   def print_hi(name)   puts \"Hi, #{name}\" end print_hi('Tom') #=> prints 'Hi, Tom' to STDOUT.  Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll Talk.   ","categories": ["jekyll","update"],
-        "tags": [],
-        "url": "/jekyll/update/welcome-to-jekyll/",
-        "teaser": null
-      },{
-    "title": "About",
-    "excerpt":"This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at jekyllrb.com   You can find the source code for Minima at GitHub: jekyll / minima   You can find the source code for Jekyll at GitHub: jekyll / jekyll   ","url": "http://localhost:4000/about/"
-  }]
+var store = [,]

data/usefakermaker.com/_site/feed.xml

@@ -1,17 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.3.4">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2024-10-14T16:53:17+01:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Faker Maker</title><subtitle>Factories over fixtures: cook your test data from fresh</subtitle><author><name>Nigel Brookes-Thomas (Billy Ruffian)</name></author><entry><title type="html">Welcome to Jekyll!</title><link href="http://localhost:4000/jekyll/update/welcome-to-jekyll/" rel="alternate" type="text/html" title="Welcome to Jekyll!" /><published>2024-10-14T13:56:50+01:00</published><updated>2024-10-14T13:56:50+01:00</updated><id>http://localhost:4000/jekyll/update/welcome-to-jekyll</id><content type="html" xml:base="http://localhost:4000/jekyll/update/welcome-to-jekyll/"><![CDATA[<p>You’ll find this post in your <code class="language-plaintext highlighter-rouge">_posts</code> directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run <code class="language-plaintext highlighter-rouge">jekyll serve</code>, which launches a web server and auto-regenerates your site when a file is updated.</p>
-
-<p>Jekyll requires blog post files to be named according to the following format:</p>
-
-<p><code class="language-plaintext highlighter-rouge">YEAR-MONTH-DAY-title.MARKUP</code></p>
-
-<p>Where <code class="language-plaintext highlighter-rouge">YEAR</code> is a four-digit number, <code class="language-plaintext highlighter-rouge">MONTH</code> and <code class="language-plaintext highlighter-rouge">DAY</code> are both two-digit numbers, and <code class="language-plaintext highlighter-rouge">MARKUP</code> is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.</p>
-
-<p>Jekyll also offers powerful support for code snippets:</p>
-
-<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">print_hi</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
-  <span class="nb">puts</span> <span class="s2">"Hi, </span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span>
-<span class="k">end</span>
-<span class="n">print_hi</span><span class="p">(</span><span class="s1">'Tom'</span><span class="p">)</span>
-<span class="c1">#=&gt; prints 'Hi, Tom' to STDOUT.</span></code></pre></figure>
-
-<p>Check out the <a href="https://jekyllrb.com/docs/home">Jekyll docs</a> for more info on how to get the most out of Jekyll. File all bugs/feature requests at <a href="https://github.com/jekyll/jekyll">Jekyll’s GitHub repo</a>. If you have questions, you can ask them on <a href="https://talk.jekyllrb.com/">Jekyll Talk</a>.</p>]]></content><author><name>Nigel Brookes-Thomas (Billy Ruffian)</name></author><category term="jekyll" /><category term="update" /><summary type="html"><![CDATA[You’ll find this post in your _posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.]]></summary></entry></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.3.4">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2025-01-16T09:57:40+00:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Faker Maker</title><subtitle>Factories over fixtures: cook your test data from fresh</subtitle><author><name>Nigel Brookes-Thomas (Billy Ruffian)</name></author></feed>

data/usefakermaker.com/_site/sitemap.xml

@@ -1,13 +1,3 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-<url>
-<loc>http://localhost:4000/jekyll/update/welcome-to-jekyll/</loc>
-<lastmod>2024-10-14T13:56:50+01:00</lastmod>
-</url>
-<url>
-<loc>http://localhost:4000/about/</loc>
-</url>
-<url>
-<loc>http://localhost:4000/</loc>
-</url>
 </urlset>

data/usefakermaker.com/about.markdown

@@ -0,0 +1,18 @@
+---
+layout: page
+title: About
+permalink: /about/
+---
+
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
+
+You can find the source code for Minima at GitHub:
+[jekyll][jekyll-organization] /
+[minima](https://github.com/jekyll/minima)
+
+You can find the source code for Jekyll at GitHub:
+[jekyll][jekyll-organization] /
+[jekyll](https://github.com/jekyll/jekyll)
+
+
+[jekyll-organization]: https://github.com/jekyll

data/usefakermaker.com/docs/contributing/index.md

@@ -0,0 +1,7 @@
+---
+layout: single
+title: Contributing
+nav_order: 2
+---
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/BillyRuffian/faker_maker>

data/{docs/installation.md → usefakermaker.com/docs/installing/index.md}

@@ -1,11 +1,9 @@
 ---
-layout: default
-title: Installation
+layout: single
+title: Installing Faker Maker
 nav_order: 2
 ---
 
-# Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -18,4 +16,4 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install faker_maker
+    $ gem install faker_maker

data/{docs/usage/arrays.md → usefakermaker.com/docs/usage/arrays/index.md}

@@ -1,12 +1,8 @@
 ---
-layout: default
+layout: single
 title: Arrays
-parent: Usage
-nav_order: 2
 ---
 
-# Arrays
-
 It is possible to declare an attribute as having multiple values.
 
 ```ruby
@@ -41,4 +37,4 @@ FakerMaker.factory :basket do
     Faker::Commerce.product_name
   end
 end
-```
+```

data/{docs/usage/building_instances.md → usefakermaker.com/docs/usage/building-instances/index.md}

@@ -1,13 +1,9 @@
 ---
-layout: default
+layout: single
 title: Building Instances
-parent: Usage
-nav_order: 6
 ---
 
-# Building Instances
-
-Instances are Plain Ol' Ruby Objects and the attributes are attached with getters and setters with their values assigned to the value return from their block at build time. 
+Instances are Plain Ol' Ruby Objects and the attributes are attached with getters and setters with their values assigned to the value return from their block at build time.
 
 To build an object:
 
@@ -15,12 +11,12 @@ To build an object:
 result = FakerMaker[:basket].build
 ```
 
-will generate a new instance using the Basket factory. Because an actual class is defined, you can instantiate an object directly through `Basket.new` but that will not populate any of the attributes.
+will generate a new instance using the Basket factory. Because an actual class is defined (since v3.0.0 Classes generated by FakerMaker are in the `FakerMaker::Factory` namespace), you can instantiate an object directly through `Basket.new` but that will not populate any of the attributes.
 
-It's possible to override attributes at build-time, either by passing values as a hash:
+It's possible to override attributes at build-time, either by passing values as a hash (preferred):
 
 ```ruby
-result = FakerMaker[:item].build( name: 'Electric Blanket' )
+result = FakerMaker[:item].build( attributes: { name: 'Electric Blanket' } )
 ```
 
 or by passing in a block:
@@ -32,7 +28,7 @@ result = FakerMaker[:item].build{ |i| i.name = 'Electric Sheep' }
 this is particularly useful for overriding nested values, since all the getters and setters of the embedded objects are already constructed:
 
 ```ruby
-result = FakerMaker[:basket].build do |b| 
+result = FakerMaker[:basket].build do |b|
   b.items.first.name = 'Neon Badger'
 end
 ```
@@ -40,7 +36,7 @@ end
 if you're crazy enough to want to do both styles during creation, the values in the block will be preserved, e.g.
 
 ```ruby
-result = FakerMaker[:item].build( name: 'Electric Blanket' ) do |i| 
+result = FakerMaker[:item].build( attributes: { name: 'Electric Blanket' } ) do |i|
   i.name = 'Electric Sheep'
 end
 ```
@@ -61,4 +57,6 @@ As another convenience, `FakerMaker` is also assigned to the variable `FM` to it
 
 ```ruby
 result = FM[:basket].build
-```
+```
+
+**For more complex instance building with embedded factories, see [Embedding Factories](docs/usage/embedding-factories/).**

data/{docs/usage/chaos.md → usefakermaker.com/docs/usage/chaos/index.md}

@@ -1,17 +1,13 @@
 ---
-layout: default
+layout: single
 title: Chaos
-parent: Usage
-nav_order: 11
 ---
 
-# Chaos
+Chaos mode introduces extra spice to your generated factories.
 
-Chaos mode introduces extra spice to your generated factories. 
+Attributes can be marked as either `required` or `optional`, which Chaos will use to determine what attributes are included when instantiating your factory.
 
-Attributes can be marked as either `required` or `optional`, which Chaos will use to determine what attributes are included when instantiating your factory. 
-
-Required attributes will always be present, however, optional attributes are not guaranteed to be present when Chaos is enabled. 
+Required attributes will always be present, however, optional attributes are not guaranteed to be present when Chaos is enabled.
 
 *All attributes are optional by default.*
 
@@ -26,11 +22,11 @@ FM.factory :item, naming: :json do
 end
 ```
 
-You can state an attribute is optional using the `optional` option set to either be a `Boolean`, `Integer` or a `Float`. 
+You can state an attribute is optional using the `optional` option set to either be a `Boolean`, `Integer` or a `Float`.
 
 When optional is set to either an `Integer` or a `Float`, this overrides the weighting which Chaos uses to determine the likelihood that attribute will be removed.
 
-Higher the value, the more likely that attribute will be present. By default there's a 50/50 chance an optional attribute will be present. 
+Higher the value, the more likely that attribute will be present. By default there's a 50/50 chance an optional attribute will be present.
 
 To unleash Chaos over a factory, you need to enable it when instantiating your object:
 

data/{docs/usage/destroying_factories.md → usefakermaker.com/docs/usage/destroying-factories/index.md}

@@ -1,13 +1,11 @@
 ---
-layout: default
+layout: single
 title: Destroying Factories
-parent: Usage
-nav_order: 9
 ---
 
 ## A Cautionary Tale
 
-If you think you want to do this, you are probably wrong. This will not only de-register the factory from Faker Maker, but also delete the class definition from the interpreter. While it's cool that Ruby allows this, it's almost certainly going to hurt. 
+If you think you want to do this, you are probably wrong. This will not only de-register the factory from Faker Maker, but also delete the class definition from the interpreter. While it's cool that Ruby allows this, it's almost certainly going to hurt.
 
 This functionality exists for experimenting with factories in REPLs.
 
@@ -20,11 +18,11 @@ Faker Maker deliberately does not allow you to redefine a factory by redeclaring
 For example, this might give you unexpected behavior:
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
 end
 
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
 end
@@ -36,13 +34,13 @@ FM[:user].as_json
 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.
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
 end
 
 FakerMaker.shut!(:user)
 
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
 end
@@ -50,5 +48,5 @@ end
 FM[:user].as_json
  => {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk"}
  ```
- 
+
  It also provides the `shut_all!` method to remove all factories.

data/{docs/usage/embedding_factories.md → usefakermaker.com/docs/usage/embedding-factories/index.md}

@@ -1,12 +1,8 @@
 ---
-layout: default
+layout: single
 title: Embedding Factories
-parent: Usage
-nav_order: 8
 ---
 
-# Embedding Factories
-
 To use factories with factories, the following pattern is recommended:
 
 ```ruby
@@ -35,11 +31,11 @@ FakerMaker.factory :item do
 end
 
 FakerMaker.factory :basket do
-  items( has: 10, factory: [:item, :discount] )
+  items( has: 10, factory: [:item, :coupon] ) # either `item` or `coupon` will be randomly selected for each member
 end
 ```
 
-In this example, through 10 iterations, one of `item` and `discount` factories will be called to build their objects.
+In this example, through 10 iterations, a random choice 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:
 
@@ -53,11 +49,48 @@ FakerMaker.factory :basket do
   items( has: 10, factory: :item ) { |item| item.price = 10.99 ; item}
 end
 ```
+
+## Overriding values for nested factories in the enclosing factory
+
 **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).
 
+## Overriding values for nested factories during build
+
+If we look carefully at this factory
+
+```ruby
+FakerMaker.factory :inventory do
+  item( factory: :item )
+  quantity { 10 }
+end
+```
+
+This will build a object of the form (in its `as_json` guise):
+
+```ruby
+{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:
+
+```ruby
+FM[:inventory].build( attributes: { item: { name: 'floor cleaner' } } )
+```
+
+When you allow Faker Maker to make a choice of factory by giving it an array:
+
+```ruby
+FakerMaker.factory :inventory do
+  item( factory: [:item, :coupon] )
+  quantity { 10 }
+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.
+
 ## Alternative method
 
-There is an alternative style which might be of use:
+There is an alternative style which might be of use, **but** you have less control using build-time overrides for values (you can't set nested values). *This is no longer a recommended pattern*.
 
 ```ruby
 FakerMaker.factory :item do
@@ -70,4 +103,4 @@ FakerMaker.factory :basket do
 end
 ```
 
-With this pattern, 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](../managing-dependencies/) and `require` your referenced factory.

data/{docs/usage → usefakermaker.com/docs/usage/getting-started}/index.md

@@ -1,40 +1,37 @@
 ---
-layout: default
-title: Usage
-nav_order: 3
-has_children: true
+layout: single
+title: Getting started
 ---
 
-# Usage
-
 FakerMaker generates factories that build disposable objects for testing. Each factory has a name and a set of attributes.
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
   admin {false}
 end
 ```
 
-This will generate a `User` class with the attributes `name`, `email` and `admin` which will always return the same value.
+This will generate a `FakerMaker::Factory::User` class with the attributes `name`, `email` and `admin` which will always return the same value.
+Since v3.0.0 Classes generated by FakerMaker are in the `FakerMaker::Factory` namespace.
 
-It is possible to explicitly set the name of class which is particularly useful if there is a risk of redefining an existing one.
+It is possible to explicitly set the name of class which is particularly useful if there is a risk of redefining an existing one. Classes will **always** be created within the `FakerMaker::Factory` namespace (since v3.0.0)
 
 ```ruby
-FakerMaker.factory :user, class: 'EmailUser' do 
+FakerMaker.factory :user, class: 'EmailUser' do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
   admin {false}
 end
 ```
 
-The class name will always be turned into a Ruby-style class name so `email_user` would become `EmailUser`.
+The class name will always be turned into a Ruby-style class name so `email_user` would become `FakerMaker::Factory::EmailUser`.
 
 Because of the block syntax in Ruby, defining attributes as `Hash`es requires two sets of curly brackets:
 
 ```ruby
-FakerMaker.factory :response do 
+FakerMaker.factory :response do
   body { { title: 'First Post', content: 'This is part of a hash' } }
 end
 ```
@@ -42,7 +39,7 @@ end
 Blocks are executed in the context of their instance. This means you can refer to variables already defined:
 
 ```ruby
-FakerMaker.factory :user, class: 'EmailUser' do 
+FakerMaker.factory :user, class: 'EmailUser' do
   title {'Ms'}
   name {'Patsy Stone'}
   formal_name {"#{title} #{name}"}
@@ -54,10 +51,10 @@ end
 Fields with no block (or reference to another factory) will be nil.
 
 ```ruby
-FakerMaker.factory :request do 
+FakerMaker.factory :request do
   body
 end
 
 FakerMaker[:request].build.body
 # => nil
-```
+```

data/{docs/usage/audit_logs.md → usefakermaker.com/docs/usage/history-logging/index.md}

@@ -1,6 +1,6 @@
 ---
-layout: default
-title: Audit (History) Logs
+layout: single
+title: History logging
 parent: Usage
 nav_order: 10
 ---
@@ -33,7 +33,7 @@ Immediately after each object is built and after the post-build hooks have compl
 For example, given the factory:
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
   admin {false}
@@ -44,4 +44,4 @@ The audit log, on build, would look like:
 
 ```
 {"timestamp":"2023-05-15T15:46:30+01:00","factory":"user","class":"User","body":{"name":"Patsy Stone","email":"patsy@fabulous.co.uk","admin":false}}
-```
+```

data/{docs/usage/inheritance.md → usefakermaker.com/docs/usage/inheritance/index.md}

@@ -1,12 +1,8 @@
 ---
-layout: default
+layout: single
 title: Inheritance
-parent: Usage
-nav_order: 1
 ---
 
-# Inheritance
-
 FakerMaker can exploit the Ruby class hierarchy to provide additional specialisation or to override some behaviours:
 
 ```ruby
@@ -22,16 +18,18 @@ FakerMaker.factory :motorbike, parent: :vehicle do
 end
 ```
 
-This is the equivalent of: 
+This is the equivalent of:
+
+Since v3.0.0 Classes generated by FakerMaker are in the `FakerMaker::Factory` namespace.
 
 ```ruby
-class Vehicle < Object
+class FakerMaker::Factory::Vehicle < Object
   # ...
 end
 
-class Motorbike < Vehicle
+class FakerMaker::Factory::Motorbike < FakerMaker::Factory::Vehicle
   # ...
 end
 ```
 
-so a motorbike will still have a colour and engine capacity between 600 and 2500.
+so a motorbike will still have a colour and engine capacity between 600 and 2500.

data/{docs/usage/json_field_names.md → usefakermaker.com/docs/usage/json-field-names/index.md}

@@ -1,12 +1,8 @@
 ---
-layout: default
+layout: single
 title: JSON Field Names
-parent: Usage
-nav_order: 4
 ---
 
-# JSON Field Names
-
 JavaScript likes to use camelCase, Ruby's idiom is to use snake_case. This can make make manipulating factory-built objects in ruby ugly. To avoid this, you can call your fields one thing and ask the JSON outputter to rename the field when generating JSON.
 
 Faker Maker provides two mechanisms for dealing with this.
@@ -54,4 +50,4 @@ v.to_json
 
 ## Combining the two approaches
 
-If the factory has a `:naming` strategy defined and an attribute has its own `:json` name defined, the attribute's `:json` name will take precedence. 
+If the factory has a `:naming` strategy defined and an attribute has its own `:json` name defined, the attribute's `:json` name will take precedence.

data/{docs/usage/lifecycle_hooks.md → usefakermaker.com/docs/usage/lifecycle-hooks/index.md}

@@ -1,12 +1,8 @@
 ---
-layout: default
+layout: single
 title: Lifecycle Hooks
-parent: Usage
-nav_order: 8
 ---
 
-# Lifecycle Hooks
-
 Faker Maker has a few hooks which can be added to the factory which are triggered when the factory builds an instance.
 
 * `before_build` the instance has been created but none of the values have been set yet
@@ -15,7 +11,7 @@ Faker Maker has a few hooks which can be added to the factory which are triggere
 For instance:
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   before_build do |instance, factory|
     puts 'Building an instance of User'
   end
@@ -23,7 +19,7 @@ FakerMaker.factory :user do
   name {'Patsy Stone'}
   email {'patsy@fabulous.co.uk'}
   admin {false}
-  
+
   after_build do |instance, factory|
     puts "Built an instance of User (#{instance.name})"
   end

data/{docs/usage/dependencies.md → usefakermaker.com/docs/usage/managing-dependencies/index.md}

@@ -1,10 +1,6 @@
 ---
-layout: default
+layout: single
 title: Managing Dependencies
-parent: Usage
-nav_order: 3
 ---
 
-# Managing Dependencies
-
-Factory definition files are Plain Ol' Ruby. If you depend on another factory because you either extend from it or use it just add a `require` or (depending on your load path) `require_relative` to the top of your file. 
+Factory definition files are Plain Ol' Ruby. If you depend on another factory because you either extend from it or use it just add a `require` or (depending on your load path) `require_relative` to the top of your file.

data/{docs/usage/omitting_fields copy.md → usefakermaker.com/docs/usage/omitting-fields/index.md}

@@ -1,16 +1,12 @@
 ---
-layout: default
+layout: single
 title: Omitting Fields
-parent: Usage
-nav_order: 5
 ---
 
-# Omitting Fields
-
 Sometimes you want a field present, other times you don't. This is often the case when you want to skip fields which have null or empty values.
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email(omit: :nil) {'patsy@fabulous.co.uk'}
   admin {false}
@@ -34,9 +30,9 @@ There are three special modifiers:
 These can be mixed with real values, e.g.
 
 ```ruby
-FakerMaker.factory :user do 
+FakerMaker.factory :user do
   name {'Patsy Stone'}
   email(omit: [:nil, :empty, 'test@foobar.com']) {'patsy@fabulous.co.uk'}
   admin {false}
 end
-```
+```

data/usefakermaker.com/pages/about/index.md

@@ -0,0 +1,20 @@
+---
+title: "About"
+layout: single
+permalink: /pages/about/
+author_profile: true
+---
+
+Faker Maker was designed to be a trivial way to create data factories that could throw JSON payloads at an API endpoint. It has grown well beyond that original purpose but still remains a thing for building things that give you data.
+
+It is much beloved by me. Although it's a personal project, it's used extensively by my employer and influenced by the needs of my colleagues. I hope it will be useful to you as well. I am very open to ideas, feedback and contributions.
+
+Faker Maker is licenced under the [MIT licence](https://raw.githubusercontent.com/BillyRuffian/faker_maker/refs/heads/master/LICENSE.txt). Do with it what you will and have fun.
+
+### What's the Billy Ruffian thing?
+
+HMS Bellerophon was a 74-gun third-rate ship of the line of the Royal Navy. Launched in 1786, she served during the French Revolutionary and Napoleonic Wars, mostly on blockades or convoy escort duties. She fought in three fleet actions: the Glorious First of June, the Battle of the Nile and the Battle of Trafalgar. She became famous as the ship upon which Napoleon surrendered and which transported him into exile in 1815.
+
+Her sailors, not being educated in the Classics, struggled to pronounce her name and so she became known as the Billy Ruffian and her crew as the "Billy Ruffians". The name stuck and was used as a nickname for the ship for the rest of her career.
+
+Since no one in coffee shops can spell my name, I adopted 'Billy' which turned into 'Billy Ruffian'. It's also a bloody good story.

data/usefakermaker.com/pages/index.markdown

@@ -0,0 +1,27 @@
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+# layout: single
+layout: splash
+permalink: /
+author_profile: false
+
+feature_row:
+  - image_path: /assets/images/unipug.svg
+    alt: An illustration of cute pug dog pretending to be a unicorn by wearing a costume
+    title: Factories over fixtures
+    excerpt: FakerMaker is a simple factory builder so you can throw away your fixtures and generate test data instead.
+    url: "/docs/installing/"
+    btn_label: "Get Started"
+    btn_class: "btn btn--success"
+---
+
+{% include feature_row type="center" %}
+
+Sometimes you need generate data; something testers need to do a lot. Often, a bunch of fixtures will be built by hand, carefully maintained and curated, until the API or schema or something changes and all the fixtures need to be pruned before the tests pass again. This drives testers into building fixtures which individually cover lots of acceptance critera just so that they can drive down the number of them they have to maintain until the fixtures don’t resemble anything like realistic criteria.
+
+If you’re testing a Rails application, you can use the awesome FactoryBot to generate faked model instances but what if you’re not using Rails or you don’t have model classes or you’re testing an API? This is what Faker Maker aims to help with.
+
+It is designed to resemble the Factory Bot gem but without needing an existing class definition to back its object and so it goes without saying that it offers no persistence mechanism. Its purpose is to provide a simple framework for generating data to test JSON APIs and is intended to be used with the Faker gem (but has no dependency upon it).
+