pry 0.9.8pre7 → 0.9.8pre8

data/lib/pry/plugins.rb

@@ -9,7 +9,7 @@ class Pry
       end
 
       def method_missing(*args)
-        $stderr.puts "Warning: The plugin '#{@name}' was not found! (no gem found)"
+        warn "Warning: The plugin '#{@name}' was not found! (no gem found)"
       end
     end
 
@@ -45,8 +45,8 @@ class Pry
         begin
           require gem_name if !active?
         rescue LoadError => e
-          $stderr.puts "Warning: The plugin '#{gem_name}' was not found! (gem found but could not be loaded)"
-          $stderr.puts e
+          warn "Warning: The plugin '#{gem_name}' was not found! (gem found but could not be loaded)"
+          warn e
         end
         self.active = true
         self.enabled = true

data/lib/pry/pry_class.rb

@@ -89,7 +89,7 @@ class Pry
     # note these have to be loaded here rather than in pry_instance as
     # we only want them loaded once per entire Pry lifetime.
     load_rc if Pry.config.should_load_rc
-    load_plugins if Pry.config.plugins.enabled
+    load_plugins if Pry.config.should_load_plugins
     load_requires if Pry.config.should_load_requires
     load_history if Pry.config.history.should_load
     load_traps if Pry.config.should_trap_interrupts
@@ -113,7 +113,10 @@ class Pry
     pry_instance = new(options)
 
     # save backtrace
-    pry_instance.backtrace = caller.tap(&:shift)
+    pry_instance.backtrace = caller
+
+    # if Pry was started via binding.pry, elide that from the backtrace.
+    pry_instance.backtrace.shift if pry_instance.backtrace.first =~ /pry.*core_extensions.*pry/
 
     # yield the binding_stack to the hook for modification
     pry_instance.exec_hook(
@@ -238,8 +241,7 @@ class Pry
     config.gist ||= OpenStruct.new
     config.gist.inspecter = proc(&:pretty_inspect)
 
-    config.plugins ||= OpenStruct.new
-    config.plugins.enabled = true
+    config.should_load_plugins = true
 
     config.requires ||= []
     config.should_load_requires = true

data/lib/pry/pry_instance.rb

@@ -7,7 +7,6 @@ class Pry
   attr_accessor :commands
   attr_accessor :print
   attr_accessor :exception_handler
-  attr_accessor :hooks
   attr_accessor :input_stack
 
   attr_accessor :custom_completions
@@ -25,6 +24,22 @@ class Pry
 
   attr_accessor :backtrace
 
+  # Special treatment for hooks as we want to alert people of the
+  # changed API
+  attr_reader :hooks
+
+  # FIXME:
+  # This is a hack to alert people of the new API.
+  # @param [Pry::Hooks] v Only accept `Pry::Hooks` now!
+  def hooks=(v)
+    if v.is_a?(Hash)
+      warn "Hash-based hooks are now deprecated! Use a `Pry::Hooks` object instead! http://rubydoc.info/github/pry/pry/master/Pry/Hooks"
+      @hooks = Pry::Hooks.from_hash(v)
+    else
+      @hooks = v
+    end
+  end
+
   # Create a new `Pry` object.
   # @param [Hash] options The optional configuration parameters.
   # @option options [#readline] :input The object to use for input.

data/lib/pry/version.rb

@@ -1,3 +1,3 @@
 class Pry
-  VERSION = "0.9.8pre7"
+  VERSION = "0.9.8pre8"
 end

data/test/helper.rb

@@ -8,6 +8,11 @@ puts "Ruby v#{RUBY_VERSION} (#{defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"}), P
 require 'bacon'
 require 'open4'
 
+
+# turn warnings off (esp for Pry::Hooks which will generate warnings
+# in tests)
+$VERBOSE = nil
+
 # Ensure we do not execute any rc files
 Pry::RC_FILES.clear
 
@@ -21,7 +26,7 @@ class << Pry
     Pry.color = false
     Pry.pager = false
     Pry.config.should_load_rc      = false
-    Pry.config.plugins.enabled     = false
+    Pry.config.should_load_plugins = false
     Pry.config.history.should_load = false
     Pry.config.history.should_save = false
     Pry.config.auto_indent         = false

data/test/test_command.rb

@@ -9,7 +9,7 @@ describe "Pry::Command" do
   describe 'call_safely' do
 
     it 'should display a message if gems are missing' do
-      cmd = @set.command_class "ford-prefect", "From a planet near Beetlegeuse", :requires_gem => %w(ghijkl) do
+      cmd = @set.create_command "ford-prefect", "From a planet near Beetlegeuse", :requires_gem => %w(ghijkl) do
         #
       end
 
