pry 0.9.0pre3 → 0.9.0

data/CHANGELOG

@@ -1,3 +1,22 @@
+17/6/2011 version 0.9.0
+* plugin system
+* regex commands
+* show-method works on methods defined in REPL
+* new command system/API
+* rubinius core support
+* inp/out special locals
+* _ex_ backtrace navigation object (_ex_.line, _ex_.file)
+* readline history saving/loading
+* prompt stack
+* more hooks
+* amend-line
+* play
+* show-input
+* edit
+* much more comprehensive test suite
+* support for new and old rubygems API
+* changed -s behaviour of ls (now excludes Object methods)
+
 26/3/2011 version 0.7.6.1
 * added slightly better support for YARD
 * now @param and @return tags are colored green and markdown `code` is syntax highlighted using coderay
@@ -24,11 +43,11 @@
 * --color mode for pry commandline
 * clean up requires (put them all in one place)
 * simple-prompt command and toggle-color commandd.
-	
+
 28/2/2011 version 0.6.3
 * Using MethodSource 0.3.4 so 1.8 show-method support provided
 * `Set` class added to list of classes that are inspected
-	
+
 26/2/2011 version 0.6.1
 * !@ command alias for exit_all
 * `cd /` for breaking out to pry top level (jump-to 0)
@@ -40,11 +59,11 @@
 22/2/2011 version 0.5.8
 * Added -c (context) option to show-doc, show-methods and eval-file
 * Fixed up ordering issue of -c and -r parameters to command line pry
-	
+
 21/2/2011 version 0.5.7
 * Added pry executable, auto-loads .pryrc in user's home directory, if it
 	exists.
-	
+
 19/2/2011 version 0.5.5
 * Added Pry.run_command
 * More useful error messages
@@ -65,7 +84,7 @@
 * Get rid of ls_method and ls_imethods (subsumed by more powerful ls)
 * Get rid of show_idoc and show_imethod
 * Add special eval-file command that evals target file in current context
