appraisal 2.0.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ab623ad895ec0d2c27cd4a0865a476ca268c355
-  data.tar.gz: 7525addf1bd53d5b424bcb314390b620ddee77e5
+SHA256:
+  metadata.gz: 0fe7f7616c7aef0aaa5544853800eb05b08f3bb619b4fc292b8e89bbd2e9ea4d
+  data.tar.gz: 43ef79f1e190735adc4fec2413b84b614938d2a94cae68760972ffe37ca3dff4
 SHA512:
-  metadata.gz: 564306857e229c592407c8f1c027d7da3a1b34ed62c49e51b4d3186a39346e1d68d6d14e0bad0887a15241dd4cb5597e7f0fea69125bdd4980ef0a3b9db6caa3
-  data.tar.gz: e24f07952fc90e2c088a2932dcd827d1a4590faa63469ae45168a1a870d6af48c65bd302eb8c75ca0dbd134977820c37b1c167afe4a12a10978f5d883537b6df
+  metadata.gz: 45cb2de8908bd80ab3331a8c452d5f77e0d573670c48e92441cf359c6ae615e7297d5a22e3c157197d659358cd8d9d776aea5c4b55782c3c94fb14c56f356acc
+  data.tar.gz: e6f88c11dbd4e09849c2318bc14174a482a9e738790fe7ccbcee376856c06d964888d54663c81a2901ef448a7e8de22d64de098ec3dfe2c527ae68ff7ce6415f

data/.travis.yml

@@ -1,22 +1,18 @@
-sudo: false
-
-before_install: gem install bundler
+---
+before_install: gem install bundler:2.1.4
 
 rvm:
-  - 1.8
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - rbx-2
-  - jruby-19mode
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby-9.2.9.0
   - ruby-head
   - jruby-head
 
 matrix:
   fast_finish: true
   allow_failures:
-    - rvm: rbx-2
-    - rvm: jruby-19mode
     - rvm: ruby-head
     - rvm: jruby-head

data/Gemfile

@@ -1,11 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 # This here to make sure appraisal works with Rails 3.0.0.
-gem 'thor', '~> 0.14.0'
-
-if RUBY_VERSION < "1.9"
-  gem "i18n", "~> 0.6.0"
-  gem "activesupport", "~> 3.2.21"
-end
+gem "thor", "~> 0.14.0"

data/README.md

@@ -5,7 +5,7 @@ Appraisal
 
 Find out what your Ruby gems are worth.
 
-[Build Status Image]: https://secure.travis-ci.org/thoughtbot/appraisal.png?branch=master
+[Build Status Image]: https://secure.travis-ci.org/thoughtbot/appraisal.svg?branch=master
 [Build Status]: http://travis-ci.org/thoughtbot/appraisal
 
 Synopsis
@@ -19,22 +19,23 @@ without interfering with day-to-day development using Bundler.
 Installation
 ------------
 
-In your Gemfile:
+In your package's `.gemspec`:
 
-    gem "appraisal"
+    s.add_development_dependency "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).
+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.
+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`.
 
-An Appraisals file consists of several appraisal definitions. An appraisal
+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:
 
@@ -46,35 +47,29 @@ few versions of Rails:
       gem "rails", "4.0.0"
     end
 
-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
+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.
 
-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"
-
 Usage
 -----
 
 Once you've configured the appraisals you want to use, you need to install the
 dependencies for each appraisal:
 
-    appraisal install
+    $ bundle exec appraisal install
 
 This will resolve, install, and lock the dependencies for that appraisal using
 bundler. Once you have your dependencies set up, you can run any command in a
 single appraisal:
 
-    appraisal rails-3 rake test
+    $ bundle exec appraisal rails-3 rake test
 
 This will run `rake test` using the dependencies configured for Rails 3. You can
 also run each appraisal in turn:
 
-    appraisal rake test
+    $ bundle exec 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
@@ -96,6 +91,18 @@ 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.
 
+### Commands
+
+```bash
+appraisal clean                  # Remove all generated gemfiles and lockfiles from gemfiles folder
+appraisal generate               # Generate a gemfile for each appraisal
+appraisal help [COMMAND]         # Describe available commands or one specific command
+appraisal install                # Resolve and install dependencies for each appraisal
+appraisal list                   # List the names of the defined appraisals
+appraisal update [LIST_OF_GEMS]  # Remove all generated gemfiles and lockfiles, resolve, and install dependencies again
+appraisal version                # Display the version and exit
+```
+
 Under the hood
 --------------
 
@@ -108,6 +115,46 @@ When you prefix a command with `appraisal`, the command is run with the
 appropriate Gemfile for that appraisal, ensuring the correct dependencies
 are used.
 
+Removing Gems using Appraisal
+-------
+
+It is common while managing multiple Gemfiles for dependencies to become deprecated and no
+longer necessary, meaning they need to be removed from the Gemfile for a specific `appraisal`.
+To do this, use the `remove_gem` declaration within the necessary `appraise` block in your
+`Appraisals` file.
+
+### Example Usage
+
+**Gemfile**
+```ruby
+gem 'rails', '~> 4.2'
+
+group :test do
+  gem 'rspec', '~> 4.0'
+  gem 'test_after_commit'
+end
+```
+
+**Appraisals**
+```ruby
+appraise 'rails-5' do
+  gem 'rails', '~> 5.2'
+
+  group :test do
+    remove_gem :test_after_commit
+  end
+end
+```
+
+Using the `Appraisals` file defined above, this is what the resulting `Gemfile` will look like:
+```ruby
+gem 'rails', '~> 5.2'
+
+group :test do
+  gem 'rspec', '~> 4.0'
+end
+```
+
 Version Control
 ---------------
 
@@ -139,15 +186,38 @@ all versions of its dependency, you might have to set a `script` setting:
 That will make sure that each of the test sub-job are not getting run more than
 one time.
 
-You can also running your test against multiple versions of Ruby locally, just
+You can also run your tests against multiple versions of Ruby locally, just
 like running on Travis CI, by using [WWTD].
 
 [WWTD]: https://github.com/grosser/wwtd
 
+Circle CI Integration
+---------------------
+
+In Circle CI you can override the default testing behaviour to customize your
+testing. Using this feature you can configure appraisal to execute your tests.
+
+In order to this you can put the following configuration in your circle.yml file:
+
+```yml
+dependencies:
+  post:
+    - bundle exec appraisal install
+test:
+  pre:
+    - bundle exec appraisal rake db:create
+    - bundle exec appraisal rake db:migrate
+  override:
+    - bundle exec appraisal rspec
+```
+
+Notice that we are running an rspec suite. You can customize your testing
+command in the `override` section and use your favourite one.
+
 Credits
 -------
 
-![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
 
 Appraisal is maintained and funded by [thoughtbot, inc][thoughtbot]
 

data/appraisal.gemspec

@@ -18,10 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = ">= 2.3.0"
+
   s.add_runtime_dependency('rake')
   s.add_runtime_dependency('bundler')
   s.add_runtime_dependency('thor', '>= 0.14.0')
-  s.add_runtime_dependency("activesupport", ">= 3.2.21")
 
+  s.add_development_dependency("activesupport", ">= 3.2.21")
   s.add_development_dependency('rspec', '~> 3.0')
 end

data/lib/appraisal/appraisal.rb

@@ -7,6 +7,8 @@ require 'pathname'
 module Appraisal
   # Represents one appraisal and its dependencies
   class Appraisal
+    DEFAULT_INSTALL_OPTIONS = { "jobs" => 1 }.freeze
+
     attr_reader :name, :gemfile
 
     def initialize(name, source_gemfile)
@@ -18,8 +20,12 @@ module Appraisal
       gemfile.gem(*args)
     end
 
-    def source(*args)
-      gemfile.source(*args)
+    def remove_gem(*args)
+      gemfile.remove_gem(*args)
+    end
+
+    def source(*args, &block)
+      gemfile.source(*args, &block)
     end
 
     def ruby(*args)
@@ -46,26 +52,36 @@ module Appraisal
       gemfile.gemspec(options)
     end
 
+    def git_source(*args, &block)
+      gemfile.git_source(*args, &block)
+    end
+
     def write_gemfile
-      ::File.open(gemfile_path, "w") do |file|
+      File.open(gemfile_path, "w") do |file|
         signature = "# This file was generated by Appraisal"
         file.puts([signature, gemfile.to_s].join("\n\n"))
       end
     end
 
-    def install(job_size = 1)
-      command = [
-        check_command,
-        "||",
-        install_command(job_size)
-      ].flatten.join(" ")
+    def install(options = {})
+      commands = [install_command(options).join(" ")]
+
+      if options["without"].nil? || options["without"].empty?
+        commands.unshift(check_command.join(" "))
+      end
+
+      command = commands.join(" || ")
 
-      Command.new(command).run
+      if Bundler.settings[:path]
+        env = { 'BUNDLE_DISABLE_SHARED_GEMS' => '1' }
+        Command.new(command, :env => env).run
+      else
+        Command.new(command).run
+      end
     end
 
     def update(gems = [])
-      command, env = update_command(gems)
-      Command.new(command, :env => env).run
+      Command.new(update_command(gems), :gemfile => gemfile_path).run
     end
 
     def gemfile_path
@@ -77,15 +93,15 @@ module Appraisal
     end
 
     def relative_gemfile_path
-      ::File.join("gemfiles", gemfile_name)
+      File.join("gemfiles", gemfile_name)
     end
 
     def relativize
       current_directory = Pathname.new(Dir.pwd)
       relative_path = current_directory.relative_path_from(gemfile_root).cleanpath
-      lockfile_content = ::File.read(lockfile_path)
+      lockfile_content = File.read(lockfile_path)
 
-      ::File.open(lockfile_path, 'w') do |file|
+      File.open(lockfile_path, 'w') do |file|
         file.write lockfile_content.gsub(/#{current_directory}/, relative_path.to_s)
       end
     end
@@ -97,19 +113,21 @@ module Appraisal
       ['bundle', 'check', gemfile_option]
     end
 
-    def install_command(job_size)
+    def install_command(options = {})
       gemfile_option = "--gemfile='#{gemfile_path}'"
-      ['bundle', 'install', gemfile_option, bundle_parallel_option(job_size)].compact
+      ['bundle', 'install', gemfile_option, bundle_options(options)].compact
     end
 
     def update_command(gems)
-      env = { "BUNDLE_GEMFILE" => gemfile_path }
-      command = ['bundle', 'update', *gems].compact
-      [command, env]
+      ['bundle', 'update', *gems].compact
     end
 
     def gemfile_root
-      Pathname.new(::File.join(Dir.pwd, "gemfiles"))
+      project_root + "gemfiles"
+    end
+
+    def project_root
+      Pathname.new(Dir.pwd)
     end
 
     def gemfile_name
@@ -124,15 +142,30 @@ module Appraisal
       name.gsub(/[^\w\.]/, '_')
     end
 
-    def bundle_parallel_option(job_size)
-      if job_size > 1
+    def bundle_options(options)
+      full_options = DEFAULT_INSTALL_OPTIONS.dup.merge(options)
+      options_strings = []
+      jobs = full_options.delete("jobs")
+      if jobs > 1
         if Utils.support_parallel_installation?
-          "--jobs=#{job_size}"
+          options_strings << "--jobs=#{jobs}"
         else
           warn 'Your current version of Bundler does not support parallel installation. Please ' +
             'upgrade Bundler to version >= 1.4.0, or invoke `appraisal` without `--jobs` option.'
         end
       end
+
+      path = full_options.delete("path")
+      if path
+        relative_path = project_root.join(options["path"])
+        options_strings << "--path #{relative_path}"
+      end
+
+      full_options.each do |flag, val|
+        options_strings << "--#{flag} #{val}"
+      end
+
+      options_strings.join(" ") if options_strings != []
     end
   end
 end

data/lib/appraisal/{file.rb → appraisal_file.rb}

@@ -4,7 +4,7 @@ require 'appraisal/gemfile'
 
 module Appraisal
   # Loads and parses Appraisals file
-  class File
+  class AppraisalFile
     attr_reader :appraisals, :gemfile
 
     def self.each(&block)
@@ -16,7 +16,7 @@ module Appraisal
       @gemfile = Gemfile.new
       @gemfile.load(ENV['BUNDLE_GEMFILE'] || 'Gemfile')
 
-      if ::File.exist? path
+      if File.exist? path
         run IO.read(path)
       else
         raise AppraisalsNotFound

data/lib/appraisal/bundler_dsl.rb

@@ -1,22 +1,23 @@
 require "appraisal/dependency_list"
-require "active_support/ordered_hash"
 
 module Appraisal
   class BundlerDSL
     attr_reader :dependencies
 
-    PARTS = %w(source ruby_version git_sources path_sources dependencies groups
-      platforms gemspec)
+    PARTS = %w(source ruby_version gits paths dependencies groups
+      platforms source_blocks gemspec)
 
     def initialize
       @sources = []
       @ruby_version = nil
       @dependencies = DependencyList.new
-      @gemspec = nil
-      @groups = ActiveSupport::OrderedHash.new
-      @platforms = ActiveSupport::OrderedHash.new
-      @git_sources = ActiveSupport::OrderedHash.new
-      @path_sources = ActiveSupport::OrderedHash.new
+      @gemspecs = []
+      @groups = Hash.new
+      @platforms = Hash.new
+      @gits = Hash.new
+      @paths = Hash.new
+      @source_blocks = Hash.new
+      @git_sources = {}
     end
 
     def run(&block)
@@ -24,23 +25,35 @@ module Appraisal
     end
 
     def gem(name, *requirements)
-      @dependencies.add(name, requirements)
+      @dependencies.add(name, substitute_git_source(requirements))
+    end
+
+    def remove_gem(name)
+      @dependencies.remove(name)
     end
 
     def group(*names, &block)
-      @groups[names] ||= Group.new(names)
+      @groups[names] ||=
+        Group.new(names).tap { |g| g.git_sources = @git_sources.dup }
       @groups[names].run(&block)
     end
 
     def platforms(*names, &block)
-      @platforms[names] ||= Platform.new(names)
+      @platforms[names] ||=
+        Platform.new(names).tap { |g| g.git_sources = @git_sources.dup }
       @platforms[names].run(&block)
     end
 
     alias_method :platform, :platforms
 
-    def source(source)
-      @sources << source
+    def source(source, &block)
+      if block_given?
+        @source_blocks[source] ||=
+          Source.new(source).tap { |g| g.git_sources = @git_sources.dup }
+        @source_blocks[source].run(&block)
+      else
+        @sources << source
+      end
     end
 
     def ruby(ruby_version)
@@ -48,13 +61,15 @@ module Appraisal
     end
 
     def git(source, options = {}, &block)
-      @git_sources[source] ||= GitSource.new(source, options)
-      @git_sources[source].run(&block)
+      @gits[source] ||=
+        Git.new(source, options).tap { |g| g.git_sources = @git_sources.dup }
+      @gits[source].run(&block)
     end
 
     def path(source, options = {}, &block)
-      @path_sources[source] ||= PathSource.new(source, options)
-      @path_sources[source].run(&block)
+      @paths[source] ||=
+        Path.new(source, options).tap { |g| g.git_sources = @git_sources.dup }
+      @paths[source].run(&block)
     end
 
     def to_s
@@ -66,9 +81,17 @@ module Appraisal
     end
 
     def gemspec(options = {})
-      @gemspec = Gemspec.new(options)
+      @gemspecs << Gemspec.new(options)
     end
 
+    def git_source(source, &block)
+      @git_sources[source] = block
+    end
+
+    protected
+
+    attr_writer :git_sources
+
     private
 
     def source_entry
@@ -85,25 +108,24 @@ module Appraisal
 
     alias_method :ruby_version_entry_for_dup, :ruby_version_entry
 
-    [:dependencies, :gemspec].each do |method_name|
-      class_eval <<-METHODS, __FILE__, __LINE__
-        private
+    def gemspec_entry
+      @gemspecs.map(&:to_s).join("\n")
+    end
 
-        def #{method_name}_entry
-          if @#{method_name}
-            @#{method_name}.to_s
-          end
-        end
+    def gemspec_entry_for_dup
+      @gemspecs.map(&:for_dup).join("\n")
+    end
 
-        def #{method_name}_entry_for_dup
-          if @#{method_name}
-            @#{method_name}.for_dup
-          end
-        end
-      METHODS
+    def dependencies_entry
+      @dependencies.to_s
+    end
+
+    def dependencies_entry_for_dup
+      @dependencies.for_dup
     end
 
-    [:git_sources, :path_sources, :platforms, :groups].each do |method_name|
+    [:gits, :paths, :platforms, :groups, :source_blocks].
+      each do |method_name|
       class_eval <<-METHODS, __FILE__, __LINE__
         private
 
@@ -120,5 +142,16 @@ module Appraisal
     def indent(string)
       string.strip.gsub(/^(.+)$/, '  \1')
     end
+
+    def substitute_git_source(requirements)
+      requirements.each do |requirement|
+        if requirement.is_a?(Hash)
+          (requirement.keys & @git_sources.keys).each do |matching_source|
+            value = requirement.delete(matching_source)
+            requirement[:git] = @git_sources[matching_source].call(value)
+          end
+        end
+      end
+    end
   end
 end