unit_record 0.4.1 → 0.9.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+*HEAD
+
+* Add association stubbing with mocha
+
+  ActiveRecord::Base.disconnect! :stub_associations => true
+
+* Add option to no-op instead of raise.
+
+  ActiveRecord::Base.disconnect! :strategy => :noop
+  or
+  ActiveRecord::Base.disconnect! :strategy => :raise
+  
+* Implemented as a connection adapter
+
 *0.4.1* (December 10th, 2007)
 
 * Stub caching for compatibility with ActionController::Caching::SqlCache in Rails 2.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2008 Dan Manges
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,137 @@
+UnitRecord
+==========
+
+Enables unit testing ActiveRecord classes without hitting the database.
+
+Why?
+----
+
+Rationale: [http://www.dcmanges.com/blog/rails-unit-record-test-without-the-database](http://www.dcmanges.com/blog/rails-unit-record-test-without-the-database)
+
+One of the biggest benefits to disconnecting unit tests from the database is having a faster test suite.  Here is the benchmark from one of my current projects:
+
+    Finished in 19.302702 seconds.
+    4920 tests, 7878 assertions, 0 failures, 0 errors
+  
+4 seconds per 1,000 tests is a good guideline.
+
+Installation
+------------
+
+    gem install unit_record
+
+Usage
+-----
+
+Restructuring the Rails Test Directory
+--------------------------------------
+
+The Rails test directory typically places testing for models under <tt>test/unit</tt> and tests for controllers under <tt>test/functional</tt>.  However, we need to change the definition of unit and functional.  Controllers can be unit tested (mocking out models and not rendering the view).  Models can be functionally tested (hitting the database).  Also, each type of test needs its own test\_helper.  I recommend restructuring your test directory like this:
+
+    test
+      test_helper.rb
+      unit
+        unit_test_helper.rb
+        controllers
+        models
+      functional
+        functional_test_helper.rb
+        controllers
+        models
+
+You should move existing functional tests into functional/controllers.  You will also need to change the require line at the top of those tests to require the functional\_test\_helper.rb file instead of the test\_helper.rb file.
+
+The <tt>functional_test_helper.rb</tt> file only needs to require <tt>test_helper.rb</tt>:
+
+    require File.dirname(__FILE__) + "/../test_helper"
+
+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.
+
+Usage
+-----
+
+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 to run your unit tests without hitting the database.
+
+Strategy
+--------
+
+There are two options for what should happen if you hit the database. You can either have UnitRecord raise an exception, or simply no-op. Raising an exception can help identify why a test is failing, but it also may be inconvenient to work around.
+
+If you want to raise an exception:
+
+    ActiveRecord::Base.disconnect! :strategy => :raise
+    
+    Person.find(:all)
+    #=> RuntimeError: ActiveRecord is disconnected; database access is unavailable in unit tests.
+
+If you want to no-op:
+
+    ActiveRecord::Base.disconnect! :strategy => :noop
+    
+    Person.find(:all)
+    #=> []
+    
+You can also change strategies within a block:
+
+    ActiveRecord::Base.connection.change_strategy(:raise) do
+      Person.find(:all)
+      #=> RuntimeError: ActiveRecord is disconnected; database access is unavailable in unit tests.
+    end
+
+    ActiveRecord::Base.connection.change_strategy(:noop) do
+      Person.find(:all)
+      #=> []
+    end
+    
+Association Stubbing
+--------------------
+
+One painful aspect of unit testing ActiveRecord classes is setting associations. Because Rails does type checking when setting an association, you'll receive an exception if you try to use a stub in place of the expected class.
+
+    Pet.new :owner => stub("person")
+    #=> ActiveRecord::AssociationTypeMismatch: Person(#16620740) expected, got Mocha::Mock(#11567340)
+    
+If you're using mocha, you can have UnitRecord stub associations. To enable association stubbing:
+
+    ActiveRecord::Base.disconnect! :stub_associations => true
+
+The above example would no longer raise an exception. It would be the equivalent of:
+
+    pet = Pet.new
+    pet.stubs(:owner).returns(stub("person"))
+    
+Note that using this approach, the setter for the association will not work for that instance.
+
+Development
+-----------
+
+Active development occurs on the [GitHub](http://github.com/dan-manges/unit-record). Changes are also pushed to the Rubyforge git repository.
+
+For bugs/patches/etc please use the [Rubyforge tracker](http://rubyforge.org/tracker/?group_id=4239).
+
+Continuous integration is provided by [RunCodeRun](http://runcoderun.com/dan-manges/unit-record).
+
+Thanks
+------
+Thanks to Jay Fields for the [original implementation](http://blog.jayfields.com/2007/03/rails-activerecord-unit-testing-part-ii.html).
+
+Maintainer
+----------
+
+[Dan Manges](http://www.dcmanges.com)
+
+Contributors
+------------
+
+* David Lowenfels
+* Rob Sanheim
+
+License
+-------
+Released under the MIT license

data/Rakefile

@@ -1,87 +1,94 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'rake/contrib/sshpublisher'
 
 desc "Default: run tests"
-task :default => :test
+task :default => %w[test:multi_verbose spec]
 
-desc "Run all tests"
-task :test => %w[test:unit test:functional]
-
-Rake::TestTask.new("test:unit") do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/unit/**/*_test.rb'
+Rake::TestTask.new("test") do |t|
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
 
-Rake::TestTask.new("test:functional") do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/functional/**/*_test.rb'
-  t.verbose = true
-end
-
-desc "Generate documentation"
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "doc"
-  rdoc.title    = "UnitRecord"
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README', 'CHANGELOG')
-end
-
-desc "Upload RDoc to RubyForge"
-task :publish_rdoc => [:rdoc] do
-  Rake::SshDirPublisher.new("dcmanges@rubyforge.org", "/var/www/gforge-projects/unit-test-ar", "doc").upload
+begin
+  require "rcov/rcovtask"
+  desc "run tests with rcov"
+  Rcov::RcovTask.new do |t|
+    t.pattern = "test/**/*_test.rb"
+    t.rcov_opts << ["--no-html", "--exclude 'Library,#{Gem.path.join(',')}'"]
+    t.verbose = true
+  end
+rescue LoadError
 end
 
-Gem::manage_gems
+require "date"
 
-specification = Gem::Specification.new do |s|
+gem_spec = Gem::Specification.new do |s|
 	s.name   = "unit_record"
   s.summary = "UnitRecord enables unit testing without hitting the database."
-	s.version = "0.4.1"
+	s.version = "0.9.0"
 	s.author = "Dan Manges"
 	s.description = "UnitRecord enables unit testing without hitting the database."
 	s.email = "daniel.manges@gmail.com"
   s.homepage = "http://unit-test-ar.rubyforge.org"
   s.rubyforge_project = "unit-test-ar"
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['README', 'CHANGELOG']
-  s.rdoc_options << '--title' << "UnitRecord" << '--main' << 'README' << '--line-numbers'
+  
+  s.has_rdoc = false
 
   s.autorequire = "unit_record"
-  s.files = FileList['{lib,test}/**/*.rb', 'CHANGELOG', 'README', 'Rakefile'].to_a
+  s.files = FileList['{lib,test,vendor}/**/*.rb', 'CHANGELOG', 'LICENSE', 'README.markdown', 'Rakefile'].to_a
 end
 
-Rake::GemPackageTask.new(specification) do |package|
-  package.need_zip = false
-  package.need_tar = false
+task :gem => %w[test:multi] do
+  Gem::Builder.new(gem_spec).build
 end
 
-RUBY_VERSIONS = %w[1.8.5-p52 1.8.5-p114 1.8.6]
-JRUBY_VERSIONS = %w[1.1b1 1.0.2]
-RAILS_VERSIONS = %w[1.2.5 1.99.0 2.0.1]
+namespace :gemspec do
+  desc "generates unit-record.gemspec"
+  task :generate do
+    File.open("unit-record.gemspec", "w") do |f|
+      f.puts "# this file is generated by rake gemspec:generate for github"
+      f.write gem_spec.to_ruby
+    end
+  end
+end
+
+task :readme do
+  require "rubygems"; gem "BlueCloth"; require "BlueCloth"; require 'tmpdir'
+  file = "#{Dir.tmpdir}/readme.html"
+  File.open(file, "w") { |f| f.write BlueCloth.new(File.read("README.markdown")).to_html }
+  sh "open #{file}"
+end
+
+RAILS_VERSIONS = %w[1.2.6 2.0.2 2.1.0 2.1.1 2.2.2]
 
 namespace :test do
-  desc "test with multiple versions of ruby and rails"
+  desc "test with multiple versions of rails"
   task :multi do
-    RUBY_VERSIONS.each do |ruby_version|
-      bin = "/usr/local/ruby-#{ruby_version}/bin"
-      RAILS_VERSIONS.each do |rails_version|
-        sh "RAILS_VERSION='#{rails_version}' #{bin}/rake test > /dev/null 2>&1"
-      end
-    end      
+    RAILS_VERSIONS.each do |rails_version|
+      puts "Testing with Rails #{rails_version}"
+      sh "RAILS_VERSION='#{rails_version}' rake test > /dev/null 2>&1"
+    end
   end
   
-  desc "test with multiple versions of jruby and rails"
-  task :multi_jruby do
-    JRUBY_VERSIONS.each do |jruby_version|
-      home = "/usr/local/jruby/jruby-#{jruby_version}"
-      RAILS_VERSIONS.each do |rails_version|
-        sh "JRUBY_HOME=#{home} RAILS_VERSION='#{rails_version}' #{home}/bin/rake test > /dev/null 2>&1"
-      end
-    end      
+  task :multi_verbose do
+    (RAILS_VERSIONS - %w[2.2.2]).each do |rails_version|
+      task = defined?(Rcov) ? "rcov" : "test"
+      sh "RAILS_VERSION='#{rails_version}' rake #{task}"
+    end
   end
 end
+
+begin
+  gem "rspec"
+  require "spec/rake/spectask"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_files = %w[test/sample_spec.rb]
+  end
+rescue LoadError
+  task :spec do
+    puts "== RSpec failed to load"
+  end
+end
+
+desc "pre-commit task"
+task :pc => %w[test:multi spec gemspec:generate]

data/lib/active_record/connection_adapters/unit_record_adapter.rb

@@ -0,0 +1,97 @@
+class ActiveRecord::ConnectionAdapters::UnitRecordAdapter < ::ActiveRecord::ConnectionAdapters::AbstractAdapter
+  EXCEPTION_MESSAGE = "ActiveRecord is disconnected; database access is unavailable in unit tests."
+
+  def initialize(config = {})
+    super
+    @strategy = config[:strategy] || :raise
+    @cached_columns = {"schema_info" => []}
+  end
+  
+  def columns(table_name, name = nil)#:nodoc:
+    @cached_columns[table_name.to_s] ||
+      raise("Columns are not cached for '#{table_name}' - check schema.rb")
+  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
+    @cached_columns[table_name.to_s] =
+      table_definition.columns.map do |c|
+        ActiveRecord::ConnectionAdapters::Column.new(c.name.to_s, c.default, c.sql_type, c.null)
+      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 change_strategy(new_strategy, &block)
+    unless [:noop, :raise].include?(new_strategy.to_sym)
+      raise ArgumentError, "#{new_strategy.inspect} is not a valid strategy - valid values are :noop and :raise"
+    end
+    begin
+      old_strategy = @strategy
+      @strategy = new_strategy.to_sym
+      yield
+    ensure
+      @strategy = old_strategy
+    end
+  end
+  
+  def execute(sql, name = nil)
+    raise_or_noop
+  end
+  
+  def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
+    raise_or_noop
+  end if Rails::VERSION::MAJOR == 1
+
+  def select_rows(sql, name = nil)
+    raise_or_noop []
+  end
+  
+  def rename_table(table_name, new_name)
+    raise_or_noop
+  end
+  
+  def change_column(table_name, column_name, type, options = {})
+    raise_or_noop
+  end
+  
+  def change_column_default(table_name, column_name, default)
+    raise_or_noop
+  end
+
+  def rename_column(table_name, column_name, new_column_name)
+    raise_or_noop
+  end
+  
+  def tables
+    @cached_columns.keys
+  end
+
+  protected
+  
+  def raise_or_noop(noop_return_value = nil)
+    @strategy == :raise ? raise(EXCEPTION_MESSAGE) : noop_return_value
+  end
+  
+  def select(sql, name = nil)
+    raise_or_noop []
+  end
+end

data/lib/unit_record.rb

@@ -1,8 +1,9 @@
-require "unit_record/column_cacher"
+require "unit_record/association_stubbing"
 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/connection_adapters/unit_record_adapter"
 
 require "active_record/fixtures"
 
@@ -10,3 +11,9 @@ ActiveRecord::ConnectionAdapters::Column.send :include, UnitRecord::ColumnExtens
 ActiveRecord::Base.extend UnitRecord::DisconnectedActiveRecord
 Test::Unit::TestCase.extend UnitRecord::DisconnectedTestCase
 Fixtures.extend UnitRecord::DisconnectedFixtures
+
+ActiveRecord::Base.class_eval do
+  def self.unit_record_connection(config)
+    ActiveRecord::ConnectionAdapters::UnitRecordAdapter.new(config)
+  end
+end