-	
+
 27/1/2011 version 0.4.5
 * fixed show_method (though fragile as it references __binding_impl__
 	directly, making a name change to that method difficult
@@ -99,4 +118,4 @@
 * now rescuing SyntaxError as well as Racc::Parser error in valid_expression?
 8/12/2010 version 0.1.0
 * release!
-	
+

data/README.markdown

@@ -4,6 +4,15 @@
 
 _Get to the code_
 
+## These docs are now out of date for the 0.9.0 release.
+
+** New documentation will be available shortly, please see the CHANGELOG and Pry's own livehelp system for information in the meantime.
+
+Also note that JRuby is not yet supported in this release, but will be soon.
+
+Thanks **
+
+
 Pry is a powerful alternative to the standard IRB shell for Ruby. It is
 written from scratch to provide a number of advanced features, some of
 these include:
@@ -549,8 +558,6 @@ Problems or questions contact me at [github](http://github.com/banister)
 The Pry team consists of:
 
 * [banisterfiend](http://github.com/banister)
-* [epitron](http://github.com/epitron)
 * [injekt](http://github.com/injekt)
 * [Mon_Ouie](http://github.com/mon-ouie)
-
-
+* [Rob Gleeson](https://github.com/robgleeson)

data/Rakefile

@@ -22,12 +22,13 @@ def apply_spec_defaults(s)
   s.test_files = `git ls-files -- test/*`.split("\n")
   s.add_dependency("ruby_parser",">=2.0.5")
   s.add_dependency("coderay",">=0.9.8")
-  s.add_dependency("slop","~>1.6.0")
-  s.add_dependency("method_source",">=0.4.0")
+  s.add_dependency("slop","~>1.9.0")
+  s.add_dependency("method_source",">=0.6.0")
   s.add_development_dependency("bacon",">=1.1.0")
   s.add_development_dependency("open4", "~>1.0.1")
 end
 
+desc "Run tests"
 task :test do
   sh "bacon -Itest -rubygems -a"
 end
@@ -52,10 +53,10 @@ namespace :ruby do
     pkg.need_zip = false
     pkg.need_tar = false
   end
-  
+
   desc  "Generate gemspec file"
   task :gemspec do
-    File.open("#{spec.name}-#{spec.version}.gemspec", "w") do |f|
+    File.open("#{spec.name}.gemspec", "w") do |f|
       f << spec.to_ruby
     end
   end
@@ -76,20 +77,8 @@ end
   end
 end
 
-namespace :jruby do
-  spec = Gem::Specification.new do |s|
-    apply_spec_defaults(s)
-    s.platform = "java"
-  end
-
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = false
-    pkg.need_tar = false
-  end
-end
-
 desc "build all platform gems at once"
-task :gems => [:clean, :rmgems, "ruby:gem", "jruby:gem", "mswin32:gem", "mingw32:gem"]
+task :gems => [:clean, :rmgems, "ruby:gem", "mswin32:gem", "mingw32:gem"]
 
 desc "remove all platform gems"
 task :rmgems => ["ruby:clobber_package"]

data/bin/pry

@@ -39,6 +39,8 @@ See: `https://github.com/banister` for more information.
     Pry.config.plugins.enabled = false
   end
 
+  on "installed-plugins", "List installed plugins."
+
   on "simple-prompt", "Enable simple prompt mode" do
     Pry.prompt = Pry::SIMPLE_PROMPT
   end
@@ -63,6 +65,15 @@ See: `https://github.com/banister` for more information.
     )
 end
 
+if opts["installed-plugins"]
+  puts "Installed Plugins:"
+  puts "--"
+  Pry.locate_plugins.each do |plugin|
+    puts "#{plugin.name}".ljust(18) + plugin.spec.summary
+  end
+  exit
+end
+
 # invoked via cli
 Pry.cli = true
 

data/lib/pry.rb

@@ -2,7 +2,7 @@
 # MIT License
 
 require 'pp'
-
+require 'pry/helpers/base_helpers'
 class Pry
   # The default hooks - display messages when beginning and ending Pry sessions.
   DEFAULT_HOOKS = {
@@ -20,11 +20,7 @@ class Pry
 
   # The default prints
   DEFAULT_PRINT = proc do |output, value|
-    if Pry.color
-      output.puts "=> #{CodeRay.scan(value.pretty_inspect, :ruby).term}"
-    else
-      output.puts "=> #{Pry.view(value)}"
-    end
+    Helpers::BaseHelpers.stagger_output("=> #{Helpers::BaseHelpers.colorize_code(value.pretty_inspect)}", output)
   end
 
   # Will only show the first line of the backtrace
@@ -53,7 +49,7 @@ class Pry
   ]
 
   # A simple prompt - doesn't display target or nesting level
-  SIMPLE_PROMPT = [proc { ">> " }, proc { ">* " }]
+  SIMPLE_PROMPT = [proc { ">> " }, proc { "  | " }]
 
   SHELL_PROMPT = [
     proc { |target_self, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} $ " },

data/lib/pry/command_processor.rb

@@ -14,9 +14,11 @@ class Pry
 
     # Is the string a valid command?
     # @param [String] val The string passed in from the Pry prompt.
+    # @param [Binding] target The context where the string should be
+    #   interpolated in.
     # @return [Boolean] Whether the string is a valid command.
-    def valid_command?(val)
-      !!(command_matched(val, binding)[0])
+    def valid_command?(val, target=binding)
+      !!(command_matched(val, target)[0])
     end
 
     # Convert the object to a form that can be interpolated into a
@@ -34,7 +36,7 @@ class Pry
     # Revaluate the string (str) and perform interpolation.
     # @param [String] str The string to reevaluate with interpolation.
     # @param [Binding] target The context where the string should be
-    #   reevaluated in.
+    #   interpolated in.
     # @return [String] The reevaluated string with interpolations
     #   applied (if any).
     def interpolate_string(str, target)
@@ -53,11 +55,18 @@ class Pry
     def command_matched(val, target)
       _, cmd_data = commands.commands.find do |name, data|
 
-        interp_val = interpolate_string(val, target)
         command_regex = /^#{convert_to_regex(name)}(?!\S)/
 
-        if data.options[:interpolate] && (command_regex =~ interp_val)
-          val.replace interp_val
+        if data.options[:interpolate]
+          # If interpolation fails then the command cannot be matched,
+          # so early exit.
+          begin
+            interp_val = interpolate_string(val, target)
+          rescue NameError
+            next
+          end
+
+          val.replace interp_val if command_regex =~ interp_val
         else
           command_regex =~ val
         end
@@ -80,7 +89,10 @@ class Pry
       # no command was matched, so return to caller
       command, captures, pos = command_matched(val, target)
       return if !command
-      arg_string = val[pos..-1].strip
+      arg_string = val[pos..-1]
+
+      # remove the one leading space if it exists
+      arg_string.slice!(0) if arg_string.start_with?(" ")
 
       args = arg_string ? Shellwords.shellwords(arg_string) : []
 

data/lib/pry/commands.rb

@@ -22,8 +22,5 @@ class Pry
     import DefaultCommands::Shell
     import DefaultCommands::Introspection
     import DefaultCommands::EasterEggs
-
-#    Helpers::CommandHelpers.try_to_load_pry_doc
-
   end
 end

data/lib/pry/config.rb

@@ -75,9 +75,9 @@ class Pry
     # sub-options include hist.file, hist.load, and hist.save
     # hist.file is the file to save/load history too, e.g
     # Pry.config.history.file = "~/.pry_history".
-    # hist.load is a boolean that determines whether history will be
+    # hist.should_load is a boolean that determines whether history will be
     # loaded from hist.file at session start.
-    # hist.save is a boolean that determines whether history will be
+    # hist.should_save is a boolean that determines whether history will be
     # saved to hist.file at session end.
     # @return [OpenStruct]
     attr_accessor :history
@@ -89,8 +89,12 @@ class Pry
     # @return [OpenStruct]
     attr_accessor :plugins
 
-    # @return [Integer] Amount of results that will be stored into _out_
+    # @return [Integer] Amount of results that will be stored into out
     attr_accessor :memory_size
+
+    # @return [Boolean] Whether or not evalation results (`=>`) are sent
+    # through a pager.
+    attr_accessor :result_pager
   end
 end
 

data/lib/pry/default_commands/context.rb

@@ -67,6 +67,7 @@ class Pry
       alias_command "!!@", "exit-all", ""
 
       command "exit-program", "End the current program. Aliases: quit-program, !!!" do
+        Pry.active_instance.save_history if Pry.config.history.should_save
         exit
       end
 

data/lib/pry/default_commands/documentation.rb

@@ -40,13 +40,16 @@ class Pry
         next output.puts("No documentation found.") if doc.empty?
         doc = process_comment_markup(doc, code_type)
         output.puts make_header(meth, code_type, doc)
+        if meth.respond_to?(:parameters)
+          output.puts "#{text.bold("signature")}: #{signature_for(meth)}"
+          output.puts
+        end
         render_output(opts.flood?, false, doc)
         doc
       end
 
       alias_command "?", "show-doc", ""
 
-
       command "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info." do |*args|
         target = target()
 
@@ -73,23 +76,21 @@ class Pry
           next
         end
 
-        code, code_type = code_and_code_type_for(meth)
-        next if !code
-        doc, code_type = doc_and_code_type_for(meth)
+        if !is_a_c_method?(meth) && !is_a_dynamically_defined_method?(meth)
+          set_file_and_dir_locals(path_line_for(meth).first)
+        end
 
-        output.puts make_header(meth, code_type, code)
-        output.puts text.bold("Method Name: ") + meth_name
-        output.puts text.bold("Method Owner: ") + (meth.owner.to_s ? meth.owner.to_s : "Unknown")
-        output.puts text.bold("Method Language: ") + code_type.to_s.capitalize
-        output.puts text.bold("Method Type: ") + (meth.is_a?(Method) ? "Bound" : "Unbound")
-        output.puts text.bold("Method Arity: ") + meth.arity.to_s
+        output.puts "Method Information:"
+        output.puts "--"
+        output.puts "Name: " + meth_name
+        output.puts "Owner: " + (meth.owner.to_s ? meth.owner.to_s : "Unknown")
+        output.puts "Type: " + (meth.is_a?(Method) ? "Bound" : "Unbound")
+        output.puts "Arity: " + meth.arity.to_s
 
-        name_map = { :req => "Required:", :opt => "Optional:", :rest => "Rest:" }
         if meth.respond_to?(:parameters)
-          output.puts text.bold("Method Parameters: ") + meth.parameters.group_by(&:first).
-            map { |k, v| "#{name_map[k]} #{v.map { |kk, vv| vv ? vv.to_s : "noname" }.join(", ")}" }.join(". ")
+          output.puts "Method Signature: " + signature_for(meth)
         end
-        output.puts text.bold("Comment length: ") + (doc.empty? ? 'No comment.' : (doc.lines.count.to_s + ' lines.'))
+
       end
 
       command "gist-method", "Gist a method to github. Type `gist-method --help` for more info.", :requires_gem => "gist" do |*args|
@@ -140,6 +141,23 @@ class Pry
         output.puts "Gist created at #{link}"
       end
 
+      helpers do
+        def signature_for(meth)
+          param_strings = []
+          meth.parameters.each do |kind, name|
+            case kind
+            when :req
+              param_strings << name
+            when :opt
+              param_strings << "#{name}=?"
+            when :rest
+              param_strings << "*#{name}"
+            end
+          end
+          "#{meth.name}(#{param_strings.join(", ")})"
+        end
+      end
+
     end
 
   end

data/lib/pry/default_commands/input.rb

@@ -8,28 +8,101 @@ class Pry
         eval_string.replace("")
       end
 
-      command "show-input", "Show the current eval_string" do
-        render_output(false, 0, Pry.color ? CodeRay.scan(eval_string, :ruby).term : eval_string)
+      command "show-input", "Show the contents of the input buffer for the current multi-line expression." do
+        render_output(false, 1, Pry.color ? CodeRay.scan(eval_string, :ruby).term : eval_string)
       end
 
-      command(/amend-line-?(\d+)?/, "Experimental amend-line, where the N in amend-line-N represents line to replace. Aliases: %N",
-      :interpolate => false, :listing => "amend-line-N")  do |line_number, replacement_line|
+      command(/amend-line.?(-?\d+)?(?:\.\.(-?\d+))?/, "Amend a line of input in multi-line mode. Type `amend-line --help` for more information. Aliases %",
+              :interpolate => false, :listing => "amend-line")  do |*args|
+        start_line_number, end_line_number, replacement_line = *args
+
+        opts = Slop.parse!(args.compact) do |opt|
+          opt.banner %{Amend a line of input in multi-line mode. `amend-line N`, where the N in `amend-line N` represents line to replace.
+
+Can also specify a range of lines using `amend-line N..M` syntax. Passing '!' as replacement content deletes the line(s) instead. Aliases: %N
+e.g amend-line 1 puts 'hello world! # replace line 1'
+e.g amend-line 1..4 !               # delete lines 1..4
+e.g amend-line 3 >puts 'goodbye'    # insert before line 3
+e.g amend-line puts 'hello again'   # no line number modifies immediately preceding line
+}
+          opt.on :h, :help, "This message." do
+            output.puts opt
+          end
+        end
+
+        next if opts.h?
+        next output.puts "No input to amend." if eval_string.empty?
+
         replacement_line = "" if !replacement_line
         input_array = eval_string.each_line.to_a
-        line_num = line_number ? line_number.to_i : input_array.size - 1
-        input_array[line_num] = arg_string + "\n"
+
+        end_line_number = start_line_number.to_i if !end_line_number
+        line_range = start_line_number ? (one_index_number(start_line_number.to_i)..one_index_number(end_line_number.to_i))  : input_array.size - 1
+
+        # delete selected lines if replacement line is '!'
+        if arg_string == "!"
+          input_array.slice!(line_range)
+        elsif arg_string.start_with?(">")
+          insert_slot = Array(line_range).first
+          input_array.insert(insert_slot, arg_string[1..-1] + "\n")
+        else
+          input_array[line_range] = arg_string + "\n"
+        end
         eval_string.replace input_array.join
+        run "show-input"
       end
 
-      alias_command(/%(\d+)?/, /amend-line-?(\d+)?/, "")
+      alias_command(/%.?(-?\d+)?(?:\.\.(-?\d+))?/, /amend-line.?(-?\d+)?(?:\.\.(-?\d+))?/, "")
+
+      command "play", "Play back a string or a method or a file as input. Type `play --help` for more information." do |*args|
+        opts = Slop.parse!(args) do |opt|
+          opt.banner "Usage: play [OPTIONS] [--help]\nDefault action (no options) is to play the provided string\ne.g `play puts 'hello world'` #=> \"hello world\"\ne.g `play -m Pry#repl --lines 1..-1`\ne.g `play -f Rakefile --lines 5`\n"
+
+          opt.on :l, :lines, 'The line (or range of lines) to replay.', true, :as => Range
+          opt.on :m, :method, 'Play a method.', true
+          opt.on :f, "file", 'The line (or range of lines) to replay.', true
+          opt.on :o, "open", 'When used with the -m switch, it plays the entire method except the last line, leaving the method definition "open". `amend-line` can then be used to modify the method.'
+          opt.on :h, :help, "This message." do
+            output.puts opt
+          end
+
+          opt.on_noopts { Pry.active_instance.input = StringIO.new(arg_string)  }
+        end
+
+        if opts.m?
+          meth_name = opts[:m]
+          if (meth = get_method_object(meth_name, target, {})).nil?
+            output.puts "Invalid method name: #{meth_name}."
+            next
+          end
+          code, code_type = code_and_code_type_for(meth)
+          next if !code
+
+          range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
+          range = (0..-2) if opts.o?
+
+          Pry.active_instance.input = StringIO.new(Array(code.each_line.to_a[range]).join)
+        end
+
+        if opts.f?
+          file_name = File.expand_path(opts[:f])
+          next output.puts "No such file: #{opts[:f]}" if !File.exists?(file_name)
+          text_array = File.readlines(file_name)
+          range = opts.l? ? one_index_range_or_number(opts[:l]) : (0..-1)
+          range = (0..-2) if opts.o?
+
+          Pry.active_instance.input = StringIO.new(Array(text_array[range]).join)
+        end
+      end
 
       command "hist", "Show and replay Readline history. Type `hist --help` for more info." do |*args|
-        Slop.parse(args) do |opt|
-          history = Readline::HISTORY.to_a
-          opt.banner "Usage: hist [--replay START..END] [--clear] [--grep PATTERN] [--head N] [--tail N] [--help]\n"
+        history = Readline::HISTORY.to_a
+
+        opts = Slop.parse!(args) do |opt|
+          opt.banner "Usage: hist [--replay START..END] [--clear] [--grep PATTERN] [--head N] [--tail N] [--help] [--save [START..END] file.txt]\n"
 
           opt.on :g, :grep, 'A pattern to match against the history.', true do |pattern|
-            pattern = Regexp.new arg_string.split(/ /)[1]
+            pattern = Regexp.new arg_string.strip.split(/ /, 2).last.strip
             history.pop
 
             history.map!.with_index do |element, index|
@@ -41,64 +114,67 @@ class Pry
             stagger_output history.compact.join "\n"
           end
 
-          opt.on :head, 'Display the first N items of history', :optional => true, :as => Integer do |limit|
-            unless opt.grep?
-              limit ||= 10
-              list  = history.first limit
-              lines = text.with_line_numbers list.join("\n"), 0
-              stagger_output lines
-            end
+          opt.on :head, 'Display the first N items of history',
+                 :optional => true,
+                 :as       => Integer,
+                 :unless   => :grep do |limit|
+
+            limit ||= 10
+            list  = history.first limit
+            lines = text.with_line_numbers list.join("\n"), 0
+            stagger_output lines
           end
 
-          opt.on :t, :tail, 'Display the last N items of history', :optional => true, :as => Integer do |limit|
-            unless opt.grep?
-              limit ||= 10
-              offset = history.size-limit
-              offset = offset < 0 ? 0 : offset
+          opt.on :t, :tail, 'Display the last N items of history',
+                     :optional => true,
+                     :as       => Integer,
+                     :unless   => :grep do |limit|
 
-              list  = history.last limit
-              lines = text.with_line_numbers list.join("\n"), offset
-              stagger_output lines
-            end
+            limit ||= 10
+            offset = history.size-limit
+            offset = offset < 0 ? 0 : offset
+
+            list  = history.last limit
+            lines = text.with_line_numbers list.join("\n"), offset
+            stagger_output lines
           end
 
-          opt.on :s, :show, 'Show the history corresponding to the history line (or range of lines).', true, :as => Range do |range|
-            unless opt.grep?
-              start_line = range.is_a?(Range) ? range.first : range
-              lines = text.with_line_numbers Array(history[range]).join("\n"), start_line
-              stagger_output lines
-            end
+          opt.on :s, :show, 'Show the history corresponding to the history line (or range of lines).',
+                 true,
+                 :as     => Range,
+                 :unless => :grep do |range|
+
+            start_line = range.is_a?(Range) ? range.first : range
+            lines = text.with_line_numbers Array(history[range]).join("\n"), start_line
+            stagger_output lines
           end
 
-          opt.on :e, :exclude, 'Exclude pry commands from the history.' do
-            unless opt.grep?
-              history.map!.with_index do |element, index|
-                unless command_processor.valid_command? element
-                  "#{text.blue index}: #{element}"
-                end
+          opt.on :e, :exclude, 'Exclude pry commands from the history.', :unless => :grep do
+            history.map!.with_index do |element, index|
+              unless command_processor.valid_command? element
+                "#{text.blue index}: #{element}"
               end
-              stagger_output history.compact.join "\n"
             end
+            stagger_output history.compact.join "\n"
           end
 
-          opt.on :r, :replay, 'The line (or range of lines) to replay.', true, :as => Range do |range|
-            unless opt.grep?
-              actions = Array(history[range]).join("\n") + "\n"
-              Pry.active_instance.input = StringIO.new(actions)
-            end
+          opt.on :r, :replay, 'The line (or range of lines) to replay.',
+                 true,
+                 :as     => Range,
+                 :unless => :grep do |range|
+            actions = Array(history[range]).join("\n") + "\n"
+            Pry.active_instance.input = StringIO.new(actions)
           end
 
-          opt.on :c, :clear, 'Clear the history' do
-            unless opt.grep?
-              Readline::HISTORY.shift until Readline::HISTORY.empty?
-              output.puts 'History cleared.'
-            end
+          opt.on "save", "Save history to a file. --save [start..end] output.txt. Pry commands are excluded from saved history.", true, :as => Range
+
+          opt.on :c, :clear, 'Clear the history', :unless => :grep do
+            Readline::HISTORY.shift until Readline::HISTORY.empty?
+            output.puts 'History cleared.'
           end
 
-          opt.on :h, :help, 'Show this message.', :tail => true do
-            unless opt.grep?
-              output.puts opt.help
-            end
+          opt.on :h, :help, 'Show this message.', :tail => true, :unless => :grep do
+            output.puts opt.help
           end
 
           opt.on_empty do
@@ -106,6 +182,62 @@ class Pry
             stagger_output lines
           end
         end
+
+        # FIXME: hack to save history (this must be refactored)
+        if opts["save"]
+          file_name = nil
+          hist_array = nil
+
+          case opts["save"]
+          when Range
+            hist_array = Array(history[opts["save"]])
+            next output.puts "Must provide a file name." if !args.first
+            file_name = File.expand_path(args.first)
+          when String
+            hist_array = history
+            file_name =  File.expand_path(opts["save"])
+          end
+
+          output.puts "Saving history in #{file_name} ..."
+          # exclude pry commands
+          hist_array.reject! do |element|
+            command_processor.valid_command?(element)
+          end
+
+          File.open(file_name, 'w') do |f|
+            f.write hist_array.join("\n")
+          end
+
+          output.puts "... history saved."
+        end
+
+      end
+
+
+      helpers do
+        def one_index_number(line_number)
+          if line_number > 0
+            line_number - 1
+          elsif line_number < 0
+            line_number
+          else
+            line_number
+          end
+        end
+
+        def one_index_range(range)
+          Range.new(one_index_number(range.begin), one_index_number(range.end))
+        end
+
+        def one_index_range_or_number(range_or_number)
+          case range_or_number
+          when Range
+            one_index_range(range_or_number)
+          else
+            one_index_number(range_or_number)
+          end
+        end
+
       end
 
     end