pry 0.9.12.2 → 0.14.2

data/lib/pry/commands/switch_to.rb

@@ -1,23 +1,29 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::SwitchTo < Pry::ClassCommand
-    match 'switch-to'
-    group 'Navigating Pry'
-    description 'Start a new subsession on a binding in the current stack.'
+  class Command
+    class SwitchTo < Pry::ClassCommand
+      match 'switch-to'
+      group 'Navigating Pry'
+      description 'Start a new subsession on a binding in the current stack.'
 
-    banner <<-'BANNER'
-      Start a new subsession on a binding in the current stack (numbered by nesting).
-    BANNER
+      banner <<-'BANNER'
+        Start a new subsession on a binding in the current stack (numbered by nesting).
+      BANNER
 
-    def process(selection)
-      selection = selection.to_i
+      def process(selection)
+        selection = selection.to_i
 
-      if selection < 0 || selection > _pry_.binding_stack.size - 1
-        raise CommandError, "Invalid binding index #{selection} - use `nesting` command to view valid indices."
-      else
-        Pry.start(_pry_.binding_stack[selection])
+        if selection < 0 || selection > pry_instance.binding_stack.size - 1
+          raise CommandError,
+                "Invalid binding index #{selection} - use `nesting` command " \
+                "to view valid indices."
+        else
+          Pry.start(pry_instance.binding_stack[selection])
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::SwitchTo)
+    Pry::Commands.add_command(Pry::Command::SwitchTo)
+  end
 end

data/lib/pry/commands/toggle_color.rb

@@ -1,20 +1,28 @@
+# frozen_string_literal: true
+
 class Pry
-  class Command::ToggleColor < Pry::ClassCommand
-    match 'toggle-color'
-    group 'Misc'
-    description 'Toggle syntax highlighting.'
+  class Command
+    class ToggleColor < Pry::ClassCommand
+      match 'toggle-color'
+      group 'Misc'
+      description 'Toggle syntax highlighting.'
+
+      banner <<-'BANNER'
+        Usage: toggle-color
 
-    banner <<-'BANNER'
-      Usage: toggle-color
+        Toggle syntax highlighting.
+      BANNER
 
-      Toggle syntax highlighting.
-    BANNER
+      def process
+        pry_instance.color = color_toggle
+        output.puts "Syntax highlighting #{pry_instance.color ? 'on' : 'off'}"
+      end
 
-    def process
-      Pry.color = !Pry.color
-      output.puts "Syntax highlighting #{Pry.color ? "on" : "off"}"
+      def color_toggle
+        !pry_instance.color
+      end
+
+      Pry::Commands.add_command(self)
     end
   end
-
-  Pry::Commands.add_command(Pry::Command::ToggleColor)
 end

data/lib/pry/commands/watch_expression/expression.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class Pry
+  class Command
+    class WatchExpression
+      class Expression
+        attr_reader :target, :source, :value, :previous_value, :pry_instance
+
+        def initialize(pry_instance, target, source)
+          @pry_instance = pry_instance
+          @target = target
+          @source = Code.new(source).strip
+        end
+
+        def eval!
+          @previous_value = value
+          @value = Pry::ColorPrinter.pp(target_eval(target, source), ''.dup)
+        end
+
+        def to_s
+          "#{Code.new(source).highlighted.strip} => #{value}"
+        end
+
+        # Has the value of the expression changed?
+        #
+        # We use the pretty-printed string represenation to detect differences
+        # as this avoids problems with dup (causes too many differences) and ==
+        # (causes too few)
+        def changed?
+          (value != previous_value)
+        end
+
+        private
+
+        def target_eval(target, source)
+          target.eval(source)
+        rescue StandardError => e
+          e
+        end
+      end
+    end
+  end
+end

