pry 0.11.3 → 0.12.0

data/lib/pry/code.rb

@@ -66,7 +66,7 @@ class Pry
       # @param [Integer, nil] start_line The line number to start on, or nil to
       #   use the method's original line numbers.
       # @return [Code]
-      def from_module(mod, candidate_rank = 0, start_line=nil)
+      def from_module(mod, candidate_rank = 0, start_line = nil)
         candidate = Pry::WrappedModule(mod).candidate(candidate_rank)
         start_line ||= candidate.line
         new(candidate.source, start_line, :ruby)
@@ -201,6 +201,7 @@ class Pry
     # @return [Code]
     def grep(pattern)
       return self unless pattern
+
       pattern = Regexp.new(pattern)
 
       select do |loc|
@@ -265,7 +266,7 @@ class Pry
 
     # Writes a formatted representation (based on the configuration of the
     # object) to the given output, which must respond to `#<<`.
-    def print_to_output(output, color=false)
+    def print_to_output(output, color = false)
       @lines.each do |loc|
         loc = loc.dup
         loc.colorize(@code_type)              if color
@@ -291,15 +292,14 @@ class Pry
     # @param [Integer] line_number (1-based)
     # @return [String] the code.
     def expression_at(line_number, consume = 0)
-      self.class.expression_at(raw, line_number, :consume => consume)
+      self.class.expression_at(raw, line_number, consume: consume)
     end
 
     # Get the (approximate) Module.nesting at the give line number.
     #
     # @param [Integer] line_number line number starting from 1
-    # @param [Module] top_module the module in which this code exists
     # @return [Array<Module>] a list of open modules.
-    def nesting_at(line_number, top_module = Object)
+    def nesting_at(line_number)
       Pry::Indent.nesting_at(raw, line_number)
     end
 
@@ -338,7 +338,7 @@ class Pry
     undef =~
 
     # Check whether String responds to missing methods.
-    def respond_to_missing?(name, include_all=false)
+    def respond_to_missing?(name, include_all = false)
       ''.respond_to?(name, include_all)
     end
 

data/lib/pry/code/code_file.rb

@@ -25,6 +25,10 @@ class Pry
       %w(Gemfile Rakefile Guardfile Capfile) => :ruby
     }
 
+    # 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
 
@@ -41,8 +45,6 @@ class Pry
         Pry.line_buffer.drop(1)
       elsif Pry::Method::Patcher.code_for(@filename)
         Pry::Method::Patcher.code_for(@filename)
-      elsif RbxPath.is_core_path?(@filename)
-        File.read(RbxPath.convert_path_to_full(@filename))
       else
         path = abs_path
         @code_type = type_from_filename(path)
@@ -97,13 +99,12 @@ class Pry
 
     # @return [String]
     def from_pry_init_pwd
-      File.expand_path(@filename, Pry::INITIAL_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,9 @@
 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)
@@ -23,6 +21,7 @@ class Pry
       private
 
       def start_line; @start_line; end
+
       def end_line; @end_line; end
 
       # If `end_line` is equal to `nil`, then calculate it from the first
@@ -48,12 +47,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
 
@@ -66,6 +67,5 @@ class Pry
         @start_line = start_line.first
       end
     end
-
   end
 end

data/lib/pry/code/loc.rb

@@ -1,10 +1,11 @@
 class Pry
   class Code
-
-    # Represents a line of code. 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 instance methods. `Pry::Code` heavily uses
-    # this class.
+    # 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
+    # instance methods.  `Pry::Code` heavily uses this class.
     #
     # @api private
     # @example
@@ -18,7 +19,6 @@ class Pry
     #   loc.indent(3)
     #   loc.line #=> "   def example\n  :example\nend"
     class LOC
-
       # @return [Array<String, Integer>]
       attr_reader :tuple
 
@@ -62,7 +62,8 @@ class Pry
       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
-        tuple[0] = "#{ colorized_lineno }: #{ line }"
+        properly_padded_line = handle_multiline_entries_from_edit_command(line, max_width)
+        tuple[0] = "#{ colorized_lineno }: #{ properly_padded_line }"
       end
 
       # Prepends a marker "=>" or an empty marker to the +line+.
@@ -86,7 +87,12 @@ class Pry
       def indent(distance)
         tuple[0] = "#{ ' ' * distance }#{ line }"
       end
-    end
 
+      def handle_multiline_entries_from_edit_command(line, max_width)
+        line.split("\n").map.with_index do |inner_line, i|
+          i.zero? ? inner_line : "#{' ' * (max_width + 2)}#{inner_line}"
+        end.join("\n")
+      end
+    end
   end
 end

data/lib/pry/code_object.rb

@@ -1,5 +1,4 @@
 class Pry
-
   # This class is responsible for taking a string (identifying a
   # command/class/method/etc) and returning the relevant type of object.
   # For example, if the user looks up "show-source" then  a
@@ -64,7 +63,7 @@ class Pry
     include Pry::Helpers::CommandHelpers
 
     class << self
-      def lookup(str, _pry_, options={})
+      def lookup(str, _pry_, options = {})
         co = new(str, _pry_, options)
 
         co.default_lookup || co.method_or_class_lookup ||
@@ -77,9 +76,9 @@ class Pry
     attr_accessor :_pry_
     attr_accessor :super_level
 
-    def initialize(str, _pry_, options={})
+    def initialize(str, _pry_, options = {})
       options = {
-        :super => 0,
+        super: 0,
       }.merge!(options)
 
       @str = str
@@ -170,6 +169,7 @@ class Pry
     def safe_to_evaluate?(str)
       return true if str.strip == "self"
       return false if str =~ /%/
+
       kind = target.eval("defined?(#{str})")
       kind =~ /variable|constant/
     end

data/lib/pry/color_printer.rb

@@ -40,6 +40,7 @@ class Pry
       end
     rescue => e
       raise if e.is_a? Pry::Pager::StopPaging
+
       begin
         str = obj.inspect
       rescue Exception 

data/lib/pry/command.rb

@@ -2,7 +2,6 @@ require 'delegate'
 require 'pry/helpers/documentation_helpers'
 
 class Pry
-
   # The super-class of all commands, new commands should be created by calling
   # {Pry::CommandSet#command} which creates a BlockCommand or {Pry::CommandSet#create_command}
   # which creates a ClassCommand. Please don't use this class directly.
@@ -24,7 +23,7 @@ class Pry
       attr_writer :command_options
       attr_writer :match
 
-      def match(arg=nil)
+      def match(arg = nil)
         if arg
           @command_options ||= default_options(arg)
           @command_options[:listing] = arg.is_a?(String) ? arg : arg.inspect
@@ -34,13 +33,13 @@ class Pry
       end
 
       # Define or get the command's description
-      def description(arg=nil)
+      def description(arg = nil)
         @description = arg if arg
         @description ||= nil
       end
 
       # Define or get the command's options
-      def command_options(arg=nil)
+      def command_options(arg = nil)
         @command_options ||= default_options(match)
         @command_options.merge!(arg) if arg
         @command_options
@@ -50,7 +49,7 @@ class Pry
       alias_method :options=, :command_options=
 
       # Define or get the command's banner
-      def banner(arg=nil)
+      def banner(arg = nil)
         @banner = arg if arg
         @banner ||= description
       end
@@ -68,10 +67,6 @@ class Pry
         new.help
       end
 
-      def source_location
-        block.source_location
-      end
-
       def source_file
         Array(block.source_location).first
       end
@@ -84,27 +79,32 @@ class Pry
 
       def default_options(match)
         {
-          :requires_gem      => [],
-          :keep_retval       => false,
-          :argument_required => false,
-          :interpolate       => true,
-          :shellwords        => true,
-          :listing           => (String === match ? match : match.inspect),
-          :use_prefix        => true,
-          :takes_block       => false
+          requires_gem: [],
+          keep_retval: false,
+          argument_required: false,
+          interpolate: true,
+          shellwords: true,
+          listing: (String === match ? match : match.inspect),
+          use_prefix: true,
+          takes_block: false
         }
       end
     end
 
     # Make those properties accessible to instances
     def name; self.class.name; end
+
     def match; self.class.match; end
+
     def description; self.class.description; end
+
     def block; self.class.block; end
+
     def command_options; self.class.options; end
+
     def command_name; self.class.command_name; end
+
     def source; self.class.source; end
-    def source_location; self.class.source_location; end
 
     class << self
       def name
@@ -169,8 +169,6 @@ class Pry
 
       # @deprecated Replaced with {Pry::Hooks#add_hook}. Left for compatibility.
       # Store hooks to be run before or after the command body.
-      # @see {Pry::CommandSet#before_command}
-      # @see {Pry::CommandSet#after_command}
       def hooks
         Pry.hooks
       end
@@ -196,7 +194,7 @@ class Pry
       # This is usually auto-generated from directory naming, but it can be
       # manually overridden if necessary.
       # Group should not be changed once it is initialized.
-      def group(name=nil)
+      def group(name = nil)
         @group ||= if name
                      name
                    else
@@ -205,9 +203,9 @@ class Pry
                        $1.capitalize.gsub(/_/, " ")
                      when %r{(pry-\w+)-([\d\.]+([\w\.]+)?)}
                        name, version = $1, $2
-                       "#{name.to_s} (v#{version.to_s})"
+                       "#{name} (v#{version})"
                      when /pryrc/
-                       "~/.pryrc"
+                       "pryrc"
                      else
                        "(other)"
                      end
@@ -254,6 +252,14 @@ class Pry
       command_set.to_hash
     end
 
+    #
+    # @deprecated
+    #   Please use black(), white(), etc directly instead (as you would with helper
+    #   functions from BaseHelpers and CommandHelpers)
+    #
+    # @return [Module]
+    #   Returns Pry::Helpers::Text
+    #
     def text
       Pry::Helpers::Text
     end
@@ -264,10 +270,11 @@ class Pry
 
     include Pry::Helpers::BaseHelpers
     include Pry::Helpers::CommandHelpers
+    include Pry::Helpers::Text
 
     # Instantiate a command, in preparation for calling it.
     # @param [Hash] context The runtime context to use with this command.
-    def initialize(context={})
+    def initialize(context = {})
       self.context      = context
       self.target       = context[:target]
       self.output       = context[:output]
@@ -338,6 +345,7 @@ class Pry
 
       # please call Command.matches? before Command#call_safely
       raise CommandError, "fatal: called a command which didn't match?!" unless Regexp.last_match
+
       captures = Regexp.last_match.captures
       pos = Regexp.last_match.end(0)
 
@@ -450,9 +458,9 @@ class Pry
 
     # Generate completions for this command
     #
-    # @param [String] search  The line typed so far
+    # @param [String] _search The line typed so far
     # @return [Array<String>]  Completion words
-    def complete(search)
+    def complete(_search)
       []
     end
 
@@ -537,12 +545,11 @@ class Pry
   # 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.match match
+        klass.description description
         klass.command_options options
       end
 

data/lib/pry/command_set.rb

@@ -75,7 +75,7 @@ class Pry
     #   # hello john, nice number: 10
     #   # pry(main)> help number
     #   # number-N regex command
