pry 0.9.12.2 → 0.14.2

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,24 +1,26 @@
+# frozen_string_literal: true
 
-class Pry
+require 'stringio'
 
+class Pry
   # Manage the processing of command line options
   class CLI
-
     NoOptionsError = Class.new(StandardError)
 
     class << self
-
       # @return [Proc] The Proc defining the valid command line options.
       attr_accessor :options
 
-      # @return [Array] The Procs that process the parsed options.
+      # @return [Array] The Procs that process the parsed options. Plugins can
+      #   utilize this facility in order to add and process their own Pry
+      #   options.
       attr_accessor :option_processors
 
       # @return [Array<String>] The input array of strings to process
       #   as CLI options.
       attr_accessor :input_args
 
-      # Add another set of CLI options (a Slop block)
+      # Add another set of CLI options (a Pry::Slop block)
       def add_options(&block)
         if options
           old_options = options
@@ -33,17 +35,8 @@ 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 process_options(&block)
+      def add_option_processor(&block)
         self.option_processors ||= []
         option_processors << block
 
@@ -56,54 +49,88 @@ class Pry
         self.option_processors = nil
       end
 
-      def parse_options(args=ARGV.dup)
+      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
+
+        @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
 
-        self.input_args = args
+        begin
+          opts = Pry::Slop.parse!(
+            slop_args,
+            help: true,
+            multiple_switches: false,
+            strict: true,
+            &options
+          )
+        rescue Pry::Slop::InvalidOptionError
+          # Display help message on unknown switches and exit.
+          puts Pry::Slop.new(&options)
+          Kernel.exit
+        end
 
-        opts = Slop.parse!(args, :help => true, :multiple_switches => false, &options)
+        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
 
-        self
+        opts
       end
 
-    end
+      def start(opts)
+        Kernel.exit if opts.help?
 
-    reset
-  end
-end
+        # invoked via cli
+        Pry.cli = true
 
+        # create the actual context
+        if opts[:context]
+          Pry.initial_session_setup
+          context = Pry.binding_for(eval(opts[:context])) # rubocop:disable Security/Eval
+          Pry.final_session_setup
+        else
+          context = Pry.toplevel_binding
+        end
 
-# String that is built to be executed on start (created by -e and -exec switches)
-exec_string = ""
+        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)
+          Kernel.exit
+        end
 
-# Bring in options defined by plugins
-Slop.new do
-  on "no-plugins" do
-    Pry.config.should_load_plugins = false
-  end
-end.parse(ARGV.dup)
+        # Start the session (running any code passed with -e, if there is any)
+        Pry.start(context, input: StringIO.new(Pry.config.exec_string))
+      end
+    end
 
-if Pry.config.should_load_plugins
-  Pry::CLI.add_plugin_options 
+    reset
+  end
 end
 
 # The default Pry command line options (before plugin options are included)
 Pry::CLI.add_options do