data/lib/pry/commands/watch_expression.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+class Pry
+  class Command
+    class WatchExpression < Pry::ClassCommand
+      match 'watch'
+      group 'Context'
+      description 'Watch the value of an expression and print a notification ' \
+                  'whenever it changes.'
+      command_options use_prefix: false
+
+      banner <<-'BANNER'
+        Usage: watch [EXPRESSION]
+               watch
+               watch --delete [INDEX]
+
+        watch [EXPRESSION] adds an expression to the list of those being watched.
+        It will be re-evaluated every time you hit enter in pry. If its value has
+        changed, the new value will be printed to the console.
+
+        This is useful if you are step-through debugging and want to see how
+        something changes over time.  It's also useful if you're trying to write
+        a method inside pry and want to check that it gives the right answers
+        every time you redefine it.
+
+        watch on its own displays all the currently watched expressions and their
+        values, and watch --delete [INDEX] allows you to delete expressions from
+        the list being watched.
+      BANNER
+
+      def options(opt)
+        opt.on :d, :delete,
+               "Delete the watch expression with the given index. If no index " \
+               "is given; clear all watch expressions.",
+               optional_argument: true, as: Integer
+        opt.on :l, :list,
+               "Show all current watch expressions and their values. Calling " \
+               "watch with no expressions or options will also show the watch " \
+               "expressions."
+      end
+
+      def process
+        if opts.present?(:delete)
+          delete opts[:delete]
+        elsif opts.present?(:list) || args.empty?
+          list
+        else
+          add_hook
+          add_expression(args)
+        end
+      end
+
+      private
+
+      def expressions
+        state.watch_expressions ||= []
+      end
+
+      def delete(index)
+        if index
+          output.puts "Deleting watch expression ##{index}: #{expressions[index - 1]}"
+          expressions.delete_at(index - 1)
+        else
+          output.puts "Deleting all watched expressions"
+          expressions.clear
+        end
+      end
+
+      def list
+        if expressions.empty?
+          output.puts "No watched expressions"
+        else
+          pry_instance.pager.open do |pager|
+            pager.puts "Listing all watched expressions:"
+            pager.puts ""
+            expressions.each_with_index do |expr, index|
+              pager.print with_line_numbers(expr.to_s, index + 1)
+            end
+            pager.puts ""
+          end
+        end
+      end
+
+      def eval_and_print_changed(output)
+        expressions.each do |expr|
+          expr.eval!
+          output.puts "#{blue 'watch'}: #{expr}" if expr.changed?
+        end
+      end
+
+      # TODO: fix arguments.
+      # https://github.com/pry/pry/commit/b031df2f2f5850ee6e9018f33d35f3485a9b0423
+      def add_expression(_arguments)
+        expressions << Expression.new(pry_instance, target, arg_string)
+        output.puts "Watching #{Code.new(arg_string).highlighted}"
+      end
+
+      def add_hook
+        hook = %i[after_eval watch_expression]
+        return if pry_instance.hooks.hook_exists?(*hook)
+
+        pry_instance.hooks.add_hook(*hook) do |_, pry_instance|
+          eval_and_print_changed pry_instance.output
+        end
+      end
+    end
+
+    Pry::Commands.add_command(Pry::Command::WatchExpression)
+  end
+end

data/lib/pry/commands/whereami.rb

@@ -1,182 +1,205 @@
-class Pry
-  class Command::Whereami < Pry::ClassCommand
+# frozen_string_literal: true
 
-    class << self
-      attr_accessor :method_size_cutoff
-    end
+require 'method_source'
 
-    @method_size_cutoff = 30
+class Pry
+  class Command
+    class Whereami < Pry::ClassCommand
+      def initialize(*)
+        super
 
-    match 'whereami'
-    description 'Show code surrounding the current context.'
-    group 'Context'
+        @method_code = nil
+      end
 
-    banner <<-'BANNER'
-      Usage: whereami [-qn] [LINES]
+      class << self
+        attr_accessor :method_size_cutoff
+      end
 
-      Describe the current location. If you use `binding.pry` inside a method then
-      whereami will print out the source for that method.
+      @method_size_cutoff = 30
 
-      If a number is passed, then LINES lines before and after the current line will be
-      shown instead of the method itself.
+      match 'whereami'
+      description 'Show code surrounding the current context.'
+      group 'Context'
 
-      The `-q` flag can be used to suppress error messages in the case that there's
-      no code to show. This is used by pry in the default before_session hook to show
-      you when you arrive at a `binding.pry`.
+      banner <<-'BANNER'
+        Usage: whereami [-qn] [LINES]
 
-      The `-n` flag can be used to hide line numbers so that code can be copy/pasted
-      effectively.
+        Describe the current location. If you use `binding.pry` inside a method then
+        whereami will print out the source for that method.
 
-      When pry was started on an Object and there is no associated method, whereami
-      will instead output a brief description of the current object.
-    BANNER
+        If a number is passed, then LINES lines before and after the current line will be
+        shown instead of the method itself.
 
-    def setup
-      @file = expand_path(target.eval('__FILE__'))
-      @line = target.eval('__LINE__')
-      @method = Pry::Method.from_binding(target)
-    end
+        The `-q` flag can be used to suppress error messages in the case that there's
+        no code to show. This is used by pry in the default before_session hook to show
+        you when you arrive at a `binding.pry`.
 
-    def options(opt)
-      opt.on :q, :quiet,             "Don't display anything in case of an error"
-      opt.on :n, :"no-line-numbers", "Do not display line numbers"
-      opt.on :m, :"method", "Show the complete source for the current method."
-      opt.on :c, :"class", "Show the complete source for the current class or module."
-      opt.on :f, :"file", "Show the complete source for the current file."
-    end
+        The `-n` flag can be used to hide line numbers so that code can be copy/pasted
+        effectively.
 
-    def code
-      @code ||= if opts.present?(:m)
-                  method_code or raise CommandError, "Cannot find method code."
-                elsif opts.present?(:c)
-                  class_code or raise CommandError, "Cannot find class code."
-                elsif opts.present?(:f)
-                  Pry::Code.from_file(@file)
-                elsif args.any?
-                  code_window
-                else
-                  default_code
-                end
-    end
+        When pry was started on an Object and there is no associated method, whereami
+        will instead output a brief description of the current object.
+      BANNER
 
-    def code?
-      !!code
-    rescue MethodSource::SourceNotFoundError
-      false
-    end
+      def setup
+        if target.respond_to?(:source_location)
+          file, @line = target.source_location
+          @file = expand_path(file)
+        else
+          @file = expand_path(target.eval('__FILE__'))
+          @line = target.eval('__LINE__')
+        end
+        @method = Pry::Method.from_binding(target)
+      end
 
-    def bad_option_combination?
-      [opts.present?(:m), opts.present?(:f),
-       opts.present?(:c), args.any?].count(true) > 1
-    end
+      def options(opt)
+        opt.on :q, :quiet, "Don't display anything in case of an error"
+        opt.on :n, :"no-line-numbers", "Do not display line numbers"
+        opt.on :m, :method, "Show the complete source for the current method."
+        opt.on :c, :class, "Show the complete source for the current class or module."
+        opt.on :f, :file, "Show the complete source for the current file."
+      end
 
-    def location
-      "#{@file} @ line #{@line} #{@method && @method.name_with_owner}"
-    end
+      def code
+        @code ||= if opts.present?(:m)
+                    method_code || raise(CommandError, "Cannot find method code.")
+                  elsif opts.present?(:c)
+                    class_code || raise(CommandError, "Cannot find class code.")
+                  elsif opts.present?(:f)
+                    Pry::Code.from_file(@file)
+                  elsif args.any?
+                    code_window
+                  else
+                    default_code
+                  end
+      end
 
-    def process
-      if bad_option_combination?
-        raise CommandError, "Only one of -m, -c, -f, and  LINES may be specified."
+      def code?
+        !!code
+      rescue MethodSource::SourceNotFoundError
+        false
       end
 
-      if nothing_to_do?
-        return
-      elsif internal_binding?(target)
-        handle_internal_binding
-        return
+      def bad_option_combination?
+        [opts.present?(:m), opts.present?(:f),
+         opts.present?(:c), args.any?].count(true) > 1
       end
 
-      set_file_and_dir_locals(@file)
+      def location
+        "#{@file}:#{@line} #{@method && @method.name_with_owner}"
+      end
 
-      out = "\n#{text.bold('From:')} #{location}:\n\n" +
-        code.with_line_numbers(use_line_numbers?).with_marker(marker).to_s + "\n"
+      def process
+        if bad_option_combination?
+          raise CommandError, "Only one of -m, -c, -f, and  LINES may be specified."
+        end
 
-      stagger_output(out)
-    end
+        return if nothing_to_do?
 
-    private
+        if internal_binding?(target)
+          handle_internal_binding
+          return
+        end
 
