faker_maker 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e70530ef4ef67e59247210037bbdbe4fd0c23c6c26666b1459db6f5ac9f65a5e
+  data.tar.gz: f007f3658015e759942885a786424b4f444f34b4d655ab64f5da5044e90274df
+SHA512:
+  metadata.gz: 42b0194260b51a49a03063183da089d885291211f4bc5ef3583b0df79d0ecac6f742ada1a7c0541fef24c2bded3056d91b83697db487eee2f569326dd00324d5
+  data.tar.gz: cf02455a97627cb404d7cb6365d8485d5ff8266797e91bb9745eeb8a40499575832b31cd4dfceaedeea8634aed6c7b5ee0ccc78922243be5fecbd6f322da1e1e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faker_maker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    faker_maker (0.1.0)
+      activesupport (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    faker (1.9.3)
+      i18n (>= 0.7)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  faker (>= 1.9)
+  faker_maker!
+  pry
+  rake (~> 10.0)
+  rspec (>= 3.8)
+  simplecov (>= 0.16)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nigel Brookes-Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# FakerMaker
+
+FakerMaker is a simple fixture generator with a concise and straightforward syntax.
+
+It is designed to resemble the [FactoryBot](https://github.com/thoughtbot/factory_bot) gem but without needing an existing class definition to back its fixtures 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](https://github.com/stympy/faker) gem (but has no dependency upon it).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faker_maker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faker_maker
+
+## Usage
+
+FakerMaker generates factories that build disposable objects for testing. Each factory has a name and a set of attributes.
+
+```ruby
+FakerMaker.factory :user do 
+  name {'Patsy Stone'}
+  email {'patsy@fabulous.co.uk'}
+  admin {false}
+end
+```
+
+This will generate a `User` class with the attributes `name`, `email` and `admin` which will always return the same value.
+
+It is possible to explicitly set the name of class which is particularly useful if there is a risk of redefining an existing one.
+
+```ruby
+FakerMaker.factory :user, class: 'EmailUser' do 
+  name {'Patsy Stone'}
+  email {'patsy@fabulous.co.uk'}
+  admin {false}
+end
+```
+
+The class name will always be turned into a Ruby-style class name so `email_user` would become `EmailUser`.
+
+Because of the block syntax in Ruby, defining attributes as `Hash`es requires two sets of curly brackets:
+
+```ruby
+FakerMaker.factory :response do 
+  body { { title: 'First Post', content: 'This is part of a hash' } }
+end
+```
+
+### Inheritance
+
+FakerMaker can exploit the Ruby class hierarchy to provide additional specialisation or to override some behaviours:
+
+```ruby
+FakerMaker.factory :vehicle do
+  wheels { 4 }
+  colour { Faker::Color.color_name }
+  engine_capacity { rand( 600..2500 ) }
+end
+
+FakerMaker.factory :motorbike, parent: :vehicle do
+  wheels { 2 }
+  sidecar { [true, false].sample }
+end
+```
+
+This is the equivalent of: 
+
+```ruby
+class Vehicle < Object
+  # ...
+end
+
+class Motorbike < Vehicle
+  # ...
+end
+```
+
+so a motorbike will still have a colour and engine capacity between 600 and 2500.
+
+### Arrays
+
+It is possible to declare an attribute as having multiple values.
+
+```ruby
+FakerMaker.factory :basket do
+  items( has: 10 ) { Faker::Commerce.product_name }
+end
+```
+
+or to pick random number of attributes from a range:
+
+```ruby
+FakerMaker.factory :basket do
+  items( has: 5..20 ) { Faker::Commerce.product_name }
+end
+```
+
+A range always generates an array, even if the range produces 1 items or the range is `0..1`.
+
+It is possible to force an attribute to always be an array, even if only produces one item.
+
+```ruby
+FakerMaker.factory :basket do
+  items( array: true ) { Faker::Commerce.product_name }
+end
+```
+
+You can always use long-form block syntax...
+
+```ruby
+FakerMaker.factory :basket do
+  items has: 5..20 do
+    Faker::Commerce.product_name
+  end
+end
+```
+
+### 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. 
+
+To build an object:
+
+```ruby
+result = FakerMaker[:basket].build
+```
+
+will generate a new instance using the Basket factory. Because an actual class is defined, you can instantiate an object directly through `Basket.new` but that will not populate any of the attributes.
+
+As a convenience, you can request a JSON representation directly:
+
+```ruby
+result = FakerMaker[:basket].to_json
+```
+
+As another convenience, `FakerMaker` is also assign to the variable `FM` to it is possible to write just:
+
+```ruby
+result = FM[:basket].build
+```
+
+### Embedding factories
+
+To use factories with factories, the following pattern is recommended:
+
+```ruby
+FakerMaker.factory :item do
+  name { Faker::Commerce.product_name }
+  price { Faker::Commerce.price }
+end
+
+FakerMaker.factory :basket do
+  items( has: 10 ) { FakerMaker[:item].build }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BillyRuffian/faker_maker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faker_maker.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faker_maker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faker_maker"
+  spec.version       = FakerMaker::VERSION
+  spec.authors       = ["Nigel Brookes-Thomas"]
+  spec.email         = ["nigel@brookes-thomas.co.uk"]
+
+  spec.summary       = %q{FakerMaker bakes fakes.}
+  spec.description   = %q{FakerMaker is a simple fixture generator with a concise and straightforward syntax.}
+  spec.homepage      = "https://github.com/BillyRuffian/faker_maker"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    #spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/BillyRuffian/faker_maker"
+    #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "faker", ">= 1.9"
+  spec.add_development_dependency "rspec", ">= 3.8"
+  spec.add_development_dependency "simplecov", ">= 0.16"
+  spec.add_development_dependency "pry"
+end

data/lib/faker_maker/attribute.rb

@@ -0,0 +1,36 @@
+module FakerMaker
+  class Attribute
+    attr_reader :name, :block
+
+    def initialize name, options={}, block
+      assert_valid_options options
+      @name = name
+      @block = block
+      @cardinality = options[:has] || 1
+      @array = options[:array] == true 
+    end
+
+    def array?
+      forced_array? || @array
+    end
+
+    def cardinality
+      if @cardinality.is_a? Range
+        rand( @cardinality ) 
+      else
+        @cardinality
+      end
+    end
+
+    private 
+
+    def forced_array?
+      @cardinality.is_a?( Range ) || @cardinality > 1
+    end
+
+    def assert_valid_options options
+      options.assert_valid_keys :has, :array
+    end
+
+  end
+end

data/lib/faker_maker/base.rb

@@ -0,0 +1,12 @@
+module FakerMaker
+  module Base
+
+    def factory name, options={}, &block
+      factory = FakerMaker::Factory.new name, options
+      proxy = DefinitionProxy.new factory
+      proxy.instance_eval &block if block_given?
+      FakerMaker.register_factory factory
+    end
+    
+  end
+end

data/lib/faker_maker/definition_proxy.rb

@@ -0,0 +1,14 @@
+module FakerMaker
+  class DefinitionProxy
+
+    def initialize factory
+      @factory = factory
+    end
+
+    def method_missing name, *args, &block
+      attribute = FakerMaker::Attribute.new name, *args, block
+      @factory.attach_attribute attribute
+    end
+
+  end
+end

data/lib/faker_maker/factory.rb

@@ -0,0 +1,80 @@
+module FakerMaker
+  class Factory
+    attr_reader :name, :attributes, :class_name, :parent_class, :parent
+
+    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 
+        Object.const_get( FakerMaker[@parent].class_name )
+      else
+         Object
+      end
+    end
+
+    def attach_attribute attribute 
+      @attributes << attribute
+    end
+
+    def build
+      instance = instantiate
+      populate_instance instance
+      yield self if block_given?
+      instance
+    end
+
+    def assemble
+      if @klass.nil?
+        @klass = Class.new @parent_class
+        Object.const_set @class_name, @klass
+        attach_attributes_to_class
+      end
+      @klass
+    end
+
+    def to_json
+      build.to_json
+    end
+
+    def parent?
+      ! @parent.nil?
+    end
+
+    protected 
+
+    def populate_instance instance
+      FakerMaker[parent].populate_instance instance if self.parent?
+      @attributes.each do |attr|
+        value = nil
+        
+        if attr.array?
+          value = Array.new.tap{ |a| attr.cardinality.times{ a << attr.block.call } }
+        else
+          value = attr.block.call
+        end
+
+        instance.send "#{attr.name}=", value
+      end
+    end
+
+    private
+
+    def instantiate
+      assemble.new
+    end
+
+    def attach_attributes_to_class
+      @attributes.each do |attr|
+        @klass.send( :attr_accessor, attr.name )
+      end
+    end
+
+    def assert_valid_options options
+      options.assert_valid_keys :class, :parent
+    end
+  end
+end

data/lib/faker_maker/version.rb

@@ -0,0 +1,3 @@
+module FakerMaker
+  VERSION = "0.6.0"
+end

data/lib/faker_maker.rb

@@ -0,0 +1,40 @@
+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 'faker_maker/base'
+require 'faker_maker/factory'
+require 'faker_maker/definition_proxy'
+require 'faker_maker/attribute'
+
+module FakerMaker
+  extend FakerMaker::Base
+
+  class Error < StandardError; end
+  # Your code goes here...
+
+  module_function
+
+  def register_factory factory
+    factory.assemble
+    factories[factory.name] = factory
+  end
+
+  def factories
+    @factories ||= {}
+  end
+
+  def build name
+    factory = factories[name]
+    raise "No such factory '#{name}'" if factory.nil?
+    factory.build
+  end
+
+  def [] name
+    factories[name]
+  end
+
+end
+
+FM = FakerMaker

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: faker_maker
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Nigel Brookes-Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FakerMaker is a simple fixture generator with a concise and straightforward
+  syntax.
+email:
+- nigel@brookes-thomas.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faker_maker.gemspec
+- lib/.DS_Store
+- lib/faker_maker.rb
+- lib/faker_maker/attribute.rb
+- lib/faker_maker/base.rb
+- lib/faker_maker/definition_proxy.rb
+- lib/faker_maker/factory.rb
+- lib/faker_maker/version.rb
+homepage: https://github.com/BillyRuffian/faker_maker
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/BillyRuffian/faker_maker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: FakerMaker bakes fakes.
+test_files: []