multi_rails 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,12 @@
+== 0.0.3 
+
+* add support for using multi_rails with regular Rails apps, which was way more work then it should have been.
+* add the bootstrap task to add our multi_rails require line at the top of environment.rb in a rails app
+* renames vendor/rails to vendor/rails.off in a Rails app, in order to fall back to rubygems
+* added multi_rails_runner to allow multi_rails to set the RAILS_GEM_VERSION before the Rails Rakefile ever gets loaded
+* improve rdoc
+* move svn hosting to google code, to make it publicly accessible
+
 == 0.0.2 / Tuesday; October 23, 2007
 
 * first public release!

data/MIT-LICENSE

@@ -0,0 +1,11 @@
+Copyright (c) 2007 Relevance, Inc. (http://thinkrelevance.com)
+
+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/Manifest.txt

@@ -1,19 +1,23 @@
 History.txt
+MIT-LICENSE
 Manifest.txt
 README.txt
 Rakefile
-init.rb
+bin/multi_rails_runner.rb
+install.rb
 lib/multi_rails.rb
 lib/multi_rails/config.rb
 lib/multi_rails/core_extensions.rb
 lib/multi_rails/loader.rb
 lib/multi_rails/multi_rails_error.rb
+lib/multi_rails/rails_app_helper.rb
 lib/multi_rails_init.rb
 tasks/load_multi_rails_rake_tasks.rb
 tasks/multi_rails.rake
 test/config_test.rb
 test/core_extensions_test.rb
-test/init_test.rb
+test/install_test.rb
 test/loader_test.rb
 test/multi_rails_init_test.rb
 test/multi_rails_test_helper.rb
+test/rails_app_helper_test.rb

data/README.txt

@@ -2,26 +2,38 @@ MultiRails
     by Relevance, http://thinkrelevance.com
        Rob Sanheim - MultiRails lead
 
+== URLs:
+
+  rubyforge:    http://rubyforge.org/projects/multi-rails/
+  svn stable:   http://robsanheim.googlecode.com/svn/tags/stable/multi_rails
+  svn trunk:    http://robsanheim.googlecode.com/svn/trunk/multi_rails
+  mailing list: http://groups.google.com/group/multi_rails
+  
 == DESCRIPTION:
   
-MultiRails allows easy testing against multiple versions of Rails for your Rails specific gem or plugin.
+MultiRails allows easy testing against multiple versions of Rails for your Rails specific gem or plugin.  IT also has tentative support testing Rails applications against multiple versions of Rails.
 
-Use MultiRails to hook in Rails 2.0 testing in your continuous integration.  Still working on Rails 2.0 support?  
-Use MultiRails to see where your test suite falls down against the 2.0 preview releases of Rails.
+Use MultiRails to hook in Rails 2.0 testing in your continuous integration.  Still working on Rails 2.0 support?  Use MultiRails to see where your test suite falls down against the 2.0 preview releases of Rails.
 
 MultiRails was initially developed by members of Relevance while developing Streamlined 
 against edge Rails.  To see how Streamlined uses MultiRails, go to http://trac.streamlinedframework.org.
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
 * easily test plugins/extensions using a require from your test_helper.rb and a require in your RakeFile
-* rake tasks to test against a specific version of Rails, or all versions of Rails available locally as Gems
+* rake tasks to test against a specified version of Rails, the latest version, or all versions
+* tentative support for testing plain Rails apps against multiple versions of Rails
+* Uses rubygems for version management of Rails
 
 == TODOs:
 
-* enable multi_rails testing in a plain ole' Rails app -- this is difficult right now because of the Rails boot process
 * improve docs on how to override what files are required by multi_rails
-* test against Rails versions that are just checked out, and not installed via Gems
+* maybe add ability to load plain Rails versions -- ie checked out copies not in RubyGems
+
+== NOTES:
+
+* (__For Rails apps only__) multi_rails will rename your vendor/rails directory to vendor/rails.off if it finds one within your rails app.  We have to do this to make Rails fall back to RubyGems rails.  Multi_rails will rename back to the correct vendor/rails when done testing, so it will not interrupt your app in normal use.
+* (__For Rails apps only__) multi_rails needs to add a line to top of your environment.rb to hook into -- see the instructions below for more details
 
 == REQUIREMENTS:
 
@@ -30,45 +42,50 @@ against edge Rails.  To see how Streamlined uses MultiRails, go to http://trac.s
 * Rails 1.2.1 or higher
 * at least one copy of Rails installed via rubygems.
 
-== INSTALL:
+== INSTALLING FOR RAILS APPS
 
-NOTE - for multi_rails to work at all, you *must* remove any of your own requires of the Rails
-       framework in any sort of test_helper you have.  MultiRails handles requiring Rails on its own,
-       immediately after it uses gem to activate the correct version under test.
-       
-* sudo gem install multi_rails
-    
-* in your projects Rakefile, require a simple rb file which just loads the multi_rails rake tasks.
+* install the plugin, which will copy the multi_rails_runner into your script folder on install.
+    script/plugin install http://robsanheim.googlecode.com/svn/tags/stable/multi_rails
 
-  require 'load_multi_rails_rake_tasks'
-  
-* run rake -T in your root, verify that you see two new rake tasks.
+* Run the multi_rails bootstrap command to get your Rails app ready to go with multi_rails - this will add a require line to the top of your environment.rb needed for multi_rails to work right.
+    script/multi_rails_runner bootstrap
 
-  rake test:multi_rails:all
-  rake test:multi_rails:one
-  
-* In your plugins test_helper, remove any rails specific requires (activerecord, actioncontroller, activesupport, etc), 
-  and require multi_rails_init instead.  
+* Run your tests against all versions of Rails installed (the default):
+    script/multi_rails_runner
+  or run our tests against the most recent version of Rails you have installed:
+    script/multi_rails_runner latest
+  or just a specific version:
+    MULTIRAILS_RAILS_VERSION=1.2.5 script/multi_rails_runner one
 
-  require multi_rails_init
+== INSTALLING FOR PLUGINS
 
-* Run the multi_rails:all rake task to run your test suite against all versions of Rails you have installed via gems.  Install
-  other versions of Rails using rubygems to add them to your test suite.
-  
-* For changing the Rails version under test, set the environment variable MULTIRAILS_RAILS_VERSION to version you want, and run
-  the multi_rails:one task or just run a test class directly.
+* Install multi_rails
+    sudo gem install multi_rails
+
+* In your projects Rakefile, require the multi_rails Rake tasks.
+
+  require "load_multi_rails_rake_tasks"
+
+* Run rake -T to verify you see the multi_rails tasks.
+    rake -T multi_rails
+    # should see   "rake test:multi_rails:all, rake test:multi_rails:latest...etc"
+
+* In your test_helper, require multi_rails_init *before* any rails specific requires (activerecord, actioncontroller, activesupport, etc).
+
+  require 'multi_rails_init'
+
+* Run the multi_rails:all rake task to run your test suite against all versions of Rails you have installed via gems.  Install other versions of Rails using rubygems to add them to your test suite.
+
+* For changing the Rails version under test, set the environment variable MULTIRAILS_RAILS_VERSION to version you want, and run the multi_rails:one task or just run a test class directly.
 
 == HELP
 
-* Are you trying to use MultiRails in a plain rails application?  Right now there isn't a good way to do this, without hacking
-  up your boot.rb.  If you have any ideas please do contribute.
-  
-* Getting gem activation errors?  Are you sure you removed your rails requires and are just using multi rails?
-  
 * Join the mailing list!  
   http://groups.google.com/group/multi_rails
   multi_rails@googlegroups.com
-  
+
+* Rails plugin testing is pretty solid, but rails *app* testing is still new.  Post issues to the mailing list.
+* Getting gem activation errors?  Post to the list with how you are using multi_rails, and I'll try to help.
 
 == LICENSE:
 

data/Rakefile

@@ -14,4 +14,12 @@ Hoe.new('multi_rails', MultiRails::VERSION) do |p|
   p.remote_rdoc_dir = '' # Release to root
   p.test_globs = 'test/**/*_test.rb' # we use the foo_test convention
   p.spec_extras[:require_paths] = ['lib', 'tasks']
+end
+
+desc "Copy trunk to stable tag in SVN to make things easy for Rails plugin installation."
+task :copy_stable do
+  trunk_dir  = "~/src/opensource/robsanheim/trunk/multi_rails/"
+  stable_dir = "~/src/opensource/robsanheim/tags/stable/multi_rails/"
+  puts %x[rsync --exclude='.svn' -r #{trunk_dir} #{stable_dir}]
+  puts %x[svn ci #{stable_dir} -m 'Release to stable from trunk.']
 end

data/bin/multi_rails_runner.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'rake'
+require 'rake/testtask'
+require 'pathname'
+
+# Get the real path, to make sure if this file is symlinked we don't mess up
+absolute_current_dir = File.dirname(Pathname.new(__FILE__).realpath)
+
+require File.expand_path(File.join(absolute_current_dir, "../lib/multi_rails"))
+require File.expand_path(File.join(absolute_current_dir, "../tasks/load_multi_rails_rake_tasks"))
+
+# A script to allow multi_rails to work with Rails apps
+# For testing Rails plugins or gems, you don't need to use this - you can just the rake tasks.
+module MultiRails
+  module Runner
+    # Run multi_rails using the specified task, defaults to testing against all Rails versions intalled
+    def self.run(task = "all")
+      task = task ? task : "all"
+      puts %[Running MultiRails with task "#{task}"...]
+      MultiRails::RailsAppHelper.run(task)
+    end
+    
+  end
+end
+
+HELP_MESSAGE = "Give this runner the name of the multi_rails rake task you want to run, or give it no args if you want the default behavior of testing against all versions of Rails."
+
+if ARGV.size > 1
+  puts HELP_MESSAGE
+else
+  MultiRails::Runner.run(ARGV.first)
+end

data/install.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+
+BAR = "=" * 80
+RUNNER_PATH = "script/multi_rails_runner"
+ACTUAL_PATH = File.expand_path(File.join(RAILS_ROOT, "/vendor/plugins/multi_rails/bin/multi_rails_runner.rb"))
+
+puts BAR
+puts "Installing multi_rails, and settig up /script/multi_rails_runner."
+
+FileUtils.symlink(ACTUAL_PATH, RUNNER_PATH, :force => true)
+`chmod +x #{RAILS_ROOT}/script/multi_rails_runner`
+puts "Run '#{RUNNER_PATH} bootstrap' to add the necessary multi_rails require line to the top of your environment.rb file."
+puts "Once that has been done, run '#{RUNNER_PATH}' from the root of our project to test your Rails app against all your versions of Rails."
+puts "Happy Testing !"
+puts BAR

data/lib/multi_rails.rb

@@ -1,12 +1,12 @@
 require 'rubygems'
 require 'logger'
-files = %w(core_extensions config loader multi_rails_error)
+files = %w(core_extensions config loader multi_rails_error rails_app_helper)
 files.each do |file|
   require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails/#{file}"))
 end
 
 module MultiRails
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   
   def self.gem_and_require_rails
     Loader.gem_and_require_rails

data/lib/multi_rails/config.rb

@@ -16,9 +16,9 @@ module MultiRails
         Loader.latest_stable_version
       end
       
-      def named_version_lookup(pretty_version)
-        version = @weird_versions[pretty_version] || pretty_version
-        raise MultiRailsError, "Can't find Rails gem version #{pretty_version} - available versions are: #{Loader.all_rails_versions.to_sentence})." if !Loader.all_rails_versions.include? version
+      def named_version_lookup(version)
+        version = @weird_versions[version] || version
+        raise MultiRailsError, "Can't find Rails gem version #{version} - available versions are: #{Loader.all_rails_versions.to_sentence})." if !Loader.all_rails_versions.include? version
         version
       end
       

data/lib/multi_rails/loader.rb

@@ -24,6 +24,10 @@ module MultiRails
       all_rails_versions.sort.reverse.detect {|version| version.count(".") < 3 }
     end
     
+    def self.latest_version
+      all_rails_versions.sort.last
+    end
+    
     # A version of the loader is created to gem and require one version of Rails
     def initialize(version)
       @version = version

data/lib/multi_rails/rails_app_helper.rb

@@ -0,0 +1,108 @@
+require 'rake'
+module MultiRails
+  module RailsAppHelper
+    RAILS_DIRECTORIES = %w(app config public test)    
+    REQUIRE_LINE = %[require File.expand_path('config/rails_version') if File.exist?("config/rails_version.rb")].freeze
+
+    class << self
+      
+      # Run the appropriate task or method for MultiRails
+      # This is called from the MultiRails command line runner
+      def run(task)
+        if task == "bootstrap"
+          self.bootstrap_for_rails
+        else
+          ENV["MULTIRAILS_FOR_RAILS_APP"] = "true"
+          Rake::Task["test:multi_rails:#{task}"].invoke
+        end
+      end
+      
+      # Do a one time bootstrap to let MultiRails do its thing -- we aren't putting this
+      # in the general MultiRails rake file to keep it from showing up in contexts where
+      # it doesn't make sense (ie when testing a plugin).
+      def bootstrap_for_rails
+        set_rails_root
+        add_require_line_to_environment_file
+      end
+      
+      # Make sure we have RAILS_ROOT set - will try to find it dynamically if its not set.
+      def set_rails_root
+        if Object.const_defined?("RAILS_ROOT")
+          RAILS_ROOT
+        else
+          Object.const_set("RAILS_ROOT", find_rails_root_dir)
+        end
+        raise("Must have a valid RAILS_ROOT.") unless Object.const_defined?("RAILS_ROOT") && RAILS_ROOT
+        RAILS_ROOT
+      end
+      
+      def clean_up
+        FileUtils.rm(rails_gem_version_file) if within_rails_app? && File.exist?(rails_gem_version_file)
+        rename_vendor_rails_to_original
+      end
+      
+      def init_for_rails_app(version)
+        set_rails_root
+        write_rails_gem_version_file(version)
+        rename_vendor_rails_if_necessary
+      end
+
+      def find_rails_root_dir
+        if current_dir_contains_rails_dirs? then Dir.pwd end
+      end
+      
+      def current_dir_contains_rails_dirs?
+        if RAILS_DIRECTORIES.all? { |rails_dir| Dir.entries(Dir.pwd).include?(rails_dir) }
+          Dir.pwd
+        end
+      end
+      
+      # Write out a file which is loaded later, so that the RAILS_GEM_VERSION gets set in the correct process
+      def write_rails_gem_version_file(version)
+        File.open(rails_gem_version_file, 'w') do |file|
+          file << %|RAILS_GEM_VERSION = '#{version}' unless Object.const_defined?("RAILS_GEM_VERSION")|
+        end
+      end
+      
+      def rails_gem_version_file
+        File.expand_path("#{RAILS_ROOT}/config/rails_version.rb")
+      end
+      
+      def rename_vendor_rails_if_necessary
+        File.rename(vendor_rails, vendor_rails_off) if File.directory?(vendor_rails)
+      end
+      
+      def rename_vendor_rails_to_original
+        File.rename(vendor_rails_off, vendor_rails) if File.directory?(vendor_rails_off)
+      end
+      
+      def add_require_line_to_environment_file
+        raise MultiRailsError, "Can't find environment.rb file was looking at path: #{environment_file}" unless File.exist?(environment_file)
+        unless first_environment_line == REQUIRE_LINE
+          original_content = File.read(environment_file)
+          File.open(environment_file, 'r+') do |f| 
+            f.puts REQUIRE_LINE
+            f.print original_content
+          end
+        end
+      end
+      
+      def first_environment_line
+        File.open(environment_file).readline.strip
+      end
+      
+      def environment_file
+        File.expand_path(File.join(RAILS_ROOT, "config/environment.rb"))
+      end
+      
+      def vendor_rails
+        "#{RAILS_ROOT}/vendor/rails"
+      end
+      
+      def vendor_rails_off
+        "#{RAILS_ROOT}/vendor/rails.off"
+      end
+    end
+    
+  end
+end

data/tasks/multi_rails.rake

@@ -11,31 +11,75 @@ end
 namespace :test do
   namespace :multi_rails do
 
-    desc "Run against all versions of rubygem installed versions of Rails"
+    desc "Run against all installed versions of Rails.  Local versions found: [#{MultiRails::Loader.all_rails_versions.to_sentence}]."
     task :all do
-      MultiRails::Loader.all_rails_versions.each_with_index do |version, index|
-        silence_warnings { ENV["MULTIRAILS_RAILS_VERSION"] = version }
-        print_rails_version
-        reset_rake_task unless index == 0
-        Rake::Task[:test].invoke
+      begin
+        MultiRails::Loader.all_rails_versions.each_with_index do |version, index|
+          silence_warnings { ENV["MULTIRAILS_RAILS_VERSION"] = version }
+          init_for_rails_app(version) if within_rails_app?
+          print_rails_version
+          reset_test_tasks unless index == 0
+          Rake::Task[:test].invoke
+        end
+      ensure
+        clean_up
       end
     end
     
     desc "Run against one verison of Rails specified as 'MULTIRAILS_RAILS_VERSION' - for example 'rake test:multi_rails:one MULTIRAILS_RAILS_VERSION=1.2.3'"
     task :one do
-      print_rails_version
-      Rake::Task[:test].invoke
+      begin
+        version = ENV["MULTIRAILS_RAILS_VERSION"]
+        raise "Must give a version number" unless version
+        init_for_rails_app(version) if within_rails_app?
+        print_rails_version
+        Rake::Task[:test].invoke
+      ensure
+        clean_up
+      end
     end
-
+    
+    desc "Run against the most recent version of Rails installed.  Most recent found: [#{MultiRails::Loader.latest_version}]."
+    task :latest do
+      begin
+        version = MultiRails::Loader.latest_version
+        ENV["MULTIRAILS_RAILS_VERSION"] = version
+        init_for_rails_app(version) if within_rails_app?
+        print_rails_version
+        Rake::Task[:test].invoke
+      ensure
+        clean_up
+      end
+    end
+    
+    def init_for_rails_app(version)
+      MultiRails::RailsAppHelper.init_for_rails_app(version)
+      load "Rakefile"
+    end
+    
+    def within_rails_app?
+      ENV["MULTIRAILS_FOR_RAILS_APP"] == "true"
+    end
+    
+    # clean up after ourselves, reverting to clean state if needed
+    def clean_up
+      MultiRails::RailsAppHelper.clean_up if within_rails_app?
+    end
+    
     BAR = "=" * 80
     def print_rails_version
       puts "\n#{BAR}\nRequiring rails version: #{MultiRails::Config.version_lookup}\n#{BAR}"
     end
     
     # Need to hack the Rake test task a bit, otherwise it will only run once and never repeat.
-    def reset_rake_task
-      Rake::Task[:test].already_invoked = false
-      Rake::Task[:test].prerequisites.each {|p| Rake::Task[p].already_invoked = false}
+    def reset_test_tasks
+      ["test", "test:units", "test:functionals", "test:integration"].each do |name| 
+        if Rake::Task.task_defined?(name)
+          Rake::Task[name].already_invoked = false
+          Rake::Task[name].prerequisites.each {|p| Rake::Task[p].already_invoked = false}
+        end
+      end
     end
+    
   end
 end

data/test/config_test.rb

@@ -1,9 +1,9 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))
 
 describe "Version Lookup in config" do
   
   it "should use argument version if passed in " do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3", "1.2.4"])
     MultiRails::Config.version_lookup("1.2.3").should == "1.2.3"
   end
   

data/test/core_extensions_test.rb

@@ -1,8 +1,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))
 
 describe "core extensions" do
   it "should extend Kernel" do
     Kernel.should.respond_to? :silence_warnings
   end
