appraisal 2.5.0 → 3.0.0.rc1

data/lib/appraisal/cli.rb

@@ -1,52 +1,63 @@
-require 'thor'
-require 'fileutils'
+# frozen_string_literal: true
+
+require "thor"
+require "fileutils"
 
 module Appraisal
   class CLI < Thor
     default_task :install
     map ["-v", "--version"] => "version"
 
-    # Override help command to print out usage
-    def self.help(shell, subcommand = false)
-      shell.say strip_heredoc(<<-help)
-        Appraisal: Find out what your Ruby gems are worth.
+    class << self
+      # Override help command to print out usage
+      def help(shell, subcommand = false)
+        shell.say strip_heredoc(<<-HELP)
+          Appraisal: Find out what your Ruby gems are worth.
 
-        Usage:
-          appraisal [APPRAISAL_NAME] EXTERNAL_COMMAND
+          Usage:
+            appraisal [APPRAISAL_NAME] EXTERNAL_COMMAND
 
-          If APPRAISAL_NAME is given, only run that EXTERNAL_COMMAND against the given
-          appraisal, otherwise it runs the EXTERNAL_COMMAND against all appraisals.
-      help
+            If APPRAISAL_NAME is given, only run that EXTERNAL_COMMAND against the given
+            appraisal, otherwise it runs the EXTERNAL_COMMAND against all appraisals.
+        HELP
 
-      if File.exist?('Appraisals')
-        shell.say
-        shell.say 'Available Appraisal(s):'
+        if File.exist?("Appraisals")
+          shell.say
+          shell.say "Available Appraisal(s):"
 
-        AppraisalFile.each do |appraisal|
-          shell.say "  - #{appraisal.name}"
+          AppraisalFile.each do |appraisal|
+            shell.say "  - #{appraisal.name}"
+          end
         end
+
+        shell.say
+
+        super
       end
 
-      shell.say
+      def exit_on_failure?
+        true
+      end
 
-      super
-    end
+      private
 
