faker_maker 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6355e061188d88ab10d97dae93595abccbf2a73346b6220c265c9241198f93ba
-  data.tar.gz: 487700e0d8e88f4fb69d00796bb4d644263e7c91af91eea188caa7eaf82861c5
+  metadata.gz: cc9201db222f65f8df79f92edc882d9d76e5ca21c6220b377f5e86ce9414d287
+  data.tar.gz: d4601f347ce1231fd287d33addde2bb83c00a1a770783eec8007dd7417c6c2f3
 SHA512:
-  metadata.gz: e2e50d6ffa61e8164163d2157a65d8a3b93b24e442028e0e04951b25f8e298693bd3a8c6ff3ff948442c38c972f427ec05017020dd120b0cfeefdbb02ebd82b8
-  data.tar.gz: 4c1ae45972c019f0929b1c0337b20ebe4f92ecaa040811f515934d50ce38e826956c994a3043d1f8a27928921930a32980d4bff29fceffbb0c8a7a82f1d4ebd6
+  metadata.gz: ce1be4538d82898bb1accd89585485e6072974350088261dece5f0481a3d1950cbf1462dba6363231e2b25019632d8f1aa649e04cab5c4a0a752c6ca9e428c7f
+  data.tar.gz: 2d442d69c483b0aa5ba5f7bc9fd26396376edbc2ff700c9d47305d27f2fc809d42d4971bf8ef8b09c67f7f4912395e6eb0127c0d105e6763708f342916e2ae85

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "3.1", "3.2"]
+
+    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

data/.gitignore

@@ -14,4 +14,5 @@ Gemfile.lock
 .DS_Store
 
 faker_maker-*.gem
-test.rb
+test.rb
+.idea

data/.rubocop.yml

@@ -45,5 +45,11 @@ Metrics/MethodLength:
 Lint/MissingSuper:
   Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
 AllCops:
   NewCops: enable

data/bin/console

@@ -3,6 +3,7 @@
 
 require 'bundler/setup'
 require 'faker_maker'
+require 'faker'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/docs/usage/chaos.md

@@ -0,0 +1,45 @@
+---
+layout: default
+title: Chaos
+parent: Usage
+nav_order: 11
+---
+
+# Chaos
+
+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. 
+
+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.*
+
+To explicitly mark attributes as either required or optional:
+
+```ruby
+FM.factory :item, naming: :json do
+  name { 'Blanket' }
+  price(required: true) { 100 }
+  description(optional: true) { 'Keeps you warm and cozy' }
+  manufacturer(optional: 0.7) { 'A large fruit company' }
+end
+```
+
+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. 
+
+To unleash Chaos over a factory, you need to enable it when instantiating your object:
+
+```ruby
+result = FakerMaker[:item].build( chaos: true )
+```
+
+You can also specify which attributes Chaos can use when instantiating your object:
+
+```ruby
+result = FakerMaker[:item].build( chaos: %i[name manufacturer] )
+```

data/faker_maker.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.2', '< 8'
 
   spec.add_development_dependency 'bundler',       '~> 2.0'
-  spec.add_development_dependency 'faker',         '~> 2.1'
+  spec.add_development_dependency 'faker',         '~> 3.2'
   spec.add_development_dependency 'guard',         '~> 2.16'
   spec.add_development_dependency 'guard-bundler', '~> 3.0'
   spec.add_development_dependency 'guard-rubocop', '~> 1.3'

data/lib/faker_maker/attribute.rb

@@ -3,7 +3,9 @@
 module FakerMaker
   # Attributes describe the fields of classes
   class Attribute
-    attr_reader :name, :block, :translation
+    attr_reader :name, :block, :translation, :required, :optional, :optional_weighting
+
+    DEFAULT_OPTIONAL_WEIGHTING = 0.5
 
     def initialize( name, block = nil, options = {} )
       assert_valid_options options
@@ -13,6 +15,13 @@ module FakerMaker
       @translation = options[:json]
       @omit = *options[:omit]
       @array = options[:array] == true
+
+      if options[:required].to_s.downcase.eql?('true') || options[:optional].to_s.downcase.eql?('false')
+        @required = true
+      else
+        @optional = true
+        @optional_weighting = determine_optional_weighting(options[:optional])
+      end
     end
 
     def array?
@@ -49,7 +58,18 @@ module FakerMaker
     end
 
     def assert_valid_options( options )
-      options.assert_valid_keys :has, :array, :json, :omit
+      options.assert_valid_keys :has, :array, :json, :omit, :required, :optional
+    end
+
+    def determine_optional_weighting( value )
+      case value
+      when Float
+        value.between?(0, 1) ? value : (value / 100)
+      when Integer
+        value.ceil.between?(0, 100) ? (value.to_f / 100) : DEFAULT_OPTIONAL_WEIGHTING
+      else
+        DEFAULT_OPTIONAL_WEIGHTING
+      end
     end
   end
 end

data/lib/faker_maker/factory.rb

@@ -5,7 +5,7 @@ module FakerMaker
   # Factories construct instances of a fake
   class Factory
     include Auditable
-    attr_reader :name, :class_name, :parent
+    attr_reader :name, :class_name, :parent, :chaos_selected_attributes
 
     def initialize( name, options = {} )
       assert_valid_options options
@@ -19,7 +19,7 @@ module FakerMaker
                          when nil
                            nil
                          else
-                           raise FakerMaker::NoSuchAttributeNamingStrategy, opttions[:naming]
+                           raise FakerMaker::NoSuchAttributeNamingStrategy, options[:naming]
                          end
       @attributes = []
       @klass = nil
@@ -42,11 +42,22 @@ module FakerMaker
       @instance ||= instantiate
     end
 
-    def build( attributes = {} )
+    def build( attributes: {}, chaos: false, **kwargs )
+      if kwargs.present?
+        validate_deprecated_build(kwargs)
+        attributes = kwargs
+      end
+
       @instance = nil
       before_build if respond_to? :before_build
       assert_only_known_attributes_for_override( attributes )
-      populate_instance instance, attributes
+
+      assert_chaos_options chaos if chaos
+
+      optional_attributes
+      required_attributes
+
+      populate_instance instance, attributes, chaos
       yield instance if block_given?
       after_build if respond_to? :after_build
       audit(@instance) if FakerMaker.configuration.audit?
@@ -110,11 +121,14 @@ module FakerMaker
 
     protected
 
-    def populate_instance( instance, attr_override_values )
-      FakerMaker[parent].populate_instance instance, attr_override_values if parent?
-      @attributes.each do |attr|
-        value = value_for_attribute( instance, attr, attr_override_values )
-        instance.send "#{attr.name}=", value
+    def populate_instance( instance, attr_override_values, chaos )
+      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 )
+        instance.send "#{attribute.name}=", value
       end
       instance.instance_variable_set( :@fm_factory, self )
     end
@@ -128,6 +142,19 @@ module FakerMaker
       raise FakerMaker::NoSuchAttributeError, issue unless unknown_attrs.empty?
     end
 
+    def assert_only_known_and_optional_attributes_for_chaos( chaos_attr_values )
+      chaos_attr_values = chaos_attr_values.map(&:to_sym)
+      unknown_attrs = chaos_attr_values - attribute_names
+      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?
+
+      # Are any chaos attributes marked as required?
+      conflicting_attributes = chaos_attr_values.select { |attr| required_attributes.map(&:name).include? attr }
+      issue = "Can't use chaos on a required attribute: '#{conflicting_attributes}'"
+      raise FakerMaker::ChaosConflictingAttributeError, issue unless conflicting_attributes.empty?
+    end
+
     def attribute_hash_overridden_value?( attr, attr_override_values )
       attr_override_values.keys.include?( attr.name )
     end
@@ -164,6 +191,68 @@ module FakerMaker
     def assert_valid_options( options )
       options.assert_valid_keys :class, :parent, :naming
     end
+
+    # Asserts attributes passed in for chaos mode are valid
+    def assert_chaos_options( chaos )
+      eval = -> { [Array, String, TrueClass, FalseClass, Symbol].include? chaos.class }
+      msg = "chaos: arg does not support object of type: '#{chaos.class}'"
+      raise NoSuchAttributeError, msg unless eval.call
+
+      case chaos
+      when Array
+        assert_only_known_and_optional_attributes_for_chaos(chaos)
+      when String, Symbol
+        assert_only_known_and_optional_attributes_for_chaos([chaos])
+      end
+    end
+
+    # Selects required @attributes
+    def required_attributes
+      @required_attributes ||= @attributes.select { |attr| attr.required.eql? true }
+    end
+
+    # Selects optional @attributes
+    def optional_attributes
+      @optional_attributes ||= @attributes.select(&:optional)
+    end
+
+    # Randomly selects optional attributes
+    # Attributes selected from parent will also be selected for the child
+    # @param [Array || TrueClass] chaos_attrs
+    # @return [Array]
+    def chaos_select( chaos_attrs = [] )
+      selected_attrs = []
+      optional_attrs = optional_attributes.dup
+
+      # Filter specific optional attributes if present
+      if chaos_attrs.is_a?(Array) && chaos_attrs.size.positive?
+        optional_attrs, selected_attrs = optional_attrs.partition { |attr| chaos_attrs.include?(attr.name) }
+      end
+
+      # Grab parent selected attributes
+      @chaos_selected_attributes = parent? ? FakerMaker[parent].chaos_selected_attributes : []
+      selected_inherited_attr = optional_attrs.select do |attr|
+        @chaos_selected_attributes.map(&:name).include? attr.name
+      end
+
+      # Select optional attributes based on weighting
+      optional_attrs.each do |optional_attr|
+        selected_attrs.push(optional_attr) if Random.rand < optional_attr.optional_weighting
+      end
+
+      # Concat required, selected and parent attributes
+      @chaos_selected_attributes.concat(required_attributes)
+                                .concat(selected_inherited_attr)
+                                .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 = '1.3.0'
+  VERSION = '2.0.0'
 end

data/lib/faker_maker.rb

@@ -27,6 +27,7 @@ module FakerMaker
   class Error < StandardError; end
   class NoSuchFactoryError < StandardError; end
   class NoSuchAttributeError < StandardError; end
+  class ChaosConflictingAttributeError < StandardError; end
   class NoSuchAttributeNamingStrategy < StandardError; end
   # Your code goes here...
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +179,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -202,6 +203,7 @@ files:
 - docs/usage/arrays.md
 - docs/usage/audit_logs.md
 - docs/usage/building_instances.md
+- docs/usage/chaos.md
 - docs/usage/dependencies.md
 - docs/usage/destroying_factories.md
 - docs/usage/embedding_factories.md