appraisal 2.5.0 → 3.0.0.rc1

data/spec/acceptance/gemfile_dsl_compatibility_spec.rb

@@ -1,20 +1,22 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Gemfile DSL compatibility' do
-  it 'supports all Bundler DSL in Gemfile' do
-    build_gems %w(bacon orange_juice waffle)
-    build_git_gem 'egg'
+require "spec_helper"
+
+RSpec.describe "Gemfile DSL compatibility" do
+  it "supports all Bundler DSL in Gemfile" do
+    build_gems %w[bacon orange_juice waffle]
+    build_git_gem "egg"
     build_gemspec
 
-    build_gemfile <<-Gemfile
+    build_gemfile <<-GEMFILE
       source "https://rubygems.org"
       ruby RUBY_VERSION
 
-      git "../gems/egg" do
+      git "../build/egg" do
         gem "egg"
       end
 
-      path "../gems/orange_juice" do
+      path "../build/orange_juice" do
         gem "orange_juice"
       end
 
@@ -29,9 +31,9 @@ describe 'Gemfile DSL compatibility' do
       gem 'appraisal', :path => #{PROJECT_ROOT.inspect}
 
       gemspec
-    Gemfile
+    GEMFILE
 
-    build_appraisal_file <<-Appraisals
+    build_appraisal_file <<-APPRAISALS
       appraise "japanese" do
         gem "rice"
         gem "miso_soup"
@@ -40,23 +42,23 @@ describe 'Gemfile DSL compatibility' do
       appraise "english" do
         gem "bread"
       end
-    Appraisals
+    APPRAISALS
 
-    run 'bundle install --local'
-    run 'appraisal generate'
+    run "bundle install --local"
+    run "appraisal generate"
 
-    expect(content_of 'gemfiles/japanese.gemfile').to eq <<-Gemfile.strip_heredoc
+    expect(content_of("gemfiles/japanese.gemfile")).to eq <<-GEMFILE.strip_heredoc
       # This file was generated by Appraisal
 
       source "https://rubygems.org"
 
       ruby "#{RUBY_VERSION}"
 
-      git "../../gems/egg" do
+      git "../../build/egg" do
         gem "egg"
       end
 
-      path "../../gems/orange_juice" do
+      path "../../build/orange_juice" do
         gem "orange_juice"
       end
 
@@ -73,20 +75,20 @@ describe 'Gemfile DSL compatibility' do
       end
 
       gemspec :path => "../"
-    Gemfile
+    GEMFILE
 
-    expect(content_of 'gemfiles/english.gemfile').to eq <<-Gemfile.strip_heredoc
+    expect(content_of("gemfiles/english.gemfile")).to eq <<-GEMFILE.strip_heredoc
       # This file was generated by Appraisal
 
       source "https://rubygems.org"
 
       ruby "#{RUBY_VERSION}"
 
-      git "../../gems/egg" do
+      git "../../build/egg" do
         gem "egg"
       end
 
-      path "../../gems/orange_juice" do
+      path "../../build/orange_juice" do
         gem "orange_juice"
       end
 
@@ -102,7 +104,7 @@ describe 'Gemfile DSL compatibility' do
       end
 
       gemspec :path => "../"
-    Gemfile
+    GEMFILE
   end
 
   it "merges gem requirements" do
@@ -110,14 +112,14 @@ describe 'Gemfile DSL compatibility' do
     build_gem "bacon", "1.1.0"
     build_gem "bacon", "1.2.0"
 
-    build_gemfile <<-Gemfile
+    build_gemfile <<-GEMFILE
       source "https://rubygems.org"
 
       gem "appraisal", :path => #{PROJECT_ROOT.inspect}
       gem "bacon", "1.2.0"
-    Gemfile
+    GEMFILE
 
-    build_appraisal_file <<-Appraisals
+    build_appraisal_file <<-APPRAISALS
       appraise "1.0.0" do
         gem "bacon", "1.0.0"
       end
@@ -129,21 +131,21 @@ describe 'Gemfile DSL compatibility' do
       appraise "1.2.0" do
         gem "bacon", "1.2.0"
       end
-    Appraisals
+    APPRAISALS
 
-    run 'bundle install --local'
-    run 'appraisal generate'
+    run "bundle install --local"
+    run "appraisal generate"
 
-    expect(content_of "gemfiles/1.0.0.gemfile").to include('gem "bacon", "1.0.0"')
-    expect(content_of "gemfiles/1.1.0.gemfile").to include('gem "bacon", "1.1.0"')
-    expect(content_of "gemfiles/1.2.0.gemfile").to include('gem "bacon", "1.2.0"')
+    expect(content_of("gemfiles/1.0.0.gemfile")).to include('gem "bacon", "1.0.0"')
+    expect(content_of("gemfiles/1.1.0.gemfile")).to include('gem "bacon", "1.1.0"')
+    expect(content_of("gemfiles/1.2.0.gemfile")).to include('gem "bacon", "1.2.0"')
   end
 
   it "supports gemspec in the group block" do
     build_gem "bacon", "1.0.0"
     build_gemspec
 
-    build_gemfile <<-Gemfile
+    build_gemfile <<-GEMFILE
       source "https://rubygems.org"
 
       gem "appraisal", :path => #{PROJECT_ROOT.inspect}
@@ -151,18 +153,18 @@ describe 'Gemfile DSL compatibility' do
       group :plugin do
         gemspec
       end
-    Gemfile
+    GEMFILE
 
-    build_appraisal_file <<-Appraisals
+    build_appraisal_file <<-APPRAISALS
       appraise "1.0.0" do
         gem "bacon", "1.0.0"
       end
-    Appraisals
+    APPRAISALS
 
     run "bundle install --local"
     run "appraisal generate"
 
-    expect(content_of "gemfiles/1.0.0.gemfile").to eq <<-gemfile.strip_heredoc
+    expect(content_of("gemfiles/1.0.0.gemfile")).to eq <<-GEMFILE.strip_heredoc
       # This file was generated by Appraisal
 
       source "https://rubygems.org"
@@ -173,6 +175,6 @@ describe 'Gemfile DSL compatibility' do
       group :plugin do
         gemspec :path => "../"
       end
-    gemfile
+    GEMFILE
   end
 end

data/spec/acceptance/gemspec_spec.rb

@@ -1,57 +1,59 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe 'Gemspec' do
+require "spec_helper"
+
+RSpec.describe "Gemspec" do
   before do
     build_appraisal_file
     build_rakefile
   end
 
-  it 'supports gemspec syntax with default options' do
+  it "supports gemspec syntax with default options" do
     build_gemspec
 
-    write_file 'Gemfile', <<-Gemfile
+    write_file "Gemfile", <<-GEMFILE
       source "https://rubygems.org"
 
       gem 'appraisal', :path => #{PROJECT_ROOT.inspect}
 
       gemspec
-    Gemfile
+    GEMFILE
 
-    run 'bundle install --local'
-    run 'appraisal install'
-    output = run 'appraisal rake version'
+    run "bundle install --local"
+    run "appraisal install"
+    output = run "appraisal rake version"
 
-    expect(output).to include 'Loaded 1.1.0'
+    expect(output).to include "Loaded 1.1.0"
   end
 
-  it 'supports gemspec syntax with path option' do
-    build_gemspec 'specdir'
+  it "supports gemspec syntax with path option" do
+    build_gemspec "specdir"
 
-    write_file 'Gemfile', <<-Gemfile
+    write_file "Gemfile", <<-GEMFILE
       source "https://rubygems.org"
 
       gem 'appraisal', :path => #{PROJECT_ROOT.inspect}
 
       gemspec :path => './specdir'
-    Gemfile
+    GEMFILE
 
-    run 'bundle install --local'
-    run 'appraisal install'
-    output = run 'appraisal rake version'
+    run "bundle install --local"
+    run "appraisal install"
+    output = run "appraisal rake version"
 
-    expect(output).to include 'Loaded 1.1.0'
+    expect(output).to include "Loaded 1.1.0"
   end
 
   def build_appraisal_file
-    super <<-Appraisals
+    super <<-APPRAISALS
       appraise 'stock' do
         gem 'rake'
       end
-    Appraisals
+    APPRAISALS
   end
 
   def build_rakefile
