makers 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf680b76a9d3f14ce6304c691bae71626e5c756c
+  data.tar.gz: 32ee7f30fefad366dc28a0cba8e5fb60785375aa
+SHA512:
+  metadata.gz: 2140702cff87010956af9acbebe1a74c632dd6b5f9f243f1c3064e96741b08d1783fe5d847f304a913b08e6543d39ec465281026fb18b9bfed356f6596a6471b
+  data.tar.gz: 7b54805548f58ad4c9f2075c37f96c62e930f14281910318c796a581b132f06895ccda7e77ee7d87d6749410be9da28109d67f57f5a86bc45e9124e1bf6a0c4b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 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.md

@@ -0,0 +1,149 @@
+[![Gem Version](https://badge.fury.io/rb/makers.svg)](http://badge.fury.io/rb/makers) [![Code Climate](https://codeclimate.com/github/museways/makers/badges/gpa.svg)](https://codeclimate.com/github/museways/makers) [![Build Status](https://travis-ci.org/museways/makers.svg?branch=0.1.0)](https://travis-ci.org/museways/makers) [![Dependency Status](https://gemnasium.com/museways/makers.svg)](https://gemnasium.com/museways/makers)
+
+# Makers
+
+Minimalistic factory inspired in factory_girl for rails.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'makers', group: [:development, :test]
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Configuration
+
+There is no need to configure anything, all this is done automatically for rspec and minitest:
+
+* Loading the definitions.
+* Replacing the fixtures generators.
+* Including the methods inside your testing framework.
+* Cleaning the database after each test.
+
+## Usage
+
+### Methods
+
+There are three methods available:
+```ruby
+attributes_for
+build
+create
+```
+
+Is possible to override the defaults passing a hash:
+```ruby
+build :user, name: 'other'
+create :category, title: 'other'
+```
+
+To create lists just pass the desired size as second parameter to build and create methods:
+```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:
+```ruby
+maker :user do
+  name 'example'
+  maker :user_with_email do
+    email 'example@mail.com'
+  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:
+```ruby
+maker :user do
+  sequence(:email) { |n| "example#{n}@mail.com" }
+  sequence(:age)
+end
+```
+
+### Associations
+
+Associations are used by name:
+```ruby
+maker :user do
+  posts
+  comments 4 # You can customize the number of records
+end
+maker :post do
+  user
+end
+maker :comment do
+  user
+end
+```
+
+### Aliases
+
+The aliases are important when there is the need of context:
+```ruby
+maker :user, aliases: :author do
+  comments
+end
+maker :post, aliases: :comment do
+  title
+  author
+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:
+```ruby
+Makers.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/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    = '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'
+
+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/generators/makers/model/model_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/named_base'
+
+module Makers
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_fixture_file
+        template 'maker.rb', Makers.path.join("#{table_name}.rb")
+      end
+
+    end
+  end
+end

data/lib/generators/makers/model/templates/maker.rb

@@ -0,0 +1,2 @@
+maker :<%= singular_table_name %> do
+end

data/lib/makers.rb

@@ -0,0 +1,57 @@
+require 'makers/callbacks'
+require 'makers/definitions'
+require 'makers/configuration'
+require 'makers/maker'
+require 'makers/sequence'
+require 'makers/fetcher'
+require 'makers/proxy'
+require 'makers/methods'
+require 'makers/railtie'
+
+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
+    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')
+    end
+
+  end
+end

data/lib/makers/callbacks.rb

@@ -0,0 +1,23 @@
+module Makers
+  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/makers/configuration.rb

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

data/lib/makers/definitions.rb

@@ -0,0 +1,43 @@
+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
+    end
+
+    def find(name)
+      @makers[name].tap do |definition|
+        raise "Definition #{name} 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/makers/fetcher.rb

@@ -0,0 +1,18 @@
+module Makers
+  class Fetcher
+
+    def initialize(name, options, &block)
+      @name = name
+      @options = options
+      instance_eval &block
+    end
+
+    def maker(name, options={}, &block)
+      Makers.definitions.maker name, @options.merge(options.merge(parent: @name)), &block
+    end
+
+    def method_missing(name, *args, &block)
+    end
+
+  end
+end

data/lib/makers/maker.rb

@@ -0,0 +1,113 @@
+module Makers
+  class Maker
+
+    attr_reader :options, :proxy
+
+    def initialize(name, options={}, &block)
+      @name = name
+      @options = options
+      @block = block
+      @loaded = false
+      Fetcher.new(name, options, &block)
+    end
+
+    def parent
+      @parent ||= begin
+        if @options[:parent]
+          Makers.definitions.find(@options[:parent])
+        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 maker #{@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
+        if instance.save
+          Makers.records << instance
+        end
+        trigger :after_create, instance
+      end
+    end
+
+    def trigger(name, instance)
+      globals = (Makers.configuration.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|
+        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
+
+  end
+end