pry 0.10.3 → 0.14.2

data/lib/pry/prompt.rb

@@ -1,26 +1,214 @@
-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."
-    }
- }
+# frozen_string_literal: true
+
+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 for adding and implementing custom prompts.
+  #
+  # @example Registering a new Pry prompt
+  #   Pry::Prompt.add(
+  #     :ipython,
+  #     'IPython-like prompt', [':', '...:']
+  #   ) do |_context, _nesting, pry_instance, sep|
+  #     sep == ':' ? "In [#{pry_instance.input_ring.count}]: " : '   ...: '
+  #   end
+  #
+  #   # Produces:
+  #   # In [3]: def foo
+  #   #    ...:   puts 'foo'
+  #   #    ...: end
+  #   # => :foo
+  #   # In [4]:
+  #
+  # @example Manually instantiating the Prompt class
+  #   prompt_procs = [
+  #     proc { '#{rand(1)}>" },
+  #     proc { "#{('a'..'z').to_a.sample}*" }
+  #   ]
+  #   prompt = Pry::Prompt.new(
+  #     :random,
+  #     'Random number or letter prompt.',
+  #     prompt_procs
+  #   )
+  #   prompt.wait_proc.call(...) #=>
+  #   prompt.incomplete_proc.call(...)
+  #
+  # @since v0.11.0
+  # @api public
+  class Prompt
+    # 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]
+      #
+      # @param [Symbol] name The name of the prompt you want to access
+      # @return [Hash{Symbol=>Object}]
+      # @since v0.12.0
+      def [](name)
+        @prompts[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] 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_instance, sep]
+      # @yieldparam context [Object] the context where Pry is currently in
+      # @yieldparam nesting [Integer] whether the context is nested
+      # @yieldparam pry_instance [Pry] the Pry instance
+      # @yieldparam separator [String] separator string
+      # @return [nil]
+      # @raise [ArgumentError] if the size of `separators` is not 2
+      # @raise [ArgumentError] if `prompt_name` is already occupied
+      # @since v0.12.0
+      def add(name, description = '', separators = %w[> *])
+        name = name.to_s
+
+        unless separators.size == 2
+          raise ArgumentError, "separators size must be 2, given #{separators.size}"
+        end
+
+        if @prompts.key?(name)
+          raise ArgumentError, "the '#{name}' prompt was already added"
+        end
+
+        @prompts[name] = new(
+          name,
+          description,
+          separators.map do |sep|
+            proc do |context, nesting, pry_instance|
+              yield(context, nesting, pry_instance, sep)
+            end
+          end
+        )
+
+        nil
+      end
+    end
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :description
+
+    # @return [Array<Proc>] the array of procs that hold
+    #   `[wait_proc, incomplete_proc]`
+    attr_reader :prompt_procs
+
+    # @param [String] name
+    # @param [String] description
+    # @param [Array<Proc>] prompt_procs
+    def initialize(name, description, prompt_procs)
+      @name = name
+      @description = description
+      @prompt_procs = prompt_procs
+    end
+
+    # @return [Proc] the proc which builds the wait prompt (`>`)
+    def wait_proc
+      @prompt_procs.first
+    end
+
+    # @return [Proc] the proc which builds the prompt when in the middle of an
+    #   expression such as open method, etc. (`*`)
+    def incomplete_proc
+      @prompt_procs.last
+    end
+
+    # @deprecated Use a `Pry::Prompt` instance directly
+    def [](key)
+      key = key.to_s
+      if %w[name description].include?(key)
+        Pry::Warning.warn(
+          "`Pry::Prompt[:#{@name}][:#{key}]` is deprecated. " \
+          "Use `#{self.class}##{key}` instead"
+        )
+        public_send(key)
+      elsif key.to_s == 'value'
+        Pry::Warning.warn(
+          "`#{self.class}[:#{@name}][:value]` is deprecated. Use " \
+          "`#{self.class}#prompt_procs` instead or an instance of " \
+          "`#{self.class}` directly"
+        )
+        @prompt_procs
+      end
+    end
+
+    add(
+      :default,
+      "The default Pry prompt. Includes information about the current expression \n" \
+      "number, evaluation context, and nesting level, plus a reminder that you're \n" \
+      'using Pry.'
+    ) do |context, nesting, pry_instance, sep|
+      format(
+        "[%<in_count>s] %<name>s(%<context>s)%<nesting>s%<separator>s ",
+        in_count: pry_instance.input_ring.count,
+        name: pry_instance.config.prompt_name,
+        context: Pry.view_clip(context),
+        nesting: (nesting > 0 ? ":#{nesting}" : ''),
+        separator: sep
+      )
+    end
+
+    add(
+      :simple,
+      "A simple `>>`.",
+      ['>> ', ' | ']
+    ) do |_, _, _, sep|
+      sep
+    end
+
+    add(
+      :nav,
+      "A prompt that displays the binding stack as a path and includes information \n" \
+      "about #{Helpers::Text.bold('_in_')} and #{Helpers::Text.bold('_out_')}.",
+      %w[> *]
+    ) do |_context, _nesting, pry_instance, sep|
+      tree = pry_instance.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_instance.input_ring.count,
+        name: pry_instance.config.prompt_name,
+        tree: tree.join(' / '),
+        stack_size: pry_instance.binding_stack.size - 1,
+        separator: sep
+      )
+    end
+
+    add(
+      :shell,
+      'A prompt that displays `$PWD` as you change it.',
+      %w[$ *]
+    ) do |context, _nesting, pry_instance, sep|
+      format(
+        "%<name>s %<context>s:%<pwd>s %<separator>s ",
+        name: pry_instance.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'
+# frozen_string_literal: true
+
+require 'stringio'
+require 'pathname'
+
 class Pry
+  LOCAL_RC_FILE = "./.pryrc".freeze
 
-  HOME_RC_FILE = ENV["PRYRC"] || "~/.pryrc"
-  LOCAL_RC_FILE = "./.pryrc"
+  # @return [Boolean] true if this Ruby supports safe levels and tainting,
+  #  to guard against using deprecated or unsupported features
+  HAS_SAFE_LEVEL = (
+    RUBY_ENGINE == 'ruby' &&
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7')
+  )
 
   class << self
-    extend Forwardable
+    extend Pry::Forwardable
     attr_accessor :custom_completions
     attr_accessor :current_line
     attr_accessor :line_buffer
@@ -14,23 +23,28 @@ class Pry
     attr_accessor :quiet
     attr_accessor :last_internal_error
     attr_accessor :config
-    attr_writer :history
-
-    def_delegators :@plugin_manager, :plugins, :load_plugins, :locate_plugins
 
-    extend Pry::Config::Convenience
-    config_shortcut(*Pry::Config.shortcuts)
-
-    def prompt=(value)
-      config.prompt = value
-    end
-
-    def prompt
-      config.prompt
-    end
-
-    def history
-      @history ||= History.new
+    def_delegators(
+      :@config, :input, :input=, :output, :output=, :commands,
+      :commands=, :print, :print=, :exception_handler, :exception_handler=,
+      :hooks, :hooks=, :color, :color=, :pager, :pager=, :editor, :editor=,
+      :memory_size, :memory_size=, :extra_sticky_locals, :extra_sticky_locals=,
+      :prompt, :prompt=, :history, :history=
+    )
+
+    #
+    # @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
 
@@ -47,7 +61,7 @@ class Pry
   #  Returns a value store for an instance of Pry running on the current thread.
   #
   def self.current
-    Thread.current[:__pry__] ||= Pry::Config.from_hash({}, nil)
+    Thread.current[:__pry__] ||= {}
   end
 
   # Load the given file in the context of `Pry.toplevel_binding`
@@ -58,8 +72,8 @@ class Pry
     puts "Error loading #{file}: #{e}\n#{e.backtrace.first}"
   end
 
-  # Load HOME_RC_FILE and LOCAL_RC_FILE if appropriate
-  # This method can also be used to reload the files if they have changed.
+  # Load RC files if appropriate This method can also be used to reload the
+  # files if they have changed.
   def self.load_rc_files
     rc_files_to_load.each do |file|
       critical_section do
@@ -71,17 +85,15 @@ class Pry
   # Load the local RC file (./.pryrc)
   def self.rc_files_to_load
     files = []
-    files << HOME_RC_FILE if Pry.config.should_load_rc
+    files << Pry.config.rc_file if Pry.config.rc_file && Pry.config.should_load_rc
     files << LOCAL_RC_FILE if Pry.config.should_load_local_rc
     files.map { |file| real_path_to(file) }.compact.uniq
   end
 
   # 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,63 +107,76 @@ 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
-    begin
-      require 'win32console'
-      # The mswin and mingw versions of pry require win32console, so this should
-      # only fail on jruby (where win32console doesn't work).
-      # Instead we'll recommend ansicon, which does.
-    rescue LoadError
-      warn <<-WARNING if Pry.config.windows_console_warning
+    require 'win32console'
+    # The mswin and mingw versions of pry require win32console, so this should
+    # only fail on jruby (where win32console doesn't work).
+    # Instead we'll recommend ansicon, which does.
+  rescue LoadError
+    warn <<-WARNING if Pry.config.windows_console_warning
 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.
-      WARNING
-    end
+you can add "Pry.config.windows_console_warning = false" to your pryrc.
+    WARNING
   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
+    # note these have to be loaded here rather than in _pry_ as
     # we only want them loaded once per entire Pry lifetime.
     load_rc_files
-    load_plugins if Pry.config.should_load_plugins
+  end
+
+  def self.final_session_setup
+    return if @session_finalized
+
+    @session_finalized = true
     load_requires if Pry.config.should_load_requires
-    load_history if Pry.config.history.should_load
+    load_history if Pry.config.history_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={})
-    return if ENV['DISABLE_PRY']
+  def self.start(target = nil, options = {})
+    return if Pry::Env['DISABLE_PRY']
+    if Pry::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?
       output.puts "ERROR: Pry started inside Pry."
