pry 0.10.4 → 0.11.0

data/lib/pry/command.rb

@@ -52,7 +52,7 @@ class Pry
       # Define or get the command's banner
       def banner(arg=nil)
         @banner = arg if arg
-        @banner || description
+        @banner ||= description
       end
 
       def block
@@ -167,11 +167,12 @@ class Pry
         end
       end
 
+      # @deprecated Replaced with {Pry::Hooks#add_hook}. Left for compatibility.
       # Store hooks to be run before or after the command body.
       # @see {Pry::CommandSet#before_command}
       # @see {Pry::CommandSet#after_command}
       def hooks
-        @hooks ||= {:before => [], :after => []}
+        Pry.hooks
       end
 
       def command_regex
@@ -223,6 +224,7 @@ class Pry
     attr_accessor :arg_string
     attr_accessor :context
     attr_accessor :command_set
+    attr_accessor :hooks
     attr_accessor :_pry_
 
     # The block we pass *into* a command so long as `:takes_block` is
@@ -271,6 +273,7 @@ class Pry
       self.output       = context[:output]
       self.eval_string  = context[:eval_string]
       self.command_set  = context[:command_set]
+      self.hooks        = context[:hooks]
       self._pry_        = context[:pry_instance]
     end
 
@@ -424,10 +427,20 @@ class Pry
         raise CommandError, "The command '#{command_name}' requires an argument."
       end
 
-      ret = call_with_hooks(*args)
+      ret = use_unpatched_symbol do
+        call_with_hooks(*args)
+      end
       command_options[:keep_retval] ? ret : void
     end
 
+    def use_unpatched_symbol
+      call_method = Symbol.method_defined?(:call) && Symbol.instance_method(:call)
+      Symbol.class_eval { undef :call } if call_method
+      yield
+    ensure
+      Symbol.instance_eval { define_method(:call, call_method) } if call_method
+    end
+
     # Are all the gems required to use this command installed?
     #
     # @return  Boolean
@@ -445,17 +458,28 @@ class Pry
 
     private
 
+    def find_hooks(event)
+      event_name = "#{event}_#{command_name}"
+      (self.hooks || self.class.hooks).get_hooks(event_name).values
+    end
+
+    def before_hooks
+      find_hooks('before')
+    end
+
+    def after_hooks
+      find_hooks('after')
+    end
+
     # Run the `#call` method and all the registered hooks.
     # @param [Array<String>] args The arguments to `#call`
     # @return [Object] The return value from `#call`
     def call_with_hooks(*args)
-      self.class.hooks[:before].each do |block|
-        instance_exec(*args, &block)
-      end
+      before_hooks.each { |block| instance_exec(*args, &block) }
 
       ret = call(*args)
 
-      self.class.hooks[:after].each do |block|
+      after_hooks.each do |block|
         ret = instance_exec(*args, &block)
       end
 
@@ -507,7 +531,7 @@ class Pry
   # subclasses.
   #
   # Create subclasses using {Pry::CommandSet#create_command}, and override the
-  # `options(opt)` method to set up an instance of Slop, and the `process`
+  # `options(opt)` method to set up an instance of Pry::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.
@@ -583,15 +607,15 @@ class Pry
       end
     end
 
-    # Return the help generated by Slop for this command.
+    # Return the help generated by Pry::Slop for this command.
     def help
       slop.help
     end
 
-    # Return an instance of Slop that can parse either subcommands or the
+    # Return an instance of Pry::Slop that can parse either subcommands or the
     # options that this command accepts.
     def slop
-      Slop.new do |opt|
+      Pry::Slop.new do |opt|
         opt.banner(unindent(self.class.banner))
         subcommands(opt)
         options(opt)
@@ -603,9 +627,9 @@ class Pry
     # @param [String] search  The line typed so far
     # @return [Array<String>]  the words to complete
     def complete(search)
-      slop.map do |opt|
+      slop.flat_map do |opt|
         [opt.long && "--#{opt.long} " || opt.short && "-#{opt.short}"]
-      end.flatten(1).compact + super
+      end.compact + super
     end
 
     # A method called just before `options(opt)` as part of `call`.
@@ -620,7 +644,7 @@ class Pry
     #   end
     def setup; end
 
-    # A method to setup Slop commands so it can parse the subcommands your
+    # A method to setup Pry::Slop commands so it can parse the subcommands your
     # command expects. If you need to set up default values, use `setup`
     # instead.
     #
