pry 0.10.3 → 0.12.2

data/lib/pry/prompt.rb

@@ -1,26 +1,145 @@
-class Pry::Prompt
-  MAP = {
-    "default" => {
-      value: Pry::DEFAULT_PROMPT,
-      description: "The default Pry prompt. Includes information about the\n" \
-                   "current expression number, evaluation context, and nesting\n" \
-                   "level, plus a reminder that you're using Pry."
-    },
-
-    "simple" => {
-      value: Pry::SIMPLE_PROMPT,
-      description: "A simple '>>'."
-    },
-
-    "nav" => {
-      value: Pry::NAV_PROMPT,
-      description: "A prompt that displays the binding stack as a path and\n" \
-                   "includes information about _in_ and _out_."
-    },
-
-    "none" => {
-      value: Pry::NO_PROMPT,
-      description: "Wave goodbye to the Pry prompt."
-    }
- }
+class Pry
+  # Prompt represents the Pry prompt, which can be used with Readline-like
+  # libraries. It defines a few default prompts (default prompt, simple prompt,
+  # etc) and also provides an API to add custom prompts.
+  #
+  # @example
+  #   Pry::Prompt.add(
+  #     :ipython,
+  #     'IPython-like prompt', [':', '...:']
+  #   ) do |_context, _nesting, _pry_, sep|
+  #     sep == ':' ? "In [#{_pry_.input_ring.count}]: " : '   ...: '
+  #   end
+  #
+  #   # Produces:
+  #   # In [3]: def foo
+  #   #    ...:   puts 'foo'
+  #   #    ...: end
+  #   # => :foo
+  #   # In [4]:
+  # @since v0.11.0
+  # @api public
+  module Prompt
+    # @return [String]
+    DEFAULT_NAME = 'pry'.freeze
+
+    # @return [Array<Object>] the list of objects that are known to have a
+    #   1-line #inspect output suitable for prompt
+    SAFE_CONTEXTS = [String, Numeric, Symbol, nil, true, false].freeze
+
+    # @deprecated Use {Pry::Prompt.add} instead.
+    MAP = {}
+    deprecate_constant(:MAP) if respond_to?(:deprecate_constant)
+
+    # A Hash that holds all prompts. The keys of the Hash are prompt
+    # names, the values are Hash instances of the format {:description, :value}.
+    @prompts = {}
+
+    class << self
+      # Retrieves a prompt.
+      #
+      # @example
+      #   Prompt[:my_prompt][:value]
+      #
+      # @param [Symbol] prompt_name The name of the prompt you want to access
+      # @return [Hash{Symbol=>Object}]
+      # @since v0.12.0
+      def [](prompt_name)
+        @prompts[prompt_name.to_s]
+      end
+
+      # @return [Hash{Symbol=>Hash}] the duplicate of the internal prompts hash
+      # @note Use this for read-only operations
+      # @since v0.12.0
+      def all
+        @prompts.dup
+      end
+
+      # Adds a new prompt to the prompt hash.
+      #
+      # @param [Symbol] prompt_name
+      # @param [String] description
+      # @param [Array<String>] separators The separators to differentiate
+      #   between prompt modes (default mode and class/method definition mode).
+      #   The Array *must* have a size of 2.
+      # @yield [context, nesting, _pry_, sep]
+      # @yieldparam context [Object] the context where Pry is currently in
+      # @yieldparam nesting [Integer] whether the context is nested
+      # @yieldparam _pry_ [Pry] the Pry instance
+      # @yieldparam separator [String] separator string
+      # @return [nil]
+      # @raise [ArgumentError] if the size of `separators` is not 2
+      # @since v0.12.0
+      def add(prompt_name, description = '', separators = %w[> *])
+        unless separators.size == 2
+          raise ArgumentError, "separators size must be 2, given #{separators.size}"
+        end
+
+        @prompts[prompt_name.to_s] = {
+          description: description,
+          value: separators.map do |sep|
+            proc { |context, nesting, _pry_| yield(context, nesting, _pry_, sep) }
+          end
+        }
+
+        nil
+      end
+
+      private
+
+      def prompt_name(name)
+        return name unless name.is_a?(Pry::Config::Lazy)
+
+        name.call
+      end
+    end
+
+    add(:default, <<DESC) do |context, nesting, _pry_, sep|
+The default Pry prompt. Includes information about the current expression
+number, evaluation context, and nesting level, plus a reminder that you're
+using Pry.
+DESC
+      format(
+        "[%<in_count>s] %<name>s(%<context>s)%<nesting>s%<separator>s ",
+        in_count: _pry_.input_ring.count,
+        name: prompt_name(_pry_.config.prompt_name),
+        context: Pry.view_clip(context),
+        nesting: (nesting > 0 ? ":#{nesting}" : ''),
+        separator: sep
+      )
+    end
+
+    add(:simple, "A simple `>>`.\n", ['>> ', ' | ']) do |_, _, _, sep|
+      sep
+    end
+
+    add(:nav, <<DESC, %w[> *]) do |context, nesting, _pry_, sep|
+A prompt that displays the binding stack as a path and includes information
+about #{Helpers::Text.bold('_in_')} and #{Helpers::Text.bold('_out_')}.
+DESC
+      tree = _pry_.binding_stack.map { |b| Pry.view_clip(b.eval('self')) }
+      format(
+        "[%<in_count>s] (%<name>s) %<tree>s: %<stack_size>s%<separator>s ",
+        in_count: _pry_.input_ring.count,
+        name: prompt_name(_pry_.config.prompt_name),
+        tree: tree.join(' / '),
+        stack_size: _pry_.binding_stack.size - 1,
+        separator: sep
+      )
+    end
+
+    add(:shell, <<DESC, %w[$ *]) do |context, nesting, _pry_, sep|
+A prompt that displays `$PWD` as you change it.
+DESC
+      format(
+        "%<name>s %<context>s:%<pwd>s %<separator>s ",
+        name: prompt_name(_pry_.config.prompt_name),
+        context: Pry.view_clip(context),
+        pwd: Dir.pwd,
+        separator: sep
+      )
+    end
+
+    add(:none, 'Wave goodbye to the Pry prompt.', Array.new(2)) { '' }
+  end
 end

data/lib/pry/pry_class.rb

@@ -1,11 +1,20 @@
-require 'pry/config'
 class Pry
-
-  HOME_RC_FILE = ENV["PRYRC"] || "~/.pryrc"
+  HOME_RC_FILE =
+    if ENV.key?('PRYRC')
+      ENV['PRYRC']
+    elsif File.exist?(File.expand_path('~/.pryrc'))
+      '~/.pryrc'
+    elsif ENV.key?('XDG_CONFIG_HOME') && ENV['XDG_CONFIG_HOME'] != ''
+      # See XDG Base Directory Specification at
+      # https://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
+      ENV['XDG_CONFIG_HOME'] + '/pry/pryrc'
+    else
+      '~/.config/pry/pryrc'
+    end
   LOCAL_RC_FILE = "./.pryrc"
 
   class << self
-    extend Forwardable
+    extend Pry::Forwardable
     attr_accessor :custom_completions
     attr_accessor :current_line
     attr_accessor :line_buffer
@@ -32,6 +41,21 @@ class Pry
     def history
       @history ||= History.new
     end
+
+    #
+    # @example
+    #  Pry.configure do |config|
+    #     config.eager_load! # optional
+    #     config.input =     # ..
+    #     config.foo = 2
+    #  end
+    #
+    # @yield [config]
+    #   Yields a block with {Pry.config} as its argument.
+    #
+    def configure
+      yield config
+    end
   end
 
   #
@@ -78,10 +102,8 @@ class Pry
 
   # Expand a file to its canonical name (following symlinks as appropriate)
   def self.real_path_to(file)
-    expanded = Pathname.new(File.expand_path(file)).realpath.to_s
-    # For rbx 1.9 mode [see rubinius issue #2165]
-    File.exist?(expanded) ? expanded : nil
-  rescue Errno::ENOENT
+    Pathname.new(File.expand_path(file)).realpath.to_s
+  rescue Errno::ENOENT, Errno::EACCES
     nil
   end
 
@@ -95,7 +117,7 @@ class Pry
   # Trap interrupts on jruby, and make them behave like MRI so we can
   # catch them.
   def self.load_traps
-    trap('INT'){ raise Interrupt }
+    trap('INT') { raise Interrupt }
   end
 
   def self.load_win32console
@@ -109,38 +131,47 @@ class Pry
 For a better Pry experience on Windows, please use ansicon:
   https://github.com/adoxa/ansicon
 If you use an alternative to ansicon and don't want to see this warning again,
-you can add "Pry.config.windows_console_warning = false" to your .pryrc.
+you can add "Pry.config.windows_console_warning = false" to your pryrc.
       WARNING
     end
   end
 
-  # Do basic setup for initial session.
-  # Including: loading .pryrc, loading plugins, loading requires, and
-  # loading history.
+  # Do basic setup for initial session including: loading pryrc, plugins,
+  # requires, and history.
   def self.initial_session_setup
     return unless initial_session?
+
     @initial_session = false
 
     # note these have to be loaded here rather than in pry_instance as
     # we only want them loaded once per entire Pry lifetime.
     load_rc_files
+  end
+
+  def self.final_session_setup
+    return if @session_finalized
+
+    @session_finalized = true
     load_plugins if Pry.config.should_load_plugins
     load_requires if Pry.config.should_load_requires
     load_history if Pry.config.history.should_load
     load_traps if Pry.config.should_trap_interrupts
-    load_win32console if Pry::Helpers::BaseHelpers.windows? && !Pry::Helpers::BaseHelpers.windows_ansi?
+    load_win32console if Helpers::Platform.windows? && !Helpers::Platform.windows_ansi?
   end
 
   # Start a Pry REPL.
-  # This method also loads `~/.pryrc` and `./.pryrc` as necessary the
-  # first time it is invoked.
+  # This method also loads `pryrc` as necessary the first time it is invoked.
   # @param [Object, Binding] target The receiver of the Pry session
   # @param [Hash] options
   # @option options (see Pry#initialize)
   # @example
   #   Pry.start(Object.new, :input => MyInput.new)
-  def self.start(target=nil, options={})
+  def self.start(target = nil, options = {})
     return if ENV['DISABLE_PRY']
+    if ENV['FAIL_PRY']
+      raise 'You have FAIL_PRY set to true, which results in Pry calls failing'
+    end
+
     options = options.to_hash
 
     if in_critical_section?
@@ -150,8 +181,8 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
     end
 
     options[:target] = Pry.binding_for(target || toplevel_binding)
-    options[:hooks] = Pry::Hooks.from_hash options.delete(:hooks) if options.key?(:hooks)
     initial_session_setup
+    final_session_setup
 
     # Unless we were given a backtrace, save the current one
     if options[:backtrace].nil?
@@ -208,7 +239,7 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
       # fixed as of https://github.com/jruby/jruby/commit/d365ebd309cf9df3dde28f5eb36ea97056e0c039
       # we can drop in the future.
       obj.to_s
-    elsif Pry.config.prompt_safe_objects.any? { |v| v === obj } && obj.inspect.length <= max
+    elsif Pry.config.prompt_safe_contexts.any? { |v| v === obj } && obj.inspect.length <= max
       obj.inspect
     else
       id == true ? "#<#{obj.class}:0x%x>" % (obj.object_id << 1) : "#<#{obj.class}>"
@@ -233,7 +264,7 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   # @param [String] command_string The Pry command (including arguments,
   #   if any).
   # @param [Hash] options Optional named parameters.
-  # @return [Object] The return value of the Pry command.
+  # @return [nil]
   # @option options [Object, Binding] :target The object to run the
   #   command under. Defaults to `TOPLEVEL_BINDING` (main).
   # @option options [Boolean] :show_output Whether to show command
@@ -244,31 +275,30 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   #   Pry.run_command "ls -m", :target => Pry
   # @example Display command output.
   #   Pry.run_command "ls -av", :show_output => true
-  def self.run_command(command_string, options={})
+  def self.run_command(command_string, options = {})
     options = {
-      :target => TOPLEVEL_BINDING,
-      :show_output => true,
-      :output => Pry.config.output,
-      :commands => Pry.config.commands
+      target: TOPLEVEL_BINDING,
+      show_output: true,
+      output: Pry.config.output,
+      commands: Pry.config.commands
     }.merge!(options)
 
     # :context for compatibility with <= 0.9.11.4
     target = options[:context] || options[:target]
     output = options[:show_output] ? options[:output] : StringIO.new
 
-    pry = Pry.new(:output   => output, :target   => target, :commands => options[:commands])
+    pry = Pry.new(output: output, target: target, commands: options[:commands])
     pry.eval command_string
+    nil
   end
 
   def self.default_editor_for_platform
     return ENV['VISUAL'] if ENV['VISUAL'] and not ENV['VISUAL'].empty?
     return ENV['EDITOR'] if ENV['EDITOR'] and not ENV['EDITOR'].empty?
-    if Helpers::BaseHelpers.windows?
-      'notepad'
-    else
-      %w(editor nano vi).detect do |editor|
-        system("which #{editor} > /dev/null 2>&1")
-      end
+    return 'notepad' if Helpers::Platform.windows?
+
+    %w(editor nano vi).detect do |editor|
+      system("which #{editor} > /dev/null 2>&1")
     end
   end
 
@@ -306,6 +336,8 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
   # Set all the configurable options back to their default values
   def self.reset_defaults
     @initial_session = true
+    @session_finalized = nil
+
     self.config = Pry::Config.new Pry::Config::Default.new
     self.cli = false
     self.current_line = 1
@@ -363,13 +395,31 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
     Thread.current[:pry_critical_section] > 0
   end
 
-  def self.critical_section(&block)
+  def self.critical_section
     Thread.current[:pry_critical_section] ||= 0
     Thread.current[:pry_critical_section] += 1
     yield
   ensure
     Thread.current[:pry_critical_section] -= 1
   end
+
+  # Wraps a block in a named block called `Pry::Config::Lazy`. This is used for
+  # dynamic config values, which are calculated every time
+  # {Pry::Config::Lazy#call} is called.
+  #
+  # @example
+  #   # pryrc
+  #   Pry.config.prompt_name = Pry.lazy { rand(100) }
+  #
+  #   # Session
+  #   [1] 96(main)>
+  #   [2] 19(main)>
+  #   [3] 80(main)>
+  #
+  # @return [#call]
+  def self.lazy(&block)
+    Pry::Config::Lazy.new(&block)
+  end
 end
 
 Pry.init