appraisal 0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+gem "cucumber"
+gem "aruba"
+gem "rake"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.4)
+      background_process
+      cucumber (~> 0.9.3)
+    background_process (1.2)
+    builder (2.1.2)
+    cucumber (0.9.4)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  rake
+  rspec

data/README.textile

@@ -0,0 +1,97 @@
+h1. Appraisal
+
+Find out what your Ruby gems are worth.
+
+h2. Synopsis
+
+Appraisal integrates with bundler and rake to test your library against
+different versions of dependencies in repeatable scenarios called "appraisals."
+Appraisal is designed to make is easy to check for regressions in your library
+without interfering with day-to-day development using bundler.
+
+h2. Installation
+
+<pre>
+gem install appraisal
+</pre>
+
+h2. Setup
+
+Setting up appraisal requires an Appraisals file (similar to a Gemfile) in your
+project root, and some slight changes to your project's Rakefile.
+
+An Appraisals file consists of several appraisal definitions. An appraisal
+definition is simply a list of gem dependencies. For example, to test with a
+few versions of Rails:
+
+<pre>
+appraise "rails2" do
+  gem "rails", "2.3.9"
+end
+
+appraise "rails3" do
+  gem "rails", "3.0.0"
+end
+</pre>
+
+The dependencies in your Appraisals file are combined with dependencies in your
+Gemfile, so you don't need to repeat anything that's the same for each
+appraisal. If something is specified in both the Gemfile and an appraisal, the
+version from the appraisal takes precedence.
+
+Once you have an Appraisals file set up, just require appraisal in your Rakefile:
+
+<pre>
+require 'appraisal'
+</pre>
+
+It's also recommended that you setup bundler at the very top of your Rakefile,
+so that you don't need to constantly run bundle exec:
+
+<pre>
+require 'rubygems'
+require 'bundler/setup'
+</pre>
+
+h2. Usage
+
+Once you've configured the appraisals you want to use, you need to install the
+dependencies for each appraisal:
+
+<pre>
+rake appraisal:install
+</pre>
+
+This will resolve, install, and lock the dependencies for that appraisal using
+bundler. Once you have your dependencies setup, you can run any rake task in a
+single appraisal:
+
+<pre>
+rake appraisal:rails2 test
+</pre>
+
+This will run your "test" rake task using the dependencies configured for Rails
+2. You can also run each appraisal in turn:
+
+<pre>
+rake appraisal test
+</pre>
+
+If you want to use only the dependencies from your Gemfile, just run "rake
+test" as normal. This allows you to keep running with the latest versions of
+your dependencies in quick test runs, but keep running the tests in older
+versions to check for regressions.
+
+h2. Under the hood
+
+Running "rake appraisal:install" generates a Gemfile for each appraisal by
+combining your root Gemfile with the specific requirements for each appraisal.
+These are stored in the "gemfiles" directory, and should be added to version
+control to ensure that the same versions are always used. When running rake
+tasks for an appraisal, the rake task is run with the appropriate Gemfile for
+that appraisal, ensuring the correct dependencies are used.
+
+h2. Author
+
+Copyright 2010 Joe Ferris
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake/gempackagetask'
+require 'cucumber/rake/task'
+
+eval("$specification = #{IO.read('appraisal.gemspec')}")
+Rake::GemPackageTask.new($specification) do |package|
+  package.need_zip = true
+  package.need_tar = true
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+desc "Default: run the cucumber scenarios"
+task :default => :cucumber
+

data/features/appraisals.feature