-    write_file 'Rakefile', <<-rakefile
+    write_file "Rakefile", <<-RAKEFILE
       require 'rubygems'
       require 'bundler/setup'
       require 'appraisal'
@@ -60,13 +62,13 @@ describe 'Gemspec' do
         require 'dummy'
         puts "Loaded \#{$dummy_version}"
       end
-    rakefile
+    RAKEFILE
   end
 
-  def build_gemspec(path = '.')
+  def build_gemspec(path = ".")
     Dir.mkdir("tmp/stage/#{path}") rescue nil
 
-    write_file File.join(path, 'gemspec_project.gemspec'), <<-gemspec
+    write_file File.join(path, "gemspec_project.gemspec"), <<-GEMSPEC
       Gem::Specification.new do |s|
         s.name = 'gemspec_project'
         s.version = '0.1'
@@ -75,6 +77,6 @@ describe 'Gemspec' do
 
         s.add_development_dependency('dummy', '1.1.0')
       end
-    gemspec
+    GEMSPEC
   end
 end

data/spec/appraisal/appraisal_file_spec.rb

@@ -1,14 +1,76 @@
-require 'spec_helper'
-require 'appraisal/appraisal_file'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "appraisal/appraisal_file"
 
 # Requiring this to make the test pass on Rubinius 2.2.5
 # https://github.com/rubinius/rubinius/issues/2934
-require 'rspec/matchers/built_in/raise_error'
+require "rspec/matchers/composable"
+require "rspec/matchers/built_in/raise_error"
 
-describe Appraisal::AppraisalFile do
+RSpec.describe Appraisal::AppraisalFile do
   it "complains when no Appraisals file is found" do
     allow(File).to receive(:exist?).with(/Gemfile/).and_return(true)
     allow(File).to receive(:exist?).with("Appraisals").and_return(false)
     expect { described_class.new }.to raise_error(Appraisal::AppraisalsNotFound)
   end
+
+  describe "#customize_gemfiles" do
+    before(:each) do
+      allow(File).to receive(:exist?).with(anything).and_return(true)
+      allow(IO).to receive(:read).with(anything).and_return("")
+    end
+
+    context "when no arguments are given" do
+      subject { described_class.new.customize_gemfiles }
+
+      it "raises an error" do
+        expect { subject }.to raise_error(LocalJumpError)
+      end
+    end
+
+    context "when a block is given" do
+      context "when the block returns a hash with :heading key" do
+        subject do
+          described_class.new.customize_gemfiles do
+            { heading: "foo" }
+          end
+        end
+
+        it "sets the heading" do
+          pending("test is broken: wrong number of arguments (given 0, expected 1)")
+
+          expect { subject }.to change { Appraisal::Customize.heading }.to("foo")
+        end
+      end
+
+      context "when the block returns a hash with :single_quotes key" do
+        subject do
+          described_class.new.customize_gemfiles do
+            { single_quotes: true }
+          end
+        end
+
+        it "sets the single_quotes" do
+          expect { subject }.to change { Appraisal::Customize.single_quotes }.to(true)
+        end
+      end
+
+      context "when the block returns a hash with :heading and :single_quotes keys" do
+        subject do
+          described_class.new.customize_gemfiles do
+            { heading: "foo", single_quotes: true }
+          end
+        end
+
+        it "sets the heading and single_quotes" do
+          pending("test is broken: wrong number of arguments (given 0, expected 1)")
+
+          subject
+          expect(Appraisal::Customize.heading).to eq("foo")
+          expect(Appraisal::Customize.single_quotes).to eq(true)
+        end
+      end
+    end
+  end
 end

data/spec/appraisal/appraisal_spec.rb

@@ -1,8 +1,10 @@
-require 'spec_helper'
-require 'appraisal/appraisal'
-require 'tempfile'
+# frozen_string_literal: true
 
-describe Appraisal::Appraisal do
+require "spec_helper"
+require "appraisal/appraisal"
+require "tempfile"
+
+RSpec.describe Appraisal::Appraisal do
   it "converts spaces to underscores in the gemfile path" do
     appraisal = Appraisal::Appraisal.new("one two", "Gemfile")
     expect(appraisal.gemfile_path).to match(/one_two\.gemfile$/)
