Ticket #1911: more_flexible_fixture_architecture-2.patch

test/fixtures_test.rb

@@ -68 +68 @@
-    end
-  end
-
+  def test_fixtures_not_found
+    assert_raise(Fixture::FixtureError) {
+      Fixtures.new(nil, File.join(File.dirname(__FILE__), 'fixtures'), FixtureGroup.new("bad_extension"))
+    }
+  end
+
-  def test_deprecated_yaml_extension
-    assert_raise(Fixture::FormatError) {
-'bad_extension', File.join(File.dirname(__FILE__), 'fixtures'
+File.join(File.dirname(__FILE__), 'fixtures', 'bad_fixtures'), FixtureGroup.new("deprecated"
-    }
-  end
-
@@ -101 +107 @@
-  end
-
-  def test_empty_yaml_fixture
-"accounts", File.dirname(__FILE__) + "/fixtures/naked/yml/accounts"
+File.dirname(__FILE__) + "/fixtures/naked/yml/", FixtureGroup.new("accounts")
-  end
-
-  def test_empty_yaml_fixture_with_a_comment_in_it
-"companies", File.dirname(__FILE__) + "/fixtures/naked/yml/companies"
+File.dirname(__FILE__) + "/fixtures/naked/yml/", FixtureGroup.new("companies")
-  end
-
-  def test_dirty_dirty_yaml_file
-    assert_raises(Fixture::FormatError) do
-"courses", File.dirname(__FILE__) + "/fixtures/naked/yml/courses"
+File.dirname(__FILE__) + "/fixtures/naked/yml/", FixtureGroup.new("courses")
-    end
-  end
-
-  def test_empty_csv_fixtures
-"accounts", File.dirname(__FILE__) + "/fixtures/naked/csv/accounts"
+File.dirname(__FILE__) + "/fixtures/naked/csv/", FixtureGroup.new("accounts")
-  end
-end
-
@@ -212 +218 @@
-
-end
-
+class FixturesGroupTest < Test::Unit::TestCase
+  def test_get_table_name_from_model_class
+    fg = FixtureGroup.new(:filedoesnotexist, :class_name => "DeveloperWithAggregate")
+    assert_equal fg.table_name, 'developers'
+    assert_equal fg.class_name, 'DeveloperWithAggregate'
+  end
+  
+  def test_assume_correct_class_name_from_table_name
+    fg = FixtureGroup.new(:developers, :table_name => "tests")
+    assert_equal fg.table_name, 'tests'
+    assert_equal fg.class_name, 'Test'
+  end
-
+  def test_file_name_is_a_string
+    fg = FixtureGroup.new(:developers)
+    assert String === fg.file_name
+  end
+  
+  def test_fixture_group_name
+    fg = FixtureGroup.new(:developers)
+    assert Symbol === fg.group_name
+    assert_equal fg.group_name, :developers
+    
+    fg = FixtureGroup.new(:developers, :group_name => "other")
+    assert Symbol === fg.group_name
+    assert_equal fg.group_name, :other
+  end
+end
-
+class MultipleFixturesForTheSameTableTest < Test::Unit::TestCase
+  self.use_instantiated_fixtures = true
+  fixture :topics, :class_name => "Topic"
+  fixture :topics2, :class_name => "Topic"
+  
+  def test_loaded_fixtures
+    assert_equal @topics.size, 2
+    assert_equal @topics2.size, 2
+    union = Topic.find(:all)
+    assert_equal union.size, 4
+  end
+end
-
+class MixSingularAndPluralFixturesTest < Test::Unit::TestCase
+  self.use_instantiated_fixtures = true
+  fixtures :topics, :developers, :accounts
+  fixture :topics2, :table_name => "topics"
+  
+  def test_loaded_fixtures
+    assert_equal @topics.size, 2
+    assert_equal @topics2.size, 2
+    union = Topic.find(:all)
+    assert_equal union.size, 4
+  end
+end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+

test/fixtures/topics2.yml

@@ +1 @@
+third:
+  id: 3
+  title: The Third Topic
+  author_name: Duane
+  author_email_address: david@loudthinking.com
+  written_on: 2003-07-16t15:28:00.00+01:00
+  last_read: 2004-04-15
+  bonus_time: 2005-01-30t15:28:00.00+01:00
+  content: Have a nice day
+  approved: 0
+  replies_count: 0
+
+fourth:
+  id: 4
+  title: The Fourth topic
+  author_name: John
+  written_on: 2003-07-15t15:28:00.00+01:00
+  content: Have a nice day
+  approved: 1
+  replies_count: 2
+  parent_id: 1

lib/active_record/fixtures.rb

@@ -2 +2 @@
-require 'yaml'
-require 'csv'
-
+# A FixtureGroup is a set of fixtures identified by a name.  Normally, this is the name of the
+# corresponding table in the database.  For example, when you declare the use of fixtures in a
+# TestUnit class, like so:
+#   fixtures :users
+# you are creating a FixtureGroup whose name is 'users', and whose defaults are set such that the
+# +class_name+, +file_name+ and +table_name+ are guessed from the FixtureGroup's name.
+class FixtureGroup
+  attr_accessor :table_name, :class_name, :connection
+  attr_reader :group_name, :file_name
+
+  def initialize(file_name, optional_names = {})
+    self.file_name = file_name
+    self.group_name = optional_names[:group_name] || file_name
+    if optional_names[:table_name]
+      self.table_name = optional_names[:table_name]
+      self.class_name = optional_names[:class_name] || Inflector.classify(@table_name.to_s.gsub('.','_'))
+    elsif optional_names[:class_name]
+      self.class_name = optional_names[:class_name]
+      if Object.const_defined?(@class_name)
+        model_class = Object.const_get(@class_name)
+        self.table_name = model_class.table_name
+      end
+    end
+
+    # In case either :table_name or :class_name was not set:
+    self.table_name ||= @group_name.to_s
+    self.class_name ||= Inflector.classify(@table_name.to_s.gsub('.','_'))
+  end
+
+  def file_name=(name)
+    @file_name = name.to_s
+  end
+  
+  def group_name=(name)
+    @group_name = name.to_sym
+  end
+
+  def class_file_name
+    Inflector.underscore(@class_name)
+  end
+  
+  # Instantiate an array of FixtureGroup objects from an array of strings (table_names)
+  def self.array_from_names(names)
+    names.collect { |n| FixtureGroup.new(n) }
+  end
+  
+  def hash
+    @group_name.hash
+  end
+  
+  def eql?(other)
+    @group_name.eql? other.group_name
+  end
+end
+
-# Fixtures are a way of organizing data that you want to test against; in short, sample data. They come in 3 flavours:
-#
-#   1.  YAML fixtures
@@ -194 +249 @@
-class Fixtures < Hash
-  DEFAULT_FILTER_RE = /\.ya?ml$/
-
-  def self.instantiate_fixtures(object, table_name, fixtures, load_instances=true)
-    old_logger_level = ActiveRecord::Base.logger.level
-    ActiveRecord::Base.logger.level = Logger::ERROR
-
-    object.instance_variable_set "@#{table_name.to_s.gsub('.','_')}", fixtures
-    if load_instances
-      fixtures.each do |name, fixture|
-        if model = fixture.find
-          object.instance_variable_set "@#{name}", model
-        end
-      end
-    end
-
-    ActiveRecord::Base.logger.level = old_logger_level
-  end
-  
-  def self.instantiate_all_loaded_fixtures(object, load_instances=true)
-    all_loaded_fixtures.each do |table_name, fixtures|
-      Fixtures.instantiate_fixtures(object, table_name, fixtures, load_instances)
-    end
-  end
-  
-  cattr_accessor :all_loaded_fixtures
-  self.all_loaded_fixtures = {}
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-    read_fixture_files
-  end
-
-  def delete_existing_fixtures
-
+fixture_group.
-  end
-
-  def insert_fixtures
-    values.each do |fixture|
-
+fixture_group.
-    end
-  end
-
-  private
-    def read_fixture_files
-      if File.file?(yaml_file_path)
-
-
-
-
-
-
-
+
-      elsif File.file?(csv_file_path)
-
-
-
-
-
-
-
-
-
+
-      elsif File.file?(deprecated_yaml_file_path)
-        raise Fixture::FormatError, ".yml extension required: rename #{deprecated_yaml_file_path} to #{yaml_file_path}"
+      elsif File.directory?(File.join(@fixtures_directory, @fixture_group.file_name))
+        read_standard_fixture_files
-      else
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        end
-      end
-    end
-
-    def yaml_file_path
-"#{@fixture_path}
+fixture_path_with_extension "
-    end
-
-    def deprecated_yaml_file_path
-"#{@fixture_path}
+fixture_path_with_extension "
-    end
-
-    def csv_file_path
-@fixture_path +
+fixture_path_with_extension
-    end
-
-yaml_fixtures_key(path
-basename(@fixture_path).split(".").first
-
+fixture_path_with_extension(ext
+join(@fixtures_directory, @fixture_group.file_name + ext)
+      
-
-    def erb_render(fixture_content)
-      ERB.new(fixture_content).result
-    end
+
+    #def yaml_fixtures_key(path)
+    #  File.basename(@fixture_path).split(".").first
+    #end
+
+  public
+    class << self
+      def instantiate_fixtures(object, fixture_group_name, fixtures, load_instances=true)
+        old_logger_level = ActiveRecord::Base.logger.level
+        ActiveRecord::Base.logger.level = Logger::ERROR
+
+        # table_name.to_s.gsub('.','_') replaced by 'fixture_group_name'
+        object.instance_variable_set "@#{fixture_group_name}", fixtures
+        if load_instances
+          fixtures.each do |name, fixture|
+            if model = fixture.find
+              object.instance_variable_set "@#{name}", model
+            end
+          end
+        end
+
+        ActiveRecord::Base.logger.level = old_logger_level
+      end
+
+      def instantiate_all_loaded_fixtures(object, load_instances=true)
+        all_loaded_fixtures.each do |fixture_group_name, fixtures|
+          Fixtures.instantiate_fixtures(object, fixture_group_name, fixtures, load_instances)
+        end
+      end
+
+
+      def create_fixtures(fixtures_directory, *fixture_groups)
+        connection = block_given? ? yield : ActiveRecord::Base.connection
+        old_logger_level = ActiveRecord::Base.logger.level
+        fixture_groups.flatten!
+        
+        # Backwards compatibility: Allow an array of table names to be passed in, but just use them
+        # to create an array of FixtureGroup objects
+        if not fixture_groups.empty? and fixture_groups.first.is_a?(String)
+          fixture_groups = FixtureGroup.array_from_names(fixture_groups)
+        end
+
+        begin
+          ActiveRecord::Base.logger.level = Logger::ERROR
+
+          fixtures_map = {}
+          fixtures = fixture_groups.map do |group|
+            fixtures_map[group.group_name] = Fixtures.new(connection, fixtures_directory, group)
+          end               
+          # Make sure all refs to all_loaded_fixtures use group_name as hash index, not table_name
+          all_loaded_fixtures.merge! fixtures_map  
+
+          connection.transaction do
+            fixtures.reverse.each { |fixture| fixture.delete_existing_fixtures }
+            fixtures.each { |fixture| fixture.insert_fixtures }
+          end
+
+          reset_sequences(connection, fixture_groups) if connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+
+          return fixtures.size > 1 ? fixtures : fixtures.first
+        ensure
+          ActiveRecord::Base.logger.level = old_logger_level
+        end
+      end
+
+      # Work around for PostgreSQL to have new fixtures created from id 1 and running.
+      def reset_sequences(connection, fixture_groups)
+        fixture_groups.flatten.each do |group|
+          if Object.const_defined?(group.class_name)
+            pk = eval("#{group.class_name}::primary_key")
+            if pk == 'id'
+              connection.execute(
+                "SELECT setval('#{group.table_name}_id_seq', (SELECT MAX(id) FROM #{group.table_name}), true)", 
+                'Setting Sequence'
+              )
+            end
+          end
+        end
+      end
+    end
-end
-
-class Fixture #:nodoc:
@@ -399 +486 @@
-    class TestCase #:nodoc:
-      include ClassInheritableAttributes
-
-_path
-table_name
+s_directory
+group
-      class_inheritable_accessor :use_transactional_fixtures
-      class_inheritable_accessor :use_instantiated_fixtures   # true, false, or :no_instances
-      class_inheritable_accessor :pre_loaded_fixtures
-
-table_name
+group
-      self.use_transactional_fixtures = false
-      self.use_instantiated_fixtures = true
-      self.pre_loaded_fixtures = false
-
-      @@already_loaded_fixtures = {}
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-      end
-
-
-
+
+
+
+
+
+
+
+
-          begin
-Inflector.singularize(table_name.to_s)
+group.class_file_name
-          rescue LoadError
-            # Let's hope the developer has included it himself
-          end
-        end
-      end
-
-table_name
-table_names || fixture_table_names).each do |table_name
-
-table
+override_fixture_group
+override_fixture_groups || fixture_groups).each do |group
+# 
+group.group
-            force_reload = optionals.shift
-table
-table
-table_name][fixture] ||= @loaded_fixtures[table
+group.group
+group.group
+group.group_name][fixture] ||= @loaded_fixtures[group.group
-          end
-        end
-      end
@@ -519 +617 @@
-      private
-        def load_fixtures
-          @loaded_fixtures = {}
-_path, fixture_table_name
+s_directory, fixture_group
-          unless fixtures.nil?
-            if fixtures.instance_of?(Fixtures)
-table
+fixture_group.group
-            else
-table
+fixture_group.group
-            end
-          end
-        end
@@ -536 +634 @@
-          if pre_loaded_fixtures
-            raise RuntimeError, 'Load fixtures before instantiating them.' if Fixtures.all_loaded_fixtures.empty?
-            unless @@required_fixture_classes
-
+
+
-              @@required_fixture_classes = true
-            end
-            Fixtures.instantiate_all_loaded_fixtures(self, load_instances?)
-          else
-            raise RuntimeError, 'Load fixtures before instantiating them.' if @loaded_fixtures.nil?
-table
-table
+fixture_group
+fixture_group
-            end
-          end
-        end