unit_record 0.1.0 → 0.2.0

data/README

@@ -17,11 +17,7 @@ One huge benefit to disconnecting unit tests from the database is having a faste
 
 == Installation
 
-The traditional way:
-  ruby script/plugin install http://unit-test-ar.rubyforge.org/svn/trunk/unit_record/
-
-Or with piston:
-  piston import http://unit-test-ar.rubyforge.org/svn/trunk/unit_record/ vendor/plugins/unit_record
+    gem install unit_record
 
 == Usage
 
@@ -46,24 +42,23 @@ The <tt>functional_test_helper.rb</tt> file should require <tt>test_helper.rb</t
 
 For moving unit tests, you have a few options.  I recommend moving them to unit/models and then disconnecting your unit tests from the database.  Any tests that fail should then be modified to not hit the database or moved to functional/models.
 
-== Caching Columns
-
-The plugin disconnects models from the database by caching the column metadata.  This is done through a rake task:
-  rake db:columns:dump
-
-The rake task creates a db/columns.rb file which will be used in the tests.  If you have a custom build/test rake task, you may just want to insert this task before you run your unit tests.  Otherwise, you can automatically have it run before <tt>test:units</tt> as so:
-  Rake::Task["test:units"].enhance ["db:columns:dump"]
-
 == Disconnecting
 
 In the <tt>test/unit/unit_test_helper.rb</tt> file you created when restructuring your test directory, you should add these lines:
   require File.dirname(__FILE__) + "/../test_helper"
+  require "unit_record"
   ActiveRecord::Base.disconnect!
   
-The <tt>disconnect!</tt> method will do everything necessary (including loading the columns.rb file) to run your unit tests without hitting the database.
+The <tt>disconnect!</tt> method will do everything necessary to run your unit tests without hitting the database.  For now, it connects to the database and caches the columns in a file (db/columns.rb) before disconnecting.  A later version will not need to connect at all.
+
+== Limitations
+
+* UnitRecord currently only works when all models use convention for table names.
 
 == Thanks
 Thanks to Jay Fields for the original implementation:
 http://blog.jayfields.com/2007/03/rails-activerecord-unit-testing-part-ii.html
 
-Copyright (c) 2007 Dan Manges, released under the MIT license.
+== License
+Released under Ruby's license.
+http://www.ruby-lang.org/en/LICENSE.txt

data/Rakefile

@@ -8,24 +8,22 @@ desc "Default: run tests"
 task :default => :test
 
 desc "Run all tests"
-task :test => %w[test:caching test:disconnecting]
+task :test => %w[test:unit test:functional]
 
-desc "Run the tests for caching columns"
-Rake::TestTask.new("test:caching") do |t|
+Rake::TestTask.new("test:unit") do |t|
   t.libs << 'lib'
-  t.pattern = 'test/caching/**/*_test.rb'
+  t.pattern = 'test/unit/**/*_test.rb'
   t.verbose = true
 end
 
-desc "Run the tests for disconnecting"
-Rake::TestTask.new("test:disconnecting") do |t|
+Rake::TestTask.new("test:functional") do |t|
   t.libs << 'lib'
-  t.pattern = 'test/disconnecting/**/*_test.rb'
+  t.pattern = 'test/functional/**/*_test.rb'
   t.verbose = true
 end
 
 desc "Generate documentation"
-Rake::RDocTask.new(:doc) do |rdoc|
+Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "doc"
   rdoc.title    = "UnitRecord"
   rdoc.options << '--line-numbers'
@@ -42,7 +40,7 @@ Gem::manage_gems
 specification = Gem::Specification.new do |s|
 	s.name   = "unit_record"
   s.summary = "UnitRecord enables unit testing without hitting the database."
-	s.version = "0.1.0"
+	s.version = "0.2.0"
 	s.author = "Dan Manges"
 	s.description = "UnitRecord enables unit testing without hitting the database."
 	s.email = "daniel.manges@gmail.com"

data/lib/unit_record.rb

@@ -1,8 +1,12 @@
-require "unit_record/column_dumper"
+require "unit_record/column_cacher"
+require "unit_record/column_extension"
 require "unit_record/disconnected_active_record"
 require "unit_record/disconnected_test_case"
 require "unit_record/disconnected_fixtures"
+
+require "active_record/fixtures"
+
+ActiveRecord::ConnectionAdapters::Column.send :include, UnitRecord::ColumnExtension
 ActiveRecord::Base.extend UnitRecord::DisconnectedActiveRecord
 Test::Unit::TestCase.extend UnitRecord::DisconnectedTestCase
-require "active_record/fixtures"
 Fixtures.extend UnitRecord::DisconnectedFixtures

data/lib/unit_record/column_cacher.rb

@@ -0,0 +1,54 @@
+module UnitRecord
+  class ColumnCacher
+    include ActiveRecord::ConnectionAdapters::SchemaStatements
+
+    def self.cache(file)
+      (class << ActiveRecord::Schema; self; end).class_eval do
+        def define(options={}, &block)
+          UnitRecord::ColumnCacher.new.instance_eval(&block)
+        end
+      end
+      load file
+    end
+
+    def add_index(table_name, column_name, options = {})
+    end
+
+    def create_table(table_name, options={})
+      table_definition = ActiveRecord::ConnectionAdapters::TableDefinition.new(self)
+      table_definition.primary_key(options[:primary_key] || "id") unless options[:id] == false
+      yield table_definition
+      if model = model_for_table(table_name)
+        (class << model; self; end).class_eval do
+          define_method(:columns) do
+            table_definition.columns.map do |c|
+              ActiveRecord::ConnectionAdapters::Column.new(c.name.to_s, c.default, c.sql_type, c.null)
+            end
+          end
+        end
+      end
+    end
+    
+    def native_database_types
+      # Copied from the MysqlAdapter so ColumnDefinition#sql_type will work
+      {
+        :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY",
+        :string      => { :name => "varchar", :limit => 255 },
+        :text        => { :name => "text" },
+        :integer     => { :name => "int", :limit => 11 },
+        :float       => { :name => "float" },
+        :decimal     => { :name => "decimal" },
+        :datetime    => { :name => "datetime" },
+        :timestamp   => { :name => "datetime" },
+        :time        => { :name => "time" },
+        :date        => { :name => "date" },
+        :binary      => { :name => "blob" },
+        :boolean     => { :name => "tinyint", :limit => 1 }
+      }
+    end
+
+    def model_for_table(table)
+      table.to_s.classify.constantize rescue nil
+    end
+  end
+end

data/lib/unit_record/column_extension.rb

@@ -0,0 +1,7 @@
+module UnitRecord
+  module ColumnExtension
+    def ==(other)
+      other && instance_variables.all? { |ivar| instance_variable_get(ivar) == other.instance_variable_get(ivar) }
+    end
+  end
+end

data/lib/unit_record/disconnected_active_record.rb

@@ -5,10 +5,6 @@ module UnitRecord
     end
     def disconnect!
       return if disconnected?
-      columns_file = File.join(RAILS_ROOT, "db", "columns.rb")
-      File.open(columns_file, "w") do |file|
-        UnitRecord::ColumnDumper.dump(ActiveRecord::Base.connection, file)
-      end
       (class << self; self; end).class_eval do
         def connection
           raise "ActiveRecord is disconnected; database access is unavailable in unit tests."
@@ -20,9 +16,11 @@ module UnitRecord
           true
         end
       end
-      load columns_file
       Fixtures.disconnect!
       Test::Unit::TestCase.disconnect!
+      old_columns_file = File.join(RAILS_ROOT, 'db', 'columns.rb')
+      File.delete old_columns_file if File.exists?(old_columns_file)
+      ColumnCacher.cache(RAILS_ROOT + "/db/schema.rb")
     end
   end
 end

data/test/db/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :preferences, :force => true do |t|
+    t.column :some_count, :integer
+    t.column :show_help, :boolean, :default => true
+  end
+
+  create_table :people, :force => true do |t|
+    t.column :first_name, :string
+    t.column :last_name,  :string
+  end
+  
+  add_index "people", ["first_name"]
+end

data/test/functional/column_cacher_test.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + "/functional_test_helper"
+
+functional_tests do
+  test "caching columns with no defaults or not nulls" do
+    assert_equal [
+      ActiveRecord::ConnectionAdapters::Column.new("id", nil, "int(11) DEFAULT NULL auto_increment PRIMARY KEY", nil),
+      ActiveRecord::ConnectionAdapters::Column.new("first_name", nil, "varchar(255)", nil),
+      ActiveRecord::ConnectionAdapters::Column.new("last_name", nil, "varchar(255)", nil)
+    ], Person.columns
+  end
+  
+  test "caching column with default" do
+    assert_equal ActiveRecord::ConnectionAdapters::Column.new("show_help", true, "tinyint(1)", nil), Preference.columns.detect { |c| c.name == "show_help" }
+  end
+  
+  test "add_index does not blow up" do
+    assert_nothing_raised { UnitRecord::ColumnCacher.new.add_index("people", "first_name") }
+  end
+end

data/test/functional/column_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + "/functional_test_helper"
+
+functional_tests do
+  test "instantiating" do
+    person = Person.new :first_name => "Dan", :last_name => "Manges"
+    assert_equal "Dan", person.first_name
+    assert_equal "Manges", person.last_name
+  end
+  
+  test "using model with column with a default" do
+    record = Preference.new
+    assert_equal true, record.show_help?
+  end
+  
+  test "typecasting happens for integer attributes" do
+    record = Preference.new
+    record.some_count = "42"
+    assert_equal 42, record.some_count
+  end
+  
+  test "" do
+  end
+end

data/test/{disconnecting → functional}/disconnected_active_record_test.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + "/./disconnecting_test_helper"
+require File.dirname(__FILE__) + "/./functional_test_helper"
 # The '.' is intentional to have a TestCase require a different relative path.
 
-class DisconnectedActiveRecordTest < Test::Unit::TestCase
+functional_tests do
   test "accessing connection raises" do
     assert_raises(RuntimeError) { ActiveRecord::Base.connection }
   end

data/test/functional/disconnected_fixtures_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + "/functional_test_helper"
+
+functional_tests do
+  test "create_fixtures does nothing" do
+    assert_nothing_raised { Fixtures.create_fixtures }
+  end
+end

data/test/{disconnecting → functional}/disconnected_test_case_test.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/disconnecting_test_helper"
+require File.dirname(__FILE__) + "/functional_test_helper"
 
-class DisconnectedTestCaseTest < Test::Unit::TestCase  
+functional_tests do
   test "use_transactional_fixtures is false" do
     assert_equal false, Test::Unit::TestCase.use_transactional_fixtures
   end

data/test/test_helper.rb

@@ -13,17 +13,13 @@ begin
 rescue LoadError
   raise "Need Mocha and Dust gems to Test"
 end
-
-ActiveRecord::Base.configurations['test'] = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
-ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
-ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'][ENV['DB'] || 'sqlite3'])
+Test::Unit::TestCase.disallow_setup!
 
 require "#{File.dirname(__FILE__)}/../init"
-silence_stream(STDOUT) do
-  load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
-end
 
 Test::Unit::TestCase.use_transactional_fixtures = true
 
+class Preference < ActiveRecord::Base
+end
 class Person < ActiveRecord::Base
 end

data/test/unit/column_extension_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+unit_tests do
+  test "equality" do
+    column1 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    column2 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    assert_equal column1, column2
+  end
+  
+  test "non-equality on name" do
+    column1 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    column2 = ActiveRecord::ConnectionAdapters::Column.new("different name", nil, :string, nil)
+    assert column1 != column2
+  end
+  
+  test "non-equality on sql_type" do
+    column1 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    column2 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :text, nil)
+    assert column1 != column2
+  end
+  
+  test "non-equality on default" do
+    column1 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    column2 = ActiveRecord::ConnectionAdapters::Column.new("name", "Dan", :string, nil)
+    assert column1 != column2
+  end
+  
+  test "non-equality on null" do
+    column1 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, nil)
+    column2 = ActiveRecord::ConnectionAdapters::Column.new("name", nil, :string, true)
+    assert column1 != column2
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.3
 specification_version: 1
 name: unit_record
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-08-15 00:00:00 -04:00
+  version: 0.2.0
+date: 2007-08-16 00:00:00 -04:00
 summary: UnitRecord enables unit testing without hitting the database.
 require_paths: 
 - lib
@@ -30,18 +30,20 @@ authors:
 - Dan Manges
 files: 
 - lib/unit_record.rb
-- lib/unit_record/column_dumper.rb
+- lib/unit_record/column_cacher.rb
+- lib/unit_record/column_extension.rb
 - lib/unit_record/disconnected_active_record.rb
 - lib/unit_record/disconnected_fixtures.rb
 - lib/unit_record/disconnected_test_case.rb
-- test/schema.rb
 - test/test_helper.rb
-- test/caching/column_dumper_test.rb
-- test/db/columns.rb
-- test/disconnecting/disconnected_active_record_test.rb
-- test/disconnecting/disconnected_fixtures_test.rb
-- test/disconnecting/disconnected_test_case_test.rb
-- test/disconnecting/disconnecting_test_helper.rb
+- test/db/schema.rb
+- test/functional/column_cacher_test.rb
+- test/functional/column_test.rb
+- test/functional/disconnected_active_record_test.rb
+- test/functional/disconnected_fixtures_test.rb
+- test/functional/disconnected_test_case_test.rb
+- test/functional/functional_test_helper.rb
+- test/unit/column_extension_test.rb
 - Rakefile
 - init.rb
 - README

data/lib/unit_record/column_dumper.rb

@@ -1,52 +0,0 @@
-require 'erb'
-module UnitRecord
-  class ColumnDumper
-    private_class_method :new
-    
-    def self.dump(connection, stream)
-      new(connection).write_to(stream)
-    end
-    
-    def initialize(connection)
-      @connection = connection
-    end
-    
-    def columns_by_model
-      @columns_by_model ||= tables.inject({}) do |hash,table|
-        model = model_for_table(table)
-        hash[model.to_s] = columns(table) if model
-        hash
-      end
-    end
-    
-    def columns(table)
-      @connection.columns(table)
-    end
-    
-    def model_for_table(table)
-      table.classify.constantize rescue nil
-    end
-    
-    def tables
-      @connection.tables
-    end
-    
-    def write_to(stream)
-      template = ERB.new <<-END, nil, '-'
-<% columns_by_model.keys.sort.each do |model| -%>
-<%= model %>.class_eval do
-  def self.columns
-    [
-      <%- columns_by_model[model].each do |column| -%>
-      ActiveRecord::ConnectionAdapters::Column.new(<%= column.name.to_s.inspect %>, <%= column.default.inspect %>, <%= column.sql_type.inspect %>, <%= column.null.inspect%>),
-      <%- end -%>
-    ]
-  end
-end
-<%- end -%>
-END
-      text = template.result binding
-      stream.write text
-    end
-  end
-end

data/test/caching/column_dumper_test.rb

@@ -1,20 +0,0 @@
-require File.dirname(__FILE__) + "/../test_helper"
-
-class ColumnDumperTest < Test::Unit::TestCase
-  test "dumping columns" do
-    stream = StringIO.new
-    UnitRecord::ColumnDumper.dump(ActiveRecord::Base.connection, stream)
-    expected = <<-END
-Person.class_eval do
-  def self.columns
-    [
-      ActiveRecord::ConnectionAdapters::Column.new("id", nil, "INTEGER", false),
-      ActiveRecord::ConnectionAdapters::Column.new("first_name", nil, "varchar(255)", true),
-      ActiveRecord::ConnectionAdapters::Column.new("last_name", nil, "varchar(255)", true),
-    ]
-  end
-end
-END
-    assert_equal expected, stream.string
-  end
-end

data/test/db/columns.rb

@@ -1,9 +0,0 @@
-Person.class_eval do
-  def self.columns
-    [
-      ActiveRecord::ConnectionAdapters::Column.new("id", nil, "INTEGER", false),
-      ActiveRecord::ConnectionAdapters::Column.new("first_name", nil, "varchar(255)", true),
-      ActiveRecord::ConnectionAdapters::Column.new("last_name", nil, "varchar(255)", true),
-    ]
-  end
-end

data/test/disconnecting/disconnected_fixtures_test.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + "/disconnecting_test_helper"
-
-class DisconnectedTestCaseTest < Test::Unit::TestCase  
-  test "create_fixtures does nothing" do
-    assert_nothing_raised { Fixtures.create_fixtures }
-  end
-end

data/test/schema.rb

@@ -1,6 +0,0 @@
-ActiveRecord::Schema.define(:version => 0) do
-  create_table :people do |t|
-    t.column :first_name, :string
-    t.column :last_name,  :string
-  end
-end