faker_maker 1.1.7 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bf4bb970ba80be62323b929fc2b6aba156abb1aee757b911d9663f58e081e4
-  data.tar.gz: c345ab60315a80d82f879f179c18e93ea81ba4ebd2751b0a4269c337a0a3a0ed
+  metadata.gz: 6b2f1fd221b22d6e524e97f69eb399bda8d0584192e960fb79e457ac5bfe1bb1
+  data.tar.gz: 3c757c4d82d1d8a9bbb0fc31d32911fa8235c4b967eb92d9008d3d8217711f15
 SHA512:
-  metadata.gz: 95340d9e637a09583f8c9d8b619391cbedb825655b414ec1b1de073beeb041a2eceba65aaf53fd70929fc6d2b80d9d0237290031031b31da6021622ea678ca0f
-  data.tar.gz: 9804e0879fe4b39d66e1409134710c90e7af608c6f14a87c35be65605029e1a54506d9ea0d95d94a590106be9051eafe2525a83d8dfcaaa74dcc765adadf1c32
+  metadata.gz: ee940fb5629d2a4f56402f164a3cbe11ad2a8150229dfeceeb596e78aa1a624b30bcd1f8518d3167750c97622b630595523448140358bd05e159327deccf38b3
+  data.tar.gz: 41f7f57bf43afe5c677592ae608d919aadac205cba4ddce3c4fd16602e6e7163d9cf060c1ce7722e9e77fb6eb4cf82028abc1dfb47f18cdd1ad8c379129f6c70

data/.rubocop.yml

@@ -13,4 +13,25 @@ Metrics/BlockLength:
     - "**/*_spec.rb"
 
 Layout/TrailingWhitespace:
-  Enabled: false
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+ 
+Style/HashTransformValues:
+  Enabled: true

data/docs/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: "12"

data/docs/usage/destroying_factories.md

@@ -2,9 +2,17 @@
 layout: default
 title: Destroying Factories
 parent: Usage
-nav_order: 8
+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. 
+
+This functionality exists for experimenting with factories in REPLs.
+
+Seriously, don't use this in anger.
+
 # Destroying Factories
 
 Faker Maker deliberately does not allow you to redefine a factory by redeclaring it. It will also be silent about your attempt to do so. This is to avoid throwing up runtime warning from the Ruby interpreter if you are embedding one factory definition in another.
