faker_maker 2.1.2 → 4.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cafb9329751d21f03c03e561d32ee4068f7d317fe60f6f4e8fcbb87127bcfc5
-  data.tar.gz: cfa5efbccddba655924eff8524d55fdffde0373540abab939c3d717c53c50a2b
+  metadata.gz: 2010123a071b807d1400f16c16cbaf58b4db86507224c72f50847affcfbc1bd4
+  data.tar.gz: 8e72393016c7a54106bc1aca8ecccf46d35c94ee1b9fb4b95c6b49ba5bbd2dfc
 SHA512:
-  metadata.gz: e825d7a2d193223af68692346257013785da1a0ec2a4902456fb583d0706ea1f9eb57f7cc069bd3c6115378a0cc7942b0c3302ecbfd75dd96ed7aad0cba055c5
-  data.tar.gz: 4cb85817f9baa181d594ae3bdbf25c87ff063f6c0d258519169801dd7143152151cafcd0a1475cc012c8fb9fb35e69ef094f24bfa8d3f7d5a258232cd0e2d005
+  metadata.gz: f8f73cb6e888ef7f49abd66959c64916df617f0254a98b0ca022c19dbc45aef6e259d92d9186d57128f9180c094c46af4776fb3c087ec3fce94eff1cead58eb0
+  data.tar.gz: b7baa192ddf36b18f6a696d4cec08b8372e57fd95a44d0397a8a6f94f298938e449553aec1d6b03c32a63544589c421afb46c080f67a699eaace38d5d9f15eaf

data/.github/workflows/ruby.yml

@@ -10,28 +10,27 @@ name: Ruby
 on:
   push:
   pull_request:
-    branches: [ "master" ]
+    branches: ["master"]
 
 permissions:
   contents: read
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.0", "3.1", "3.2"]
+        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@v1 # v1.146.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -8,6 +8,10 @@
 /tmp/
 
 Gemfile.lock
+
+/hack/
+TODO.md
+
 # rspec failure tracking
 .rspec_status
 

data/.rubocop.yml

@@ -1,7 +1,7 @@
 Layout/SpaceInsideParens:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/ModuleLength:
@@ -32,7 +32,7 @@ Style/HashEachMethods:
 
 Style/HashTransformKeys:
   Enabled: true
- 
+
 Style/HashTransformValues:
   Enabled: true
 
@@ -52,4 +52,5 @@ Metrics/PerceivedComplexity:
   Max: 10
 
 AllCops:
-  NewCops: enable
+  TargetRubyVersion: 3.4
+  NewCops: enable

data/Gemfile

@@ -6,3 +6,9 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in faker_maker.gemspec
 gemspec
+
+gem 'bundler-audit', '~> 0.9.2'
+gem 'irb', '~> 1.15'
+gem 'rdoc', '~> 6.13'
+
+gem "awesome_print", "~> 1.9"

data/README.md

@@ -21,4 +21,10 @@
 
 FakerMaker is a simple factory builder so you can throw away your fixtures and generate test data instead.
 
-Read the [documentation here](https://billyruffian.github.io/faker_maker/).
+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).
+
+Read the [documentation here](https://usefakermaker.com).

data/lib/faker_maker/attribute.rb

@@ -3,7 +3,7 @@
 module FakerMaker
   # Attributes describe the fields of classes
   class Attribute
-    attr_reader :name, :block, :translation, :required, :optional, :optional_weighting, :embedded_factories
+    attr_reader :name, :block, :translation, :required, :optional, :optional_weighting
 
     DEFAULT_OPTIONAL_WEIGHTING = 0.5
 
@@ -25,6 +25,15 @@ module FakerMaker
       end
     end
 
+    # Return an array of factory instances
+    def embedded_factories
+      @embedded_factories.map { |name| FakerMaker[name] }
+    end
+
+    def embedded_factories?
+      @embedded_factories.any?
+    end
+
     def array?
       forced_array? || @array
     end

data/lib/faker_maker/factory.rb

@@ -5,8 +5,26 @@ module FakerMaker
   # Factories construct instances of a fake
   class Factory
     include Auditable
+
     attr_reader :name, :class_name, :parent, :chaos_selected_attributes
 
+    # Create a new +Factory+ object.
+    #
+    # This method does not automatically register the factory,see
+    # FakerMaker#register_factory
+    #
+    # Options:
+    # - +:class_name+ - override the default class name that FakerMaker will generate.
+    #   This is useful in the case of collisions with existing classes or keywords.
+    # - +:parent+ - the parent factory from which this factory inherits attributes.
+    #   Instances built by this factory will have a class which inherits from the parent's
+    #   class.
+    # - +:naming+ - one of:
+    #   - +nil+ (default) - use field names as the method name and in JSON conversion
+    #   - +:json+ - use field names as the method name but convert when rendering JSON, e.g.
+    #     +hello_world+ becomes +helloWorld+
+    #   - +:json_capitalised+ (or +:json_capitalized+) - as +:json+ but with the first letter
+    #     captialised, e.g. +hello_world+ becomes +HelloWorld+
     def initialize( name, options = {} )
       assert_valid_options options
       @name = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.underscore.to_sym
@@ -26,14 +44,16 @@ module FakerMaker
       @parent = options[:parent]
     end
 
+    # Get the Class of the parent for this factory
     def parent_class
       if @parent
-        Object.const_get( FakerMaker[@parent].class_name )
+        FakerMaker::Factory.const_get( FakerMaker[@parent].class_name )
       else
         Object
       end
     end
 
+    # Attach a FakerMaker::Attribute to this Factory
     def attach_attribute( attribute )
       @attributes << attribute
     end
@@ -42,14 +62,11 @@ module FakerMaker
       @instance ||= instantiate
     end
 
-    def build( attributes: {}, chaos: false, **kwargs )
-      if kwargs.present?
-        validate_deprecated_build(kwargs)
-        attributes = kwargs
-      end
-
+    def build( attributes: {}, chaos: false )
       @instance = nil
       before_build if respond_to? :before_build
+
+      # TODO: make this cleverer to handle nested attributes
       assert_only_known_attributes_for_override( attributes )
 
       assert_chaos_options chaos if chaos
@@ -57,17 +74,23 @@ module FakerMaker
       optional_attributes
       required_attributes
 
-      populate_instance instance, attributes, chaos
+      populate_instance(instance, attributes, chaos:)
       yield instance if block_given?
+
       after_build if respond_to? :after_build
       audit(@instance) if FakerMaker.configuration.audit?
       instance
     end
 
+    # Construct a Class object which will become the parent type of objects built
+    # by this factory.
+    #
+    # The Class object will be created and the attributes added to it. The returned value
+    # is a Ruby Class which can be instantiated.
     def assemble
       if @klass.nil?
         @klass = Class.new parent_class
-        Object.const_set @class_name, @klass
+        FakerMaker::Factory.const_set @class_name, @klass
         attach_attributes_to_class
         attach_json_overrides_to_class
       end
@@ -91,7 +114,7 @@ module FakerMaker
       unless @json_key_map
         @json_key_map = {}.with_indifferent_access
         @json_key_map.merge!( FakerMaker[parent].json_key_map ) if parent?
-        attributes.each_with_object( @json_key_map ) do |attr, map|
+        attributes(include_embeddings: false).each_with_object( @json_key_map ) do |attr, map|
           key = if attr.translation?
                   attr.translation
                 elsif @naming_strategy
@@ -106,29 +129,86 @@ module FakerMaker
       @json_key_map
     end
 
-    def attribute_names( collection = [] )
-      collection |= FakerMaker[parent].attribute_names( collection ) if parent?
-      collection | @attributes.map( &:name )
+    # Returns a transformed list of attribute names from the `attributes` array.
+    # For each item in the array:
+    # - If the item is a Hash, recursively transforms its keys and values,
+    #   replacing keys with their `name` and applying the same transformation to values.
+    # - Otherwise, replaces the item with its `name`.
+    #
+    # @return [Array] An array (possibly nested) of attribute names, with hashes' keys replaced by their `name`.
+    def attribute_names
+      transform = lambda do |arr|
+        arr.map do |item|
+          if item.is_a?(Hash)
+            item.transform_keys(&:name).transform_values { |v| transform.call(v) }
+          else
+            item.name
+          end
+        end
+      end
+      transform.call(attributes)
     end
 
-    def attributes( collection = [] )
+    # Returns a collection of attributes for the factory, optionally including embedded factory attributes.
+    #
+    # @param collection [Array] an optional array of attributes to start with (default: empty array)
+    # @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.
+    def attributes( collection = [], include_embeddings: true )
       collection |= FakerMaker[parent].attributes( collection ) if parent?
-      collection | @attributes
+      collection |= @attributes.reject { |attr| attr.embedded_factories.any? }
+
+      # if there is an embedded factory(-ies) and we are including the embedded factory's
+      # fields, we are going to return a hash
+      if include_embeddings
+        @attributes.select { |attr| attr.embedded_factories.any? }.each do |attr|
+          collection << { attr => attr.embedded_factories.flat_map(&:attributes) }
+        end
+      # if there is an embedded factory(-ies) and we are not including the embedded factory's
+      # fields, just add the attribute into the set of returned fields
+      else
+        collection |= @attributes.select { |attr| attr.embedded_factories.any? }
+      end
+
+      collection
     end
 
+    # Finds and returns the first attribute matching the given name.
+    #
+    # This method searches through the attributes (excluding embeddings) and returns the first attribute
+    # whose name, translation, or the result of applying the naming strategy to its name matches the provided `name`.
+    #
+    # @param name [String] The name to search for among the attributes. Defaults to an empty string.
+    # @return [Object, nil] The first matching attribute object, or nil if no match is found.
     def find_attribute( name = '' )
-      attributes.filter { |a| [a.name, a.translation, @naming_strategy&.name(a.name)].include? name }.first
+      attributes(include_embeddings: false).filter do |a|
+        [a.name, a.translation, @naming_strategy&.name(a.name)].include? name
+      end.first
     end
 
     protected
 
-    def populate_instance( instance, attr_override_values, chaos )
-      FakerMaker[parent].populate_instance instance, attr_override_values, chaos if parent?
+    # Populates the given instance with attribute values, optionally applying chaos/randomization.
+    #
+    # @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.
+    # @return [void]
+    #
+    # If the factory has a parent, its attributes are populated first.
+    # Each attribute is assigned a value, either from the override values or generated.
+    # The factory instance is set on the populated object for reference.
+    def populate_instance( instance, attr_override_values, chaos: false )
+      FakerMaker[parent].populate_instance(instance, attr_override_values, chaos:) if parent?
 
       attributes = chaos ? chaos_select(chaos) : @attributes
 
       attributes.each do |attribute|
-        value = value_for_attribute( instance, attribute, attr_override_values )
+        value = value_for_attribute( instance, attribute, attr_override_values, chaos: )
         instance.send "#{attribute.name}=", value
       end
       instance.instance_variable_set( :@fm_factory, self )
@@ -137,7 +217,10 @@ module FakerMaker
     private
 
     def assert_only_known_attributes_for_override( attr_override_values )
-      unknown_attrs = attr_override_values.keys - attribute_names
+      unknown_attrs = attr_override_values.keys - attribute_names.flat_map do |item|
+        item.is_a?(Hash) ? item.keys : item
+      end
+
       issue = "Can't build an instance of '#{class_name}' " \
               "setting '#{unknown_attrs.join( ', ' )}', no such attribute(s)"
       raise FakerMaker::NoSuchAttributeError, issue unless unknown_attrs.empty?
@@ -156,34 +239,44 @@ module FakerMaker
       raise FakerMaker::ChaosConflictingAttributeError, issue unless conflicting_attributes.empty?
     end
 
-    def attribute_hash_overridden_value?( attr, attr_override_values )
+    def overridden_value?( attr, attr_override_values )
       attr_override_values.keys.include?( attr.name )
     end
 
-    def value_for_attribute( instance, attr, attr_override_values )
-      if attribute_hash_overridden_value?( attr, attr_override_values )
+    def value_for_attribute( instance, attr, attr_override_values, chaos: false )
+      if !attr.embedded_factories? && overridden_value?( attr, attr_override_values )
         attr_override_values[attr.name]
       elsif attr.array?
         [].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
+            manufacture = manufacture_from_embedded_factory( attr, attr_override_values[attr.name.to_sym], chaos: )
+            # if manufacture has been built 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
-        manufacture = manufacture_from_embedded_factory( attr )
+        manufacture = manufacture_from_embedded_factory( attr, attr_override_values[attr.name.to_sym], chaos: )
         attr.block ? instance.instance_exec(manufacture, &attr.block) : manufacture
       end
     end
 
-    def manufacture_from_embedded_factory( attr )
+    def manufacture_from_embedded_factory( attr, attributes = {}, chaos: false )
+      attributes ||= {}
       # The name of the embedded factory randomly selected from the list of embedded factories.
-      embedded_factory_name = attr.embedded_factories.sample
+      embedded_factory = attr.embedded_factories.sample
+
+      # filter out attributes for non-chosen embedded factories to avoid triggering
+      # the NoSuchAttribute exception
+      attributes = attr
+                   .embedded_factories
+                   .reject { |e| e == embedded_factory }
+                   .flat_map { |f| pp f.attributes.map(&:name) }
+                   .then { |excl| attributes.delete_if { |k, _v| excl.include?(k) } }
+
       # 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
+      embedded_factory&.build(attributes:, chaos:)
     end
 
     def instantiate
@@ -264,13 +357,6 @@ module FakerMaker
                                 .concat(selected_attrs).uniq!
       @chaos_selected_attributes
     end
-
-    def validate_deprecated_build(kwargs)
-      usage = kwargs.each_with_object([]) { |kwarg, result| result << "#{kwarg.first}: #{kwarg.last}" }.join(', ')
-
-      warn "[DEPRECATION] `FM[:#{name}].build(#{usage})` is deprecated. " \
-           "Please use `FM[:#{name}].build(attributes: { #{usage} })` instead."
-    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/faker_maker/version.rb

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

data/lib/faker_maker.rb

@@ -63,7 +63,7 @@ module FakerMaker
     return unless factory
 
     factories[name] = nil
-    Object.send( :remove_const, factory.class_name )
+    FakerMaker::Factory.send( :remove_const, factory.class_name )
   end
 
   def shut_all!

data/usefakermaker.com/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/usefakermaker.com/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/usefakermaker.com/Gemfile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem 'jekyll', '~> 4.3.4'
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem 'minima', '~> 2.5'
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem 'jekyll-data'
+  gem 'jekyll-feed', '~> 0.12'
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem 'tzinfo', '>= 1', '< 3'
+  gem 'tzinfo-data'
+end
+
+# Performance-booster for watching directories on Windows
+gem 'wdm', '~> 0.1', platforms: %i[mingw x64_mingw mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem 'base64'
+gem 'csv'
+gem 'http_parser.rb', '~> 0.6.0', platforms: [:jruby]
+gem 'minimal-mistakes-jekyll'

data/usefakermaker.com/README.md

@@ -0,0 +1,5 @@
+This is the Jekyll documentation for Faker Maker.
+
+Cloudflare Pages is configurated to automatically deploy the `main` branch of this repository to the `usefakermaker.com` domain.
+
+When adding pages, you usually want to add to the `usage` collection. Remember to update the `data/_navigation.yml` file to include the new page in the navigation.