-    def block_command(match, description="No description.", options={}, &block)
+    def block_command(match, description = "No description.", options = {}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
       options = Pry::Command.default_options(match).merge!(options)
 
@@ -107,7 +107,7 @@ class Pry
     #     end
     #   end
     #
-    def create_command(match, description="No description.", options={}, &block)
+    def create_command(match, description = "No description.", options = {}, &block)
       description, options = ["No description.", description] if description.is_a?(Hash)
       options = Pry::Command.default_options(match).merge!(options)
 
@@ -116,41 +116,6 @@ class Pry
       @commands[match]
     end
 
-    # Execute a block of code before a command is invoked. The block also
-    # gets access to parameters that will be passed to the command and
-    # is evaluated in the same context.
-    # @param [String, Regexp] search The match or listing of the command.
-    # @yield The block to be run before the command.
-    # @example Display parameter before invoking command
-    #   Pry.config.commands.before_command("whereami") do |n|
-    #     output.puts "parameter passed was #{n}"
-    #   end
-    # @deprecated Use {Pry::Hooks#add_hook} instead.
-    def before_command(search, &block)
-      cmd = find_command_by_match_or_listing(search)
-      cmd.hooks.add_hook("before_#{cmd.command_name}", random_hook_name, block)
-    end
-
-    # Execute a block of code after a command is invoked. The block also
-    # gets access to parameters that will be passed to the command and
-    # is evaluated in the same context.
-    # @param [String, Regexp] search The match or listing of the command.
-    # @yield The block to be run after the command.
-    # @example Display text 'command complete' after invoking command
-    #   Pry.config.commands.after_command("whereami") do |n|
-    #     output.puts "command complete!"
-    #   end
-    # @deprecated Use {Pry::Hooks#add_hook} instead.
-    def after_command(search, &block)
-      cmd = find_command_by_match_or_listing(search)
-      cmd.hooks.add_hook("after_#{cmd.command_name}", random_hook_name, block)
-    end
-
-    def random_hook_name
-      (0...8).map { ('a'..'z').to_a[rand(26)] }.join
-    end
-    private :random_hook_name
-
     def each(&block)
       @commands.each(&block)
     end
@@ -209,13 +174,13 @@ class Pry
     #   Pry.config.commands.alias_command "lM", "ls -M"
     # @example Pass explicit description (overriding default).
     #   Pry.config.commands.alias_command "lM", "ls -M", :desc => "cutiepie"
-    def alias_command(match, action,  options={})
+    def alias_command(match, action, options = {})
       cmd = find_command(action) or fail "Command: `#{action}` not found"
       original_options = cmd.options.dup
 
       options = original_options.merge!({
-                                          :desc => "Alias for `#{action}`",
-                                          :listing => match
+                                          desc: "Alias for `#{action}`",
+                                          listing: match
                                         }).merge!(options)
 
       # ensure default description is used if desc is nil
@@ -245,12 +210,12 @@ class Pry
     #   command description to be passed this way too.
     # @example Renaming the `ls` command and changing its description.
     #   Pry.config.commands.rename "dir", "ls", :description => "DOS friendly ls"
-    def rename_command(new_match, search, options={})
+    def rename_command(new_match, search, options = {})
       cmd = find_command_by_match_or_listing(search)
 
       options = {
-        :listing     => new_match,
-        :description => cmd.description
+        listing: new_match,
+        description: cmd.description
       }.merge!(options)
 
       @commands[new_match] = cmd.dup
@@ -260,7 +225,7 @@ class Pry
       @commands.delete(cmd.match)
     end
 
-    def disabled_command(name_of_disabled_command, message, matcher=name_of_disabled_command)
+    def disabled_command(name_of_disabled_command, message, matcher = name_of_disabled_command)
       create_command name_of_disabled_command do
         match matcher
         description ""
@@ -282,7 +247,7 @@ class Pry
     #   end
     # @example Getting
     #   Pry.config.commands.desc "amend-line"
-    def desc(search, description=nil)
+    def desc(search, description = nil)
       cmd = find_command_by_match_or_listing(search)
       return cmd.description if !description
 
@@ -305,7 +270,6 @@ class Pry
       helper_module.class_eval(&block)
     end
 
-
     # @return [Array]
     #   The list of commands provided by the command set.
     def list_commands
@@ -352,6 +316,7 @@ class Pry
       unless Class === command && command < Pry::Command
         raise TypeError, "command is not a subclass of Pry::Command"
       end
+
       bind_command_to_pattern = pattern != command.match
       if bind_command_to_pattern
         command_copy = command.dup
@@ -394,9 +359,9 @@ class Pry
     # @param [String] val The line to execute
     # @param [Hash] context The context to execute the commands with
     # @return [CommandSet::Result]
-    def process_line(val, context={})
-      if command = find_command(val)
-        context = context.merge(:command_set => self)
+    def process_line(val, context = {})
+      if (command = find_command(val))
+        context = context.merge(command_set: self)
         retval = command.new(context).process_line(val)
         Result.new(true, retval)
       else
@@ -414,13 +379,13 @@ class Pry
     # @param [String] search The line to search for
     # @param [Hash] context  The context to create the command with
     # @return [Array<String>]
-    def complete(search, context={})
-      if command = find_command(search)
+    def complete(search, context = {})
+      if (command = find_command(search))
         command.new(context).complete(search)
       else
         @commands.keys.select do |key|
           String === key && key.start_with?(search)
-        end.map{ |key| key + " " }
+        end.map { |key| key + " " }
       end
     end
   end