@@ -43,4 +51,4 @@ FM[:user].as_json
  => {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk"}
  ```
  
- It also provides the `shut_all!` method to remove all factories.
+ It also provides the `shut_all!` method to remove all factories.

data/docs/usage/embedding_factories.md

@@ -2,7 +2,7 @@
 layout: default
 title: Embedding Factories
 parent: Usage
-nav_order: 7
+nav_order: 8
 ---
 
 # Embedding Factories

data/docs/usage/lifecycle_hooks.md

@@ -0,0 +1,33 @@
+---
+layout: default
+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
+* `after_build` the instance has been created and all of the values have been set
+
+For instance:
+
+```ruby
+FakerMaker.factory :user do 
+  before_build do
+    puts 'Building an instance of User'
+  end
+
+  name {'Patsy Stone'}
+  email {'patsy@fabulous.co.uk'}
+  admin {false}
+  
+  after_build do
+    puts "Built an instance of User (#{faker_maker_factory.instance.name})"
+  end
+end
+```
+
+Access to the factory object is through the `faker_maker_factory` method. The instance under construction is available through the `faker_maker_factory.instance` method.

data/lib/faker_maker.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require 'active_support'
-require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/object/json'
-require 'faker_maker/version'
+require 'active_support/core_ext/string'
+require 'faker_maker/attribute'
 require 'faker_maker/base'
-require 'faker_maker/factory'
+require 'faker_maker/lifecycle_hooks'
 require 'faker_maker/definition_proxy'
-require 'faker_maker/attribute'
+require 'faker_maker/factory'
+require 'faker_maker/lifecycle_hooks'
+require 'faker_maker/version'
 
 # FakerMaker module for generating Fakes
 module FakerMaker
@@ -40,21 +42,21 @@ module FakerMaker
 
     factory
   end
-  
+
   def find_factory( name )
     factories[name]
   end
-  
+
   def shut!( name )
     factory = find_factory( name )
-    if factory
-      factories[name] = nil
-      Object.send( :remove_const, factory.class_name )
-    end
+    return unless factory
+
+    factories[name] = nil
+    Object.send( :remove_const, factory.class_name )
   end
-  
+
   def shut_all!
-    factories.keys.each { |f| shut!( f ) }
+    factories.each_key { |f| shut!( f ) }
   end
 end
 

data/lib/faker_maker/attribute.rb

@@ -12,7 +12,7 @@ module FakerMaker
       @cardinality = options[:has] || 1
       @translation = options[:json]
       @omit = *options[:omit]
-      @array = options[:array] == true 
+      @array = options[:array] == true
     end
 
     def array?
@@ -21,7 +21,7 @@ module FakerMaker
 
     def cardinality
       if @cardinality.is_a? Range
-        rand( @cardinality ) 
+        rand( @cardinality )
       else
         @cardinality
       end
@@ -30,7 +30,7 @@ module FakerMaker
     def translation?
       !@translation.blank?
     end
-    
+
     def omit?( value )
       case value
       when nil
@@ -42,7 +42,7 @@ module FakerMaker
       end
     end
 
-    private 
+    private
 
     def forced_array?
       @cardinality.is_a?( Range ) || @cardinality > 1

data/lib/faker_maker/base.rb

@@ -5,7 +5,7 @@ module FakerMaker
   module Base
     def factory(name, options = {}, &block)
       factory = FakerMaker.find_factory(name)
-      if factory.nil? 
+      if factory.nil?
         factory = FakerMaker::Factory.new name, options
         proxy = DefinitionProxy.new factory
         proxy.instance_eval( &block ) if block_given?
@@ -14,6 +14,5 @@ module FakerMaker
         factory
       end
     end
-    
   end
 end

data/lib/faker_maker/definition_proxy.rb

@@ -3,15 +3,21 @@
 module FakerMaker
   # Proxy for mapping attribute names
   class DefinitionProxy
+    include FakerMaker::LifecycleHooks::DefinitionProxy
+
     def initialize(factory)
       @factory = factory
     end
 
+    def faker_maker_factory
+      @factory
+    end
+
     def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper
       attribute = FakerMaker::Attribute.new name, block, *args
       @factory.attach_attribute attribute
     end
-    
+
     def respond_to_missing?(method_name, include_private = false)
       super
     end

data/lib/faker_maker/factory.rb

@@ -14,9 +14,9 @@ module FakerMaker
       @klass = nil
       @parent = options[:parent]
     end
-    
+
     def parent_class
-      if @parent 
+      if @parent
         Object.const_get( FakerMaker[@parent].class_name )
       else
         Object
@@ -24,14 +24,19 @@ module FakerMaker
     end
 
     def attach_attribute( attribute )
-      @attributes << attribute 
+      @attributes << attribute
+    end
+
+    def instance
+      @instance ||= instantiate
     end
 
     def build( attributes = {} )
-      instance = instantiate
+      before_build if respond_to? :before_build
       assert_only_known_attributes_for_override( attributes )
       populate_instance instance, attributes
       yield instance if block_given?
+      after_build if respond_to? :after_build
       instance
     end
 
@@ -73,19 +78,19 @@ module FakerMaker
       collection |= FakerMaker[parent].attribute_names( collection ) if parent?
       collection | @attributes.map( &:name )
     end
-    
+
     def attributes( collection = [] )
       collection |= FakerMaker[parent].attributes( collection ) if parent?
       collection | @attributes
     end
-    
+
     def find_attribute( name = '' )
       attributes.filter { |a| [a.name, a.translation].include? name }.first
     end
 
-    protected 
+    protected
 
-    def populate_instance( instance, attr_override_values )    
+    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 )
@@ -93,21 +98,20 @@ module FakerMaker
       end
       instance.instance_variable_set( :@fm_factory, self )
     end
-    
-    
+
     private
-    
+
     def assert_only_known_attributes_for_override( attr_override_values )
       unknown_attrs = attr_override_values.keys - 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?
     end
-    
+
     def attribute_hash_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 )
         attr_override_values[attr.name]

data/lib/faker_maker/lifecycle_hooks.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module FakerMaker
+  module LifecycleHooks
+    # Lifecycle hooks which can be called during the building of an instance
+    module DefinitionProxy
+      def before_build(&block)
+        @factory.define_singleton_method(:before_build) { block.call }
+      end
+
+      def after_build(&block)
+        @factory.define_singleton_method(:after_build) { block.call }
+      end
+    end
+  end
+end

data/lib/faker_maker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FakerMaker
-  VERSION = '1.1.7'
+  VERSION = '1.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.8
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,6 +220,7 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
+- docs/.bundle/config
 - docs/.keep
 - docs/_config.yml
 - docs/contributing.md
@@ -235,6 +236,7 @@ files:
 - docs/usage/index.md
 - docs/usage/inheritance.md
 - docs/usage/json_field_names.md
+- docs/usage/lifecycle_hooks.md
 - docs/usage/omitting_fields copy.md
 - faker_maker.gemspec
 - img/unipug.svg
@@ -243,6 +245,7 @@ files:
 - lib/faker_maker/base.rb
 - lib/faker_maker/definition_proxy.rb
 - lib/faker_maker/factory.rb
+- lib/faker_maker/lifecycle_hooks.rb
 - lib/faker_maker/version.rb
 homepage: https://billyruffian.github.io/faker_maker/
 licenses: