pry--pry/test/test_pry.rb

require 'helper'

puts "Ruby Version #{RUBY_VERSION}"
puts "Testing Pry #{Pry::VERSION}"
puts "With method_source version #{MethodSource::VERSION}"
puts "--"

describe Pry do
  describe "open a Pry session on an object" do
    describe "rep" do
      before do
        class Hello
        end
      end

      after do
        Object.send(:remove_const, :Hello)
      end

      # bug fix for https://github.com/banister/pry/issues/93
      it 'should not leak pry constants into Object namespace' do
        input_string = "CommandContext"
        str_output = StringIO.new
        o = Object.new
        pry_tester = Pry.new(:input => StringIO.new(input_string),
                             :output => str_output,
                             :exception_handler => proc { |_, exception| @excep = exception },
                             :print => proc {}
                             ).rep(o)

        @excep.is_a?(NameError).should == true
      end

      it 'should set an ivar on an object' do
        input_string = "@x = 10"
        input = InputTester.new(input_string)
        o = Object.new

        pry_tester = Pry.new(:input => input, :output => Pry::NullOutput)
        pry_tester.rep(o)
        o.instance_variable_get(:@x).should == 10
      end

      it 'should make self evaluate to the receiver of the rep session' do
        o = Object.new
        str_output = StringIO.new

        pry_tester = Pry.new(:input => InputTester.new("self"), :output => str_output)
        pry_tester.rep(o)
        str_output.string.should =~ /#{o.to_s}/
      end

      it 'should work with multi-line input' do
        o = Object.new
        str_output = StringIO.new

        pry_tester = Pry.new(:input => InputTester.new("x = ", "1 + 4"), :output => str_output)
        pry_tester.rep(o)
        str_output.string.should =~ /5/
      end

      it 'should define a nested class under Hello and not on top-level or Pry' do
        pry_tester = Pry.new(:input => InputTester.new("class Nested", "end"), :output => Pry::NullOutput)
        pry_tester.rep(Hello)
        Hello.const_defined?(:Nested).should == true
      end

      it 'should suppress output if input ends in a ";" and is an Exception object (single line)' do
        o = Object.new
        str_output = StringIO.new

        pry_tester = Pry.new(:input => InputTester.new("Exception.new;"), :output => str_output)
        pry_tester.rep(o)
        str_output.string.should == ""
      end

      it 'should suppress output if input ends in a ";" (single line)' do
        o = Object.new
        str_output = StringIO.new

        pry_tester = Pry.new(:input => InputTester.new("x = 5;"), :output => str_output)
        pry_tester.rep(o)
        str_output.string.should == ""
      end


      it 'should suppress output if input ends in a ";" (multi-line)' do
        o = Object.new
        str_output = StringIO.new

        pry_tester = Pry.new(:input => InputTester.new("def self.blah", ":test", "end;"), :output => str_output)
        pry_tester.rep(o)
        str_output.string.should == ""
      end

      it 'should be able to evaluate exceptions normally' do
        o = Exception.new
        str_output = StringIO.new

        was_called = false
        pry_tester = Pry.new(:input => InputTester.new("self"),
                             :output => str_output,
                             :exception_handler => proc { was_called = true })

        pry_tester.rep(o)
        was_called.should == false
      end

      it 'should notice when exceptions are raised' do
        o = Exception.new
        str_output = StringIO.new

        was_called = false
        pry_tester = Pry.new(:input => InputTester.new("raise self"),
                             :output => str_output,
                             :exception_handler => proc { was_called = true })

        pry_tester.rep(o)
        was_called.should == true
      end
    end

    describe "repl" do
      describe "basic functionality" do
        it 'should set an ivar on an object and exit the repl' do
          input_strings = ["@x = 10", "exit"]
          input = InputTester.new(*input_strings)

          o = Object.new

          pry_tester = Pry.start(o, :input => input, :output => Pry::NullOutput)

          o.instance_variable_get(:@x).should == 10
        end
      end

      describe "test loading rc files" do
        after do
          Pry::RC_FILES.clear
          Pry.should_load_rc = false
        end

        it "should run the rc file only once" do
          Pry.should_load_rc = true
          Pry::RC_FILES << File.expand_path("../testrc", __FILE__)

          Pry.start(self, :input => StringIO.new("exit\n"), :output => Pry::NullOutput)
          TEST_RC.should == [0]

          Pry.start(self, :input => StringIO.new("exit\n"), :output => Pry::NullOutput)
          TEST_RC.should == [0]

          Object.remove_const(:TEST_RC)
        end

        it "should not run the rc file at all if Pry.should_load_rc is false" do
          Pry.should_load_rc = false
          Pry.start(self, :input => StringIO.new("exit\n"), :output => Pry::NullOutput)
          Object.const_defined?(:TEST_RC).should == false
        end

        it "should not load the rc file if #repl method invoked" do
          Pry.should_load_rc = true
          Pry.new(:input => StringIO.new("exit\n"), :output => Pry::NullOutput).repl(self)
          Object.const_defined?(:TEST_RC).should == false
          Pry.should_load_rc = false
        end
      end

      describe "nesting" do
        after do
          Pry.reset_defaults
          Pry.color = false
        end

        it 'should nest properly' do
          Pry.input = InputTester.new("pry", "pry", "pry", "\"nest:\#\{Pry.nesting.level\}\"", "exit_all")

          str_output = StringIO.new
          Pry.output = str_output

          o = Object.new

          pry_tester = o.pry
          str_output.string.should =~ /nest:3/
        end
      end

      describe "defining methods" do
        it 'should define a method on the singleton class of an object when performing "def meth;end" inside the object' do
          [Object.new, {}, []].each do |val|
            str_input = StringIO.new("def hello;end")
            Pry.new(:input => str_input, :output => StringIO.new).rep(val)

            val.methods(false).map(&:to_sym).include?(:hello).should == true
          end
        end

        it 'should define an instance method on the module when performing "def meth;end" inside the module' do
          str_input = StringIO.new("def hello;end")
          hello = Module.new
          Pry.new(:input => str_input, :output => StringIO.new).rep(hello)
          hello.instance_methods(false).map(&:to_sym).include?(:hello).should == true
        end

        it 'should define an instance method on the class when performing "def meth;end" inside the class' do
          str_input = StringIO.new("def hello;end")
          hello = Class.new
          Pry.new(:input => str_input, :output => StringIO.new).rep(hello)
          hello.instance_methods(false).map(&:to_sym).include?(:hello).should == true
        end

        it 'should define a method on the class of an object when performing "def meth;end" inside an immediate value or Numeric' do
          # should include  float in here, but test fails for some reason
          # on 1.8.7, no idea why!
          [:test, 0, true, false, nil].each do |val|
            str_input = StringIO.new("def hello;end")
            Pry.new(:input => str_input, :output => StringIO.new).rep(val)
            val.class.instance_methods(false).map(&:to_sym).include?(:hello).should == true
          end
        end

      end


      describe "commands" do
        it 'should run a command with no parameter' do
          pry_tester = Pry.new
          pry_tester.commands = CommandTester
          pry_tester.input = InputTester.new("command1", "exit_all")
          pry_tester.commands = CommandTester

          str_output = StringIO.new
          pry_tester.output = str_output

          pry_tester.rep

          str_output.string.should =~ /command1/
        end

        it 'should run a command with one parameter' do
          pry_tester = Pry.new
          pry_tester.commands = CommandTester
          pry_tester.input = InputTester.new("command2 horsey", "exit_all")
          pry_tester.commands = CommandTester

          str_output = StringIO.new
          pry_tester.output = str_output

          pry_tester.rep

          str_output.string.should =~ /horsey/
        end
      end

      describe "Object#pry" do

        after do
          Pry.reset_defaults
          Pry.color = false
        end

        it "should start a pry session on the receiver (first form)" do
          Pry.input = InputTester.new("self", "exit")

          str_output = StringIO.new
          Pry.output = str_output

          20.pry

          str_output.string.should =~ /20/
        end

        it "should start a pry session on the receiver (second form)" do
          Pry.input = InputTester.new("self", "exit")

          str_output = StringIO.new
          Pry.output = str_output

          pry 20

          str_output.string.should =~ /20/
        end

        it "should error if more than one argument is passed to Object#pry" do
          lambda { pry(20, :input => Readline) }.should.raise ArgumentError
        end
      end

      describe "Pry.binding_for" do
        it 'should return TOPLEVEL_BINDING if parameter self is main' do
          _main_ = lambda { TOPLEVEL_BINDING.eval('self') }
          Pry.binding_for(_main_.call).is_a?(Binding).should == true
          Pry.binding_for(_main_.call).should == TOPLEVEL_BINDING
          Pry.binding_for(_main_.call).should == Pry.binding_for(_main_.call)
        end
      end


      describe "test Pry defaults" do

        after do
          Pry.reset_defaults
          Pry.color = false
        end

        describe "input" do

          after do
            Pry.reset_defaults
            Pry.color = false
          end

          it 'should set the input default, and the default should be overridable' do
            Pry.input = InputTester.new("5")

            str_output = StringIO.new
            Pry.output = str_output
            Pry.new.rep
            str_output.string.should =~ /5/

            Pry.new(:input => InputTester.new("6")).rep
            str_output.string.should =~ /6/
          end

          it 'should pass in the prompt if readline arity is 1' do
            Pry.prompt = proc { "A" }

            arity_one_input = Class.new do
              attr_accessor :prompt
              def readline(prompt)
                @prompt = prompt
                "exit"
              end
            end.new

            Pry.start(self, :input => arity_one_input, :output => Pry::NullOutput)
            arity_one_input.prompt.should == Pry.prompt.call
          end

          it 'should not pass in the prompt if the arity is 0' do
            Pry.prompt = proc { "A" }

            arity_zero_input = Class.new do
              def readline
                "exit"
              end
            end.new

            lambda { Pry.start(self, :input => arity_zero_input, :output => Pry::NullOutput) }.should.not.raise Exception
          end

          it 'should not pass in the prompt if the arity is -1' do
            Pry.prompt = proc { "A" }

            arity_multi_input = Class.new do
              attr_accessor :prompt

              def readline(*args)
                @prompt = args.first
                "exit"
              end
            end.new

            Pry.start(self, :input => arity_multi_input, :output => Pry::NullOutput)
            arity_multi_input.prompt.should == nil
          end

        end

        it 'should set the output default, and the default should be overridable' do
          Pry.input = InputTester.new("5", "6", "7")

          str_output = StringIO.new
          Pry.output = str_output

          Pry.new.rep
          str_output.string.should =~ /5/

          Pry.new.rep
          str_output.string.should =~ /5\n.*6/

          str_output2 = StringIO.new
          Pry.new(:output => str_output2).rep
          str_output2.string.should.not =~ /5\n.*6/
          str_output2.string.should =~ /7/
        end

        # describe "Pry.run_command" do
        #   before do
        #     class RCTest
        #       def a() end
        #       B = 20
        #       @x = 10
        #     end
        #   end

        #   after do
        #     Object.remove_const(:RCTest)
        #   end

        #   it "should execute command in the appropriate object context" do
        #     result = Pry.run_command "ls", :context => RCTest
        #     result.map(&:to_sym).should == [:@x]
        #   end

        #   it "should execute command with parameters in the appropriate object context" do
        #     result = Pry.run_command "ls -M", :context => RCTest
        #     result.map(&:to_sym).should == [:a]
        #   end

        #   it "should execute command and show output with :show_output => true flag" do
        #     str = StringIO.new
        #     Pry.output = str
        #     result = Pry.run_command "ls -afv", :context => RCTest, :show_output => true
        #     str.string.should =~ /global variables/
        #     Pry.output = $stdout
        #   end

        #   it "should execute command with multiple parameters" do
        #     result = Pry.run_command "ls -c -M RCTest"
        #     result.map(&:to_sym).should == [:a, :B]
        #   end
        # end

        describe "commands" do
          it 'should interpolate ruby code into commands' do
            klass = Pry::CommandSet.new :test do
              command "hello", "", :keep_retval => true do |arg|
                arg
              end
            end

            @test_interpolation = "bing"
            str_output = StringIO.new
            Pry.new(:input => StringIO.new("hello #{@test_interpolation}"), :output => str_output, :commands => klass).rep
            str_output.string.should =~ /bing/
            @test_interpolation = nil
          end

          it 'should create a comand in  a nested context and that command should be accessible from the parent' do
            str_input = StringIO.new("@x=nil\ncd 7\n_pry_.commands.instance_eval {\ncommand('bing') { |arg| run arg }\n}\ncd ..\nbing ls\nexit")
            str_output = StringIO.new
            Pry.input = str_input
            obj = Object.new
            Pry.new(:output => str_output).repl(obj)
            Pry.input = Readline
            str_output.string.should =~ /@x/
          end

          it 'should define a command that keeps its return value' do
            klass = Pry::CommandSet.new :test do
              command "hello", "", :keep_retval => true do
                :kept_hello
              end
            end
            str_output = StringIO.new
            Pry.new(:input => StringIO.new("hello\n"), :output => str_output, :commands => klass).rep
            str_output.string.should =~ /:kept_hello/
            str_output.string.should =~ /=>/
          end

          it 'should define a command that does NOT keep its return value' do
            klass = Pry::CommandSet.new :test do
              command "hello", "", :keep_retval => false do
                :kept_hello
              end
            end
            str_output = StringIO.new
            Pry.new(:input => StringIO.new("hello\n"), :output => str_output, :commands => klass).rep
            (str_output.string =~ /:kept_hello/).should == nil
            str_output.string !~ /=>/
          end

          it 'should set the commands default, and the default should be overridable' do
            klass = Pry::CommandSet.new :test do
              command "hello" do
                output.puts "hello world"
              end
            end

            Pry.commands = klass

            str_output = StringIO.new
            Pry.new(:input => InputTester.new("hello"), :output => str_output).rep
            str_output.string.should =~ /hello world/

            other_klass = Pry::CommandSet.new :test2 do
              command "goodbye", "" do
                output.puts "goodbye world"
              end
            end

            str_output = StringIO.new

            Pry.new(:input => InputTester.new("goodbye"), :output => str_output, :commands => other_klass).rep
            str_output.string.should =~ /goodbye world/
          end

          it 'should inherit "help" command from Pry::CommandBase' do
            klass = Pry::CommandSet.new :test do
              command "h", "h command" do
              end
            end

            klass.commands.keys.size.should == 3
            klass.commands.keys.include?("help").should == true
            klass.commands.keys.include?("install").should == true
            klass.commands.keys.include?("h").should == true
          end

          it 'should inherit commands from Pry::Commands' do
            klass = Pry::CommandSet.new :test, Pry::Commands do
              command "v" do
              end
            end

            klass.commands.include?("nesting").should == true
            klass.commands.include?("jump-to").should == true
            klass.commands.include?("cd").should == true
            klass.commands.include?("v").should == true
          end

          it 'should alias a command with another command' do
              klass = Pry::CommandSet.new :test do
              alias_command "help2", "help"
            end


              klass.commands["help2"].block.should == klass.commands["help"].block
          end

          it 'should change description of a command using desc' do
            klass = Pry::CommandSet.new :test do; end
            orig = klass.commands["help"].description
            klass.instance_eval do
              desc "help", "blah"
            end
            klass.commands["help"].description.should.not == orig
            klass.commands["help"].description.should == "blah"
          end

          it 'should run a command from within a command' do
            klass = Pry::CommandSet.new :test do
              command "v" do
                output.puts "v command"
              end

              command "run_v" do
                run "v"
              end
            end

            str_output = StringIO.new
            Pry.new(:input => InputTester.new("run_v"), :output => str_output, :commands => klass).rep
            str_output.string.should =~ /v command/
          end

          it 'should enable an inherited method to access opts and output and target, due to instance_exec' do
            klass = Pry::CommandSet.new :test do
              command "v" do
                output.puts "#{target.eval('self')}"
              end
            end

            child_klass = Pry::CommandSet.new :test2, klass do
            end

            str_output = StringIO.new
            Pry.new(:print => proc {}, :input => InputTester.new("v"),
                    :output => str_output, :commands => child_klass).rep("john")

            str_output.string.rstrip.should == "john"
          end

          it 'should import commands from another command object' do
            klass = Pry::CommandSet.new :test do
              import_from Pry::Commands, "ls", "jump-to"
            end

              klass.commands.include?("ls").should == true
              klass.commands.include?("jump-to").should == true
            end

          it 'should delete some inherited commands when using delete method' do
            klass = Pry::CommandSet.new :test, Pry::Commands do
              command "v" do
              end

              delete "show-doc", "show-method"
              delete "ls"
            end

            klass.commands.include?("nesting").should == true
            klass.commands.include?("jump-to").should == true
            klass.commands.include?("cd").should == true
            klass.commands.include?("v").should == true
            klass.commands.include?("show-doc").should == false
            klass.commands.include?("show-method").should == false
            klass.commands.include?("ls").should == false
          end

          it 'should override some inherited commands' do
            klass = Pry::CommandSet.new :test, Pry::Commands do
              command "jump-to" do
                output.puts "jump-to the music"
              end

              command "help" do
                output.puts "help to the music"
              end
            end

            # suppress evaluation output
            Pry.print = proc {}

            str_output = StringIO.new
            Pry.new(:input => InputTester.new("jump-to"), :output => str_output, :commands => klass).rep
            str_output.string.rstrip.should == "jump-to the music"

            str_output = StringIO.new
            Pry.new(:input => InputTester.new("help"), :output => str_output, :commands => klass).rep
            str_output.string.rstrip.should == "help to the music"


            Pry.reset_defaults
            Pry.color = false
          end
        end

        it "should set the print default, and the default should be overridable" do
          new_print = proc { |out, value| out.puts value }
          Pry.print =  new_print

          Pry.new.print.should == Pry.print
          str_output = StringIO.new
          Pry.new(:input => InputTester.new("\"test\""), :output => str_output).rep
          str_output.string.should == "test\n"

          str_output = StringIO.new
          Pry.new(:input => InputTester.new("\"test\""), :output => str_output,
                  :print => proc { |out, value| out.puts value.reverse }).rep
          str_output.string.should == "tset\n"

          Pry.new.print.should == Pry.print
          str_output = StringIO.new
          Pry.new(:input => InputTester.new("\"test\""), :output => str_output).rep
          str_output.string.should == "test\n"
        end

        describe "pry return values" do
          it 'should return the target object' do
            Pry.start(self, :input => StringIO.new("exit"), :output => Pry::NullOutput).should == self
          end

          it 'should return the parameter given to exit' do
            Pry.start(self, :input => StringIO.new("exit 10"), :output => Pry::NullOutput).should == 10
          end

          it 'should return the parameter (multi word string) given to exit' do
            Pry.start(self, :input => StringIO.new("exit \"john mair\""), :output => Pry::NullOutput).should == "john mair"
          end

          it 'should return the parameter (function call) given to exit' do
            Pry.start(self, :input => StringIO.new("exit 'abc'.reverse"), :output => Pry::NullOutput).should == 'cba'
          end

          it 'should return the parameter (self) given to exit' do
            Pry.start("carl", :input => StringIO.new("exit self"), :output => Pry::NullOutput).should == "carl"
          end
        end

        describe "prompts" do
          it 'should set the prompt default, and the default should be overridable (single prompt)' do
            new_prompt = proc { "test prompt> " }
            Pry.prompt =  new_prompt

            Pry.new.prompt.should == Pry.prompt
            Pry.new.select_prompt(true, 0).should == "test prompt> "
            Pry.new.select_prompt(false, 0).should == "test prompt> "

            new_prompt = proc { "A" }
            pry_tester = Pry.new(:prompt => new_prompt)
            pry_tester.prompt.should == new_prompt
            pry_tester.select_prompt(true, 0).should == "A"
            pry_tester.select_prompt(false, 0).should == "A"

            Pry.new.prompt.should == Pry.prompt
            Pry.new.select_prompt(true, 0).should == "test prompt> "
            Pry.new.select_prompt(false, 0).should == "test prompt> "
          end

          it 'should set the prompt default, and the default should be overridable (multi prompt)' do
            new_prompt = [proc { "test prompt> " }, proc { "test prompt* " }]
            Pry.prompt =  new_prompt

            Pry.new.prompt.should == Pry.prompt
            Pry.new.select_prompt(true, 0).should == "test prompt> "
            Pry.new.select_prompt(false, 0).should == "test prompt* "

            new_prompt = [proc { "A" }, proc { "B" }]
            pry_tester = Pry.new(:prompt => new_prompt)
            pry_tester.prompt.should == new_prompt
            pry_tester.select_prompt(true, 0).should == "A"
            pry_tester.select_prompt(false, 0).should == "B"

            Pry.new.prompt.should == Pry.prompt
            Pry.new.select_prompt(true, 0).should == "test prompt> "
            Pry.new.select_prompt(false, 0).should == "test prompt* "
          end

          describe 'storing and restoring the prompt' do
            before do
              make = lambda do |name,i|
                prompt = [ proc { "#{i}>" } , proc { "#{i+1}>" } ]
                (class << prompt; self; end).send(:define_method, :inspect) { "<Prompt-#{name}>" }
                prompt
              end
              @a , @b , @c = make[:a,0] , make[:b,1] , make[:c,2]
              @pry = Pry.new :prompt => @a
            end
            it 'should have a prompt stack' do
              @pry.push_prompt @b
              @pry.push_prompt @c
              @pry.prompt.should == @c
              @pry.pop_prompt
              @pry.prompt.should == @b
              @pry.pop_prompt
              @pry.prompt.should == @a
            end

            it 'should restore overridden prompts when returning from file-mode' do
              pry = Pry.new :input => InputTester.new('shell-mode', 'shell-mode'),
                            :prompt => [ proc { 'P>' } ] * 2
              pry.select_prompt(true, 0).should == "P>"
              pry.re
              pry.select_prompt(true, 0).should =~ /\Apry .* \$ \z/
              pry.re
              pry.select_prompt(true, 0).should == "P>"
            end

            it '#pop_prompt should return the popped prompt' do
              @pry.push_prompt @b
              @pry.push_prompt @c
              @pry.pop_prompt.should == @c
              @pry.pop_prompt.should == @b
            end

            it 'should not pop the last prompt' do
              @pry.push_prompt @b
              @pry.pop_prompt.should == @b
              @pry.pop_prompt.should == @a
              @pry.pop_prompt.should == @a
              @pry.prompt.should == @a
            end

            describe '#prompt= should replace the current prompt with the new prompt' do
              it 'when only one prompt on the stack' do
                @pry.prompt = @b
                @pry.prompt.should == @b
                @pry.pop_prompt.should == @b
                @pry.pop_prompt.should == @b
              end
              it 'when several prompts on the stack' do
                @pry.push_prompt @b
                @pry.prompt = @c
                @pry.pop_prompt.should == @c
                @pry.pop_prompt.should == @a
              end
            end
          end
        end

        it 'should set the hooks default, and the default should be overridable' do
          Pry.input = InputTester.new("exit")
          Pry.hooks = {
            :before_session => proc { |out,_| out.puts "HELLO" },
            :after_session => proc { |out,_| out.puts "BYE" }
          }

          str_output = StringIO.new
          Pry.new(:output => str_output).repl
          str_output.string.should =~ /HELLO/
          str_output.string.should =~ /BYE/

          Pry.input.rewind

          str_output = StringIO.new
          Pry.new(:output => str_output,
                  :hooks => {
                    :before_session => proc { |out,_| out.puts "MORNING" },
                    :after_session => proc { |out,_| out.puts "EVENING" }
                  }
                  ).repl

          str_output.string.should =~ /MORNING/
          str_output.string.should =~ /EVENING/

          # try below with just defining one hook
          Pry.input.rewind
          str_output = StringIO.new
          Pry.new(:output => str_output,
                  :hooks => {
                    :before_session => proc { |out,_| out.puts "OPEN" }
                  }
                  ).repl

          str_output.string.should =~ /OPEN/

          Pry.input.rewind
          str_output = StringIO.new
          Pry.new(:output => str_output,
                  :hooks => {
                    :after_session => proc { |out,_| out.puts "CLOSE" }
                  }
                  ).repl

          str_output.string.should =~ /CLOSE/

          Pry.reset_defaults
          Pry.color = false
        end
      end
    end
  end
end