@@ -0,0 +1,75 @@
+Feature: run a rake task through several appraisals
+
+  Background:
+    Given a directory named "projecto"
+    When I cd to "projecto"
+    And I write to "Gemfile" with:
+    """
+    source "http://rubygems.org"
+    gem "rake"
+    gem "factory_girl"
+    """
+    When I add "appraisal" from this project as a dependency
+    And I write to "Appraisals" with:
+    """
+    appraise "1.3.2" do
+      gem "factory_girl", "1.3.2"
+    end
+    appraise "1.3.0" do
+      gem "factory_girl", "1.3.0"
+    end
+    """
+    When I write to "Rakefile" with:
+    """
+    require 'rubygems'
+    require 'bundler/setup'
+    require 'appraisal'
+    task :version do
+      require 'factory_girl'
+      puts "Loaded #{Factory::VERSION}"
+    end
+    task :fail do
+      require 'factory_girl'
+      puts "Fail #{Factory::VERSION}"
+      raise
+    end
+    task :default => :version
+    """
+    When I successfully run "rake appraisal:install --trace"
+
+  @disable-bundler
+  Scenario: run a specific task with one appraisal
+    When I successfully run "rake appraisal:1.3.0 version --trace"
+    Then the output should contain "Loaded 1.3.0"
+
+  @disable-bundler
+  Scenario: run a specific task with all appraisals
+    When I successfully run "rake appraisal version --trace"
+    Then the output should contain "Loaded 1.3.0"
+    And the output should contain "Loaded 1.3.2"
+    And the output should not contain "Invoke version"
+
+  @disable-bundler
+  Scenario: run the default task with one appraisal
+    When I successfully run "rake appraisal:1.3.0 --trace"
+    Then the output should contain "Loaded 1.3.0"
+
+  @disable-bundler
+  Scenario: run the default task with all appraisals
+    When I successfully run "rake appraisal --trace"
+    Then the output should contain "Loaded 1.3.0"
+    And the output should contain "Loaded 1.3.2"
+
+  @disable-bundler
+  Scenario: run a failing task with one appraisal
+    When I run "rake appraisal:1.3.0 fail --trace"
+    Then the output should contain "Fail 1.3.0"
+    And the exit status should be 1
+
+  @disable-bundler
+  Scenario: run a failing task with all appraisals
+    When I run "rake appraisal fail --trace"
+    Then the output should contain "Fail 1.3.2"
+    But the output should not contain "Fail 1.3.0"
+    And the exit status should be 1
+

data/features/step_definitions/dependency_steps.rb

@@ -0,0 +1,4 @@
+When /^I add "([^"]*)" from this project as a dependency$/ do |gem_name|
+  append_to_file('Gemfile', %{\ngem "#{gem_name}", :path => "#{PROJECT_ROOT}"})
+end
+

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'aruba'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+

data/lib/appraisal.rb

@@ -0,0 +1,4 @@
+require 'appraisal/task'
+
+Appraisal::Task.new
+

data/lib/appraisal/appraisal.rb

@@ -0,0 +1,46 @@
+require 'appraisal/gemfile'
+require 'appraisal/command'
+require 'fileutils'
+
+module Appraisal
+  # Represents one appraisal and its dependencies
+  class Appraisal
+    attr_reader :name, :gemfile
+
+    def initialize(name, source_gemfile)
+      @name = name
+      @gemfile = source_gemfile.dup
+    end
+
+    def gem(name, *requirements)
+      gemfile.gem(name, *requirements)
+    end
+
+    def write_gemfile
+      ::File.open(gemfile_path, "w") do |file|
+        file.puts("# This file was generated by Appraisal")
+        file.puts
+        file.write(gemfile.to_s)
+      end
+    end
+
+    def install
+      Command.new("bundle install --gemfile=#{gemfile_path}").run
+    end
+
+    def gemfile_path
+      unless ::File.exist?(gemfile_root)
+        FileUtils.mkdir(gemfile_root)
+      end
+
+      ::File.join(gemfile_root, "#{name}.gemfile")
+    end
+
+    private
+
+    def gemfile_root
+      "gemfiles"
+    end
+  end
+end
+

data/lib/appraisal/command.rb

@@ -0,0 +1,57 @@
+module Appraisal
+  # Executes commands with a clean environment
+  class Command
+    BUNDLER_ENV_VARS = %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE).freeze
+
+    def self.from_args(gemfile)
+      command = ([$0] + ARGV.slice(1, ARGV.size)).join(' ')
+      new(command, gemfile)
+    end
+
+    def initialize(command, gemfile = nil)
+      @original_env = {}
+      @gemfile = gemfile
+      @command = command
+    end
+
+    def run
+      announce
+      with_clean_env do
+        unless Kernel.system(@command)
+          exit(1)
+        end
+      end
+    end
+
+    def exec
+      announce
+      with_clean_env { Kernel.exec(@command) }
+    end
+
+    private
+
+    def with_clean_env
+      unset_bundler_env_vars
+      ENV['BUNDLE_GEMFILE'] = @gemfile
+      yield
+    ensure
+      restore_env
+    end
+
+    def announce
+      puts ">> BUNDLE_GEMFILE=#{@gemfile} #{@command}"
+    end
+
+    def unset_bundler_env_vars
+      BUNDLER_ENV_VARS.each do |key|
+        @original_env[key] = ENV[key]
+        ENV[key] = nil
+      end
+    end
+
+    def restore_env
+      @original_env.each { |key, value| ENV[key] = value }
+    end
+  end
+end
+

data/lib/appraisal/dependency.rb

