fabricators 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf4172edafa15e0c0a33f21c7b468a9dc0b174b7
+  data.tar.gz: 9e96fe2c40e58ace973698c3f59ac8cc3822a077
+SHA512:
+  metadata.gz: 53c4e36450a96f6acda28bced824e382a8c45f706d1a83245c2773f0b67e1a59988f25a85392f9822b4074354102a4329b39522cfcb6c7ef1d89edc13634cacf
+  data.tar.gz: 239e928ca1e1a2b3f96be3045a27df12eabce2d385bb942a489f23e0c38c862f55516ac07f5de696cd5d175b843d17c639708992f0b291edb18458353995c69f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Museways
+
+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.rdoc

@@ -0,0 +1,134 @@
+{<img src="https://badge.fury.io/rb/fabricators.png" alt="Gem Version" />}[http://badge.fury.io/rb/fabricators] {<img src="https://codeclimate.com/github/museways/fabricators.png" />}[https://codeclimate.com/github/museways/fabricators] {<img src="https://travis-ci.org/museways/fabricators.png?branch=master" alt="Build Status" />}[https://travis-ci.org/museways/fabricators] {<img src="https://gemnasium.com/museways/fabricators.png" alt="Dependency Status" />}[https://gemnasium.com/museways/fabricators]
+
+= Fabricators
+
+Minimalistic factory alternative inspired in factory_girl.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'fabricators'
+  
+Then bundle:
+  $ bundle  
+
+= Configuration
+
+There is no need to configure the rails application, the gem will do it automatically.
+
+= Usage
+
+== Methods
+
+There are three methods available:
+  Fabricators.attributes_for
+  Fabricators.build
+  Fabricators.create
+
+To not write "Fabricators" every time you can include the methods in your tests:
+  class ActiveSupport::TestCase
+    include Fabricators::Methods
+  end
+
+Then you can you just:
+  attributes_for
+  build
+  create
+
+Is possible to override the defaults passing a hash:
+  build :user, name: 'other'
+  create :category, title: 'other'
+
+To create lists just pass the desired size as second parameter to build and create:
+  build :user, 2, name: 'other'
+  create :category, 5, title: 'other'
+
+== Fabricators
+
+The way you define your fabricators should be very familiar already.
+  Fabricators.define do
+    fabricator :user do
+      name 'example'
+    end
+  end
+
+== Inehritance
+
+Can be declare nested or separate:
+  Fabricators.define do
+    fabricator :user do
+      name 'example'
+      fabricator :user_with_email do
+        email 'example@mail.com'
+      end
+    end
+    fabricator :user_with_age, parent: :user do
+      age 9
+    end
+  end
+
+== Generators
+
+Define them outside your fabricators and use them as attributes:
+  Fabricators.define do
+    generator(:name) { 'example' }
+    generator(:email) { |n| "example#{n}@mail.com" }
+    generator(:age)
+    fabricator :user do
+      name
+      email
+      age
+    end
+  end
+
+== Associations
+
+Associations are declared just by the name of the association:
+  Fabricators.define do
+    fabricator :user do
+      posts
+      comments 4 # By default 1, but can be overwritten
+    end
+    fabricator :post do
+      user
+    end
+    fabricator :comment do
+      user
+    end
+  end
+
+== Aliases
+
+The aliases are essential when there is the need of context:
+  Fabricators.define do
+    generator(:title, aliases: [:first_name, :last_name]) { 'example' }
+    fabricators :user, aliases: :author do
+      first_name
+      last_name
+      comments
+    end
+    fabricators :post, aliases: :comment do
+      title
+      author
+    end
+  end
+
+== Dependent attributes
+
+If you need to use some logic that depends of another attribute you can go:
+  Fabricators.define do
+    fabricators :user do
+      name 'example'
+      email { "#{name}@mail.com" }
+    end
+  end
+
+== Callbacks
+
+The available callbacks are before(:build), before(:create), after(:build) and after(:create):
+  Fabricators.define do
+    before(:build) { |u| u.name = 'global' }
+    fabricator :user do
+      after(:build) { |u| u.name = 'local' }
+    end
+  end

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fabricators'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/fabricators.rb

@@ -0,0 +1,41 @@
+require 'fabricators/callbacks'
+require 'fabricators/definitions'
+require 'fabricators/fabricator'
+require 'fabricators/generator'
+require 'fabricators/reader'
+require 'fabricators/proxy'
+require 'fabricators/methods'
+require 'fabricators/railtie'
+
+module Fabricators
+  extend Methods
+  class << self
+
+    def define(&block)
+      definitions.instance_eval &block
+    end
+
+    def definitions
+      @definitions ||= Definitions.new
+    end
+ 
+    def generate(name)
+      definitions.find(name, :generator).generate
+    end
+
+    def paths
+      @paths ||= %w(test/fabricators spec/fabricators).map { |path| Rails.root.join(path) }
+    end
+
+    def path
+      @path ||= paths.find { |path| Dir.exists? path }
+    end
+
+    def populate
+      Dir[path.join('**', '*.rb')].each do |file|
+        load file
+      end
+    end
+
+  end
+end

data/lib/fabricators/callbacks.rb

@@ -0,0 +1,23 @@
+module Fabricators
+  module Callbacks
+
+    def callbacks
+      @callbacks ||= {}
+    end
+ 
+    %w(after before).each do |moment|
+      define_method moment do |actions, &block|
+        actions = [actions] unless actions.is_a? Array
+        actions.each do |action|
+          name = :"#{moment}_#{action}"
+          if callbacks[name]
+            callbacks[name] << block
+          else
+            callbacks[name] = [block]
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/fabricators/definitions.rb

@@ -0,0 +1,58 @@
+module Fabricators
+  class Definitions
+    include Callbacks
+ 
+    def initialize
+      reset!
+    end
+
+    def reset!
+      @fabricators = {}
+      @generators = {}
+      @callbacks = {}
+    end
+ 
+    def fabricator(name, options={}, &block)
+      fabricator = Fabricator.new(name, options, &block)
+      iterate_names name, options do |name|
+        @fabricators[name] = fabricator
+      end
+    end
+ 
+    def generator(name, first=0, options={}, &block)
+      generator = Generator.new(first, &block)
+      iterate_names name, options do |name|
+        @generators[name] = generator
+      end
+    end
+
+    def find(name, type)
+      case type
+      when :fabricator
+        @fabricators[name]
+      when :generator
+        @generators[name]
+      end.tap do |definition|
+        raise "Definition #{name} of type #{type} not found" unless definition
+      end
+    end
+
+    protected
+
+    def iterate_names(name, options)
+      names = [name]
+      if aliases = options[:aliases]
+        case aliases
+        when Array
+          names |= aliases
+        else
+          names << aliases
+        end
+      end
+      names.each do |name|
+        yield name
+      end
+    end
+
+  end
+end

data/lib/fabricators/fabricator.rb

@@ -0,0 +1,102 @@
+module Fabricators
+  class Fabricator
+
+    attr_reader :options, :proxy
+
+    def initialize(name, options={}, &block)
+      @name = name
+      @options = options
+      @block = block
+      @loaded = false
+      Reader.new(name, options, &block)
+    end
+
+    def parent
+      @parent ||= begin
+        if @options[:parent]
+          Fabricators.definitions.find(@options[:parent], :fabricator)
+        end
+      end
+    end
+
+    def attributes_for(options={})
+      {}.tap do |hash|
+        iterate_attributes(options, proxy) do |name, value|
+          hash[name] = value
+        end
+      end
+    end
+
+    %w(build create).each do |name|
+      define_method name do |*args|
+        options = args.extract_options!
+        single_name = :"#{name}_one"
+        if args.any?
+          [].tap do |list|
+            args.first.times do
+              list << send(single_name, options)
+            end
+          end
+        else
+          send(single_name, options)
+        end
+      end
+    end
+
+    %w(options attributes_for build create).each do |name|
+      define_method :"#{name}_with_load" do |*args|
+        load
+        send :"#{name}_without_load", *args
+      end
+      alias_method_chain name, :load
+    end
+
+    protected
+
+    def load
+      unless @loaded
+        if parent
+          @options = parent.options.merge(@options)
+        end
+        unless @options[:class] ||= @name.to_s.classify.constantize
+          raise "Class not found for fabricator #{@name}"
+        end
+        @proxy = Proxy.new(self, &@block)
+        @loaded = true
+      end
+    end
+
+    def build_one(options={})
+      @options[:class].new.tap do |instance|
+        trigger :before_build, instance
+        iterate_attributes(options, instance) do |name, value|
+          instance.send :"#{name}=", value
+        end
+        trigger :after_build, instance
+      end
+    end
+
+    def create_one(options={})
+      build_one(options).tap do |instance|
+        trigger :before_create, instance
+        instance.save
+        trigger :after_create, instance
+      end
+    end
+
+    def trigger(name, instance)
+      globals = (Fabricators.definitions.callbacks[name] || [])
+      locals = (proxy.callbacks[name] || [])
+      (globals + locals).each do |callback|
+        callback.call instance
+      end
+    end
+
+    def iterate_attributes(options={}, context)
+      proxy.attributes.merge(options).each do |name, value|
+        yield name, (value.is_a?(Proc) ? context.instance_eval(&value) : value)
+      end
+    end
+
+  end
+end

data/lib/fabricators/generator.rb

@@ -0,0 +1,19 @@
+module Fabricators
+  class Generator
+
+    def initialize(starts_at, &block)
+      @index = starts_at
+      @block = block
+    end
+
+    def generate
+      @index += 1
+      if @block
+        @block.call(@index)
+      else
+        @index
+      end
+    end
+
+  end
+end