plugin_test_helper 0.1.5 → 0.1.6

data/CHANGELOG.rdoc

@@ -1,5 +1,14 @@
 == master
 
+== 0.1.6 / 2008-12-06
+
+* Remove all dependencies on plugin_test_helper when using the plugin_test_structure generator
+* Add a test_helper to the plugin_test_structure generator [Jinzhu Zhang]
+* Use the main application vendor/rails in which the plugin exists as the default vendor install if RAILS_FRAMEWORK_ROOT isn't defined [Jinzhu Zhang]
+* Update boot file to Rails 2.1.1+ requirements (i.e. RubyGems 1.1.1+)
+* Fix tests to reference ActiveSupport::Dependencies instead of Dependencies
+* Automatically load ActionView::TestCase
+
 == 0.1.5 / 2008-07-13
 
 * Don't load ActiveSupport before the environment has been initialized since it can hide problems in the plugin being tested

data/Rakefile

@@ -5,11 +5,11 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'plugin_test_helper'
-  s.version           = '0.1.5'
+  s.version           = '0.1.6'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Simplifies plugin testing by creating an isolated Rails environment that simulates its usage in a real application.'
   
-  s.files             = FileList['{generators,lib,test}/**/*'].to_a - FileList['generators/plugin_test_structure/templates/app_root/log/*'].to_a + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
+  s.files             = FileList['{generators,lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['generators/plugin_test_structure/templates/app_root/{log,log/*,script,script/*}']
   s.require_path      = 'lib'
   s.has_rdoc          = true
   s.test_files        = Dir['test/**/*_test.rb']

data/generators/plugin_test_controller/plugin_test_controller_generator.rb

@@ -1,4 +1,4 @@
-# Generates the class, helper, and view for a controller in a plugin's test application
+# Generates the class and view for a controller in a plugin's test application
 class PluginTestControllerGenerator < PluginAWeek::PluginTestHelper::Generator
   def manifest #:nodoc:
     record do |m|

data/generators/plugin_test_model/plugin_test_model_generator.rb

@@ -31,7 +31,6 @@ class PluginTestModelGenerator < PluginAWeek::PluginTestHelper::Generator
     def add_options!(opt)
       opt.separator ''
       opt.separator 'Options:'
-      opt.on("--skip-migration", 
-             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on('--skip-migration',  "Don't generate a migration file for this model") {|v| options[:skip_migration] = v}
     end
 end

data/generators/plugin_test_structure/USAGE

@@ -1,12 +1,13 @@
 Description:
-    Stubs out a new test application. Pass the plugin name, under_scored.
+    Stubs out a new test application that has no dependencies in plugin_test_helper. Pass the plugin name, under_scored.
 
     This generates the application structure in test/app_root
 
 Examples:
     `./script/generate plugin_test_structure has_comments`
 
-        creates a controller and application configurations:
+        creates test, controller and application configurations:
+            Test Helper:    test/test_helper.rb
             Controller:     test/app_root/app/controllers/application.rb
             Configurations: test/app_root/config/boot.rb
                             test/app_root/config/database.yml
@@ -17,3 +18,4 @@ Examples:
                             test/app_root/config/environments/postgresql.rb
                             test/app_root/config/environments/sqlite.rb
                             test/app_root/config/environments/sqlite3.rb
+            Scripts:        test/app_root/script/console

data/generators/plugin_test_structure/plugin_test_structure_generator.rb

@@ -1,4 +1,5 @@
-# Generates the test structure for a plugin
+# Generates the test structure for a plugin with no dependencies on the
+# plugin_test_helper library
 class PluginTestStructureGenerator < Rails::Generator::NamedBase
   def manifest #:nodoc:
     record do |m|
@@ -6,6 +7,9 @@ class PluginTestStructureGenerator < Rails::Generator::NamedBase
       plugin_test_root = "vendor/plugins/#{name}/test"
       templates_root = "#{File.dirname(__FILE__)}/templates"
       
+      # Root test directory
+      m.directory plugin_test_root
+      
       # Copy all directories and files.  None of them are templated so that they
       # can be reused during runtime
       Dir["#{templates_root}/**/*"].each do |source_file|

data/generators/plugin_test_structure/templates/app_root/config/boot.rb

@@ -1,5 +1,5 @@
 # Allow customization of the rails framework path
-RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{RAILS_ROOT}/vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
 
 # Don't change this file!
 # Configure your app in config/environment.rb and config/environments/*.rb
@@ -70,7 +70,7 @@ module Rails
 
     class << self
       def rubygems_version
-        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+        Gem::RubyGemsVersion rescue nil
       end
 
       def gem_version
@@ -85,14 +85,14 @@ module Rails
 
       def load_rubygems
         require 'rubygems'
-
-        unless rubygems_version >= '0.9.4'
-          $stderr.puts %(Rails requires RubyGems >= 0.9.4 (you have #{rubygems_version}). Please `gem update --system` and try again.)
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
           exit 1
         end
-
+ 
       rescue LoadError
-        $stderr.puts %(Rails requires RubyGems >= 0.9.4. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
         exit 1
       end
 

data/generators/plugin_test_structure/templates/app_root/config/environment.rb

@@ -1,6 +1,13 @@
-require 'config/boot'
+require File.join(File.dirname(__FILE__), 'boot')
 
 Rails::Initializer.run do |config|
   config.cache_classes = false
   config.whiny_nils = true
+  config.plugin_locators.unshift(
+    Class.new(Rails::Plugin::Locator) do
+      def plugins
+        [Rails::Plugin.new(File.expand_path('.'))]
+      end
+    end
+  ) unless defined?(PluginAWeek::PluginTestHelper::PluginLocator)
 end

data/generators/plugin_test_structure/templates/test_helper.rb

@@ -0,0 +1,20 @@
+# Set the default environment to sqlite3's in_memory database
+ENV['RAILS_ENV'] ||= 'in_memory'
+
+# Load the Rails environment and testing framework
+require "#{File.dirname(__FILE__)}/app_root/config/environment"
+require 'test_help'
+require 'action_view/test_case' # Load additional test classes not done automatically by < Rails 2.2.2
+
+# Undo changes to RAILS_ENV
+silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+# Set default fixture loading properties
+Test::Unit::TestCase.class_eval do
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+  self.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+end

data/lib/plugin_test_helper.rb

@@ -9,7 +9,7 @@ $:.unshift(RAILS_ROOT)
 # Set the default environment to sqlite3's in_memory database
 ENV['RAILS_ENV'] ||= 'in_memory'
 
-# First boost the Rails framework
+# First boot the Rails framework
 require 'config/boot'
 
 # Extend it so that we can hook into the initialization process
@@ -19,12 +19,16 @@ require 'plugin_test_helper/extensions/initializer'
 require 'config/environment'
 require 'test_help'
 
+# Load additional test classes not done automatically by < Rails 2.2.2
+# TODO: Remove in Rails 2.2.3 / 2.3 (whichever includes the fix)
+require 'action_view/test_case'
+
 # Undo changes to RAILS_ENV
 silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
 
 # Set default fixture loading properties
-class Test::Unit::TestCase #:nodoc:
+Test::Unit::TestCase.class_eval do
   self.use_transactional_fixtures = true
-  self.use_instantiated_fixtures  = false
+  self.use_instantiated_fixtures = false
   self.fixture_path = "#{Rails.root}/../fixtures"
 end

data/test/functional/plugin_test_console_generator_test.rb

@@ -16,6 +16,5 @@ class PluginTestConsoleGeneratorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_controller_generator_test.rb

@@ -20,6 +20,5 @@ class PluginTestControllerGeneratorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_helper_generator_test.rb

@@ -16,6 +16,5 @@ class PluginTestHelperGeneratorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_helper_test.rb

@@ -75,6 +75,5 @@ class PluginTestHelperTest < Test::Unit::TestCase
     teardown_app
     
     $LOAD_PATH.replace(@original_load_path)
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_migration_generator_test.rb

@@ -18,6 +18,5 @@ class PluginTestMigrationGeneratorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_model_generator_test.rb

@@ -26,6 +26,5 @@ class PluginTestModelGeneratorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/functional/plugin_test_structure_generator_test.rb

@@ -10,6 +10,10 @@ class PluginTestStructureGeneratorTest < Test::Unit::TestCase
     Rails::Generator::Scripts::Generate.new.run(['plugin_test_structure', 'acts_as_foo'])
   end
   
+  def test_should_create_test_helper
+    assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/test_helper.rb")
+  end
+  
   def test_should_create_application_controller
     assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/app_root/app/controllers/application.rb")
   end
@@ -50,8 +54,11 @@ class PluginTestStructureGeneratorTest < Test::Unit::TestCase
     assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/app_root/config/routes.rb")
   end
   
+  def test_should_create_console_script
+    assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/app_root/script/console")
+  end
+  
   def teardown
     teardown_app
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))
   end
 end

data/test/test_helper.rb

@@ -3,10 +3,17 @@ require 'fileutils'
 
 $:.unshift("#{File.dirname(__FILE__)}/../lib")
 
-FileUtils.rmtree('test/app_root')
+# Ensure the app root is empty
+FileUtils.rm_rf('test/app_root')
 FileUtils.mkdir('test/app_root')
 
-class Test::Unit::TestCase
+# Use an in-memory log so that the app root can be removed without having to
+# close all loggers in use
+require 'logger'
+require 'stringio'
+Object.const_set('RAILS_DEFAULT_LOGGER', Logger.new(StringIO.new))
+
+Test::Unit::TestCase.class_eval do
   private
     def assert_valid_environment
       assert_not_nil ApplicationController
@@ -14,8 +21,9 @@ class Test::Unit::TestCase
     end
     
     def setup_app(name)
-      FileUtils.cp_r(Dir.glob("test/app_roots/#{name}/*"), 'test/app_root')
+      FileUtils.cp_r(Dir["test/app_roots/#{name}/*"], 'test/app_root')
       
+      # Load the environment
       load 'plugin_test_helper.rb'
       assert_valid_environment
     end
@@ -24,12 +32,17 @@ class Test::Unit::TestCase
       # Clear dependencies
       self.class.use_transactional_fixtures = false
       ActiveRecord::Base.reset_subclasses
-      Dependencies.clear
+      ActiveSupport::Dependencies.clear
+      
+      # Reset open streams
       ActiveRecord::Base.clear_reloadable_connections!
       
       # Forget that the environment files were loaded so that a new app environment
       # can be set up again
       $".delete('config/environment.rb')
       $".delete('test_help.rb')
+      
+      # Remove the app folder
+      FileUtils.rm_r(Dir['test/app_root/*'])
     end
 end

data/test/unit/plugin_locator_test.rb

@@ -13,7 +13,6 @@ class PluginLocatorTest < Test::Unit::TestCase
   
   def teardown
     teardown_app
-    $LOAD_PATH.replace(@original_load_path)
-    FileUtils.rm_r(Dir.glob('test/app_root/*'))    
+    $LOAD_PATH.replace(@original_load_path)  
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plugin_test_helper
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-13 00:00:00 -04:00
+date: 2008-12-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,10 +23,17 @@ extra_rdoc_files: []
 
 files: 
 - generators/plugin_test_console
-- generators/plugin_test_console/plugin_test_console_generator.rb
 - generators/plugin_test_console/templates
 - generators/plugin_test_console/templates/console
+- generators/plugin_test_console/plugin_test_console_generator.rb
 - generators/plugin_test_console/USAGE
+- generators/plugin_test_model
+- generators/plugin_test_model/templates
+- generators/plugin_test_model/templates/migration.rb
+- generators/plugin_test_model/templates/fixtures.yml
+- generators/plugin_test_model/templates/model.rb
+- generators/plugin_test_model/plugin_test_model_generator.rb
+- generators/plugin_test_model/USAGE
 - generators/plugin_test_helper
 - generators/plugin_test_helper/templates
 - generators/plugin_test_helper/templates/test_helper.rb
@@ -34,106 +41,98 @@ files:
 - generators/plugin_test_helper/USAGE
 - generators/plugin_test_structure
 - generators/plugin_test_structure/templates
+- generators/plugin_test_structure/templates/test_helper.rb
 - generators/plugin_test_structure/templates/app_root
-- generators/plugin_test_structure/templates/app_root/app
-- generators/plugin_test_structure/templates/app_root/app/controllers
-- generators/plugin_test_structure/templates/app_root/app/controllers/application.rb
 - generators/plugin_test_structure/templates/app_root/config
 - generators/plugin_test_structure/templates/app_root/config/environment.rb
 - generators/plugin_test_structure/templates/app_root/config/environments
-- generators/plugin_test_structure/templates/app_root/config/environments/mysql.rb
-- generators/plugin_test_structure/templates/app_root/config/environments/sqlite3.rb
+- generators/plugin_test_structure/templates/app_root/config/environments/in_memory.rb
 - generators/plugin_test_structure/templates/app_root/config/environments/sqlite.rb
 - generators/plugin_test_structure/templates/app_root/config/environments/postgresql.rb
-- generators/plugin_test_structure/templates/app_root/config/environments/in_memory.rb
+- generators/plugin_test_structure/templates/app_root/config/environments/sqlite3.rb
+- generators/plugin_test_structure/templates/app_root/config/environments/mysql.rb
 - generators/plugin_test_structure/templates/app_root/config/boot.rb
-- generators/plugin_test_structure/templates/app_root/config/routes.rb
 - generators/plugin_test_structure/templates/app_root/config/database.yml
-- generators/plugin_test_structure/templates/app_root/log
+- generators/plugin_test_structure/templates/app_root/config/routes.rb
+- generators/plugin_test_structure/templates/app_root/app
+- generators/plugin_test_structure/templates/app_root/app/controllers
+- generators/plugin_test_structure/templates/app_root/app/controllers/application.rb
 - generators/plugin_test_structure/plugin_test_structure_generator.rb
 - generators/plugin_test_structure/USAGE
-- generators/plugin_test_migration
-- generators/plugin_test_migration/templates
-- generators/plugin_test_migration/templates/migration.rb
-- generators/plugin_test_migration/plugin_test_migration_generator.rb
-- generators/plugin_test_migration/USAGE
 - generators/plugin_test_controller
 - generators/plugin_test_controller/templates
-- generators/plugin_test_controller/templates/controller.rb
 - generators/plugin_test_controller/templates/view.html.erb
+- generators/plugin_test_controller/templates/controller.rb
 - generators/plugin_test_controller/plugin_test_controller_generator.rb
 - generators/plugin_test_controller/USAGE
-- generators/plugin_test_model
-- generators/plugin_test_model/plugin_test_model_generator.rb
-- generators/plugin_test_model/templates
-- generators/plugin_test_model/templates/model.rb
-- generators/plugin_test_model/templates/fixtures.yml
-- generators/plugin_test_model/templates/migration.rb
-- generators/plugin_test_model/USAGE
+- generators/plugin_test_migration
+- generators/plugin_test_migration/templates
+- generators/plugin_test_migration/templates/migration.rb
+- generators/plugin_test_migration/USAGE
+- generators/plugin_test_migration/plugin_test_migration_generator.rb
 - lib/plugin_test_helper.rb
 - lib/plugin_test_helper
-- lib/plugin_test_helper/console_with_fixtures.rb
 - lib/plugin_test_helper/plugin_locator.rb
 - lib/plugin_test_helper/extensions
 - lib/plugin_test_helper/extensions/initializer.rb
 - lib/plugin_test_helper/generator.rb
-- test/app_root
+- lib/plugin_test_helper/console_with_fixtures.rb
 - test/fixtures
 - test/fixtures/people.yml
+- test/test_helper.rb
 - test/functional
-- test/functional/plugin_test_helper_test.rb
 - test/functional/plugin_test_migration_generator_test.rb
-- test/functional/plugin_test_controller_generator_test.rb
+- test/functional/plugin_test_structure_generator_test.rb
 - test/functional/plugin_test_model_generator_test.rb
+- test/functional/plugin_test_helper_test.rb
 - test/functional/plugin_test_console_generator_test.rb
+- test/functional/plugin_test_controller_generator_test.rb
 - test/functional/plugin_test_helper_generator_test.rb
-- test/functional/plugin_test_structure_generator_test.rb
-- test/test_helper.rb
 - test/app_roots
-- test/app_roots/with_model
-- test/app_roots/with_model/app
-- test/app_roots/with_model/app/models
-- test/app_roots/with_model/app/models/person.rb
-- test/app_roots/with_migration
-- test/app_roots/with_migration/app
-- test/app_roots/with_migration/app/models
-- test/app_roots/with_migration/app/models/person.rb
-- test/app_roots/with_migration/db
-- test/app_roots/with_migration/db/migrate
-- test/app_roots/with_migration/db/migrate/001_create_people.rb
-- test/app_roots/with_routes
-- test/app_roots/with_routes/config
-- test/app_roots/with_routes/config/routes.rb
+- test/app_roots/empty
+- test/app_roots/empty/empty
 - test/app_roots/with_fixtures
-- test/app_roots/with_fixtures/app
-- test/app_roots/with_fixtures/app/models
-- test/app_roots/with_fixtures/app/models/person.rb
 - test/app_roots/with_fixtures/db
 - test/app_roots/with_fixtures/db/migrate
 - test/app_roots/with_fixtures/db/migrate/001_create_people.rb
-- test/app_roots/with_helper
-- test/app_roots/with_helper/app
-- test/app_roots/with_helper/app/helpers
-- test/app_roots/with_helper/app/helpers/people_helper.rb
+- test/app_roots/with_fixtures/app
+- test/app_roots/with_fixtures/app/models
+- test/app_roots/with_fixtures/app/models/person.rb
 - test/app_roots/with_controller
 - test/app_roots/with_controller/app
 - test/app_roots/with_controller/app/controllers
 - test/app_roots/with_controller/app/controllers/people_controller.rb
 - test/app_roots/with_custom_config
+- test/app_roots/with_custom_config/config
+- test/app_roots/with_custom_config/config/environment.rb
 - test/app_roots/with_custom_config/vendor
 - test/app_roots/with_custom_config/vendor/plugins
 - test/app_roots/with_custom_config/vendor/plugins/acts_as_foo
-- test/app_roots/with_custom_config/vendor/plugins/acts_as_foo/init.rb
 - test/app_roots/with_custom_config/vendor/plugins/acts_as_foo/lib
 - test/app_roots/with_custom_config/vendor/plugins/acts_as_foo/lib/acts_as_foo.rb
-- test/app_roots/with_custom_config/config
-- test/app_roots/with_custom_config/config/environment.rb
-- test/app_roots/empty
-- test/app_roots/empty/empty
+- test/app_roots/with_custom_config/vendor/plugins/acts_as_foo/init.rb
+- test/app_roots/with_routes
+- test/app_roots/with_routes/config
+- test/app_roots/with_routes/config/routes.rb
+- test/app_roots/with_helper
+- test/app_roots/with_helper/app
+- test/app_roots/with_helper/app/helpers
+- test/app_roots/with_helper/app/helpers/people_helper.rb
 - test/app_roots/with_custom_application_controller
 - test/app_roots/with_custom_application_controller/app
 - test/app_roots/with_custom_application_controller/app/controllers
 - test/app_roots/with_custom_application_controller/app/controllers/application.rb
+- test/app_roots/with_model
+- test/app_roots/with_model/app
+- test/app_roots/with_model/app/models
+- test/app_roots/with_model/app/models/person.rb
+- test/app_roots/with_migration
+- test/app_roots/with_migration/db
+- test/app_roots/with_migration/db/migrate
+- test/app_roots/with_migration/db/migrate/001_create_people.rb
+- test/app_roots/with_migration/app
+- test/app_roots/with_migration/app/models
+- test/app_roots/with_migration/app/models/person.rb
 - test/unit
 - test/unit/plugin_locator_test.rb
 - CHANGELOG.rdoc
@@ -163,16 +162,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pluginaweek
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Simplifies plugin testing by creating an isolated Rails environment that simulates its usage in a real application.
 test_files: 
-- test/functional/plugin_test_helper_test.rb
 - test/functional/plugin_test_migration_generator_test.rb
-- test/functional/plugin_test_controller_generator_test.rb
+- test/functional/plugin_test_structure_generator_test.rb
 - test/functional/plugin_test_model_generator_test.rb
+- test/functional/plugin_test_helper_test.rb
 - test/functional/plugin_test_console_generator_test.rb
+- test/functional/plugin_test_controller_generator_test.rb
 - test/functional/plugin_test_helper_generator_test.rb
-- test/functional/plugin_test_structure_generator_test.rb
 - test/unit/plugin_locator_test.rb