faker_maker 3.0.0 → 4.0.0

data/usefakermaker.com.site/site/assets/styles.css

@@ -0,0 +1,351 @@
+:root {
+  --font-sans: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+  --font-mono: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+
+  --color-bg: #ffffff;
+  --color-text: #1a202c;
+  --color-primary: #3182ce;
+  --color-primary-hover: #2c5282;
+  --color-sidebar-bg: #f7fafc;
+  --color-border: #e2e8f0;
+  --color-code-bg: #edf2f7;
+
+  --spacing-unit: 1rem;
+  --sidebar-width: 280px;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --color-bg: #1a202c;
+    --color-text: #e2e8f0;
+    --color-primary: #63b3ed;
+    --color-primary-hover: #4299e1;
+    --color-sidebar-bg: #2d3748;
+    --color-border: #4a5568;
+    --color-code-bg: #2d3748;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  font-family: var(--font-sans);
+  color: var(--color-text);
+  background-color: var(--color-bg);
+  line-height: 1.6;
+}
+
+.layout {
+  display: flex;
+  min-height: 100vh;
+}
+
+.sidebar {
+  width: var(--sidebar-width);
+  background: var(--color-sidebar-bg);
+  border-right: 1px solid var(--color-border);
+  padding: 2rem;
+  overflow-y: auto;
+  position: sticky;
+  top: 0;
+  height: 100vh;
+  flex-shrink: 0;
+}
+
+.page-container {
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+  min-height: 100vh;
+}
+
+.main-content {
+  flex: 1;
+  padding: 2rem 4rem;
+  max-width: 1000px;
+  width: 100%;
+}
+
+.site-footer {
+  padding: 2rem 4rem;
+  border-top: 1px solid var(--color-border);
+  margin-top: 4rem;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  font-size: 0.9rem;
+  color: var(--color-text);
+  opacity: 0.7;
+}
+
+.site-footer p {
+  margin: 0;
+}
+
+.site-footer a {
+  color: inherit;
+  font-weight: 500;
+}
+
+/* Typography */
+h1 {
+  font-size: 2.5rem;
+  margin-bottom: 1rem;
+  line-height: 1.2;
+}
+
+h2 {
+  font-size: 1.75rem;
+  margin-top: 2.5rem;
+  margin-bottom: 1rem;
+  padding-bottom: 0.5rem;
+  border-bottom: 1px solid var(--color-border);
+}
+
+h3 {
+  font-size: 1.25rem;
+  margin-top: 2rem;
+}
+
+a {
+  color: var(--color-primary);
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+/* Navigation */
+.nav-section {
+  margin-bottom: 2rem;
+}
+
+.nav-title {
+  font-weight: bold;
+  text-transform: uppercase;
+  font-size: 0.85rem;
+  color: var(--color-text);
+  letter-spacing: 0.05em;
+  margin-bottom: 0.5rem;
+  opacity: 0.7;
+}
+
+.nav-links {
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+}
+
+.nav-link {
+  color: var(--color-text);
+  font-size: 0.95rem;
+  opacity: 0.8;
+  transition: opacity 0.2s;
+}
+
+.nav-link:hover {
+  opacity: 1;
+  color: var(--color-primary);
+  text-decoration: none;
+}
+
+.logo {
+  font-size: 1.5rem;
+  font-weight: bold;
+  display: block;
+  margin-bottom: 2rem;
+  color: var(--color-text);
+}
+
+/* Code Blocks */
+pre {
+  background: var(--color-code-bg);
+  padding: 1rem;
+  border-radius: 0.5rem;
+  overflow-x: auto;
+  font-family: var(--font-mono);
+  font-size: 0.9em;
+}
+
+code {
+  font-family: var(--font-mono);
+  background: var(--color-code-bg);
+  padding: 0.2em 0.4em;
+  border-radius: 0.25rem;
+  font-size: 0.85em;
+}
+
+pre code {
+  background: transparent;
+  padding: 0;
+}
+
+/* Components */
+.btn {
+  display: inline-block;
+  background: var(--color-primary);
+  color: white;
+  padding: 0.75rem 1.5rem;
+  border-radius: 0.375rem;
+  font-weight: 600;
+  transition: background-color 0.2s;
+  text-decoration: none !important;
+}
+
+.btn:hover {
+  background: var(--color-primary-hover);
+  color: white;
+}
+
+.hero {
+  text-align: center;
+  padding: 4rem 2rem;
+  background: var(--color-sidebar-bg);
+  border-radius: 1rem;
+  margin-bottom: 2rem;
+}
+
+.hero h2 {
+  border-bottom: none;
+  font-size: 2rem;
+  margin-top: 0;
+}
+
+/* Mobile Navigation */
+.menu-toggle {
+  display: none;
+  position: fixed;
+  bottom: 1.5rem;
+  right: 1.5rem;
+  width: 3.5rem;
+  height: 3.5rem;
+  border-radius: 50%;
+  background: var(--color-primary);
+  border: none;
+  box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
+  cursor: pointer;
+  z-index: 100;
+  padding: 0;
+  align-items: center;
+  justify-content: center;
+}
+
+.hamburger {
+  width: 24px;
+  height: 2px;
+  background: white;
+  position: relative;
+  transition: all 0.3s;
+}
+
+.hamburger::before,
+.hamburger::after {
+  content: '';
+  position: absolute;
+  width: 24px;
+  height: 2px;
+  background: white;
+  left: 0;
+  transition: all 0.3s;
+}
+
+.hamburger::before {
+  top: -8px;
+}
+
+.hamburger::after {
+  top: 8px;
+}
+
+.sidebar-open .hamburger {
+  background: transparent;
+}
+
+.sidebar-open .hamburger::before {
+  top: 0;
+  transform: rotate(45deg);
+}
+
+.sidebar-open .hamburger::after {
+  top: 0;
+  transform: rotate(-45deg);
+}
+
+.sidebar-overlay {
+  position: fixed;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background: rgba(0, 0, 0, 0.5);
+  z-index: 40;
+  display: none;
+  opacity: 0;
+  transition: opacity 0.3s;
+}
+
+.sidebar-open .sidebar-overlay {
+  display: block;
+  opacity: 1;
+}
+
+/* Responsive */
+@media (max-width: 768px) {
+  .menu-toggle {
+    display: flex;
+  }
+
+  .layout {
+    display: block;
+  }
+
+  .sidebar {
+    position: fixed;
+    top: 0;
+    left: 0;
+    bottom: 0;
+    width: 280px;
+    z-index: 50;
+    transform: translateX(-100%);
+    transition: transform 0.3s cubic-bezier(0.4, 0, 0.2, 1);
+    box-shadow: 0 0 20px rgba(0, 0, 0, 0.2);
+  }
+
+  .sidebar-open .sidebar {
+    transform: translateX(0);
+  }
+
+  .sidebar-open {
+    overflow: hidden;
+  }
+
+  /* Update main-content selector usage if needed or ensure page-container behaves on mobile */
+  .page-container {
+    width: 100%;
+  }
+
+  .main-content {
+    padding: 1.5rem;
+    width: 100%;
+  }
+
+  .site-footer {
+    padding: 1.5rem;
+    flex-direction: column;
+    gap: 1rem;
+    text-align: center;
+  }
+
+  /* Adjust typography for mobile */
+  h1 {
+    font-size: 2rem;
+  }
+
+  .logo {
+    margin-bottom: 2rem;
+  }
+}

data/{usefakermaker.com/docs/contributing/index.md → usefakermaker.com.site/site/src/docs/contributing/index.page.md}

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

data/{usefakermaker.com/docs/installing/index.md → usefakermaker.com.site/site/src/docs/installing/index.page.md}

@@ -1,8 +1,4 @@
----
-layout: single
-title: Installing Faker Maker
-nav_order: 2
----
+# Installing Faker Maker
 
 Add this line to your application's Gemfile:
 

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Arrays
----
+# Arrays
 
 It is possible to declare an attribute as having multiple values.
 

data/{usefakermaker.com/docs/usage/building-instances/index.md → usefakermaker.com.site/site/src/docs/usage/building-instances/index.page.md}

@@ -1,7 +1,4 @@
----
-layout: single
-title: Building Instances
----
+# 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.
 
@@ -13,10 +10,10 @@ result = FakerMaker[:basket].build
 
 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:
@@ -36,7 +33,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
 ```
@@ -58,3 +55,5 @@ 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/{usefakermaker.com/docs/usage/chaos/index.md → usefakermaker.com.site/site/src/docs/usage/chaos/index.page.md}

@@ -1,7 +1,4 @@
----
-layout: single
-title: Chaos
----
+# Chaos
 
 Chaos mode introduces extra spice to your generated factories.
 

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Destroying Factories
----
+# Destroying Factories
 
 ## A Cautionary Tale
 

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Embedding Factories
----
+# Embedding Factories
 
 To use factories with factories, the following pattern is recommended:
 
@@ -31,11 +28,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:
 
@@ -49,11 +46,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

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Getting started
----
+# Getting started
 
 FakerMaker generates factories that build disposable objects for testing. Each factory has a name and a set of attributes.
 

data/{usefakermaker.com/docs/usage/history-logging/index.md → usefakermaker.com.site/site/src/docs/usage/history-logging/index.page.md}

@@ -1,9 +1,4 @@
----
-layout: single
-title: History logging
-parent: Usage
-nav_order: 10
----
+# History logging
 
 _(since 1.3.0)_
 

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Inheritance
----
+# Inheritance
 
 FakerMaker can exploit the Ruby class hierarchy to provide additional specialisation or to override some behaviours:
 

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: JSON Field Names
----
+# 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.
 

data/{usefakermaker.com/docs/usage/lifecycle-hooks/index.md → usefakermaker.com.site/site/src/docs/usage/lifecycle-hooks/index.page.md}

@@ -1,7 +1,4 @@
----
-layout: single
-title: Lifecycle Hooks
----
+# Lifecycle Hooks
 
 Faker Maker has a few hooks which can be added to the factory which are triggered when the factory builds an instance.
 

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

@@ -1,6 +1,3 @@
----
-layout: single
-title: Managing Dependencies
----
+# 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.

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

@@ -1,7 +1,4 @@
----
-layout: single
-title: Omitting Fields
----
+# 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.
 

data/{usefakermaker.com/pages/index.markdown → usefakermaker.com.site/site/src/index.page.md}

@@ -1,23 +1,13 @@
----
-# 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
+# FakerMaker
 
-# 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" %}
+<div class="hero">
+  <img src="/images/unipug.svg" alt="An illustration of cute pug dog pretending to be a unicorn by wearing a costume" style="max-width: 200px; display: block; margin: 0 auto 2rem;">
+  <h2>Factories over fixtures</h2>
+  <p>FakerMaker is a simple factory builder so you can throw away your fixtures and generate test data instead.</p>
+  <p style="text-align: center;">
+    <a href="/docs/installing" class="btn">Get Started</a>
+  </p>
+</div>
 
 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.
 

data/usefakermaker.com.site/site/templates/_nav.html.erb

@@ -0,0 +1,27 @@
+<nav>
+  <div class="nav-section">
+    <div class="nav-title">Getting Started</div>
+    <div class="nav-links">
+      <a href="/docs/installing" class="nav-link">Installing</a>
+      <a href="/docs/contributing" class="nav-link">Contributing</a>
+    </div>
+  </div>
+
+  <div class="nav-section">
+    <div class="nav-title">Usage</div>
+    <div class="nav-links">
+      <a href="/docs/usage/getting-started" class="nav-link">Getting started</a>
+      <a href="/docs/usage/building-instances" class="nav-link">Building instances</a>
+      <a href="/docs/usage/arrays" class="nav-link">Arrays</a>
+      <a href="/docs/usage/omitting-fields" class="nav-link">Omitting fields</a>
+      <a href="/docs/usage/json-field-names" class="nav-link">JSON field names</a>
+      <a href="/docs/usage/inheritance" class="nav-link">Inheritance</a>
+      <a href="/docs/usage/embedding-factories" class="nav-link">Embedding factories</a>
+      <a href="/docs/usage/chaos" class="nav-link">Chaos</a>
+      <a href="/docs/usage/lifecycle-hooks" class="nav-link">Lifecycle hooks</a>
+      <a href="/docs/usage/destroying-factories" class="nav-link">Destroying factories</a>
+      <a href="/docs/usage/managing-dependencies" class="nav-link">Managing dependencies</a>
+      <a href="/docs/usage/history-logging" class="nav-link">History logging</a>
+    </div>
+  </div>
+</nav>

data/usefakermaker.com.site/site/templates/layout.html.erb

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= title %> - FakerMaker</title>
+  <link rel="stylesheet" href="/styles.css">
+  <link rel="apple-touch-icon" sizes="180x180" href="/favicons/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="/favicons/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="/favicons/favicon-16x16.png">
+  <link rel="manifest" href="/favicons/site.webmanifest">
+  <link rel="shortcut icon" href="/favicons/favicon.ico">
+</head>
+<body>
+  <div class="layout">
+    <button class="menu-toggle" aria-label="Toggle navigation">
+      <span class="hamburger"></span>
+    </button>
+    <aside class="sidebar">
+      <a href="/" class="logo">FakerMaker</a>
+      <%= render 'nav' %>
+    </aside>
+    <div class="page-container">
+      <main class="main-content">
+        <%= content %>
+      </main>
+      <footer class="site-footer">
+        <p>&copy; 2026 FakerMaker</p>
+        <p>
+          <a href="https://github.com/BillyRuffian/faker_maker">GitHub</a> &bull;
+          <a href="https://usejackdaw.com">Documentation by Jackdaw</a>
+        </p>
+      </footer>
+    </div>
+    <div class="sidebar-overlay"></div>
+  </div>
+  <script>
+    document.querySelector('.menu-toggle').addEventListener('click', function() {
+      document.body.classList.toggle('sidebar-open');
+    });
+    document.querySelector('.sidebar-overlay').addEventListener('click', function() {
+      document.body.classList.remove('sidebar-open');
+    });
+  </script>
+</body>
+</html>

data/usefakermaker.com.site/site/templates/page.html.erb

@@ -0,0 +1,3 @@
+<main>
+  <%= content %>
+</main>