ruby/spec/bundler/commands/console_spec.rb

# frozen_string_literal: true

RSpec.describe "bundle console", readline: true do
  before :each do
    build_repo2 do
      # A minimal fake pry console
      build_gem "pry" do |s|
        s.write "lib/pry.rb", <<-RUBY
          class Pry
            class << self
              def toplevel_binding
                unless defined?(@toplevel_binding) && @toplevel_binding
                  TOPLEVEL_BINDING.eval %{
                    def self.__pry__; binding; end
                    Pry.instance_variable_set(:@toplevel_binding, __pry__)
                    class << self; undef __pry__; end
                  }
                end
                @toplevel_binding.eval('private')
                @toplevel_binding
              end

              def __pry__
                while line = gets
                  begin
                    puts eval(line, toplevel_binding).inspect.sub(/^"(.*)"$/, '=> \\1')
                  rescue Exception => e
                    puts "\#{e.class}: \#{e.message}"
                    puts e.backtrace.first
                  end
                end
              end
              alias start __pry__
            end
          end
        RUBY
      end

      build_dummy_irb
    end
  end

  context "when the library requires a non-existent file" do
    before do
      build_lib "loadfuuu", "1.0.0" do |s|
        s.write "lib/loadfuuu.rb", "require_relative 'loadfuuu/bar'"
        s.write "lib/loadfuuu/bar.rb", "require 'not-in-bundle'"
      end

      install_gemfile <<-G
        source "https://gem.repo2"
        gem "irb"
        path "#{lib_path}" do
          gem "loadfuuu", require: true
        end
      G
    end

    it "does not show the bug report template" do
      bundle("console", raise_on_error: false) do |input, _, _|
        input.puts("exit")
      end

      expect(err).not_to include("ERROR REPORT TEMPLATE")
    end
  end

  context "when the library references a non-existent constant" do
    before do
      build_lib "loadfuuu", "1.0.0" do |s|
        s.write "lib/loadfuuu.rb", "Some::NonExistent::Constant"
      end

      install_gemfile <<-G
        source "https://gem.repo2"
        gem "irb"
        path "#{lib_path}" do
          gem "loadfuuu", require: true
        end
      G
    end

    it "does not show the bug report template" do
      bundle("console", raise_on_error: false) do |input, _, _|
        input.puts("exit")
      end

      expect(err).not_to include("ERROR REPORT TEMPLATE")
    end
  end

  context "when the library does not have any errors" do
    before do
      install_gemfile <<-G
        source "https://gem.repo2"
        gem "irb"
        gem "myrack"
        gem "activesupport", :group => :test
        gem "myrack_middleware", :group => :development
      G
    end

    it "starts IRB with the default group loaded" do
      bundle "console" do |input, _, _|
        input.puts("puts MYRACK")
        input.puts("exit")
      end
      expect(out).to include("0.9.1")
    end

    it "uses IRB as default console" do
      skip "Does not work in a ruby-core context if irb is in the default $LOAD_PATH because it enables the real IRB, not our dummy one" if ruby_core? && Gem.ruby_version < Gem::Version.new("3.5.0.a")

      bundle "console" do |input, _, _|
        input.puts("__method__")
        input.puts("exit")
      end
      expect(out).to include("__irb__")
    end

    it "starts another REPL if configured as such" do
      install_gemfile <<-G
        source "https://gem.repo2"
        gem "irb"
        gem "pry"
      G
      bundle "config set console pry"

      bundle "console" do |input, _, _|
        input.puts("__method__")
        input.puts("exit")
      end
      expect(out).to include(":__pry__")
    end

    it "falls back to IRB if the other REPL isn't available" do
      skip "Does not work in a ruby-core context if irb is in the default $LOAD_PATH because it enables the real IRB, not our dummy one" if ruby_core? && Gem.ruby_version < Gem::Version.new("3.5.0.a")

      bundle "config set console pry"
      # make sure pry isn't there

      bundle "console" do |input, _, _|
        input.puts("__method__")
        input.puts("exit")
      end
      expect(out).to include("__irb__")
    end

    it "does not try IRB twice if no console is configured and IRB is not available" do
      create_file("irb.rb", "raise LoadError, 'irb is not available'")

      bundle("console", env: { "RUBYOPT" => "-I#{bundled_app} #{ENV["RUBYOPT"]}" }, raise_on_error: false) do |input, _, _|
        input.puts("puts ACTIVESUPPORT")
        input.puts("exit")
      end
      expect(err).not_to include("falling back to irb")
      expect(err).to include("irb is not available")
    end

    it "doesn't load any other groups" do
      bundle "console" do |input, _, _|
        input.puts("puts ACTIVESUPPORT")
        input.puts("exit")
      end
      expect(out).to include("NameError")
    end

    describe "when given a group" do
      it "loads the given group" do
        bundle "console test" do |input, _, _|
          input.puts("puts ACTIVESUPPORT")
          input.puts("exit")
        end
        expect(out).to include("2.3.5")
      end

      it "loads the default group" do
        bundle "console test" do |input, _, _|
          input.puts("puts MYRACK")
          input.puts("exit")
        end
        expect(out).to include("0.9.1")
      end

      it "doesn't load other groups" do
        bundle "console test" do |input, _, _|
          input.puts("puts MYRACK_MIDDLEWARE")
          input.puts("exit")
        end
        expect(out).to include("NameError")
      end
    end

    it "performs an automatic bundle install" do
      gemfile <<-G
        source "https://gem.repo2"
        gem "irb"
        gem "myrack"
        gem "activesupport", :group => :test
        gem "myrack_middleware", :group => :development
        gem "foo"
      G

      bundle "config set auto_install 1"
      bundle :console do |input, _, _|
        input.puts("puts 'hello'")
        input.puts("exit")
      end
      expect(out).to include("Installing foo 1.0")
      expect(out).to include("hello")
      expect(the_bundle).to include_gems "foo 1.0"
    end
  end
end