@@ -17,7 +17,7 @@ describe "Pry::Command" do
     end
 
     it 'should abort early if arguments are required' do
-      cmd = @set.command_class 'arthur-dent', "Doesn't understand Thursdays", :argument_required => true do
+      cmd = @set.create_command 'arthur-dent', "Doesn't understand Thursdays", :argument_required => true do
         #
       end
 
@@ -27,7 +27,7 @@ describe "Pry::Command" do
     end
 
     it 'should return VOID without keep_retval' do
-      cmd = @set.command_class 'zaphod-beeblebrox', "Likes pan-Galactic Gargle Blasters" do
+      cmd = @set.create_command 'zaphod-beeblebrox', "Likes pan-Galactic Gargle Blasters" do
         def process
           3
         end
@@ -37,7 +37,7 @@ describe "Pry::Command" do
     end
 
     it 'should return the return value with keep_retval' do
-      cmd = @set.command_class 'tricia-mcmillian', "a.k.a Trillian", :keep_retval => true do
+      cmd = @set.create_command 'tricia-mcmillian', "a.k.a Trillian", :keep_retval => true do
         def process
           5
         end
@@ -47,7 +47,7 @@ describe "Pry::Command" do
     end
 
     it 'should call hooks in the right order' do
-      cmd = @set.command_class 'marvin', "Pained by the diodes in his left side" do
+      cmd = @set.create_command 'marvin', "Pained by the diodes in his left side" do
         def process
           output.puts 3 + args[0].to_i
         end
@@ -73,13 +73,13 @@ describe "Pry::Command" do
 
     # TODO: This strikes me as rather silly...
     it 'should return the value from the last hook with keep_retval' do
-      cmd = @set.command_class 'slartibartfast', "Designs Fjords", :keep_retval => true do
+      cmd = @set.create_command 'slartibartfast', "Designs Fjords", :keep_retval => true do
         def process
           22
         end
       end
 
-      @set.after_command 'slartibartfast' do 
+      @set.after_command 'slartibartfast' do
         10
       end
 
@@ -97,7 +97,7 @@ describe "Pry::Command" do
     end
 
     it 'should use slop to generate the help for classy commands' do
-      @set.command_class 'eddie', "The ship-board computer" do
+      @set.create_command 'eddie', "The ship-board computer" do
         def options(opt)
           opt.banner "Over-cheerful, and makes a ticking noise."
         end
@@ -107,7 +107,7 @@ describe "Pry::Command" do
     end
 
     it 'should provide --help for classy commands' do
-      cmd = @set.command_class 'agrajag', "Killed many times by Arthur" do
+      cmd = @set.create_command 'agrajag', "Killed many times by Arthur" do
         def options(opt)
           opt.on :r, :retaliate, "Try to get Arthur back"
         end
@@ -117,7 +117,7 @@ describe "Pry::Command" do
     end
 
     it 'should provide a -h for classy commands' do
-      cmd = @set.command_class 'zarniwoop', "On an intergalactic cruise, in his office." do
+      cmd = @set.create_command 'zarniwoop', "On an intergalactic cruise, in his office." do
         def options(opt)
           opt.on :e, :escape, "Help zaphod escape the Total Perspective Vortex"
         end
@@ -127,7 +127,7 @@ describe "Pry::Command" do
     end
 
     it 'should use the banner provided' do
-      cmd = @set.command_class 'deep-thought', "The second-best computer ever" do
+      cmd = @set.create_command 'deep-thought', "The second-best computer ever" do
         banner <<-BANNER
           Who's merest operational parameters, I am not worthy to compute.
         BANNER
@@ -148,7 +148,7 @@ describe "Pry::Command" do
     }
 
     it 'should capture lots of stuff from the hash passed to new before setup' do
-      cmd = @set.command_class 'fenchurch', "Floats slightly off the ground" do
+      cmd = @set.create_command 'fenchurch', "Floats slightly off the ground" do
         define_method(:setup) do
           self.context.should == context
           target.should == context[:target]
@@ -170,7 +170,7 @@ describe "Pry::Command" do
   describe 'classy api' do
 
     it 'should call setup, then options, then process' do
-      cmd = @set.command_class 'rooster', "Has a tasty towel" do
+      cmd = @set.create_command 'rooster', "Has a tasty towel" do
         def setup
           output.puts "setup"
         end
@@ -188,7 +188,7 @@ describe "Pry::Command" do
     end
 
     it 'should raise a command error if process is not overridden' do
-      cmd = @set.command_class 'jeltz', "Commander of a Vogon constructor fleet" do
+      cmd = @set.create_command 'jeltz', "Commander of a Vogon constructor fleet" do
         def proccces
           #
         end