-    def self.exit_on_failure?
-      true
+      def strip_heredoc(string)
+        indent = string.scan(/^[ \t]*(?=\S)/).min.size || 0
+        string.gsub(/^[ \t]{#{indent}}/, "")
+      end
     end
 
-    desc 'install', 'Resolve and install dependencies for each appraisal'
-    method_option 'jobs', :aliases => 'j', :type => :numeric, :default => 1,
-      :banner => 'SIZE',
-      :desc => 'Install gems in parallel using the given number of workers.'
-    method_option 'retry', :type => :numeric, :default => 1,
-      :desc => 'Retry network and git requests that have failed'
-    method_option "without", :banner => "GROUP_NAMES",
-      :desc => "A space-separated list of groups referencing gems to skip " +
+    desc "install", "Resolve and install dependencies for each appraisal"
+    method_option "jobs", aliases: "j", type: :numeric, default: 1,
+      banner: "SIZE",
+      desc: "Install gems in parallel using the given number of workers."
+    method_option "retry", type: :numeric, default: 1,
+      desc: "Retry network and git requests that have failed"
+    method_option "without", banner: "GROUP_NAMES",
+      desc: "A space-separated list of groups referencing gems to skip " +
         "during installation. Bundler will remember this option."
-    method_option "full-index", :type => :boolean,
-                                :desc => "Run bundle install with the " \
+    method_option "full-index", type: :boolean,
+                                desc: "Run bundle install with the " \
                                          "full-index argument."
     method_option "path", type: :string,
                           desc: "Install gems in the specified directory. " \
@@ -61,19 +72,19 @@ module Appraisal
       end
     end
 
-    desc 'generate', 'Generate a gemfile for each appraisal'
+    desc "generate", "Generate a gemfile for each appraisal"
     def generate
       AppraisalFile.each do |appraisal|
         appraisal.write_gemfile
       end
     end
 
-    desc 'clean', 'Remove all generated gemfiles and lockfiles from gemfiles folder'
+    desc "clean", "Remove all generated gemfiles and lockfiles from gemfiles folder"
     def clean
-      FileUtils.rm_f Dir['gemfiles/*.{gemfile,gemfile.lock}']
+      FileUtils.rm_f Dir["gemfiles/*.{gemfile,gemfile.lock}"]
     end
 
-    desc 'update [LIST_OF_GEMS]', 'Remove all generated gemfiles and lockfiles, resolve, and install dependencies again'
+    desc "update [LIST_OF_GEMS]", "Remove all generated gemfiles and lockfiles, resolve, and install dependencies again"
     def update(*gems)
       invoke :generate, []
 
@@ -82,7 +93,7 @@ module Appraisal
       end
     end
 
-    desc 'list', 'List the names of the defined appraisals'
+    desc "list", "List the names of the defined appraisals"
     def list
       AppraisalFile.new.appraisals.each { |appraisal| puts appraisal.name }
     end
@@ -100,17 +111,12 @@ module Appraisal
       end
 
       if matching_appraisal
-        Command.new(args, :gemfile => matching_appraisal.gemfile_path).run
+        Command.new(args, gemfile: matching_appraisal.gemfile_path).run
       else
         AppraisalFile.each do |appraisal|
-          Command.new(ARGV, :gemfile => appraisal.gemfile_path).run
+          Command.new(ARGV, gemfile: appraisal.gemfile_path).run
         end
       end
     end
-
-    def self.strip_heredoc(string)
-      indent = string.scan(/^[ \t]*(?=\S)/).min.size || 0
-      string.gsub(/^[ \t]{#{indent}}/, '')
-    end
   end
 end

data/lib/appraisal/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module Appraisal
@@ -70,7 +72,7 @@ module Appraisal
       if command_starts_with_bundle?(original_command)
         original_command
       else
-        %w(bundle exec) + original_command
+        %w[bundle exec] + original_command
       end
     end
 

data/lib/appraisal/conditional.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
 require "appraisal/utils"
 
@@ -14,6 +16,8 @@ module Appraisal
 
     # :nodoc:
     def for_dup
+      return unless @condition.is_a?(String)
+
       "install_if #{@condition} do\n#{indent(super)}\nend"
     end
   end

data/lib/appraisal/customize.rb

@@ -1,16 +1,36 @@
+# frozen_string_literal: true
+
 module Appraisal
   class Customize
     def initialize(heading: nil, single_quotes: false)
-      @@heading = heading
+      @@heading = heading&.chomp
       @@single_quotes = single_quotes
     end
 
-    def self.heading
+    def self.heading(gemfile)
       @@heading ||= nil
+      customize(@@heading, gemfile)
     end
 
     def self.single_quotes
       @@single_quotes ||= false
     end
+
+    def self.customize(heading, gemfile)
+      return nil unless heading
+
+      format(
+        heading.to_s,
+        appraisal: gemfile.send("clean_name"),
+        gemfile: gemfile.send("gemfile_name"),
+        gemfile_path: gemfile.gemfile_path,
+        lockfile: "#{gemfile.send('gemfile_name')}.lock",
+        lockfile_path: gemfile.send("lockfile_path"),
+        relative_gemfile_path: gemfile.relative_gemfile_path,
+        relative_lockfile_path: "#{gemfile.relative_gemfile_path}.lock"
+      )
+    end
+
+    private_class_method :customize
   end
 end

data/lib/appraisal/dependency.rb

@@ -1,4 +1,6 @@
-require 'appraisal/utils'
+# frozen_string_literal: true
+
+require "appraisal/utils"
 
 module Appraisal
   # Dependency on a gem and optional version requirements
@@ -43,7 +45,7 @@ module Appraisal
     end
 
     def gem_name
-      %{gem "#{name}"}
+      %(gem "#{name}")
     end
 
     def no_requirements?

data/lib/appraisal/dependency_list.rb

@@ -1,10 +1,12 @@
-require 'appraisal/dependency'
+# frozen_string_literal: true
+
+require "appraisal/dependency"
 require "set"
 
 module Appraisal
   class DependencyList
     def initialize
-      @dependencies = Hash.new
+      @dependencies = {}
       @removed_dependencies = Set.new
     end
 

data/lib/appraisal/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appraisal
   # Raises when Appraisal is unable to locate Appraisals file in the current directory.
   class AppraisalsNotFound < StandardError

data/lib/appraisal/gemfile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
 
 module Appraisal

data/lib/appraisal/gemspec.rb

@@ -1,4 +1,6 @@
-require 'appraisal/utils'
+# frozen_string_literal: true
+
+require "appraisal/utils"
 
 module Appraisal
   class Gemspec
@@ -6,7 +8,7 @@ module Appraisal
 
     def initialize(options = {})
       @options = options
-      @options[:path] ||= '.'
+      @options[:path] ||= "."
     end
 
     def to_s
@@ -22,7 +24,7 @@ module Appraisal
 
     def exported_options
       @options.merge(
-        :path => Utils.prefix_path(@options[:path])
+        path: Utils.prefix_path(@options[:path])
       )
     end
   end

data/lib/appraisal/git.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
-require 'appraisal/utils'
+require "appraisal/utils"
 
 module Appraisal
   class Git < BundlerDSL

data/lib/appraisal/group.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
-require 'appraisal/utils'
+require "appraisal/utils"
 
 module Appraisal
   class Group < BundlerDSL
@@ -20,10 +22,10 @@ module Appraisal
     private
 
     def formatted_output(output_dependencies)
-      <<-OUTPUT.strip
-group #{Utils.format_arguments(@group_names)} do
-#{output_dependencies}
-end
+      <<~OUTPUT.strip
+        group #{Utils.format_arguments(@group_names)} do
+        #{output_dependencies}
+        end
       OUTPUT
     end
   end

data/lib/appraisal/path.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
-require 'appraisal/utils'
+require "appraisal/utils"
 
 module Appraisal
   class Path < BundlerDSL

data/lib/appraisal/platform.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
-require 'appraisal/utils'
+require "appraisal/utils"
 
 module Appraisal
   class Platform < BundlerDSL
@@ -20,10 +22,10 @@ module Appraisal
     private
 
     def formatted_output(output_dependencies)
-      <<-OUTPUT.strip
-platforms #{Utils.format_arguments(@platform_names)} do
-#{output_dependencies}
-end
+      <<~OUTPUT.strip
+        platforms #{Utils.format_arguments(@platform_names)} do
+        #{output_dependencies}
+        end
       OUTPUT
     end
   end

data/lib/appraisal/source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "appraisal/bundler_dsl"
 require "appraisal/utils"
 
@@ -20,11 +22,11 @@ module Appraisal
     private
 
     def formatted_output(output_dependencies)
-      <<-OUTPUT.strip
-source #{@source.inspect} do
-#{output_dependencies}
-end
-        OUTPUT
+      <<~OUTPUT.strip
+        source #{@source.inspect} do
+        #{output_dependencies}
+        end
+      OUTPUT
     end
   end
 end

data/lib/appraisal/task.rb

@@ -1,5 +1,7 @@
-require 'appraisal/appraisal_file'
-require 'rake/tasklib'
+# frozen_string_literal: true
+
+require "appraisal/appraisal_file"
+require "rake/tasklib"
 
 module Appraisal
   # Defines tasks for installing appraisal dependencies and running other tasks
@@ -11,21 +13,21 @@ module Appraisal
         task :gemfiles do
           warn "`rake appraisal:gemfile` task is deprecated and will be removed soon. " +
             "Please use `appraisal generate`."
-          exec 'bundle exec appraisal generate'
+          exec "bundle exec appraisal generate"
         end
 
         desc "DEPRECATED: Resolve and install dependencies for each appraisal"
         task :install do
           warn "`rake appraisal:install` task is deprecated and will be removed soon. " +
             "Please use `appraisal install`."
-          exec 'bundle exec appraisal install'
+          exec "bundle exec appraisal install"
         end
 
         desc "DEPRECATED: Remove all generated gemfiles from gemfiles/ folder"
         task :cleanup do
           warn "`rake appraisal:cleanup` task is deprecated and will be removed soon. " +
             "Please use `appraisal clean`."
-          exec 'bundle exec appraisal clean'
+          exec "bundle exec appraisal clean"
         end
 
         begin
@@ -48,7 +50,7 @@ module Appraisal
       end
 
       desc "Run the given task for all appraisals"
-      task :appraisal => "appraisal:all"
+      task appraisal: "appraisal:all"
     end
   end
 end

data/lib/appraisal/utils.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Appraisal
   # Contains methods for various operations
   module Utils
     def self.support_parallel_installation?
-      Gem::Version.create(Bundler::VERSION) >= Gem::Version.create('1.4.0.pre.1')
+      Gem::Version.create(Bundler::VERSION) >= Gem::Version.create("1.4.0.pre.1")
     end
 
     def self.format_string(object, enclosing_object = false)
@@ -15,7 +17,7 @@ module Appraisal
         if enclosing_object
           "{ #{items.join(', ')} }"
         else
-          items.join(', ')
+          items.join(", ")
         end
       else
         object.inspect
@@ -35,7 +37,7 @@ module Appraisal
 
     def self.format_arguments(arguments)
       unless arguments.empty?
-        arguments.map { |object| format_string(object, false) }.join(', ')
+        arguments.map { |object| format_string(object, false) }.join(", ")
       end
     end
 
@@ -53,10 +55,7 @@ module Appraisal
     end
 
     def self.bundler_version
-      Gem::Specification.
-        detect { |spec| spec.name == "bundler" }.
-        version.
-        to_s
+      Gem::Specification.detect { |spec| spec.name == "bundler" }.version.to_s
     end
   end
 end

data/lib/appraisal/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appraisal
-  VERSION = "2.5.0".freeze
+  VERSION = "3.0.0.rc1"
 end

data/lib/appraisal.rb

@@ -1,4 +1,6 @@
-require 'appraisal/version'
-require 'appraisal/task'
+# frozen_string_literal: true
+
+require "appraisal/version"
+require "appraisal/task"
 
 Appraisal::Task.new

data/spec/acceptance/appraisals_file_bundler_dsl_compatibility_spec.rb

@@ -1,24 +1,26 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Appraisals file Bundler DSL compatibility' do
-  it 'supports all Bundler DSL in Appraisals file' do
-    build_gems %w(bagel orange_juice milk waffle coffee ham
-                  sausage pancake rotten_egg mayonnaise)
-    build_git_gems %w(egg croissant pain_au_chocolat omelette)
+require "spec_helper"
 
-    build_gemfile <<-Gemfile
+RSpec.describe "Appraisals file Bundler DSL compatibility" do
+  it "supports all Bundler DSL in Appraisals file" do
+    build_gems %w[bagel orange_juice milk waffle coffee ham
+                  sausage pancake rotten_egg mayonnaise]
+    build_git_gems %w[egg croissant pain_au_chocolat omelette]
+
+    build_gemfile <<-GEMFILE
       source 'https://rubygems.org'
-      git_source(:custom_git_source) { |repo| "../gems/\#{repo}" }
+      git_source(:custom_git_source) { |repo| "../build/\#{repo}" }
       ruby RUBY_VERSION
 
       gem 'bagel'
       gem "croissant", :custom_git_source => "croissant"
 
-      git '../gems/egg' do
+      git '../build/egg' do
         gem 'egg'
       end
 
-      path '../gems/waffle' do
+      path '../build/waffle' do
         gem 'waffle'
       end
 
@@ -45,9 +47,9 @@ describe 'Appraisals file Bundler DSL compatibility' do
       end
 
       gem 'appraisal', :path => #{PROJECT_ROOT.inspect}
-    Gemfile
+    GEMFILE
 
-    build_appraisal_file <<-Appraisals
+    build_appraisal_file <<-APPRAISALS
       appraise 'breakfast' do
         source 'http://some-other-source.com'
         ruby "2.3.0"
@@ -55,11 +57,11 @@ describe 'Appraisals file Bundler DSL compatibility' do
         gem 'bread'
         gem "pain_au_chocolat", :custom_git_source => "pain_au_chocolat"
 
-        git '../gems/egg' do
+        git '../build/egg' do
           gem 'porched_egg'
         end
 
-        path '../gems/waffle' do
+        path '../build/waffle' do
           gem 'chocolate_waffle'
         end
 
@@ -87,12 +89,12 @@ describe 'Appraisals file Bundler DSL compatibility' do
         gemspec
         gemspec :path => "sitepress"
       end
-    Appraisals
+    APPRAISALS
 
-    run 'bundle install --local'
-    run 'appraisal generate'
+    run "bundle install --local"
+    run "appraisal generate"
 
-    expect(content_of 'gemfiles/breakfast.gemfile').to eq <<-Gemfile.strip_heredoc
+    expect(content_of("gemfiles/breakfast.gemfile")).to eq <<-GEMFILE.strip_heredoc
       # This file was generated by Appraisal
 
       source "https://rubygems.org"
@@ -100,25 +102,25 @@ describe 'Appraisals file Bundler DSL compatibility' do
 
       ruby "2.3.0"
 
-      git "../../gems/egg" do
+      git "../../build/egg" do
         gem "egg"
         gem "porched_egg"
       end
 
-      path "../../gems/waffle" do
+      path "../../build/waffle" do
         gem "waffle"
         gem "chocolate_waffle"
       end
 
       gem "bagel"
-      gem "croissant", :git => "../../gems/croissant"
+      gem "croissant", :git => "../../build/croissant"
       gem "appraisal", :path => #{PROJECT_ROOT.inspect}
       gem "bread"
-      gem "pain_au_chocolat", :git => "../../gems/pain_au_chocolat"
+      gem "pain_au_chocolat", :git => "../../build/pain_au_chocolat"
 
       group :breakfast do
         gem "orange_juice"
-        gem "omelette", :git => "../../gems/omelette"
+        gem "omelette", :git => "../../build/omelette"
         gem "bacon"
 
         platforms :rbx do
@@ -147,6 +149,35 @@ describe 'Appraisals file Bundler DSL compatibility' do
 
       gemspec :path => "../"
       gemspec :path => "../sitepress"
-    Gemfile
+    GEMFILE
+  end
+
+  it 'supports ruby file: ".ruby-version" DSL' do
+    build_gemfile <<-GEMFILE
+      source 'https://rubygems.org'
+
+      ruby RUBY_VERSION
+
+      gem 'appraisal', :path => #{PROJECT_ROOT.inspect}
+    GEMFILE
+
+    build_appraisal_file <<-APPRAISALS
+      appraise 'ruby-version' do
+        ruby file: ".ruby-version"
+      end
+    APPRAISALS
+
+    run "bundle install --local"
+    run "appraisal generate"
+
+    expect(content_of("gemfiles/ruby_version.gemfile")).to eq <<-GEMFILE.strip_heredoc
+      # This file was generated by Appraisal
+
+      source "https://rubygems.org"
+
+      ruby({:file=>".ruby-version"})
+
+      gem "appraisal", :path => #{PROJECT_ROOT.inspect}
+    GEMFILE
   end
 end