pry 0.11.3 → 0.12.0

data/lib/pry/method/disowned.rb

@@ -20,7 +20,7 @@ class Pry
       #
       # @param [Object] receiver
       # @param [String] method_name
-      def initialize(receiver, method_name, binding=nil)
+      def initialize(receiver, method_name)
         @receiver, @name = receiver, method_name
         @method = nil
       end
@@ -47,6 +47,7 @@ class Pry
       # Raise a more useful error message instead of trying to forward to nil.
       def method_missing(meth_name, *args, &block)
         raise "Cannot call '#{meth_name}' on an undef'd method." if method(:name).respond_to?(meth_name)
+
         Object.instance_method(:method_missing).bind(self).call(meth_name, *args, &block)
       end
     end

data/lib/pry/method/patcher.rb

@@ -94,7 +94,7 @@ class Pry
       def wrap_for_owner(source)
         Pry.current[:pry_owner] = method.owner
         owner_source = definition_for_owner(source)
-        visibility_fix = "#{method.visibility.to_s} #{method.name.to_sym.inspect}"
+        visibility_fix = "#{method.visibility} #{method.name.to_sym.inspect}"
         "Pry.current[:pry_owner].class_eval do; #{owner_source}\n#{visibility_fix}\nend"
       end
 
@@ -113,7 +113,7 @@ class Pry
       def wrap_for_nesting(source)
         nesting = Pry::Code.from_file(method.source_file).nesting_at(method.source_line)
 
-        (nesting + [source] + nesting.map{ "end" } + [""]).join(";")
+        (nesting + [source] + nesting.map { "end" } + [""]).join(";")
       rescue Pry::Indent::UnparseableNestingError
         source
       end

data/lib/pry/method/weird_method_locator.rb

@@ -1,6 +1,5 @@
 class Pry
   class Method
-
     # This class is responsible for locating the *real* `Pry::Method`
     # object captured by a binding.
     #
@@ -16,7 +15,6 @@ class Pry
     # Pry::Method and return it, or return nil if we fail.
     class WeirdMethodLocator
       class << self
-
         # Whether the given method object matches the associated binding.
         # If the method object does not match the binding, then it's
         # most likely not the method captured by the binding, and we
@@ -67,7 +65,7 @@ class Pry
 
       def skip_superclass_search?
         target_mod = @target.eval('self').class
-        target_mod.ancestors.take_while {|mod| mod != target_mod }.any?
+        target_mod.ancestors.take_while { |mod| mod != target_mod }.any?
       end
 
       def normal_method?(method)
@@ -100,8 +98,7 @@ class Pry
       # __FILE__ and __LINE__ the binding is at, we can hope to disambiguate these cases.
       #
       # This obviously won't work if the source is unavaiable for some reason, or if both
-      # methods have the same __FILE__ and __LINE__, or if we're in rbx where b.eval('__LINE__')
-      # is broken.
+      # methods have the same __FILE__ and __LINE__.
       #
       # @return [Pry::Method, nil] The Pry::Method representing the
       #   superclass method.
@@ -110,6 +107,7 @@ class Pry
         if skip_superclass_search?
           return guess
         end
+
         while guess
           # needs rescue if this is a Disowned method or a C method or something...
           # TODO: Fix up the exception handling so we don't need a bare rescue
@@ -122,9 +120,9 @@ class Pry
           end
         end
 
-        # Uhoh... none of the methods in the chain had the right __FILE__ and __LINE__
-        # This may be caused by rbx https://github.com/rubinius/rubinius/issues/953,
-        # or other unknown circumstances (TODO: we should warn the user when this happens)
+        # Uhoh... none of the methods in the chain had the right `__FILE__` and
+        # `__LINE__` due to unknown circumstances.
+        # TODO: we should warn the user when this happens.
         nil
       end
 
@@ -136,6 +134,7 @@ class Pry
       #   renamed method
       def find_renamed_method
         return if !valid_file?(target_file)
