pry-moves 0.1.9 → 1.0.0

data/lib/pry-moves/restartable.rb

@@ -0,0 +1,38 @@
+module PryMoves::Restartable
+
+  attr_accessor :restart_requested, :reload_requested,
+    :reload_rake_tasks
+
+  def restartable
+    trigger :new_run
+    yield
+    re_execution
+  rescue PryMoves::Restart
+    self.restart_requested = false
+    PryMoves.reset
+    trigger :restart
+    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.9'
+  VERSION = '1.0.0'
 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,17 +1,30 @@
 require 'pry' unless defined? Pry
 
 require 'pry-moves/version'
-require 'pry-moves/trace_commands'
-require 'pry-moves/tracer'
 require 'pry-moves/pry_ext'
 require 'pry-moves/commands'
+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 '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
@@ -20,8 +33,30 @@ 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,
+    :stop_on_breakpoints, :launched_specs_examples, :debug_called_times
+
+  def reset
+    self.launched_specs_examples = 0
+    self.stop_on_breakpoints = true
+    self.debug_called_times = 0
+  end
 
-  attr_accessor :is_open
+  def debug(message = nil, at: nil)
+    pry_moves_stack_root = true
+    PryMoves.re_execution
+    if PryMoves.stop_on_breakpoints
+      if at
+        self.debug_called_times += 1
+        return unless self.debug_called_times == at
+      end
+      PryMoves.messages << message if message
+      binding.pry
+      PryMoves.re_execution
+    end
+  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
@@ -34,9 +69,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?
@@ -57,6 +101,23 @@ module PryMoves
     true
   end
 
+  def trigger(event)
+    triggers[event].each &:call
+  end
+
+  def triggers
+    @triggers ||= Hash.new do |hash, key|
+      hash[key] = []
+    end
+  end
+
+  def on(trigger, &block)
+    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/VERSION

@@ -0,0 +1,2 @@
+Forked and modified copy of pry-stack_explorer v0.4.9.
+Latest upstream merged: v0.4.9.3

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"
@@ -108,7 +108,7 @@ module PryStackExplorer
       (b1.eval('self').equal?(b2.eval('self'))) &&
         (b1.eval('__method__') == b2.eval('__method__')) &&
         (b1.eval('local_variables').map { |v| b1.eval("#{v}") }.equal?(
-         b2.eval('local_variables').map { |v| b2.eval("#{v}") }))
+        b2.eval('local_variables').map { |v| b2.eval("#{v}") }))
     end
   end
 end
@@ -117,23 +117,9 @@ Pry.config.hooks.add_hook(:after_session, :delete_frame_manager) do |_, _, _pry_
   PryStackExplorer.clear_frame_managers(_pry_)
 end
 
+# Can be moved to start_with_pry_nav to isolate from other use cases of Pry
 Pry.config.hooks.add_hook(:when_started, :save_caller_bindings, PryStackExplorer::WhenStartedHook.new)
 
 # Import the StackExplorer commands
 Pry.config.commands.import PryStackExplorer::Commands
 
-# monkey-patch the whereami command to show some frame information,
-# useful for navigating stack.
-Pry.config.commands.before_command("whereami") do |num|
-  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

data/lib/pry-stack_explorer/{commands.rb → stack_commands.rb}

@@ -49,7 +49,7 @@ module PryStackExplorer
       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::Helpers.method_signature_with_owner b
+      sig = PryMoves::Formatter.new.method_signature b
 
       self_clipped = "#{Pry.view_clip(b_self)}"
       path = "@ #{b.eval('__FILE__')}:#{b.eval('__LINE__')}"
@@ -87,14 +87,18 @@ module PryStackExplorer
       frame_manager.bindings.index(new_frame)
     end
 
-    def find_frame_by_direction(up_or_down, step_into_vapid: false)
-      frame_index = find_frame_by_block(up_or_down) do |b|
-          step_into_vapid or
-            not b.local_variable_defined?(:vapid_frame)
+    def find_frame_by_direction(dir, step_into_vapid: false)
+      frame_index = find_frame_by_block(dir) do |b|
+        step_into_vapid or
+            not frame_manager.bindings.vapid?(b)
         end
 
+      if !frame_index and !step_into_vapid
+        frame_index = find_frame_by_block(dir) {true}
+      end
+
       frame_index ||
-        raise(Pry::CommandError, "At #{up_or_down == :up ? 'top' : 'bottom'} of stack, cannot go further")
+        raise(Pry::CommandError, "At #{dir == :up ? 'top' : 'bottom'} of stack, cannot go further")
     end
 
     def move(direction, param)

data/lib/pry-stack_explorer/when_started_hook.rb

@@ -2,84 +2,38 @@ module PryStackExplorer
   class WhenStartedHook
     include Pry::Helpers::BaseHelpers
 
-    def caller_bindings(target)
-      bindings = binding.callers
-      pre_callers = Thread.current[:pre_callers]
-      bindings = bindings + pre_callers if pre_callers
-      bindings = remove_internal_frames(bindings)
-      mark_vapid_frames(bindings)
-      bindings
-    end
-
     def call(target, options, _pry_)
-      target ||= _pry_.binding_stack.first if _pry_
+      start_from_console = target.eval('__callee__').nil? &&
+        target.eval('__FILE__') == '<main>' &&
+        target.eval('__LINE__') == 0
+      return if start_from_console
+
       options = {
-        :call_stack    => true,
-        :initial_frame => 0
+        call_stack: true
       }.merge!(options)
 
-      return if !options[:call_stack]
+      return unless options[:call_stack]
+      initial_frame = options[:initial_frame]
 
       if options[:call_stack].is_a?(Array)
         bindings = options[:call_stack]
-
-        if !valid_call_stack?(bindings)
+        initial_frame ||= 0
+        unless valid_call_stack?(bindings)
           raise ArgumentError, ":call_stack must be an array of bindings"
         end
       else
-        bindings = caller_bindings(target)
-      end
-
-      PryStackExplorer.create_and_push_frame_manager bindings, _pry_, :initial_frame => options[:initial_frame]
-    end
-
-    private
-
-    def mark_vapid_frames(bindings)
-      stepped_out = false
-      actual_file, actual_method = nil, nil
-
-      bindings.each do |binding|
-        if stepped_out
-          if actual_file == binding.eval("__FILE__") and actual_method == binding.eval("__method__")
-            stepped_out = false
-          else
-            binding.local_variable_set :vapid_frame, true
-          end
-        elsif binding.frame_type == :block
-          stepped_out = true
-          actual_file = binding.eval("__FILE__")
-          actual_method = binding.eval("__method__")
-        end
-
-        if binding.local_variable_defined? :hide_from_stack
-          binding.local_variable_set :vapid_frame, true
+        bindings = PryMoves::BindingsStack.new
+        initial_frame ||= bindings.suggest_initial_frame_index
+        # if Thread.current[:pry_moves_debug] and initial_frame > 0
+        if initial_frame > 0
+          PryMoves.messages << "👽  Frames hidden: #{initial_frame}"
         end
       end
-    end
-
-    # remove internal frames related to setting up the session
-    def remove_internal_frames(bindings)
-      i = top_internal_frame_index(bindings)
-      # DEBUG:
-      #bindings.each_with_index do |b, index|
-      #  puts "#{index}: #{b.eval("self.class")} #{b.eval("__method__")}"
-      #end
-      #puts "FOUND top internal frame: #{bindings.size} => #{i}"
 
-      bindings.drop i+1
+      PryStackExplorer.create_and_push_frame_manager bindings, _pry_, initial_frame: initial_frame
     end
 
-    def top_internal_frame_index(bindings)
-      bindings.rindex do |b|
-        if b.frame_type == :method
-          self_, method = b.eval("self"), b.eval("__method__")
-          self_.equal?(Pry) && method == :start ||
-            self_.class == Binding && method == :pry ||
-            self_.class == PryMoves::Tracer && method == :tracing_func
-        end
-      end
-    end
+    private
 
     def valid_call_stack?(bindings)
       bindings.any? && bindings.all? { |v| v.is_a?(Binding) }

data/playground/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: ..
   specs:
-    pry-moves (0.1.8)
+    pry-moves (1.0.0)
       binding_of_caller (~> 0.7)
-      pry (>= 0.9.10, < 0.11.0)
+      colorize (~> 0.8)
+      pry (>= 0.10.4, < 0.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
-    coderay (1.1.1)
+    coderay (1.1.3)
+    colorize (0.8.1)
     debug_inspector (0.0.3)
-    method_source (0.8.2)
-    pry (0.10.4)
+    method_source (0.9.2)
+    pry (0.12.2)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    slop (3.6.0)
+      method_source (~> 0.9.0)
 
 PLATFORMS
   ruby
@@ -26,4 +26,4 @@ DEPENDENCIES
   pry-moves!
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/playground/README.md

@@ -2,6 +2,7 @@
 
 ```
 be ruby sand.rb
+be ruby test.rb
 ```
 
 ## Conditions to be met

data/playground/playground.rb

@@ -16,6 +16,23 @@ class Playground
     binding.pry # step_into stop
     something_inside # point to step inside
   end
+  
+  def skip_hidden_impl
+    binding.pry # skip_hidden_impl stop
+    hidden_self.something_inside # point to step inside
+  end
+
+  def hidden_self
+    hide_from_stack = true # hidden_self 1
+    self # hidden_self 2
+  end
+
+  def hidden_stop
+    hide_from_stack = true
+    binding.pry # hidden stop
+    dummy = :ok_next # hidden_stop for next
+    dummy = :ok_step # hidden_stop for step
+  end
 
   def continue
     binding.pry # first stop
@@ -39,6 +56,16 @@ class Playground
     step_by_name
     :after_step_by_name # after_step_by_name
   end
+  
+  def early_return_wrap
+    early_return
+    :after_return # after early return
+  end
+  
+  def early_return
+    return true if level_c # at early return
+    dummy = 1
+  end
 
   def level_a
     level_b # inside of level_a
@@ -52,7 +79,7 @@ class Playground
   def level_c(param = nil)
     binding.pry # stop in level_c
     self
-  end
+  end # exit from level_c
 
   def nested_block(early_return: false)
     binding.pry # stop in nested_block
@@ -62,7 +89,7 @@ class Playground
     end
     :after_block # after block
   end
-
+  
   def native_block(early_return: false)
     binding.pry # stop in native_block
     2.times do |i| # iterator line
@@ -72,25 +99,83 @@ class Playground
     :after_block # after block
   end
 
+  def one_line_in_block
+    binding.pry # stop in one_line_in_block
+    iterator do |i| # iterator line
+      dummy = 1 # inside block
+    end
+    :after_block # after block
+  end
+
+  def one_line_block
+    binding.pry # stop in one_line_block
+    iterator { |i| dummy = 1 } # iterator line
+    :after_block # after block
+  end
+  
+  def parentheses_in_loop
+    binding.pry # stop in parentheses_in_loop
+    i = 2
+    while (i = i - 1) > 0 # iterator line
+      dummy = 1 # inside block
+    end
+    :after_block # after block
+  end
+
   def zaloop(pass = :root)
     binding.pry if pass == :root # stop in zaloop
-    iterator do |i|
+    iterator do |i| # iterator line
       dummy = 1 # inside block
       zaloop i if pass == :root
+      return unless pass == :root # after sub-zaloop
     end
     :after_block # after block
-  end
+  end # exit from zaloop
 
   def method_with_redirection
-    debug_redirect = '=level_a' # at method_with_redirection
+    debug_redirect = :level_a # at method_with_redirection
     level_a
   end
 
+  def instant_redirection
+    debug_redirect = '=something_inside'
+    binding.pry # at instant_redirection
+    something_inside
+  end
+
   def redirection_host
     binding.pry # redirection host
     method_with_redirection
   end
 
+  def something_inside
+    :something # some internal line
+  end
+  
+  def method_with_breakpoints
+    binding.pry # method_with_breakpoints host
+    dummy = 1 # some internal line
+    debug_ # breakpoint
+    dummy = 1 # after breakpoint
+    dummy = 1 # after after breakpoint
+    debug_ # breakpoint 2
+    dummy = 1 # after breakpoint 2
+  end
+
+  def skip_test
+    binding.pry # stop in skip_test
+    skipped_method.not_skipped_method # next step
+  end
+
+  def skipped_method
+    pry_moves_skip = true # at skipped_method
+    self # at skipped_method
+  end
+
+  def not_skipped_method
+    :not_skipped_method # at not_skipped_method
+  end
+
   private
 
   def iterator
@@ -99,10 +184,10 @@ class Playground
       yield i
       :post_yield # post_yield
     end
-  end
-
-  def something_inside
-    :something # some internal line
+  end # exit from iterator
+  
+  def debug_
+    :something # inside of debug method
   end
 
 end