pry 0.10.4 → 0.13.0

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
@@ -35,22 +47,28 @@ 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)
+
+        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
+
       # Activate the plugin (require the gem - enables/loads the
       # plugin immediately at point of call, even if plugin is
       # disabled)
       # 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
 
@@ -60,6 +78,16 @@ class Pry
 
       alias active? active
       alias enabled? enabled
+
+      def supported?
+        pry_version = Gem::Version.new(VERSION)
+        spec.dependencies.each do |dependency|
+          if dependency.name == "pry"
+            return dependency.requirement.satisfied_by?(pry_version)
+          end
+        end
+        true
+      end
     end
 
     def initialize
@@ -68,11 +96,12 @@ class Pry
 
     # 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|
+      gem_list.each do |gem|
         next if gem.name !~ PRY_PLUGIN_PREFIX
+
         plugin_name = gem.name.split('-', 2).last
-        @plugins << Plugin.new(plugin_name, gem.name, gem, true) if !gem_located?(gem.name)
+        plugin = Plugin.new(plugin_name, gem.name, gem, false)
+        @plugins << plugin.tap(&:enable!) if plugin.supported? && !plugin_located?(plugin)
       end
       @plugins
     end
@@ -95,9 +124,16 @@ class Pry
     end
 
     private
-    def gem_located?(gem_name)
-      @plugins.any? { |plugin| plugin.gem_name == gem_name }
+
+    def plugin_located?(plugin)
+      @plugins.any? { |existing| existing.gem_name == plugin.gem_name }
     end
-  end
 
+    def gem_list
+      Gem.refresh
+      return Gem::Specification if Gem::Specification.respond_to?(:each)
+
+      Gem.source_index.find_name('')
+    end
+  end
 end

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