-      output.puts "This can happen if you have a binding.pry inside a #to_s or #inspect function."
+      output.puts "This can happen if you have a binding.pry inside a #to_s " \
+                  "or #inspect function."
+      return
+    end
+
+    unless mutex_available?
+      output.puts "ERROR: Unable to obtain mutex lock."
+      output.puts "This can happen if binding.pry is called from a signal handler"
       return
     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?
@@ -175,7 +200,6 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   # Execute the file through the REPL loop, non-interactively.
   # @param [String] file_name File name to load through the REPL.
   def self.load_file_through_repl(file_name)
-    require "pry/repl_file_loader"
     REPLFileLoader.new(file_name).load
   end
 
@@ -201,17 +225,23 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
   def self.view_clip(obj, options = {})
     max = options.fetch :max_length, 60
     id = options.fetch :id, false
-    if obj.kind_of?(Module) && obj.name.to_s != "" && obj.name.to_s.length <= max
+    if obj.is_a?(Module) && obj.name.to_s != "" && obj.name.to_s.length <= max
       obj.name.to_s
     elsif Pry.main == obj
-      # special-case to support jruby.
-      # fixed as of https://github.com/jruby/jruby/commit/d365ebd309cf9df3dde28f5eb36ea97056e0c039
+      # Special-case to support jruby. 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
+      # rubocop:disable Style/CaseEquality
+    elsif Pry.config.prompt_safe_contexts.any? { |v| v === obj } &&
+          obj.inspect.length <= max
+      # rubocop:enable Style/CaseEquality
+
       obj.inspect
+    elsif id
+      format("#<#{obj.class}:0x%<id>x>", id: obj.object_id << 1)
     else
-      id == true ? "#<#{obj.class}:0x%x>" % (obj.object_id << 1) : "#<#{obj.class}>"
+      "#<#{obj.class}>"
     end
   rescue RescuableException
     "unknown"
@@ -233,7 +263,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,32 +274,21 @@ 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
-  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
-    end
+    nil
   end
 
   def self.auto_resize!
@@ -281,23 +300,23 @@ you can add "Pry.config.windows_console_warning = false" to your .pryrc.
     end
 
     if Readline::VERSION =~ /edit/i
-      warn <<-EOT
+      warn(<<-WARN)
 Readline version #{Readline::VERSION} detected - will not auto_resize! correctly.
   For the fix, use GNU Readline instead:
-  https://github.com/guard/guard/wiki/Add-proper-Readline-support-to-Ruby-on-Mac-OS-X
-      EOT
+  https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X
+      WARN
       return
     end
 
     trap :WINCH do
       begin
-        Readline.set_screen_size(*Terminal.size!)
-      rescue => e
+        Readline.set_screen_size(*output.size)
+      rescue StandardError => e
         warn "\nPry.auto_resize!'s Readline.set_screen_size failed: #{e}"
       end
       begin
         Readline.refresh_line
-      rescue => e
+      rescue StandardError => e
         warn "\nPry.auto_resize!'s Readline.refresh_line failed: #{e}"
       end
     end
@@ -306,7 +325,9 @@ 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
-    self.config = Pry::Config.new Pry::Config::Default.new
+    @session_finalized = nil
+
+    self.config = Pry::Config.new
     self.cli = false
     self.current_line = 1
     self.line_buffer = [""]
@@ -315,9 +336,7 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
 
   # Basic initialization.
   def self.init
-    @plugin_manager ||= PluginManager.new
     reset_defaults
-    locate_plugins
   end
 
   # Return a `Binding` object for `target` or return `target` if it is
@@ -326,15 +345,10 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
   # @param [Object] target The object to get a `Binding` object for.
   # @return [Binding] The `Binding` object.
   def self.binding_for(target)
-    if Binding === target
-      target
-    else
-      if Pry.main == target
-        TOPLEVEL_BINDING
-      else
-        target.__binding__
-      end
-    end
+    return target if Binding === target # rubocop:disable Style/CaseEquality
+    return TOPLEVEL_BINDING if Pry.main == target
+
+    target.__binding__
   end
 
   def self.toplevel_binding
@@ -354,8 +368,8 @@ Readline version #{Readline::VERSION} detected - will not auto_resize! correctly
     @toplevel_binding
   end
 
-  def self.toplevel_binding=(binding)
-    @toplevel_binding = binding
+  class << self
+    attr_writer :toplevel_binding
   end
 
   def self.in_critical_section?
@@ -363,13 +377,20 @@ 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
+
+  def self.mutex_available?
+    Mutex.new.synchronize { true }
+  rescue ThreadError
+    false
+  end
+  private_class_method :mutex_available?
 end
 
 Pry.init