-end
+end

data/test/install_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
+
+describe "install hook" do
+  setup    { Object.const_set("RAILS_ROOT", "/src/rails_app") }
+  teardown { Object.send(:remove_const, "RAILS_ROOT") if Object.const_defined?("RAILS_ROOT")}
+  
+  def load_install
+    silence_warnings do
+      load File.expand_path(File.join(File.dirname(__FILE__), "../install.rb"))
+    end
+  end
+  
+  it "should copy the multi_rails_runner to the script directory" do
+    Object.any_instance.stubs(:puts).returns(nil)
+    Object.any_instance.stubs(:`)
+    
+    FileUtils.expects(:symlink).with("#{RAILS_ROOT}/vendor/plugins/multi_rails/bin/multi_rails_runner.rb", 
+      "script/multi_rails_runner", :force => true)
+    load_install
+  end
+  
+  it 'should make the file executable' do
+    Object.any_instance.stubs(:puts).returns(nil)
+    Object.any_instance.expects(:`).with("chmod +x #{RAILS_ROOT}/script/multi_rails_runner")
+    File.stubs(:symlink)
+    load_install
+  end
+  
+end

data/test/loader_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))
 
 describe "loader" do
   
@@ -25,6 +24,7 @@ describe "loader" do
   end
   
   it "should allow using a better name for weird gem version numbers, like 2.0.0 PR => 1.2.4.7794" do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3", "1.2.4", "1.2.4.7794"])
     stub_rails_requires
     MultiRails::Loader.any_instance.expects(:gem).with("rails", MultiRails::Config.weird_versions["2.0.0.PR"]).returns(true)
     MultiRails::Loader.gem_and_require_rails("2.0.0.PR")
