pry 0.12.2 → 0.14.1

data/bin/pry

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (C) John Mair (banisterfiend)
+# MIT license
+
 $0 = 'pry'
 
 require 'pry'

data/lib/pry/basic_object.rb

@@ -1,6 +1,10 @@
-class Pry::BasicObject < BasicObject
-  [:Kernel, :Pry].each do |constant|
-    const_set constant, ::Object.const_get(constant)
+# frozen_string_literal: true
+
+class Pry
+  class BasicObject < BasicObject
+    [:Kernel, :File, :Dir, :LoadError, :ENV, :Pry].each do |constant|
+      const_set constant, ::Object.const_get(constant)
+    end
+    include Kernel
   end
-  include Kernel
 end

data/lib/pry/block_command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Pry
+  # A super-class for Commands that are created with a single block.
+  #
+  # This class ensures that the block is called with the correct number of
+  # arguments and the right context.
+  #
+  # Create subclasses using {Pry::CommandSet#command}.
+  class BlockCommand < Command
+    # Call the block that was registered with this command.
+    # @param [Array<String>] args The arguments passed
+    # @return [Object] The return value of the block
+    def call(*args)
+      instance_exec(*normalize_method_args(block, args), &block)
+    end
+
+    def help
+      "#{command_options[:listing].to_s.ljust(18)} #{description}"
+    end
+  end
+end

data/lib/pry/class_command.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+class Pry
+  # A super-class of Commands with structure.
+  #
+  # This class implements the bare-minimum functionality that a command should
+  # have, namely a --help switch, and then delegates actual processing to its
+  # subclasses.
+  #
+  # Create subclasses using {Pry::CommandSet#create_command}, and override the
+  # `options(opt)` method to set up an instance of Pry::Slop, and the `process`
+  # method to actually run the command. If necessary, you can also override
+  # `setup` which will be called before `options`, for example to require any
+  # gems your command needs to run, or to set up state.
+  class ClassCommand < Command
+    class << self
+      # Ensure that subclasses inherit the options, description and
+      # match from a ClassCommand super class.
+      def inherited(klass)
+        klass.match match
+        klass.description description
+        klass.command_options options
+      end
+
+      def source
+        source_object.source
+      end
+
+      def doc
+        new.help
+      end
+
+      def source_location
+        source_object.source_location
+      end
+
+      def source_file
+        source_object.source_file
+      end
+      alias file source_file
+
+      def source_line
+        source_object.source_line
+      end
+      alias line source_line
+
+      private
+
+      # The object used to extract the source for the command.
+      #
+      # This should be a `Pry::Method(block)` for a command made with `create_command`
+      # and a `Pry::WrappedModule(self)` for a command that's a standard class.
+      # @return [Pry::WrappedModule, Pry::Method]
+      def source_object
+        @source_object ||= if name =~ /^[A-Z]/
+                             Pry::WrappedModule(self)
+                           else
+                             Pry::Method(block)
+                           end
+      end
+    end
+
+    attr_accessor :opts
+    attr_accessor :args
+
+    # Set up `opts` and `args`, and then call `process`.
+    #
+    # This method will display help if necessary.
+    #
+    # @param [Array<String>] args The arguments passed
+    # @return [Object] The return value of `process` or VOID_VALUE
+    def call(*args)
+      setup
+
+      self.opts = slop
+      self.args = opts.parse!(args)
+
+      if opts.present?(:help)
+        output.puts slop.help
+        void
+      else
+        process(*normalize_method_args(method(:process), args))
+      end
+    end
+
+    # Return the help generated by Pry::Slop for this command.
+    def help
+      slop.help
+    end
+
+    # Return an instance of Pry::Slop that can parse either subcommands or the
+    # options that this command accepts.
+    def slop
+      Pry::Slop.new do |opt|
+        opt.banner(unindent(self.class.banner))
+        subcommands(opt)
+        options(opt)
+        opt.on :h, :help, 'Show this message.'
+      end
+    end
+
+    # Generate shell completions
+    # @param [String] search  The line typed so far
+    # @return [Array<String>]  the words to complete
+    def complete(search)
+      slop.flat_map do |opt|
+        [opt.long && "--#{opt.long} " || opt.short && "-#{opt.short}"]
+      end.compact + super
+    end
+
+    # A method called just before `options(opt)` as part of `call`.
+    #
+    # This method can be used to set up any context your command needs to run,
+    # for example requiring gems, or setting default values for options.
+    #
+    # @example
+    #   def setup
+    #     require 'gist'
+    #     @action = :method
+    #   end
+    def setup; end
+
+    # A method to setup Pry::Slop commands so it can parse the subcommands your
+    # command expects. If you need to set up default values, use `setup`
+    # instead.
+    #
+    # @example A minimal example
+    #   def subcommands(cmd)
+    #     cmd.command :download do |opt|
+    #       description 'Downloads a content from a server'
+    #
+    #       opt.on :verbose, 'Use verbose output'
+    #
+    #       run do |options, arguments|
+    #         ContentDownloader.download(options, arguments)
+    #       end
+    #     end
+    #   end
+    #
+    # @example Define the invokation block anywhere you want
+    #   def subcommands(cmd)
+    #     cmd.command :download do |opt|
+    #       description 'Downloads a content from a server'
+    #
+    #       opt.on :verbose, 'Use verbose output'
+    #     end
+    #   end
+    #
+    #   def process
+    #     # Perform calculations...
+    #     opts.fetch_command(:download).run do |options, arguments|
+    #       ContentDownloader.download(options, arguments)
+    #     end
+    #     # More calculations...
+    #   end
+    def subcommands(cmd); end
+
+    # A method to setup Pry::Slop so it can parse the options your command expects.
+    #
+    # @note Please don't do anything side-effecty in the main part of this
+    # method, as it may be called by Pry at any time for introspection reasons.
+    # If you need to set up default values, use `setup` instead.
+    #
+    # @example
+    #  def options(opt)
+    #    opt.banner "Gists methods or classes"
+    #    opt.on(:c, :class, "gist a class") do
+    #      @action = :class
+    #    end
+    #  end
+    def options(opt); end
+
+    # The actual body of your command should go here.
+    #
+    # The `opts` mehod can be called to get the options that Pry::Slop has passed,
+    # and `args` gives the remaining, unparsed arguments.
+    #
+    # The return value of this method is discarded unless the command was
+    # created with `:keep_retval => true`, in which case it is returned to the
+    # repl.
+    #
+    # @example
+    #   def process
+    #     if opts.present?(:class)
+    #       gist_class
+    #     else
+    #       gist_method
+    #     end
+    #   end
+    def process
+      raise CommandError, "command '#{command_name}' not implemented"
+    end
+  end
+end

data/lib/pry/cli.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
 class Pry
   # Manage the processing of command line options
   class CLI
@@ -31,15 +35,6 @@ class Pry
         self
       end
 
-      # Bring in options defined in plugins
-      def add_plugin_options
-        Pry.plugins.values.each do |plugin|
-          plugin.load_cli_options
-        end
-
-        self
-      end
-
       # Add a block responsible for processing parsed options.
       def add_option_processor(&block)
         self.option_processors ||= []
@@ -56,14 +51,22 @@ class Pry
 
       def parse_options(args = ARGV)
         unless options
-          raise NoOptionsError, "No command line options defined! Use Pry::CLI.add_options to add command line options."
+          raise NoOptionsError,
+                "No command line options defined! Use Pry::CLI.add_options to " \
+                "add command line options."
         end
 
-        self.input_args = args
+        @pass_argv = args.index { |cli_arg| %w[- --].include?(cli_arg) }
+        if @pass_argv
+          slop_args = args[0...@pass_argv]
+          self.input_args = args.replace(args[@pass_argv + 1..-1])
+        else
+          self.input_args = slop_args = args
+        end
 
         begin
           opts = Pry::Slop.parse!(
-            args,
+            slop_args,
             help: true,
             multiple_switches: false,
             strict: true,
@@ -72,22 +75,20 @@ class Pry
         rescue Pry::Slop::InvalidOptionError
           # Display help message on unknown switches and exit.
           puts Pry::Slop.new(&options)
-          exit
+          Kernel.exit
         end
 
         Pry.initial_session_setup
         Pry.final_session_setup
 
         # Option processors are optional.
-        if option_processors
-          option_processors.each { |processor| processor.call(opts) }
-        end
+        option_processors.each { |processor| processor.call(opts) } if option_processors
 
         opts
       end
 
       def start(opts)
-        exit if opts.help?
+        Kernel.exit if opts.help?
 
         # invoked via cli
         Pry.cli = true
@@ -95,16 +96,16 @@ class Pry
         # create the actual context
         if opts[:context]
           Pry.initial_session_setup
-          context = Pry.binding_for(eval(opts[:context]))
+          context = Pry.binding_for(eval(opts[:context])) # rubocop:disable Security/Eval
           Pry.final_session_setup
         else
           context = Pry.toplevel_binding
         end
 
-        if Pry::CLI.input_args.any? && Pry::CLI.input_args != ["pry"]
+        if !@pass_argv && Pry::CLI.input_args.any? && Pry::CLI.input_args != ["pry"]
           full_name = File.expand_path(Pry::CLI.input_args.first)
           Pry.load_file_through_repl(full_name)
-          exit
+          Kernel.exit
         end
 
         # Start the session (running any code passed with -e, if there is any)
@@ -116,27 +117,19 @@ class Pry
   end
 end
 
-# Bring in options defined by plugins
-Pry::Slop.new do
-  on "no-plugins" do
-    Pry.config.should_load_plugins = false
-  end
-end.parse(ARGV.dup)
-
-if Pry.config.should_load_plugins
-  Pry::CLI.add_plugin_options
-end
-
 # The default Pry command line options (before plugin options are included)
 Pry::CLI.add_options do
   banner(
     "Usage: pry [OPTIONS]\n" \
     "Start a Pry session.\n" \
-    "See http://pryrepl.org/ for more information.\n"
+    "See http://pryrepl.org/ for more information.\n" \
+    "Copyright (c) 2016 John Mair (banisterfiend)" \
   )
 
-  on :e, :exec=, "A line of code to execute in context before the session starts" do |input|
-    Pry.config.exec_string += "\n" if Pry.config.exec_string.length > 0
+  on(
+    :e, :exec=, "A line of code to execute in context before the session starts"
+  ) do |input|
+    Pry.config.exec_string += "\n" unless Pry.config.exec_string.empty?
     Pry.config.exec_string += input
   end
 
@@ -157,49 +150,45 @@ Pry::CLI.add_options do
     Pry.config.should_load_local_rc = false
   end
 
-  on :s, "select-plugin=", "Only load specified plugin (and no others)." do |plugin_name|
-    Pry.config.should_load_plugins = false
-    Pry.plugins[plugin_name].activate!
+  on :s, "select-plugin=", "Only load specified plugin (and no others)." do |_plugin_name|
+    warn "The --select-plugin option is deprecated and has no effect"
   end
 
-  on :d, "disable-plugin=", "Disable a specific plugin." do |plugin_name|
-    Pry.plugins[plugin_name].disable!
+  on :d, "disable-plugin=", "Disable a specific plugin." do |_plugin_name|
+    warn "The --disable-plugin option is deprecated and has no effect"
   end
 
   on "no-plugins", "Suppress loading of plugins." do
-    Pry.config.should_load_plugins = false
+    warn "The --no-plugins option is deprecated and has no effect"
   end
 
   on "plugins", "List installed plugins." do
-    puts "Installed Plugins:"
-    puts "--"
-    Pry.locate_plugins.each do |plugin|
-      puts "#{plugin.name}".ljust(18) << plugin.spec.summary
-    end
-    exit
+    warn "The --plugins option is deprecated and has no effect"
+    warn "Try using `gem list pry-`"
+    Kernel.exit
   end
 
   on "simple-prompt", "Enable simple prompt mode" do
-    Pry.config.prompt = Pry::Prompt[:simple][:value]
+    Pry.config.prompt = Pry::Prompt[:simple]
   end
 
   on "noprompt", "No prompt mode" do
-    Pry.config.prompt = Pry::Prompt[:none][:value]
+    Pry.config.prompt = Pry::Prompt[:none]
   end
 
   on :r, :require=, "`require` a Ruby script at startup" do |file|
     Pry.config.requires << file
   end
 
-  on :I=, "Add a path to the $LOAD_PATH", as: Array, delimiter: ":" do |load_path|
+  on(:I=, "Add a path to the $LOAD_PATH", as: Array, delimiter: ":") do |load_path|
     load_path.map! do |path|
-      /\A\.\// =~ path ? path : File.expand_path(path)
+      %r{\A\./} =~ path ? path : File.expand_path(path)
     end
 
     $LOAD_PATH.unshift(*load_path)
   end
 
-  on "gem", "Shorthand for -I./lib -rgemname" do |load_path|
+  on "gem", "Shorthand for -I./lib -rgemname" do |_load_path|
     $LOAD_PATH.unshift("./lib")
     Dir["./lib/*.rb"].each do |file|
       Pry.config.requires << file
@@ -208,11 +197,11 @@ Pry::CLI.add_options do
 
   on :v, :version, "Display the Pry version" do
     puts "Pry version #{Pry::VERSION} on Ruby #{RUBY_VERSION}"
-    exit
+    Kernel.exit
   end
 
-  on(:c, :context=,
-     "Start the session in the specified context. Equivalent to `context.pry` in a session.",
+  on :c, :context=,
+     "Start the session in the specified context. Equivalent to " \
+     "`context.pry` in a session.",
      default: "Pry.toplevel_binding"
-     )
 end

data/lib/pry/code/code_file.rb

@@ -1,29 +1,33 @@
+# frozen_string_literal: true
+
+require 'method_source'
+
 class Pry
   class CodeFile
-    DEFAULT_EXT = '.rb'
+    DEFAULT_EXT = '.rb'.freeze
 
     # List of all supported languages.
     # @return [Hash]
     EXTENSIONS = {
-      %w(.py)        => :python,
-      %w(.js)        => :javascript,
-      %w(.css)       => :css,
-      %w(.xml)       => :xml,
-      %w(.php)       => :php,
-      %w(.html)      => :html,
-      %w(.diff)      => :diff,
-      %w(.java)      => :java,
-      %w(.json)      => :json,
-      %w(.c .h)      => :c,
-      %w(.rhtml)     => :rhtml,
-      %w(.yaml .yml) => :yaml,
-      %w(.cpp .hpp .cc .h .cxx) => :cpp,
-      %w(.rb .ru .irbrc .gemspec .pryrc .rake) => :ruby,
-    }
+      %w[.py] => :python,
+      %w[.js] => :javascript,
+      %w[.css] => :css,
+      %w[.xml] => :xml,
+      %w[.php] => :php,
+      %w[.html] => :html,
+      %w[.diff] => :diff,
+      %w[.java] => :java,
+      %w[.json] => :json,
+      %w[.c .h] => :c,
+      %w[.rhtml] => :rhtml,
+      %w[.yaml .yml] => :yaml,
+      %w[.cpp .hpp .cc .h .cxx] => :cpp,
+      %w[.rb .ru .irbrc .gemspec .pryrc .rake] => :ruby
+    }.freeze
 
     FILES = {
-      %w(Gemfile Rakefile Guardfile Capfile) => :ruby
-    }
+      %w[Gemfile Rakefile Guardfile Capfile] => :ruby
+    }.freeze
 
     # Store the current working directory. This allows show-source etc. to work if
     # your process has changed directory since boot. [Issue #675]
@@ -58,16 +62,16 @@ class Pry
     #   readable for some reason.
     # @return [String] absolute path for the given `filename`.
     def abs_path
-      code_path.detect { |path| readable?(path) } or
-        raise MethodSource::SourceNotFoundError,
-              "Cannot open #{ @filename.inspect } for reading."
+      code_path.detect { |path| readable?(path) } ||
+        raise(MethodSource::SourceNotFoundError,
+              "Cannot open #{@filename.inspect} for reading.")
     end
 
     # @param [String] path
     # @return [Boolean] if the path, with or without the default ext,
     #   is a readable file then `true`, otherwise `false`.
     def readable?(path)
-      File.readable?(path) && !File.directory?(path) or
+      File.readable?(path) && !File.directory?(path) ||
         File.readable?(path << DEFAULT_EXT)
     end
 
@@ -80,8 +84,8 @@ class Pry
     # @param [String] filename
     # @param [Symbol] default (:unknown) the file type to assume if none could be
     #   detected.
-    # @return [Symbol, nil] The CodeRay type of a file from its extension, or
-    #   `nil` if `:unknown`.
+    # @return [Symbol, nil] The SyntaxHighlighter type of a file from its
+    #   extension, or `nil` if `:unknown`.
     def type_from_filename(filename, default = :unknown)
       _, @code_type = EXTENSIONS.find do |k, _|
         k.any? { |ext| ext == File.extname(filename) }

data/lib/pry/code/code_range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Pry
   class Code
     # Represents a range of lines in a code listing.
@@ -20,9 +22,9 @@ class Pry
 
       private
 
-      def start_line; @start_line; end
+      attr_reader :start_line
 
-      def end_line; @end_line; end
+      attr_reader :end_line
 
       # If `end_line` is equal to `nil`, then calculate it from the first
       # parameter, `start_line`. Otherwise, leave it as it is.

data/lib/pry/code/loc.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class Pry
   class Code
-    # Represents a line of code (which may, in fact, contain multiple lines if the
-    # entirety was eval'd as a single unit following the `edit` command).
+    # Represents a line of code (which may, in fact, contain multiple lines if
+    # the entirety was eval'd as a single unit following the `edit` command).
     #
     # A line of code is a tuple, which consists of a line and a line number. A
     # `LOC` object's state (namely, the line parameter) can be changed via
@@ -52,7 +54,7 @@ class Pry
       # @param [Symbol] code_type
       # @return [void]
       def colorize(code_type)
-        tuple[0] = CodeRay.scan(line, code_type).term
+        tuple[0] = SyntaxHighlighter.highlight(line, code_type)
       end
 
       # Prepends the line number `lineno` to the `line`.
@@ -61,9 +63,14 @@ class Pry
       # @return [void]
       def add_line_number(max_width = 0, color = false)
         padded = lineno.to_s.rjust(max_width)
-        colorized_lineno = color ? Pry::Helpers::BaseHelpers.colorize_code(padded) : padded
+        colorized_lineno =
+          if color
+            Pry::Helpers::BaseHelpers.colorize_code(padded)
+          else
+            padded
+          end
         properly_padded_line = handle_multiline_entries_from_edit_command(line, max_width)
-        tuple[0] = "#{ colorized_lineno }: #{ properly_padded_line }"
+        tuple[0] = "#{colorized_lineno}: #{properly_padded_line}"
       end
 
       # Prepends a marker "=>" or an empty marker to the +line+.
@@ -74,9 +81,9 @@ class Pry
       def add_marker(marker_lineno)
         tuple[0] =
           if lineno == marker_lineno
-            " => #{ line }"
+            " => #{line}"
           else
-            "    #{ line }"
+            "    #{line}"
           end
       end
 
@@ -85,7 +92,7 @@ class Pry
       # @param [Integer] distance
       # @return [void]
       def indent(distance)
-        tuple[0] = "#{ ' ' * distance }#{ line }"
+        tuple[0] = "#{' ' * distance}#{line}"
       end
 
       def handle_multiline_entries_from_edit_command(line, max_width)