pry-moves 0.1.13 → 1.0.2

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

@@ -1,117 +1,13 @@
-module PryStackExplorer
-  module 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::Helpers.method_signature_with_owner 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
+require_relative 'frame_helpers.rb'
 
-      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(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)
-        end
-
-      frame_index ||
-        raise(Pry::CommandError, "At #{up_or_down == :up ? 'top' : 'bottom'} of stack, cannot go further")
-    end
+module PryStackExplorer
 
-    def move(direction, param)
-      raise Pry::CommandError, "Nowhere to go" unless frame_manager
+  COMMANDS = Pry::CommandSet.new do
 
-      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
+    block_command '%', 'Print current stack frame' do
+      run 'whereami'
     end
-  end
-
 
-  Commands = Pry::CommandSet.new do
     create_command "up", "Go up to the caller's context." do
       include FrameHelpers
 
@@ -159,6 +55,7 @@ module PryStackExplorer
         frame_manager.change_frame_to 0
       end
     end
+    alias_command 'bm', 'bottom'
 
     create_command "frame", "Switch to a particular frame." do
       include FrameHelpers

data/lib/pry-stack_explorer/when_started_hook.rb

@@ -2,94 +2,39 @@ 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_)
       start_from_console = target.eval('__callee__').nil? &&
         target.eval('__FILE__') == '<main>' &&
         target.eval('__LINE__') == 0
       return if start_from_console
 
-      target ||= _pry_.binding_stack.first if _pry_
       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]
-
+        initial_frame ||= 0
         unless valid_call_stack?(bindings)
           raise ArgumentError, ":call_stack must be an array of bindings"
         end
       else
-        bindings = caller_bindings(target)
-        initial_frame = bindings.find do |b|
-          not b.local_variable_defined?(:vapid_frame)
+        bindings = PryMoves::BindingsStack.new options
+        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
-        options[:initial_frame] = bindings.index initial_frame
       end
 
-      PryStackExplorer.create_and_push_frame_manager bindings, _pry_, initial_frame: options[:initial_frame]
+      PryStackExplorer.create_and_push_frame_manager bindings, _pry_, initial_frame: 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
-        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
-    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
-
     def valid_call_stack?(bindings)
       bindings.any? && bindings.all? { |v| v.is_a?(Binding) }
     end

data/playground/Gemfile.lock

@@ -1,17 +1,21 @@
 PATH
   remote: ..
   specs:
-    pry-moves (0.1.11)
+    pry-moves (1.0.1)
       binding_of_caller (~> 0.7)