@@ -655,7 +679,7 @@ class Pry
     #   end
     def subcommands(cmd); end
 
-    # A method to setup Slop so it can parse the options your command expects.
+    # A method to setup Pry::Slop so it can parse the options your command expects.
     #
     # @note Please don't do anything side-effecty in the main part of this
     # method, as it may be called by Pry at any time for introspection reasons.
@@ -672,7 +696,7 @@ class Pry
 
     # The actual body of your command should go here.
     #
-    # The `opts` mehod can be called to get the options that Slop has passed,
+    # The `opts` mehod can be called to get the options that Pry::Slop has passed,
     # and `args` gives the remaining, unparsed arguments.
     #
     # The return value of this method is discarded unless the command was

data/lib/pry/command_set.rb

@@ -125,9 +125,10 @@ class Pry
     #   Pry.config.commands.before_command("whereami") do |n|
     #     output.puts "parameter passed was #{n}"
     #   end
+    # @deprecated Use {Pry::Hooks#add_hook} instead.
     def before_command(search, &block)
       cmd = find_command_by_match_or_listing(search)
-      cmd.hooks[:before].unshift block
+      cmd.hooks.add_hook("before_#{cmd.command_name}", random_hook_name, block)
     end
 
     # Execute a block of code after a command is invoked. The block also
@@ -139,11 +140,17 @@ class Pry
     #   Pry.config.commands.after_command("whereami") do |n|
     #     output.puts "command complete!"
     #   end
+    # @deprecated Use {Pry::Hooks#add_hook} instead.
     def after_command(search, &block)
       cmd = find_command_by_match_or_listing(search)
-      cmd.hooks[:after] << block
+      cmd.hooks.add_hook("after_#{cmd.command_name}", random_hook_name, block)
     end
 
+    def random_hook_name
+      (0...8).map { ('a'..'z').to_a[rand(26)] }.join
+    end
+    private :random_hook_name
+
     def each(&block)
       @commands.each(&block)
     end

data/lib/pry/commands/cat/exception_formatter.rb

@@ -27,16 +27,17 @@ class Pry
       end
 
       def backtrace_level
-        return @backtrace_level if @backtrace_level
-
-        bl =  if opts[:ex].nil?
-                ex.bt_index
-              else
-                ex.bt_index = absolute_index_number(opts[:ex], ex.backtrace.size)
-              end
-
-        increment_backtrace_level
-        @backtrace_level = bl
+        @backtrace_level ||=
+          begin
+            bl =  if opts[:ex].nil?
+                    ex.bt_index
+                  else
+                    ex.bt_index = absolute_index_number(opts[:ex], ex.backtrace.size)
+                  end
+
+            increment_backtrace_level
+            bl
+          end
       end
 
       def increment_backtrace_level

data/lib/pry/commands/cat/file_formatter.rb

@@ -6,6 +6,8 @@ class Pry
       attr_reader :_pry_
 
       def initialize(file_with_embedded_line, _pry_, opts)
+        raise CommandError, "Must provide a filename, --in, or --ex." if !file_with_embedded_line
+
         @file_with_embedded_line = file_with_embedded_line
         @opts = opts
         @_pry_ = _pry_
@@ -13,8 +15,6 @@ class Pry
       end
 
       def format
-        raise CommandError, "Must provide a filename, --in, or --ex." if !file_with_embedded_line
-
         set_file_and_dir_locals(file_name, _pry_, _pry_.current_context)
         decorate(@code_from_file)
       end
@@ -40,7 +40,11 @@ class Pry
       end
 
       def decorate(content)
-        line_number ? super.around(line_number, code_window_size) : super
+        if line_number
+          super(content.around(line_number, code_window_size))
+        else
+          super
+        end
       end
 
       def code_type

data/lib/pry/commands/code_collector.rb

@@ -51,21 +51,23 @@ class Pry
     #
     # @return [String]
     def content
-      return @content if @content
-      raise CommandError, "Only one of --out, --in, --doc and CODE_OBJECT may be specified." if bad_option_combination?
+      @content ||=
+        begin
+          raise CommandError, "Only one of --out, --in, --doc and CODE_OBJECT may be specified." if bad_option_combination?
 
-      content = case
-                when opts.present?(:o)
-                  pry_output_content
-                when opts.present?(:i)
-                  pry_input_content
-                when opts.present?(:d)
-                  code_object_doc
-                else
-                  code_object_source_or_file
-                end
+          content = case
+                    when opts.present?(:o)
+                      pry_output_content
+                    when opts.present?(:i)
+                      pry_input_content
+                    when opts.present?(:d)
+                      code_object_doc
+                    else
+                      code_object_source_or_file
+                    end
 
