appraisal 0.5.2 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5219eedbc26798b63b1aab040b7a511751c725b
-  data.tar.gz: 9e654d7ce29fa85fe3d6086e9f15679fd7ddf4af
+  metadata.gz: 90e8b6522115c4dc3c17e760c10c3be470782a10
+  data.tar.gz: 88f5f2cd1d763807d3365a1c216883066922a683
 SHA512:
-  metadata.gz: f940b01fa7a150d127336194c2464601f39f5dfa8aeebc302da7cc968eaa53a62a32a69b029cacd0e12d7c7ded13cf4244b45239c3813fb66874a106423f8f5b
-  data.tar.gz: d7f5148386343f5e1a85f0b703c2a52f3a46281a1e918751eb4ff201aff878093823a8520eb6ee0e022be5f2346951fd7286bfb69e3085572629e169dd47c178
+  metadata.gz: 16adfbd7bf60a34ff6567d3c5b177af70fbc07a4d9d0a8d57e63241d404a47ab95b513f9def0ffa3ce35047d6ca04e5a7b87f0973ddeab0f87f4cbf203977b05
+  data.tar.gz: 802f454088dece1fbc37920e67c5eab145f38e7789de70b3a9b9580bde97f1090cd0459011455483739a965b047089a846b74d716e39ab416b6797a96e9e6e24

data/.travis.yml

@@ -1,7 +1,15 @@
+before_install: gem install bundler --pre
+
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
-branches:
-  only:
-    - master
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: ruby-head
+    - rvm: jruby-head

data/README.md

@@ -1,14 +1,20 @@
-# Appraisal [![Build Status](https://secure.travis-ci.org/thoughtbot/appraisal.png)](http://travis-ci.org/thoughtbot/appraisal?branch=master)
+Appraisal
+=========
+
+[![Build Status][Build Status Image]][Build Status]
 
 Find out what your Ruby gems are worth.
 
+[Build Status Image]: https://secure.travis-ci.org/thoughtbot/appraisal.png?branch=master
+[Build Status]: http://travis-ci.org/thoughtbot/appraisal
+
 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 it easy to check for regressions in your library
-without interfering with day-to-day development using bundler.
+without interfering with day-to-day development using Bundler.
 
 Installation
 ------------
@@ -17,22 +23,27 @@ In your Gemfile:
 
     gem "appraisal"
 