-      pry (>= 0.10.4, < 1)
+      colorize (~> 0.8)
+      diffy
+      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.2)
-    debug_inspector (0.0.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    debug_inspector (1.1.0)
+    diffy (3.4.0)
     method_source (0.9.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -24,4 +28,4 @@ DEPENDENCIES
   pry-moves!
 
 BUNDLED WITH
-   1.17.0
+   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

data/playground/sand.rb

@@ -1,3 +1,6 @@
+# cd playground
+# be ruby sand.rb
+
 require 'pry-moves'
 require './tracer.rb'
 
@@ -7,42 +10,41 @@ def fi(param)
   puts param
 end
 
-class A
+class Sand
 
   def initialize
     puts :xuilo
   end
 
-  def aa
+  def some_logic
     puts 'aa: step 1'
     puts 'aa: step 2'
   end
 
-  def bb
+  def method_with_hidden_stack
     debug_redirect = :aa
     hide_from_stack = true
     puts 'bb: step 1'
     puts 'bb: step 2'
-    aa
+    some_logic
   end
 
-  def cc
+  def debugged_method
     koko = :love
-    binding.pry
-    bb
+    debug
+    method_with_hidden_stack
     (2..4).each do |i|
       puts i
     end
     puts :two
   end
-  alias cc_al cc
+  alias debugged_method_alias debugged_method
 
 end
 
 puts :prepare
 
-A.new.cc_al
-A.new.cc_al
+Sand.new.method_with_hidden_stack
 
 
 bb = 1

data/playground/test.rb

@@ -2,4 +2,8 @@ require 'pry-moves'
 require_relative '../playground/playground.rb'
 
 i = Playground.new
-i.recursion
+if ARGV[0]
+  i.send ARGV[0]
+else
+  i.zaloop
+end

data/playground/test.sh

@@ -0,0 +1 @@
+bundle exec ruby playground/test.rb $@

data/pry-moves.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   # Dependencies
-  gem.required_ruby_version = '>= 1.8.7'
-  gem.add_runtime_dependency 'pry', '>= 0.10.4', '< 0.12.0'
+  gem.required_ruby_version = '>= 1.8.7', '< 3'
+  gem.add_runtime_dependency 'pry', '>= 0.10.4', '< 0.13'
   gem.add_runtime_dependency 'binding_of_caller', '~> 0.7'
+  gem.add_runtime_dependency 'colorize', '~> 0.8'
+  gem.add_runtime_dependency 'diffy', '~> 3.4.0'
   gem.add_development_dependency 'pry-remote', '~> 0.1.6'
 end

data/publish.sh

@@ -1,2 +1,3 @@
-gem build pry-moves.gemspec
+bundle exec rspec && \
+gem build pry-moves.gemspec && \
 gem push pry-moves-`ruby -e 'require "./lib/pry-moves/version.rb"; puts PryMoves::VERSION'`.gem

data/spec/backtrace_spec.rb

@@ -7,25 +7,23 @@ describe 'backtrace' do
       [nil, 'stop in level_c'],
       ['bt', lambda{|b, output|
         lines = output.split("\n").reverse
-        expect(lines[0]).to end_with 'level_c(param=?)'
-        expect(lines[1]).to end_with 'level_a()'
-        expect(lines[2]).to include 'Playground:'
-        expect(lines[3]).to end_with ':block'
-        expect(lines[4]).to include 'RSpec::ExampleGroups'
-        expect(lines.count).to be 5
+        expect(lines[0]).to end_with 'level_c(param=? nil)'
+        expect(lines[1]).to end_with 'frames hidden: 1'
+        expect(lines[2]).to end_with 'level_a()'
+        expect(lines[3]).to include 'Playground'
+        expect(lines[4]).to end_with ':block'
+        expect(lines[5]).to include 'RSpec::ExampleGroups'
+        expect(lines.count).to be 7
       }],
-      ['bt all', lambda{|b, output|
+      ['bt hidden', lambda{|b, output|
         lines = output.split("\n").reverse
         # show hidden frame
         expect(lines[1]).to end_with 'level_b()'
-        expect(lines.count).to be 6
+        expect(lines.count).to be 11
       }],
-      ['bt 2', lambda{|b, output|
+      ['up', lambda{|b, output|
         lines = output.split("\n").reverse
-        expect(lines[0]).to end_with 'level_c(param=?)'
-        expect(lines[1]).to end_with 'level_a()'
-        expect(lines[3]).to start_with 'Latest 2 lines'
-        expect(lines.count).to be 4
+        expect(lines[1]).to end_with 'level_b # inside of level_a'
       }],
     ]
     Playground.new.level_a

data/spec/blocks_spec.rb

@@ -5,7 +5,7 @@ describe 'blocks' do
   it 'should go next over blocks' do
     breakpoints [
       [nil, 'stop in zaloop'],
-      ['n', ''],
+      ['n', 'iterator line'],
       # repeat commands
       ['', 'inside block'],
       ['', nil],
@@ -15,11 +15,10 @@ describe 'blocks' do
       ['', 'inside block'],
       ['pass', {output: '=> 0'}],
 
-      ['f', 'after block'],
-      ['pass', {output: '=> 0'}],
+      ['f', 'iterator line'],
+      ['f', 'after sub-zaloop'],
+      ['pass', {output: '=> :root'}],
 
-      ['f', 'post_yield'], # Тут хорошо бы, чтобы сразу шёл на "after block",
-      # но пока и не понятно, как это угадать
       ['f', 'after block'],
       ['pass', {output: '=> :root'}],
     ]
@@ -39,7 +38,7 @@ describe 'blocks' do
   it 'should finish block with sub-calls' do
     breakpoints [
       [nil, 'stop in zaloop'],
-      ['n', ''],
+      ['n', 'iterator line'],
       ['', 'inside block'],
       ['f', 'after block'],
       ['pass', {output: '=> :root'}],
@@ -79,7 +78,7 @@ describe 'blocks' do
       ['n', 'iterator line'],
       ['n', 'inside block'],
       ['iterate', 'iterator line'],
-      ['n', 'exit'],
+      ['n', 'exit']
     ]
     Playground.new.native_block early_return: true
     :exit # exit
@@ -91,10 +90,44 @@ describe 'blocks' do
       ['n', 'iterator line'],
       ['n', 'inside block'],
       ['iterate', 'iterator line'],
-      ['n', 'exit'],
+      ['n', 'exit']
     ]
     Playground.new.nested_block early_return: true
     :exit # exit
   end
+
+  it 'should iterate over one-line in block' do
+    breakpoints [
+      [nil, 'stop in one_line_in_block'],
+      ['n', 'iterator line'],
+      ['n', 'inside block'],
+      ['i', {output: '=> 0'}],
+      ['n', 'inside block'],
+      ['i', {output: '=> 1'}],
+      ['n', 'after block'],
+    ]
+    Playground.new.one_line_in_block
+  end
+
+  it 'should skip one-line block' do
+    breakpoints [
+      [nil, 'stop in one_line_block'],
+      ['n', 'iterator line'],
+      ['n', 'after block']
+    ]
+    Playground.new.one_line_block
+  end
+
+  it 'should skip parentheses in loop' do
+    breakpoints [
+      [nil, 'stop in parentheses_in_loop'],
+      ['n', nil],
+      ['n', 'iterator line'],
+      ['n', 'inside block'],
+      ['n', 'iterator line'],
+      ['n', 'after block']
+    ]
+    Playground.new.parentheses_in_loop
+  end
   
 end