pry 0.9.8pre5-i386-mswin32 → 0.9.8pre6-i386-mswin32

data/lib/pry/command_set.rb

@@ -331,23 +331,36 @@ class Pry
 
     def define_default_commands
 
-      command "help", "This menu." do |cmd|
-        if !cmd
-          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")
+      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
 
-          stagger_output(help_text)
-        else
-          if command = find_command(cmd)
-            output.puts command.new.help
+        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 "No info for command: #{cmd}"
+            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

data/lib/pry/commands.rb

@@ -7,7 +7,6 @@ require "pry/default_commands/shell"
 require "pry/default_commands/introspection"
 require "pry/default_commands/easter_eggs"
 
-require "pry/extended_commands/user_command_api"
 require "pry/extended_commands/experimental"
 
 class Pry

data/lib/pry/config.rb

@@ -33,8 +33,8 @@ class Pry
     attr_accessor :exception_whitelist
 
     # @return [Fixnum] The number of lines of context to show before and after
-    # the exception when using cat --ex.
-    attr_accessor :exception_window_size
+    #   exceptions, etc.
+    attr_accessor :default_window_size
 
     # Get/Set the Hash that defines Pry hooks used by default by all Pry
     # instances.

data/lib/pry/default_commands/context.rb

@@ -6,42 +6,56 @@ class Pry
     Context = Pry::CommandSet.new do
       import Ls
 
-      command "cd", "Move into a new context (use `cd ..` to go back and `cd /` to return to Pry top-level). Complex syntax (e.g cd ../@x/y) also supported."  do |obj|
-        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?
-
-        resolve_failure = false
-        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
+      command_class "cd" do
+        description "Move into a new context (object or scope). Type `cd --help` for more information."
+
+        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
-            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
-            resolve_failure = true
-            break
+            rescue RescuableException => e
+              output.puts "Bad object path: #{arg_string.chomp}. Failed trying to resolve: #{context}"
+              output.puts e.inspect
+              return
+            end
           end
-        end
 
-        next if resolve_failure
-
-        _pry_.binding_stack = stack
+          _pry_.binding_stack = stack
+        end
       end
 
       command "switch-to", "Start a new sub-session on a binding in the current stack (numbered by nesting)." do |selection|
@@ -92,21 +106,47 @@ class Pry
 
       alias_command "!!@", "exit-all"
 
-      command "exit", "Pop the current binding and return to the one immediately prior. Note this does NOT exit the program. Aliases: quit", :keep_retval => true do
-        if _pry_.binding_stack.one?
-          # when breaking out of top-level then behave like `exit-all`
+      command_class "exit" do
+        description "Pop the previous binding (does NOT exit program). Type `exit --help` for more information. Aliases: quit"
+
+        banner <<-BANNER
+          Usage:   exit [OPTIONS] [--help]
+          Aliases: quit
+
+          It can be useful to exit a context with a user-provided value. For
+          instance an exit value can be used to determine program flow.
+
+          e.g: `exit "pry this"`
+          e.g: `exit`
+
+          https://github.com/pry/pry/wiki/State-navigation#wiki-Exit_with_value
+        BANNER
+
+        command_options(
+                        :keep_retval => true
+                        )
+
+        def process
+          if _pry_.binding_stack.one?
+            # when breaking out of top-level then behave like `exit-all`
+            process_exit_all
+          else
+            # otherwise just pop a binding and return user supplied value
+            process_pop_and_return
+          end
+        end
+
+        def process_exit_all
           _pry_.binding_stack.clear
           throw(:breakout, target.eval(arg_string))
-        else
-          # otherwise just pop a binding
+        end
+
+        def process_pop_and_return
           popped_object = _pry_.binding_stack.pop.eval('self')
 
-          # return a user-specified value if given
-          if !arg_string.empty?
-            target.eval(arg_string)
-          else
-            popped_object
-          end
+          # return a user-specified value if given otherwise return the object
+          return target.eval(arg_string) unless arg_string.empty?
+          popped_object
         end
       end
 
@@ -124,20 +164,25 @@ class Pry
         target.pry
       end
 
-      command "pry-backtrace", "Show the backtrace for the Pry session" do
-        output.puts "\n#{text.bold('Backtrace:')}\n--\n"
-        output.puts _pry_.backtrace
+      command_class "pry-backtrace", "Show the backtrace for the Pry session." do
+        banner <<-BANNER
+          Usage:   pry-backtrace [OPTIONS] [--help]
+
+          Show the backtrace for the Pry session.
+
+          e.g: pry-backtrace
+        BANNER
+
+        def process
+          output.puts "\n#{text.bold('Backtrace:')}\n--\n"
+          stagger_output _pry_.backtrace.join("\n")
+        end
       end
 
       command "whereami", "Show the code context for the session. (whereami <n> shows <n> extra lines of code around the invocation line. Default: 5)" do |num|
         file = target.eval('__FILE__')
         line_num = target.eval('__LINE__')
-
-        if num
-          i_num = num.to_i
-        else
-          i_num = 5
-        end
+        i_num = num ? num.to_i : 5
 
         if file != Pry.eval_path && (file =~ /(\(.*\))|<.*>/ || file == "" || file == "-e")
           raise CommandError, "Cannot find local context. Did you use `binding.pry`?"
@@ -149,40 +194,9 @@ class Pry
         method_description = method ? " in #{method.name_with_owner}" : ""
         output.puts "\n#{text.bold('From:')} #{file} @ line #{line_num}#{method_description}:\n\n"
 
-        if file == Pry.eval_path
-          f = Pry.line_buffer[1..-1]
-        else
-          unless File.readable?(file)
-            raise CommandError, "Cannot open #{file.inspect} for reading."
-          end
-          f = File.open(file)
-        end
-
-        # This method inspired by http://rubygems.org/gems/ir_b
-        begin
-          f.each_with_index do |line, index|
-            line_n = index + 1
-            next unless line_n > (line_num - i_num - 1)
-            break if line_n > (line_num + i_num)
-            if line_n == line_num
-              code =" =>#{line_n.to_s.rjust(3)}: #{line.chomp}"
-              if Pry.color
-                code = CodeRay.scan(code, :ruby).term
-              end
-              output.puts code
-              code
-            else
-              code = "#{line_n.to_s.rjust(6)}: #{line.chomp}"
-              if Pry.color
-                code = CodeRay.scan(code, :ruby).term
-              end
-              output.puts code
-              code
-            end
-          end
-        ensure
-          f.close if f.respond_to?(:close)
-        end
+        code = Pry::Code.from_file(file).around(line_num, i_num)
+        output.puts code.with_line_numbers.with_marker(line_num)
+        output.puts
       end
 
     end

data/lib/pry/default_commands/documentation.rb

@@ -38,7 +38,8 @@ class Pry
           output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
           output.puts "#{text.bold("Signature:")} #{meth.signature}"
           output.puts
-          render_output(opts.present?(:flood), false, doc)
+
+          render_output(doc, opts)
         end
       end
 
@@ -88,10 +89,12 @@ class Pry
   e.g: gist -m my_method
   e.g: gist -d my_method
   e.g: gist -i 1..10
+  e.g: gist -c show-method
 USAGE
 
           opt.on :d, :doc, "Gist a method's documentation.", true
           opt.on :m, :method, "Gist a method's source.", true
+          opt.on :c, :command, "Gist a command's source.", true
           opt.on :f, :file, "Gist a file.", true
           opt.on :p, :public, "Create a public gist (default: false)", :default => false
           opt.on :l, :lines, "Only gist a subset of lines (only works with -m and -f)", :optional => true, :as => Range, :default => 1..-1
@@ -117,6 +120,9 @@ USAGE
           if opts.present?(:method)
             method_option
           end
+          if opts.present?(:command)
+            command_option
+          end
 
           perform_gist
         end
@@ -170,6 +176,19 @@ USAGE
           self.code_type = meth.source_type
         end
 
+        def command_option
+          command = find_command(opts[:c])
+          command_source = command.block.source
+
+          if opts.present?(:lines)
+            self.content << restrict_to_lines(command_source, opts[:l])
+          else
+            self.content << command_source
+          end
+
+          self.code_type = :ruby
+        end
+
         def perform_gist
           type_map = { :ruby => "rb", :c => "c", :plain => "plain" }
 

data/lib/pry/default_commands/gems.rb

@@ -3,53 +3,81 @@ class Pry
 
     Gems = Pry::CommandSet.new do
 
-      command "gem-install", "Install a gem and refresh the gem cache.", :argument_required => true do |gem|
-        require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
-        begin
-          destination = File.writable?(Gem.dir) ? Gem.dir : Gem.user_dir
-          installer = Gem::DependencyInstaller.new :install_dir => destination
-          installer.install gem
-        rescue Errno::EACCES
-          raise CommandError, "Insufficient permissions to install `#{text.green gem}`."
-        rescue Gem::GemNotFoundException
-          raise CommandError, "Gem `#{text.green gem}` not found."
-        else
-          Gem.refresh
-          output.puts "Gem `#{text.green gem}` installed."
+      create_command "gem-install", "Install a gem and refresh the gem cache.", :argument_required => true do |gem|
+
+        banner <<-BANNER
+          Usage: gem-install GEM_NAME
+
+          Installs the given gem and refreshes the gem cache so that you can immediately 'require GEM_FILE'
+        BANNER
+
+        def setup
+          require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
         end
-      end
 
-      command "gem-cd", "Change working directory to specified gem's directory.", :argument_required => true do |gem|
-        specs = Gem::Specification.respond_to?(:each) ? Gem::Specification.find_all_by_name(gem) : Gem.source_index.find_name(gem)
-        spec  = specs.sort { |a,b| Gem::Version.new(b.version) <=> Gem::Version.new(a.version) }.first
-        if spec
-          Dir.chdir(spec.full_gem_path)
-        else
-          raise CommandError, "Gem `#{gem}` not found."
+        def process(gem)
+          begin
+            destination = File.writable?(Gem.dir) ? Gem.dir : Gem.user_dir
+            installer = Gem::DependencyInstaller.new :install_dir => destination
+            installer.install gem
+          rescue Errno::EACCES
+            raise CommandError, "Insufficient permissions to install `#{text.green gem}`."
+          rescue Gem::GemNotFoundException
+            raise CommandError, "Gem `#{text.green gem}` not found."
+          else
+            Gem.refresh
+            output.puts "Gem `#{text.green gem}` installed."
+          end
         end
       end
 
-      command "gem-list", "List/search installed gems. (Optional parameter: a regexp to limit the search)" do |pattern|
-        pattern = Regexp.new pattern.to_s, Regexp::IGNORECASE
-        gems    = if Gem::Specification.respond_to?(:each)
-                    Gem::Specification.select{|spec| spec.name =~ pattern }.group_by(&:name)
-                  else
-                    Gem.source_index.gems.values.group_by(&:name).select { |gemname, specs| gemname =~ pattern }
-                  end
-
-        gems.each do |gem, specs|
-          specs.sort! do |a,b|
-            Gem::Version.new(b.version) <=> Gem::Version.new(a.version)
-          end
+      create_command "gem-cd", "Change working directory to specified gem's directory.", :argument_required => true do |gem|
+        banner <<-BANNER
+          Usage: gem-cd GEM_NAME
 
-          versions = specs.each_with_index.map do |spec, index|
-            index == 0 ? text.bright_green(spec.version.to_s) : text.green(spec.version.to_s)
-          end
+          Change the current working directory to that in which the given gem is installed.
+        BANNER
 
-          output.puts "#{text.default gem} (#{versions.join ', '})"
+        def process(gem)
+          specs = Gem::Specification.respond_to?(:each) ? Gem::Specification.find_all_by_name(gem) : Gem.source_index.find_name(gem)
+          spec  = specs.sort { |a,b| Gem::Version.new(b.version) <=> Gem::Version.new(a.version) }.first
+          if spec
+            Dir.chdir(spec.full_gem_path)
+            output.puts(Dir.pwd)
+          else
+            raise CommandError, "Gem `#{gem}` not found."
+          end
         end
       end
 
+      create_command "gem-list", "List and search installed gems." do |pattern|
+        banner <<-BANNER
+          Usage: gem-list [REGEX]
+
+          List all installed gems, when a regex is provided, limit the output to those that
+          match the regex.
+        BANNER
+
+        def process(pattern=nil)
+          gems    = if Gem::Specification.respond_to?(:each)
+                      Gem::Specification.select{|spec| spec.name =~ pattern }.group_by(&:name)
+                    else
+                      Gem.source_index.gems.values.group_by(&:name).select { |gemname, specs| gemname =~ pattern }
+                    end
+
+          gems.each do |gem, specs|
+            specs.sort! do |a,b|
+              Gem::Version.new(b.version) <=> Gem::Version.new(a.version)
+            end
+
+            versions = specs.each_with_index.map do |spec, index|
+              index == 0 ? text.bright_green(spec.version.to_s) : text.green(spec.version.to_s)
+            end
+
+            output.puts "#{text.default gem} (#{versions.join ', '})"
+          end
+        end
+      end
     end
   end
 end