pry-byebug 1.3.3 → 2.0.0

data/lib/pry-byebug/processor.rb

@@ -2,126 +2,104 @@ require 'pry'
 require 'byebug'
 
 module PryByebug
+  #
+  # Extends raw byebug's processor.
+  #
   class Processor < Byebug::Processor
     attr_accessor :pry
 
     def initialize(interface = Byebug::LocalInterface.new)
       super(interface)
-      
+
       Byebug.handler = self
-      @always_enabled = true
-      @delayed = Hash.new(0)
     end
 
     # Wrap a Pry REPL to catch navigational commands and act on them.
-    def run(initial = true, &block)
+    def run(initial = false, &_block)
       return_value = nil
 
-      command = catch(:breakout_nav) do  # Throws from PryByebug::Commands
-        return_value = yield
-        {}    # Nothing thrown == no navigational command
-      end
+      if initial
+        Byebug.start
+        Byebug.current_context.step_out(3)
+      else
+        command = catch(:breakout_nav) do  # Throws from PryByebug::Commands
+          return_value = yield
+          {}    # Nothing thrown == no navigational command
+        end
 
-      times = (command[:times] || 1).to_i   # Command argument
-      times = 1 if times <= 0
+        times = (command[:times] || 1).to_i   # Command argument
+        times = 1 if times <= 0
 
-      if [:step, :next, :finish].include? command[:action]
-        @pry = command[:pry]   # Pry instance to resume after stepping
-        Byebug.start unless Byebug.started?
+        if [:step, :next, :finish].include? command[:action]
+          @pry = command[:pry]   # Pry instance to resume after stepping
 
-        if initial
-          # Movement when on the initial binding.pry line will have a frame
-          # inside Byebug. If we step normally, it'll stop inside this
-          # Processor. So jump out and stop at the above frame, then step/next
-          # from our callback.
-          @delayed[command[:action]] = times
-          Byebug.current_context.step_out(2)
-        elsif :next == command[:action]
-          Byebug.current_context.step_over(times, 0)
+          if :next == command[:action]
+            Byebug.current_context.step_over(times, 0)
 
-        elsif :step == command[:action]
-          Byebug.current_context.step_into(times)
+          elsif :step == command[:action]
+            Byebug.current_context.step_into(times)
 
-        elsif :finish == command[:action]
-          Byebug.current_context.step_out(0)
+          elsif :finish == command[:action]
+            Byebug.current_context.step_out(times)
+          end
         end
-      else
-        stop
       end
 
       return_value
     end
 
-    # Adjust debugging. When set to false, the Processor will manage enabling
-    # and disabling the debugger itself. When set to true, byebug is always
-    # enabled.
-    def debugging=(enabled)
-      if enabled
-        @always_enabled = true
-        Byebug.start unless Byebug.started?
-      else
-        @always_enabled = false
-        # Byebug will get stopped if necessary in `stop` once the repl ends.
-      end
-    end
-
     # --- Callbacks from byebug C extension ---
-    def at_line(context, file, line)
-       # If any delayed nexts/steps, do 'em.
-      if @delayed[:next] > 1
-        context.step_over(@delayed[:next] - 1, 0)
 
-      elsif @delayed[:step] > 1
-        context.step_into(@delayed[:step] - 1)
+    #
+    # Called when the wants to stop at a regular line
+    #
+    def at_line(context, _file, _line)
+      resume_pry(context)
+    end
+
+    #
+    # Called when the wants to stop right before a method return
+    #
+    def at_return(context, _file, _line)
+      resume_pry(context)
+    end
 
-      elsif @delayed[:finish] > 1
-        context.step_out(@delayed[:finish] - 1)
+    #
+    # Called when a breakpoint is hit. Note that `at_line`` is called
+    # inmediately after with the context's `stop_reason == :breakpoint`, so we
+    # must not resume the pry instance here
+    #
+    def at_breakpoint(_context, breakpoint)
+      @pry ||= Pry.new
 
-      # Otherwise, resume the pry session at the stopped line.
-      else
-        resume_pry context
-      end
+      brkpt_num = "\nBreakpoint #{breakpoint.id}. "
+      @pry.output.print Pry::Helpers::Text.bold(brkpt_num)
 
-      @delayed = Hash.new(0)
-    end
+      n_hits = breakpoint.hit_count
+      @pry.output.puts(n_hits == 1 ? 'First hit' : "Hit #{n_hits} times.")
 
-    # Called when a breakpoint is triggered. Note: `at_line`` is called
-    # immediately after with the context's `stop_reason == :breakpoint`.
-    def at_breakpoint(context, breakpoint)
-      @pry.output.print Pry::Helpers::Text.bold("\nBreakpoint #{breakpoint.id}. ")
-      @pry.output.puts  (breakpoint.hit_count == 1 ?
-                           'First hit.' :
-                           "Hit #{breakpoint.hit_count} times." )
-      if (expr = breakpoint.expr)
-        @pry.output.print Pry::Helpers::Text.bold("Condition: ")
-        @pry.output.puts expr
-      end
-    end
+      expr = breakpoint.expr
+      return unless expr
 
-    def at_catchpoint(context, exception)
-      # TODO
+      @pry.output.print Pry::Helpers::Text.bold('Condition: ')
+      @pry.output.puts expr
     end
 
     private
 
-      #
-      # Resume an existing Pry REPL at the paused point.
-      #
-      def resume_pry(context)
-        new_binding = context.frame_binding(0)
-        Byebug.stop unless @always_enabled
-
-        run(false) do
-          @pry.repl new_binding
-        end
-      end
-
-      # Cleanup when debugging is stopped and execution continues.
-      def stop
-        Byebug.stop if !@always_enabled && Byebug.started?
-        if PryByebug.current_remote_server   # Cleanup DRb remote if running
-          PryByebug.current_remote_server.teardown
+    #
+    # Resume an existing Pry REPL at the paused point.
+    #
+    def resume_pry(context)
+      new_binding = context.frame_binding(0)
+
+      run(false) do
+        if @pry
+          @pry.repl(new_binding)
+        else
+          @pry = Pry.start_without_pry_byebug(new_binding)
         end
       end
+    end
   end
 end

data/lib/pry-byebug/pry_remote_ext.rb

@@ -1,21 +1,22 @@
 require 'pry-remote'
 
 module PryRemote
+  #
+  # Overrides PryRemote::Server
+  #
   class Server
+    #
     # Override the call to Pry.start to save off current Server, and not
     # teardown the server right after Pry.start finishes.
+    #
     def run
-      if PryByebug.current_remote_server
-        raise 'Already running a pry-remote session!'
-      else
-        PryByebug.current_remote_server = self
-      end
+      fail('Already running a pry-remote session!') if
+        PryByebug.current_remote_server
+
+      PryByebug.current_remote_server = self
 
       setup
-      Pry.start @object, {
-        :input  => client.input_proxy,
-        :output => client.output
-      }
+      Pry.start @object, input: client.input_proxy, output: client.output
     end
 
     # Override to reset our saved global current server session.
@@ -35,7 +36,5 @@ end
 # 'next' on the last line of a program won't hit PryByebug::Processor#run,
 # which normally handles cleanup.
 at_exit do
-  if PryByebug.current_remote_server
-    PryByebug.current_remote_server.teardown
-  end
+  PryByebug.current_remote_server.teardown if PryByebug.current_remote_server
 end

data/lib/pry-byebug/version.rb

@@ -1,3 +1,3 @@
 module PryByebug
-  VERSION = '1.3.3'
+  VERSION = '2.0.0'
 end

data/pry-byebug.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/deivid-rodriguez/pry-byebug'
   gem.summary       = 'Fast debugging with Pry.'
-  gem.description   = %q{Combine 'pry' with 'byebug'. Adds 'step', 'next', and
-    'continue' commands to control execution.}
+  gem.description   = "Combine 'pry' with 'byebug'. Adds 'step', 'next',
+   'finish', 'continue' and 'break' commands to control execution."
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- test/*`.split("\n")
@@ -19,5 +19,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.0.0'
 
   gem.add_runtime_dependency 'pry', '~> 0.10'
-  gem.add_runtime_dependency 'byebug', '~> 2.7'
+  gem.add_runtime_dependency 'byebug', '~> 3.4'
 end

data/test/base_test.rb

@@ -1,14 +1,16 @@
 require 'test_helper'
 
+#
+# Checks current pry-byebug's context.
+#
 class BaseTest < MiniTest::Spec
   def test_main_file_context
-    Pry.stubs eval_path: "<main>"
+    Pry.stubs eval_path: '<main>'
     assert PryByebug.check_file_context(TOPLEVEL_BINDING)
   end
 
   def test_other_file_context
-    Pry.stubs eval_path: "something"
+    Pry.stubs eval_path: 'something'
     refute PryByebug.check_file_context(TOPLEVEL_BINDING)
   end
 end
-

data/test/breakpoints_test.rb

@@ -1,14 +1,20 @@
 require 'test_helper'
 
-class BreakpointsTest < MiniTest::Spec
+#
+# Tests for pry-byebug breakpoints.
+#
+class BreakpointsTestGeneral < MiniTest::Spec
   def test_add_file_raises_argument_error
-    Pry.stubs eval_path: "something"
+    Pry.stubs eval_path: 'something'
     File.stubs :exist?
     assert_raises(ArgumentError) do
-      PryByebug::Breakpoints.add_file("file", 1)
+      PryByebug::Breakpoints.add_file('file', 1)
     end
   end
 
+  #
+  # Minimal dummy example class.
+  #
   class Tester
     def self.class_method; end
     def instance_method; end
@@ -32,3 +38,96 @@ class BreakpointsTest < MiniTest::Spec
     end
   end
 end
+
+#
+# Some common specs for breakpoints
+#
+module BreakpointSpecs
+  def test_shows_breakpoint_enabled
+    @output.string.must_match @regexp
+  end
+
+  def test_shows_breakpoint_hit
+    match = @output.string.match(@regexp)
+    @output.string.must_match(/^Breakpoint #{match[:id]}\. First hit/)
+  end
+
+  def test_shows_breakpoint_line
+    @output.string.must_match(/\=> \s*#{@line}:/)
+  end
+end
+
+#
+# Tests for breakpoint commands
+#
+class BreakpointsTestCommands < Minitest::Spec
+  let(:break_first_file) { test_file('break1') }
+  let(:break_second_file) { test_file('break2') }
+
+  before do
+    Pry.color, Pry.pager, Pry.hooks = false, false, Pry::DEFAULT_HOOKS
+    @output = StringIO.new
+  end
+
+  describe 'Set Breakpoints' do
+    before do
+      @input = InputTester.new 'break --delete-all'
+      redirect_pry_io(@input, @output) { load break_first_file }
+    end
+
+    describe 'set by line number' do
+      before do
+        @input = InputTester.new('break 7')
+        redirect_pry_io(@input, @output) { load break_first_file }
+        @line = 7
+        @regexp = /^Breakpoint (?<id>\d+): #{break_first_file} @ 7 \(Enabled\)/
+      end
+
+      include BreakpointSpecs
+    end
+
+    describe 'set by method_id' do
+      before do
+        @input = InputTester.new('break Break1Example#a')
+        redirect_pry_io(@input, @output) { load break_first_file }
+        @line = 7
+        @regexp = /Breakpoint (?<id>\d+): Break1Example#a \(Enabled\)/
+      end
+
+      include BreakpointSpecs
+    end
+
+    describe 'set by method_id when its a bang method' do
+      before do
+        @input = InputTester.new('break Break1Example#c!')
+        redirect_pry_io(@input, @output) { load break_first_file }
+        @line = 17
+        @regexp = /Breakpoint (?<id>\d+): Break1Example#c! \(Enabled\)/
+      end
+
+      include BreakpointSpecs
+    end
+
+    describe 'set by method_id within context' do
+      before do
+        @input = InputTester.new('break #b')
+        redirect_pry_io(@input, @output) { load break_second_file }
+        @line = 11
+        @regexp = /Breakpoint (?<id>\d+): Break2Example#b \(Enabled\)/
+      end
+
+      include BreakpointSpecs
+    end
+  end
+
+  describe 'List breakpoints' do
+    before do
+      @input = InputTester.new('break --delete-all', 'break #b', 'breakpoints')
+      redirect_pry_io(@input, @output) { load break_second_file }
+    end
+
+    it 'shows all breakpoints' do
+      @output.string.must_match(/Yes \s*Break2Example#b/)
+    end
+  end
+end

data/test/commands_test.rb

@@ -1,178 +1,77 @@
 require 'test_helper'
 
-class CommandsTest < MiniTest::Spec
-  let(:step_file) do
-    (Pathname.new(__FILE__) + "../examples/stepping.rb").cleanpath.to_s
-  end
-
-  let(:break_first_file) do
-    (Pathname.new(__FILE__) + "../examples/break1.rb").cleanpath.to_s
+#
+# Some common specs for stepping
+#
+module SteppingSpecs
+  def self.included(spec_class)
+    spec_class.class_eval do
+      it 'shows current line' do
+        @output.string.must_match(/\=> \s*#{@line}:/)
+      end
+    end
   end
+end
 
-  let(:break_second_file) do
-    (Pathname.new(__FILE__) + "../examples/break2.rb").cleanpath.to_s
-  end
+#
+# Tests for pry-byebug commands.
+#
+class CommandsTest < MiniTest::Spec
+  let(:step_file) { test_file('stepping') }
 
   before do
-    Pry.color = false
-    Pry.pager = false
-    Pry.hooks = Pry::DEFAULT_HOOKS
+    Pry.color, Pry.pager, Pry.hooks = false, false, Pry::DEFAULT_HOOKS
     @output = StringIO.new
   end
 
   describe 'Step Command' do
     describe 'single step' do
       before do
-        @input = InputTester.new 'step'
-        redirect_pry_io(@input, @output) do
-          load step_file
-        end
+        @input, @line = InputTester.new('step'), 7
+        redirect_pry_io(@input, @output) { load step_file }
       end
 
-      it 'shows current line' do
-        @output.string.must_match /\=> 3:/
-      end
+      include SteppingSpecs
     end
 
     describe 'multiple step' do
       before do
-        @input = InputTester.new 'step 2'
-        redirect_pry_io(@input, @output) do
-          load step_file
-        end
+        @input, @line = InputTester.new('step 2'), 12
+        redirect_pry_io(@input, @output) { load step_file }
       end
 
-      it 'shows current line' do
-        @output.string.must_match /\=> 4:/
-      end
+      include SteppingSpecs
     end
   end
 
   describe 'Next Command' do
     describe 'single step' do
       before do
-        @input = InputTester.new 'next'
-        redirect_pry_io(@input, @output) do
-          load step_file
-        end
+        @input, @line = InputTester.new('break --delete-all', 'next'), 6
+        redirect_pry_io(@input, @output) { load step_file }
       end
 
-      it 'shows current line' do
-        @output.string.must_match /\=> 3:/
-      end
+      include SteppingSpecs
     end
 
     describe 'multiple step' do
       before do
-        @input = InputTester.new 'next 2'
-        redirect_pry_io(@input, @output) do
-          load step_file
-        end
+        @input, @line = InputTester.new('break --delete-all', 'next 2'), 25
+        redirect_pry_io(@input, @output) { load step_file }
       end
 
-      it 'shows current line' do
-        @output.string.must_match /\=> 20:/
-      end
+      include SteppingSpecs
     end
   end
 
-  describe 'Set Breakpoints' do
+  describe 'Finish Command' do
     before do
-      @input = InputTester.new 'break --delete-all'
-      redirect_pry_io(@input, @output) do
-        load break_first_file
-      end
-      @output = StringIO.new
-    end
-
-    describe 'set by line number' do
-      before do
-        @input = InputTester.new 'break 3'
-        redirect_pry_io(@input, @output) do
-          load break_first_file
-        end
-      end
-
-      it 'shows breakpoint enabled' do
-        @output.string.must_match /^Breakpoint [\d]+: #{break_first_file} @ 3 \(Enabled\)/
-      end
-
-      it 'shows breakpoint hit' do
-        @output.string =~ /^Breakpoint ([\d]+): #{break_first_file} @ 3 \(Enabled\)/
-        @output.string.must_match Regexp.new("^Breakpoint #{$1}\. First hit")
-      end
-
-      it 'shows breakpoint line' do
-        @output.string.must_match /\=> 3:/
-      end
-    end
-
-    describe 'set by method_id' do
-      before do
-        @input = InputTester.new 'break BreakExample#a'
-        redirect_pry_io(@input, @output) do
-          load break_first_file
-        end
-      end
-
-      it 'shows breakpoint enabled' do
-        @output.string.must_match /^Breakpoint [\d]+: BreakExample#a \(Enabled\)/
-      end
-
-      it 'shows breakpoint hit' do
-        @output.string =~ /^Breakpoint ([\d]+): BreakExample#a \(Enabled\)/
-        @output.string.must_match Regexp.new("^Breakpoint #{$1}\. First hit")
-      end
-
-      it 'shows breakpoint line' do
-        @output.string.must_match /\=> 4:/
-      end
-
-      describe 'when its a bang method' do
-        before do
-          @input = InputTester.new 'break BreakExample#c!'
-          redirect_pry_io(@input, @output) do
-            load break_first_file
-          end
-        end
-
-        it 'shows breakpoint enabled' do
-          @output.string.must_match /^Breakpoint [\d]+: BreakExample#c! \(Enabled\)/
-        end
-
-        it 'shows breakpoint hit' do
-          @output.string =~ /^Breakpoint ([\d]+): BreakExample#c! \(Enabled\)/
-          @output.string.must_match Regexp.new("^Breakpoint #{$1}\. First hit")
-        end
-
-        it 'shows breakpoint line' do
-          @output.string.must_match /\=> 14:/
-        end
-      end
-    end
-
-    describe 'set by method_id within context' do
-      before do
-        @input = InputTester.new 'break #b'
-        redirect_pry_io(@input, @output) do
-          load break_second_file
-        end
-      end
-
-      it 'shows breakpoint enabled' do
-        @output.string.must_match /^Breakpoint [\d]+: BreakExample#b \(Enabled\)/
-      end
-
-      it 'shows breakpoint hit' do
-        @output.string =~ /^Breakpoint ([\d]+): BreakExample#b \(Enabled\)/
-        @output.string.must_match Regexp.new("^Breakpoint #{$1}\. First hit")
-      end
-
-      it 'shows breakpoint line' do
-        @output.string.must_match /\=>  8:/
-      end
+      @input = \
+        InputTester.new 'break --delete-all', 'break 19', 'continue', 'finish'
+      redirect_pry_io(@input, @output) { load step_file }
+      @line = 15
     end
 
+    include SteppingSpecs
   end
 end
-