gonzales 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright 2012 Knut I Stenmark, Dynamic Project Management AS
+Copyright 2012 Teknobingo AS
+Copyright 2012 Bingo Entrepenøren AS
+
+
+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,107 @@
+# Gonzales
+
+After struggling with some slow running tests you will probably want to speed them up. Factory girl is somewhat slow, because it will try to create new records in the database before each test is running. Fixtures works much faster but with less flexibility.
+
+Using Gonzales, reduced my unit-tests time from 1 minute 40 seconds, down to 28 seconds.
+
+Well, Gonzales makes the best out of Factory Girl, by allowing you to load the factories into the database before the tests starts. 
+You just have to learn one new keyword - ```speedy```. You will use ```speedy``` for:
+
+   * Saving factories to test database before running tests
+   * Declaring associations in factories
+   * Refering to objects that were saved to test database before tests started
+
+# Install and Setup
+
+Install the gem
+
+    gem install gonzales
+    
+Or, in your Gemfile
+
+    gem 'gonzales'
+    
+## Initializing your factories before the tests are running
+
+Define a file in your test directory called speedy.rb. Enlist all the factories you want to load before tests are running using the ```speedy``` command.
+
+``` Ruby
+# test/speedy.rb
+Gonzales::Factories.load do |go|
+  go.speedy :address
+  go.speedy :organization
+  go.speedy :person
+  go.speedy :john, :person, :name => 'John'
+end
+```
+The latter is creating the alias ```john``` to ```person``` and also changing its ```name``` attribute. This way you can easily customize associations in your factories. 
+
+Then, you will need to initialize Gonzales before you run your tests.
+Add this file to your lib/tasks directory:
+
+``` Ruby
+# lib/tasks/gonzales_tasks.rake
+namespace :db do
+  namespace :test do
+    task :prepare => :environment do
+      # place your seeds here, if you have any
+      Gonzales.initialize!
+    end
+  end
+end
+```
+
+# Important command - speedy
+
+## Loading association with speedy
+
+A model with many associations may be very slow to instantiate. Lets say you have a person that has an address, and the person belongs to an organization with an address; that is four records that needs to be created in the database just for one person. If you need multiple roles in a test, that is the multitude of the number of roles you use in the test. By creating the records in the test database before running the tests, the tests will run much faster.
+
+You will use the keyword ```speedy``` with factory girl to define associations
+
+``` Ruby
+# test/factories.rb
+FactoryGirl.define do
+  
+  factory :organization do
+    name 'Looney tunes'
+    speedy :address
+  end
+
+  factory :person do
+    name 'Sylvester'
+    speedy :organization
+    speedy :address
+  end
+end
+```
+
+```speedy``` is in reality implemented so that if you have defined the association with Factory.create command, it will be preserved. The code:
+
+``` Ruby
+  Factory.create :person, :organization => @organization
+```
+
+In practice the ```speedy``` association command does something like this:
+
+``` Ruby
+  after_build { |r| r.organization = pre_created_organization || Factory.create(:organization) unless r.organization }
+```
+
+## Instantiating a pre-created object defined with factory girl using speedy
+
+In order to fetch an object that has already been pre-created you'll use the ```speedy``` command for that too.
+In your test you will write something like this:
+
+``` Ruby
+class HatTest < ActiveSupport::TestCase
+  setup do
+    @person = speedy :person
+  end
+  ...
+end
+```
+
+If the factory has not been pre-created speedy will just call Factory.create. And of course, if you want to, you can still use Factory.build or Factory.create, but then they will work like traditional FactoryGirl usage.
+
+Thats all there is to it. Speedy coding!

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Gonzales'
+  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/gonzales/collection.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2012 Bingo Entreprenøren AS
+# Copyright (c) 2012 Teknobingo Scandinavia AS
+# Copyright (c) 2012 Knut I. Stenmark
+#
+# 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.
+
+module Gonzales
+  # = Gonzales::Collection
+  #
+  # Holds references to the factories instantiated during db:test:prepare
+  class Collection
+    class << self
+      
+      # Adds an object (entity) to the collection.
+      def add(name, object)
+        entities[name] = { :class => object.class.to_s, :id => object.id }
+      end
+      
+      # Retrieves the collection of entities.
+      # If they are not already loded from the temporary cache map, the map is loaded.
+      def entities
+        @@entities ||= load
+      end
+      
+      # Retrieves a specific object
+      def entity(factory_name)
+        if e = entities[factory_name]
+          e[:class].constantize.find e[:id]
+        end
+      end
+
+      # Save a collection map to temporary file
+      def save #:nodoc:
+        File.open(cache_filename, "w+") do |file|
+          file.write entities.to_yaml
+        end
+      end
+      
+    private
+      def cache_filename #:nodoc:
+        @@cache_filename ||= Gonzales.factory_cache || Rails.root.join('tmp', 'speedy.yml')
+      end
+
+      def load #:nodoc:
+        begin
+          YAML::load_file cache_filename
+        rescue Errno::ENOENT
+          {}
+        end
+      end      
+    end
+  end
+end

data/lib/gonzales/factories.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2012 Bingo Entreprenøren AS
+# Copyright (c) 2012 Teknobingo Scandinavia AS
+# Copyright (c) 2012 Knut I. Stenmark
+#
+# 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.
+
+module Gonzales
+  # = Gonzales::Factories
+  #
+  # Facitity to instantiate factories in database during db:test:prepare
+  class Factories
+    # Save a factory based record to the test database before executing tests
+    #
+    # === Arguments
+    #  * alias_name - optional alias name (can be used to reference factory or associations later)
+    #  * factory_name - the name of the factory (use to reference factory or associations later if alias is not given)
+    #  * options - a hash to be passed to FactoryGirl when creating the record
+    #
+    # === Examples
+    #   Gonzales::Factories.load do |go|
+    #     go.speedy :address
+    #     go.speedy :organization
+    #     go.speedy :john, :person, :name => 'John'
+    #   end
+    #
+    def self.speedy(factory_or_alias_name, *args)
+      alias_name = factory_or_alias_name
+      options = args.extract_options!
+      factory_name = args.first || alias_name
+      Collection.add alias_name, Factory.create(factory_name, options)
+    end
+    
+    # Yields a block to define speedy statements, then saves a collection of references to a temporary file
+    def self.load(&block)
+      ::FactoryGirl.reload
+      yield self
+      Collection.save
+    end
+  end
+end

data/lib/gonzales/factory_girl/definition_proxy.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2012 Bingo Entreprenøren AS
+# Copyright (c) 2012 Teknobingo Scandinavia AS
+# Copyright (c) 2012 Knut I. Stenmark
+#
+# 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.
+
+module Gonzales
+  module FactoryGirl
+    # = Gonzales::FactoryGirl::DefinitionProxy
+    #
+    # Extends FactoryGirl with a new extension
+    module DefinitionProxy
+      # Define an association in a factory.
+      # Supports belongs_to and has_and_belongs_to_many associations
+      #
+      # speedy will assign the association in the following order:
+      #
+      #   #. If you have specified the association then insgtantiating creating or building the factory,
+      #      it will use that association
+      #   #. If the association exists in the database, it will assign that.
+      #   #. Lastly, when none of the above, it will create the factory.
+      #
+      # === Arguments
+      #   
+      #  * association_name - the name of the association
+      #  * factory_name - the name of the factory (if the factory has the same name as the association, this parameter is optional)
+      #  * options - a hash to be passed to FactoryGirl when creating the record using factory
+      #
+      # === Examples
+      #
+      #    FactoryGirl.define do
+      #      factory :organization do
+      #        name "Looney tunes"
+      #        speedy :contact                                      # association to contact (belongs_to :contact), 
+      #               # same as +association :contact+
+      #        speedy :addresses, :street_address, :postal_address  # association to addresses (has_many_and_belongs_to_many :addresses)
+      #               # same as +addresses { |org| [org.association(:street_address), org.association(:postal_address)] }+
+      #      end
+      #    end
+      #
+      def speedy(attribute_or_factory, *args)
+        attribute = attribute_or_factory
+        options = args.extract_options!
+        after_build do |r|
+          if r.class.reflect_on_association(attribute).macro.to_s.include? 'has_and_belongs_to_many'
+            if r.send(attribute).size == 0
+              factory_names = args.size > 0 ? args : [attribute]
+              r.send("#{attribute}=",
+                factory_names.collect { |factory_name| Gonzales::Collection.entity(factory_name) || Factory.create(factory_name, options) }) 
+            end
+          elsif !r.send(attribute)
+            factory_name = args.first || attribute
+            r.send("#{attribute}=", Gonzales::Collection.entity(factory_name) || Factory.create(factory_name, options))
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gonzales/test_helper.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2012 Bingo Entreprenøren AS
+# Copyright (c) 2012 Teknobingo Scandinavia AS
+# Copyright (c) 2012 Knut I. Stenmark
+#
+# 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.
+
+require 'factory_girl'
+module Gonzales
+  # = Gonzales::TestHelper
+  #
+  # Helper to be used when writing tests when you use Gonzales
+  module TestHelper
+    # returns a created record to be used in tests
+    #
+    # speedy will return the record from the database if it alreday exists in the test database.
+    # If not it will call FactoryGirl to instantiate the record.
+    #
+    # === Arguments
+    #
+    #   * factory_name - Name of the factory or the alias specified in the gonzales file
+    #   * options - will be passed to FactoryGirl if the factory does not exist in the test database.
+    #     Note!! options will not be passed to Gonzales. 
+    #
+    # === Example
+    #
+    #   setup do
+    #     @person = speedy :person
+    #   end
+    #
+    def speedy(factory_name, *options)
+      Collection.entity(factory_name) || Factory.create(factory_name, *options)
+    end
+  end
+end

data/lib/gonzales/version.rb

@@ -0,0 +1,3 @@
+module Gonzales
+  VERSION = "0.5.0"
+end

data/lib/gonzales.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2012 Bingo Entreprenøren AS
+# Copyright (c) 2012 Teknobingo Scandinavia AS
+# Copyright (c) 2012 Knut I. Stenmark
+#
+# 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.
+
+require 'active_support/configurable'
+
+module Gonzales
+  # = Gonzales provides a mechanism for speeding up tests when using FactoryGirl
+  #
+  # == Configutations
+  #
+  #   * factory_module - the module containing the definitions of factories to be store in the test database.
+  #                      Defaults to +test/speedy.rb+
+  #   * factory_cache  - the entity lookup yaml-file to store factories that was save to the database when Gonzales.initialize! was run
+  #                      Defaults to +test/speedy.yml+
+  #
+  # === Example 
+  #
+  # Gonzales.configure do |config|
+  #   config.factory_module = Rails.root.join('tmp', 'gonzales.yml')
+  #   config.factory_cache =  Rails.root.join('test', 'speedy.rb')
+  # end
+  
+  autoload :Collection, 'gonzales/collection'
+  autoload :Factories,  'gonzales/factories'
+  autoload :TestHelper, 'gonzales/test_helper'
+  
+  include ActiveSupport::Configurable
+  config_accessor :factory_module, :factory_cache
+  
+  # Runs the initialization of Gonzales. Put this in a rake task for your application.
+  #
+  # === Example
+  #
+  #   # lib/tasks/gonzales_tasks.rake
+  #   namespace :db do
+  #     namespace :test do
+  #       task :prepare => :environment do
+  #         # place your seeds here, if you have any
+  #         Gonzales.initialize!
+  #       end
+  #     end
+  #   end
+  #
+  def self.initialize!
+    load factory_module || Rails.root.join('test', 'speedy.rb')
+  end
+end
+
+require 'gonzales/factory_girl/definition_proxy'
+require 'factory_girl'
+FactoryGirl::DefinitionProxy.send(:include, Gonzales::FactoryGirl::DefinitionProxy)
+ActiveSupport::TestCase.send(:include, Gonzales::TestHelper)

data/lib/tasks/gonzales_tasks.rake

@@ -0,0 +1,7 @@
+namespace :db do
+  namespace :test do
+    task :prepare => :environment do
+      Gonzales.initialize!
+    end
+  end
+end