-    def nothing_to_do?
-      opts.quiet? && (internal_binding?(target) || !code?)
-    end
+        set_file_and_dir_locals(@file)
 
-    def use_line_numbers?
-      !opts.present?(:n)
-    end
+        pretty_code = code.with_line_numbers(use_line_numbers?)
+          .with_marker(marker)
+          .highlighted
+        pry_instance.pager.page(
+          "\n#{bold('From:')} #{location}:\n\n" + pretty_code + "\n"
+        )
+      end
 
-    def marker
-      !opts.present?(:n) && @line
-    end
+      private
 
-    def top_level?
-      target_self == TOPLEVEL_BINDING.eval("self")
-    end
+      def nothing_to_do?
+        opts.quiet? && (internal_binding?(target) || !code?)
+      end
 
-    def handle_internal_binding
-      if top_level?
-        output.puts "At the top level."
-      else
-        output.puts "Inside #{Pry.view_clip(target_self)}."
+      def use_line_numbers?
+        !opts.present?(:n)
       end
-    end
 
-    def small_method?
-      @method.source_range.count < self.class.method_size_cutoff
-    end
+      def marker
+        !opts.present?(:n) && @line
+      end
 
-    def default_code
-      if method_code && small_method?
-        method_code
-      else
-        code_window
+      def top_level?
+        target_self == Pry.main
       end
-    end
 
-    def code_window
-      Pry::Code.from_file(@file).around(@line, window_size)
-    end
+      def handle_internal_binding
+        if top_level?
+          output.puts "At the top level."
+        else
+          output.puts "Inside #{Pry.view_clip(target_self)}."
+        end
+      end
 
-    def method_code
-      return @method_code if @method_code
+      def small_method?
+        @method.source_range.count < self.class.method_size_cutoff
+      end
 
-      if valid_method?
-        @method_code = Pry::Code.from_method(@method)
+      def default_code
+        if method_code && small_method?
+          method_code
+        else
+          code_window
+        end
       end
-    end
 
-    def class_code
-      return @class_code if @class_code
+      def code_window
+        Pry::Code.from_file(@file).around(@line, window_size)
+      end
 
-      if valid_method?
-        mod = Pry::WrappedModule(@method.owner)
-        idx = mod.candidates.find_index { |v| expand_path(v.source_file) == @file }
-        @class_code = idx && Pry::Code.from_module(mod, idx)
+      def method_code
+        return @method_code if @method_code
+
+        @method_code = Pry::Code.from_method(@method) if valid_method?
       end
-    end
 
-    def valid_method?
-      @method && @method.source? && expand_path(@method.source_file) == @file &&
-        @method.source_range.include?(@line)
-    end
+      # This either returns the `target_self`
+      # or it returns the class of `target_self` if `target_self` is not a class.
+      # @return [Pry::WrappedModule]
+      def target_class
+        return Pry::WrappedModule(target_self) if target_self.is_a?(Module)
 
-    def expand_path(f)
-      return if !f
+        Pry::WrappedModule(target_self.class)
+      end
 
-      if Pry.eval_path == f
-        f
-      else
-        File.expand_path(f)
+      def class_code
+        @class_code ||=
+          begin
+            mod = @method ? Pry::WrappedModule(@method.owner) : target_class
+            idx = mod.candidates.find_index { |v| expand_path(v.source_file) == @file }
+            idx && Pry::Code.from_module(mod, idx)
+          end
+      end
+
+      def valid_method?
+        @method && @method.source? && expand_path(@method.source_file) == @file &&
+          @method.source_range.include?(@line)
       end
-    end
 
-    def window_size
-      if args.empty?
-        Pry.config.default_window_size
-      else
-        args.first.to_i
+      def expand_path(filename)
+        return unless filename
+        return filename if Pry.eval_path == filename
+
+        File.expand_path(filename)
+      end
+
+      def window_size
+        if args.empty?
+          pry_instance.config.default_window_size
+        else
+          args.first.to_i
+        end
       end
     end
-  end
 
-  Pry::Commands.add_command(Pry::Command::Whereami)
+    Pry::Commands.add_command(Pry::Command::Whereami)
+    Pry::Commands.alias_command '@', 'whereami'
+    Pry::Commands.alias_command(/whereami[!?]+/, 'whereami')
+  end
 end