-      @content ||= restrict_to_lines(content, line_range)
+          restrict_to_lines(content, line_range)
+        end
     end
 
     # The code object
@@ -141,7 +143,7 @@ class Pry
     end
 
     def file_content
-      if File.exists?(obj_name)
+      if File.exist?(obj_name)
         # Set the file accessor.
         self.file = obj_name
         File.read(obj_name)

data/lib/pry/commands/easter_eggs.rb

@@ -10,17 +10,17 @@ class Pry
     end
 
     command "get-naked", "" do
-      text = %{
+      txt = %{
   --
   We dont have to take our clothes off to have a good time.
   We could dance & party all night And drink some cherry wine.
   -- Jermaine Stewart }
-      output.puts text
-      text
+      output.puts txt
+      txt
     end
 
     command "east-coker", "" do
-      text = %{
+      txt = %{
   --
   Now the light falls
   Across the open field, leaving the deep lane
@@ -34,12 +34,12 @@ class Pry
   Wait for the early owl.
                 -- T.S Eliot
           }
-      output.puts text
-      text
+      output.puts txt
+      txt
     end
 
     command "cohen-poem", "" do
-      text = %{
+      txt = %{
   --
   When this American woman,
   whose thighs are bound in casual red cloth,
@@ -57,8 +57,8 @@ class Pry
   they are lost for hours.
                 -- Leonard Cohen
               }
-      output.puts text
-      text
+      output.puts txt
+      txt
     end
 
     command "pessoa-poem", "" do

data/lib/pry/commands/edit/file_and_line_locator.rb

@@ -7,7 +7,7 @@ class Pry
         end
 
         def from_code_object(code_object, filename_argument)
-          if File.exists?(code_object.source_file.to_s)
+          if File.exist?(code_object.source_file.to_s)
             [code_object.source_file, code_object.source_line]
           else
             raise CommandError, "Cannot find a file for #{filename_argument}!"

data/lib/pry/commands/edit.rb

@@ -46,7 +46,7 @@ class Pry
         # code defined in pry, eval'd within pry.
         repl_edit
       elsif runtime_patch?
-        # patch code without persisting changes
+        # patch code without persisting changes, implies future changes are patches
         apply_runtime_patch
       else
         # code stored in actual files, eval'd at top-level
@@ -72,7 +72,7 @@ class Pry
     end
 
     def runtime_patch?
-       !file_based_exception? && (opts.present?(:patch) || pry_method?(code_object))
+       !file_based_exception? && (opts.present?(:patch) || previously_patched?(code_object) || pry_method?(code_object))
     end
 
     def apply_runtime_patch
@@ -140,6 +140,10 @@ class Pry
         code_object.pry_method?
     end
 
+    def previously_patched?(code_object)
+      code_object.is_a?(Pry::Method) && Pry::Method::Patcher.code_for(code_object.source_location.first)
+    end
+
     def patch_exception?
       opts.present?(:ex) && opts.present?(:patch)
     end
@@ -153,7 +157,7 @@ class Pry
       case opts[:i]
       when Range
         (_pry_.input_array[opts[:i]] || []).join
-      when Fixnum
+      when Integer
         _pry_.input_array[opts[:i]] || ""
       else
         raise Pry::CommandError, "Not a valid range: #{opts[:i]}"

data/lib/pry/commands/find_method.rb

@@ -20,7 +20,7 @@ class Pry
       find-method re Pry
 
       # Find all methods that contain the code:
-      # output.puts inside the Pry namepsace.
+      # output.puts inside the Pry namespace.
       find-method -c 'output.puts' Pry
     BANNER
 

data/lib/pry/commands/gem_open.rb

@@ -16,7 +16,7 @@ class Pry
 
     def process(gem)
       Dir.chdir(Rubygem.spec(gem).full_gem_path) do
-        Pry::Editor.invoke_editor(".", 0, false)
+        Pry::Editor.new(_pry_).invoke_editor(".", 0, false)
       end
     end
 

data/lib/pry/commands/gem_readme.rb

@@ -0,0 +1,25 @@
+class Pry::Command::GemReadme < Pry::ClassCommand
+  match 'gem-readme'
+  description 'Show the readme bundled with a rubygem'
+  group 'Gems'
+  command_options argument_required: true
+  banner <<-BANNER
+    gem-readme gem
+    Show the readme bundled with a rubygem
+  BANNER
+
+  def process(name)
+    spec = Gem::Specification.find_by_name(name)
+    glob = File.join(spec.full_gem_path, 'README*')
+    readme = Dir[glob][0]
+    if File.exist?(readme.to_s)
+      _pry_.pager.page File.read(readme)
+    else
+      raise Pry::CommandError, "Gem '#{name}' doesn't appear to have a README"
+    end
+  rescue Gem::LoadError
+    raise Pry::CommandError, "Gem '#{name}' wasn't found. Are you sure it is installed?"
+  end
+
+  Pry::Commands.add_command(self)
+end

data/lib/pry/commands/gem_search.rb

@@ -0,0 +1,40 @@
+class Pry::Command::GemSearch < Pry::ClassCommand
+  match 'gem-search'
+  description 'Search for a gem with the rubygems.org JSON API'
+  group 'Gems'
+  command_options argument_required: true
+  banner <<-BANNER
+    gem-search [options] gem
+    Search for a gem with the rubygems.org HTTP API
+  BANNER
+
+  API_ENDPOINT = 'https://rubygems.org/api/v1/search.json'
+
+  def setup
+    require 'json' unless defined?(JSON)
+    require 'net/http' unless defined?(Net::HTTP)
+  end
+
+  def options(opt)
+    opt.on :l, :limit, 'Limit the number of results (max: 30)',
+      default: 10,
+      as: Integer,
+      argument: true
+  end
+
+  def process(str)
+    uri = URI.parse(API_ENDPOINT)
+    uri.query = URI.encode_www_form(query: str)
+    gems = JSON.load Net::HTTP.get(uri)
+    _pry_.pager.page list_as_string(gems, opts[:limit])
+  end
+
+private
+  def list_as_string(gems, limit = 10)
+    gems[0..limit-1].map do |gem|
+      name, version, info = gem.values_at 'name', 'version', 'info'
+      "#{text.bold(name)} #{text.bold('v'+version)} \n#{info}\n\n"
+    end.join
+  end
+  Pry::Commands.add_command(self)
+end

data/lib/pry/commands/hist.rb

@@ -170,8 +170,8 @@ class Pry
           else
             Pry.history.to_a.last(Pry.history.session_line_count)
           end
-      # The last value in history will be the 'hist' command itself.
-      Pry::Code(h[0..-2])
+
+      Pry::Code(Pry.history.filter(h[0..-2]))
     end
   end
 

data/lib/pry/commands/jump_to.rb

@@ -9,18 +9,18 @@ class Pry
     BANNER
 
     def process(break_level)
-      break_level = break_level.to_i
-      nesting_level = _pry_.binding_stack.size - 1
+      break_level    = break_level.to_i
+      nesting_level  = _pry_.binding_stack.size - 1
+      max_nest_level = nesting_level - 1
 
       case break_level
       when nesting_level
         output.puts "Already at nesting level #{nesting_level}"
-      when (0...nesting_level)
-        _pry_.binding_stack.slice!(break_level + 1, _pry_.binding_stack.size)
-
+      when 0..max_nest_level
+        _pry_.binding_stack = _pry_.binding_stack[0..break_level]
       else
-        max_nest_level = nesting_level - 1
-        output.puts "Invalid nest level. Must be between 0 and #{max_nest_level}. Got #{break_level}."
+        output.puts "Invalid nest level. Must be between 0 and " \
+          "#{max_nest_level}. Got #{break_level}."
       end
     end
   end

data/lib/pry/commands/ls/constants.rb

@@ -3,15 +3,17 @@ require 'pry/commands/ls/interrogatable'
 class Pry
   class Command::Ls < Pry::ClassCommand
     class Constants < Pry::Command::Ls::Formatter
+      DEPRECATED_CONSTANTS = [:Fixnum, :Bignum, :TimeoutError, :NIL, :FALSE, :TRUE]
+      DEPRECATED_CONSTANTS << :JavaPackageModuleTemplate if Pry::Helpers::BaseHelpers.jruby?
       include Pry::Command::Ls::Interrogatable
 
-
       def initialize(interrogatee, no_user_opts, opts, _pry_)
         super(_pry_)
         @interrogatee = interrogatee
         @no_user_opts = no_user_opts
         @default_switch = opts[:constants]
         @verbose_switch = opts[:verbose]
+        @dconstants = opts.dconstants?
       end
 
       def correct_opts?
@@ -26,8 +28,17 @@ class Pry
 
       private
 
+      def show_deprecated_constants?
+        @dconstants == true
+      end
+
       def format(mod, constants)
         constants.sort_by(&:downcase).map do |name|
+          if Object.respond_to?(:deprecate_constant) and
+            DEPRECATED_CONSTANTS.include?(name)      and
+            !show_deprecated_constants?
+            next
+          end
           if const = (!mod.autoload?(name) && (mod.const_get(name) || true) rescue nil)
             if (const < Exception rescue false)
               color(:exception_constant, name)

data/lib/pry/commands/ls/formatter.rb

@@ -7,6 +7,7 @@ class Pry
       def initialize(_pry_)
         @_pry_ = _pry_
         @target = _pry_.current_context
+        @default_switch = nil
       end
 
       def write_out

data/lib/pry/commands/ls/jruby_hacks.rb

@@ -19,7 +19,7 @@ module Pry::Command::Ls::JRubyHacks
       m.name.sub(/\A(is|get|set)(?=[A-Z_])/, '').gsub(/[_?=]/, '').downcase
     end
 
-    grouped.map do |key, values|
+    grouped.flat_map do |key, values|
       values = values.sort_by do |m|
         rubbishness(m.name)
       end
@@ -28,7 +28,7 @@ module Pry::Command::Ls::JRubyHacks
       values.select do |x|
         (!found.any? { |y| x == y }) && found << x
       end
-    end.flatten(1)
+    end
   end
 
   # When removing jruby aliases, we want to keep the alias that is

data/lib/pry/commands/ls/self_methods.rb

@@ -11,6 +11,8 @@ class Pry
         super(_pry_)
         @interrogatee = interrogatee
         @no_user_opts = no_user_opts
+        @ppp_switch = opts[:ppp]
+        @jruby_switch = opts['all-java']
       end
 
       def output_self

data/lib/pry/commands/ls.rb

@@ -61,7 +61,9 @@ class Pry
       " " * 32 <<            "Constants that are pending autoload? are also shown (in yellow)"
       opt.on :i, :ivars,     "Show instance variables (in blue) and class variables (in bright blue)"
       opt.on :G, :grep,      "Filter output by regular expression", :argument => true
-
+      if Object.respond_to?(:deprecate_constant)
+        opt.on :d, :dconstants, "Show deprecated constants"
+      end
       if jruby?
         opt.on :J, "all-java", "Show all the aliases for methods from java (default is to show only prettiest)"
       end

data/lib/pry/commands/play.rb

@@ -12,7 +12,7 @@ class Pry
 
       play --lines 149..153   # assumes current context
       play -i 20 --lines 1..3 # assumes lines of the input expression at 20
-      play -o 4               # the output of of an expression at 4
+      play -o 4               # the output of an expression at 4
       play Pry#repl -l 1..-1  # play the contents of Pry#repl method
       play -e 2               # play from specified line until end of valid expression
       play hello.rb           # play a file
@@ -91,7 +91,7 @@ class Pry
     end
 
     def file_content
-      if default_file && File.exists?(default_file)
+      if default_file && File.exist?(default_file)
         @cc.restrict_to_lines(File.read(default_file), @cc.line_range)
       else
         raise CommandError, "File does not exist! File was: #{default_file.inspect}"

data/lib/pry/commands/reload_code.rb

@@ -31,7 +31,7 @@ class Pry
     end
 
     def reload_current_file
-      if !File.exists?(current_file)
+      if !File.exist?(current_file)
         raise CommandError, "Current file: #{current_file} cannot be found on disk!"
       end
 
@@ -49,7 +49,7 @@ class Pry
     def check_for_reloadability(code_object, identifier)
       if !code_object || !code_object.source_file
         raise CommandError, "Cannot locate #{identifier}!"
-      elsif !File.exists?(code_object.source_file)
+      elsif !File.exist?(code_object.source_file)
         raise CommandError,
           "Cannot reload #{identifier} as it has no associated file on disk. " \
           "File found was: #{code_object.source_file}"

data/lib/pry/commands/ri.rb

@@ -14,6 +14,10 @@ class Pry
     BANNER
 
     def process(spec)
+      unless spec
+        return output.puts "Please provide a class, module, or method name (e.g: ri Array#push)"
+      end
+
       # Lazily load RI
       require 'rdoc/ri/driver'