@@ -78,3 +78,16 @@ describe "finding latest stable version" do
   end  
   
 end
+
+describe "finding latest version" do
+  it "should find the most recent version, regardless of edge or non edge versions" do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3", "1.2.5", "1.2.5.1343"])
+    MultiRails::Loader.latest_version.should == "1.2.5.1343"
+  end
+
+  it "should return the only version you have if there is only one installed" do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3"])
+    MultiRails::Loader.latest_version.should == "1.2.3"
+  end
+  
+end

data/test/multi_rails_init_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))
 
 describe "Rubygem test helper init" do
   it "should call gem and require rails" do

data/test/multi_rails_test_helper.rb

@@ -1,4 +1,6 @@
 require 'test/unit'
 require 'test/spec'
 require 'mocha'
-require 'redgreen' unless Object.const_defined?("TextMate")
+require 'redgreen' unless Object.const_defined?("TextMate")
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))

data/test/rails_app_helper_test.rb

@@ -0,0 +1,131 @@
+require 'tempfile'
+require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
+
+describe "running a task" do
+  setup { Object.const_set("RAILS_ROOT", "/src/rails_app")}
+  teardown { Object.send(:remove_const, "RAILS_ROOT")}
+  
+  it "should call the bootstrap method if thats the task" do
+    MultiRails::RailsAppHelper.expects(:bootstrap_for_rails)
+    MultiRails::RailsAppHelper.run('bootstrap')
+  end
+  
+  it "should invoke the corresponding rake task for any other arg" do
+    task = mock().expects(:invoke)
+    Rake::Task.expects(:[]).with("test:multi_rails:all").returns(task)
+    MultiRails::RailsAppHelper.run('all')
+  end
+  
+end
+
+describe "determing rails root" do
+  teardown { Object.send(:remove_const, "RAILS_ROOT") if Object.const_defined?("RAILS_ROOT")}
+  
+  it "should try the RAILS_ROOT constant first" do
+    Object.const_set("RAILS_ROOT", "/src/rails_app")
+    MultiRails::RailsAppHelper.set_rails_root.should == "/src/rails_app"
+  end
+  
+  it "should fallback to finding it dynamically" do
+    current_dir_stub = "/foo/bar/my_rails_app"
+    Dir.expects(:entries).returns(["app", "lib", "config", "public", "test", "vendor"]).at_least_once
+    Dir.expects(:pwd).returns(current_dir_stub).at_least_once
+    MultiRails::RailsAppHelper.set_rails_root.should == "/foo/bar/my_rails_app"
+  end
+  
+  it "should fail fast if it can't determine RAILS ROOT" do
+    MultiRails::RailsAppHelper.expects(:find_rails_root_dir).returns(nil)
+    lambda { MultiRails::RailsAppHelper.set_rails_root }.should.raise
+  end
+  
+end
+
+describe "writing rails gem version file" do
+  setup { Object.const_set("RAILS_ROOT", "/src/rails_app")}
+  teardown { Object.send(:remove_const, "RAILS_ROOT")}
+
+  it "should write to the correct file" do
+    File.expects(:open).with("#{RAILS_ROOT}/config/rails_version.rb", 'w')
+    MultiRails::RailsAppHelper.write_rails_gem_version_file('1.2.5')
+  end
+  
+end
+
+describe "init for rails app" do
+  it "should set rails root, write rails gem version file, and rename vendor rails" do
+    version = "1.2.6"
+    MultiRails::RailsAppHelper.expects(:set_rails_root)
+    MultiRails::RailsAppHelper.expects(:write_rails_gem_version_file).with(version)
+    MultiRails::RailsAppHelper.expects(:rename_vendor_rails_if_necessary)
+    MultiRails::RailsAppHelper.init_for_rails_app(version)
+  end
+end
+
+describe "renaming vendor/rails if it exists" do
+  setup { Object.const_set("RAILS_ROOT", "/src/rails_app")}
+  teardown { Object.send(:remove_const, "RAILS_ROOT")}
+  
+  it "should rename with .OFF extension so that gem version is picked up during test run" do
+    vendor_rails = "#{RAILS_ROOT}/vendor/rails"
+    File.stubs(:directory?).returns(true)
+    File.expects(:rename).with(vendor_rails, "#{vendor_rails}.off")
+    MultiRails::RailsAppHelper.rename_vendor_rails_if_necessary
+  end
+  
+  it "should do nothing if there is no vendor/rails" do
+    File.expects(:directory?).returns(false)
+    File.expects(:rename).never
+    MultiRails::RailsAppHelper.rename_vendor_rails_if_necessary
+  end
+end
+
+describe "adding require hook to top of environment.rb using mocks" do
+  setup { Object.const_set("RAILS_ROOT", "/src/rails_app")}
+  teardown { Object.send(:remove_const, "RAILS_ROOT")}
+  
+  it "should raise if it can't find environment.rb" do
+    e = lambda { MultiRails::RailsAppHelper.add_require_line_to_environment_file }.should.raise(MultiRailsError)
+  end
+  
+  it "should not do anything if the line is already in the file" do
+    File.stubs(:exist?).returns(true)
+    File.expects(:open).never
+    MultiRails::RailsAppHelper.expects(:first_environment_line).returns(MultiRails::RailsAppHelper::REQUIRE_LINE)
+    MultiRails::RailsAppHelper.add_require_line_to_environment_file
+  end
+  
+end
+
+describe "adding require hook to top of environment.rb (without using mocks)" do
+  
+  setup do
+    Object.const_set("RAILS_ROOT", "/src/rails_app")
+    @env_content = <<-EOL
+# Be sure to restart your web server when you modify this file.
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '1.2.5' unless defined? RAILS_GEM_VERSION
+EOL
+    @file = Tempfile.new('sample_environment')
+    @file << @env_content
+    @file.close
+  end
+  
+  teardown do
+    Object.send(:remove_const, "RAILS_ROOT")
+  end
+  
+  it "should add the require line" do
+    MultiRails::RailsAppHelper.stubs(:environment_file).returns(@file.path)
+    MultiRails::RailsAppHelper.add_require_line_to_environment_file
+    @file.open.rewind
+    lines = @file.readlines
+    lines[0].to_s.should == (MultiRails::RailsAppHelper::REQUIRE_LINE + "\n")
+    lines[1..-1].to_s.should == @env_content
+  end
+  
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: multi_rails
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-10-23 00:00:00 -04:00
+  version: 0.0.3
+date: 2007-12-06 00:00:00 -05:00
 summary: Testing tool to easily test agaist multiple versions of Rails.
 require_paths: 
 - lib
@@ -12,7 +12,7 @@ require_paths:
 email: multi_rails@googlegroups.com
 homepage: http://multi-rails.rubyforge.org/
 rubyforge_project: multi-rails
-description: "MultiRails by Relevance, http://thinkrelevance.com Rob Sanheim - MultiRails lead  == DESCRIPTION:  MultiRails allows easy testing against multiple versions of Rails for your Rails specific gem or plugin.  Use MultiRails to hook in Rails 2.0 testing in your continuous integration.  Still working on Rails 2.0 support?   Use MultiRails to see where your test suite falls down against the 2.0 preview releases of Rails.  MultiRails was initially developed by members of Relevance while developing Streamlined  against edge Rails.  To see how Streamlined uses MultiRails, go to http://trac.streamlinedframework.org.  == FEATURES/PROBLEMS:  * easily test plugins/extensions using a require from your test_helper.rb and a require in your RakeFile * rake tasks to test against a specific version of Rails, or all versions of Rails available locally as Gems  == TODOs:  * enable multi_rails testing in a plain ole' Rails app -- this is difficult right now because of the Rails boot process * improve docs on how to override what files are required by multi_rails * test against Rails versions that are just checked out, and not installed via Gems  == REQUIREMENTS:  * Ruby 1.8.5 or higher * Rubygems * Rails 1.2.1 or higher * at least one copy of Rails installed via rubygems.  == INSTALL:"
+description: "MultiRails by Relevance, http://thinkrelevance.com Rob Sanheim - MultiRails lead  == URLs:  rubyforge:    http://rubyforge.org/projects/multi-rails/ svn stable:   http://robsanheim.googlecode.com/svn/tags/stable/multi_rails svn trunk:    http://robsanheim.googlecode.com/svn/trunk/multi_rails mailing list: http://groups.google.com/group/multi_rails  == DESCRIPTION:  MultiRails allows easy testing against multiple versions of Rails for your Rails specific gem or plugin.  IT also has tentative support testing Rails applications against multiple versions of Rails.  Use MultiRails to hook in Rails 2.0 testing in your continuous integration.  Still working on Rails 2.0 support?  Use MultiRails to see where your test suite falls down against the 2.0 preview releases of Rails.  MultiRails was initially developed by members of Relevance while developing Streamlined  against edge Rails.  To see how Streamlined uses MultiRails, go to http://trac.streamlinedframework.org.  == FEATURES:  * easily test plugins/extensions using a require from your test_helper.rb and a require in your RakeFile * rake tasks to test against a specified version of Rails, the latest version, or all versions * tentative support for testing plain Rails apps against multiple versions of Rails * Uses rubygems for version management of Rails  == TODOs:  * improve docs on how to override what files are required by multi_rails * maybe add ability to load plain Rails versions -- ie checked out copies not in RubyGems  == NOTES:  * (__For Rails apps only__) multi_rails will rename your vendor/rails directory to vendor/rails.off if it finds one within your rails app.  We have to do this to make Rails fall back to RubyGems rails.  Multi_rails will rename back to the correct vendor/rails when done testing, so it will not interrupt your app in normal use. * (__For Rails apps only__) multi_rails needs to add a line to top of your environment.rb to hook into -- see the instructions below for more details"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -31,30 +31,35 @@ authors:
 - Relevance
 files: 
 - History.txt
+- MIT-LICENSE
 - Manifest.txt
 - README.txt
 - Rakefile
-- init.rb
+- bin/multi_rails_runner.rb
+- install.rb
 - lib/multi_rails.rb
 - lib/multi_rails/config.rb
 - lib/multi_rails/core_extensions.rb
 - lib/multi_rails/loader.rb
 - lib/multi_rails/multi_rails_error.rb
+- lib/multi_rails/rails_app_helper.rb
 - lib/multi_rails_init.rb
 - tasks/load_multi_rails_rake_tasks.rb
 - tasks/multi_rails.rake
 - test/config_test.rb
 - test/core_extensions_test.rb
-- test/init_test.rb
+- test/install_test.rb
 - test/loader_test.rb
 - test/multi_rails_init_test.rb
 - test/multi_rails_test_helper.rb
+- test/rails_app_helper_test.rb
 test_files: 
 - test/config_test.rb
 - test/core_extensions_test.rb
-- test/init_test.rb
+- test/install_test.rb
 - test/loader_test.rb
 - test/multi_rails_init_test.rb
+- test/rails_app_helper_test.rb
 rdoc_options: 
 - --main
 - README.txt
@@ -62,8 +67,8 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-executables: []
-
+executables: 
+- multi_rails_runner.rb
 extensions: []
 
 requirements: []

data/init.rb

@@ -1,4 +0,0 @@
-if Object.const_defined?("RAILS_ENV") && RAILS_ENV == "test"
-  require File.expand_path(File.join(File.dirname(__FILE__), "lib/multi_rails"))
-  MultiRails::gem_and_require_rails
-end

data/test/init_test.rb

@@ -1,28 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails_test_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails"))
-
-describe "Rails plugin init" do
-  it "should do nothing if RAILS_ENV isn't set" do
-    MultiRails.expects(:gem_and_require_rails).never
-    load File.expand_path(File.join(File.dirname(__FILE__), "../init.rb"))
-  end
-  
-  it "should only do anything in Test environment" do
-    MultiRails.expects(:gem_and_require_rails).never
-    load File.expand_path(File.join(File.dirname(__FILE__), "../init.rb"))
-  end
-  
-  it "should require rails in Test environment" do
-    silence_warnings do 
-      begin
-        orig_rails_env = Object.const_defined?("RAILS_ENV") ? Object.const_get("RAILS_ENV") : nil
-        Object.const_set("RAILS_ENV", "test")
-        MultiRails.expects(:gem_and_require_rails).once
-        load File.expand_path(File.join(File.dirname(__FILE__), "../init.rb"))
-      ensure
-        Object.const_set("RAILS_ENV", orig_rails_env)
-      end
-    end
-  end
-  
-end