-  banner %{Usage: pry [OPTIONS]
-Start a Pry session.
-See: `https://github.com/pry` for more information.
-Copyright (c) 2013 John Mair (banisterfiend)
---
-}
-  on :e, :exec=, "A line of code to execute in context before the session starts" do |input|
-    exec_string << input + "\n"
+  banner(
+    "Usage: pry [OPTIONS]\n" \
+    "Start a Pry session.\n" \
+    "See http://pry.github.io/ 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" unless Pry.config.exec_string.empty?
+    Pry.config.exec_string += input
   end
 
   on "no-pager", "Disable pager for long output" do
@@ -111,57 +138,57 @@ Copyright (c) 2013 John Mair (banisterfiend)
   end
 
   on "no-history", "Disable history loading" do
-    Pry.config.history.should_load = false
+    Pry.config.history_load = false
   end
 
   on "no-color", "Disable syntax highlighting for session" do
-    Pry.color = false
+    Pry.config.color = false
   end
 
-  on :f, "Suppress loading of ~/.pryrc and ./.pryrc" do
+  on :f, "Suppress loading of pryrc" do
     Pry.config.should_load_rc = false
     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 "installed-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
+  on "plugins", "List installed plugins." do
+    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::SIMPLE_PROMPT
+    Pry.config.prompt = Pry::Prompt[:simple]
+  end
+
+  on "noprompt", "No prompt mode" do
+    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
@@ -170,33 +197,11 @@ Copyright (c) 2013 John Mair (banisterfiend)
 
   on :v, :version, "Display the Pry version" do
     puts "Pry version #{Pry::VERSION} on Ruby #{RUBY_VERSION}"
-    exit
-  end
-
-  on(:c, :context=,
-     "Start the session in the specified context. Equivalent to `context.pry` in a session.",
-     :default => "Pry.toplevel_binding"
-     )
-end.process_options do |opts|
-
-  exit if opts.help?
-
-  # invoked via cli
-  Pry.cli = true
-
-  # create the actual context
-  context = Pry.binding_for(eval(opts[:context]))
-
-  if 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
-  end
-
-  if Pry.config.should_load_plugins
-    parser = Slop.new
+    Kernel.exit
   end
 
-  # Start the session (running any code passed with -e, if there is any)
-  Pry.start(context, :input => StringIO.new(exec_string))
+  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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'method_source'
+
+class Pry
+  class CodeFile
+    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
+    }.freeze
+
+    FILES = {
+      %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]
+    INITIAL_PWD = Dir.pwd
+
+    # @return [Symbol] The type of code stored in this wrapper.
+    attr_reader :code_type
+
+    # @param [String] filename The name of a file with code to be detected
+    # @param [Symbol] code_type The type of code the `filename` contains
+    def initialize(filename, code_type = type_from_filename(filename))
+      @filename = filename
+      @code_type = code_type
+    end
+
+    # @return [String] The code contained in the current `@filename`.
+    def code
+      if @filename == Pry.eval_path
+        Pry.line_buffer.drop(1)
+      elsif Pry::Method::Patcher.code_for(@filename)
+        Pry::Method::Patcher.code_for(@filename)
+      else
+        path = abs_path
+        @code_type = type_from_filename(path)
+        File.read(path)
+      end
+    end
+
+    private
+
+    # @raise [MethodSource::SourceNotFoundError] if the `filename` is not
+    #   readable for some reason.
+    # @return [String] absolute path for the given `filename`.
+    def abs_path
+      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) ||
+        File.readable?(path << DEFAULT_EXT)
+    end
+
+    # @return [Array] All the paths that contain code that Pry can use for its
+    #   API's. Skips directories.
+    def code_path
+      [from_pwd, from_pry_init_pwd, *from_load_path]
+    end
+
+    # @param [String] filename
+    # @param [Symbol] default (:unknown) the file type to assume if none could be
+    #   detected.
+    # @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) }
+      end || FILES.find do |k, _|
+        k.any? { |file_name| file_name == File.basename(filename) }
+      end
+
+      code_type || default
+    end
+
+    # @return [String]
+    def from_pwd
+      File.expand_path(@filename, Dir.pwd)
+    end
+
+    # @return [String]
+    def from_pry_init_pwd
+      File.expand_path(@filename, INITIAL_PWD)
+    end
+
+    # @return [String]
+    def from_load_path
+      $LOAD_PATH.map { |path| File.expand_path(@filename, path) }
+    end
+  end
+end

data/lib/pry/code/code_range.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 class Pry
   class Code
-
     # Represents a range of lines in a code listing.
     #
     # @api private
     class CodeRange
-
       # @param [Integer] start_line
       # @param [Integer?] end_line
       def initialize(start_line, end_line = nil)
@@ -22,7 +22,9 @@ class Pry
 
       private
 
-      attr_reader :start_line, :end_line
+      attr_reader :start_line
+
+      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.
@@ -47,12 +49,14 @@ class Pry
       # @return [Integer]
       def find_start_index(lines)
         return start_line if start_line < 0
+
         lines.index { |loc| loc.lineno >= start_line } || lines.length
       end
 
       # @return [Integer]
       def find_end_index(lines)
         return end_line if end_line < 0
+
         (lines.index { |loc| loc.lineno > end_line } || 0) - 1
       end
 
@@ -65,6 +69,5 @@ class Pry
         @start_line = start_line.first
       end
     end
-
   end
 end