plugin_test_helper 0.2.1 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,6 +1,13 @@
 == master
 
-== 0.2.1 / 2008-01-11
+== 0.3.0 / 2009-04-13
+
+* Fix environment being loaded twice when generators are loaded
+* Clean up / simplify generators
+* Rename application.rb to application_controller.rb
+* Add dependency on Rails 2.3
+
+== 0.2.1 / 2009-01-11
 
 * Remove init.rb since the library should never be loaded automatically
 * Fix fixtures not being loaded within the test application console [Sergei Kozlov]

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2008 Aaron Pfeifer
+Copyright (c) 2006-2009 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -104,7 +104,7 @@ Example:
         create  vendor/plugins/acts_as_most_popular/test/app_root/config/environments/in_memory.rb
         create  vendor/plugins/acts_as_most_popular/test/app_root/config/environments/postgresql.rb
         create  vendor/plugins/acts_as_most_popular/test/app_root/app/controllers
-        create  vendor/plugins/acts_as_most_popular/test/app_root/app/controllers/application.rb
+        create  vendor/plugins/acts_as_most_popular/test/app_root/app/controllers/application_controller.rb
   Loaded suite script/generate
   Started
   
@@ -187,7 +187,7 @@ Example:
 
 == Dependencies
 
-Rails 2.1 or later
+Rails 2.3 or later
 
 == References
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'plugin_test_helper'
-  s.version           = '0.2.1'
+  s.version           = '0.3.0'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Simplifies plugin testing by creating an isolated Rails environment that simulates its usage in a real application.'
   

data/generators/plugin_test_console/plugin_test_console_generator.rb

@@ -1,9 +1,11 @@
+require 'plugin_test_helper/generator'
+
 # Generates a test console for the plugin's test application.
-class PluginTestConsoleGenerator < Rails::Generator::NamedBase
+class PluginTestConsoleGenerator < Rails::Generator::Base
+  include PluginTestHelper::Generator
+  
   def manifest #:nodoc:
     record do |m|
-      plugin_root = "vendor/plugins/#{name}"
-      
       # Script directory
       m.directory File.join(plugin_root, 'script')
       

data/generators/plugin_test_controller/plugin_test_controller_generator.rb

@@ -1,5 +1,9 @@
+require 'plugin_test_helper/generator'
+
 # Generates the class and view for a controller in a plugin's test application
-class PluginTestControllerGenerator < PluginTestHelper::Generator
+class PluginTestControllerGenerator < Rails::Generator::NamedBase
+  include PluginTestHelper::Generator
+  
   def manifest #:nodoc:
     record do |m|
       # Check for class naming collisions

data/generators/plugin_test_helper/plugin_test_helper_generator.rb

@@ -1,9 +1,11 @@
+require 'plugin_test_helper/generator'
+
 # Generates the test helper for a plugin
-class PluginTestHelperGenerator < Rails::Generator::NamedBase
+class PluginTestHelperGenerator < Rails::Generator::Base
+  include PluginTestHelper::Generator
+  
   def manifest #:nodoc:
     record do |m|
-      plugin_root = "vendor/plugins/#{name}"
-      
       # Test directory
       m.directory File.join(plugin_root, 'test')
       

data/generators/plugin_test_migration/plugin_test_migration_generator.rb

@@ -1,5 +1,9 @@
+require 'plugin_test_helper/generator'
+
 # Generates migrations for a plugin's test application
-class PluginTestMigrationGenerator < PluginTestHelper::Generator
+class PluginTestMigrationGenerator < Rails::Generator::NamedBase
+  include PluginTestHelper::Generator
+  
   def manifest #:nodoc:
     record do |m|
       m.migration_template 'migration.rb', "#{plugin_app_root}/db/migrate"

data/generators/plugin_test_model/plugin_test_model_generator.rb

@@ -1,25 +1,26 @@
+require 'plugin_test_helper/generator'
+
 # Generates the class, fixtures, and migration for a model in a plugin's test application
-class PluginTestModelGenerator < PluginTestHelper::Generator
-  default_options :skip_migration => false
+class PluginTestModelGenerator < Rails::Generator::NamedBase
+  include PluginTestHelper::Generator
   
   def manifest #:nodoc:
     record do |m|
-      # Check for class naming collisions.
+      # Check for class naming collisions
       m.class_collisions class_path, class_name
       
-      # Model and fixture directories.
+      # Model and fixture directories
       m.directory File.join(plugin_app_root, 'app/models', class_path)
       m.directory File.join(plugin_test_root, 'fixtures', class_path)
       
-      # Model class and fixtures.
+      # Model class and fixtures
       m.template 'model.rb',      File.join(plugin_app_root, 'app/models', class_path, "#{file_name}.rb")
       m.template 'fixtures.yml',  File.join(plugin_test_root, 'fixtures', class_path, "#{table_name}.yml")
       
-      unless options[:skip_migration]
-        m.migration_template 'migration.rb', "#{plugin_app_root}/db/migrate", :assigns => {
-          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
-        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
-      end
+      # Migration
+      m.migration_template 'migration.rb', "#{plugin_app_root}/db/migrate", :assigns => {
+        :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+      }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
     end
   end
 
@@ -27,10 +28,4 @@ class PluginTestModelGenerator < PluginTestHelper::Generator
     def banner
       "Usage: #{$0} generate your_plugin ModelName [field:type, field:type]"
     end
-    
-    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}
-    end
 end

data/generators/plugin_test_model/templates/migration.rb

@@ -3,9 +3,6 @@ class <%= migration_name %> < ActiveRecord::Migration
     create_table :<%= table_name %> do |t|
 <% for attribute in attributes -%>
       t.<%= attribute.type %> :<%= attribute.name %>
-<% end -%>
-<% unless options[:skip_timestamps] %>
-      t.timestamps
 <% end -%>
     end
   end

data/generators/plugin_test_structure/USAGE

@@ -8,7 +8,7 @@ Examples:
 
         creates test, controller and application configurations:
             Test Helper:    test/test_helper.rb
-            Controller:     test/app_root/app/controllers/application.rb
+            Controller:     test/app_root/app/controllers/application_controller.rb
             Configurations: test/app_root/config/boot.rb
                             test/app_root/config/database.yml
                             test/app_root/config/environment.rb

data/generators/plugin_test_structure/plugin_test_structure_generator.rb

@@ -1,10 +1,13 @@
+require 'plugin_test_helper/generator'
+
 # Generates the test structure for a plugin with no dependencies on the
 # plugin_test_helper library
-class PluginTestStructureGenerator < Rails::Generator::NamedBase
+class PluginTestStructureGenerator < Rails::Generator::Base
+  include PluginTestHelper::Generator
+  
   def manifest #:nodoc:
     record do |m|
       # Paths are relative to our template dir
-      plugin_test_root = "vendor/plugins/#{name}/test"
       templates_root = "#{File.dirname(__FILE__)}/templates"
       
       # Root test directory

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

@@ -47,6 +47,7 @@ module Rails
     def load_initializer
       require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
       Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
     end
   end
 
@@ -85,7 +86,7 @@ module Rails
 
       def load_rubygems
         require 'rubygems'
-        min_version = '1.1.1'
+        min_version = '1.3.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

data/generators/plugin_test_structure/templates/app_root/config/database.yml

@@ -2,20 +2,30 @@ in_memory:
   adapter: sqlite3
   database: ":memory:"
   verbosity: quiet
+  pool: 5
+  timeout: 5000
 sqlite:
   adapter: sqlite
   dbfile: plugin_test.sqlite.db
+  pool: 5
+  timeout: 5000
 sqlite3:
   adapter: sqlite3
   dbfile: plugin_test.sqlite3.db
+  pool: 5
+  timeout: 5000
 postgresql:
   adapter: postgresql
   username: postgres
   password: postgres
   database: plugin_test
+  pool: 5
+  timeout: 5000
 mysql:
   adapter: mysql
   host: localhost
   username: root
   password:
   database: plugin_test
+  pool: 5
+  timeout: 5000

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

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), 'boot')
 Rails::Initializer.run do |config|
   config.cache_classes = false
   config.whiny_nils = true
+  config.action_controller.session = {:key => 'rails_session', :secret => 'd229e4d22437432705ab3985d4d246'}
   config.plugin_locators.unshift(
     Class.new(Rails::Plugin::Locator) do
       def plugins

data/generators/plugin_test_structure/templates/test_helper.rb

@@ -4,7 +4,6 @@ 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']}
@@ -13,8 +12,10 @@ silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
 ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
 
 # Set default fixture loading properties
-Test::Unit::TestCase.class_eval do
+ActiveSupport::TestCase.class_eval do
   self.use_transactional_fixtures = true
   self.use_instantiated_fixtures = false
   self.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+  
+  fixtures :all
 end

data/lib/plugin_test_helper/extensions/{initializer.rb → configuration.rb}

@@ -2,24 +2,6 @@ require 'plugin_test_helper/plugin_locator'
 
 module PluginTestHelper
   module Extensions #:nodoc:
-    # Adds in hooks for extending other parts of the Rails framework *after*
-    # Rails has loaded those frameworks
-    module Initializer
-      def self.included(base)
-        base.class_eval do
-          alias_method :require_frameworks_without_test_helper, :require_frameworks
-          alias_method :require_frameworks, :require_frameworks_with_test_helper
-        end
-      end
-      
-      # Load the needed frameworks and then our extensions to them
-      def require_frameworks_with_test_helper
-        require_frameworks_without_test_helper
-        
-        require 'plugin_test_helper/generator'
-      end
-    end
-    
     # Overrides some of the default values in the Rails configuration so that
     # files can be reused from this test helper or overridden by the plugin
     # using the helper
@@ -31,7 +13,6 @@ module PluginTestHelper
         alias_method_chain base, :default_routes_configuration_file, :test_helper
         alias_method_chain base, :default_controller_paths, :test_helper
         alias_method_chain base, :default_plugin_locators, :test_helper
-        alias_method_chain base, :default_plugin_paths, :test_helper
       end
       
       # Defines a "lite" version of ActiveSupport's alias chaining extensions.
@@ -60,7 +41,6 @@ module PluginTestHelper
             app/controllers
             config
             lib
-            vendor
           ).map {|dir| "#{HELPER_RAILS_ROOT}/#{dir}"}
         end
         
@@ -87,20 +67,10 @@ module PluginTestHelper
           locators = default_plugin_locators_without_test_helper
           locators.unshift(PluginTestHelper::PluginLocator)
         end
-        
-        # Add the helper's vendor/plugins path
-        def default_plugin_paths_with_test_helper
-          paths = default_plugin_paths_without_test_helper
-          paths << File.join(HELPER_RAILS_ROOT, 'vendor/plugins')
-        end
     end
   end
 end
 
-Rails::Initializer.class_eval do
-  include PluginTestHelper::Extensions::Initializer
-end
-
 Rails::Configuration.class_eval do
   include PluginTestHelper::Extensions::Configuration
 end

data/lib/plugin_test_helper/generator.rb

@@ -3,7 +3,7 @@ require 'rails_generator'
 module PluginTestHelper
   # The base generator for creating parts of the test application. The first
   # argument of the generator is always the name of the plugin.
-  class Generator < Rails::Generator::NamedBase
+  module Generator
     attr_accessor :plugin_name
     
     def initialize(*runtime_args) #:nodoc:
@@ -12,9 +12,14 @@ module PluginTestHelper
     end
     
     private
+      # The root path of the plugin's directory
+      def plugin_root
+        "vendor/plugins/#{plugin_name}"
+      end
+      
       # The root path of the plugin's test directory
       def plugin_test_root
-        "vendor/plugins/#{plugin_name}/test"
+        "#{plugin_root}/test"
       end
       
       # The root path of the plugin's test app

data/lib/plugin_test_helper.rb

@@ -12,23 +12,21 @@ ENV['RAILS_ENV'] ||= 'in_memory'
 # First boot the Rails framework
 require 'config/boot'
 
-# Extend it so that we can hook into the initialization process
-require 'plugin_test_helper/extensions/initializer'
+# Extend it so that we can hook into the configuration process
+require 'plugin_test_helper/extensions/configuration'
 
 # Load the Rails environment and testing framework
 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
-Test::Unit::TestCase.class_eval do
+ActiveSupport::TestCase.class_eval do
   self.use_transactional_fixtures = true
   self.use_instantiated_fixtures = false
-  self.fixture_path = "#{Rails.root}/../fixtures"
+  self.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+  
+  fixtures :all
 end

data/test/functional/plugin_test_helper_test.rb

@@ -8,6 +8,7 @@ class PluginTestHelperTest < Test::Unit::TestCase
   
   def test_should_load_with_no_app_root
     load 'plugin_test_helper.rb'
+    
     assert_valid_environment
   end
   

data/test/functional/plugin_test_structure_generator_test.rb

@@ -15,7 +15,7 @@ class PluginTestStructureGeneratorTest < Test::Unit::TestCase
   end
   
   def test_should_create_application_controller
-    assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/app_root/app/controllers/application.rb")
+    assert File.exists?("#{Rails.root}/vendor/plugins/acts_as_foo/test/app_root/app/controllers/application_controller.rb")
   end
   
   def test_should_create_in_memory_environment

data/test/test_helper.rb

@@ -14,6 +14,25 @@ require 'stringio'
 Object.const_set('RAILS_DEFAULT_LOGGER', Logger.new(StringIO.new))
 
 Test::Unit::TestCase.class_eval do
+  def self.reset_environment
+    # Clear dependencies
+    ActiveRecord::Base.reset_subclasses
+    ActiveSupport::Dependencies.clear
+    
+    # Clear configurations
+    ActionController::Routing.controller_paths.clear
+    ActionController::Routing::Routes.configuration_files.clear
+    Rails::Rack::Metal.requested_metals.clear if Rails::Rack::Metal.requested_metals
+    Rails::Rack::Metal.metal_paths.clear if Rails::Rack::Metal.metal_paths
+    
+    # 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_if {|path| path =~ /(config\/environment\.rb|test_help\.rb)$/}
+  end
+  
   private
     def assert_valid_environment
       assert_not_nil ApplicationController
@@ -29,19 +48,14 @@ Test::Unit::TestCase.class_eval do
     end
     
     def teardown_app
-      # Clear dependencies
-      self.class.use_transactional_fixtures = false
-      ActiveRecord::Base.reset_subclasses
-      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_if {|path| path =~ /(config\/environment\.rb|test_help\.rb)$/}
+      self.class.reset_environment
       
       # Remove the app folder
       FileUtils.rm_r(Dir['test/app_root/*'])
     end
 end
+
+# Load the helper once before tests start so that the Rails library paths
+# don't get lost betweeen environment loads
+require 'plugin_test_helper'
+Test::Unit::TestCase.reset_environment

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plugin_test_helper
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-11 00:00:00 -05:00
+date: 2009-04-13 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -58,7 +58,7 @@ files:
 - 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/templates/app_root/app/controllers/application_controller.rb
 - generators/plugin_test_structure/plugin_test_structure_generator.rb
 - generators/plugin_test_structure/USAGE
 - generators/plugin_test_controller
@@ -76,7 +76,7 @@ files:
 - lib/plugin_test_helper
 - lib/plugin_test_helper/plugin_locator.rb
 - lib/plugin_test_helper/extensions
-- lib/plugin_test_helper/extensions/initializer.rb
+- lib/plugin_test_helper/extensions/configuration.rb
 - lib/plugin_test_helper/generator.rb
 - lib/plugin_test_helper/console_with_fixtures.rb
 - test/fixtures
@@ -123,7 +123,7 @@ files:
 - 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_custom_application_controller/app/controllers/application_controller.rb
 - test/app_roots/with_model
 - test/app_roots/with_model/app
 - test/app_roots/with_model/app/models
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pluginaweek
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Simplifies plugin testing by creating an isolated Rails environment that simulates its usage in a real application.