+
         alias_name = all_methods_for(target_self).find do |v|
           expanded_source_location(target_self.method(v).source_location) == renamed_method_source_location
         end

data/lib/pry/object_path.rb

@@ -28,7 +28,7 @@ class Pry
       stack   = @current_stack.dup
 
       begin
-        next_segment  = ""
+        next_segment = ""
 
         loop do
           # Scan for as long as we don't see a slash
@@ -74,9 +74,10 @@ class Pry
         "Exception: #{err.inspect}"
       ].join("\n")
 
-      raise CommandError.new(msg).tap { |e|
-        e.set_backtrace err.backtrace
-      }
+      command_error = CommandError.new(msg)
+      command_error.set_backtrace(err.backtrace)
+
+      raise command_error
     end
   end
 end

data/lib/pry/output.rb

@@ -8,8 +8,9 @@ class Pry::Output
 
   def puts(*objs)
     return print "\n" if objs.empty?
+
     objs.each do |obj|
-      if ary = Array.try_convert(obj)
+      if (ary = Array.try_convert(obj))
         puts(*ary)
       else
         print "#{obj.to_s.chomp}\n"
@@ -35,7 +36,7 @@ class Pry::Output
     @boxed_io.__send__(name, *args, &block)
   end
 
-  def respond_to_missing?(m, include_all=false)
+  def respond_to_missing?(m, include_all = false)
     @boxed_io.respond_to?(m, include_all)
   end
 

data/lib/pry/pager.rb

@@ -51,7 +51,7 @@ class Pry::Pager
   def best_available
     if !_pry_.config.pager
       NullPager.new(_pry_.output)
-    elsif !SystemPager.available? || Pry::Helpers::BaseHelpers.jruby?
+    elsif !SystemPager.available? || Helpers::Platform.jruby?
       SimplePager.new(_pry_.output)
     else
       SystemPager.new(_pry_.output)
@@ -111,6 +111,7 @@ class Pry::Pager
           @out.print "<page break> --- Press enter to continue " \
                      "( q<enter> to break ) --- <page break>\n"
           raise StopPaging if Readline.readline("").chomp == "q"
+
           @tracker.reset
         end
       end
@@ -138,8 +139,8 @@ class Pry::Pager
       if @system_pager.nil?
         @system_pager = begin
           pager_executable = default_pager.split(' ').first
-          if Pry::Helpers::BaseHelpers.windows? || Pry::Helpers::BaseHelpers.windows_ansi?
-            `where #{pager_executable}`
+          if Helpers::Platform.windows? || Helpers::Platform.windows_ansi?
+            `where /Q #{pager_executable}`
           else
             `which #{pager_executable}`
           end

data/lib/pry/platform.rb

@@ -1,93 +1,91 @@
-module Pry::Platform
-  extend self
+class Pry
+  module Platform
+    extend self
 
-  #
-  # @return [Boolean]
-  #  Returns true if Pry is running on Mac OSX.
-  #
-  # @note
-  #   Queries RbConfig::CONFIG['host_os'] with a best guess.
-  #
-  def mac_osx?
-    !!(RbConfig::CONFIG['host_os'] =~ /\Adarwin/i)
-  end
+    #
+    # @return [Boolean]
+    #  Returns true if Pry is running on Mac OSX.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def mac_osx?
+      !!(RbConfig::CONFIG['host_os'] =~ /\Adarwin/i)
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true if Pry is running on Linux.
-  #
-  # @note
-  #   Queries RbConfig::CONFIG['host_os'] with a best guess.
-  #
-  def linux?
-    !!(RbConfig::CONFIG['host_os'] =~ /linux/i)
-  end
+    #
+    # @return [Boolean]
+    #   Returns true if Pry is running on Linux.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def linux?
+      !!(RbConfig::CONFIG['host_os'] =~ /linux/i)
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true if Pry is running on Windows.
-  #
-  # @note
-  #   Queries RbConfig::CONFIG['host_os'] with a best guess.
-  #
-  def windows?
-    !!(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
-  end
+    #
+    # @return [Boolean]
+    #   Returns true if Pry is running on Windows.
+    #
+    # @note
+    #   Queries RbConfig::CONFIG['host_os'] with a best guess.
+    #
+    def windows?
+      !!(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/)
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is running on Windows with ANSI support.
-  #
-  def windows_ansi?
-    return false if not windows?
-    !!(defined?(Win32::Console) or ENV['ANSICON'] or mri_2?)
-  end
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is running on Windows with ANSI support.
+    #
+    def windows_ansi?
+      return false if not windows?
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from JRuby.
-  #
-  def jruby?
-    RbConfig::CONFIG['ruby_install_name'] == 'jruby'
-  end
+      !!(defined?(Win32::Console) or ENV['ANSICON'] or mri_2?)
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from JRuby in 1.9 mode.
-  #
-  def jruby_19?
-    jruby? and RbConfig::CONFIG['ruby_version'] == '1.9'
-  end
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from JRuby.
+    #
+    def jruby?
+      RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from Rubinius.
-  #
-  def rbx?
-    RbConfig::CONFIG['ruby_install_name'] == 'rbx'
-  end
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from JRuby in 1.9 mode.
+    #
+    def jruby_19?
+      jruby? and RbConfig::CONFIG['ruby_version'] == '1.9'
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from MRI (CRuby).
-  #
-  def mri?
-    RbConfig::CONFIG['ruby_install_name'] == 'ruby'
-  end
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI (CRuby).
+    #
+    def mri?
+      RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from MRI v1.9+ (CRuby).
-  #
-  def mri_19?
-    !!(mri? and RUBY_VERSION =~ /\A1\.9/)
-  end
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI v1.9+ (CRuby).
+    #
+    def mri_19?
+      !!(mri? and RUBY_VERSION =~ /\A1\.9/)
+    end
 
-  #
-  # @return [Boolean]
-  #   Returns true when Pry is being run from MRI v2+ (CRuby).
-  #
-  def mri_2?
-    !!(mri? and RUBY_VERSION =~ /\A2/)
+    #
+    # @return [Boolean]
+    #   Returns true when Pry is being run from MRI v2+ (CRuby).
+    #
+    def mri_2?
+      !!(mri? and RUBY_VERSION =~ /\A2/)
+    end
   end
+
+  # Not supported on MRI 2.2 and lower.
+  deprecate_constant(:Platform) if respond_to?(:deprecate_constant)
 end

data/lib/pry/plugins.rb

@@ -8,7 +8,7 @@ class Pry
         @name = name
       end
 
-      def method_missing(*args)
+      def method_missing(*_args)
         warn "Warning: The plugin '#{@name}' was not found! (no gem found)"
       end
     end
@@ -35,8 +35,12 @@ class Pry
       # Load the Command line options defined by this plugin (if they exist)
       def load_cli_options
         cli_options_file = File.join(spec.full_gem_path, "lib/#{spec.name}/cli.rb")
-        require cli_options_file if File.exist?(cli_options_file)
+        return unless File.exist?(cli_options_file)
+
+        cli_options_file = File.realpath(cli_options_file) if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.4.4")
+        require cli_options_file
       end
+
       # Activate the plugin (require the gem - enables/loads the
       # plugin immediately at point of call, even if plugin is
       # disabled)
@@ -80,6 +84,7 @@ class Pry
     def locate_plugins
       gem_list.each do |gem|
         next if gem.name !~ PRY_PLUGIN_PREFIX
+
         plugin_name = gem.name.split('-', 2).last
         plugin = Plugin.new(plugin_name, gem.name, gem, false)
         @plugins << plugin.tap(&:enable!) if plugin.supported? && !plugin_located?(plugin)
@@ -114,5 +119,4 @@ class Pry
       Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')
     end
   end
-
 end

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)
+        all[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