myronmarston-factory_data_preloader 0.3.2 → 0.4.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 3
-:patch: 2
+:minor: 4
+:patch: 0

data/lib/factory_data_preloader/factory_data.rb

@@ -17,7 +17,7 @@ module FactoryDataPreloader
       attr_accessor :definition_file_paths
 
       def preload(model_type, options = {}, &proc)
-        raise PreloaderAlreadyDefinedError.new, "You have already defined the preloader for #{model_type.to_s}" if PreloaderCollection.instance.map(&:model_type).include?(model_type)
+        raise PreloaderAlreadyDefinedError.new, "You have already defined the preloader for #{model_type.to_s}" if AllPreloaders.instance.map(&:model_type).include?(model_type)
 
         model_class = options[:model_class] || model_type.to_s.singularize.classify.constantize
         depends_on = [options[:depends_on]].compact.flatten
@@ -35,7 +35,7 @@ module FactoryDataPreloader
         return unless @@preloaded_data_deleted.nil?
 
         # Delete them in the reverse order of the dependencies, to handle foreign keys
-        PreloaderCollection.instance.dependency_order.reverse.each do |preloader|
+        FactoryDataPreloader.requested_preloaders.reverse.each do |preloader|
           preloader.model_class.delete_all
         end
 
@@ -46,7 +46,7 @@ module FactoryDataPreloader
         return unless @@preloaded_cache.nil? # make sure the data is only preloaded once.
         @@preloaded_cache = {}
 
-        PreloaderCollection.instance.dependency_order.each do |preloader|
+        FactoryDataPreloader.requested_preloaders.dependency_order.each do |preloader|
           cache = @@preloaded_cache[preloader.model_type] ||= {}
           preloader.data.each do |key, record|
             if record.new_record? && !record.save

data/lib/factory_data_preloader/preloader.rb

@@ -1,49 +1,61 @@
 module FactoryDataPreloader
   class PreloaderNotDefinedError < StandardError; end
 
+  mattr_accessor :preload_all
+  self.preload_all = true
+
+  mattr_accessor :preload_types
+  self.preload_types = []
+
+  class << self
+    alias :preload_all? :preload_all
+
+    def requested_preloaders
+      @requested_preloaders ||= begin
+        if preload_all?
+          AllPreloaders.instance
+        else
+          preloaders = self.preload_types.collect { |type| AllPreloaders.instance.from_symbol(type) }
+          preloaders += (preloaders.collect { |p| p.all_dependencies }).flatten
+          preloaders.uniq!
+          PreloaderCollection.new(preloaders)
+        end
+      end
+    end
+  end
+
   class Preloader
     attr_accessor :model_type, :model_class, :proc, :depends_on
 
     def initialize(model_type, model_class, proc, depends_on)
       @model_type, @model_class, @proc, @depends_on = model_type, model_class, proc, depends_on || []
-      PreloaderCollection.instance << self
+      AllPreloaders.instance << self
     end
 
     def data
       @data ||= begin
-        data = {}
-        self.proc.try(:call, data)
+        data = PreloaderDataHash.new
+        print "Preloading #{model_type}:"
+        benchmark_measurement = Benchmark.measure { self.proc.try(:call, data) }
+        print "(#{format('%.3f', benchmark_measurement.real)} secs)\n"
         data
       end
     end
 
     def dependencies
-      @dependencies ||= begin
-        self.depends_on.collect do |dependency|
-          preloader = PreloaderCollection.instance.detect { |p| p.model_type == dependency }
-          raise PreloaderNotDefinedError, "The preloader for :#{dependency} has not been defined." unless preloader
-          preloader
-        end
-      end
+      @dependencies ||= self.depends_on.collect { |dependency| AllPreloaders.instance.from_symbol(dependency) }
     end
-  end
 
