fabricators 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaa3e7a3fadb7a11032d347388fb0ee8e2bc51fc
-  data.tar.gz: b82cd8864420212b0ec69ed10dcee10553ebb468
+  metadata.gz: 4be64faca5c2c0d4113a421b3209ea9d9e201b1b
+  data.tar.gz: 3a91647becc2ebe494bdcaadda4c6710acebf736
 SHA512:
-  metadata.gz: 60f13c2519e2a42553657c65190a2bc7dbaf9494839d270b1ffa9f07190f9f7aedbb634895545764440a330ed14af35e987198dc7f45c44bc089bd09e0a59b74
-  data.tar.gz: af6f469463db9c2babb7b038418b9d85ada22d0af24ff66ca95d0628306355486d1cab8405c8f2f6f00aca3bd9c9278a7c84f077f8ee1a4dafe5ddc937584199
+  metadata.gz: 3be1d8f754cb2fca13a5e44b4556532f0c443090a38d11b180fc38e8320ed216d61c7f77be6b1d0934ef4a67a2a65b88275d78aa1a2cf0b5f52ee37c5f15642c
+  data.tar.gz: 4e0c5a835598acdb78962f3034c617f6a1c7f7d7e556097a34a249d75fa31ad48e2794188efb1db1058e2caf180607712836f091ac757f6ab8588627b3247599

data/README.rdoc

@@ -1,24 +1,24 @@
-=== NOTE: From version 0.0.2 the syntax has been simplified.
+=== NOTE: Important changes in version 0.1.0, read below.
 
 ---
 
-{<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]
+{<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]
 
 = Fabricators
 
-Minimalistic factory alternative inspired in factory_girl.
+Minimalistic factory inspired in factory_girl for rails.
 
 = Install
 
 Put this line in your Gemfile:
-  gem 'fabricators'
-  
+  gem 'fabricators', group: [:development, :test]
+
 Then bundle:
-  $ bundle  
+  $ bundle
 
 = Configuration
 
-There is no need to configure anything, all is done automatically:
+There is no need to configure anything, all this is done automatically for rspec and minitest:
 
 - Loading the definitions.
 - Replacing the fixtures generators.
@@ -38,13 +38,13 @@ 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:
+To create lists just pass the desired size as second parameter to build and create methods:
   build :user, 2, name: 'other'
   create :category, 5, title: 'other'
 
 == Fabricators
 
-Define them inside test/fabricators or spec/fabricators:
+Define them in a ruby file inside test/fabricators or spec/fabricators folders:
   fabricator :user do
     name 'example'
   end
@@ -62,24 +62,20 @@ Can be declare nested or separated:
     age 9
   end
 
-== Attributes
+== Sequences
 
-Define them outside your fabricators and reference them by name:
-  attribute(:name) { 'example' }
-  attribute(:email) { |n| "example#{n}@mail.com" }
-  attribute(:age)
+Generates an unique sequence of numbers for the attribute of the fabricator:
   fabricator :user do
-    name
-    email
-    age
+    sequence(:email) { |n| "example#{n}@mail.com" }
+    sequence(:age)
   end
 
 == Associations
 
-Associations are declared just by the name of the association:
+Associations are used by name:
   fabricator :user do
     posts
-    comments 4 # By default 1, but can be overwritten
+    comments 4 # You can customize the number of records
   end
   fabricator :post do
     user
@@ -90,11 +86,8 @@ Associations are declared just by the name of the association:
 
 == Aliases
 
-The aliases are essential when there is the need of context:
-  attribute(:title, aliases: [:first_name, :last_name]) { 'example' }
+The aliases are important when there is the need of context:
   fabricators :user, aliases: :author do
-    first_name
-    last_name
     comments
   end
   fabricators :post, aliases: :comment do
@@ -104,16 +97,31 @@ The aliases are essential when there is the need of context:
 
 == Dependent attributes
 
-If you need to use some logic that depends of another attribute you can go:
+If you need to use some logic that depends of another attribute you can use a block or sequence:
   fabricators :user do
     name 'example'
     email { "#{name}@mail.com" }
+    sequence(:username) { |n| "#{name}-#{n}" }
   end
 
 == Callbacks
 
 The available callbacks are before(:build), before(:create), after(:build) and after(:create):
-  before(:build) { |u| u.name = 'global' }
   fabricator :user do