+Note that gems must be bundled in the global namespace. Bundling gems to a local
+location or vendoring plugins is not supported. If you do not want to pollute the
+global namespace, one alternative is [RVM's Gemsets](http://rvm.io/gemsets).
+
 Setup
 -----
 
 Setting up appraisal requires an Appraisals file (similar to a Gemfile) in your
-project root, named "Appraisals" (note the case), and some slight changes to your project's Rakefile.
+project root, named "Appraisals" (note the case), 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:
 
-    appraise "rails2" do
-      gem "rails", "2.3.9"
+    appraise "rails-3" do
+      gem "rails", "3.2.14"
     end
 
-    appraise "rails3" do
-      gem "rails", "3.0.0"
+    appraise "rails-4" do
+      gem "rails", "4.0.0"
     end
 
 The dependencies in your Appraisals file are combined with dependencies in your
@@ -40,15 +51,11 @@ 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:
-
-    require 'appraisal'
-
 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:
 
-    require 'rubygems'
-    require 'bundler/setup'
+    require "rubygems"
+    require "bundler/setup"
 
 Usage
 -----
@@ -56,55 +63,99 @@ Usage
 Once you've configured the appraisals you want to use, you need to install the
 dependencies for each appraisal:
 
-    rake appraisal:install
+    appraisal install
 
 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
+bundler. Once you have your dependencies set up, you can run any command in a
 single appraisal:
 
-    rake appraisal:rails2 test
+    appraisal rails-3 rake test
 
-This will run your "test" rake task using the dependencies configured for Rails
-2. You can also run each appraisal in turn:
+This will run `rake test` using the dependencies configured for Rails 3. You can
+also run each appraisal in turn:
 
-    rake appraisal test
+    appraisal rake test
 
-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
+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.
 
+In the case that you want to run all the appraisals by default when you run
+`rake`, you can override your default Rake task by put this into your Rakefile:
+
+    if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+      task :default => :appraisal
+    end
+
+(Appraisal sets `APPRAISAL_INITIALIZED` environment variable when it runs your
+process. We put a check here to ensure that `appraisal rake` command should run
+your real default task, which usually is your `test` task.)
+
+Note that this may conflict with your CI setup if you decide to split the test
+into multiple processes by Appraisal and you are using `rake` to run tests by
+default. Please see **Travis CI Integration** for more detail.
+
 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.
+Running `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 you prefix a command with `appraisal`, the command is run with the
+appropriate Gemfile for that appraisal, ensuring the correct dependencies
+are used.
 
 Version Control
---------------
+---------------
+
+When using Appraisal, we recommend you check in the Gemfiles that Appraisal
+generates within the gemfiles directory, but exclude the lockfiles there
+(`*.gemfile.lock`.) The Gemfiles are useful when running your tests against a
+continuous integration server such as [Travis CI][Travis CI].
+
+[Travis CI]: https://travis-ci.org
+
+Travis CI integration
+---------------------
 
-When using Appraisal, we recommend that you check your Gemfile.lock into
-version control, as well as the gemfiles directory generated by Appraisal. This
-will ensure that your tests are always green when you check out a fresh copy.
-It also allows you to create reproducible regression tests for version-specific
-bugs.
+If you're using Appraisal and using Travis CI, we're recommending you to setup
+Travis to run the test against multiple generated Gemfiles. This can be done
+by using `gemfile` setting:
+
+    # In .travis.yml
+    gemfile:
+      - gemfiles/3.0.gemfile
+      - gemfiles/3.1.gemfile
+      - gemfiles/3.2.gemfile
+
+Please note that if you've set your default rake task to run the test against
+all versions of its dependency, you might have to set a `script` setting:
+
+    script: "bundle exec rake test"
+
+That will make sure that each of the test sub-job are not getting run more than
+one time.
 
 Credits
 -------
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
-Appraisal is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+Appraisal is maintained and funded by [thoughtbot, inc][thoughtbot]
 
-Thank you to all [the contributors](https://github.com/thoughtbot/appraisal/contributors)!
+Thank you to all [the contributors][contributors]
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
+[thoughtbot]: http://thoughtbot.com/community
+[contributors]: https://github.com/thoughtbot/appraisal/contributors
+
 License
 -------
 
-Appraisal is Copyright © 2010-2013 Joe Ferris and thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Appraisal is Copyright © 2010-2013 Joe Ferris and thoughtbot, inc. It is free
+software, and may be redistributed under the terms specified in the MIT-LICENSE
+file.

data/appraisal.gemspec

@@ -3,14 +3,15 @@ $:.push File.expand_path("../lib", __FILE__)
 require "appraisal/version"
 
 Gem::Specification.new do |s|
-  s.name        = %q{appraisal}
+  s.name        = 'appraisal'
   s.version     = Appraisal::VERSION.dup
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Joe Ferris"]
-  s.email       = %q{jferris@thoughtbot.com}
-  s.homepage    = "http://github.com/thoughtbot/appraisal"
-  s.summary     = %q{Find out what your Ruby gems are worth}
-  s.description = %q{Appraisal integrates with bundler and rake to test your library against different versions of dependencies in repeatable scenarios called "appraisals."}
+  s.authors     = ['Joe Ferris', 'Prem Sichanugrist']
+  s.email       = ['jferris@thoughtbot.com', 'prem@thoughtbot.com']
+  s.homepage    = 'http://github.com/thoughtbot/appraisal'
+  s.summary     = 'Find out what your Ruby gems are worth'
+  s.description = 'Appraisal integrates with bundler and rake to test your library against different versions of dependencies in repeatable scenarios called "appraisals."'
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -19,8 +20,10 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('rake')
   s.add_runtime_dependency('bundler')
+  s.add_runtime_dependency('thor', '~> 0.18.1')
 
+  s.add_development_dependency('activesupport', '>= 3.2.13')
   s.add_development_dependency('cucumber', '~> 1.0')
   s.add_development_dependency('rspec', '~> 2.6')
-  s.add_development_dependency('aruba', '~> 0.4.2')
+  s.add_development_dependency('aruba', '~> 0.5.1')
 end

data/bin/appraisal

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'appraisal'
+require 'appraisal/cli'
+
+Appraisal::CLI.start

data/features/appraisals.feature

@@ -16,11 +16,13 @@ Feature: run a rake task through several appraisals
     """
     gem "dummy_rake", "0.8.7"
     gem "dummy_girl"
+
     group :assets do
-      gem 'dummy_sass', "  ~> 3.1.0"
+      gem 'dummy_sass', "~> 3.1.0"
     end
+
     group :test, :development do
-      gem 'dummy_spec', "  ~> 3.1.0"
+      gem 'dummy_spec', "~> 3.1.0"
     end
     """
     When I add "appraisal" from this project as a dependency
@@ -29,6 +31,7 @@ Feature: run a rake task through several appraisals
     appraise "1.3.2" do
       gem "dummy_girl", "1.3.2"
     end
+
     appraise "1.3.0" do
       gem "dummy_girl", "1.3.0"
       gem "dummy_rake", "0.9.0"
@@ -39,15 +42,18 @@ Feature: run a rake task through several appraisals
     require 'rubygems'
     require 'bundler/setup'
     require 'appraisal'
+
     task :version do
       require 'dummy_girl'
       puts "Loaded #{$dummy_girl_version}"
     end
+
     task :fail do
       require 'dummy_girl'
       puts "Fail #{$dummy_girl_version}"
       raise
     end
+
     task :default => :version
     """
     When I successfully run `bundle install --local`
@@ -89,3 +95,11 @@ Feature: run a rake task through several appraisals
     And a file named "gemfiles/1.3.0.gemfile.lock" should not exist
     And a file named "gemfiles/1.3.2.gemfile" should not exist
     And a file named "gemfiles/1.3.2.gemfile.lock" should not exist
+
+  Scenario: install gems within groups
+    Then the file "gemfiles/1.3.0.gemfile" should contain:
+      """
+      group :assets do
+        gem "dummy_sass", "~> 3.1.0"
+      end
+      """

data/features/bundler_gemfile_compatibility.feature

@@ -0,0 +1,70 @@
+@disable-bundler
+Feature: Bundler Gemfile Compatibility
+
+  Scenario: Parsing Gemfile
+    Given the following installed dummy gems:
+      | name      | version |
+      | bacon     | 1.0.0   |
+      | bread     | 1.0.0   |
+      | miso_soup | 1.0.0   |
+      | rice      | 1.0.0   |
+    And a git repository exists for gem "egg" with version "0.1.0"
+    And I write to "Gemfile" with:
+    """
+    source "https://rubygems.org"
+    ruby RUBY_VERSION
+
+    git "./egg" do
+      gem "egg"
+    end
+
+    group :breakfast do
+      gem "bacon"
+    end
+    """
+    And I add "appraisal" from this project as a dependency
+    And I write to "Appraisals" with:
+    """
+    appraise "japanese" do
+      gem "rice"
+      gem "miso_soup"
+    end
+
+    appraise "english" do
+      gem "bread"
+    end
+    """
+    And I write to "Rakefile" with:
+    """
+    require 'rubygems'
+    require 'bundler/setup'
+    require 'appraisal'
+    """
+    When I successfully run `bundle install --local`
+    And I successfully run `bundle exec rake appraisal:gemfiles --trace`
+    Then the file "gemfiles/japanese.gemfile" should contain:
+    """
+    source "https://rubygems.org"
+    """
+    And the file "gemfiles/japanese.gemfile" should contain a correct ruby directive
+    And the file "gemfiles/japanese.gemfile" should contain:
+    """
+    gem "rice"
+    gem "miso_soup"
+    """
+    And the file "gemfiles/japanese.gemfile" should contain:
+    """
+    git "./egg" do
+      gem "egg"
+    end
+    """
+    And the file "gemfiles/japanese.gemfile" should contain:
+    """
+    group :breakfast do
+      gem "bacon"
+    end
+    """
+    And the file "gemfiles/english.gemfile" should contain:
+    """
+    gem "bread"
+    """

data/features/gemspec.feature

@@ -57,17 +57,6 @@ Feature: appraisals using an existing gemspec
     And I run `bundle exec rake appraisal version --trace`
     Then the output should contain "Loaded 1.3.2"
 
-
-  Scenario: run a gem in the gemspec via path
-    And I write to "Gemfile" with:
-    """
-    gemspec :path => './specdir'
-    """
-    When I add "appraisal" from this project as a dependency
-    When I successfully run `bundle exec rake appraisal:install --trace`
-    When I run `bundle exec rake appraisal version --trace`
-    Then the output should contain "Loaded 1.3.0"
-
   Scenario: run a gem in the gemspec via path
     And I write to "Gemfile" with:
     """

data/features/missing_appraisals_file.feature

@@ -0,0 +1,23 @@
+@disable-bundler
+Feature: raise an exception when there is no Appraisal file
+
+  Scenario: No Appraisal file
+    Given a directory named "projecto"
+    And the following installed dummy gems:
+      | name       | version |
+      | dummy_girl | 1.3.0   |
+    And I cd to "projecto"
+    And I write to "Gemfile" with:
+    """
+    gem "dummy_girl"
+    """
+    And I add "appraisal" from this project as a dependency
+    And I write to "Rakefile" with:
+    """
+    require 'rubygems'
+    require 'bundler/setup'
+    require 'appraisal'
+    """
+    And I successfully run `bundle install --local`
+    When I run `bundle exec rake appraisal:install --trace`
+    Then the output should contain "Unable to locate 'Appraisals' file in the current directory."

data/features/step_definitions/dependency_steps.rb

@@ -3,29 +3,22 @@ When /^I add "([^"]*)" from this project as a dependency$/ do |gem_name|
 end
 
 Given /^the following installed dummy gems:$/ do |table|
-  table.hashes.each do |hash|
-    name = hash["name"]
-    version = hash["version"]
-    create_dir(name)
-    cd(name)
-    create_dir("lib")
-    gem_path = "#{name}.gemspec"
-    version_path = "lib/#{name}.rb"
-    spec = <<-SPEC
-      Gem::Specification.new do |s|
-        s.name    = '#{name}'
-        s.version = '#{version}'
-        s.authors = 'Mr. Smith'
-        s.summary = 'summary'
-        s.files   = '#{version_path}'
-      end
-    SPEC
-    write_file(gem_path, spec)
-    write_file(version_path, "$#{name}_version = '#{version}'")
-    in_current_dir { `gem build #{gem_path} 2>&1` }
-    set_env("GEM_HOME", TMP_GEM_ROOT)
-    in_current_dir { `gem install #{name}-#{version}.gem 2>&1` }
-    FileUtils.rm_rf(File.join(current_dir, name))
-    dirs.pop
+  table.hashes.each { |hash| build_gem(hash["name"], hash["version"]) }
+end
+
+Given /^a git repository exists for gem "(.*?)" with version "(.*?)"$/ do |gem_name, version|
+  build_gem(gem_name, version)
+  cd gem_name
+  run_simple 'git init .'
+  run_simple 'git config user.email "appraisal@thoughtbot.com"'
+  run_simple 'git config user.name "Appraisal"'
+  run_simple 'git add .'
+  run_simple 'git commit -a -m "initial commit"'
+  dirs.pop
+end
+
+Then /^the file "(.*?)" should contain a correct ruby directive$/ do |filename|
+  in_current_dir do
+    File.read(filename).should match(/^ruby "#{RUBY_VERSION}"$/)
   end
 end