activerecord 1.1.0 → 1.2.0

data/lib/active_record/fixtures.rb

@@ -1,147 +1,258 @@
+require 'erb'
 require 'yaml'
+require 'csv'
 require 'active_record/support/class_inheritable_attributes'
 require 'active_record/support/inflector'
 
-# Fixtures are a way of organizing data that you want to test against. Each fixture file is created as a row
-# in the database and created as a hash with column names as keys and data as values. All of these fixture hashes
-# are kept in an overall hash where they can be accessed by their file name.
+# Fixtures are a way of organizing data that you want to test against; in short, sample data. They come in 3 flavours:
 #
-# Example:
+#   1.  YAML fixtures
+#   2.  CSV fixtures
+#   3.  Single-file fixtures
 #
-# Directory with the fixture files
+# = YAML fixtures
 #
-#   developers/
-#     david
-#     luke
-#     jamis
+# This type of fixture is in YAML format and the preferred default. YAML is a file format which describes data structures
+# in a non-verbose, humanly-readable format. It ships with Ruby 1.8.1+.
 #
-# The file +david+ then contains:
+# Unlike single-file fixtures, YAML fixtures are stored in a single file per model, which is place in the directory appointed
+# by <tt>Test::Unit::TestCase.fixture_path=(path)</tt> (this is automatically configured for Rails, so you can just
+# put your files in <your-rails-app>/test/fixtures/). The fixture file ends with the .yml file extension (Rails example:
+# "<your-rails-app>/test/fixtures/web_sites.yml"). The format of a YAML fixture file looks like this:
+#
+#   rubyonrails:
+#     id: 1
+#     name: Ruby on Rails
+#     url: http://www.rubyonrails.org
+#
+#   google:
+#     id: 2
+#     name: Google
+#     url: http://www.google.com
+#
+# This YAML fixture file includes two fixtures.  Each YAML fixture (ie. record) is given a name and is followed by an
+# indented list of key/value pairs in the "key: value" format.  Records are separated by a blank line for your viewing
+# pleasure.
+#
+# = CSV fixtures
+#
+# Fixtures can also be kept in the Comma Separated Value format. Akin to YAML fixtures, CSV fixtures are stored
+# in a single file, but, instead end with the .csv file extension (Rails example: "<your-rails-app>/test/fixtures/web_sites.csv")
+#
+# The format of this tye of fixture file is much more compact than the others, but also a little harder to read by us
+# humans.  The first line of the CSV file is a comma-separated list of field names.  The rest of the file is then comprised
+# of the actual data (1 per line).  Here's an example:
+#
+#   id, name, url
+#   1, Ruby On Rails, http://www.rubyonrails.org
+#   2, Google, http://www.google.com
+#
+# Should you have a piece of data with a comma character in it, you can place double quotes around that value.  If you
+# need to use a double quote character, you must escape it with another double quote.
+#
+# Another unique attribute of the CSV fixture is that it has *no* fixture name like the other two formats.  Instead, the
+# fixture names are automatically generated by deriving the class name of the fixture file and adding an incrementing
+# number to the end.  In our example, the 1st fixture would be called "web_site_1" and the 2nd one would be called
+# "web_site_2".
+#
+# Most databases and spreadsheets support exporting to CSV format, so this is a great format for you to choose if you
+# have existing data somewhere already.
+#
+# = Single-file fixtures
+#
+# This type of fixtures was the original format for Active Record that has since been deprecated in favor of the YAML and CSV formats.
+# Fixtures for this format are created by placing text files in a sub-directory (with the name of the model) to the directory
+# appointed by <tt>Test::Unit::TestCase.fixture_path=(path)</tt> (this is automatically configured for Rails, so you can just
+# put your files in <your-rails-app>/test/fixtures/<your-model-name>/ -- like <your-rails-app>/test/fixtures/web_sites/ for the WebSite
+# model).
+#
+# Each text file placed in this directory represents a "record".  Usually these types of fixtures are named without
+# extensions, but if you are on a Windows machine, you might consider adding .txt as the extension.  Here's what the
+# above example might look like:
+#
+#   web_sites/google
+#   web_sites/yahoo.txt
+#   web_sites/ruby-on-rails
+#
+# The file format of a standard fixture is simple.  Each line is a property (or column in db speak) and has the syntax
+# of "name => value".  Here's an example of the ruby-on-rails fixture above:
 #
 #   id => 1
-#   name => David Heinemeier Hansson
-#   birthday => 1979-10-15
-#   profession => Systems development
+#   name => Ruby on Rails
+#   url => http://www.rubyonrails.org
 #
-# Now when we call <tt>@developers = Fixtures.new(ActiveRecord::Base.connection, "developers", "developers/")</tt> all three
-# developers will get inserted into the "developers" table through the active Active Record connection (that must be setup
-# before-hand). And we can now query the fixture data through the <tt>@developers</tt> hash, so <tt>@developers["david"]["name"]</tt>
-# will return <tt>"David Heinemeier Hansson"</tt> and <tt>@developers["david"]["birthday"]</tt> will return <tt>Date.new(1979, 10, 15)</tt>.
+# = Using Fixtures
 #
-# This can then be used for comparison in a unit test. Something like:
+# Since fixtures are a testing construct, we use them in our unit and functional tests.  There are two ways to use the
+# fixtures, but first lets take a look at a sample unit test found:
 #
-#   def test_find
-#     assert_equal @developers["david"]["name"], Developer.find(@developers["david"]["id"]).name
+#   require 'web_site'
+#
+#   class WebSiteTest < Test::Unit::TestCase
+#     def test_web_site_count
+#       assert_equal 2, WebSite.count
+#     end
 #   end
 #
-# == Automatic fixture setup and instance variable availability
+# As it stands, unless we pre-load the web_site table in our database with two records, this test will fail.  Here's the
+# easiest way to add fixtures to the database:
 #
-# Fixtures can also be automatically instantiated in instance variables relating to their names using the following style:
+#   ...
+#   class WebSiteTest < Test::Unit::TestCase
+#     fixtures :web_sites # add more by separating the symbols with commas
+#   ...
 #
-#   class FixturesTest < Test::Unit::TestCase
-#     fixtures :developers # you can add more with comma separation
+# By adding a "fixtures" method to the test case and passing it a list of symbols (only one is shown here tho), we trigger
+# the testing environment to automatically load the appropriate fixtures into the database before each test, and
+# automatically delete them after each test.
 #
-#     def test_developers
-#       assert_equal 3, @developers.size # the container for all the fixtures is automatically set
-#       assert_kind_of Developer, @david # works like @developers["david"].find
-#       assert_equal "David Heinemeier Hansson", @david.name
-#     end
+# In addition to being available in the database, the fixtures are also loaded into a hash stored in an instance variable
+# of the test case.  It is named after the symbol... so, in our example, there would be a hash available called
+# @web_sites.  This is where the "fixture name" comes into play.
+#
+# On top of that, each record is automatically "found" (using Model.find(id)) and placed in the instance variable of its name.
+# So for the YAML fixtures, we'd get @rubyonrails and @google, which could be interrogated using regular Active Record semantics:
+#
+#   # test if the object created from the fixture data has the same attributes as the data itself
+#   def test_find
+#     assert_equal @web_sites["rubyonrails"]["name"], @rubyonrails.name
 #   end
 #
-# == YAML fixtures
-#
-# Additionally, fixtures supports yaml files.  Like fixture files, these yaml files have a pre-defined format.  The document
-# must be formatted like this:
-#
-# name: david
-# data:
-#  id: 1
-#  name: David Heinemeier Hansson
-#  birthday: 1979-10-15
-#  profession: Systems development
-# ---
-# name: steve
-# data:
-#  id: 2
-#  name: Steve Ross Kellock
-#  birthday: 1974-09-27
-#  profession: guy with keyboard
-#
-# In that file, there's two records.  Each record must have two parts:  'name' and 'data'.  The data that you add
-# must be indented like you see above.
-#
-# Yaml fixtures file names must end with .yml as in people.yml or camel.yml.  The yaml fixtures are placed in the same
-# directory as the normal fixtures and can happy co-exist.  :)
+# As seen above, the data hash created from the YAML fixtures would have @web_sites["rubyonrails"]["url"] return
+# "http://www.rubyonrails.org" and @web_sites["google"]["name"] would return "Google". The same fixtures, but loaded
+# from a CSV fixture file would be accessible via @web_sites["web_site_1"]["name"] == "Ruby on Rails" and have the individual
+# fixtures available as instance variables @web_site_1 and @web_site_2.
+#
+# = Dynamic fixtures with ERb
+#
+# Some times you don't care about the content of the fixtures as much as you care about the volume. In these cases, you can
+# mix ERb in with your YAML or CSV fixtures to create a bunch of fixtures for load testing, like:
+#
+# <% for i in 1..1000 %>
+# fix_<%= i %>:
+#   id: <%= i %>
+#   name: guy_<%= 1 %>
+# <% end %>
+#
+# This will create 1000 very simple YAML fixtures.
+#
+# Using ERb, you can also inject dynamic values into your fixtures with inserts like <%= Date.today.strftime("%Y-%m-%d") %>.
+# This is however a feature to be used with some caution. The point of fixtures are that they're stable units of predictable
+# sample data. If you feel that you need to inject dynamic values, then perhaps you should reexamine whether your application
+# is properly testable. Hence, dynamic values in fixtures are to be considered a code smell.
 class Fixtures < Hash
+  DEFAULT_FILTER_RE = /\.ya?ml$/
+
   def self.instantiate_fixtures(object, fixtures_directory, *table_names)
     [ create_fixtures(fixtures_directory, *table_names) ].flatten.each_with_index do |fixtures, idx|
       object.instance_variable_set "@#{table_names[idx]}", fixtures
       fixtures.each { |name, fixture| object.instance_variable_set "@#{name}", fixture.find }
     end
   end
-  
+
   def self.create_fixtures(fixtures_directory, *table_names)
     connection = block_given? ? yield : ActiveRecord::Base.connection
     old_logger_level = ActiveRecord::Base.logger.level
 
     begin
       ActiveRecord::Base.logger.level = Logger::ERROR
-      fixtures = connection.transaction do
-        table_names.flatten.map do |table_name|
-          Fixtures.new(connection, table_name.to_s, File.join(fixtures_directory, table_name.to_s))
-        end
+
+      fixtures = table_names.flatten.map do |table_name|
+        Fixtures.new(connection, table_name.to_s, File.join(fixtures_directory, table_name.to_s))
+      end
+
+      connection.transaction do
+        fixtures.reverse.each { |fixture| fixture.delete_existing_fixtures }
+        fixtures.each { |fixture| fixture.insert_fixtures }
       end
+
       return fixtures.size > 1 ? fixtures : fixtures.first
     ensure
       ActiveRecord::Base.logger.level = old_logger_level
     end
   end
 
-  def initialize(connection, table_name, fixture_path, file_filter = /^\.|CVS|\.yaml/)
+  def initialize(connection, table_name, fixture_path, file_filter = DEFAULT_FILTER_RE)
     @connection, @table_name, @fixture_path, @file_filter = connection, table_name, fixture_path, file_filter
     @class_name = Inflector.classify(@table_name)
 
     read_fixture_files
-    delete_existing_fixtures
-    insert_fixtures
+  end
+
+  def delete_existing_fixtures
+    @connection.delete "DELETE FROM #{@table_name}", 'Fixture Delete'
+  end
+
+  def insert_fixtures
+    values.each do |fixture|
+      @connection.execute "INSERT INTO #{@table_name} (#{fixture.key_list}) VALUES (#{fixture.value_list})", 'Fixture Insert'
+    end
   end
 
   private
     def read_fixture_files
-      Dir.entries(@fixture_path).each do |file|
-        case file
-          when /\.ya?ml$/
-            path = File.join(@fixture_path, file)
-            YamlFixture.produce(path).each { |fixture|
-                self[fixture.yaml_name] = fixture
-            }
-          when @file_filter
-            # skip
-          else
-            self[file] = Fixture.new(@fixture_path, file, @class_name)
+      if File.file?(yaml_file_path)
+        # YAML fixtures
+        begin
+          yaml = YAML::load(erb_render(IO.read(yaml_file_path)))
+          yaml.each { |name, data| self[name] = Fixture.new(data, @class_name) } if yaml
+        rescue Exception=>boom
+          raise Fixture::FormatError, "a YAML error occured parsing #{yaml_file_path}"
+        end
+      elsif File.file?(csv_file_path)
+        # CSV fixtures
+        reader = CSV::Reader.create(erb_render(IO.read(csv_file_path)))
+        header = reader.shift
+        i = 0
+        reader.each do |row|
+          data = {}
+          row.each_with_index { |cell, j| data[header[j].to_s.strip] = cell.to_s.strip }
+          self["#{Inflector::underscore(@class_name)}_#{i+=1}"]= Fixture.new(data, @class_name)
+        end
+      elsif File.file?(deprecated_yaml_file_path)
+        raise Fixture::FormatError, ".yml extension required: rename #{deprecated_yaml_file_path} to #{yaml_file_path}"
+      else
+        # Standard fixtures
+        Dir.entries(@fixture_path).each do |file|
+          path = File.join(@fixture_path, file)
+          if File.file?(path) and file !~ @file_filter
+            self[file] = Fixture.new(path, @class_name)
+          end
         end
       end
     end
 
-    def delete_existing_fixtures
-      @connection.delete "DELETE FROM #{@table_name}"
+    def yaml_file_path
+      "#{@fixture_path}.yml"
     end
 
-    def insert_fixtures
-      values.each do |fixture|
-        @connection.execute "INSERT INTO #{@table_name} (#{fixture.key_list}) VALUES(#{fixture.value_list})"
-      end
+    def deprecated_yaml_file_path
+      "#{@fixture_path}.yaml"
+    end
+
+    def csv_file_path
+      @fixture_path + ".csv"
+    end
+
+    def yaml_fixtures_key(path)
+      File.basename(@fixture_path).split(".").first
+    end
+
+    def erb_render(fixture_content)
+      ERB.new(fixture_content).result
     end
 end
 
 class Fixture #:nodoc:
   include Enumerable
-  class FixtureError < StandardError; end
-  class FormatError < FixtureError; end
+  class FixtureError < StandardError#:nodoc:
+  end
+  class FormatError < FixtureError#:nodoc:
+  end
 
-  def initialize(fixture_path, file, class_name)
-    @fixture_path, @file, @class_name = fixture_path, file, class_name
-    @fixture = read_fixture_file
-    @class_name
+  def initialize(fixture, class_name)
+    @fixture = fixture.is_a?(Hash) ? fixture : read_fixture_file(fixture)
+    @class_name = class_name
   end
 
   def each
@@ -163,93 +274,76 @@ class Fixture #:nodoc:
   def value_list
     @fixture.values.map { |v| ActiveRecord::Base.connection.quote(v).gsub('\\n', "\n").gsub('\\r', "\r") }.join(", ")
   end
-  
+
   def find
-    Object.const_get(@class_name).find(self["id"])
+    Object.const_get(@class_name).find(self[Object.const_get(@class_name).primary_key])
   end
-  
+
   private
-    def read_fixture_file
-      path = File.join(@fixture_path, @file)
-      IO.readlines(path).inject({}) do |fixture, line|
+    def read_fixture_file(fixture_file_path)
+      IO.readlines(fixture_file_path).inject({}) do |fixture, line|
         # Mercifully skip empty lines.
-        next if line.empty?
+        next if line =~ /^\s*$/
 
         # Use the same regular expression for attributes as Active Record.
         unless md = /^\s*([a-zA-Z][-_\w]*)\s*=>\s*(.+)\s*$/.match(line)
-          raise FormatError, "#{path}: fixture format error at '#{line}'.  Expecting 'key => value'."
+          raise FormatError, "#{fixture_file_path}: fixture format error at '#{line}'.  Expecting 'key => value'."
         end
         key, value = md.captures
 
         # Disallow duplicate keys to catch typos.
-        raise FormatError, "#{path}: duplicate '#{key}' in fixture." if fixture[key]
+        raise FormatError, "#{fixture_file_path}: duplicate '#{key}' in fixture." if fixture[key]
         fixture[key] = value.strip
         fixture
       end
     end
 end
 
-# A YamlFixture is like a fixture, but instead of a name to use as
-# a key, it uses a yaml_name.
-class YamlFixture < Fixture #:nodoc:
-  class YamlFormatError < FormatError; end
+module Test#:nodoc:
+  module Unit#:nodoc:
+    class TestCase #:nodoc:
+      include ClassInheritableAttributes
 
-  # yaml_name is analogous to a normal fixture's filename
-  attr_reader :yaml_name
-
-  # Instantiate with fixture name and data.
-  def initialize(yaml_name, fixture)
-    @yaml_name, @fixture = yaml_name, fixture
-  end
-
-  def produce(yaml_file_name)
-    YamlFixture.produce(yaml_file_name)
-  end
+      cattr_accessor :fixture_path
+      cattr_accessor :fixture_table_names
 
-  # Extract an array of YamlFixtures from a yaml file.
-  def self.produce(yaml_file_name)
-    fixtures = []
-    File.open(yaml_file_name) do |yaml_file|
-      YAML::load_documents(yaml_file) do |doc|
-        missing = %w(name data).reject { |key| doc[key] }.join(' and ')
-        raise YamlFormatError, "#{path}: yaml fixture missing #{missing}: #{doc.to_yaml}" unless missing.empty?
-        fixtures << YamlFixture.new(doc['name'], doc['data'])
+      def self.fixtures(*table_names)
+        require_fixture_classes(table_names)
+        write_inheritable_attribute("fixture_table_names", table_names)
       end
-    end
-    fixtures
-  end
-end
 
-class Test::Unit::TestCase #:nodoc:
-  include ClassInheritableAttributes
-  
-  cattr_accessor :fixture_path
-  cattr_accessor :fixture_table_names
-  
-  def self.fixtures(*table_names)
-    write_inheritable_attribute("fixture_table_names", table_names)
-  end
+      def self.require_fixture_classes(table_names)
+        table_names.each do |table_name| 
+          begin
+            require(Inflector.singularize(table_name.to_s))
+          rescue LoadError
+            # Let's hope the developer is included it himself
+          end
+        end
+      end
 
-  def setup
-    instantiate_fixtures(*fixture_table_names) if fixture_table_names
-  end
-  
-  def self.method_added(method_symbol)
-    if method_symbol == :setup && !method_defined?(:setup_without_fixtures)
-      alias_method :setup_without_fixtures, :setup
-      define_method(:setup) do
+      def setup
         instantiate_fixtures(*fixture_table_names) if fixture_table_names
-        setup_without_fixtures
       end
-    end
-  end
 
-  private
-    def instantiate_fixtures(*table_names)
-      Fixtures.instantiate_fixtures(self, fixture_path, *table_names)
-    end
-    
-    def fixture_table_names
-      self.class.read_inheritable_attribute("fixture_table_names")
+      def self.method_added(method_symbol)
+        if method_symbol == :setup && !method_defined?(:setup_without_fixtures)
+          alias_method :setup_without_fixtures, :setup
+          define_method(:setup) do
+            instantiate_fixtures(*fixture_table_names) if fixture_table_names
+            setup_without_fixtures
+          end
+        end
+      end
+
+      private
+        def instantiate_fixtures(*table_names)
+          Fixtures.instantiate_fixtures(self, fixture_path, *table_names)
+        end
+
+        def fixture_table_names
+          self.class.read_inheritable_attribute("fixture_table_names")
+        end
     end
+  end
 end