pry 0.12.0 → 0.14.0

data/bin/pry

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (C) John Mair (banisterfiend)
+# MIT license
+
 $0 = 'pry'
 
 require 'pry'

data/lib/pry.rb

@@ -1,132 +1,145 @@
-require 'pp'
-require 'pry/forwardable'
-require 'pry/input_lock'
-require 'pry/exceptions'
-require 'pry/platform'
-require 'pry/helpers/base_helpers'
-require 'pry/hooks'
+# frozen_string_literal: true
 
-class Pry
-  # The default hooks - display messages when beginning and ending Pry sessions.
-  DEFAULT_HOOKS = Pry::Hooks.new.add_hook(:before_session, :default) do |out, target, _pry_|
-    next if _pry_.quiet?
-
-    _pry_.run_command("whereami --quiet")
-  end
-
-  # The default print
-  DEFAULT_PRINT = proc do |output, value, _pry_|
-    _pry_.pager.open do |pager|
-      pager.print _pry_.config.output_prefix
-      Pry::ColorPrinter.pp(value, pager, Pry::Terminal.width! - 1)
-    end
-  end
-
-  # may be convenient when working with enormous objects and
-  # pretty_print is too slow
-  SIMPLE_PRINT = proc do |output, value|
-    begin
-      output.puts value.inspect
-    rescue RescuableException
-      output.puts "unknown"
-    end
-  end
-
-  # useful when playing with truly enormous objects
-  CLIPPED_PRINT = proc do |output, value|
-    output.puts Pry.view_clip(value, id: true)
-  end
-
-  # Will only show the first line of the backtrace
-  DEFAULT_EXCEPTION_HANDLER = proc do |output, exception, _|
-    if UserError === exception && SyntaxError === exception
-      output.puts "SyntaxError: #{exception.message.sub(/.*syntax error, */m, '')}"
-    else
-      output.puts "#{exception.class}: #{exception.message}"
-      output.puts "from #{exception.backtrace.first}"
-
-      if exception.respond_to? :cause
-        cause = exception.cause
-        while cause
-          output.puts "Caused by #{cause.class}: #{cause}\n"
-          output.puts "from #{cause.backtrace.first}"
-          cause = cause.cause
-        end
-      end
-    end
-  end
-
-  # Deal with the ^D key being pressed. Different behaviour in different cases:
-  #   1. In an expression behave like `!` command.
-  #   2. At top-level session behave like `exit` command.
-  #   3. In a nested session behave like `cd ..`.
-  DEFAULT_CONTROL_D_HANDLER = proc do |eval_string, _pry_|
-    if !eval_string.empty?
-      eval_string.replace('') # Clear input buffer.
-    elsif _pry_.binding_stack.one?
-      _pry_.binding_stack.clear
-      throw(:breakout)
-    else
-      # Otherwise, saves current binding stack as old stack and pops last
-      # binding out of binding stack (the old stack still has that binding).
-      _pry_.command_state["cd"] ||= Pry::Config.from_hash({}) # FIXME
-      _pry_.command_state['cd'].old_stack = _pry_.binding_stack.dup
-      _pry_.binding_stack.pop
-    end
-  end
-
-  DEFAULT_SYSTEM = proc do |output, cmd, _|
-    if !system(cmd)
-      output.puts "Error: there was a problem executing system command: #{cmd}"
-    end
-  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'
-require 'shellwords'
-require 'stringio'
-require 'strscan'
-require 'coderay'
-require 'pry/slop'
-require 'rbconfig'
-require 'tempfile'
-require 'pathname'
+# (C) John Mair (banisterfiend) 2016
+# MIT License
 
 require 'pry/version'
-require 'pry/repl'
-require 'pry/code'
-require 'pry/ring'
+require 'pry/last_exception'
+require 'pry/forwardable'
+
+require 'pry/helpers/base_helpers'
+require 'pry/helpers/documentation_helpers'
 require 'pry/helpers'
+
+require 'pry/basic_object'
+require 'pry/prompt'
 require 'pry/code_object'
-require 'pry/method'
-require 'pry/wrapped_module'
-require 'pry/history'
+require 'pry/exceptions'
+require 'pry/hooks'
+require 'pry/input_completer'
 require 'pry/command'
+require 'pry/class_command'
+require 'pry/block_command'
 require 'pry/command_set'
-require 'pry/commands'
-require 'pry/plugins'
-require 'pry/core_extensions'
-require 'pry/basic_object'
-require 'pry/config/behavior'
-require 'pry/config/memoization'
-require 'pry/config/default'
-require 'pry/config/convenience'
+require 'pry/syntax_highlighter'
+require 'pry/editor'
+require 'pry/history'
+require 'pry/color_printer'
+require 'pry/exception_handler'
+require 'pry/system_command_handler'
+require 'pry/control_d_handler'
+require 'pry/command_state'
+require 'pry/warning'
+require 'pry/env'
+
+Pry::Commands = Pry::CommandSet.new unless defined?(Pry::Commands)
+
+require 'pry/commands/ls/jruby_hacks'
+require 'pry/commands/ls/methods_helper'
+require 'pry/commands/ls/interrogatable'
+require 'pry/commands/ls/grep'
+require 'pry/commands/ls/formatter'
+require 'pry/commands/ls/globals'
+require 'pry/commands/ls/constants'
+require 'pry/commands/ls/methods'
+require 'pry/commands/ls/self_methods'
+require 'pry/commands/ls/instance_vars'
+require 'pry/commands/ls/local_names'
+require 'pry/commands/ls/local_vars'
+require 'pry/commands/ls/interrogatable'
+require 'pry/commands/ls/ls_entity'
+require 'pry/commands/ls/methods_helper'
+require 'pry/commands/ls'
+
+require 'pry/config/attributable'
+require 'pry/config/value'
+require 'pry/config/memoized_value'
+require 'pry/config/lazy_value'
 require 'pry/config'
+
 require 'pry/pry_class'
 require 'pry/pry_instance'
-require 'pry/cli'
-require 'pry/color_printer'
+require 'pry/inspector'
 require 'pry/pager'
-require 'pry/terminal'
-require 'pry/editor'
-require 'pry/rubygem'
-require "pry/indent"
-require "pry/last_exception"
-require "pry/prompt"
-require "pry/inspector"
+require 'pry/indent'
 require 'pry/object_path'
 require 'pry/output'
+require 'pry/input_lock'
+require 'pry/repl'
+require 'pry/code'
+require 'pry/ring'
+require 'pry/method'
+
+require 'pry/wrapped_module'
+require 'pry/wrapped_module/candidate'
+
+require 'pry/slop'
+require 'pry/cli'
+require 'pry/core_extensions'
+require 'pry/repl_file_loader'
+
+require 'pry/code/loc'
+require 'pry/code/code_range'
+require 'pry/code/code_file'
+
+require 'pry/method/weird_method_locator'
+require 'pry/method/disowned'
+require 'pry/method/patcher'
+
+require 'pry/commands/amend_line'
+require 'pry/commands/bang'
+require 'pry/commands/bang_pry'
+
+require 'pry/commands/cat'
+require 'pry/commands/cat/abstract_formatter.rb'
+require 'pry/commands/cat/input_expression_formatter.rb'
+require 'pry/commands/cat/exception_formatter.rb'
+require 'pry/commands/cat/file_formatter.rb'
+
+require 'pry/commands/cd'
+require 'pry/commands/change_inspector'
+require 'pry/commands/change_prompt'
+require 'pry/commands/clear_screen'
+require 'pry/commands/code_collector'
+require 'pry/commands/disable_pry'
+require 'pry/commands/easter_eggs'
+
+require 'pry/commands/edit'
+require 'pry/commands/edit/exception_patcher'
+require 'pry/commands/edit/file_and_line_locator'
+
+require 'pry/commands/exit'
+require 'pry/commands/exit_all'
+require 'pry/commands/exit_program'
+require 'pry/commands/find_method'
+require 'pry/commands/fix_indent'
+require 'pry/commands/help'
+require 'pry/commands/hist'
+require 'pry/commands/import_set'
+require 'pry/commands/jump_to'
+require 'pry/commands/list_inspectors'
+
+require 'pry/commands/nesting'
+require 'pry/commands/play'
+require 'pry/commands/pry_backtrace'
+require 'pry/commands/pry_version'
+require 'pry/commands/raise_up'
+require 'pry/commands/reload_code'
+require 'pry/commands/reset'
+require 'pry/commands/ri'
+require 'pry/commands/save_file'
+require 'pry/commands/shell_command'
+require 'pry/commands/shell_mode'
+require 'pry/commands/show_info'
+require 'pry/commands/show_doc'
+require 'pry/commands/show_input'
+require 'pry/commands/show_source'
+require 'pry/commands/stat'
+require 'pry/commands/switch_to'
+require 'pry/commands/toggle_color'
+
+require 'pry/commands/watch_expression'
+require 'pry/commands/watch_expression/expression.rb'
+
+require 'pry/commands/whereami'
+require 'pry/commands/wtf'

data/lib/pry/basic_object.rb

@@ -1,6 +1,10 @@
-class Pry::BasicObject < BasicObject
-  [:Kernel, :Pry].each do |constant|
-    const_set constant, ::Object.const_get(constant)
+# frozen_string_literal: true
+
+class Pry
+  class BasicObject < BasicObject
+    [:Kernel, :File, :Dir, :LoadError, :ENV, :Pry].each do |constant|
+      const_set constant, ::Object.const_get(constant)
+    end
+    include Kernel
   end
-  include Kernel
 end

data/lib/pry/block_command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Pry
+  # A super-class for Commands that are created with a single block.
+  #
+  # This class ensures that the block is called with the correct number of
+  # arguments and the right context.
+  #
+  # Create subclasses using {Pry::CommandSet#command}.
+  class BlockCommand < Command
+    # Call the block that was registered with this command.
+    # @param [Array<String>] args The arguments passed
+    # @return [Object] The return value of the block
+    def call(*args)
+      instance_exec(*normalize_method_args(block, args), &block)
+    end
+
+    def help
+      "#{command_options[:listing].to_s.ljust(18)} #{description}"
+    end
+  end
+end

data/lib/pry/class_command.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+class Pry
+  # A super-class of Commands with structure.
+  #
+  # 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#create_command}, and override the
+  # `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.
+  class ClassCommand < Command
+    class << self
+      # Ensure that subclasses inherit the options, description and
+      # match from a ClassCommand super class.
+      def inherited(klass)
+        klass.match match
+        klass.description description
+        klass.command_options options
+      end
+
+      def source
+        source_object.source
+      end
+
+      def doc
+        new.help
+      end
+
+      def source_location
+        source_object.source_location
+      end
+
+      def source_file
+        source_object.source_file
+      end
+      alias file source_file
+
+      def source_line
+        source_object.source_line
+      end
+      alias line source_line
+
+      private
+
+      # The object used to extract the source for the command.
+      #
+      # This should be a `Pry::Method(block)` for a command made with `create_command`
+      # and a `Pry::WrappedModule(self)` for a command that's a standard class.
+      # @return [Pry::WrappedModule, Pry::Method]
+      def source_object
+        @source_object ||= if name =~ /^[A-Z]/
+                             Pry::WrappedModule(self)
+                           else
+                             Pry::Method(block)
+                           end
+      end
+    end
+
+    attr_accessor :opts
+    attr_accessor :args
+
+    # Set up `opts` and `args`, and then call `process`.
+    #
+    # This method will display help if necessary.
+    #
+    # @param [Array<String>] args The arguments passed
+    # @return [Object] The return value of `process` or VOID_VALUE
+    def call(*args)
+      setup
+
+      self.opts = slop
+      self.args = opts.parse!(args)
+
+      if opts.present?(:help)
+        output.puts slop.help
+        void
+      else
+        process(*normalize_method_args(method(:process), args))
+      end
+    end
+
+    # Return the help generated by Pry::Slop for this command.
+    def help
+      slop.help
+    end
+
+    # Return an instance of Pry::Slop that can parse either subcommands or the
+    # options that this command accepts.
+    def slop
+      Pry::Slop.new do |opt|
+        opt.banner(unindent(self.class.banner))
+        subcommands(opt)
+        options(opt)
+        opt.on :h, :help, 'Show this message.'
+      end
+    end
+
+    # Generate shell completions
+    # @param [String] search  The line typed so far
+    # @return [Array<String>]  the words to complete
+    def complete(search)
+      slop.flat_map do |opt|
+        [opt.long && "--#{opt.long} " || opt.short && "-#{opt.short}"]
+      end.compact + super
+    end
+
+    # A method called just before `options(opt)` as part of `call`.
+    #
+    # This method can be used to set up any context your command needs to run,
+    # for example requiring gems, or setting default values for options.
+    #
+    # @example
+    #   def setup
+    #     require 'gist'
+    #     @action = :method
+    #   end
+    def setup; end
+
+    # 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.
+    #
+    # @example A minimal example
+    #   def subcommands(cmd)
+    #     cmd.command :download do |opt|
+    #       description 'Downloads a content from a server'
+    #
+    #       opt.on :verbose, 'Use verbose output'
+    #
+    #       run do |options, arguments|
+    #         ContentDownloader.download(options, arguments)
+    #       end
+    #     end
+    #   end
+    #
+    # @example Define the invokation block anywhere you want
+    #   def subcommands(cmd)
+    #     cmd.command :download do |opt|
+    #       description 'Downloads a content from a server'
+    #
+    #       opt.on :verbose, 'Use verbose output'
+    #     end
+    #   end
+    #
+    #   def process
+    #     # Perform calculations...
+    #     opts.fetch_command(:download).run do |options, arguments|
+    #       ContentDownloader.download(options, arguments)
+    #     end
+    #     # More calculations...
+    #   end
+    def subcommands(cmd); end
+
+    # 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.
+    # If you need to set up default values, use `setup` instead.
+    #
+    # @example
+    #  def options(opt)
+    #    opt.banner "Gists methods or classes"
+    #    opt.on(:c, :class, "gist a class") do
+    #      @action = :class
+    #    end
+    #  end
+    def options(opt); end
+
+    # The actual body of your command should go here.
+    #
+    # 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
+    # created with `:keep_retval => true`, in which case it is returned to the
+    # repl.
+    #
+    # @example
+    #   def process
+    #     if opts.present?(:class)
+    #       gist_class
+    #     else
+    #       gist_method
+    #     end
+    #   end
+    def process
+      raise CommandError, "command '#{command_name}' not implemented"
+    end
+  end
+end