@@ -200,7 +200,7 @@ describe "Pry::Command" do
     end
 
     it 'should work if neither options, nor setup is overridden' do
-      cmd = @set.command_class 'wowbagger', "Immortal, insulting.", :keep_retval => true do
+      cmd = @set.create_command 'wowbagger', "Immortal, insulting.", :keep_retval => true do
         def process
           5
         end
@@ -210,7 +210,7 @@ describe "Pry::Command" do
     end
 
     it 'should provide opts and args as provided by slop' do
-      cmd = @set.command_class 'lintilla', "One of 800,000,000 clones" do
+      cmd = @set.create_command 'lintilla', "One of 800,000,000 clones" do
          def options(opt)
            opt.on :f, :four, "A numeric four", :as => Integer, :optional => true
          end
@@ -225,7 +225,7 @@ describe "Pry::Command" do
     end
 
     it 'should allow overriding options after definition' do
-      cmd = @set.command_class /number-(one|two)/, "Lieutenants of the Golgafrinchan Captain", :shellwords => false do
+      cmd = @set.create_command /number-(one|two)/, "Lieutenants of the Golgafrinchan Captain", :shellwords => false do
 
         command_options :listing => 'number-one'
       end

data/test/test_command_set.rb

@@ -501,7 +501,7 @@ describe Pry::CommandSet do
     end
 
     it 'should return Result.new(true, VOID) if the command is not keep_retval' do
-      @set.command_class('mrs-cake') do
+      @set.create_command('mrs-cake') do
         def process; 42; end
       end
 
@@ -512,7 +512,7 @@ describe Pry::CommandSet do
     end
 
     it 'should return Result.new(true, retval) if the command is keep_retval' do
-      @set.command_class('magrat', 'the maiden', :keep_retval => true) do
+      @set.create_command('magrat', 'the maiden', :keep_retval => true) do
         def process; 42; end
       end
 
@@ -529,7 +529,7 @@ describe Pry::CommandSet do
         :output => StringIO.new,
         :target => binding
       }
-      @set.command_class('agnes') do
+      @set.create_command('agnes') do
         define_method(:process) do
           eval_string.should == ctx[:eval_string]
           output.should == ctx[:output]
@@ -543,7 +543,7 @@ describe Pry::CommandSet do
 
     it 'should add command_set to context' do
       set = @set
-      @set.command_class(/nann+y ogg+/) do
+      @set.create_command(/nann+y ogg+/) do
         define_method(:process) do
           command_set.should == set
         end

data/test/test_default_commands/test_documentation.rb

@@ -3,29 +3,41 @@ require 'helper'
 describe "Pry::DefaultCommands::Documentation" do
   describe "show-doc" do
     it 'should output a method\'s documentation' do
-      str_output = StringIO.new
-      redirect_pry_io(InputTester.new("show-doc sample_method", "exit-all"), str_output) do
+      redirect_pry_io(InputTester.new("show-doc sample_method", "exit-all"), str_output=StringIO.new) do
         pry
       end
 
       str_output.string.should =~ /sample doc/
     end
 
-    it 'should output a method\'s documentation if inside method without needing to use method name' do
-      $str_output = StringIO.new
+    it 'should output a method\'s documentation with line numbers' do
+      redirect_pry_io(InputTester.new("show-doc sample_method -l", "exit-all"), str_output=StringIO.new) do
+        pry
+      end
+
+      str_output.string.should =~ /\d: sample doc/
+    end
+
+    it 'should output a method\'s documentation with line numbers (base one)' do
+      redirect_pry_io(InputTester.new("show-doc sample_method -b", "exit-all"), str_output=StringIO.new) do
+        pry
+      end
+
+      str_output.string.should =~ /1: sample doc/
+    end
 
+    it 'should output a method\'s documentation if inside method without needing to use method name' do
       o = Object.new
 
       # sample comment
       def o.sample
-        redirect_pry_io(InputTester.new("show-doc", "exit-all"), $str_output) do
+        redirect_pry_io(InputTester.new("show-doc", "exit-all"), $out=StringIO.new) do
           binding.pry
        end
       end
       o.sample
-
-      $str_output.string.should =~ /sample comment/
-      $str_output = nil
+      $out.string.should =~ /sample comment/
+      $out = nil
     end
 
     it "should be able to find super methods" do

data/test/test_default_commands/test_input.rb

@@ -170,59 +170,93 @@ describe "Pry::DefaultCommands::Input" do
       str_output.string.should.not =~ /goodbye/
     end
 
