pry 0.8.4pre1-java → 0.9.0pre1-java

data/lib/pry/helpers/command_helpers.rb

@@ -5,15 +5,6 @@ class Pry
 
       module_function
 
-      def try_to_load_pry_doc
-
-        # YARD crashes on rbx, so do not require it
-        if !Object.const_defined?(:RUBY_ENGINE) || RUBY_ENGINE !~ /rbx/
-          require "pry-doc"
-        end
-      rescue LoadError
-      end
-
       def meth_name_from_binding(b)
         meth_name = b.eval('__method__')
         if [:__script__, nil, :__binding__, :__binding_impl__].include?(meth_name)
@@ -23,29 +14,16 @@ class Pry
         end
       end
 
-      def add_line_numbers(lines, start_line)
-        line_array = lines.each_line.to_a
-        line_array.each_with_index.map do |line, idx|
-          adjusted_index = idx + start_line
-          if Pry.color
-            cindex = CodeRay.scan("#{adjusted_index}", :ruby).term
-            "#{cindex}: #{line}"
-          else
-            "#{idx}: #{line}"
-          end
-        end.join
-      end
-
       # if start_line is not false then add line numbers starting with start_line
-      def render_output(should_flood, start_line, doc)
+      def render_output(should_flood, start_line, text)
         if start_line
-          doc = add_line_numbers(doc, start_line)
+          text = Pry::Helpers::Text.with_line_numbers text, start_line
         end
 
         if should_flood
-          output.puts doc
+          output.puts text
         else
-          stagger_output(doc)
+          stagger_output(text)
         end
       end
 
@@ -55,31 +33,74 @@ class Pry
       end
 
       def check_for_dynamically_defined_method(meth)
-        if is_a_dynamically_defined_method?(meth)
+        file, _ = meth.source_location
+        if file =~ /(\(.*\))|<.*>/ && file != Pry.eval_path
           raise "Cannot retrieve source for dynamically defined method."
         end
       end
 
-      def check_for_dynamically_defined_method(meth)
-        file, _ = meth.source_location
-        if file =~ /(\(.*\))|<.*>/
-          raise "Cannot retrieve source for dynamically defined method."
+      ########### RBX HELPERS #############
+      def rbx_core?(meth)
+        defined?(RUBY_ENGINE) &&
+          RUBY_ENGINE =~ /rbx/ &&
+          meth.source_location &&
+          meth.source_location.first.start_with?("kernel")
+      end
+
+      def rvm_ruby?(path)
+        !!(path =~ /\.rvm/)
+      end
+
+      def rbx_core_code_for(meth)
+        rbx_core_code_or_doc_for(meth, :code)
+      end
+
+      def rbx_core_doc_for(meth)
+        rbx_core_code_or_doc_for(meth, :doc)
+      end
+
+      def rbx_core_code_or_doc_for(meth, code_or_doc)
+        path_line = rbx_core_path_line_for(meth)
+
+        case code_or_doc
+        when :code
+          MethodSource.source_helper(path_line)
+        when :doc
+          MethodSource.comment_helper(path_line)
         end
       end
 
-      def remove_first_word(text)
-        text.split.drop(1).join(' ')
+      def rbx_core_path_line_for(meth)
+        if rvm_ruby?(Rubinius::BIN_PATH)
+          rvm_rbx_core_path_line_for(meth)
+        else
+          std_rbx_core_path_line_for(meth)
+        end
       end
 
-      # turn off color for duration of block
-      def no_color(&block)
-        old_color_state = Pry.color
-        Pry.color = false
-        yield
-      ensure
-        Pry.color = old_color_state
+      def std_rbx_core_path_line_for(meth)
+        file_name = File.join(Rubinius::BIN_PATH, "..", meth.source_location.first)
+        raise "Cannot find rbx core source" if !File.exists?(file_name)
+
+        start_line = meth.source_location.last
+
+        [file_name, start_line]
       end
 
+      def rvm_rbx_core_path_line_for(meth)
+        ruby_name = File.dirname(Rubinius::BIN_PATH).split("/").last
+        source_path = File.join(File.dirname(File.dirname(File.dirname(Rubinius::BIN_PATH))),  "src", ruby_name)
+
+        file_name = File.join(source_path, meth.source_location.first)
+        raise "Cannot find rbx core source" if !File.exists?(file_name)
+
+        start_line = meth.source_location.last
+
+        [file_name, start_line]
+      end
+
+      ######### END RBX HELPERS ###############
+
       def code_and_code_type_for(meth)
         case code_type = code_type_for(meth)
         when nil
@@ -88,8 +109,18 @@ class Pry
           code = Pry::MethodInfo.info_for(meth).source
           code = strip_comments_from_c_code(code)
         when :ruby
-          code = strip_leading_whitespace(meth.source)
-          set_file_and_dir_locals(meth.source_location.first)
+          if meth.source_location.first == Pry.eval_path
+            start_line = meth.source_location.last
+            p = Pry.new(:input => StringIO.new(Pry.line_buffer[start_line..-1].join)).r(target)
+            code = strip_leading_whitespace(p)
+          else
+            if rbx_core?(meth)
+              code = strip_leading_whitespace(rbx_core_code_for(meth))
+            else
+              code = strip_leading_whitespace(meth.source)
+            end
+          end
+          set_file_and_dir_locals(path_line_for(meth).first)
         end
 
         [code, code_type]
@@ -102,9 +133,12 @@ class Pry
         when :c
           doc = Pry::MethodInfo.info_for(meth).docstring
         when :ruby
-          doc = meth.comment
-          doc = strip_leading_hash_and_whitespace_from_ruby_comments(doc)
-          set_file_and_dir_locals(meth.source_location.first)
+          if rbx_core?(meth)
+            doc = strip_leading_hash_and_whitespace_from_ruby_comments(rbx_core_doc_for(meth))
+          else
+            doc = strip_leading_hash_and_whitespace_from_ruby_comments(meth.comment)
+          end
+          set_file_and_dir_locals(path_line_for(meth).first)
         end
 
         [doc, code_type]
@@ -144,15 +178,23 @@ class Pry
         end
       end
 
+      def path_line_for(meth)
+        if rbx_core?(meth)
+          rbx_core_path_line_for(meth)
+        else
+          meth.source_location
+        end
+      end
+
       def make_header(meth, code_type, content)
-        num_lines = "Number of lines: #{bold(content.each_line.count.to_s)}"
+        num_lines = "Number of lines: #{Pry::Helpers::Text.bold(content.each_line.count.to_s)}"
         case code_type
         when :ruby
-          file, line = meth.source_location
-          "\n#{bold('From:')} #{file} @ line #{line}:\n#{num_lines}\n\n"
+          file, line = path_line_for(meth)
+          "\n#{Pry::Helpers::Text.bold('From:')} #{file} @ line #{line}:\n#{num_lines}\n\n"
         else
           file = Pry::MethodInfo.info_for(meth).file
-          "\n#{bold('From:')} #{file} in Ruby Core (C Method):\n#{num_lines}\n\n"
+          "\n#{Pry::Helpers::Text.bold('From:')} #{file} in Ruby Core (C Method):\n#{num_lines}\n\n"
         end
       end
 
@@ -161,7 +203,7 @@ class Pry
       end
 
       def should_use_pry_doc?(meth)
-        Pry.has_pry_doc && is_a_c_method?(meth)
+        Pry.config.has_pry_doc && is_a_c_method?(meth)
       end
 
       def code_type_for(meth)
@@ -232,16 +274,11 @@ class Pry
          normalized_line_number(end_line, lines_array.size)]
       end
 
-      # documentation related helpers
-      def strip_color_codes(str)
-        str.gsub(/\e\[.*?(\d)+m/, '')
-      end
-
       def process_rdoc(comment, code_type)
         comment = comment.dup
         comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { Pry.color ? CodeRay.scan($1, code_type).term : $1 }.
-          gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { Pry.color ? "\e[32m#{$1}\e[0m": $1 }.
-          gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { Pry.color ? "\e[34m#{$1}\e[0m" : $1 }.
+          gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { Pry.color ? "\e[1m#{$1}\e[0m": $1 }.
+          gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { Pry.color ? "\e[1m#{$1}\e[0m" : $1 }.
           gsub(/\B\+(\w*?)\+\B/)  { Pry.color ? "\e[32m#{$1}\e[0m": $1 }.
           gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { Pry.color ? CodeRay.scan($1, code_type).term : $1 }.
           gsub(/`(?:\s*\n)?(.*?)\s*`/) { Pry.color ? CodeRay.scan($1, code_type).term : $1 }
@@ -251,7 +288,7 @@ class Pry
         in_tag_block = nil
         output = comment.lines.map do |v|
           if in_tag_block && v !~ /^\S/
-            strip_color_codes(strip_color_codes(v))
+            Pry::Helpers::Text.strip_color Pry::Helpers::Text.strip_color(v)
           elsif in_tag_block
             in_tag_block = false
             v
@@ -288,7 +325,7 @@ class Pry
       end
 
       def strip_comments_from_c_code(code)
-        code.sub /\A\s*\/\*.*?\*\/\s*/m, ''
+        code.sub(/\A\s*\/\*.*?\*\/\s*/m, '')
       end
 
       def prompt(message, options="Yn")

data/lib/pry/helpers/text.rb

@@ -0,0 +1,83 @@
+class Pry
+  module Helpers
+
+    # The methods defined on {Text} are available to custom commands via {Pry::CommandContext#text}.  
+    module Text
+ 
+      COLORS = 
+      {
+        "black"   => 0,
+        "red"     => 1,
+        "green"   => 2,
+        "yellow"  => 3,
+        "blue"    => 4,
+        "purple"  => 5,
+        "magenta" => 5,
+        "cyan"    => 6,
+        "white"   => 7
+      }
+
+      class << self
+        
+        COLORS.each_pair do |color, value|
+          define_method color do |text|
+            Pry.color ? "\033[0;#{30+value}m#{text}\033[0m" : text.to_s
+          end
+
+          define_method "bright_#{color}" do |text|
+            Pry.color ? "\033[1;#{30+value}m#{text}\033[0m" : text.to_s
+          end
+        end
+
+        alias_method :grey, :bright_black
+        alias_method :gray, :bright_black
+        
+
+        # Remove any color codes from _text_.
+        #
+        # @param  [String, #to_s] text
+        # @return [String] _text_ stripped of any color codes.
+        def strip_color text
+          text.to_s.gsub(/\e\[.*?(\d)+m/ , '')
+        end
+
+        # Returns _text_ as bold text for use on a terminal.  
+        # _Pry.color_ must be true for this method to perform any transformations.
+        #
+        # @param [String, #to_s] text
+        # @return [String] _text_ 
+        def bold text
+          Pry.color ? "\e[1m#{text}\e[0m" : text.to_s
+        end
+
+        # Executes _block_ with _Pry.color_ set to false.
+        #
+        # @param [Proc]
+        # @return [void]
+        def no_color &block
+          boolean = Pry.color
+          Pry.color = false
+          yield
+        ensure
+          Pry.color = boolean
+        end
+
+        # Returns _text_ in a numbered list, beginning at _offset_.
+        # 
+        # @param  [#each_line] text
+        # @param  [Fixnum] offset
+        # @return [String]
+        def with_line_numbers text, offset
+          lines = text.each_line.to_a
+          lines.each_with_index.map do |line, index|
+            adjusted_index = index + offset
+            "#{self.blue adjusted_index}: #{line}"
+          end.join
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/pry/plugins.rb

@@ -0,0 +1,79 @@
+class Pry
+  class PluginManager
+    PRY_PLUGIN_PREFIX = /^pry-/
+    PluginNotFound = Class.new(LoadError)
+
+    MessageSink = Object.new.tap { |o| def o.method_missing(*args) end }
+
+    class Plugin
+      attr_accessor :name, :gem_name, :enabled, :active
+
+      def initialize(name, gem_name, enabled)
+        @name, @gem_name, @enabled = name, gem_name, enabled
+      end
+
+      # Disable a plugin.
+      def disable!
+        self.enabled = false
+      end
+
+      # Enable a plugin.
+      def enable!
+        self.enabled = true
+      end
+
+      # Activate the plugin (require the gem).
+      def activate!
+        begin
+          require gem_name
+        rescue LoadError
+          raise PluginNotFound, "The plugin '#{gem_name}' was not found!"
+        end
+        self.active = true
+        self.enabled = true
+      end
+
+      alias active? active
+      alias enabled? enabled
+    end
+
+    def initialize
+      @plugins = []
+    end
+
+    # Find all installed Pry plugins and store them in an internal array.
+    def locate_plugins
+      Gem.refresh
+      (Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')).each do |gem|
+        next if gem.name !~ PRY_PLUGIN_PREFIX
+        plugin_name = gem.name.split('-', 2).last
+        @plugins << Plugin.new(plugin_name, gem.name, true) if !gem_located?(gem.name)
+      end
+      @plugins
+    end
+
+    # @return [Hash] A hash with all plugin names (minus the 'pry-') as
+    #   keys and Plugin objects as values.
+    def plugins
+      h = Pry.config.plugins.strict_loading ? {} : Hash.new { MessageSink }
+      @plugins.each do |plugin|
+        h[plugin.name] = plugin
+      end
+      h
+    end
+
+    # Require all enabled plugins, disabled plugins are skipped.
+    def load_plugins
+      @plugins.each do |plugin|
+        plugin.activate! if plugin.enabled?
+      end
+    end
+
+    private
+    def gem_located?(gem_name)
+      @plugins.any? { |plugin| plugin.gem_name == gem_name }
+    end
+  end
+
+end
+

data/lib/pry/pry_class.rb

@@ -1,3 +1,7 @@
+require 'ostruct'
+require 'forwardable'
+require 'pry/config'
+
 # @author John Mair (banisterfiend)
 class Pry
 
@@ -6,6 +10,13 @@ class Pry
 
   # class accessors
   class << self
+    extend Forwardable
+
+    # convenience method
+    def self.delegate_accessors(delagatee, *names)
+      def_delegators delagatee, *names
+      def_delegators delagatee, *names.map { |v| "#{v}=" }
+    end
 
     # Get nesting data.
     # This method should not need to be accessed directly.
@@ -27,41 +38,6 @@ class Pry
     # @return [Pry] The active Pry instance.
     attr_accessor :active_instance
 
-    # Get/Set the object to use for input by default by all Pry instances.
-    # @return [#readline] The object to use for input by default by all
-    #   Pry instances.
-    attr_accessor :input
-
-    # Get/Set the object to use for output by default by all Pry instances.
-    # @return [#puts] The object to use for output by default by all
-    #   Pry instances.
-    attr_accessor :output
-
-    # Get/Set the object to use for commands by default by all Pry instances.
-    # @return [Pry::CommandBase] The object to use for commands by default by all
-    #   Pry instances.
-    attr_accessor :commands
-
-    # Get/Set the Proc to use for printing by default by all Pry
-    # instances.
-    # This is the 'print' component of the REPL.
-    # @return [Proc] The Proc to use for printing by default by all
-    #   Pry instances.
-    attr_accessor :print
-
-    # @return [Proc] The Proc to use for printing exceptions by default by all
-    #   Pry instances.
-    attr_accessor :exception_handler
-
-    # Get/Set the Hash that defines Pry hooks used by default by all Pry
-    # instances.
-    # @return [Hash] The hooks used by default by all Pry instances.
-    # @example
-    #   Pry.hooks :before_session => proc { puts "hello" },
-    #     :after_session => proc { puts "goodbye" }
-    attr_accessor :hooks
-
-
     # Get/Set the Proc that defines extra Readline completions (on top
     # of the ones defined for IRB).
     # @return [Proc] The Proc that defines extra Readline completions (on top
@@ -69,49 +45,31 @@ class Pry
     #   Pry.custom_completions = proc { Dir.entries('.') }
     attr_accessor :custom_completions
 
-    # Get the array of Procs to be used for the prompts by default by
-    # all Pry instances.
-    # @return [Array<Proc>] The array of Procs to be used for the
-    #   prompts by default by all Pry instances.
-    attr_accessor :prompt
-
     # Value returned by last executed Pry command.
     # @return [Object] The command value
     attr_accessor :cmd_ret_value
 
-    # Determines whether colored output is enabled.
-    # @return [Boolean]
-    attr_accessor :color
+    # @return [Fixnum] The current input line.
+    attr_accessor :current_line
 
-    # Determines whether paging (of long blocks of text) is enabled.
-    # @return [Boolean]
-    attr_accessor :pager
+    # @return [Array] The Array of evaluated expressions.
+    attr_accessor :line_buffer
 
-    # Determines whether the rc file (~/.pryrc) should be loaded.
-    # @return [Boolean]
-    attr_accessor :should_load_rc
+    # @return [String] The __FILE__ for the `eval()`. Should be "(pry)"
+    #   by default.
+    attr_accessor :eval_path
 
-    # Set to true if Pry is invoked from command line using `pry` executable
-    # @return [Boolean]
+    # @return [OpenStruct] Return Pry's config object.
+    attr_accessor :config
+
+    # @return [Boolean] Whether Pry was activated from the command line.
     attr_accessor :cli
 
-    # Set to true if the pry-doc extension is loaded.
-    # @return [Boolean]
-    attr_accessor :has_pry_doc
-
-    # The default editor to use. Defaults to $EDITOR or nano if
-    # $EDITOR is not defined.
-    # If `editor` is a String then that string is used as the shell
-    # command to invoke the editor. If `editor` is callable (e.g a
-    # Proc) then `file` and `line` are passed in as parameters and the
-    # return value of that callable invocation is used as the exact
-    # shell command to invoke the editor.
-    # @example String
-    #   Pry.editor = "emacsclient"
-    # @example Callable
-    #   Pry.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
-    # @return [String, #call]
-    attr_accessor :editor
+    # plugin forwardables
+    def_delegators :@plugin_manager, :plugins, :load_plugins, :locate_plugins
+
+    delegate_accessors :@config, :input, :output, :commands, :prompt, :print, :exception_handler,
+      :hooks, :color, :pager, :editor
   end
 
   # Load the rc files given in the `Pry::RC_FILES` array.
@@ -133,9 +91,15 @@ class Pry
   # @example
   #   Pry.start(Object.new, :input => MyInput.new)
   def self.start(target=TOPLEVEL_BINDING, options={})
-    if should_load_rc && !@rc_loaded
-      load_rc
-      @rc_loaded = true
+    if initial_session?
+      # note these have to be loaded here rather than in pry_instance as
+      # we only want them loaded once per entire Pry lifetime, not
+      # multiple times per each new session (i.e in debugging)
+      load_rc if Pry.config.should_load_rc
+      load_plugins if Pry.config.plugins.enabled
+      load_history if Pry.config.history.load
+
+      @initial_session = false
     end
 
     new(options).repl(target)
@@ -146,12 +110,7 @@ class Pry
   # @param obj The object to view.
   # @return [String] The string representation of `obj`.
   def self.view(obj)
-    case obj
-    when String, Hash, Array, Symbol, Exception, nil
-      obj.inspect
-    else
-      obj.to_s
-    end
+    obj.inspect
 
   rescue NoMethodError
     "unknown"
@@ -170,10 +129,20 @@ class Pry
     end
   end
 
+  # Load Readline history if required.
+  def self.load_history
+    history_file = File.expand_path(Pry.config.history.file)
+    Readline::HISTORY.push(*File.readlines(history_file).map(&:chomp)) if File.exists?(history_file)
+  end
+
+  # @return [Boolean] Whether this is the first time a Pry session has
+  #   been started since loading the Pry class.
+  def self.initial_session?
+    @initial_session
+  end
+
   # Run a Pry command from outside a session. The commands available are
   # those referenced by `Pry.commands` (the default command set).
-  # Command output is suppresed by default, this is because the return
-  # value (if there is one) is likely to be more useful.
   # @param [String] arg_string The Pry command (including arguments,
   #   if any).
   # @param [Hash] options Optional named parameters.
@@ -181,35 +150,24 @@ class Pry
   # @option options [Object, Binding] :context The object context to run the
   #   command under. Defaults to `TOPLEVEL_BINDING` (main).
   # @option options [Boolean] :show_output Whether to show command
-  #   output. Defaults to false.
+  #   output. Defaults to true.
   # @example Run at top-level with no output.
   #   Pry.run_command "ls"
   # @example Run under Pry class, returning only public methods.
   #   Pry.run_command "ls -m", :context => Pry
   # @example Display command output.
   #   Pry.run_command "ls -av", :show_output => true
-  def self.run_command(arg_string, options={})
-    name, arg_string = arg_string.split(/\s+/, 2)
-    arg_string = "" if !arg_string
-
+  def self.run_command(command_string, options={})
     options = {
       :context => TOPLEVEL_BINDING,
-      :show_output => false,
+      :show_output => true,
       :output => Pry.output,
       :commands => Pry.commands
     }.merge!(options)
 
-    null_output = StringIO.new
+    output = options[:show_output] ? options[:output] : StringIO.new
 
-    context = CommandContext.new
-    commands = options[:commands]
-
-    context.opts        = {}
-    context.output      = options[:show_output] ? options[:output] : null_output
-    context.target      = Pry.binding_for(options[:context])
-    context.command_set = commands
-
-    commands.run_command(context, name, *Shellwords.shellwords(arg_string))
+    Pry.new(:output => output, :input => StringIO.new(command_string), :commands => options[:commands]).rep(options[:context])
   end
 
   def self.default_editor_for_platform
@@ -220,25 +178,50 @@ class Pry
     end
   end
 
+  def self.set_config_defaults
+    config.input = Readline
+    config.output = $stdout
+    config.commands = Pry::Commands
+    config.prompt = DEFAULT_PROMPT
+    config.print = DEFAULT_PRINT
+    config.exception_handler = DEFAULT_EXCEPTION_HANDLER
+    config.hooks = DEFAULT_HOOKS
+    config.color = true
+    config.pager = true
+    config.editor = default_editor_for_platform
+    config.should_load_rc = true
+
+    config.plugins ||= OpenStruct.new
+    config.plugins.enabled = true
+    config.plugins.strict_loading = true
+
+    config.history ||= OpenStruct.new
+    config.history.save = true
+    config.history.load = true
+    config.history.file = File.expand_path("~/.pry_history")
+  end
+
   # Set all the configurable options back to their default values
   def self.reset_defaults
-    @input = Readline
-    @output = $stdout
-    @commands = Pry::Commands
-    @prompt = DEFAULT_PROMPT
-    @print = DEFAULT_PRINT
-    @exception_handler = DEFAULT_EXCEPTION_HANDLER
-    @hooks = DEFAULT_HOOKS
-    @custom_completions = DEFAULT_CUSTOM_COMPLETIONS
-    @color = true
-    @pager = true
-    @should_load_rc = true
-    @rc_loaded = false
-    @cli = false
-    @editor = default_editor_for_platform
+    set_config_defaults
+
+    @initial_session = true
+
+    self.custom_completions = DEFAULT_CUSTOM_COMPLETIONS
+    self.cli = false
+    self.current_line = 0
+    self.line_buffer = []
+    self.eval_path = "(pry)"
   end
 
-  self.reset_defaults
+  # Basic initialization.
+  def self.init
+    @plugin_manager ||= PluginManager.new
+
+    self.config ||= Config.new
+    reset_defaults
+    locate_plugins
+  end
 
   @nesting = []
   def @nesting.level
@@ -269,3 +252,5 @@ class Pry
     end
   end
 end
+
+Pry.init