pry 0.12.2 → 0.13.0

data/lib/pry/pager.rb

@@ -1,4 +1,4 @@
-require 'pry/terminal'
+# frozen_string_literal: true
 
 # A pager is an `IO`-like object that accepts text and either prints it
 # immediately, prints it one page at a time, or streams it to an external
@@ -8,10 +8,10 @@ class Pry
     class StopPaging < StandardError
     end
 
-    attr_reader :_pry_
+    attr_reader :pry_instance
 
-    def initialize(_pry_)
-      @_pry_ = _pry_
+    def initialize(pry_instance)
+      @pry_instance = pry_instance
     end
 
     # Send the given text through the best available pager (if
@@ -33,16 +33,18 @@ class Pry
     def open
       pager = best_available
       yield pager
-    rescue StopPaging
+    rescue StopPaging # rubocop:disable Lint/HandleExceptions
     ensure
       pager.close if pager
     end
 
     private
 
-    def enabled?; !!@enabled; end
+    def enabled?
+      !!@enabled
+    end
 
-    def output; @output; end
+    attr_reader :output
 
     # Return an instance of the "best" available pager class --
     # `SystemPager` if possible, `SimplePager` if `SystemPager` isn't
@@ -52,12 +54,12 @@ class Pry
     # you must rescue `Pry::Pager::StopPaging`. These requirements can be
     # avoided by using `.open` instead.
     def best_available
-      if !_pry_.config.pager
-        NullPager.new(_pry_.output)
+      if !pry_instance.config.pager
+        NullPager.new(pry_instance.output)
       elsif !SystemPager.available? || Helpers::Platform.jruby?
-        SimplePager.new(_pry_.output)
+        SimplePager.new(pry_instance.output)
       else
-        SystemPager.new(_pry_.output)
+        SystemPager.new(pry_instance.output)
       end
     end
 
@@ -81,17 +83,16 @@ class Pry
         @out.write str
       end
 
-      def close
-      end
+      def close; end
 
       private
 
       def height
-        @height ||= Pry::Terminal.height!
+        @height ||= @out.height
       end
 
       def width
-        @width ||= Pry::Terminal.width!
+        @width ||= @out.width
       end
     end
 
@@ -108,15 +109,15 @@ class Pry
           @out.print line
           @tracker.record line
 
-          if @tracker.page?
-            @out.print "\n"
-            @out.print "\e[0m"
-            @out.print "<page break> --- Press enter to continue " \
-                       "( q<enter> to break ) --- <page break>\n"
-            raise StopPaging if Readline.readline("").chomp == "q"
+          next unless @tracker.page?
 
-            @tracker.reset
-          end
+          @out.print "\n"
+          @out.print "\e[0m"
+          @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
     end
@@ -127,13 +128,11 @@ class Pry
     # buffered content.
     class SystemPager < NullPager
       def self.default_pager
-        pager = ENV["PAGER"] || ""
+        pager = Pry::Env['PAGER'] || ''
 
         # Default to less, and make sure less is being passed the correct
         # options
-        if pager.strip.empty? or pager =~ /^less\b/
-          pager = "less -R -F -X"
-        end
+        pager = "less -R -F -X" if pager.strip.empty? || pager =~ /^less\b/
 
         pager
       end
@@ -142,17 +141,18 @@ class Pry
 
       def self.available?
         if @system_pager.nil?
-          @system_pager = begin
-            pager_executable = default_pager.split(' ').first
-            if Helpers::Platform.windows? || Helpers::Platform.windows_ansi?
-              `where /Q #{pager_executable}`
-            else
-              `which #{pager_executable}`
+          @system_pager =
+            begin
+              pager_executable = default_pager.split(' ').first
+              if Helpers::Platform.windows? || Helpers::Platform.windows_ansi?
+                `where /Q #{pager_executable}`
+              else
+                `which #{pager_executable}`
+              end
+              $CHILD_STATUS.success?
+            rescue StandardError
+              false
             end
-            $?.success?
-          rescue
-            false
-          end
         else
           @system_pager
         end
@@ -170,11 +170,9 @@ class Pry
           write_to_pager str
         else
           @tracker.record str
-          @buffer << str
+          @buffer += str
 
-          if @tracker.page?
-            write_to_pager @buffer
-          end
+          write_to_pager @buffer if @tracker.page?
         end
       rescue Errno::EPIPE
         raise StopPaging
@@ -214,7 +212,8 @@ class Pry
     # `false` to `true` until we see a newline.
     class PageTracker
       def initialize(rows, cols)
-        @rows, @cols = rows, cols
+        @rows = rows
+        @cols = cols
         reset
       end
 

data/lib/pry/plugins.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
 class Pry
   class PluginManager
-    PRY_PLUGIN_PREFIX = /^pry-/
+    PRY_PLUGIN_PREFIX = /^pry-/.freeze
 
     # Placeholder when no associated gem found, displays warning
     class NoPlugin
@@ -8,8 +12,13 @@ class Pry
         @name = name
       end
 
-      def method_missing(*_args)
+      def method_missing(*)
         warn "Warning: The plugin '#{@name}' was not found! (no gem found)"
+        super
+      end
+
+      def respond_to_missing?(*)
+        false
       end
     end
 
@@ -17,7 +26,10 @@ class Pry
       attr_accessor :name, :gem_name, :enabled, :spec, :active
 
       def initialize(name, gem_name, spec, enabled)
-        @name, @gem_name, @enabled, @spec = name, gem_name, enabled, spec
+        @name = name
+        @gem_name = gem_name
+        @enabled = enabled
+        @spec = spec
       end
 
       # Disable a plugin. (prevents plugin from being loaded, cannot
@@ -37,7 +49,9 @@ class Pry
         cli_options_file = File.join(spec.full_gem_path, "lib/#{spec.name}/cli.rb")
         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")
+        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.4.4")
+          cli_options_file = File.realpath(cli_options_file)
+        end
         require cli_options_file
       end
 
@@ -47,14 +61,14 @@ class Pry
       # Does not reload plugin if it's already active.
       def activate!
         # Create the configuration object for the plugin.
-        Pry.config.send("#{gem_name.gsub('-', '_')}=", Pry::Config.from_hash({}))
+        Pry.config.send("#{gem_name.tr('-', '_')}=", OpenStruct.new)
 
         begin
-          require gem_name if !active?
+          require gem_name unless active?
         rescue LoadError => e
           warn "Found plugin #{gem_name}, but could not require '#{gem_name}'"
           warn e
-        rescue => e
+        rescue StandardError => e
           warn "require '#{gem_name}' # Failed, saying: #{e}"
         end
 
@@ -110,13 +124,16 @@ class Pry
     end
 
     private
+
     def plugin_located?(plugin)
       @plugins.any? { |existing| existing.gem_name == plugin.gem_name }
     end
 
     def gem_list
       Gem.refresh
-      Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')
+      return Gem::Specification if Gem::Specification.respond_to?(:each)
+
+      Gem.source_index.find_name('')
     end
   end
 end

data/lib/pry/prompt.rb

@@ -1,14 +1,16 @@
+# 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 to add custom prompts.
+  # etc) and also provides an API for adding and implementing custom prompts.
   #
-  # @example
+  # @example Registering a new Pry prompt
   #   Pry::Prompt.add(
   #     :ipython,
   #     'IPython-like prompt', [':', '...:']
-  #   ) do |_context, _nesting, _pry_, sep|
-  #     sep == ':' ? "In [#{_pry_.input_ring.count}]: " : '   ...: '
+  #   ) do |_context, _nesting, pry_instance, sep|
+  #     sep == ':' ? "In [#{pry_instance.input_ring.count}]: " : '   ...: '
   #   end
   #
   #   # Produces:
@@ -17,20 +19,23 @@ class Pry
   #   #    ...: 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
-  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)
-
+  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 = {}
@@ -39,13 +44,13 @@ class Pry
       # Retrieves a prompt.
       #
       # @example
-      #   Prompt[:my_prompt][:value]
+      #   Prompt[:my_prompt]
       #
-      # @param [Symbol] prompt_name The name of the prompt you want to access
+      # @param [Symbol] 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]
+      def [](name)
+        @prompts[name.to_s]
       end
 
       # @return [Hash{Symbol=>Hash}] the duplicate of the internal prompts hash
@@ -57,89 +62,153 @@ class Pry
 
       # Adds a new prompt to the prompt hash.
       #
-      # @param [Symbol] prompt_name
+      # @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_, sep]
+      # @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_ [Pry] the Pry instance
+      # @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(prompt_name, description = '', separators = %w[> *])
+      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
 
-        @prompts[prompt_name.to_s] = {
-          description: description,
-          value: separators.map do |sep|
-            proc { |context, nesting, _pry_| yield(context, nesting, _pry_, sep) }
+        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
 
-      private
+    # @return [String]
+    attr_reader :name
 
-      def prompt_name(name)
-        return name unless name.is_a?(Pry::Config::Lazy)
+    # @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
 
-        name.call
+    # @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, <<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
+    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_.input_ring.count,
-        name: prompt_name(_pry_.config.prompt_name),
+        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 `>>`.\n", ['>> ', ' | ']) do |_, _, _, sep|
+    add(
+      :simple,
+      "A simple `>>`.",
+      ['>> ', ' | ']
+    ) 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')) }
+    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_.input_ring.count,
-        name: prompt_name(_pry_.config.prompt_name),
+        in_count: pry_instance.input_ring.count,
+        name: pry_instance.config.prompt_name,
         tree: tree.join(' / '),
-        stack_size: _pry_.binding_stack.size - 1,
+        stack_size: pry_instance.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
+    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: prompt_name(_pry_.config.prompt_name),
+        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)) { '' }
+    add(
+      :none,
+      'Wave goodbye to the Pry prompt.',
+      Array.new(2)
+    ) { '' }
   end
 end