@@ -85,50 +87,45 @@ describe Appraisal::Appraisal do
     end
   end
 
-  context 'parallel installation' do
+  context "parallel installation" do
     include StreamHelpers
 
     before do
-      @appraisal = Appraisal::Appraisal.new('fake', 'fake')
+      @appraisal = Appraisal::Appraisal.new("fake", "fake")
       allow(@appraisal).to receive(:gemfile_path).and_return("/home/test/test directory")
-      allow(@appraisal).to receive(:project_root).
-        and_return(Pathname.new("/home/test"))
-      allow(Appraisal::Command).to receive(:new).and_return(double(:run => true))
+      allow(@appraisal).to receive(:project_root).and_return(Pathname.new("/home/test"))
+      allow(Appraisal::Command).to receive(:new).and_return(double(run: true))
     end
 
-    it 'runs single install command on Bundler < 1.4.0' do
-      stub_const('Bundler::VERSION', '1.3.0')
+    it "runs single install command on Bundler < 1.4.0" do
+      stub_const("Bundler::VERSION", "1.3.0")
 
       warning = capture(:stderr) do
         @appraisal.install("jobs" => 42)
       end
 
-      expect(Appraisal::Command).to have_received(:new).
-        with("#{bundle_check_command} || #{bundle_single_install_command}")
-      expect(warning).to include 'Please upgrade Bundler'
+      expect(Appraisal::Command).to have_received(:new).with("#{bundle_check_command} || #{bundle_single_install_command}")
+      expect(warning).to include "Please upgrade Bundler"
     end
 
-    it 'runs parallel install command on Bundler >= 1.4.0' do
-      stub_const('Bundler::VERSION', '1.4.0')
+    it "runs parallel install command on Bundler >= 1.4.0" do
+      stub_const("Bundler::VERSION", "1.4.0")
 
       @appraisal.install("jobs" => 42)
 
-      expect(Appraisal::Command).to have_received(:new).
-        with("#{bundle_check_command} || #{bundle_parallel_install_command}")
+      expect(Appraisal::Command).to have_received(:new).with("#{bundle_check_command} || #{bundle_parallel_install_command}")
     end
 
-    it 'runs install command with retries on Bundler' do
+    it "runs install command with retries on Bundler" do
       @appraisal.install("retry" => 3)
 
-      expect(Appraisal::Command).to have_received(:new).
-        with("#{bundle_check_command} || #{bundle_install_command_with_retries}")
+      expect(Appraisal::Command).to have_received(:new).with("#{bundle_check_command} || #{bundle_install_command_with_retries}")
     end
 
     it "runs install command with path on Bundler" do
       @appraisal.install("path" => "vendor/appraisal")
 
-      expect(Appraisal::Command).to have_received(:new).
-        with("#{bundle_check_command} || #{bundle_install_command_with_path}")
+      expect(Appraisal::Command).to have_received(:new).with("#{bundle_check_command} || #{bundle_install_command_with_path}")
     end
 
     def bundle_check_command

data/spec/appraisal/customize_spec.rb

@@ -1,18 +1,140 @@
+# frozen_string_literal: true
+
 require "spec_helper"
+require "appraisal/appraisal"
 require "appraisal/customize"
 
-describe Appraisal::Customize do
-  it "has defaults" do
-    expect(described_class.heading).to eq nil
-    expect(described_class.single_quotes).to eq false
-    expect { described_class.new }.to_not(change do
-      [described_class.heading, described_class.single_quotes]
-    end)
+RSpec.describe Appraisal::Customize do
+  let(:appraisal) { Appraisal::Appraisal.new("test", "Gemfile") }
+  let(:single_line_heading) { "This file was generated with a custom heading!" }
+  let(:multi_line_heading) do
+    <<~HEADING
+      frozen_string_literal: true
+
+      This file was generated with a custom heading!
+    HEADING
+  end
+  let(:subject) { described_class.new }
+  let(:single_line_subject) do
+    described_class.new(heading: single_line_heading)
+  end
+  let(:multi_line_single_quotes_subject) do
+    described_class.new(heading: multi_line_heading, single_quotes: true)
+  end
+
+  describe ".heading" do
+    it "returns nil if no heading is set" do
+      subject
+      expect(described_class.heading(appraisal)).to eq(nil)
+    end
+
+    it "returns the heading if set" do
+      single_line_subject
+      expect(described_class.heading(appraisal)).to eq(single_line_heading)
+    end
+
+    it "returns the heading without an trailing newline" do
+      multi_line_single_quotes_subject
+      expect(described_class.heading(appraisal)).to eq(multi_line_heading.chomp)
+      expect(described_class.heading(appraisal)).to_not end_with("\n")
+    end
+  end
+
+  describe ".single_quotes" do
+    it "returns false if not set" do
+      subject
+      expect(described_class.single_quotes).to eq(false)
+    end
+
+    it "returns true if set" do
+      multi_line_single_quotes_subject
+      expect(described_class.single_quotes).to eq(true)
+    end
   end
 