+    it 'should play documentation with the -d switch' do
+      o = Object.new
+
+      # @v = 10
+      # @y = 20
+      def o.test_method
+        :test_method_content
+      end
+
+      redirect_pry_io(InputTester.new('play -d test_method', "exit-all"), str_output = StringIO.new) do
+        o.pry
+      end
+
+      o.instance_variable_get(:@v).should == 10
+      o.instance_variable_get(:@y).should == 20
+    end
+
+    it 'should play documentation with the -d switch (restricted by --lines)' do
+      o = Object.new
+
+      # @x = 0
+      # @v = 10
+      # @y = 20
+      # @z = 30
+      def o.test_method
+        :test_method_content
+      end
+
+      redirect_pry_io(InputTester.new('play -d test_method --lines 2..3', "exit-all"), str_output = StringIO.new) do
+        o.pry
+      end
+
+      o.instance_variable_get(:@x).should == nil
+      o.instance_variable_get(:@z).should == nil
+      o.instance_variable_get(:@v).should == 10
+      o.instance_variable_get(:@y).should == 20
+    end
+
+
     it 'should play a method with the -m switch (a single line)' do
-      $o = Object.new
-      def $o.test_method
+      o = Object.new
+      def o.test_method
         :test_method_content
       end
 
-      redirect_pry_io(InputTester.new('play -m $o.test_method --lines 2', "exit-all"), str_output = StringIO.new) do
-        pry
+      redirect_pry_io(InputTester.new('play -m test_method --lines 2', "exit-all"), str_output = StringIO.new) do
+        o.pry
       end
 
       str_output.string.should =~ /:test_method_content/
-      $o = nil
     end
 
     it 'should APPEND to the input buffer when playing a line with play -m, not replace it' do
-      $o = Object.new
-      def $o.test_method
+      o = Object.new
+      def o.test_method
         :test_method_content
       end
 
-      redirect_pry_io(InputTester.new('def another_test_method', 'play -m $o.test_method --lines 2', 'show-input', 'exit-all'), str_output = StringIO.new) do
-        pry
+      redirect_pry_io(InputTester.new('def another_test_method', 'play -m test_method --lines 2', 'show-input', 'exit-all'), str_output = StringIO.new) do
+        o.pry
       end
       str_output.string.should =~ /def another_test_method/
       str_output.string.should =~ /:test_method_content/
-      $o = nil
     end
 
 
     it 'should play a method with the -m switch (multiple line)' do
-      $o = Object.new
-      class << $o
-        attr_accessor :var1, :var2
-      end
+      o = Object.new
 
-      def $o.test_method
+      def o.test_method
+        @var0 = 10
         @var1 = 20
         @var2 = 30
+        @var3 = 40
       end
 
-      obj = Object.new
-      b = Pry.binding_for(obj)
-
-      redirect_pry_io(InputTester.new('play -m $o.test_method --lines 2..3', "exit-all"), str_output = StringIO.new) do
-        b.pry
+      redirect_pry_io(InputTester.new('play -m test_method --lines 3..4', "exit-all"), str_output = StringIO.new) do
+        o.pry
       end
 
-      obj.instance_variable_get(:@var1).should == 20
-      obj.instance_variable_get(:@var2).should == 30
+      o.instance_variable_get(:@var0).should == nil
+      o.instance_variable_get(:@var1).should == 20
+      o.instance_variable_get(:@var2).should == 30
+      o.instance_variable_get(:@var3).should == nil
       str_output.string.should =~ /30/
       str_output.string.should.not =~ /20/
     end
-
   end
 
   describe "hist" do
@@ -242,24 +276,29 @@ describe "Pry::DefaultCommands::Input" do
     end
 
     it 'should replay history correctly (single item)' do
-      @hist.push ":blah"
-      @hist.push ":bucket"
-      @hist.push ":ostrich"
+      o = Object.new
+      @hist.push "@x = 10"
+      @hist.push "@y = 20"
+      @hist.push "@z = 30"
       str_output = StringIO.new
       redirect_pry_io(InputTester.new("hist --replay -1", "exit-all"), str_output) do
-        pry
+        o.pry
       end
-      str_output.string.should =~ /ostrich/
+      o.instance_variable_get(:@x).should == nil
+      o.instance_variable_get(:@y).should == nil
+      o.instance_variable_get(:@z).should == 30
     end
 
     it 'should replay a range of history correctly (range of items)' do
-      @hist.push ":hello"
-      @hist.push ":carl"
+      o = Object.new
+      @hist.push "@x = 10"
+      @hist.push "@y = 20"
       str_output = StringIO.new
       redirect_pry_io(InputTester.new("hist --replay 0..2", "exit-all"), str_output) do
-        pry
+        o.pry
       end
-      str_output.string.should =~ /:hello\n.*:carl/
+      o.instance_variable_get(:@x).should == 10
+      o.instance_variable_get(:@y).should == 20
     end
 
     it 'should grep for correct lines in history' do