RubyGems - faker_maker - Versions diffs - 4.0.0.beta1 → 4.0.0 - Mend

faker_maker 4.0.0.beta1 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2010123a071b807d1400f16c16cbaf58b4db86507224c72f50847affcfbc1bd4
-  data.tar.gz: 8e72393016c7a54106bc1aca8ecccf46d35c94ee1b9fb4b95c6b49ba5bbd2dfc
+  metadata.gz: 4f341f27ec954b732dde7141c9ad532346c09dadbbed4ea469894b10cac652f8
+  data.tar.gz: 61919d74b140d82fba2750bcf0e1c25473ebe21e02a2b213bd1109d94f22d9e2
 SHA512:
-  metadata.gz: f8f73cb6e888ef7f49abd66959c64916df617f0254a98b0ca022c19dbc45aef6e259d92d9186d57128f9180c094c46af4776fb3c087ec3fce94eff1cead58eb0
-  data.tar.gz: b7baa192ddf36b18f6a696d4cec08b8372e57fd95a44d0397a8a6f94f298938e449553aec1d6b03c32a63544589c421afb46c080f67a699eaace38d5d9f15eaf
+  metadata.gz: de3ae09ed6b848612d3fc23533d04f4633eaa4be42f7f7be9fc3f3938f8b86afa2a495f6928a66f38207d63233e2b37ce88897178688a4f3aa2c6c5f524b51e4
+  data.tar.gz: cdc3c4509819316bc389d2bf1857883ddfa62b14b93a8f794a043af70bd603dec46f7e0a0c37d29d8814ff447ac2762cd3d56a92fc917338bc3458b4113263c9

data/.github/workflows/ruby.yml CHANGED Viewed

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
+        ruby-version: ["3.4", "4.0"]
     steps:
       - uses: actions/checkout@v3

data/.rubocop.yml CHANGED Viewed

@@ -52,5 +52,5 @@ Metrics/PerceivedComplexity:
   Max: 10
 AllCops:
-  TargetRubyVersion: 3.4
+  TargetRubyVersion: 4.0
   NewCops: enable

data/Gemfile CHANGED Viewed

@@ -11,4 +11,4 @@ gem 'bundler-audit', '~> 0.9.2'
 gem 'irb', '~> 1.15'
 gem 'rdoc', '~> 6.13'
-gem "awesome_print", "~> 1.9"
+gem 'awesome_print', '~> 1.9'

data/MIGRATION_NOTES.md ADDED Viewed

@@ -0,0 +1,47 @@
+# Jekyll to Jackdaw Migration Notes
+## 1. Project Initialization
+* Run `jackdaw new <project_name>` to generate the standard directory structure:
+  * `site/src`: Content
+  * `site/templates`: ERB Templates
+  * `site/assets`: Static files (images, css, favicons)
+## 2. Template Conversion
+* **Layouts**: Consolidate Jekyll layouts (default, page, etc.) into `site/templates/layout.html.erb`.
+  * Replace `{{ content }}` with `<%= content %>`.
+  * Replace `{{ page.title }}` with `<%= title %>`.
+* **Partials**: Convert `{% include file.html %}` to `<%= render 'file' %>`.
+  * Rename partial files to start with an underscore (e.g., `_nav.html.erb`).
+* **Assets**:
+  * Move CSS/JS/Images to `site/assets/`.
+  * **Important**: When referencing in HTML, omit `assets/`.
+    * `site/assets/styles.css` -> `<link href="/styles.css">`
+    * `site/assets/img/logo.png` -> `<img src="/img/logo.png">`
+## 3. Content Migration Strategies
+* **File Extensions**:
+  * Regular pages: `.md` -> `.page.md`
+  * Blog posts: `.md` -> `.blog.md` (Filename must start with `YYYY-MM-DD-`)
+* **Frontmatter Handling**:
+  * Jackdaw renders the *first H1* as the page title.
+  * **Task**: Strip YAML frontmatter (`--- ... ---`) and ensure the file starts with `# Page Title`.
+* **Directory Structure**:
+  * Keep the same folder structure in `site/src` to maintain URLs.
+  * **Conflict Warning**: Do not create `topic.page.md` if you also have a folder named `topic/`. Instead, create `topic/index.page.md`.
+## 4. Automation (Ruby Script)
+For bulk migration of documentation, use a script to:
+1. Iterate through source directories.
+2. Read file content.
+3. specific YAML frontmatter values (Title).
+4. Rewrite file to destination with new header and `.page.md` extension.
+## 5. Navigation & Indices
+* Jackdaw does not automatically build navigation menus from folder structure.
+* **Manual**: Edit `site/templates/_nav.html.erb`.
+* **Auto-generated Indices**: Write scripts to generate index markdown files (e.g., "List of all Rules") if the content changes frequently.
+## 6. Styling
+* Jackdaw provides no default styling.
+* Create a robust `styles.css` using CSS Variables for theming.
+* Link fonts and stylesheets in the `<head>` of `layout.html.erb`.

data/TODO.md ADDED Viewed

@@ -0,0 +1,16 @@
+-- DONE - sorta
+2. get attributes including embedded attr -- THIS WORKS IF USING THE FACTORY PARAMETER, NOT PROC EMBEDDED FACTORIES -- NEED A CHANGE TO OSL FACTORIES
+3. What the hell is going on with @embedded factories -- why is this always nil  CHECK -- FOR THE LOVE OF GOD, WRITE DOCUMENTATION FOR THIS
+4. Factory#attribute_names line ~ 110
+-- TODO
+1. nested builds using the build method -- this is hidden at the moment, it sets the value of the key to a hash rather than recursively calling the field#field method
+5. FM[:foo].build( attributes: { does_not_exist: 1 }, raise_on_error: false ) # RAISE_ON_ERROR
+5. FM[:foo].build( attributes: { does_not_exist: 1 }, strict: false ) # RAISE_ON_ERROR
+5. FM[:foo].build( attributes: { does_not_exist: 1 }, very_strict: false ) # RAISE_ON_ERROR
+building embedded factories need to know the build options passed in to the top level build call -- e.g. is chaos on or not
+check naming strategies still work

data/faker_maker.gemspec CHANGED Viewed

@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.2', '< 9'
-  spec.add_development_dependency 'bundler',       '~> 2'
+  spec.add_development_dependency 'bundler',       '>= 2'
   spec.add_development_dependency 'faker',         '~> 3.2'
   spec.add_development_dependency 'guard',         '~> 2.16'
   spec.add_development_dependency 'guard-bundler', '~> 3.0'

data/hack/nested.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'faker_maker'
+require 'awesome_print'
+FM.factory :random do
+  flavour { 'blue' }
+end
+FM.factory :item do
+  name { 'toothpaste' }
+  price { 0.99 }
+end
+FM.factory :coupon do
+  discount { 0.10 }
+end
+FM.factory :basket do
+  items( factory: %i[item random] )
+end
+# { a: 1, b: { x: 2 } }

data/lib/faker_maker/base.rb CHANGED Viewed

@@ -3,12 +3,12 @@
 module FakerMaker
   # Base module for defining the DSL
   module Base
-    def factory(name, options = {}, &block)
+    def factory(name, options = {}, &)
       factory = FakerMaker.find_factory(name)
       if factory.nil?
         factory = FakerMaker::Factory.new name, options
         proxy = DefinitionProxy.new factory
-        proxy.instance_eval( &block ) if block_given?
+        proxy.instance_eval( & ) if block_given?
         FakerMaker.register_factory factory
       else
         factory

data/lib/faker_maker/definition_proxy.rb CHANGED Viewed

@@ -13,8 +13,8 @@ module FakerMaker
       @factory
     end
-    def method_missing(name, *args, &block)
-      attribute = FakerMaker::Attribute.new name, block, *args
+    def method_missing(name, *, &block)
+      attribute = FakerMaker::Attribute.new(name, block, *)
       @factory.attach_attribute attribute
     end

data/lib/faker_maker/factory.rb CHANGED Viewed

@@ -155,9 +155,10 @@ module FakerMaker
     # @param include_embeddings [Boolean] whether to include attributes from embedded factories (default: true)
     # @return [Array] the collection of attributes, possibly including embedded factory attributes as hashes
     #
-    # If the factory has a parent, its attributes are merged in. Attributes without embedded factories are added directly.
-    # If `include_embeddings` is true, attributes with embedded factories are added as hashes mapping the attribute to the
-    # flattened attributes of its embedded factories. If false, only the attribute itself is added.
+    # If the factory has a parent, its attributes are merged in. Attributes without embedded factories are added
+    # directly. If `include_embeddings` is true, attributes with embedded factories are added as hashes mapping
+    # the attribute to the flattened attributes of its embedded factories. If false, only the attribute itself
+    # is added.
     def attributes( collection = [], include_embeddings: true )
       collection |= FakerMaker[parent].attributes( collection ) if parent?
       collection |= @attributes.reject { |attr| attr.embedded_factories.any? }
@@ -196,7 +197,8 @@ module FakerMaker
     #
     # @param instance [Object] The object instance to populate with attribute values.
     # @param attr_override_values [Hash] A hash of attribute names and their override values.
-    # @param chaos [Boolean, Integer, nil] If truthy, enables chaos mode which may randomize or select a subset of attributes.
+    # @param chaos [Boolean, Integer, nil] If truthy, enables chaos mode which may randomize or select a subset
+    # of attributes.
     # @return [void]
     #
     # If the factory has a parent, its attributes are populated first.

data/lib/faker_maker/version.rb CHANGED Viewed

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

data/usefakermaker.com.site/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ public/
2	+ .DS_Store

data/usefakermaker.com.site/site/assets/favicons/android-chrome-192x192.png ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/android-chrome-512x512.png ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/apple-touch-icon.png ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/favicon-16x16.png ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/favicon-32x32.png ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/favicon.ico ADDED Viewed

Binary file

data/usefakermaker.com.site/site/assets/favicons/site.webmanifest ADDED Viewed

@@ -0,0 +1,19 @@
+{
+    "name": "FakerMaker",
+    "short_name": "FakerMaker",
+    "icons": [
+       {
+          "src": "/favicons/android-chrome-192x192.png",
+          "sizes": "192x192",
+          "type": "image/png"
+       },
+       {
+        "src": "/favicons/android-chrome-512x512.png",
+        "sizes": "512x512",
+        "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+ }

data/usefakermaker.com.site/site/assets/robots.txt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ User-agent: *
2	+ Allow: /

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

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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.

data/{usefakermaker.com/docs/usage/chaos/index.md → usefakermaker.com.site/site/src/docs/usage/chaos/index.page.md} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -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} RENAMED Viewed

@@ -1,7 +1,4 @@
----
-layout: single
-title: Embedding Factories
----
+# Embedding Factories
 To use factories with factories, the following pattern is recommended:

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

@@ -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} RENAMED Viewed

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