-  it "can override defaults" do
-    described_class.new(single_quotes: true, heading: "foo")
-    expect(described_class.heading).to eq "foo"
-    expect(described_class.single_quotes).to eq true
+  describe ".customize" do
+    let(:appraisal_name) { "test" }
+    let(:gemfile) { "test.gemfile" }
+    let(:lockfile) { "#{gemfile}.lock" }
+    let(:gemfile_relative_path) { "gemfiles/#{gemfile}" }
+    let(:lockfile_relative_path) { "gemfiles/#{lockfile}" }
+    let(:gemfile_full_path) { "/path/to/project/#{gemfile_relative_path}" }
+    let(:lockfile_full_path) { "/path/to/project/#{lockfile_relative_path}" }
+    before do
+      allow(appraisal).to receive(:gemfile_name).and_return(gemfile)
+      allow(appraisal).to receive(:gemfile_path).and_return(gemfile_full_path)
+      allow(appraisal).to receive(:lockfile_path).and_return(lockfile_full_path)
+      allow(appraisal).to receive(:relative_gemfile_path).and_return(gemfile_relative_path)
+    end
+
+    it "returns nil if no heading is set" do
+      subject
+      expect(described_class.send(:customize, nil, appraisal)).to eq(nil)
+    end
+
+    it "returns the heading unchanged" do
+      single_line_subject
+      expect(described_class.send(
+               :customize,
+               single_line_heading,
+               appraisal
+             )).to eq(single_line_heading)
+    end
+
+    it "returns the heading with the appraisal name" do
+      expect(described_class.send(
+               :customize,
+               "Appraisal: %{appraisal}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Appraisal: #{appraisal_name}")
+    end
+
+    it "returns the heading with the gemfile name" do
+      expect(described_class.send(
+               :customize,
+               "Gemfile: %{gemfile}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Gemfile: #{gemfile}")
+    end
+
+    it "returns the heading with the gemfile path" do
+      expect(described_class.send(
+               :customize,
+               "Gemfile: %{gemfile_path}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Gemfile: #{gemfile_full_path}")
+    end
+
+    it "returns the heading with the lockfile name" do
+      expect(described_class.send(
+               :customize,
+               "Lockfile: %{lockfile}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Lockfile: #{lockfile}")
+    end
+
+    it "returns the heading with the lockfile path" do
+      expect(described_class.send(
+               :customize,
+               "Lockfile: %{lockfile_path}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Lockfile: #{lockfile_full_path}")
+    end
+
+    it "returns the heading with the relative gemfile path" do
+      expect(described_class.send(
+               :customize,
+               "Gemfile: %{relative_gemfile_path}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Gemfile: #{gemfile_relative_path}")
+    end
+
+    it "returns the heading with the relative lockfile path" do
+      expect(described_class.send(
+               :customize,
+               "Gemfile: %{relative_lockfile_path}", # rubocop:disable Style/FormatStringToken
+               appraisal
+             )).to eq("Gemfile: #{lockfile_relative_path}")
+    end
   end
 end

data/spec/appraisal/dependency_list_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 require "appraisal/dependency_list"
 
-describe Appraisal::DependencyList do
+RSpec.describe Appraisal::DependencyList do
   describe "#add" do
     let(:dependency_list) { Appraisal::DependencyList.new }