pry 0.9.8.2 → 0.9.8.3

data/CHANGELOG

@@ -1,3 +1,11 @@
+2/3/2012 version 0.9.8.3 minor update
+* various tweaks to improve rbx support
+* commands now support optional block arguments
+* much improved help command
+* updated method_source dependency
+* added wtf command
+* jruby should now work in windows (though without color)
+
 9/2/2012 version 0.9.8.2 bugfix
 * fixed bugs related to --super
 * upgraded slop dependency

data/README.markdown

@@ -1,4 +1,9 @@
 [![Build Status](https://secure.travis-ci.org/pry/pry.png)](http://travis-ci.org/pry/pry)
+
+**RBX (Rubinius) users**
+
+Please report bugs that you find because we are working very hard right now to make Pry more RBX friendly and it would be great to hear of your problems with Pry in RBX.  File a ticket if you run into problems with Pry on RBX so we can try to fix it for our next major release.
+
 <center>
 ![Alt text](http://dl.dropbox.com/u/26521875/pry_logo_350.png)
 
@@ -32,10 +37,12 @@ these include:
 * Gist integration
 * Navigation around state (`cd`, `ls` and friends)
 * Runtime invocation (use Pry as a developer console or debugger)
-* Exotic object support (BasicObject instances, IClasses, ...)
-* A Powerful and flexible command system
-* Ability to view and replay history
+* Exotic object support (BasicObject ins
+* tances, IClasses, ...)
+* A Powerful and flexible command system* Ability to view and replay history
+
 * Many convenience commands inspired by IPython, Smalltalk and other advanced REPLs
+* A wide-range number of [plugins](https://github.com/pry/pry/wiki/Available-plugins) that provide remote sessions, full debugging functionality, and more.
 
 Pry also aims to be more than an IRB replacement; it is an
 attempt to bring REPL driven programming to the Ruby language. It is
@@ -79,7 +86,7 @@ Pry command will show a list of all private instance methods (in
 scope) that begin with 'pa'
 
     pry(YARD::Parser::SourceParser):5> ls -Mp --grep ^pa
-    [:parser_class, :parser_type=, :parser_type_for_filename]
+    YARD::Parser::SourceParser#methods: parse  parser_class  parser_type  parser_type=  parser_type_for_filename
 
 ### Navigating around state
 
@@ -97,7 +104,7 @@ an instance variable inside that class:
     => 20
     pry(main)> cd Hello
     pry(Hello):1> ls -i
-    => [:@x]
+    instance variables: @x
     pry(Hello):1> cd @x
     pry(20:2)> self + 10
     => 30
@@ -121,8 +128,6 @@ We can then jump back to any of the previous nesting levels by using
 the `jump-to` command:
 
     pry("friend":3)> jump-to 1
-    Ending Pry session for "friend"
-    Ending Pry session for 100
     => 100
     pry(Hello):1>
 
@@ -223,8 +228,8 @@ In the following example we will enter the `Pry` class, list the
 instance methods beginning with 're' and display the source code for the `rep` method:
 
     pry(main)> cd Pry
-    pry(Pry):1> ls -M --grep ^re
-    [:re, :readline, :rep, :repl, :repl_epilogue, :repl_prologue, :retrieve_line]
+    pry(Pry)> ls -M --grep re
+    Pry#methods: re  readline  refresh  rep  repl  repl_epilogue  repl_prologue  retrieve_line
     pry(Pry):1> show-method rep -l
 
     From: /home/john/ruby/projects/pry/lib/pry/pry_instance.rb @ line 143:
@@ -319,12 +324,12 @@ We can also use `ri` in the normal way:
 ### Gist integration
 
 If the `gist` gem is installed then method source or documentation can be gisted to github with the
-`gist-method` command. The `gist-method` command accepts the same two
-syntaxes as `show-method`. In the example below we will gist the C source
+`gist` command.  The `gist` command is capable of gisting [almost any REPL content](https://gist.github.com/cae143e4533416529726), including methods, documentation,
+input expressions, command source, and so on. In the example below we will gist the C source
 code for the `Symbol#to_proc` method to github:
 
-    pry(main)> gist-method Symbol#to_proc
-    https://gist.github.com/5332c38afc46d902ce46
+    pry(main)> gist -m Symbol#to_proc
+    Gist created at https://gist.github.com/5332c38afc46d902ce46 and added to clipboard.
     pry(main)>
 
 You can see the actual gist generated here: [https://gist.github.com/5332c38afc46d902ce46](https://gist.github.com/5332c38afc46d902ce46)
@@ -363,6 +368,8 @@ avaiable.
 
 MyArtChannel has kindly provided a hack to replace the `rails console` command in Rails 3: [https://gist.github.com/941174](https://gist.github.com/941174) This is not recommended for code bases with multiple developers, as they may not all want to use Pry.
 
+Also check out the [wiki](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry) for other strategies on integrating Pry with rails, notably the [pry-rails](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry#wiki-pry_rails) plugin.
+
 ### Limitations:
 
 * Tab completion is currently a bit broken/limited this will have a

data/Rakefile

@@ -21,7 +21,7 @@ def apply_spec_defaults(s)
   s.test_files = `git ls-files -- test/*`.split("\n")
   s.add_dependency('coderay', '~> 1.0.5')
   s.add_dependency('slop', ['>= 2.4.4', '< 3'])
-  s.add_dependency('method_source','~> 0.7')
+  s.add_dependency('method_source','~> 0.7.1')
   s.add_development_dependency('bacon', '~> 1.1')
   s.add_development_dependency('open4', '~> 1.3')
   s.add_development_dependency('rake', '~> 0.9')

data/lib/pry.rb

@@ -179,8 +179,7 @@ if Pry::Helpers::BaseHelpers.windows?
   begin
     require 'win32console'
   rescue LoadError
-    warn "Need to `gem install win32console`"
-    exit 1
+    warn "You should: `gem install win32console` for better auto-indent and color support."
   end
 end
 

data/lib/pry/command.rb

@@ -83,6 +83,30 @@ class Pry
         command_regex =~ val
       end
 
+      # How well does this command match the given line?
+      #
+      # Higher scores are better because they imply that this command matches
+      # the line more closely.
+      #
+      # The score is calculated by taking the number of characters at the start
+      # of the string that are used only to identify the command, not as part of
+      # the arguments.
+      #
+      # @example
+      #   /\.(.*)/.match_score(".foo") #=> 1
+      #   /\.*(.*)/.match_score("...foo") #=> 3
+      #   'hi'.match_score("hi there") #=> 2
+      #
+      # @param String  a line input at the REPL
+      # @return Fixnum
+      def match_score(val)
+        if command_regex =~ val
+          Regexp.last_match.size > 1 ? Regexp.last_match.begin(1) : Regexp.last_match.end(0)
+        else
+          -1
+        end
+      end
+
       # Store hooks to be run before or after the command body.
       # @see {Pry::CommandSet#before_command}
       # @see {Pry::CommandSet#after_command}
@@ -105,8 +129,27 @@ class Pry
           obj
         end
       end
-    end
 
+      # The group in which the command should be displayed in "help" output.
+      # This is usually auto-generated from directory naming, but it can be
+      # manually overridden if necessary.
+      def group(name=nil)
+        @group = name if name
+        @group ||=(
+          case Pry::Method(block).source_file
+          when %r{/pry/.*_commands/(.*).rb}
+            $1.capitalize.gsub(/_/, " ")
+          when %r{(pry-[\w_]+)-([\d\.]+)}
+            name, version = $1, $2
+            "#{name.to_s} (v#{version.to_s})"
+          when /pryrc/
+            "~/.pryrc"
+          else
+            "(other)"
+          end
+        )
+      end
+    end
 
     # Properties of one execution of a command (passed by {Pry#run_command} as a hash of
     # context and expanded in {#initialize}
@@ -119,6 +162,14 @@ class Pry
     attr_accessor :command_set
     attr_accessor :_pry_
 
+    # The block we pass *into* a command so long as `:takes_block` is
+    # not equal to `false`
+    # @example
+    #   my-command | do
+    #     puts "block content"
+    #   end
+    attr_accessor :command_block
+
     # Run a command from another command.
     # @param [String] command_string The string that invokes the command
     # @param [Array] args Further arguments to pass to the command
@@ -217,6 +268,9 @@ class Pry
       # remove the one leading space if it exists
       arg_string.slice!(0) if arg_string.start_with?(" ")
 
+      # process and pass a block if one is found
+      pass_block(arg_string) if command_options[:takes_block]
+
       if arg_string
         args = command_options[:shellwords] ? Shellwords.shellwords(arg_string) : arg_string.split(" ")
       else
@@ -241,6 +295,36 @@ class Pry
       call_safely(*(captures + args))
     end
 
+    # Pass a block argument to a command.
+    # @param [String] arg_string The arguments (as a string) passed to the command.
+    #   We inspect these for a '| do' or a '| {' and if we find it we use it
+    #   to start a block input sequence. Once we have a complete
+    #   block, we save it to an accessor that can be retrieved from the command context.
+    #   Note that if we find the '| do' or '| {' we delete this and the
+    #   elements following it from `arg_string`.
+    def pass_block(arg_string)
+      block_index = arg_string.rindex /\| *(?:do|\{)/
+
+      return if !block_index
+
+      block_init_string = arg_string.slice!(block_index..-1)[1..-1]
+      prime_string = "proc #{block_init_string}\n"
+
+      if !_pry_.complete_expression?(prime_string)
+        block_string = _pry_.r(target, prime_string)
+      else
+        block_string = prime_string
+      end
+
+      begin
+        self.command_block = target.eval(block_string)
+      rescue Pry::RescuableException
+        raise CommandError, "Incomplete block definition."
+      end
+    end
+
+    private :pass_block
+
     # Run the command with the given {args}.
     #
     # This is a public wrapper around {#call} which ensures all preconditions are met.
@@ -327,7 +411,9 @@ class Pry
       instance_exec(*correct_arg_arity(block.arity, args), &block)
     end
 
-    def help; description; end
+    def help
+      "#{command_options[:listing].to_s.ljust(18)} #{description}"
+    end
   end
 
   # A super-class ofr Commands with structure.

data/lib/pry/command_set.rb

@@ -21,7 +21,6 @@ class Pry
       @commands      = {}
       @helper_module = Module.new
 
-      define_default_commands
       import(*imported_sets)
 
       instance_eval(&block) if block
@@ -281,7 +280,19 @@ class Pry
     # @param [String]  the line that may be a command invocation
     # @return [Pry::Command, nil]
     def find_command(val)
-      commands.values.detect{ |c| c.matches?(val) }
+      commands.values.select{ |c| c.matches?(val) }.sort_by{ |c| c.match_score(val) }.last
+    end
+
+    # Find the command that the user might be trying to refer to.
+    #
+    # @param [String]  the user's search.
+    # @return [Pry::Command, nil]
+    def find_command_for_help(search)
+      find_command(search) || (begin
+        find_command_by_name_or_listing(search)
+      rescue ArgumentError
+        nil
+      end)
     end
 
     # Is the given line a command invocation?
@@ -324,91 +335,10 @@ class Pry
         :interpolate => true,
         :shellwords => true,
         :listing => name,
-        :use_prefix => true
+        :use_prefix => true,
+        :takes_block => false
       }
     end
-
-    def define_default_commands
-
-      create_command "help" do |cmd|
-        description "Show a list of commands, or help for one command"
-
-        banner <<-BANNER
-          Usage: help [ COMMAND ]
-
-          With no arguments, help lists all the available commands in the current
-          command-set along with their description.
-
-          When given a command name as an argument, shows the help for that command.
-        BANNER
-
-        def process
-          if cmd = args.first
-            if command = find_command(cmd)
-              output.puts command.new.help
-            else
-              output.puts "No info for command: #{cmd}"
-            end
-          else
-            output.puts
-            help_text = heading("Command List: ") + "\n"
-
-            help_text << commands.map do |key, command|
-              if command.description && !command.description.empty?
-                "#{command.options[:listing].to_s.ljust(18)} #{command.description}"
-              end
-            end.compact.sort.join("\n")
-
-            stagger_output(help_text)
-          end
-        end
-      end
-
-      create_command "install-command", "Install a disabled command." do |name|
-
-        banner <<-BANNER
-          Usage: install-command COMMAND
-
-          Installs the gems necessary to run the given COMMAND. You will generally not
-          need to run this unless told to by an error message.
-        BANNER
-
-        def process(name)
-          require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
-          command = find_command(name)
-
-          if command_dependencies_met?(command.options)
-            output.puts "Dependencies for #{command.name} are met. Nothing to do."
-            return
-          end
-
-          output.puts "Attempting to install `#{name}` command..."
-          gems_to_install = Array(command.options[:requires_gem])
-
-          gems_to_install.each do |g|
-            next if gem_installed?(g)
-            output.puts "Installing `#{g}` gem..."
-
-            begin
-              Gem::DependencyInstaller.new.install(g)
-            rescue Gem::GemNotFoundException
-              raise CommandError, "Required Gem: `#{g}` not found. Aborting command installation."
-            end
-          end
-
-          Gem.refresh
-          gems_to_install.each do |g|
-            begin
-              require g
-            rescue LoadError
-              raise CommandError, "Required Gem: `#{g}` installed but not found?!. Aborting command installation."
-            end
-          end
-
-          output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
-        end
-      end
-    end
   end
 
   # Wraps the return result of process_commands, indicates if the

data/lib/pry/commands.rb

@@ -1,10 +1,12 @@
-require "pry/default_commands/basic"
-require "pry/default_commands/documentation"
+require "pry/default_commands/misc"
+require "pry/default_commands/help"
 require "pry/default_commands/gems"
 require "pry/default_commands/context"
-require "pry/default_commands/input"
-require "pry/default_commands/shell"
+require "pry/default_commands/commands"
+require "pry/default_commands/input_and_output"
 require "pry/default_commands/introspection"
+require "pry/default_commands/editing"
+require "pry/default_commands/navigating_pry"
 require "pry/default_commands/easter_eggs"
 
 require "pry/extended_commands/experimental"
@@ -13,13 +15,15 @@ class Pry
 
   # Default commands used by Pry.
   Commands = Pry::CommandSet.new do
-    import DefaultCommands::Basic
-    import DefaultCommands::Documentation
+    import DefaultCommands::Misc
+    import DefaultCommands::Help
     import DefaultCommands::Gems
     import DefaultCommands::Context
-    import DefaultCommands::Input
-    import DefaultCommands::Shell
+    import DefaultCommands::NavigatingPry
+    import DefaultCommands::Editing
+    import DefaultCommands::InputAndOutput
     import DefaultCommands::Introspection
     import DefaultCommands::EasterEggs
+    import DefaultCommands::Commands
   end
 end

data/lib/pry/default_commands/cd.rb

@@ -0,0 +1,58 @@
+class Pry
+  module DefaultCommands
+    Cd = Pry::CommandSet.new do
+      create_command "cd" do
+        group "Context"
+        description "Move into a new context (object or scope)."
+
+        banner <<-BANNER
+          Usage: cd [OPTIONS] [--help]
+
+          Move into new context (object or scope). As in unix shells use
+          `cd ..` to go back and `cd /` to return to Pry top-level).
+          Complex syntax (e.g cd ../@x/y) also supported.
+
+          e.g: `cd @x`
+          e.g: `cd ..
+          e.g: `cd /`
+
+          https://github.com/pry/pry/wiki/State-navigation#wiki-Changing_scope
+        BANNER
+
+        def process
+          path   = arg_string.split(/\//)
+          stack  = _pry_.binding_stack.dup
+
+          # special case when we only get a single "/", return to root
+          stack  = [stack.first] if path.empty?
+
+          path.each do |context|
+            begin
+              case context.chomp
+              when ""
+                stack = [stack.first]
+              when "::"
+                stack.push(TOPLEVEL_BINDING)
+              when "."
+                next
+              when ".."
+                unless stack.size == 1
+                  stack.pop
+                end
+              else
+                stack.push(Pry.binding_for(stack.last.eval(context)))
+              end
+
+            rescue RescuableException => e
+              output.puts "Bad object path: #{arg_string.chomp}. Failed trying to resolve: #{context}"
+              output.puts e.inspect
+              return
+            end
+          end
+
+          _pry_.binding_stack = stack
+        end
+      end
+    end
+  end
+end