makers 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3143ece0f562a4ced85734c5a998a5e8d4dccd07
-  data.tar.gz: ad42645a69354b63eedb3bfd3f9c3c1fda66c84e
+  metadata.gz: 1755d396dc8957e00c67a9444667654b0b4664aa
+  data.tar.gz: 8be1fb5dd093e611a339b498c7167566775efd01
 SHA512:
-  metadata.gz: bdddac354402744691e34740640745827eaf956bbbaa1d23fa6e20ab2ae30551823adc0bc6116be26eda38690633ad65a04baf2793cc75df7f8b6e84793c8297
-  data.tar.gz: 1bb0f2b8e9ca1c561179a7c638a2d2d3d97114f88b2a1658c886a2f5a77f7d78c4d95f2f832c547f5b77d5c0d31de8c274c438cdd11523c3281fb66e2c4bb487
+  metadata.gz: d750ffd12a45749f57e39cc9d05f8caac89bea2f3ce481bbd676a73c9339a4022273985dbeac99507d74fbe6cd6cca76abb1f876246607791a8b16f299caad94
+  data.tar.gz: ba20ae75fc27e14830c1ff4613183f6b5bf6dfd99bf4a489a000a095726dbc3353659ee283345edda24553d4e424295369ea35d25971419962d28d244c28cd7b

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,11 +1,19 @@
 [![Gem Version](https://badge.fury.io/rb/makers.svg)](http://badge.fury.io/rb/makers)
 [![Code Climate](https://codeclimate.com/github/mmontossi/makers/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/makers)
-[![Build Status](https://travis-ci.org/mmontossi/makers.svg](https://travis-ci.org/mmontossi/makers)
+[![Build Status](https://travis-ci.org/mmontossi/makers.svg)](https://travis-ci.org/mmontossi/makers)
 [![Dependency Status](https://gemnasium.com/mmontossi/makers.svg)](https://gemnasium.com/mmontossi/makers)
 
 # Makers
 
-Minimalistic factory inspired in factory_girl for rails.
+Minimalistic factories to replace fixtures in rails.
+
+## Why
+
+I did this gem to add some enhancements to my projects:
+
+- Enforce better practices removing unnecessary options.
+- Avoid the need to use another method to create lists.
+- Quicker syntax to handle associations.
 
 ## Install
 
@@ -21,20 +29,26 @@ $ bundle
 
 ## Configuration
 
-There is no need to configure anything, all this is done automatically for rspec and minitest:
+Generate the configuration file:
+```
+bundle exec rails g makers:install
+```
 
-* Loading the definitions.
-* Replacing the fixtures generators.
-* Including the methods inside your testing framework.
-* Cleaning the database after each test.
+Define makers in test/makers.rb or spec/makers.rb:
+```ruby
+Makers.define do
+  maker :user do
+    name 'example'
+  end
+end
+```
 
 ## Usage
 
 ### Methods
 
-There are three methods available:
+There are two methods available:
 ```ruby
-attributes_for
 build
 create
 ```
@@ -45,100 +59,80 @@ build :user, name: 'other'
 create :category, title: 'other'
 ```
 
-To create lists just pass the desired size as second parameter to build and create methods:
+To create lists just pass the desired size as second parameter:
 ```ruby
 build :user, 2, name: 'other'
 create :category, 5, title: 'other'
 ```
 
-### Makers
-
-Define them in a ruby file inside test/makers or spec/makers folders:
-```ruby
-maker :user do
-  name 'example'
-end
-```
-
 ### Inheritance
 
-Can be declare nested or separated:
+Just concatenate makers:
 ```ruby
-maker :user do
-  name 'example'
-  maker :user_with_email do
-    email 'example@mail.com'
+Makers.define do
+  maker :user do
+    name 'example'
+    maker :user_with_email do
+      email 'example@mail.com'
+    end
   end
 end
-maker :user_with_age, parent: :user do
-  age 9
-end
 ```
 
 ### Sequences
 
-Generates an unique sequence of numbers for the attribute of the maker:
+Generates an unique sequence of numbers for an attribute:
 ```ruby
-maker :user do
-  sequence(:email) { |n| "example#{n}@mail.com" }
-  sequence(:age)
+Makers.define do
+  maker :user do
+    sequence(:email) { |n| "example#{n}@mail.com" }
+    sequence(:phone)
+  end
 end
 ```
 
 ### Associations
 
-Associations are used by name:
+Associations are defined by name or by the association method:
 ```ruby
-maker :user do
-  posts
-  comments 4 # You can customize the number of records
-end
-maker :post do
-  user
-end
-maker :comment do
-  user
+Makers.define do
+  maker :user do
+    posts
+    comments 4, strategy: :create
+  end
+  maker :comment do
+    association :user
+  end
+  maker :post do
+    user
+  end
 end
 ```
 
 ### Aliases
 
-The aliases are important when there is the need of context:
+Aliases can be assigned in the initialization:
 ```ruby
-maker :user, aliases: :author do
-  comments
-end
-maker :post, aliases: :comment do
-  title
-  author
+Makers.define do
+  maker :user, aliases: :author do
+    comments
+  end
+  maker :post, aliases: :comment do
+    title
+    author
+  end
 end
 ```
 
 ### Dependent attributes
 
-If you need to use some logic that depends of another attribute you can use a block or sequence:
-```ruby
-maker :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):
-```ruby
-maker :user do
-  after(:build) { |u| u.name = 'sample' }
-end
-```
-
-You can declare global callbacks in your test or spec helper as well:
+If you need to use some logic that depends of another attribute you can use a block:
 ```ruby
-Makers.configure do
-  after(:create) do |object|
-    log object.errors unless object.valid?
+Makers.define do
+  maker :user do
+    name 'example'
+    email { "#{name}@mail.com" }
+    sequence(:username) { |n| "#{name}-#{n}" }
   end
 end
 ```

data/Rakefile

@@ -4,19 +4,6 @@ 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    = 'Makers'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -26,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

data/lib/generators/makers/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module Makers
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_definitions_file
+        if Dir.exist?(Rails.root.join('spec'))
+          directory = 'spec'
+        else
+          directory = 'test'
+        end
+        template 'definitions.rb', "#{directory}/makers.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/makers/templates/definitions.rb

@@ -0,0 +1,2 @@
+Makers.define do
+end

data/lib/makers.rb

@@ -1,56 +1,29 @@
-require 'makers/callbacks'
+require 'generators/makers/install_generator'
+require 'makers/dsl/maker'
+require 'makers/extensions/active_support/test_case'
 require 'makers/definitions'
-require 'makers/configuration'
 require 'makers/maker'
-require 'makers/sequence'
-require 'makers/fetcher'
 require 'makers/proxy'
-require 'makers/methods'
 require 'makers/railtie'
+require 'makers/version'
 
 module Makers
-  extend Methods
   class << self
 
-    def reset
-      configuration.reset
-      definitions.reset
-    end
-
-    def configure(&block)
-      configuration.instance_eval &block
-    end
-
     def configuration
       @configuration ||= Configuration.new
     end
 
-    def define(&block)
-      definitions.instance_eval &block
+    def configure
+      yield configuration
     end
 
     def definitions
       @definitions ||= Definitions.new
     end
 
-    def clean
-      records.pop.destroy until records.empty?
-    end
-
-    def records
-      @records ||= []
-    end
-
-    def load
-      if path
-        Dir[path.join('**', '*.rb')].each do |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, 'makers')
+    def define(&block)
+      Proxy.new &block
     end
 
   end

data/lib/makers/definitions.rb

@@ -1,42 +1,33 @@
 module Makers
   class Definitions
 
-    def initialize
-      reset
-    end
-
-    def reset
-      @makers = {}
-    end
-
-    def maker(name, options={}, &block)
-      maker = Maker.new(name, options, &block)
-      iterate_names name, options do |name|
-        @makers[name] = maker
-      end
+    def contains?(name)
+      registry.has_key? name
     end
 
     def find(name)
-      @makers[name].tap do |definition|
-        raise "Definition #{name} not found" unless definition
+      if contains?(name)
+        registry[name]
+      else
+        raise "Definition #{name} not found"
       end
     end
 
-    protected
-
-    def iterate_names(name, options)
-      names = [name]
-      if aliases = options[:aliases]
-        case aliases
-        when Array
-          names |= aliases
+    def add(names, *args)
+      maker = Maker.new(*args)
+      names.each do |name|
+        if contains?(name)
+          raise "Maker #{name} already registered"
         else
-          names << aliases
+          registry[name] = maker
         end
       end
-      names.each do |name|
-        yield name
-      end
+    end
+
+    private
+
+    def registry
+      @registry ||= {}
     end
 
   end

data/lib/makers/dsl/maker.rb

@@ -0,0 +1,74 @@
+module Makers
+  module DSL
+    class Maker
+
+      def initialize(name, options={}, &block)
+        @name = name
+        @options = options.reverse_merge(class_name: name.to_s.classify)
+        @class = @options[:class_name].constantize
+        @assignments = {}
+        if block_given?
+          instance_eval &block
+        end
+        Makers.definitions.add(
+          [@name] + Array(@options[:aliases]),
+          @options,
+          @assignments
+        )
+      end
+
+      def maker(name, overrides={}, &block)
+        options = @options.dup
+        options.delete :aliases
+        options.merge! overrides
+        options.merge! parent: @name
+        DSL::Maker.new name, options, &block
+      end
+
+      def sequence(name, &block)
+        index = 0
+        if block_given?
+          @assignments[name] = -> {
+            index += 1
+            instance_exec index, &block
+          }
+        else
+          @assignments[name] = -> {
+            index += 1
+          }
+        end
+      end
+
+      def association(name, *args)
+        options = args.extract_options!
+        name = (options[:maker] || name)
+        strategy = (options[:strategy] || :build)
+        case @class.reflections[name.to_s].macro
+        when :belongs_to,:has_one
+          @assignments[name] = -> {
+            maker = Makers.definitions.find(name)
+            maker.send strategy
+          }
+        when :has_many
+          @assignments[name] = -> {
+            maker = Makers.definitions.find(name.to_s.singularize.to_sym)
+            (args.first || 1).times.map do
+              maker.send strategy
+            end
+          }
+        end
+      end
+
+      def method_missing(name, *args, &block)
+        if @class.reflections.has_key?(name.to_s)
+          association name, *args
+        elsif block_given?
+          @assignments[name] = block
+        elsif args.size > 0
+          @assignments[name] = -> { args.first }
+        end
+      end
+
+    end
+  end
+end