pry-moves 0.1.13 → 1.0.2

data/lib/pry-moves/pry_ext.rb

@@ -1,32 +1,32 @@
 class << Pry
-  alias_method :start_without_pry_nav, :start
-
-  def start_with_pry_nav(target = TOPLEVEL_BINDING, options = {})
-    old_options = options.reject { |k, _| k == :pry_remote }
+  alias pry_moves_origin_start start
 
+  def start(target = TOPLEVEL_BINDING, options = {})
     if target.is_a?(Binding) && PryMoves.check_file_context(target)
       # Wrap the tracer around the usual Pry.start
-      PryMoves::PryWrapper.new(target, options).run do
-        start_without_pry_nav(target, old_options)
-      end
+      original_verbosity = $VERBOSE
+      $VERBOSE = nil # Disable warnings for pry-moves
+      PryMoves::PryWrapper.new(target, options, self).run
+      $VERBOSE = original_verbosity
     else
       # No need for the tracer unless we have a file context to step through
-      start_without_pry_nav(target, old_options)
+      pry_moves_origin_start(target, options)
     end
   end
 
-  alias_method :start, :start_with_pry_nav
 end
 
 Binding.class_eval do
 
+  attr_accessor :index, :hidden
+
   alias pry_forced pry
 
-  def pry
-    unless Pry.config.disable_breakpoints
-      PryMoves.synchronize_threads ||
-        return # Don't start binding.pry when semaphore locked by current thread
-      pry_forced
+  def pry options = nil
+    if !Pry.config.disable_breakpoints and
+        # Don't start binding.pry when semaphore locked by current thread
+        PryMoves.synchronize_threads
+      pry_forced options
     end
   end
 
@@ -34,6 +34,32 @@ end
 
 Pry.config.pager = false
 
+Pry::Command.class_eval do
+  class << self
+    attr_accessor :original_user_input
+  end
+
+  alias run_origin_for_pry_moves run
+  def run(command_string, *args)
+    Pry.config.original_user_input = self.class.original_user_input
+    result = run_origin_for_pry_moves command_string, *args
+    Pry.config.original_user_input = nil
+    result
+  end
+end
+
+Pry::CommandSet.class_eval do
+
+  alias alias_command_origin_for_pry_moves alias_command
+
+  def alias_command(match, action, options = {})
+    cmd = alias_command_origin_for_pry_moves match, action, options
+    cmd.original_user_input = match
+    cmd
+  end
+
+end
+
 Pry::Command::Whereami.class_eval do
   # Negligent function from Pry - evidently poor output format
   # would be wanted to be changed often by developers,
@@ -56,11 +82,19 @@ Pry::Command::Whereami.class_eval do
   end
 
   def build_output
-    lines = []
-    lines << "#{text.bold('From:')} #{PryMoves::Helpers.shorten_path location}"
-    lines << PryMoves::Watch.instance.output(target) unless PryMoves::Watch.instance.empty?
+    lines = ['']
+
+    formatter = PryMoves::Formatter.new
+    prefix = Thread.current[:pry_moves_debug] ? "👾 " : ""
+    lines << "#{prefix}#{formatter.shorten_path location}"
+    lines << "   ." + formatter.method_signature(target)
     lines << ''
     lines << "#{code.with_line_numbers(use_line_numbers?).with_marker(marker).highlighted}"
+
+    lines << PryMoves::Watch.instance.output(target) unless PryMoves::Watch.instance.empty?
+    lines.concat PryMoves.messages
+    PryMoves.messages.clear
+
     lines << ''
     lines.join "\n"
   end
@@ -82,4 +116,18 @@ Pry::Code::LOC.class_eval do
     tuple[0] = " #{marker} #{ line }"
   end
 
-end
+end
+
+Pry::Output.class_eval do
+
+  alias pry_moves_origin_for_puts puts
+
+  def puts *args
+    first = args[0]
+    if first.is_a? String and first.start_with? "(pry) output error"
+      first.slice! 400..-1
+    end
+    pry_moves_origin_for_puts *args
+  end
+
+end if defined? Pry::Output

data/lib/pry-moves/pry_wrapper.rb

@@ -2,24 +2,24 @@ require 'pry' unless defined? Pry
 
 module PryMoves
 class PryWrapper
-  def initialize(binding_, pry_start_options = {})
+  def initialize(binding_, pry_start_options, pry)
     @init_binding = binding_
     @pry_start_options = pry_start_options   # Options to use for Pry.start