-  class PreloaderCollection < Array
-    include Singleton
-
-    def dependency_order
-      unordered_preloaders = Array.new(self) # rather than using self.dup since singleton doesn't allow duping.
-      ordered_preloaders = []
-
-      until unordered_preloaders.empty?
-        unordered_preloaders.each do |preloader|
-          if preloader.dependencies.all? { |dependency| ordered_preloaders.include?(dependency) }
-            ordered_preloaders << unordered_preloaders.delete(preloader)
-          end
-        end
-      end
+    def all_dependencies
+      @all_dependencies ||= (self.dependencies + (self.dependencies.collect { |d| d.all_dependencies }).flatten).uniq
+    end
+  end
 
-      ordered_preloaders
+  class PreloaderDataHash < Hash
+    def []=(key, value)
+      print "."
+      super
     end
   end
+
 end

data/lib/factory_data_preloader/preloader_collection.rb

@@ -0,0 +1,30 @@
+module FactoryDataPreloader
+  class PreloaderCollection < Array
+    def dependency_order
+      unordered_preloaders = Array.new(self) # rather than using self.dup since singleton doesn't allow duping.
+      ordered_preloaders = []
+
+      until unordered_preloaders.empty?
+        unordered_preloaders.each do |preloader|
+          if preloader.dependencies.all? { |dependency| ordered_preloaders.include?(dependency) }
+            ordered_preloaders << unordered_preloaders.delete(preloader)
+          end
+        end
+      end
+
+      ordered_preloaders
+    end
+
+    def from_symbol(symbol)
+      unless preloader = self.detect { |p| p.model_type == symbol }
+        raise PreloaderNotDefinedError, "The preloader for :#{symbol} has not been defined."
+      end
+      preloader
+    end
+  end
+
+  class AllPreloaders < PreloaderCollection
+    include Singleton
+  end
+
+end

data/lib/factory_data_preloader/rails_core_ext.rb

@@ -30,4 +30,10 @@ class Fixtures
   end
   
   alias_method_chain :delete_existing_fixtures, :preloaded_factory_data
+end
+
+class ActiveSupport::TestCase
+  def self.preload_factory_data(*types)
+    types.each { |t| FactoryDataPreloader.preload_types << t }
+  end
 end

data/lib/factory_data_preloader.rb

@@ -13,6 +13,7 @@ require 'active_record/fixtures'
 
 require 'factory_data_preloader/core_ext'
 require 'factory_data_preloader/preloader'
+require 'factory_data_preloader/preloader_collection'
 require 'factory_data_preloader/factory_data'
 require 'factory_data_preloader/rails_core_ext'
 

data/test/factory_data_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class FactoryDataTest < Test::Unit::TestCase  
   def setup
-    FactoryData.reset!
+    FactoryDataPreloader.reset!
   end
   
   context 'Calling FactoryData.preload(:users)' do

data/test/preloader_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class PreloaderTest < Test::Unit::TestCase
   def setup
-    FactoryDataPreloader::PreloaderCollection.instance.clear
+    FactoryDataPreloader.reset!
   end
 
   context 'A new preloader' do
@@ -21,7 +21,7 @@ class PreloaderTest < Test::Unit::TestCase
     end
 
     should 'be automatically added to the PreloaderCollection' do
-      assert_equal [@preloader], FactoryDataPreloader::PreloaderCollection.instance
+      assert_equal [@preloader], FactoryDataPreloader::AllPreloaders.instance
     end
   end
 
@@ -59,7 +59,44 @@ class PreloaderTest < Test::Unit::TestCase
 
     should 'sort correctly for PreloaderCollection.instance.dependency_order' do
       expected = [@ip_addresses, @users, @posts, @post_images, @post_image_ratings]