-    after(:build) { |u| u.name = 'local' }
+    after(:build) { |u| u.name = 'sample' }
+  end
+
+You can declare global callbacks in your test or spec helper as well:
+  Fabricators.configure do
+    after(:create) do |object|
+      log object.errors unless object.valid?
+    end
   end
+
+= Credits
+
+This gem is maintained and funded by museways[http://museways.com].
+
+= License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/fabricators.rb

@@ -1,8 +1,9 @@
 require 'fabricators/callbacks'
 require 'fabricators/definitions'
+require 'fabricators/configuration'
 require 'fabricators/fabricator'
-require 'fabricators/attribute'
-require 'fabricators/reader'
+require 'fabricators/sequence'
+require 'fabricators/fetcher'
 require 'fabricators/proxy'
 require 'fabricators/methods'
 require 'fabricators/railtie'
@@ -11,33 +12,46 @@ module Fabricators
   extend Methods
   class << self
 
-    def define(&block)
-      definitions.instance_eval &block
+    def reset
+      configuration.reset
+      definitions.reset
     end
 
-    def clean
-      records.pop.destroy until records.empty?
+    def configure(&block)
+      configuration.instance_eval &block
     end
 
-    def records
-      @records ||= []
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def define(&block)
+      definitions.instance_eval &block
     end
 
     def definitions
       @definitions ||= Definitions.new
     end
 
-    def path
-      @path ||= %w(test spec).map{ |dir| Rails.root.join(dir) }.find{ |path| Dir.exist?(path) }.try(:join, 'fabricators')
+    def clean
+      records.pop.destroy until records.empty?
     end
 
-    def load_files
+    def records
+      @records ||= []
+    end
+
+    def load
       if path
         Dir[path.join('**', '*.rb')].each do |file|
-          Fabricators.definitions.instance_eval File.read(file)
+          definitions.instance_eval File.read(file)
         end
       end
     end
 
+    def path
+      @path ||= %w(test spec).map{ |dir| Rails.root.join(dir) }.find{ |path| Dir.exist?(path) }.try(:join, 'fabricators')
+    end
+
   end
 end

data/lib/fabricators/callbacks.rb

@@ -4,7 +4,7 @@ module Fabricators
     def callbacks
       @callbacks ||= {}
     end
- 
+
     %w(after before).each do |moment|
       define_method moment do |actions, &block|
         actions = [actions] unless actions.is_a? Array

data/lib/fabricators/configuration.rb

@@ -0,0 +1,10 @@
+module Fabricators
+  class Configuration
+    include Callbacks
+
+    def reset
+      @callbacks = {}
+    end
+
+  end
+end

data/lib/fabricators/definitions.rb

@@ -1,39 +1,24 @@
 module Fabricators
   class Definitions
-    include Callbacks
- 
+
     def initialize
       reset
     end
 
     def reset
       @fabricators = {}
-      @attributes = {}
-      @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 attribute(name, options={}, &block)
-      attribute = Attribute.new(&block)
-      iterate_names name, options do |name|
-        @attributes[name] = attribute
-      end
-    end
 
-    def find(name, type)
-      case type
-      when :fabricator
-        @fabricators[name]
-      when :attribute
-        @attributes[name]
-      end.tap do |definition|
-        raise "Definition #{name} of type #{type} not found" unless definition
+    def find(name)
+      @fabricators[name].tap do |definition|
+        raise "Definition #{name} not found" unless definition
       end
     end
 

data/lib/fabricators/fabricator.rb

@@ -8,13 +8,13 @@ module Fabricators
       @options = options
       @block = block
       @loaded = false
-      Reader.new(name, options, &block)
+      Fetcher.new(name, options, &block)
     end
 
     def parent
       @parent ||= begin
         if @options[:parent]
-          Fabricators.definitions.find(@options[:parent], :fabricator)
+          Fabricators.definitions.find(@options[:parent])
         end
       end
     end
@@ -87,7 +87,7 @@ module Fabricators
     end
 
     def trigger(name, instance)
-      globals = (Fabricators.definitions.callbacks[name] || [])
+      globals = (Fabricators.configuration.callbacks[name] || [])
       locals = (proxy.callbacks[name] || [])
       (globals + locals).each do |callback|
         callback.call instance
@@ -96,7 +96,16 @@ module Fabricators
 
     def iterate_attributes(options={}, context)
       proxy.attributes.merge(options).each do |name, value|
-        yield name, (value.is_a?(Proc) ? context.instance_eval(&value) : value)
+        case value
+        when Proc
+          context.instance_eval &value
+        when Sequence
+          value.generate context
+        else
+          value
+        end.tap do |value|
+          yield name, value
+        end
       end
     end
 

data/lib/fabricators/{reader.rb → fetcher.rb}

@@ -1,12 +1,12 @@
 module Fabricators
-  class Reader
+  class Fetcher
 
     def initialize(name, options, &block)
       @name = name
       @options = options
       instance_eval &block
     end
-    
+
     def fabricator(name, options={}, &block)
       Fabricators.definitions.fabricator name, @options.merge(options.merge(parent: @name)), &block
     end

data/lib/fabricators/methods.rb

@@ -3,7 +3,7 @@ module Fabricators
 
     %w(build create attributes_for).each do |method|
       define_method method do |name, *args|
-        Fabricators.definitions.find(name, :fabricator).send(method, *args)
+        Fabricators.definitions.find(name).send(method, *args)
       end
     end
 

data/lib/fabricators/proxy.rb

@@ -5,6 +5,7 @@ module Fabricators
     def initialize(fabricator, &block)
       @fabricator = fabricator
       @attributes = []
+      @sequences = {}
       instance_eval &block
     end
 
@@ -19,18 +20,24 @@ module Fabricators
       end
     end
 
+    def sequence(name, &block)
+      @attributes << name
+      @sequences[name] = Sequence.new(&block)
+      class_eval do
+        define_method(name) { @sequences[name] }
+      end
+    end
+
     def method_missing(name, *args, &block)
       unless name == :fabricator
         options = args.extract_options!
         strategy = options.delete(:strategy) || :build
         if block_given?
           logic = block
-        elsif fabricator = Fabricators.definitions.find(name, :fabricator) rescue nil
+        elsif fabricator = Fabricators.definitions.find(name) rescue nil
           logic = -> { fabricator.send(strategy, options) }
-        elsif fabricator = Fabricators.definitions.find(name.to_s.singularize.to_sym, :fabricator) rescue nil
+        elsif fabricator = Fabricators.definitions.find(name.to_s.singularize.to_sym) rescue nil
           logic = -> { fabricator.send(strategy, (args.first || 1), options) }
-        elsif attribute = Fabricators.definitions.find(name, :attribute) rescue nil
-          logic = -> { attribute.generate }
         elsif args.any?
           logic = -> { args.first }
         end
@@ -40,6 +47,6 @@ module Fabricators
         end
       end
     end
- 
+
   end
 end

data/lib/fabricators/railtie.rb

@@ -26,7 +26,7 @@ module Fabricators
     end
 
     config.after_initialize do
-      Fabricators.load_files
+      Fabricators.load
     end
 
   end

data/lib/fabricators/{attribute.rb → sequence.rb}

@@ -1,15 +1,15 @@
 module Fabricators
-  class Attribute
+  class Sequence
 
     def initialize(&block)
       @index = 0
       @block = block
     end
 
-    def generate
+    def generate(context)
       @index += 1
       if @block
-        @block.call(@index)
+        context.instance_exec @index, &@block
       else
         @index
       end

data/lib/fabricators/version.rb

@@ -1,5 +1,5 @@
 module Fabricators
 
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 
 end

data/test/aliases_test.rb

@@ -4,7 +4,6 @@ class AliasesTest < ActiveSupport::TestCase
 
   setup do
     Fabricators.define do
-      attribute(:mobile, aliases: :phone)
       fabricator :user, aliases: [:owner, :author] do
         name 'name'
         phone
@@ -12,15 +11,10 @@ class AliasesTest < ActiveSupport::TestCase
     end
   end
 
-  test "generator aliases" do
-    assert_kind_of Fabricators::Attribute, Fabricators.definitions.find(:mobile, :attribute)
-    assert_kind_of Fabricators::Attribute, Fabricators.definitions.find(:phone, :attribute)
-  end
-
-  test "fabricator aliases" do
-    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:user, :fabricator)
-    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:owner, :fabricator)
-    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:author, :fabricator)
+  test "aliases" do
+    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:user)
+    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:owner)
+    assert_kind_of Fabricators::Fabricator, Fabricators.definitions.find(:author)
   end
 
 end