faker_maker 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2d4bf41d893f06f219a7ed7c630b5115f4351af244e480e582f554fca3d59aa
-  data.tar.gz: 8bb38648b33e21b14afed798db4284e501cfc4f408377574d2bec6925d54bf0f
+  metadata.gz: fee4b085d7597c65882a322c750393492922c22653b66bb5c4b2e2da064c85be
+  data.tar.gz: ad9fa43a58aefcba71b1beaa0a2a53ebbf200644b01f9cfd568f234d665d1631
 SHA512:
-  metadata.gz: b0db65f7c7432cde9d278d1fc789106fd50df317d9b7b637b5345561449ce543275cdb5ae7edaccd79019aa48595737d360d9be684276e7544f639d21fba6810
-  data.tar.gz: fce49187a0b109f9a88b86a859fcd569bd9425e1f2d481f0df4b0a39c8625515d0ac863f91d0880848bc7bab846a97cf0118359807cd9f7b2f07b7129ccb8a50
+  metadata.gz: 14dd70aa6b4cdac5402e1603073bd018dbd699b23181ef8294c8ea5ec3b759d8e6dc6fffcccec30f66e3b34d764c975e6c899b8703027f94ffbdf4b4e53ae2f5
+  data.tar.gz: '083a7808d7c4c8d8830b1c02595192f9f72aef08880918d9667e7f63e8d5749f42878f239f24443aa4c680b7f5d6cce8f39b1992be1c50bde782f9b02f4a71ca'

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+# Use the latest 2.1 version of CircleCI pipeline processing engine, see https://circleci.com/docs/2.0/configuration-reference/
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    steps:
+      - checkout
+      - run: gem update --system
+      - run: gem install bundler
+      - run: bundle install
+      - run: bundle exec rake spec

data/.gitignore

@@ -12,3 +12,6 @@ Gemfile.lock
 .rspec_status
 
 .DS_Store
+
+faker_maker-*.gem
+test.rb

data/.rubocop.yml

@@ -1,5 +1,16 @@
 Layout/SpaceInsideParens:
   Enabled: false
-  
+
 Metrics/LineLength:
-  Max: 120
+  Max: 120
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Layout/TrailingWhitespace:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -1,3 +1,8 @@
+
+![CircleCI branch](https://img.shields.io/circleci/project/github/BillyRuffian/faker_maker/master.svg?style=flat-square)
+[![CodeFactor](https://www.codefactor.io/repository/github/billyruffian/faker_maker/badge?style=flat-square)](https://www.codefactor.io/repository/github/billyruffian/faker_maker)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/BillyRuffian/faker_maker.svg?style=flat-square)
+
 # FakerMaker
 
 FakerMaker is a simple fixture generator with a concise and straightforward syntax.
@@ -155,7 +160,7 @@ result = FakerMaker[:item].build( name: 'Electric Blanket' ) do |i|
 end
 ```
 
-then the value of `i.name` is 'Electric Sheep'.
+then the value of `result.name` is 'Electric Sheep'.
 
 Beware when overriding values in this way: there is no type checking. You will get an exception if you try to set a value to an attribute that doesn't exist but you won't get one if you assign, say, an array of values where you would otherwise have a string and vice versa.
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "faker_maker"
+require 'bundler/setup'
+require 'faker_maker'
 
 # 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.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/faker_maker.gemspec

@@ -1,3 +1,7 @@
+# Disable rubocop checks for the .gemspec
+# I'll take the output from 'bundle gem new' to be authoritative
+# rubocop:disable all
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'faker_maker/version'
@@ -35,13 +39,13 @@ 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'
+  spec.add_dependency 'activesupport', '>= 5.2', '< 6'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'faker', '>= 1.9'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '>= 3.8'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov', '>= 0.16'
+  spec.add_development_dependency 'bundler',   '~> 2.0'
+  spec.add_development_dependency 'faker',     '~> 1.9'
+  spec.add_development_dependency 'pry',       '~> 0.12'
+  spec.add_development_dependency 'rake',      '~> 12.3'
+  spec.add_development_dependency 'rspec',     '~> 3.8'
+  spec.add_development_dependency 'rubocop',   '~> 0.68'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/lib/faker_maker/attribute.rb

@@ -1,8 +1,9 @@
 module FakerMaker
+  # Attributes describe the fields of classes
   class Attribute
     attr_reader :name, :block, :translation
 
-    def initialize name, options={}, block
+    def initialize( name, block = nil, options = {} )
       assert_valid_options options
       @name = name
       @block = block
@@ -24,7 +25,7 @@ module FakerMaker
     end
 
     def translation?
-      ! @translation.blank?
+      !@translation.blank?
     end
 
     private 
@@ -33,9 +34,8 @@ module FakerMaker
       @cardinality.is_a?( Range ) || @cardinality > 1
     end
 
-    def assert_valid_options options
+    def assert_valid_options( options )
       options.assert_valid_keys :has, :array, :json
     end
-
   end
-end
+end

data/lib/faker_maker/base.rb

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

data/lib/faker_maker/definition_proxy.rb

@@ -1,14 +1,17 @@
 module FakerMaker
+  # Proxy for mapping attribute names
   class DefinitionProxy
-
-    def initialize factory
+    def initialize(factory)
       @factory = factory
     end
 
-    def method_missing name, *args, &block
-      attribute = FakerMaker::Attribute.new name, *args, block
+    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
   end
-end
+end

data/lib/faker_maker/factory.rb

@@ -1,26 +1,30 @@
 module FakerMaker
+  # Factories construct instances of a fake
   class Factory
-    attr_reader :name, :attributes, :class_name, :parent_class, :parent
+    attr_reader :name, :attributes, :class_name, :parent
 
-    def initialize name, options={}
+    def initialize( name, options = {} )
       assert_valid_options options
       @name = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.underscore.to_sym
       @class_name = (options[:class] || @name).to_s.camelcase
       @attributes = []
       @klass = nil
       @parent = options[:parent]
-      @parent_class = if @parent 
+    end
+    
+    def parent_class
+      if @parent 
         Object.const_get( FakerMaker[@parent].class_name )
       else
-         Object
+        Object
       end
     end
 
-    def attach_attribute attribute
+    def attach_attribute( attribute )
       @attributes << attribute 
     end
 
-    def build attributes={}
+    def build( attributes = {} )
       instance = instantiate
       populate_instance instance, attributes
       yield instance if block_given?
@@ -29,7 +33,7 @@ module FakerMaker
 
     def assemble
       if @klass.nil?
-        @klass = Class.new @parent_class
+        @klass = Class.new parent_class
         Object.const_set @class_name, @klass
         attach_attributes_to_class
         attach_json_overrides_to_class
@@ -37,12 +41,12 @@ module FakerMaker
       @klass
     end
 
-    def to_json
+    def to_json(*_args)
       build.to_json
     end
 
     def parent?
-      ! @parent.nil?
+      !@parent.nil?
     end
 
     def json_key_map
@@ -59,30 +63,39 @@ module FakerMaker
 
     protected 
 
-    def populate_instance instance, attr_override_values
-      if ! ( unknown_attrs = attr_override_values.keys - @attributes.map( &:name ) ).empty?
-        raise FakerMaker::NoSuchAttributeError, 
-          "Can't build an instance of '#{class_name}' setting '#{unknown_attrs.join( ', ' )}', no such attribute(s)"
-      end
+    def populate_instance( instance, attr_override_values )
+      assert_only_know_attributes_for_override( attr_override_values )
     
-      FakerMaker[parent].populate_instance instance if self.parent?
-      @attributes.each do |attr|
-        value = nil
-        
-        if ! attr_override_values[attr.name].nil?
-          value = attr_override_values[attr.name]
-        elsif attr.array?
-          value = Array.new.tap{ |a| attr.cardinality.times{ a << attr.block.call } }
-        else
-          value = attr.block.call
-        end
-
+      FakerMaker[parent].populate_instance instance if parent?
+      @attributes.each do |attr|       
+        value = value_for_attribute( attr, attr_override_values )
         instance.send "#{attr.name}=", value
       end
       instance.instance_variable_set( :@fm_factory, self )
     end
 
     private
+    
+    def assert_only_know_attributes_for_override( attr_override_values )
+      unknown_attrs = attr_override_values.keys - @attributes.map( &:name )
+      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[attr.name].nil?
+    end
+    
+    def value_for_attribute( attr, attr_override_values )
+      if attribute_hash_overridden_value?( attr, attr_override_values )
+        attr_override_values[attr.name]
+      elsif attr.array?
+        [].tap { |a| attr.cardinality.times { a << attr.block.call } }
+      else
+        attr.block.call
+      end
+    end
 
     def instantiate
       assemble.new
@@ -96,13 +109,13 @@ module FakerMaker
     end
 
     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 }
+      @klass.define_method :as_json do |options = {}|
+        super( options.merge( except: 'fm_factory' ) ).transform_keys { |key| @fm_factory.json_key_map[key] || key }
       end
     end
 
-    def assert_valid_options options
+    def assert_valid_options( options )
       options.assert_valid_keys :class, :parent
     end
   end
-end
+end

data/lib/faker_maker/version.rb

@@ -1,3 +1,3 @@
 module FakerMaker
-  VERSION = "1.0.0"
+  VERSION = '1.0.1'.freeze
 end

data/lib/faker_maker.rb

@@ -8,6 +8,7 @@ require 'faker_maker/factory'
 require 'faker_maker/definition_proxy'
 require 'faker_maker/attribute'
 
+# FakerMaker module for generating Fakes
 module FakerMaker
   extend FakerMaker::Base
 
@@ -18,7 +19,7 @@ module FakerMaker
 
   module_function
 
-  def register_factory factory
+  def register_factory( factory )
     factory.assemble
     factories[factory.name] = factory
   end
@@ -27,19 +28,19 @@ module FakerMaker
     @factories ||= {}
   end
 
-  def build name    
+  def build( name )
     find_factory( name ).build
   end
 
-  def [] name
+  def []( name )
     find_factory name
   end
   
-  def find_factory name
+  def find_factory( name )
     raise NoSuchFactoryError, "No such factory '#{name}'" if factories[name].nil?
+    
     factories[name]
   end
-
 end
 
 FM = FakerMaker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faker_maker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -42,84 +48,84 @@ dependencies:
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.68'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.68'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
 description: FakerMaker is a simple fixture generator with a concise and straightforward
@@ -130,6 +136,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -147,7 +154,6 @@ files:
 - lib/faker_maker/definition_proxy.rb
 - lib/faker_maker/factory.rb
 - lib/faker_maker/version.rb
-- test.rb
 homepage: https://github.com/BillyRuffian/faker_maker
 licenses:
 - MIT

data/test.rb

@@ -1,61 +0,0 @@
-FakerMaker.factory :Foo, class: 'FooBar' do 
-  bob {'hey'} 
-end
-
-FakerMaker.factory :bar, parent: :Foo, class: 'BarFoo' do 
-  box {'ho'} 
-  bex { {foo: :bar } }
-end
-
-FakerMaker.factory :green_eggs_and_ham, class: 'Egg' do
-  name { Faker::Name.name }
-  date { Time.now }
-  parameter( has: 2 ) { Faker::Company.bs }
-  array( array: true ) { 'bang' }
-  sub has: 0..2 do
-     FakerMaker.build :Foo
-  end
-  blank { nil }
-end
-
-FakerMaker.factory :seuss, parent: :green_eggs_and_ham do
-  quote { 'Today you are you! That is truer than true! There is no one alive who is you-er than you!' }
-end
-
-FakerMaker.factory :vehicle do
-  wheels { 4 }
-  colour { Faker::Color.color_name }
-  engine_capacity( json: 'engineCapacity' ) { rand( 600..2500 ) }
-end
-
-FakerMaker.factory :motorbike, parent: :vehicle do
-  wheels { 2 }
-  sidecar { [true, false].sample }
-end
-
-
-FakerMaker.factory :item do
-  name( json: 'productName' ) { Faker::Commerce.product_name }
-  price( json: 'ticketPrice' ) { Faker::Commerce.price }
-end
-
-
-FakerMaker.factory :basket do
-  items( has: 10 ) { FakerMaker[:item].build }
-end
-
-FakerMaker.factory :a do
-  a( json: 'bigA' ) { 'a' }
-end
-
-FakerMaker.factory :b, parent: :a do
-  b( json: 'bigB' ) { 'b' }
-end
-
-FakerMaker.factory :c, parent: :b do
-  c( json: 'bigC' ) { 'c' }
-end
-
-FakerMaker.factory :d do
-  label{ 'hello' }
-end