@@ -0,0 +1,27 @@
+module Appraisal
+  # Dependency on a gem and optional version requirements
+  class Dependency
+    attr_reader :name, :requirements
+
+    def initialize(name, requirements)
+      @name = name
+      @requirements = requirements
+    end
+
+    def to_s
+      gem_name = %{gem "#{name}"}
+      if requirements.nil? || requirements.empty?
+        gem_name
+      else
+        "#{gem_name}, #{inspect_requirements}"
+      end
+    end
+
+    private
+
+    def inspect_requirements
+      requirements.map { |requirement| requirement.inspect }.join(", ")
+    end
+  end
+end
+

data/lib/appraisal/file.rb

@@ -0,0 +1,41 @@
+require 'appraisal/appraisal'
+require 'appraisal/gemfile'
+
+module Appraisal
+  # Loads and parses Appraisal files
+  class File
+    attr_reader :appraisals, :gemfile
+
+    def self.each(&block)
+      new.each(&block)
+    end
+
+    def initialize
+      @appraisals = []
+      @gemfile = Gemfile.new
+      @gemfile.load('Gemfile')
+      run(IO.read(path))
+    end
+
+    def each(&block)
+      appraisals.each(&block)
+    end
+
+    def appraise(name, &block)
+      @appraisals << Appraisal.new(name, gemfile).tap do |appraisal|
+        appraisal.instance_eval(&block)
+      end
+    end
+
+    private
+
+    def run(definitions)
+      instance_eval definitions, __FILE__, __LINE__
+    end
+
+    def path
+      'Appraisals'
+    end
+  end
+end
+

data/lib/appraisal/gemfile.rb

@@ -0,0 +1,42 @@
+require 'appraisal/dependency'
+
+module Appraisal
+  # Load bundler Gemfiles and merge dependencies
+  class Gemfile
+    attr_reader :dependencies
+
+    def initialize
+      @dependencies = {}
+    end
+
+    def load(path)
+      run(IO.read(path))
+    end
+
+    def run(definitions)
+      instance_eval(definitions, __FILE__, __LINE__)
+    end
+
+    def gem(name, *requirements)
+      @dependencies[name] = Dependency.new(name, requirements)
+    end
+
+    def source(source)
+      @source = source
+    end
+
+    def to_s
+      %{source "#{@source}"\n} <<
+        dependencies.values.map { |dependency| dependency.to_s }.join("\n")
+    end
+
+    def dup
+      Gemfile.new.tap do |gemfile|
+        gemfile.source @source
+        dependencies.values.each do |dependency|
+          gemfile.gem(dependency.name, *dependency.requirements)
+        end
+      end
+    end
+  end
+end

data/lib/appraisal/task.rb

@@ -0,0 +1,44 @@
+require 'appraisal/file'
+require 'rake/tasklib'
+
+module Appraisal
+  # Defines tasks for installing appraisal dependencies and running other tasks
+  # for a given appraisal.
+  class Task < Rake::TaskLib
+    def initialize
+      namespace :appraisal do
+        desc "Generate a Gemfile for each appraisal"
+        task :gemfiles do
+          File.each do |appraisal|
+            appraisal.write_gemfile
+          end
+        end
+
+        desc "Resolve and install dependencies for each appraisal"
+        task :install => :gemfiles do
+          File.each do |appraisal|
+            appraisal.install
+          end
+        end
+
+        File.each do |appraisal|
+          desc "Run the given task for appraisal #{appraisal.name}"
+          task appraisal.name do
+            Command.from_args(appraisal.gemfile_path).exec
+          end
+        end
+
+        task :all do
+          File.each do |appraisal|
+            Command.from_args(appraisal.gemfile_path).run
+          end
+          exit
+        end
+      end
+
+      desc "Run the given task for all appraisals"
+      task :appraisal => "appraisal:all"
+    end
+  end
+end
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: appraisal
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Joe Ferris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: cucumber
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: aruba
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rake
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: Appraisal integrates with bundler and rake to test your library against different versions of dependencies in repeatable scenarios called "appraisals."
+email: jferris@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- README.textile
+- lib/appraisal/appraisal.rb
+- lib/appraisal/command.rb
+- lib/appraisal/dependency.rb
+- lib/appraisal/file.rb
+- lib/appraisal/gemfile.rb
+- lib/appraisal/task.rb
+- lib/appraisal.rb
+- features/appraisals.feature
+- features/step_definitions/dependency_steps.rb
+- features/support/env.rb
+has_rdoc: false
+homepage: http://github.com/thoughtbot/appraisal
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Find out what your Ruby gems are worth
+test_files: 
+- features/appraisals.feature
+- features/step_definitions/dependency_steps.rb
+- features/support/env.rb