-      assert_equal expected.map(&:model_type), FactoryDataPreloader::PreloaderCollection.instance.dependency_order.map(&:model_type)
+      assert_equal expected.map(&:model_type), FactoryDataPreloader::AllPreloaders.instance.dependency_order.map(&:model_type)
+    end
+
+    should 'return the correct preloader objects for #all_dependencies' do
+      assert_same_elements [@post_images, @posts, @users], @post_image_ratings.all_dependencies
+      assert_same_elements [@posts, @users], @post_images.all_dependencies
+      assert_same_elements [], @ip_addresses.all_dependencies
+      assert_same_elements [@users], @posts.all_dependencies
+      assert_same_elements [], @users.all_dependencies
+    end
+
+    context 'when FactoryDataPreloader.preload_all = true' do
+      setup do
+        FactoryDataPreloader.preload_all = true
+      end
+
+      should 'return all preloaders for FactoryDataPreloader.requested_preloaders' do
+        expected = [@ip_addresses, @users, @posts, @post_images, @post_image_ratings]
+        assert_equal expected.map(&:model_type), FactoryDataPreloader.requested_preloaders.dependency_order.map(&:model_type)
+      end
+    end
+
+    context 'when FactoryDataPreloader.preload_all = false' do
+      setup do
+        FactoryDataPreloader.preload_all = false
+      end
+
+      should 'return no preloaders when for FactoryDataPreloader.requested_preloaders when preload_types is empty' do
+        assert_equal [], FactoryDataPreloader.preload_types
+        assert_equal [], FactoryDataPreloader.requested_preloaders
+      end
+
+      should 'return just the requested preloaders for FactoryDataPreloader.requested_preloaders' do
+        FactoryDataPreloader.preload_types << :post_images
+        FactoryDataPreloader.preload_types << :ip_addresses
+        expected = [@ip_addresses, @users, @posts, @post_images]
+        assert_equal expected.map(&:model_type), FactoryDataPreloader.requested_preloaders.dependency_order.map(&:model_type)
+      end
     end
   end
 end

data/test/test_helper.rb

@@ -38,23 +38,32 @@ module OutputCapturer
   end
 end
 
-class FactoryDataPreloader::FactoryData
-  # helper method to reset the factory data between test runs.
+module FactoryDataPreloader
   def self.reset!
-    FactoryDataPreloader::PreloaderCollection.instance.dependency_order.reverse.each do |preloader|
-      class << self; self; end.class_eval do
-        remove_method(preloader.model_type)
-      end
+    self.preload_all = true
+    self.preload_types = []
+    @requested_preloaders = nil
+    FactoryData.reset!
+  end
+
+  class FactoryData
+    # helper method to reset the factory data between test runs.
+    def self.reset!
+      FactoryDataPreloader::AllPreloaders.instance.each do |preloader|
+        class << self; self; end.class_eval do
+          remove_method(preloader.model_type) if method_defined?(preloader.model_type)
+        end
 
-      unless @@preloaded_cache.nil?
-        preloader.model_class.delete_all(:id => (@@preloaded_cache[preloader.model_type] || {}).values)
+        unless @@preloaded_cache.nil?
+          preloader.model_class.delete_all(:id => (@@preloaded_cache[preloader.model_type] || {}).values)
+        end
       end
-    end
 
-    @@preloaded_cache = nil
-    @@preloaded_data_deleted = nil
-    @@single_test_cache = {}
-    FactoryDataPreloader::PreloaderCollection.instance.clear
+      @@preloaded_cache = nil
+      @@preloaded_data_deleted = nil
+      @@single_test_cache = {}
+      FactoryDataPreloader::AllPreloaders.instance.clear
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: myronmarston-factory_data_preloader
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Myron Marston
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-07 00:00:00 -07:00
+date: 2009-06-01 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ files:
 - lib/factory_data_preloader/core_ext.rb
 - lib/factory_data_preloader/factory_data.rb
 - lib/factory_data_preloader/preloader.rb
+- lib/factory_data_preloader/preloader_collection.rb
 - lib/factory_data_preloader/rails_core_ext.rb
 - lib/factory_data_preloader.rb
 - test/factory_data_test.rb