gonzales 0.5.0 → 0.6.0

data/README.md

@@ -2,7 +2,7 @@
 
 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.
+Using Gonzales, reduced my unit-tests time from 1 minute 40 seconds, down to 24 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:
@@ -104,4 +104,41 @@ 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.
 
+## Using speedy with integration tests
+
+If you are using (DatabaseCleaner)[https://github.com/bmabey/database_cleaner], and probably (Capybara)[https://github.com/jnicklas/capybara], when running integration tests, you will probably face some challenges. However, do not despair, you may be able to work around this. Since you do not want to load all your factories in advance, you can let Gonzales load them as you need them. I recomment the following settings in your integration_test_helper file:
+
+``` Ruby
+
+Gonzales.configure do |config|
+  config.disable_preload = true         # ensures that the spoeedy file is not loaded when initializing Gonzales
+  config.adapter = :registered          # ensures factories created are cached as they would be when loaded from speedy file.
+end
+
+module ActionDispatch
+  class IntegrationTest
+    include Capybara::DSL
+    # Stop ActiveRecord from wrapping tests in transactions
+    self.use_transactional_fixtures = false
+    DatabaseCleaner.clean                 # Truncate the database before tests are run the first time
+    Gonzales.initialize!                  # Ensure any cache is cleared before we run the tests
+
+    teardown do
+      DatabaseCleaner.clean               # Truncate the database
+      Capybara.reset_sessions!            # Forget the (simulated) browser state
+      Capybara.use_default_driver         # Revert Capybara.current_driver to Capybara.default_driver
+      Gonzales.initialize!                # Ensure cache is cleared after running each test
+    end
+
+    def capture_and_open_screen
+      tmp = Tempfile.new('capture_and_open_screen')
+      tmp.close
+      system("screencapture -P #{tmp.path}")
+      system("open -a Preview \"file://#{tmp.path}\"")
+    end
+  end
+end
+```
+
+
 Thats all there is to it. Speedy coding!

data/lib/gonzales/adapter/registered.rb

@@ -0,0 +1,37 @@
+# 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 Adapter
+    # = Gonzales::Adapters::Registered
+    #
+    class Registered
+      # Facitity to instantiate factories in database during db:test.
+      # The record will be registered in the collection when created.
+      #
+      def self.create(factory_name, *options)
+        Gonzales::Factories.speedy(factory_name, *options)
+      end
+    end
+  end
+end

data/lib/gonzales/adapter/unregistered.rb

@@ -0,0 +1,37 @@
+# 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 Adapter
+    # = Gonzales::Adapter::Unregistered
+    #
+    class Unregistered
+      # Facitity to instantiate factories in database during db:test.
+      # The record will not be registered in the collection when created.
+      #
+      def self.create(factory_name, *options)
+        Factory.create(factory_name, *options)
+      end
+    end
+  end
+end

data/lib/gonzales/adapter.rb

@@ -0,0 +1,49 @@
+# 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::Adapter
+  #
+  # Adapter for instantiating factories in database
+  module Adapter
+    autoload :Registered,     'gonzales/adapter/registered'
+    autoload :Unregistered,   'gonzales/adapter/unregistered'
+    
+    # Instantiates a record in the database with the defined factory. This is an internal method.
+    #
+    # The method will call either registered or unregistered adapter, depending on what was defined in the use method.
+    #
+    def self.create(factory_name, *options)
+      @@adapter ||= Unregistered
+      @@adapter.create(factory_name, *options)
+    end
+   
+    # Sets the adapter to be used for instantiating objects based on predefioned factories. Internal.
+    #
+    def self.use(name)
+      raise ArgumentError unless %w(registered unregistered).include? name.to_s
+      @@adapter = "#{self}::#{name.to_s.classify}".constantize
+    end
+  end
+end

data/lib/gonzales/collection.rb

@@ -31,6 +31,7 @@ module Gonzales
       # Adds an object (entity) to the collection.
       def add(name, object)
         entities[name] = { :class => object.class.to_s, :id => object.id }
+        object
       end
       
       # Retrieves the collection of entities.
@@ -53,12 +54,18 @@ module Gonzales
         end
       end
       
+      # Clears the cache of objects collected from load or instantiation
+      def clear_cache
+        @@entities = {}
+      end
+      
     private
       def cache_filename #:nodoc:
         @@cache_filename ||= Gonzales.factory_cache || Rails.root.join('tmp', 'speedy.yml')
       end
 
       def load #:nodoc:
+        return {} if Gonzales.disable_preload
         begin
           YAML::load_file cache_filename
         rescue Errno::ENOENT

data/lib/gonzales/factories.rb

@@ -49,6 +49,7 @@ module Gonzales
     
     # Yields a block to define speedy statements, then saves a collection of references to a temporary file
     def self.load(&block)
+      Collection.clear_cache
       ::FactoryGirl.reload
       yield self
       Collection.save

data/lib/gonzales/factory_girl/definition_proxy.rb

@@ -63,11 +63,11 @@ module Gonzales
             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) }) 
+                factory_names.collect { |factory_name| Collection.entity(factory_name) || Adapter.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))
+            r.send("#{attribute}=", Collection.entity(factory_name) || Adapter.create(factory_name, options))
           end
         end
       end

data/lib/gonzales/test_helper.rb

@@ -45,7 +45,7 @@ module Gonzales
     #   end
     #
     def speedy(factory_name, *options)
-      Collection.entity(factory_name) || Factory.create(factory_name, *options)
+      Collection.entity(factory_name) || Adapter.create(factory_name, *options)
     end
   end
 end

data/lib/gonzales/version.rb

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

data/lib/gonzales.rb

@@ -26,26 +26,38 @@ 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+
+  autoload :Adapter,    'gonzales/adapter'
+  autoload :Collection, 'gonzales/collection'
+  autoload :Factories,  'gonzales/factories'
+  autoload :TestHelper, 'gonzales/test_helper'
+
+  include ActiveSupport::Configurable
+  
+  # == Configurations
   #
+  #   * 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+
+  #   * disable_preload - Set to true if you want to disable preload for integration tests. If you are using database_cleaner, you
+  #                       will probably also set this one to true.
+  #   * adapter         - Set to either :registered or :unregistered. When using database_cleaner with integration_tests and you want
+  #                       to reuse associations decleared with speedy, you should set this value to :registered
   # === 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
+  config_accessor :factory_module, :factory_cache, :disable_preload, :adapter
+
+  self.config.class.redefine_method(:adapter=) do |name|
+    Gonzales::Adapter.use name
+  end
+
+  # def self.adapter=(name)
+  #   Adapter.use name
+  # end
   
   # Runs the initialization of Gonzales. Put this in a rake task for your application.
   #
@@ -62,7 +74,11 @@ module Gonzales
   #   end
   #
   def self.initialize!
-    load factory_module || Rails.root.join('test', 'speedy.rb')
+    unless disable_preload
+      load(factory_module || Rails.root.join('test', 'speedy.rb'))
+    else
+      Collection.clear_cache
+    end
   end
 end