pry 0.9.8pre7-java → 0.9.8pre8-java

data/lib/pry.rb

@@ -148,6 +148,14 @@ class Pry
   # indicate an exceptional condition that's fatal to the current command.
   class CommandError < StandardError; end
   class NonMethodContextError < CommandError; end
+
+  # indicates obsolete API
+  class ObsoleteError < StandardError; end
+
+  # This is to keep from breaking under Rails 3.2 for people who are doing that
+  # IRB = Pry thing.
+  module ExtendCommandBundle
+  end
 end
 
 require "method_source"
@@ -163,7 +171,7 @@ if Pry::Helpers::BaseHelpers.jruby?
   begin
     require 'ffi'
   rescue LoadError
-    $stderr.puts "Need to `gem install ffi`"
+    warn "Need to `gem install ffi`"
   end
 end
 
@@ -171,7 +179,7 @@ if Pry::Helpers::BaseHelpers.windows?
   begin
     require 'win32console'
   rescue LoadError
-    $stderr.puts "Need to `gem install win32console`"
+    warn "Need to `gem install win32console`"
     exit 1
   end
 end

data/lib/pry/code.rb

@@ -122,7 +122,7 @@ class Pry
     # @return [String] The inserted line.
     def push(line, line_num=nil)
       line_num = @lines.last.last + 1 unless line_num
-      @lines.push([line, line_num])
+      @lines.push([line.chomp, line_num])
       line
     end
     alias << push
@@ -305,6 +305,13 @@ class Pry
       lines.map { |l| "#{l.first}\n" }.join
     end
 
+    # Return an unformatted String of the code.
+    #
+    # @return [String]
+    def raw
+      @lines.map(&:first).join("\n")
+    end
+
     # Return the number of lines stored.
     #
     # @return [Fixnum]

data/lib/pry/command.rb

@@ -1,7 +1,7 @@
 class Pry
 
   # The super-class of all commands, new commands should be created by calling
-  # {Pry::CommandSet#command} which creates a BlockCommand or {Pry::CommandSet#command_class}
+  # {Pry::CommandSet#command} which creates a BlockCommand or {Pry::CommandSet#create_command}
   # which creates a ClassCommand. Please don't use this class directly.
   class Command
 
@@ -12,7 +12,7 @@ class Pry
     def VOID_VALUE.inspect() "void" end
 
     # Properties of the command itself (as passed as arguments to
-    # {CommandSet#command} or {CommandSet#command_class}).
+    # {CommandSet#command} or {CommandSet#create_command}).
     class << self
       attr_accessor :block
       attr_accessor :name
@@ -331,7 +331,7 @@ class Pry
   # This class implements the bare-minimum functionality that a command should have,
   # namely a --help switch, and then delegates actual processing to its subclasses.
   #
-  # Create subclasses using {Pry::CommandSet#command_class}, and override the {options(opt)} method
+  # Create subclasses using {Pry::CommandSet#create_command}, and override the {options(opt)} method
   # to set up an instance of Slop, and the {process} method to actually run the command. If
   # necessary, you can also override {setup} which will be called before {options}, for example to
   # require any gems your command needs to run, or to set up state.

data/lib/pry/command_set.rb

@@ -122,7 +122,6 @@ class Pry
       commands[name].class_eval(&block)
       commands[name]
     end
-    alias_method :command_class, :create_command
 
     # Execute a block of code before a command is invoked. The block also
     # gets access to parameters that will be passed to the command and
@@ -365,45 +364,49 @@ class Pry
         end
       end
 
-      command "install-command", "Install a disabled command." do |name|
-        require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
-        command = find_command(name)
+      create_command "install-command", "Install a disabled command." do |name|
 
-        if command_dependencies_met?(command.options)
-          output.puts "Dependencies for #{command.name} are met. Nothing to do."
-          next
-        end
+        banner <<-BANNER
+          Usage: install-command COMMAND
 
-        output.puts "Attempting to install `#{name}` command..."
-        gems_to_install = Array(command.options[:requires_gem])
+          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
 
-        gem_install_failed = false
-        gems_to_install.each do |g|
-          next if gem_installed?(g)
-          output.puts "Installing `#{g}` gem..."
+        def process(name)
+          require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
+          command = find_command(name)
 
-          begin
-            Gem::DependencyInstaller.new.install(g)
-          rescue Gem::GemNotFoundException
-            output.puts "Required Gem: `#{g}` not found. Aborting command installation."
-            gem_install_failed = true
-            next
+          if command_dependencies_met?(command.options)
+            output.puts "Dependencies for #{command.name} are met. Nothing to do."
+            return
           end
-        end
-        next if gem_install_failed
-
-        Gem.refresh
-        gems_to_install.each do |g|
-          begin
-            require g
-          rescue LoadError
-            output.puts "Required Gem: `#{g}` installed but not found?!. Aborting command installation."
-            gem_install_failed = true
+
+          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
-        end
-        next if gem_install_failed
 
-        output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
+          output.puts "Installation of `#{name}` successful! Type `help #{name}` for information"
+        end
       end
     end
   end

data/lib/pry/config.rb

@@ -42,7 +42,19 @@ class Pry
     # @example
     #   Pry.hooks :before_session => proc { puts "hello" },
     #     :after_session => proc { puts "goodbye" }
-    attr_accessor :hooks
+    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
 
     # Get/Set the stack of input objects that a Pry instance switches
     # to when its current input object encounters EOF.

data/lib/pry/default_commands/context.rb

@@ -6,7 +6,7 @@ class Pry
     Context = Pry::CommandSet.new do
       import Ls
 
-      command_class "cd" do
+      create_command "cd" do
         description "Move into a new context (object or scope). Type `cd --help` for more information."
 
         banner <<-BANNER
@@ -106,7 +106,7 @@ class Pry
 
       alias_command "!!@", "exit-all"
 
-      command_class "exit" do
+      create_command "exit" do
         description "Pop the previous binding (does NOT exit program). Type `exit --help` for more information. Aliases: quit"
 
         banner <<-BANNER
@@ -164,11 +164,16 @@ class Pry
         target.pry
       end
 
-      command_class "pry-backtrace", "Show the backtrace for the Pry session." do
+      create_command "pry-backtrace", "Show the backtrace for the Pry session." do
         banner <<-BANNER
           Usage:   pry-backtrace [OPTIONS] [--help]
 
-          Show the backtrace for the Pry session.
+          Show the backtrace for the position in the code where Pry was started. This can be used to
+          infer the behavior of the program immediately before it entered Pry, just like the backtrace
+          property of an exception.
+
+          (NOTE: if you are looking for the backtrace of the most recent exception raised,
+          just type: `_ex_.backtrace` instead, see https://github.com/pry/pry/wiki/Special-Locals)
 
           e.g: pry-backtrace
         BANNER

data/lib/pry/default_commands/documentation.rb

@@ -3,7 +3,7 @@ class Pry
 
     Documentation = Pry::CommandSet.new do
 
-      command_class "ri", "View ri documentation. e.g `ri Array#each`" do
+      create_command "ri", "View ri documentation. e.g `ri Array#each`" do
         banner <<-BANNER
           Usage: ri [spec]
           e.g. ri Array#each
@@ -16,7 +16,7 @@ class Pry
         end
       end
 
-      command_class "show-doc", "Show the comments above METH. Type `show-doc --help` for more info. Aliases: \?", :shellwords => false do |*args|
+      create_command "show-doc", "Show the comments above METH. Type `show-doc --help` for more info. Aliases: \?", :shellwords => false do |*args|
         banner <<-BANNER
           Usage: show-doc [OPTIONS] [METH]
           Show the comments above method METH. Tries instance methods first and then methods by default.
@@ -25,6 +25,8 @@ class Pry
 
         def options(opt)
           method_options(opt)
+          opt.on :l, "line-numbers", "Show line numbers."
+          opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)."
           opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
         end
 
@@ -39,13 +41,27 @@ class Pry
           output.puts "#{text.bold("Signature:")} #{meth.signature}"
           output.puts
 
+          if opts.present?(:b) || opts.present?(:l)
+            doc = Code.new(doc, start_line, :text).
+              with_line_numbers(true)
+          end
+
           render_output(doc, opts)
         end
+
+        def start_line
+          if opts.present?(:'base-one')
+             1
+          else
+            (method_object.source_line - method_object.doc.lines.count) || 1
+          end
+        end
+
       end
 
       alias_command "?", "show-doc"
 
-      command_class "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info.", :shellwords => false do |*args|
+      create_command "stat", "View method information and set _file_ and _dir_ locals. Type `stat --help` for more info.", :shellwords => false do |*args|
         banner <<-BANNER
             Usage: stat [OPTIONS] [METH]
             Show method information for method METH and set _file_ and _dir_ locals.
@@ -72,67 +88,55 @@ class Pry
         end
       end
 
-      command_class "gist", "Gist a method or expression history to github. Type `gist --help` for more info.", :requires_gem => "gist", :shellwords => false do
+      create_command "gist", "Gist a method or expression history to github. Type `gist --help` for more info.", :requires_gem => "gist", :shellwords => false do
+        banner <<-USAGE
+          Usage: gist [OPTIONS] [METH]
+          Gist method (doc or source) or input expression to github.
+          Ensure the `gist` gem is properly working before use. http://github.com/defunkt/gist for instructions.
+          e.g: gist -m my_method
+          e.g: gist -d my_method
+          e.g: gist -i 1..10
+          e.g: gist -c show-method
+          e.g: gist -m hello_world --lines 2..-2
+        USAGE
+
         attr_accessor :content
         attr_accessor :code_type
-        attr_accessor :input_ranges
 
         def setup
           require 'gist'
+          self.content   = ""
+          self.code_type = :ruby
         end
 
         def options(opt)
-          opt.banner unindent <<-USAGE
-  Usage: gist [OPTIONS] [METH]
-  Gist method (doc or source) or input expression to github.
-  Ensure the `gist` gem is properly working before use. http://github.com/defunkt/gist for instructions.
-  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
-          opt.on :i, :in, "Gist entries from Pry's input expression history. Takes an index or range.", :optional => true,
-          :as => Range, :default => -5..-1 do |range|
-            self.input_ranges ||= []
-            input_ranges << absolute_index_range(range, _pry_.input_array.length)
-          end
-        end
-
-        def process
-          self.content = ""
-
-          if opts.present?(:in)
-            in_option
-          end
-          if opts.present?(:file)
-            file_option
+          opt.on :m, :method, "Gist a method's source.", true do |meth_name|
+            meth = get_method_or_raise(meth_name, target, {})
+            self.content << meth.source
+            self.code_type = meth.source_type
           end
-          if opts.present?(:doc)
-            doc_option
+          opt.on :d, :doc, "Gist a method's documentation.", true do |meth_name|
+            meth = get_method_or_raise(meth_name, target, {})
+            text.no_color do
+              self.content << process_comment_markup(meth.doc, self.code_type)
+            end
+            self.code_type = :plain
           end
-          if opts.present?(:method)
-            method_option
+          opt.on :c, :command, "Gist a command's source.", true do |command_name|
+            command = find_command(command_name)
+            block = Pry::Method.new(find_command(command_name).block)
+            self.content << block.source
           end
-          if opts.present?(:command)
-            command_option
+          opt.on :f, :file, "Gist a file.", true do |file|
+            self.content << File.read(File.expand_path(file))
           end
-
-          perform_gist
-        end
-
-        def in_option
-          self.code_type = :ruby
-
-          input_ranges.each do |range|
+          opt.on :p, :public, "Create a public gist (default: false)", :default => false
+          opt.on :l, :lines, "Only gist a subset of lines.", :optional => true, :as => Range, :default => 1..-1
+          opt.on :i, :in, "Gist entries from Pry's input expression history. Takes an index or range.", :optional => true,
+          :as => Range, :default => -5..-1 do |range|
+            range = convert_to_range(range)
             input_expressions = _pry_.input_array[range] || []
-            input_expressions.each_with_index.map do |code, index|
+            Array(input_expressions).each_with_index do |code, index|
               corrected_index = index + range.first
               if code && code != ""
                 self.content << code
@@ -144,49 +148,8 @@ USAGE
           end
         end
 
-        def file_option
-          whole_file = File.read(File.expand_path(opts[:f]))
-          if opts.present?(:lines)
-            self.content << restrict_to_lines(whole_file, opts[:l])
-          else
-            self.content << whole_file
-          end
-        end
-
-        def doc_option
-          meth = get_method_or_raise(opts[:d], target, {})
-          self.content << meth.doc
-          self.code_type = meth.source_type
-
-          text.no_color do
-            self.content << process_comment_markup(self.content, self.code_type)
-          end
-          self.code_type = :plain
-        end
-
-        def method_option
-          meth = get_method_or_raise(opts[:m], target, {})
-          method_source = meth.source
-          if opts.present?(:lines)
-            self.content << restrict_to_lines(method_source, opts[:l])
-          else
-            self.content << method_source
-          end
-
-          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
+        def process
+          perform_gist
         end
 
         def perform_gist
@@ -200,6 +163,10 @@ USAGE
           begin
             extname = opts.present?(:file) ? ".#{gist_file_extension(opts[:f])}" : ".#{type_map[self.code_type]}"
 
+            if opts.present?(:lines)
+              self.content = restrict_to_lines(content, opts[:l])
+            end
+
             link = Gist.write([:extension => extname,
                                :input => self.content],
                               !opts[:p])
@@ -212,15 +179,18 @@ USAGE
           end
         end
 
-        def restrict_to_lines(content, lines)
-          line_range = one_index_range(lines)
-          content.lines.to_a[line_range].join
-        end
-
         def gist_file_extension(file_name)
           file_name.split(".").last
         end
 
+        def convert_to_range(n)
+          if !n.is_a?(Range)
+            (n..n)
+          else
+            n
+          end
+        end
+
         def comment_expression_result_for_gist(result)
           content = ""
           result.lines.each_with_index do |line, index|