faker_maker 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ec69f6145d624d4c97304fc347e0968000490eed3330bd6821757d8e91709b
-  data.tar.gz: c0def7a4f1f467c0c0a5cf7cba89eac31673ee9d9a75cbd21bc781bf1e3049bc
+  metadata.gz: 8dad7967bc0e3c689498afafca60a7b9c691aa8af466880ac5af87d5668e4706
+  data.tar.gz: c7659747e882e4a9361507759629f4482068475c859dc9883a79ffdb62b916fb
 SHA512:
-  metadata.gz: 89c0415112f57426f32515643829fde4191a3017b8934154fca010d5447302b56f0b5ab6f9467257646d22c5a9c40e4983f805c77502fdcd87a93f420c4bb28f
-  data.tar.gz: d2cf75a2cc0cc2d038df826d4ebfc53e192c62547e9167bae13894c179c8e20c7068fc9f4503cfb704cd116e70a844e82db9b93d57b82111681eedd617d63b42
+  metadata.gz: fb83e7d087b54877d133d89b7b00f4c849eb8355c5dc9233b53dfe69d8a9096ec8f2da6edc5539a2334ab7afc880e1c5fb6369b590e69b31e8a7a99fb94b39f2
+  data.tar.gz: 1e661f28f49569d73dbeeb8ddbd27226a5d124522d6fd07b53be9341f7021f7dc46595d9d1f55303f62df92a1d49b7276c68e854fee6f84e03b1866aa6197c79

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -140,8 +140,33 @@ FakerMaker.factory :basket do
 end
 ```
 
+### Organising 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. 
+
 ### 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.
+
+```ruby
+FakerMaker.factory :vehicle do
+  wheels { 4 }
+  colour { Faker::Color.color_name }
+  engine_capacity(json: 'engineCapacity') { rand( 600..2500 ) }
+end
+
+v = FM[:vehicle].build
+v.engine_capacity = 125
+```
+
+and calls to `as_json` and `to_json` will report the fieldname as `engineCapacity`.
+
+```ruby
+v.to_json
+
+=> "{\"wheels\":4,\"colour\":\"blue\",\"engineCapacity\":125}"
+```
+
 ### 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. 
@@ -166,6 +191,14 @@ or by passing in a block:
 result = FakerMaker[:item].build{ |i| i.name = 'Electric Sheep' }
 ```
 
+this is particularly useful for overriding nested values, since all the getters and setters of the embedded objects are already constructed:
+
+```ruby
+result = FakerMaker[:basket].build do |b| 
+  b.items.first.name = 'Neon Badger'
+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
@@ -192,6 +225,42 @@ As another convenience, `FakerMaker` is also assigned to the variable `FM` to it
 result = FM[:basket].build
 ```
 
+### 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.
+
+```ruby
+FakerMaker.factory :user do 
+  name {'Patsy Stone'}
+  email(omit: :nil) {'patsy@fabulous.co.uk'}
+  admin {false}
+end
+
+FM[:user].build.as_json
+=> {:name=>"Patsy Stone", :email=>"patsy@fabulous.co.uk", :admin=>false}
+
+FM[:user].build(email: nil).as_json
+=> {:name=>"Patsy Stone", :admin=>false}
+```
+
+The `omit` modifier can take a single value or an array. If it is passed a value and the attribute equals this value, it will not be included in the output from `as_json` (which returns a Ruby Hash) or in `to_json` methods.
+
+There are three special modifiers:
+
+* `:nil` (symbol) to omit output when the attribute is set to nil
+* `:empty` to omit output when the value is an empty string, an empty array or an empty hash
+* `:always` to never output this attibute.
+
+These can be mixed with real values, e.g.
+
+```ruby
+FakerMaker.factory :user do 
+  name {'Patsy Stone'}
+  email(omit: [:nil, :empty, 'test@foobar.com']) {'patsy@fabulous.co.uk'}
+  admin {false}
+end
+```
+
 ### Embedding factories
 
 To use factories with factories, the following pattern is recommended:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'faker_maker'

data/faker_maker.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Disable rubocop checks for the .gemspec
 # I'll take the output from 'bundle gem new' to be authoritative
 # rubocop:disable all
@@ -39,10 +41,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 5.2', '< 6'
+  spec.add_dependency 'activesupport', '>= 5.2', '< 7'
 
   spec.add_development_dependency 'bundler',   '~> 2.0'
-  spec.add_development_dependency 'faker',     '~> 1.9'
+  spec.add_development_dependency 'faker',     '~> 2.1'
   spec.add_development_dependency 'pry',       '~> 0.12'
   spec.add_development_dependency 'rake',      '~> 12.3'
   spec.add_development_dependency 'rspec',     '~> 3.8'

data/lib/faker_maker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'

data/lib/faker_maker/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FakerMaker
   # Attributes describe the fields of classes
   class Attribute
@@ -9,6 +11,7 @@ module FakerMaker
       @block = block || proc { nil }
       @cardinality = options[:has] || 1
       @translation = options[:json]
+      @omit = *options[:omit]
       @array = options[:array] == true 
     end
 
@@ -27,6 +30,17 @@ module FakerMaker
     def translation?
       !@translation.blank?
     end
+    
+    def omit?( value )
+      case value
+      when nil
+        @omit.include? :nil
+      when '', [], {}
+        @omit.include? :empty
+      else
+        @omit.include?( :always ) || @omit.include?( value )
+      end
+    end
 
     private 
 
@@ -35,7 +49,7 @@ module FakerMaker
     end
 
     def assert_valid_options( options )
-      options.assert_valid_keys :has, :array, :json
+      options.assert_valid_keys :has, :array, :json, :omit
     end
   end
 end

data/lib/faker_maker/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FakerMaker
   # Base module for defining the DSL
   module Base

data/lib/faker_maker/definition_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FakerMaker
   # Proxy for mapping attribute names
   class DefinitionProxy

data/lib/faker_maker/factory.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/ClassLength
 module FakerMaker
   # Factories construct instances of a fake
   class Factory
-    attr_reader :name, :attributes, :class_name, :parent
+    attr_reader :name, :class_name, :parent
 
     def initialize( name, options = {} )
       assert_valid_options options
@@ -47,6 +49,10 @@ module FakerMaker
       build.to_json
     end
 
+    def as_json(*_args)
+      build.as_json
+    end
+
     def parent?
       !@parent.nil?
     end
@@ -65,7 +71,16 @@ module FakerMaker
 
     def attribute_names( collection = [] )
       collection |= FakerMaker[parent].attribute_names( collection ) if parent?
-      collection | attributes.map( &:name )
+      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 == name }.first
     end
 
     protected 
@@ -116,7 +131,9 @@ module FakerMaker
 
     def attach_json_overrides_to_class
       @klass.define_method :as_json do |options = {}|
-        super( options.merge( except: 'fm_factory' ) ).transform_keys { |key| @fm_factory.json_key_map[key] || key }
+        super( options.merge( except: 'fm_factory' ) )
+          .transform_keys { |key| @fm_factory.json_key_map[key] || key }
+          .filter { |key, value| !@fm_factory.find_attribute(key)&.omit?( value ) }
       end
     end
 

data/lib/faker_maker/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FakerMaker
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement