multi_rails 0.0.2

data/History.txt

@@ -0,0 +1,11 @@
+== 0.0.2 / Tuesday; October 23, 2007
+
+* first public release!
+* add link to email group
+* improve docs
+* add hook file to load rake tasks when used as a gem
+* change the env var for specifying the rails version under test to avoid name conflicts
+
+== 0.0.1 / Sunday; October 21, 2007
+
+* initial release, no public announcment

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+init.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_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/loader_test.rb
+test/multi_rails_init_test.rb
+test/multi_rails_test_helper.rb

data/README.txt

@@ -0,0 +1,96 @@
+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:
+
+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.
+
+  require 'load_multi_rails_rake_tasks'
+  
+* run rake -T in your root, verify that you see two new rake tasks.
+
+  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.  
+
+  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
+  
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Relevance, 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/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'hoe'
+require File.expand_path(File.join(File.dirname(__FILE__), "/lib/multi_rails"))
+load File.expand_path(File.join(File.dirname(__FILE__), "/tasks/multi_rails.rake"))
+
+Hoe.new('multi_rails', MultiRails::VERSION) do |p|
+  p.rubyforge_name = 'multi-rails'
+  p.author = 'Relevance'
+  p.email = 'multi_rails@googlegroups.com'
+  p.summary = 'Testing tool to easily test agaist multiple versions of Rails.'
+  p.description = p.paragraphs_of('README.txt', 0..10).join("\n\n")
+  p.url = 'http://multi-rails.rubyforge.org/'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  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

data/init.rb

@@ -0,0 +1,4 @@
+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/lib/multi_rails.rb

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

data/lib/multi_rails/config.rb

@@ -0,0 +1,28 @@
+module MultiRails
+
+  # Simple config object
+  class Config
+    @weird_versions = { "2.0.0.PR" => "1.2.4.7794" }
+    @rails_requires = %w[active_support
+                         active_record 
+                         action_controller 
+                         action_controller/test_process]
+    
+    class << self
+      attr_accessor :weird_versions, :rails_requires
+      def version_lookup(version = nil)
+        return named_version_lookup(version) if version
+        return named_version_lookup(ENV["MULTIRAILS_RAILS_VERSION"]) if ENV['MULTIRAILS_RAILS_VERSION']
+        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
+        version
+      end
+      
+    end
+  end
+  
+end

data/lib/multi_rails/core_extensions.rb

@@ -0,0 +1,44 @@
+# Add some nice to haves from ActiveSupport
+
+module Kernel
+  def silence_warnings
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end
+
+module HashExtensions
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+
+  def reverse_merge!(other_hash)
+    replace(reverse_merge(other_hash))
+  end
+end
+
+module ArrayExtensions
+  # Converts the array to comma-seperated sentence where the last element is joined by the connector word. Options:
+  # * <tt>:connector</tt>: The word used to join the last element in arrays with two or more elements (default: "and")
+  # * <tt>:skip_last_comma</tt>: Set to true to return "a, b and c" instead of "a, b, and c".
+  def to_sentence(options = {})
+    options.reverse_merge! :connector => 'and', :skip_last_comma => false
+    
+    case length
+    	when 0
+    		""
+      when 1
+        self[0]
+      when 2
+        "#{self[0]} #{options[:connector]} #{self[1]}"
+      else
+        "#{self[0...-1].join(', ')}#{options[:skip_last_comma] ? '' : ','} #{options[:connector]} #{self[-1]}"
+    end
+  end
+  
+end
+
+Array.send(:include, ArrayExtensions) unless Array.respond_to?(:to_sentence)
+Hash.send(:include, HashExtensions) unless Hash.respond_to?(:reverse_merge) && Hash.respond_to?(:reverse_merge!)

data/lib/multi_rails/loader.rb

@@ -0,0 +1,50 @@
+module MultiRails
+
+  class Loader
+    attr_reader :version
+    
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+    
+    # Require and gem rails
+    # Will use a default version if none is supplied
+    def self.gem_and_require_rails(rails_version = nil)
+      rails_version = MultiRails::Config.version_lookup(rails_version)
+      Loader.new(rails_version).gem_and_require_rails
+    end
+    
+    # Returns a list of all Rails versions available, oldest first
+    def self.all_rails_versions
+      specs = Gem::cache.find_name("rails")
+      specs.map {|spec| spec.version.to_s }.sort
+    end
+    
+    def self.latest_stable_version
+      all_rails_versions.sort.reverse.detect {|version| version.count(".") < 3 }
+    end
+    
+    # A version of the loader is created to gem and require one version of Rails
+    def initialize(version)
+      @version = version
+    end
+    
+    # Gem a version of Rails, and require appropriate files
+    def gem_and_require_rails
+      gem_rails
+      require_rails
+    end
+    
+    def gem_rails
+      gem 'rails', version
+    rescue LoadError => e
+      msg = %Q[Cannot find gem for Rails version: '#{version}'!\nInstall the missing gem with:\nsudo gem install -v=#{version} rails]
+      raise MultiRailsError, msg
+    end
+    
+    def require_rails
+      Config.rails_requires.each {|lib| require lib }
+    end
+  end
+  
+end

data/lib/multi_rails/multi_rails_error.rb

@@ -0,0 +1,2 @@
+class MultiRailsError < RuntimeError
+end

data/lib/multi_rails_init.rb

@@ -0,0 +1,3 @@
+# We include an init file here to be easily required using a gemmed version of MultiRails
+require File.expand_path(File.join(File.dirname(__FILE__), "multi_rails"))
+MultiRails::gem_and_require_rails

data/tasks/load_multi_rails_rake_tasks.rb

@@ -0,0 +1 @@
+load File.expand_path(File.join(File.dirname(__FILE__), "multi_rails.rake"))

data/tasks/multi_rails.rake

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require File.expand_path(File.join(File.dirname(__FILE__), "/../lib/multi_rails"))
+
+# Enable overriding the already invoked flag of a Rake task
+class Rake::Task
+  attr_accessor :already_invoked
+end
+
+namespace :test do
+  namespace :multi_rails do
+
+    desc "Run against all versions of rubygem installed versions of Rails"
+    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
+      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
+    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}
+    end
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,32 @@
+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::Config.version_lookup("1.2.3").should == "1.2.3"
+  end
+  
+  it "should use env var if set" do
+    begin
+      MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.99"])
+      ENV["MULTIRAILS_RAILS_VERSION"] = "1.2.99"
+      MultiRails::Config.version_lookup.should == "1.2.99"
+    ensure
+      silence_warnings { ENV["MULTIRAILS_RAILS_VERSION"] = nil }
+    end
+  end
+  
+  it "should raise if providing env var and we dont find a corresponding version" do
+    begin
+      ENV["MULTIRAILS_RAILS_VERSION"] = "X.X.99"
+      lambda { MultiRails::Config.version_lookup }.should.raise(MultiRailsError)
+    ensure
+      silence_warnings { ENV["MULTIRAILS_RAILS_VERSION"] = nil }
+    end
+  end
+  
+  it "should use latest stable version if there is no argumnt or env var" do
+    MultiRails::Config.version_lookup.should == MultiRails::Loader.latest_stable_version
+  end
+end

data/test/core_extensions_test.rb

@@ -0,0 +1,8 @@
+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

data/test/init_test.rb

@@ -0,0 +1,28 @@
+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

data/test/loader_test.rb

@@ -0,0 +1,80 @@
+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
+  
+  setup do
+    never_really_require_rails
+    never_puts
+  end
+  
+  it "should fall back to a default verison to try" do
+    stub_rails_requires
+    MultiRails::Loader.any_instance.expects(:gem).with("rails", MultiRails::Loader.latest_stable_version)
+    MultiRails::Loader.gem_and_require_rails
+  end
+  
+  it "should fail fast if we are missing a requested gem version" do
+    lambda { MultiRails::Loader.gem_and_require_rails("9.9.9") }.should.raise(MultiRailsError)
+  end
+  
+  it "should gem the specified version" do
+    stub_rails_requires
+    MultiRails::Loader.any_instance.expects(:gem).with("rails", "1.2.5").returns(true)
+    MultiRails::Loader.gem_and_require_rails("1.2.5")
+  end
+  
+  it "should allow using a better name for weird gem version numbers, like 2.0.0 PR => 1.2.4.7794" do
+    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")
+  end
+
+  it "should require the needed dependancies" do
+    MultiRails::Loader.any_instance.stubs(:gem)
+    MultiRails::Config.rails_requires.each do |file|
+      MultiRails::Loader.any_instance.expects(:require).with(file)
+    end
+    MultiRails::Loader.gem_and_require_rails
+  end
+  
+  def stub_rails_requires
+    MultiRails::Loader.any_instance.stubs(:require).returns(true)
+  end
+  
+  def never_really_require_rails
+    MultiRails::Loader.any_instance.expects(:require).never
+  end
+  
+  def never_puts
+    MultiRails::Loader.stubs(:puts)
+  end
+end
+
+describe "finding all gems of rails available" do
+  
+  it "should find rails by name when retrieving all rails versions, in order to avoid false positives with other gems with rails in the name" do
+    Gem::cache.expects(:find_name).with("rails").returns([])
+    MultiRails::Loader.all_rails_versions
+  end
+  
+  it "should return all Rails versions it finds sorted with the earliest versions first" do
+    specs = [stub(:version => stub(:to_s => "1.2.4")), stub(:version => stub(:to_s => "1.2.3"))]
+    Gem::cache.expects(:find_name).with("rails").returns(specs)
+    MultiRails::Loader.all_rails_versions.should == ["1.2.3", "1.2.4"]
+  end
+  
+end
+
+describe "finding latest stable version" do
+  it "should find the latest stable rails gem" do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3", "1.2.5", "1.2.5.1343"])
+    MultiRails::Loader.latest_stable_version.should == "1.2.5"
+  end  
+  
+  it "should find 2.0.0 when its released" do
+    MultiRails::Loader.stubs(:all_rails_versions).returns(["1.2.3", "1.2.5", "1.2.5.1343", "2.0.0", "1.2.7"])
+    MultiRails::Loader.latest_stable_version.should == "2.0.0"
+  end  
+  
+end

data/test/multi_rails_init_test.rb

@@ -0,0 +1,17 @@
+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
+    MultiRails.expects(:gem_and_require_rails).once
+    load File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails_init.rb"))
+  end
+  
+  it "should actually do the gem and require" do
+    MultiRails::Loader.any_instance.expects(:require).never
+    MultiRails::Loader.any_instance.expects(:gem_rails)
+    MultiRails::Loader.any_instance.expects(:require_rails)
+    load File.expand_path(File.join(File.dirname(__FILE__), "../lib/multi_rails_init.rb"))
+  end
+  
+end

data/test/multi_rails_test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'test/spec'
+require 'mocha'
+require 'redgreen' unless Object.const_defined?("TextMate")

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+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
+summary: Testing tool to easily test agaist multiple versions of Rails.
+require_paths: 
+- lib
+- tasks
+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:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Relevance
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- init.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_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/loader_test.rb
+- test/multi_rails_init_test.rb
+- test/multi_rails_test_helper.rb
+test_files: 
+- test/config_test.rb
+- test/core_extensions_test.rb
+- test/init_test.rb
+- test/loader_test.rb
+- test/multi_rails_init_test.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: