appraisal 2.4.1 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f28af4a3f925fd52ded81f375ed865a56a844fe20d4bdaf09a4a6fc8c7ad644
-  data.tar.gz: 3016386d58c9a22889d2e3e137cec003040f28e75040cc5349fa7d8ef2081c52
+  metadata.gz: 91cd28f94201740fdcc34e58200fec87442a99144b1b4c1b909d818b12f8e644
+  data.tar.gz: 7e61989365c22a32cea85d0cd01a7b27056a9daa2eeae452a6dede92537caf0e
 SHA512:
-  metadata.gz: 8f610b40f4e7282377c0d98eb36ee735ca6ecc24daac98995029affb811f2d86e41189628e1667464000ab706392b3ea418411760847bd8a61aea08629e1d461
-  data.tar.gz: 709cc7583d98cdaa1ead29f3804f9f02ebf1a7f089af2a751433dc4860748438e6f2f3974eb14fe58ae67dcd1f406b7a00ddf5be6228112258698c67d13595c8
+  metadata.gz: 442f8a5bad710daee1497ea947a19a5d0378c99b7e76977932cad75291229c02141d0df4eac179c3ced5e142afea8e75a9189116a09d1d2a8374f3ec435de7e3
+  data.tar.gz: 3cfe5371dc2a941f71cb16407f0ba804b33b5ec94c4faf94185527e11e36e0a10dcaecab1477515bc4f255c4fe82e7863830a53115586ab614d08e7f2f5429d2

data/.github/workflows/dynamic-security.yml

@@ -0,0 +1,19 @@
+name: update-security
+
+on:
+  push:
+    paths:
+      - SECURITY.md
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update-security:
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    uses: thoughtbot/templates/.github/workflows/dynamic-security.yaml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/main.yml

@@ -0,0 +1,55 @@
+---
+name: Tests
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.3'
+          - '3.2'
+          - '3.1'
+          - '3.0'
+          - 'head'
+          - jruby
+          - jruby-head
+          - truffleruby
+          - truffleruby-head
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Update bundler
+        env:
+          RUBY_VERSION: ${{ matrix.ruby }}
+        run: |
+          case ${RUBY_VERSION} in
+            truffleruby|truffleruby-head)
+              gem install bundler -v 2.5.18
+            ;;
+
+            *)
+              gem update --system
+            ;;
+          esac
+
+          bundle install
+
+      - name: Run tests
+        run: bin/rspec

data/.gitignore

@@ -6,3 +6,4 @@ pkg
 *.gem
 Gemfile.lock
 .bundle
+.DS_Store

data/Gemfile

@@ -4,3 +4,8 @@ gemspec
 
 # This here to make sure appraisal works with Rails 3.0.0.
 gem "thor", "~> 0.14.0"
+
+group :development, :test do
+  gem "activesupport", ">= 3.2.21"
+  gem "rspec", "~> 3.0"
+end

data/README.md

@@ -1,13 +1,8 @@
 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.svg?branch=master
-[Build Status]: http://travis-ci.org/thoughtbot/appraisal
-
 Synopsis
 --------
 
@@ -89,7 +84,7 @@ 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.
+default.
 
 ### Commands
 
@@ -141,7 +136,7 @@ appraise 'rails-5' do
   gem 'rails', '~> 5.2'
 
   group :test do
-    remove_gem :test_after_commit
+    remove_gem 'test_after_commit'
   end
 end
 ```
@@ -155,41 +150,62 @@ group :test do
 end
 ```
 
-Version Control
----------------
+Customization
+-------------
 
-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].
+It is possible to customize the generated Gemfiles by adding a `customize_gemfiles` block to
+your `Appraisals` file. The block must contain a hash of key/value pairs. Currently supported
+customizations include:
+- heading: a string that by default adds "# This file was generated by Appraisal" to the top of each Gemfile, (the string will be commented for you)
+- single_quotes: a boolean that controls if strings are single quoted in each Gemfile, defaults to false
 
-[Travis CI]: https://travis-ci.org
+You can also provide variables for substitution in the heading, based on each appraisal. Currently supported variables:
+- `%{appraisal}`: Becomes the name of each appraisal, e.g. `rails-3`
+- `%{gemfile}`: Becomes the filename of each gemfile, e.g. `rails-3.gemfile`
+- `%{gemfile_path}`: Becomes the full path of each gemfile, e.g. `/path/to/project/gemfiles/rails-3.gemfile`
+- `%{lockfile}`: Becomes the filename of each lockfile, e.g. `rails-3.gemfile.lock`
+- `%{lockfile_path}`: Becomes the full path of each lockfile, e.g. `/path/to/project/gemfiles/rails-3.gemfile.lock`
+- `%{relative_gemfile_path}`: Becomes the relative path of each gemfile, e.g. `gemfiles/rails-3.gemfile`
+- `%{relative_lockfile_path}`: Becomes the relative path of each lockfile, e.g. `gemfiles/rails-3.gemfile.lock`
 
-Travis CI integration
----------------------
+### Example Usage
 
-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:
+**Appraisals**
+```ruby
+customize_gemfiles do
+  {
+    single_quotes: true,
+    heading: <<~HEADING
+      frozen_string_literal: true
+
+      `%{gemfile}` has been generated by Appraisal, do NOT modify it or `%{lockfile}` directly!
+      Make the changes to the "%{appraisal}" block in `Appraisals` instead. See the conventions at https://example.com/
+    HEADING
+  }
+end
 
-    # In .travis.yml
-    gemfile:
-      - gemfiles/3.0.gemfile
-      - gemfiles/3.1.gemfile
-      - gemfiles/3.2.gemfile
+appraise "rails-3" do
+  gem "rails", "3.2.14"
+end
+```
 
-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:
+Using the `Appraisals` file defined above, this is what the resulting `Gemfile` will look like:
+```ruby
+# frozen_string_literal: true
 
-    script: "bundle exec rake test"
+# `rails-3.gemfile` has been generated by Appraisal, do NOT modify it or `rails-3.gemfile.lock` directly!
+# Make the changes to the "rails-3" block in `Appraisals` instead. See the conventions at https://example.com/
 
-That will make sure that each of the test sub-job are not getting run more than
-one time.
+gem 'rails', '3.2.14'
+```
 
-You can also run your tests against multiple versions of Ruby locally, just
-like running on Travis CI, by using [WWTD].
+Version Control
+---------------
 
-[WWTD]: https://github.com/grosser/wwtd
+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.
 
 Circle CI Integration
 ---------------------
@@ -217,7 +233,7 @@ command in the `override` section and use your favourite one.
 Credits
 -------
 
-![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
 
 Appraisal is maintained and funded by [thoughtbot, inc][thoughtbot]
 

data/Rakefile

@@ -1,12 +1,14 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
   t.ruby_opts = %w[-w]
   t.verbose = false
 end
 
-desc 'Default: run the rspec examples'
-task :default => [:spec]
+desc "Default: run the rspec examples"
+task default: [:spec]

data/SECURITY.md

@@ -0,0 +1,20 @@
+<!-- START /templates/security.md -->
+# Security Policy
+
+## Supported Versions
+
+Only the the latest version of this project is supported at a given time. If
+you find a security issue with an older version, please try updating to the
+latest version first.
+
+If for some reason you can't update to the latest version, please let us know
+your reasons so that we can have a better understanding of your situation.
+
+## Reporting a Vulnerability
+
+For security inquiries or vulnerability reports, visit
+<https://thoughtbot.com/security>.
+
+If you have any suggestions to improve this policy, visit <https://thoughtbot.com/security>.
+
+<!-- END /templates/security.md -->

data/appraisal.gemspec

@@ -1,29 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "appraisal/version"
+# frozen_string_literal: true
+
+require_relative "lib/appraisal/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'appraisal'
+  s.name        = "appraisal"
   s.version     = Appraisal::VERSION.dup
   s.platform    = Gem::Platform::RUBY
-  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.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.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
+  s.bindir        = "exe"
 
   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_development_dependency("activesupport", ">= 3.2.21")
-  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_dependency("rake")
+  s.add_dependency("bundler")
+  s.add_dependency("thor", ">= 0.14.0")
 end

data/bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/{bin → exe}/appraisal

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'bundler/setup'
-require 'appraisal'
-require 'appraisal/cli'
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+require "appraisal"
+require "appraisal/cli"
 
 begin
   Appraisal::CLI.start

data/lib/appraisal/appraisal.rb

@@ -1,8 +1,11 @@
-require 'appraisal/gemfile'
-require 'appraisal/command'
-require 'appraisal/utils'
-require 'fileutils'
-require 'pathname'
+# frozen_string_literal: true
+
+require "appraisal/gemfile"
+require "appraisal/command"
+require "appraisal/customize"
+require "appraisal/utils"
+require "fileutils"
+require "pathname"
 
 module Appraisal
   # Represents one appraisal and its dependencies
@@ -44,6 +47,10 @@ module Appraisal
       gemfile.group(*args, &block)
     end
 
+    def install_if(*args, &block)
+      gemfile.install_if(*args, &block)
+    end
+
     def platforms(*args, &block)
       gemfile.platforms(*args, &block)
     end
@@ -58,8 +65,9 @@ module Appraisal
 
     def write_gemfile
       File.open(gemfile_path, "w") do |file|
-        signature = "# This file was generated by Appraisal"
-        file.puts([signature, gemfile.to_s].join("\n\n"))
+        signature =
+          Customize.heading(self) || "This file was generated by Appraisal"
+        file.puts([comment_lines(signature), quoted_gemfile].join("\n\n"))
       end
     end
 
@@ -73,15 +81,15 @@ module Appraisal
       command = commands.join(" || ")
 
       if Bundler.settings[:path]
-        env = { 'BUNDLE_DISABLE_SHARED_GEMS' => '1' }
-        Command.new(command, :env => env).run
+        env = { "BUNDLE_DISABLE_SHARED_GEMS" => "1" }
+        Command.new(command, env: env).run
       else
         Command.new(command).run
       end
     end
 
     def update(gems = [])
-      Command.new(update_command(gems), :gemfile => gemfile_path).run
+      Command.new(update_command(gems), gemfile: gemfile_path).run
     end
 
     def gemfile_path
@@ -101,8 +109,11 @@ module Appraisal
       relative_path = current_directory.relative_path_from(gemfile_root).cleanpath
       lockfile_content = File.read(lockfile_path)
 
-      File.open(lockfile_path, 'w') do |file|
-        file.write lockfile_content.gsub(/#{current_directory}/, relative_path.to_s)
+      File.open(lockfile_path, "w") do |file|
+        file.write lockfile_content.gsub(
+          / #{current_directory}/,
+          " #{relative_path}"
+        )
       end
     end
 
@@ -110,16 +121,16 @@ module Appraisal
 
     def check_command
       gemfile_option = "--gemfile='#{gemfile_path}'"
-      ['bundle', 'check', gemfile_option]
+      ["bundle", "check", gemfile_option]
     end
 
     def install_command(options = {})
       gemfile_option = "--gemfile='#{gemfile_path}'"
-      ['bundle', 'install', gemfile_option, bundle_options(options)].compact
+      ["bundle", "install", gemfile_option, bundle_options(options)].compact
     end
 
     def update_command(gems)
-      ['bundle', 'update', *gems].compact
+      ["bundle", "update", *gems].compact
     end
 
     def gemfile_root
@@ -139,7 +150,7 @@ module Appraisal
     end
 
     def clean_name
-      name.gsub(/[^\w\.]/, '_')
+      name.gsub(/[^\w\.]/, "_")
     end
 
     def bundle_options(options)
@@ -150,8 +161,8 @@ module Appraisal
         if Utils.support_parallel_installation?
           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.'
+          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
 
@@ -167,5 +178,21 @@ module Appraisal
 
       options_strings.join(" ") if options_strings != []
     end
+
+    def comment_lines(heading)
+      heading.lines.map do |line|
+        if line.lstrip.empty?
+          line
+        else
+          "# #{line}"
+        end
+      end.join
+    end
+
+    def quoted_gemfile
+      return gemfile.to_s unless Customize.single_quotes
+
+      gemfile.to_s.tr('"', "'")
+    end
   end
 end

data/lib/appraisal/appraisal_file.rb

@@ -1,6 +1,9 @@
-require 'appraisal/appraisal'
-require 'appraisal/errors'
-require 'appraisal/gemfile'
+# frozen_string_literal: true
+
+require "appraisal/appraisal"
+require "appraisal/customize"
+require "appraisal/errors"
+require "appraisal/gemfile"
 
 module Appraisal
   # Loads and parses Appraisals file
@@ -14,7 +17,7 @@ module Appraisal
     def initialize
       @appraisals = []
       @gemfile = Gemfile.new
-      @gemfile.load(ENV['BUNDLE_GEMFILE'] || 'Gemfile')
+      @gemfile.load(ENV["BUNDLE_GEMFILE"] || "Gemfile")
 
       if File.exist? path
         run IO.read(path)
@@ -33,6 +36,10 @@ module Appraisal
       @appraisals << appraisal
     end
 
+    def customize_gemfiles(&_block)
+      Customize.new(**yield)
+    end
+
     private
 
     def run(definitions)
@@ -40,7 +47,7 @@ module Appraisal
     end
 
     def path
-      'Appraisals'
+      "Appraisals"
     end
   end
 end