myronmarston-factory_data_preloader 0.3.1 → 0.3.2

data/VERSION.yml

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

data/lib/factory_data_preloader/factory_data.rb

@@ -8,21 +8,20 @@ module FactoryDataPreloader
     @@preloaded_cache = nil
     @@preloaded_data_deleted = nil
     @@single_test_cache = {}
-    @@preloaders = []
-  
+
     class << self
       # An Array of strings specifying locations that should be searched for
       # factory_data definitions. By default, factory_data_preloader will attempt to require
       # "factory_data," "test/factory_data," and "spec/factory_data." Only the first
       # existing file will be loaded.
       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 @@preloaders.map(&:model_type).include?(model_type)
-      
+        raise PreloaderAlreadyDefinedError.new, "You have already defined the preloader for #{model_type.to_s}" if PreloaderCollection.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
-        @@preloaders << FactoryDataPreloader::Preloader.new(model_type, model_class, proc, @@preloaders.size, depends_on)
+        FactoryDataPreloader::Preloader.new(model_type, model_class, proc, depends_on)
 
         class << self; self; end.class_eval do
           define_method model_type do |key|
@@ -34,21 +33,20 @@ module FactoryDataPreloader
       def delete_preload_data!
         # make sure this only runs once...
         return unless @@preloaded_data_deleted.nil?
-    
-        # the preloaders are listed in the parent -> child table order,
-        # so we need to delete them in reverse.
-        @@preloaders.sort.reverse.each do |preloader|
+
+        # Delete them in the reverse order of the dependencies, to handle foreign keys
+        PreloaderCollection.instance.dependency_order.reverse.each do |preloader|
           preloader.model_class.delete_all
         end
-    
+
         @@preloaded_data_deleted = true
       end
 
       def preload_data!
         return unless @@preloaded_cache.nil? # make sure the data is only preloaded once.
         @@preloaded_cache = {}
-    
-        @@preloaders.sort.each do |preloader|
+
+        PreloaderCollection.instance.dependency_order.each do |preloader|
           cache = @@preloaded_cache[preloader.model_type] ||= {}
           preloader.data.each do |key, record|
             if record.new_record? && !record.save
@@ -57,16 +55,16 @@ module FactoryDataPreloader
               puts "\n\n"
               next
             end
-        
+
             cache[key] = record.id
           end
         end
       end
-  
+
       def reset_cache!
         @@single_test_cache = {}
       end
-      
+
       def find_definitions
         definition_file_paths.each do |path|
           require("#{path}.rb") if File.exists?("#{path}.rb")
@@ -89,7 +87,7 @@ module FactoryDataPreloader
           record
         end
       end
-    
+
       # Borrowed from shoulda: http://github.com/thoughtbot/shoulda/blob/e02228d45a879ff92cb72b84f5fccc6a5f856a65/lib/shoulda/active_record/helpers.rb#L4-9
       def pretty_error_messages(obj)
         obj.errors.map do |a, m|
@@ -98,7 +96,7 @@ module FactoryDataPreloader
         end
       end
     end
-    
+
     self.definition_file_paths = %w(factory_data test/factory_data spec/factory_data)
   end
 end

data/lib/factory_data_preloader/preloader.rb

@@ -1,11 +1,14 @@
 module FactoryDataPreloader
+  class PreloaderNotDefinedError < StandardError; end
+
   class Preloader
-    attr_accessor :model_type, :model_class, :proc, :defined_index, :depends_on
-  
-    def initialize(model_type, model_class, proc, defined_index, depends_on)
-      @model_type, @model_class, @proc, @defined_index, @depends_on = model_type, model_class, proc, defined_index, depends_on || []
+    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
     end
-  
+
     def data
       @data ||= begin
         data = {}
@@ -13,15 +16,34 @@ module FactoryDataPreloader
         data
       end
     end
-    
-    def <=>(preloader)
-      if self.depends_on.include?(preloader.model_type)
-        1
-      elsif preloader.depends_on.include?(self.model_type)
-        -1
-      else
-        self.defined_index <=> preloader.defined_index
+
+    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
     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
+
+      ordered_preloaders
+    end
+  end
 end

data/test/lib/models.rb

@@ -6,9 +6,23 @@ end
 
 class Post < ActiveRecord::Base
   belongs_to :user
+  has_many   :comments
+  has_many   :post_images
 end
 
 class Comment < ActiveRecord::Base
   belongs_to :post
   belongs_to :user
+end
+
+class PostImage < ActiveRecord::Base
+  belongs_to :post
+  has_many   :post_image_ratings
+end
+
+class PostImageRating < ActiveRecord::Base
+  belongs_to :post_image
+end
+
+class IpAddress < ActiveRecord::Base
 end

data/test/lib/schema.rb

@@ -24,4 +24,25 @@ OutputCapturer.capture do
       t.timestamps
     end
   end
+
+  ActiveRecord::Schema.define do
+    create_table :post_images, :force => true do |t|
+      t.references :post
+      t.timestamps
+    end
+  end
+
+  ActiveRecord::Schema.define do
+    create_table :post_image_ratings, :force => true do |t|
+      t.references :post_image
+      t.timestamps
+    end
+  end
+
+  ActiveRecord::Schema.define do
+    create_table :ip_addresses, :force => true do |t|
+      t.string     :ip_address
+      t.timestamps
+    end
+  end
 end

data/test/preloader_test.rb

@@ -1,43 +1,65 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class FactoryDataTest < Test::Unit::TestCase
+class PreloaderTest < Test::Unit::TestCase
+  def setup
+    FactoryDataPreloader::PreloaderCollection.instance.clear
+  end
+
   context 'A new preloader' do
     setup do
-      proc = lambda { |data| 
+      proc = lambda { |data|
         data[:thom] = User.create(:first_name => 'Thom', :last_name => 'York')
         data[:john] = User.create(:first_name => 'John', :last_name => 'Doe')
       }
-      @preloader = FactoryDataPreloader::Preloader.new(:users, User, proc, 0, [])
+      @preloader = FactoryDataPreloader::Preloader.new(:users, User, proc, [])
     end
-    
+
     should 'return the preloaded data for #data' do
       data = @preloader.data
       assert_equal 'York', data[:thom].last_name
       assert_equal 'Doe',  data[:john].last_name
     end
+
+    should 'be automatically added to the PreloaderCollection' do
+      assert_equal [@preloader], FactoryDataPreloader::PreloaderCollection.instance
+    end
   end
-  
-  context 'Post and user preloaders, where post depends on users' do
+
+  context 'A preloader with dependencies' do
     setup do
-      @posts = FactoryDataPreloader::Preloader.new(:posts, Post, nil, 0, [:users])
-      @users = FactoryDataPreloader::Preloader.new(:users, User, nil, 1, [])
+      @comments = FactoryDataPreloader::Preloader.new(:comments, Comment, nil, [:users, :posts])
     end
-    
-    should 'return a comparison value indicating that users is less than posts' do
-      assert_equal -1, @users <=> @posts
-      assert_equal  1, @posts <=> @users
+
+    should 'raise PreloaderNotDefinedError for #dependencies if the preloader it depends on are not defined' do
+      assert_raise FactoryDataPreloader::PreloaderNotDefinedError do
+        @comments.dependencies
+      end
+    end
+
+    context 'when the dependency preloaders have also been defined' do
+      setup do
+        @posts = FactoryDataPreloader::Preloader.new(:posts, Post, nil, [:users])
+        @users = FactoryDataPreloader::Preloader.new(:users, User, nil, [])
+      end
+
+      should 'return the preloader objects for #dependencies' do
+        assert_equal [@users, @posts], @comments.dependencies
+      end
     end
   end
-  
-  context 'Post and user preloaders, where neither post depends on the other' do
+
+  context 'A series of preloaders, with dependencies,' do
     setup do
-      @posts = FactoryDataPreloader::Preloader.new(:posts, Post, nil, 0, [])
-      @users = FactoryDataPreloader::Preloader.new(:users, User, nil, 1, [])
+      @post_image_ratings  = FactoryDataPreloader::Preloader.new(:post_image_ratings,  PostImageRating, nil, [:post_images])
+      @post_images         = FactoryDataPreloader::Preloader.new(:post_images,         PostImage,       nil, [:posts])
+      @ip_addresses        = FactoryDataPreloader::Preloader.new(:ip_addresses,        IpAddress,       nil, [])
+      @posts               = FactoryDataPreloader::Preloader.new(:posts,               Post,            nil, [:users])
+      @users               = FactoryDataPreloader::Preloader.new(:users,               User,            nil, [])
     end
-    
-    should 'return a comparison value based on their defined index' do
-      assert_equal  1, @users <=> @posts
-      assert_equal -1, @posts <=> @users
+
+    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)
     end
   end
 end

data/test/test_helper.rb

@@ -41,20 +41,20 @@ end
 class FactoryDataPreloader::FactoryData
   # helper method to reset the factory data between test runs.
   def self.reset!
-    @@preloaders.reverse.each do |preloader|
-      class << self; self; end.class_eval do 
-        remove_method(preloader.model_type) 
+    FactoryDataPreloader::PreloaderCollection.instance.dependency_order.reverse.each do |preloader|
+      class << self; self; end.class_eval do
+        remove_method(preloader.model_type)
       end
-      
+
       unless @@preloaded_cache.nil?
         preloader.model_class.delete_all(:id => (@@preloaded_cache[preloader.model_type] || {}).values)
       end
     end
-    
+
     @@preloaded_cache = nil
     @@preloaded_data_deleted = nil
     @@single_test_cache = {}
-    @@preloaders = []
+    FactoryDataPreloader::PreloaderCollection.instance.clear
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: myronmarston-factory_data_preloader
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Myron Marston
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-30 00:00:00 -07:00
+date: 2009-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: []