+    @pry = pry
   end
 
-  def run(&block)
+  def run
     PryMoves.lock
 
-    Pry.config.marker = "⛔️" if @pry_start_options[:exit_from_method]
-
-    return_value = nil
-    PryMoves.is_open = true
-    @command = catch(:breakout_nav) do      # Coordinates with PryMoves::Commands
-      return_value = yield
-      nil    # Nothing thrown == no navigational command
+    initial_frame = PryMoves::BindingsStack.new(@pry_start_options).initial_frame
+    if not @pry_start_options[:pry_moves_loop] and
+        initial_frame.local_variable_defined? :debug_redirect
+      debug_redirect = initial_frame.local_variable_get(:debug_redirect)
+      PryMoves.messages << "⏩ redirected to #{debug_redirect}"
+      @command = {action: :step, binding: initial_frame}
+    else
+      start_pry
     end
-    PryMoves.is_open = false
-    Pry.config.marker = "=>"
 
     if @command
       trace_command
@@ -30,11 +30,24 @@ class PryWrapper
       end
     end
 
-    return_value
+    @return_value
   end
 
   private
 
+  def start_pry
+    Pry.config.marker = "⛔️" if @pry_start_options[:exit_from_method]
+    PryMoves.is_open = true
+
+    @command = catch(:breakout_nav) do      # Coordinates with PryMoves::Commands
+      @return_value = @pry.pry_moves_origin_start(@init_binding, @pry_start_options)
+      nil    # Nothing thrown == no navigational command
+    end
+
+    PryMoves.is_open = false
+    Pry.config.marker = "=>"
+  end
+
   def trace_command
     if @command[:action] == :debug
       wrap_debug
@@ -61,9 +74,9 @@ class PryWrapper
       tracer = start_tracing
       begin
         @command[:binding].eval @command[:param]
-      rescue => e
+      rescue StandardError, SyntaxError => e
         Thread.current.set_trace_func nil
-        puts e
+        puts "❌️ Error during #{"debug".yellow} execution: #{e}"
       end
       tracer.stop_tracing
     end.join
@@ -73,9 +86,9 @@ class PryWrapper
 
   def start_tracing
     @last_runtime_binding = @command[:binding]
-    tracer = PryMoves::Tracer.new @command, @pry_start_options
-    tracer.trace
-    tracer
+    PryMoves::TraceCommand.trace @command, @pry_start_options do |binding|
+      Pry.start(binding, @pry_start_options)
+    end
   end
 
 end

data/lib/pry-moves/recursion_tracker.rb

@@ -0,0 +1,94 @@
+module PryMoves::Recursion
+
+  class Tracker
+
+    attr_reader :loops
+
+    def initialize
+      @history = []
+      @loops = 0
+      @missing = 0
+      @currently_missing = []
+      @missing_lines = []
+    end
+
+    def track file, line_num, bt_index, binding_index
+      line = "#{file}:#{line_num}"
+      if @last_index
+        check_recursion line, bt_index, binding_index
+      elsif (prev_index = @history.rindex line)
+        @loops += 1
+        @last_index = prev_index
+        @recursion_size = 1
+      else
+        @history << line
+        @last_index = nil
+      end
+
+      @repetitions_start ||= bt_index if @loops == 2
+    end
+
+    def check_recursion line, bt_index, binding_index
+      prev_index = @history.rindex line
+      if prev_index == @last_index
+        @loops += 1
+        @missing = 0
+        @recursion_size = 0
+        @missing_lines.concat @currently_missing
+        @repetitions_end = bt_index
+      elsif prev_index && prev_index > @last_index
+        @last_index = prev_index + 1
+        @recursion_size += 1
+        # todo: finish tracking and debug multi-line recursions
+      elsif @missing <= @recursion_size
+        @missing += 1
+        @currently_missing << binding_index
+        false
+      else
+        # @missing_lines = nil
+        # @last_index = nil
+        @is_finished = true
+        false
+      end
+    end
+
+    def finished?
+      @is_finished
+    end
+
+    def good?
+      @repetitions_start and @repetitions_end
+    end
+
+    def apply result
+      label = "♻️  recursion with #{@loops} loops"
+      label += " Ⓜ️  #{@missing} missing lines #{@missing_lines}" if @missing_lines.present?
+      label = "...(#{label})..."
+      # puts "#{@repetitions_start}..#{@repetitions_end}"
+      result[@repetitions_start..@repetitions_end] = [label]
+    end
+
+  end
+
+  class Holder < Array
+
+    def initialize(*args)
+      super
+      new_tracker
+    end
+
+    def new_tracker
+      @tracker = Tracker.new
+    end
+
+    def track *args
+      @tracker.track *args
+      if @tracker.finished?
+        self << @tracker if @tracker.good?
+        new_tracker
+      end
+    end
+
+  end
+
+end

data/lib/pry-moves/restartable.rb

@@ -0,0 +1,39 @@
+module PryMoves::Restartable
+
+  attr_accessor :restart_requested, :reload_requested,
+    :reload_rake_tasks
+
+  def restartable context
+    trigger :each_new_run, context
+    yield
+    re_execution
+  rescue PryMoves::Restart
+    puts "🔄️  Restarting execution"
+    self.restart_requested = false
+    PryMoves.reset
+    trigger :restart, context
+    retry
+  rescue PryMoves::Reload
+    puts "🔮  try to use @ with reload"
+    exit 3
+  end
+
+  def re_execution
+    raise PryMoves::Restart if restart_requested
+    raise PryMoves::Reload if reload_requested
+  end
+
+
+end
+
+class PryMoves::Restart < RuntimeError
+end
+class PryMoves::Reload < RuntimeError
+end
+RSpec::Support::AllExceptionsExceptOnesWeMustNotRescue::AVOID_RESCUING.concat [PryMoves::Restart, PryMoves::Reload] if defined? RSpec
+
+Pry.config.hooks.add_hook(:after_eval, :exit_on_re_execution) do |_, _, _pry_|
+  if PryMoves.restart_requested or PryMoves.reload_requested
+    Pry.run_command 'exit-all'
+  end
+end

data/lib/pry-moves/version.rb

@@ -1,3 +1,3 @@
 module PryMoves
-  VERSION = '0.1.13'
+  VERSION = '1.0.2'
 end

data/lib/pry-moves/watch.rb

@@ -1,4 +1,5 @@
 require 'singleton'
+require 'set'
 
 class PryMoves::Watch
 
@@ -44,6 +45,8 @@ class PryMoves::Watch
     "\033[1m#{cmd}\033[0m: #{format binding_.eval(cmd)}"
   rescue NameError
     "\033[1m#{cmd}\033[0m: <undefined>"
+  rescue => e
+    "\033[1m#{cmd}\033[0m: <#{e}>"
   end
 
   def format(text)

data/lib/pry-moves.rb

@@ -1,19 +1,34 @@
 require 'pry' unless defined? Pry
+require 'colorize'
+require 'diffy'
 
 require 'pry-moves/version'
-require 'pry-moves/trace_commands'
-require 'pry-moves/traced_method'
-require 'pry-moves/tracer'
 require 'pry-moves/pry_ext'
 require 'pry-moves/commands'
-require 'pry-moves/traversing'
+require 'pry-moves/add_suffix'
 require 'pry-moves/pry_wrapper'
+require 'pry-moves/bindings_stack'
+require 'pry-moves/formatter'
 require 'pry-moves/backtrace'
 require 'pry-moves/watch'
-require 'pry-moves/helpers'
 require 'pry-moves/painter'
+require 'pry-moves/restartable'
+require 'pry-moves/recursion_tracker'
+require 'pry-moves/error_with_data'
+
+require 'commands/traced_method'
+require 'commands/trace_helpers'
+require 'commands/trace_command'
+require 'commands/debug'
+require 'commands/finish'
+require 'commands/goto'
+require 'commands/iterate'
+require 'commands/next'
+require 'commands/next_breakpoint'
+require 'commands/step'
 
 require 'pry-stack_explorer/pry-stack_explorer'
+require 'debug_sugar'
 
 # Optionally load pry-remote monkey patches
 require 'pry-moves/pry_remote_ext' if defined? PryRemote
@@ -22,8 +37,36 @@ module PryMoves
   TRACE_IGNORE_FILES = Dir[File.join(File.dirname(__FILE__), '**', '*.rb')].map { |f| File.expand_path(f) }
 
   extend self
+  extend PryMoves::Restartable
+
+  attr_accessor :is_open, :trace, :stack_tips,
+    :stop_on_breakpoints, :launched_specs_examples, :debug_called_times
 
-  attr_accessor :is_open
+  def reset
+    self.launched_specs_examples = 0
+    self.stop_on_breakpoints = true
+    self.debug_called_times = 0
+  end
+
+  def debug(message = nil, at: nil, options: nil)
+    pry_moves_stack_end = true
+    PryMoves.re_execution
+    if PryMoves.stop_on_breakpoints
+      self.debug_called_times += 1
+      if at
+        return unless self.debug_called_times == at
+      end
+      if message
+        PryMoves.messages << (message.is_a?(String) ? message : message.ai)
+      end
+      binding.pry options
+      PryMoves.re_execution
+    end
+  end
+
+  def error(message)
+    debug message, options: {is_error: true}
+  end
 
   # Checks that a binding is in a local file context. Extracted from
   # https://github.com/pry/pry/blob/master/lib/pry/default_commands/context.rb
@@ -36,9 +79,18 @@ module PryMoves
     @semaphore ||= Mutex.new
   end
 
+  def messages
+    @messages ||= []
+  end
+
+  def add_command(command, &block)
+    Pry.commands.block_command command, "", &block
+  end
+
   def locked?
     semaphore.locked?
   end
+  alias tracing? locked?
 
   def lock
     semaphore.lock unless semaphore.locked?
@@ -59,6 +111,25 @@ module PryMoves
     true
   end
 
+  def trigger(event, context)
+    triggers[event].each {|t| t.call context}
+  end
+
+  def triggers
+    @triggers ||= Hash.new do |hash, key|
+      hash[key] = []
+    end
+  end
+
+  TRIGGERS = [:each_new_run, :restart]
+  def on(trigger, &block)
+    error "Invalid trigger, possible triggers: #{TRIGGERS}", trigger unless trigger.in? TRIGGERS
+    triggers[trigger] << block
+  end
+
   # Reference to currently running pry-remote server. Used by the tracer.
   attr_accessor :current_remote_server
 end
+
+PryMoves.reset
+PryMoves.trace = true if ENV['TRACE_MOVES']

data/lib/pry-stack_explorer/frame_helpers.rb

@@ -0,0 +1,114 @@
+module PryStackExplorer; end
+module PryStackExplorer::FrameHelpers
+  private
+
+  # @return [PryStackExplorer::FrameManager] The active frame manager for
+  #   the current `Pry` instance.
+  def frame_manager
+    PryStackExplorer.frame_manager(_pry_)
+  end
+
+  # @return [Array<PryStackExplorer::FrameManager>] All the frame
+  #   managers for the current `Pry` instance.
+  def frame_managers
+    PryStackExplorer.frame_managers(_pry_)
+  end
+
+  # @return [Boolean] Whether there is a context to return to once
+  #   the current `frame_manager` is popped.
+  def prior_context_exists?
+    frame_managers.count > 1 || frame_manager.prior_binding
+  end
+
+  # Return a description of the frame (binding).
+  # This is only useful for regular old bindings that have not been
+  # enhanced by `#of_caller`.
+  # @param [Binding] b The binding.
+  # @return [String] A description of the frame (binding).
+  def frame_description(b)
+    b_self = b.eval('self')
+    b_method = b.eval('__method__')
+
+    if b_method && b_method != :__binding__ && b_method != :__binding_impl__
+      b_method.to_s
+    elsif b_self.instance_of?(Module)
+      "<module:#{b_self}>"
+    elsif b_self.instance_of?(Class)
+      "<class:#{b_self}>"
+    else
+      "<main>"
+    end
+  end
+
+  # Return a description of the passed binding object. Accepts an
+  # optional `verbose` parameter.
+  # @param [Binding] b The binding.
+  # @param [Boolean] verbose Whether to generate a verbose description.
+  # @return [String] The description of the binding.
+  def frame_info(b, verbose = false)
+    b_self = b.eval('self')
+    type = b.frame_type ? "[#{b.frame_type}]".ljust(9) : ""
+    desc = b.frame_description ? "#{b.frame_description}" : "#{frame_description(b)}"
+    sig = PryMoves::Formatter.new.method_signature b
+
+    self_clipped = "#{Pry.view_clip(b_self)}"
+    path = "@ #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
+
+    if !verbose
+      "#{type} #{desc} #{sig}"
+    else
+      "#{type} #{desc} #{sig}\n      in #{self_clipped} #{path}"
+    end
+  end
+
+  def find_frame_by_regex(regex, up_or_down)
+    frame_index = find_frame_by_block(up_or_down) do |b|
+      (b.eval('"#{__FILE__}:#{__LINE__}"') =~ regex) or
+        (b.eval("__method__").to_s =~ regex)
+    end
+
+    frame_index || raise(Pry::CommandError, "No frame that matches #{regex.source} found")
+  end
+
+  def find_frame_by_block(up_or_down)
+    start_index = frame_manager.binding_index
+
+    if up_or_down == :down
+      enum = start_index == 0 ? [].each :
+        frame_manager.bindings[0..start_index - 1].reverse_each
+    else
+      enum = frame_manager.bindings[start_index + 1..-1]
+    end
+
+    new_frame = enum.find do |b|
+      yield(b)
+    end
+
+    frame_manager.bindings.index(new_frame)
+  end
+
+  def find_frame_by_direction(dir, step_into_vapid: false)
+    frame_index = find_frame_by_block(dir) do |b|
+      step_into_vapid or not b.hidden
+    end
+
+    if !frame_index and !step_into_vapid
+      frame_index = find_frame_by_block(dir) {true}
+    end
+
+    frame_index ||
+      raise(Pry::CommandError, "At #{dir == :up ? 'top' : 'bottom'} of stack, cannot go further")
+  end
+
+  def move(direction, param)
+    raise Pry::CommandError, "Nowhere to go" unless frame_manager
+
+    if param == '+' or param.nil?
+      index = find_frame_by_direction direction, step_into_vapid: param == '+'
+      frame_manager.change_frame_to index
+    else
+      index = find_frame_by_regex(Regexp.new(param), direction)
+      frame_manager.change_frame_to index
+    end
+  end
+end

data/lib/pry-stack_explorer/frame_manager.rb

@@ -33,13 +33,6 @@ module PryStackExplorer
       @prior_backtrace   = _pry_.backtrace
     end
 
-    def filter_bindings(vapid_frames: false)
-      bindings.reject do |binding|
-        !vapid_frames and
-          binding.local_variable_defined?(:vapid_frame)
-      end
-    end
-
     # Iterate over all frames
     def each(&block)
       bindings.each(&block)
@@ -61,14 +54,18 @@ module PryStackExplorer
     # @param [Fixnum] index The index.
     def set_binding_index_safely(index)
       if index > bindings.size - 1
-        raise Pry::CommandError, "At top of stack, cannot go further"
+        raise Pry::CommandError, "Shouldn't happen: At top of stack, cannot go further"
       elsif index < 0
-        raise Pry::CommandError, "At bottom of stack, cannot go further"
+        raise Pry::CommandError, "Shouldn't happen: At bottom of stack, cannot go further"
       else
         self.binding_index = index
       end
     end
 
+    def goto_index index
+      change_frame_to bindings.index {|b| b.index == index }
+    end
+
     # Change active frame to the one indexed by `index`.
     # Note that indexing base is `0`
     # @param [Fixnum] index The index of the frame.

data/lib/pry-stack_explorer/pry-stack_explorer.rb

@@ -1,7 +1,7 @@
 # pry-stack_explorer.rb
 # (C) John Mair (banisterfiend); MIT license
 
-require "pry-stack_explorer/commands"
+require "pry-stack_explorer/stack_commands"
 require "pry-stack_explorer/frame_manager"
 require "pry-stack_explorer/when_started_hook"
 require "binding_of_caller"
@@ -121,20 +121,5 @@ end
 Pry.config.hooks.add_hook(:when_started, :save_caller_bindings, PryStackExplorer::WhenStartedHook.new)
 
 # Import the StackExplorer commands
-Pry.config.commands.import PryStackExplorer::Commands
+Pry.config.commands.import PryStackExplorer::COMMANDS
 
-# monkey-patch the whereami command to show some frame information,
-# useful for navigating stack.
-Pry.config.hooks.add_hook(:before_whereami, :stack_explorer) do
-  if PryStackExplorer.frame_manager(_pry_) && !internal_binding?(target)
-    bindings      = PryStackExplorer.frame_manager(_pry_).bindings
-    binding_index = PryStackExplorer.frame_manager(_pry_).binding_index
-
-    info = "#{Pry::Helpers::Text.bold('Frame:')} "+
-      "#{binding_index}/#{bindings.size - 1} "+
-      "#{bindings[binding_index].frame_type}"
-
-    output.puts "\n"
-    output.puts info
-  end
-end