pry-byebug 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8123f22dc42ff24f284f47d77bdf74679b8025c2
-  data.tar.gz: 1803eaf3cc4e019e64ce84835bb0a288cef8cebe
+  metadata.gz: c42e1d5a58d90aa640bcd1e79be383d78286fc66
+  data.tar.gz: 32cf706c69453f75a70729fa4caf95b023642379
 SHA512:
-  metadata.gz: eecedab14af1c1eddfc82d5828a4418a239691b6ef27f67e4340458054e0646edd049ded5cde2dc1ef10efe72bf2abb70b4c759a1145710c2e25b9e59b3faeec
-  data.tar.gz: 33135d020dc22bf50e1a8f57b39a5dce8f5e8c1373cd8f380500a210b8199bf05a5c90084f286c2d003b2379703e025fe63d80465b2007dfa3d10b68849a0495
+  metadata.gz: d4e5826a3e0d91869ff79953c45e475d0ecb5252e50171a5ad18f8a667625558690af3b00e09d0b8ccb68c55257e5bc0f285edb85334388fd7a4b8ea9c6ce826
+  data.tar.gz: e87f0c3fe28da82b42e2146c108ae73b0832b4bc10d1f1b54baaefccf639580d8874cc5c7a1149fbd46500969ce3b55bd4e13b81531f1d05913735ad389fd193

data/.rubocop.yml

@@ -1,2 +1,12 @@
 Lint/Debugger:
+  Exclude:
+    - test/examples/*.rb
+
+Style/FileName:
+  Exclude:
+    - lib/pry-byebug.rb
+    - lib/pry-byebug/cli.rb
+    - test/test_helper.rb
+
+Style/ModuleFunction:
   Enabled: false

data/.travis.yml

@@ -1,7 +1,9 @@
 rvm:
 - 2.0.0
 - 2.1
+- 2.2
 - ruby-head
+
 matrix:
   allow_failures:
   - rvm: ruby-head

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.0.0 (Unreleased)
+
+- Improvements:
+  * Adds RuboCop to enforce a consistent code style.
+  * Several refactorings to keep code simpler.
+
+- Bugfixes:
+  * `binding.pry` would not stop at the correct place when called at the last
+line of a method/block.
+
+- Removals:
+  * Stepping aliases for `next` (`n`), `step` (`s`), `finish` (`f`) and
+`continue` (`c`). See #34.
+
+
 ## 2.0.0 (2014-01-09)
 
 - Improvements:

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 gem 'rake', '~> 10.3'
 
 group :development do
-  gem 'rubocop', '~> 0.25'
+  gem 'rubocop', '~> 0.26'
 end
 
 group :test do

data/README.md

@@ -1,6 +1,7 @@
 # pry-byebug
 [![Version][VersionBadge]][VersionURL]
 [![Build][TravisBadge]][TravisURL]
+[![Inline docs][InchCIBadge]](InchCIURL)
 [![Gittip][GittipBadge]][GittipURL]
 
 _Fast execution control in Pry_
@@ -9,12 +10,16 @@ Adds **step**, **next**, **finish** and **continue** commands and
 **breakpoints** to [Pry][pry] using [byebug][byebug].
 
 To use, invoke pry normally. No need to start your script or app differently.
+Execution will stop in the first statement after your `binding.pry`.
 
 ```ruby
 def some_method
-  binding.pry          # Execution will stop here.
-  puts 'Hello World'   # Run 'step' or 'next' in the console to move here.
+  puts 'Hello World' # Run 'step' in the console to move here
 end
+
+binding.pry
+some_method          # Execution will stop here.
+puts 'Goodbye World' # Run 'next' in the console to move here.
 ```
 
 
@@ -37,14 +42,43 @@ to use it to debug your tests!_
 ## Execution Commands
 
 **step:** Step execution into the next line or method. Takes an optional numeric
-argument to step multiple times. Aliased to `s`
+argument to step multiple times.
 
 **next:** Step over to the next line within the same frame. Also takes an
-optional numeric argument to step multiple lines. Aliased to `n`
+optional numeric argument to step multiple lines.
+
+**finish:** Execute until current stack frame returns.
+
+**continue:** Continue program execution and end the Pry session.
+
 
-**finish:** Execute until current stack frame returns. Aliased to `f`
+## Matching Byebug Behaviour
 
-**continue:** Continue program execution and end the Pry session. Aliased to `c`
+If you're coming from Byebug or from Pry-Byebug versions previous to 3.0, you
+may be lacking the 'n', 's', 'c' and 'f' aliases for the stepping commands.
+These aliases were removed by default because they usually conflict with
+scratch variable names. But it's very easy to reenable them if you still want
+them, just add the following shortcuts to your `~/.pryrc` file:
+
+```ruby
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end
+```
+
+Also, you might find useful as well the repeat the last command by just hitting
+the `Enter` key (e.g., with `step` or `next`). To achieve that, add this to
+your `~/.pryrc` file:
+
+```ruby
+# Hit Enter to repeat last command
+Pry::Commands.command /^$/, "repeat last command" do
+  _pry_.run_command Pry.history.to_a.last
+end
+```
 
 
 ## Breakpoints
@@ -70,7 +104,7 @@ break --condition 3            # Remove the condition on breakpoint #3.
 break --delete 5               # Delete breakpoint #5.
 break --disable-all            # Disable all breakpoints.
 
-break                          # List all breakpoints. (Same as `breakpoints`)
+breaks                         # List all breakpoints. (Same as `breakpoints`)
 break --show 2                 # Show details about breakpoint #2.
 ```
 
@@ -99,9 +133,11 @@ Patches and bug reports are welcome.
 [byebug]: https://github.com/deivid-rodriguez/byebug
 [pry-debugger]: https://github.com/nixme/pry-debugger
 [pry-stack_explorer]: https://github.com/pry/pry-stack_explorer
-[VersionBadge]: https://badge.fury.io/rb/pry-byebug.png
+[VersionBadge]: https://badge.fury.io/rb/pry-byebug.svg
 [VersionURL]: http://badge.fury.io/rb/pry-byebug
-[TravisBadge]: https://secure.travis-ci.org/deivid-rodriguez/pry-byebug.png
+[TravisBadge]: https://secure.travis-ci.org/deivid-rodriguez/pry-byebug.svg
 [TravisURL]: http://travis-ci.org/deivid-rodriguez/pry-byebug
+[InchCIBadge]: http://inch-ci.org/github/deivid-rodriguez/pry-byebug.svg?branch=master
+[InchCIURL]: http://inch-ci.org/github/deivid-rodriguez/pry-byebug
 [GittipBadge]: http://img.shields.io/gittip/deivid-rodriguez.svg
 [GittipURL]: https://www.gittip.com/deivid-rodriguez

data/lib/{pry-byebug/processor.rb → byebug/processors/pry_processor.rb}

@@ -1,51 +1,55 @@
 require 'pry'
 require 'byebug'
 
-module PryByebug
+module Byebug
   #
   # Extends raw byebug's processor.
   #
-  class Processor < Byebug::Processor
+  class PryProcessor < Processor
     attr_accessor :pry
 
-    def initialize(interface = Byebug::LocalInterface.new)
+    def initialize(interface = LocalInterface.new)
       super(interface)
 
       Byebug.handler = self
     end
 
+    def start
+      Byebug.start
+      Byebug.current_context.step_out(3, true)
+    end
+
+    #
     # Wrap a Pry REPL to catch navigational commands and act on them.
-    def run(initial = false, &_block)
+    #
+    def run(&_block)
       return_value = nil
 
-      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
+      command = catch(:breakout_nav) do  # Throws from PryByebug::Commands
+        return_value = yield
+        {}    # Nothing thrown == no navigational command
+      end
 
-        if [:step, :next, :finish].include? command[:action]
-          @pry = command[:pry]   # Pry instance to resume after stepping
+      # Pry instance to resume after stepping
+      @pry = command[:pry]
 
-          if :next == command[:action]
-            Byebug.current_context.step_over(times, 0)
+      perform(command[:action], (command[:times] || '1').to_i)
 
-          elsif :step == command[:action]
-            Byebug.current_context.step_into(times)
+      return_value
+    end
 
-          elsif :finish == command[:action]
-            Byebug.current_context.step_out(times)
-          end
-        end
+    #
+    # Set up a number of navigational commands to be performed by Byebug.
+    #
+    def perform(action, times)
+      case action
+      when :next
+        Byebug.current_context.step_over(times, 0)
+      when :step
+        Byebug.current_context.step_into(times)
+      when :finish
+        Byebug.current_context.step_out(times)
       end
-
-      return_value
     end
 
     # --- Callbacks from byebug C extension ---
@@ -93,7 +97,7 @@ module PryByebug
     def resume_pry(context)
       new_binding = context.frame_binding(0)
 
-      run(false) do
+      run do
         if @pry
           @pry.repl(new_binding)
         else

data/lib/pry-byebug.rb

@@ -1,3 +1,4 @@
 require 'pry-byebug/base'
 require 'pry-byebug/pry_ext'
-require 'pry-byebug/commands'
+require 'pry/commands/stepping'
+require 'pry/commands/breakpoint'

data/lib/pry-byebug/base.rb

@@ -1,11 +1,23 @@
+#
+# Main container module for Pry-Byebug functionality
+#
 module PryByebug
   #
-  # Checks that a binding is in a local file context. Extracted from
+  # Checks that a target binding is in a local file context.
   #
-  def check_file_context(target)
+  def file_context?(target)
     file = target.eval('__FILE__')
     file == Pry.eval_path || !Pry::Helpers::BaseHelpers.not_a_real_file?(file)
   end
+  module_function :file_context?
+
+  #
+  # Ensures that a command is executed in a local file context.
+  #
+  def check_file_context(target, e = nil)
+    e ||= 'Cannot find local context. Did you use `binding.pry`?'
+    fail(Pry::CommandError, e) unless file_context?(target)
+  end
   module_function :check_file_context
 
   # Reference to currently running pry-remote server. Used by the processor.

data/lib/pry-byebug/pry_ext.rb

@@ -1,19 +1,16 @@
 require 'pry'
-require 'pry-byebug/processor'
+require 'byebug/processors/pry_processor'
 
 class << Pry
   alias_method :start_without_pry_byebug, :start
   attr_reader :processor
 
   def start_with_pry_byebug(target = TOPLEVEL_BINDING, options = {})
-    @processor ||= PryByebug::Processor.new
+    @processor ||= Byebug::PryProcessor.new
 
-    if target.is_a?(Binding) && PryByebug.check_file_context(target)
-      # Wrap the processor around the usual Pry.start to catch navigation
-      # commands.
-      @processor.run(true) do
-        start_without_pry_byebug(target, options)
-      end
+    if target.is_a?(Binding) && PryByebug.file_context?(target)
+      # Wrap processor around the usual Pry.start to catch navigation commands
+      @processor.start
     else
       # No need for the tracer unless we have a file context to step through
       start_without_pry_byebug(target, options)

data/lib/pry-byebug/pry_remote_ext.rb

@@ -19,7 +19,9 @@ module PryRemote
       Pry.start @object, input: client.input_proxy, output: client.output
     end
 
+    #
     # Override to reset our saved global current server session.
+    #
     alias_method :teardown_without_pry_byebug, :teardown
     def teardown_with_pry_byebug
       return if @torn
@@ -33,7 +35,7 @@ module PryRemote
 end
 
 # Ensure cleanup when a program finishes without another break. For example,
-# 'next' on the last line of a program won't hit PryByebug::Processor#run,
+# 'next' on the last line of a program won't hit Byebug::PryProcessor#run,
 # which normally handles cleanup.
 at_exit do
   PryByebug.current_remote_server.teardown if PryByebug.current_remote_server

data/lib/pry-byebug/version.rb

@@ -1,3 +1,6 @@
+#
+# Main container module for Pry-Byebug functionality
+#
 module PryByebug
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/pry/byebug/breakpoints.rb

@@ -0,0 +1,157 @@
+class Pry
+  module Byebug
+    #
+    # Wrapper for Byebug.breakpoints that respects our Processor and has better
+    # failure behavior. Acts as an Enumerable.
+    #
+    module Breakpoints
+      extend Enumerable
+      extend self
+
+      #
+      # Breakpoint in a file:line location
+      #
+      class FileBreakpoint < SimpleDelegator
+        def source_code
+          Pry::Code.from_file(source).around(pos, 3).with_marker(pos)
+        end
+
+        def to_s
+          "#{source} @ #{pos}"
+        end
+      end
+
+      #
+      # Breakpoint in a Class#method location
+      #
+      class MethodBreakpoint < SimpleDelegator
+        def initialize(byebug_bp, method)
+          __setobj__ byebug_bp
+          @method = method
+        end
+
+        def source_code
+          Pry::Code.from_method(Pry::Method.from_str(@method))
+        end
+
+        def to_s
+          @method
+        end
+      end
+
+      def breakpoints
+        @breakpoints ||= []
+      end
+
+      #
+      # Adds a method breakpoint.
+      #
+      def add_method(method, expression = nil)
+        validate_expression expression
+        owner, name = method.split(/[\.#]/)
+        byebug_bp = ::Byebug::Breakpoint.add(owner, name.to_sym, expression)
+        bp = MethodBreakpoint.new byebug_bp, method
+        breakpoints << bp
+        bp
+      end
+
+      #
+      # Adds a file breakpoint.
+      #
+      def add_file(file, line, expression = nil)
+        real_file = (file != Pry.eval_path)
+        fail(ArgumentError, 'Invalid file!') if real_file && !File.exist?(file)
+        validate_expression expression
+
+        path = (real_file ? File.expand_path(file) : file)
+        bp = FileBreakpoint.new ::Byebug::Breakpoint.add(path, line, expression)
+        breakpoints << bp
+        bp
+      end
+
+      #
+      # Changes the conditional expression for a breakpoint.
+      #
+      def change(id, expression = nil)
+        validate_expression expression
+
+        breakpoint = find_by_id(id)
+        breakpoint.expr = expression
+        breakpoint
+      end
+
+      #
+      # Deletes an existing breakpoint with the given ID.
+      #
+      def delete(id)
+        deleted = ::Byebug.started? &&
+          ::Byebug::Breakpoint.remove(id) && breakpoints.delete(find_by_id(id))
+        fail(ArgumentError, "No breakpoint ##{id}") unless deleted
+      end
+
+      #
+      # Deletes all breakpoints.
+      #
+      def delete_all
+        @breakpoints = []
+        ::Byebug.breakpoints.clear if ::Byebug.started?
+      end
+
+      #
+      # Enables a disabled breakpoint with the given ID.
+      #
+      def enable(id)
+        change_status id, true
+      end
+
+      #
+      # Disables a breakpoint with the given ID.
+      #
+      def disable(id)
+        change_status id, false
+      end
+
+      #
+      # Disables all breakpoints.
+      #
+      def disable_all
+        each do |breakpoint|
+          breakpoint.enabled = false
+        end
+      end
+
+      def to_a
+        breakpoints
+      end
+
+      def size
+        to_a.size
+      end
+
+      def each(&block)
+        to_a.each(&block)
+      end
+
+      def find_by_id(id)
+        breakpoint = find { |b| b.id == id }
+        fail(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
+        breakpoint
+      end
+
+      private
+
+      def change_status(id, enabled = true)
+        breakpoint = find_by_id(id)
+        breakpoint.enabled = enabled
+        breakpoint
+      end
+
+      def validate_expression(exp)
+        return unless exp &&
+                     (exp.empty? || !Pry::Code.complete_expression?(exp))
+
+        fail("Invalid breakpoint conditional: #{expression}")
+      end
+    end
+  end
+end

data/lib/{pry-byebug/commands.rb → pry/commands/breakpoint.rb}

@@ -1,86 +1,13 @@
 require 'pry'
-require 'pry-byebug/breakpoints'
+require 'pry/byebug/breakpoints'
 
 #
-# Container for all of pry-byebug's functionality
+# Main Pry class.
 #
-module PryByebug
-  Commands = Pry::CommandSet.new do
-    create_command 'step' do
-      description 'Step execution into the next line or method.'
-
-      banner <<-BANNER
-        Usage: step [TIMES]
-        Aliases: s
-
-        Step execution forward. By default, moves a single step.
-
-        Examples:
-
-          step                           Move a single step forward.
-          step 5                         Execute the next 5 steps.
-      BANNER
-
-      def process
-        check_file_context
-        breakout_navigation :step, args.first
-      end
-    end
-    alias_command 's', 'step'
-
-    create_command 'next' do
-      description 'Execute the next line within the current stack frame.'
-
-      banner <<-BANNER
-        Usage: next [LINES]
-        Aliases: n
-
-        Step over within the same frame. By default, moves forward a single
-        line.
-
-        Examples:
-
-          next                           Move a single line forward.
-          next 4                         Execute the next 4 lines.
-      BANNER
-
-      def process
-        check_file_context
-        breakout_navigation :next, args.first
-      end
-    end
-    alias_command 'n', 'next'
-
-    create_command 'finish' do
-      description 'Execute until current stack frame returns.'
-
-      banner <<-BANNER
-        Usage: finish
-        Aliases: f
-      BANNER
-
-      def process
-        check_file_context
-        breakout_navigation :finish
-      end
-    end
-    alias_command 'f', 'finish'
-
-    create_command 'continue' do
-      description 'Continue program execution and end the Pry session.'
-
-      banner <<-BANNER
-        Usage: continue
-        Aliases: c
-      BANNER
-
-      def process
-        check_file_context
-        breakout_navigation :continue
-      end
-    end
-    alias_command 'c', 'continue'
-
+# We're going to add to it custom breakpoint commands for Pry-Byebug
+#
+class Pry
+  BreakpointCommands = CommandSet.new do
     create_command 'break' do
       description 'Set or edit a breakpoint.'
 
@@ -139,7 +66,7 @@ module PryByebug
 
       %w(delete disable enable).each do |command|
         define_method(:"process_#{command}") do
-          Breakpoints.send(command, opts[command])
+          breakpoints.send(command, opts[command])
           run 'breakpoints'
         end
       end
@@ -147,18 +74,18 @@ module PryByebug
       %w(disable-all delete-all).each do |command|
         method_name = command.gsub('-', '_')
         define_method(:"process_#{method_name}") do
-          Breakpoints.send(method_name)
+          breakpoints.send(method_name)
           run 'breakpoints'
         end
       end
 
       def process_show
-        print_full_breakpoint(Breakpoints.find_by_id(opts[:show]))
+        print_full_breakpoint(breakpoints.find_by_id(opts[:show]))
       end
 
       def process_condition
         expr = args.empty? ? nil : args.join(' ')
-        Breakpoints.change(opts[:condition], expr)
+        breakpoints.change(opts[:condition], expr)
       end
 
       def new_breakpoint
@@ -168,21 +95,21 @@ module PryByebug
         bp =
           case place
           when /^(\d+)$/
-            line = Regexp.last_match[1]
             errmsg = 'Line number declaration valid only in a file context.'
-            check_file_context(errmsg)
+            PryByebug.check_file_context(target, errmsg)
 
-            Breakpoints.add_file(target.eval('__FILE__'), line.to_i, condition)
+            file, lineno = target.eval('__FILE__'), Regexp.last_match[1].to_i
+            breakpoints.add_file(file, lineno, condition)
           when /^(.+):(\d+)$/
             file, lineno = Regexp.last_match[1], Regexp.last_match[2].to_i
-            Breakpoints.add_file(file, lineno, condition)
+            breakpoints.add_file(file, lineno, condition)
           when /^(.*)[.#].+$/  # Method or class name
             if Regexp.last_match[1].strip.empty?
               errmsg = 'Method name declaration valid only in a file context.'
-              check_file_context(errmsg)
+              PryByebug.check_file_context(target, errmsg)
               place = target.eval('self.class.to_s') + place
             end
-            Breakpoints.add_method(place, condition)
+            breakpoints.add_method(place, condition)
           else
             fail(ArgumentError, 'Cannot identify arguments as breakpoint')
           end
@@ -207,33 +134,33 @@ module PryByebug
       end
 
       def process
-        errmsg = 'No breakpoints defined.'
-        return output.puts text.bold(errmsg) unless Breakpoints.count > 0
+        if breakpoints.count == 0
+          return output.puts(text.bold('No breakpoints defined.'))
+        end
 
         if opts.verbose?
-          Breakpoints.each { |b| print_full_breakpoint(b) }
+          breakpoints.each { |b| print_full_breakpoint(b) }
         else
-          output.puts
           print_breakpoints_header
-          Breakpoints.each { |b| print_short_breakpoint(b) }
-          output.puts
+          breakpoints.each { |b| print_short_breakpoint(b) }
         end
       end
     end
     alias_command 'breaks', 'breakpoints'
 
     helpers do
-      def breakout_navigation(action, times = nil)
-        _pry_.binding_stack.clear # Clear the binding stack.
-
-        # Break out of the REPL loop and signal tracer
-        throw :breakout_nav, action: action, times: times, pry: _pry_
+      #
+      # Byebug's array of breakpoints.
+      #
+      def breakpoints
+        Byebug::Breakpoints
       end
 
-      # Ensures that a command is executed in a local file context.
-      def check_file_context(e = nil)
-        e ||= 'Cannot find local context. Did you use `binding.pry`?'
-        fail(Pry::CommandError, e) unless PryByebug.check_file_context(target)
+      #
+      # Prints a message with bold font.
+      #
+      def bold_puts(msg)
+        output.puts(text.bold(msg))
       end
 
       #
@@ -241,28 +168,24 @@ module PryByebug
       #
       # Includes surrounding code at that point.
       #
-      def print_full_breakpoint(breakpoint)
-        output.print text.bold("Breakpoint #{breakpoint.id}: ")
-        output.print "#{breakpoint} "
-        output.print breakpoint.enabled? ? '(Enabled)' : '(Disabled)'
-        output.puts ' :'
-        if (expr = breakpoint.expr)
-          output.puts "#{text.bold('Condition:')} #{expr}"
-        end
-        output.puts
-        output.puts breakpoint.source_code.with_line_numbers.to_s
-        output.puts
+      def print_full_breakpoint(br)
+        header = text.bold("Breakpoint #{br.id}:")
+        status = br.enabled? ? '(Enabled)' : '(Disabled)'
+        code = br.source_code.with_line_numbers.to_s
+        condition = br.expr ? "#{text.bold('Condition:')} #{br.expr}\n" : ''
+
+        output.puts("#{header} #{br} #{status} :\n#{condition}#{code}\n")
       end
 
       #
       # Print out concise information about a breakpoint.
       #
       def print_short_breakpoint(breakpoint)
-        output.printf "%#{max_width}d  ", breakpoint.id
-        output.print breakpoint.enabled? ? 'Yes      ' : 'No       '
-        output.print breakpoint.to_s
-        output.print " (if #{breakpoint.expr})" if breakpoint.expr
-        output.puts
+        id = sprintf('%*d  ', max_width, breakpoint.id)
+        status = breakpoint.enabled? ? 'Yes' : 'No'
+        expr = breakpoint.expr ? breakpoint.expr : ''
+
+        output.puts("#{id} #{status}      #{breakpoint} #{expr}")
       end
 
       #
@@ -271,18 +194,22 @@ module PryByebug
       def print_breakpoints_header
         header = "#{' ' * (max_width - 1)}#  Enabled  At "
 
-        output.puts text.bold(header)
-        output.puts text.bold('-' * header.size)
+        output.puts <<-EOP
+
+          #{text.bold(header)}
+          #{text.bold('-' * header.size)}
+
+        EOP
       end
 
       #
       # Max width of breakpoints id column
       #
       def max_width
-        [Math.log10(Breakpoints.count).ceil, 1].max
+        [Math.log10(breakpoints.count).ceil, 1].max
       end
     end
   end
-end
 
-Pry.commands.import PryByebug::Commands
+  Pry.commands.import(BreakpointCommands)
+end

data/lib/pry/commands/stepping.rb

@@ -0,0 +1,90 @@
+require 'pry'
+
+#
+# Main Pry class.
+#
+# We're going to add to it custom stepping commands for Pry-Byebug
+#
+class Pry
+  SteppingCommands = CommandSet.new do
+    create_command 'step' do
+      description 'Step execution into the next line or method.'
+
+      banner <<-BANNER
+        Usage: step [TIMES]
+
+        Step execution forward. By default, moves a single step.
+
+        Examples:
+          step   #=> Move a single step forward.
+          step 5 #=> Execute the next 5 steps.
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        breakout_navigation :step, args.first
+      end
+    end
+
+    create_command 'next' do
+      description 'Execute the next line within the current stack frame.'
+
+      banner <<-BANNER
+        Usage: next [LINES]
+
+        Step over within the same frame. By default, moves forward a single
+        line.
+
+        Examples:
+          next   #=> Move a single line forward.
+          next 4 #=> Execute the next 4 lines.
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        breakout_navigation :next, args.first
+      end
+    end
+
+    create_command 'finish' do
+      description 'Execute until current stack frame returns.'
+
+      banner <<-BANNER
+        Usage: finish
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        breakout_navigation :finish
+      end
+    end
+
+    create_command 'continue' do
+      description 'Continue program execution and end the Pry session.'
+
+      banner <<-BANNER
+        Usage: continue
+      BANNER
+
+      def process
+        PryByebug.check_file_context(target)
+
+        breakout_navigation :continue
+      end
+    end
+
+    helpers do
+      def breakout_navigation(action, times = nil)
+        _pry_.binding_stack.clear # Clear the binding stack.
+
+        # Break out of the REPL loop and signal tracer
+        throw :breakout_nav, action: action, times: times, pry: _pry_
+      end
+    end
+  end
+
+  Pry.commands.import(SteppingCommands)
+end

data/test/base_test.rb

@@ -6,11 +6,11 @@ require 'test_helper'
 class BaseTest < MiniTest::Spec
   def test_main_file_context
     Pry.stubs eval_path: '<main>'
-    assert PryByebug.check_file_context(TOPLEVEL_BINDING)
+    assert PryByebug.file_context?(TOPLEVEL_BINDING)
   end
 
   def test_other_file_context
     Pry.stubs eval_path: 'something'
-    refute PryByebug.check_file_context(TOPLEVEL_BINDING)
+    refute PryByebug.file_context?(TOPLEVEL_BINDING)
   end
 end

data/test/breakpoints_test.rb

@@ -4,14 +4,6 @@ require 'test_helper'
 # Tests for pry-byebug breakpoints.
 #
 class BreakpointsTestGeneral < MiniTest::Spec
-  def test_add_file_raises_argument_error
-    Pry.stubs eval_path: 'something'
-    File.stubs :exist?
-    assert_raises(ArgumentError) do
-      PryByebug::Breakpoints.add_file('file', 1)
-    end
-  end
-
   #
   # Minimal dummy example class.
   #
@@ -20,9 +12,21 @@ class BreakpointsTestGeneral < MiniTest::Spec
     def instance_method; end
   end
 
+  def breakpoints_class
+    Pry::Byebug::Breakpoints
+  end
+
+  def test_add_file_raises_argument_error
+    Pry.stubs eval_path: 'something'
+    File.stubs :exist?
+    assert_raises(ArgumentError) do
+      breakpoints_class.add_file('file', 1)
+    end
+  end
+
   def test_add_method_adds_instance_method_breakpoint
-    Pry.stub :processor, PryByebug::Processor.new do
-      PryByebug::Breakpoints.add_method 'BreakpointsTest::Tester#instance_method'
+    Pry.stub :processor, Byebug::PryProcessor.new do
+      breakpoints_class.add_method 'BreakpointsTest::Tester#instance_method'
       bp = Byebug.breakpoints.last
       assert_equal 'BreakpointsTest::Tester', bp.source
       assert_equal 'instance_method', bp.pos
@@ -30,8 +34,8 @@ class BreakpointsTestGeneral < MiniTest::Spec
   end
 
   def test_add_method_adds_class_method_breakpoint
-    Pry.stub :processor, PryByebug::Processor.new do
-      PryByebug::Breakpoints.add_method 'BreakpointsTest::Tester.class_method'
+    Pry.stub :processor, Byebug::PryProcessor.new do
+      breakpoints_class.add_method 'BreakpointsTest::Tester.class_method'
       bp = Byebug.breakpoints.last
       assert_equal 'BreakpointsTest::Tester', bp.source
       assert_equal 'class_method', bp.pos

data/test/examples/deep_stepping.rb

@@ -0,0 +1,9 @@
+#
+# Toy program for testing binding.pry initialization
+#
+
+new_str = 'string'.gsub!(/str/) do |_|
+  binding.pry
+end
+
+new_str

data/test/processor_test.rb

@@ -23,4 +23,17 @@ class ProcessorTest < Minitest::Spec
       @output.string.must_match(/\=>  6:/)
     end
   end
+
+  describe 'Initialization at the end of block/method call' do
+    let(:step_file) { test_file('deep_stepping') }
+
+    before do
+      @input, @output = InputTester.new, StringIO.new
+      redirect_pry_io(@input, @output) { load step_file }
+    end
+
+    it 'stops execution at the first line after binding.pry' do
+      @output.string.must_match(/\=> 7:/)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-byebug
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - David Rodríguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -55,21 +55,23 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/byebug/processors/pry_processor.rb
 - lib/pry-byebug.rb
 - lib/pry-byebug/base.rb
-- lib/pry-byebug/breakpoints.rb
 - lib/pry-byebug/cli.rb
-- lib/pry-byebug/commands.rb
-- lib/pry-byebug/processor.rb
 - lib/pry-byebug/pry_ext.rb
 - lib/pry-byebug/pry_remote_ext.rb
 - lib/pry-byebug/version.rb
+- lib/pry/byebug/breakpoints.rb
+- lib/pry/commands/breakpoint.rb
+- lib/pry/commands/stepping.rb
 - pry-byebug.gemspec
 - test/base_test.rb
 - test/breakpoints_test.rb
 - test/commands_test.rb
 - test/examples/break1.rb
 - test/examples/break2.rb
+- test/examples/deep_stepping.rb
 - test/examples/stepping.rb
 - test/processor_test.rb
 - test/pry_ext_test.rb
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fast debugging with Pry.
@@ -105,6 +107,7 @@ test_files:
 - test/commands_test.rb
 - test/examples/break1.rb
 - test/examples/break2.rb
+- test/examples/deep_stepping.rb
 - test/examples/stepping.rb
 - test/processor_test.rb
 - test/pry_ext_test.rb

data/lib/pry-byebug/breakpoints.rb

@@ -1,154 +0,0 @@
-module PryByebug
-  #
-  # Wrapper for Byebug.breakpoints that respects our Processor and has better
-  # failure behavior. Acts as an Enumerable.
-  #
-  module Breakpoints
-    extend Enumerable
-    extend self
-
-    #
-    # Breakpoint in a file:line location
-    #
-    class FileBreakpoint < SimpleDelegator
-      def source_code
-        Pry::Code.from_file(source).around(pos, 3).with_marker(pos)
-      end
-
-      def to_s
-        "#{source} @ #{pos}"
-      end
-    end
-
-    #
-    # Breakpoint in a Class#method location
-    #
-    class MethodBreakpoint < SimpleDelegator
-      def initialize(byebug_bp, method)
-        __setobj__ byebug_bp
-        @method = method
-      end
-
-      def source_code
-        Pry::Code.from_method(Pry::Method.from_str(@method))
-      end
-
-      def to_s
-        @method
-      end
-    end
-
-    def breakpoints
-      @breakpoints ||= []
-    end
-
-    #
-    # Adds a method breakpoint.
-    #
-    def add_method(method, expression = nil)
-      validate_expression expression
-      owner, name = method.split(/[\.#]/)
-      byebug_bp = Byebug::Breakpoint.add(owner, name.to_sym, expression)
-      bp = MethodBreakpoint.new byebug_bp, method
-      breakpoints << bp
-      bp
-    end
-
-    #
-    # Adds a file breakpoint.
-    #
-    def add_file(file, line, expression = nil)
-      real_file = (file != Pry.eval_path)
-      fail(ArgumentError, 'Invalid file!') if real_file && !File.exist?(file)
-      validate_expression expression
-
-      path = (real_file ? File.expand_path(file) : file)
-      bp = FileBreakpoint.new Byebug::Breakpoint.add(path, line, expression)
-      breakpoints << bp
-      bp
-    end
-
-    #
-    # Changes the conditional expression for a breakpoint.
-    #
-    def change(id, expression = nil)
-      validate_expression expression
-
-      breakpoint = find_by_id(id)
-      breakpoint.expr = expression
-      breakpoint
-    end
-
-    #
-    # Deletes an existing breakpoint with the given ID.
-    #
-    def delete(id)
-      deleted = Byebug.started? &&
-        Byebug::Breakpoint.remove(id) && breakpoints.delete(find_by_id(id))
-      fail(ArgumentError, "No breakpoint ##{id}") unless deleted
-    end
-
-    #
-    # Deletes all breakpoints.
-    #
-    def delete_all
-      @breakpoints = []
-      Byebug.breakpoints.clear if Byebug.started?
-    end
-
-    #
-    # Enables a disabled breakpoint with the given ID.
-    #
-    def enable(id)
-      change_status id, true
-    end
-
-    #
-    # Disables a breakpoint with the given ID.
-    #
-    def disable(id)
-      change_status id, false
-    end
-
-    #
-    # Disables all breakpoints.
-    #
-    def disable_all
-      each do |breakpoint|
-        breakpoint.enabled = false
-      end
-    end
-
-    def to_a
-      breakpoints
-    end
-
-    def size
-      to_a.size
-    end
-
-    def each(&block)
-      to_a.each(&block)
-    end
-
-    def find_by_id(id)
-      breakpoint = find { |b| b.id == id }
-      fail(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
-      breakpoint
-    end
-
-    private
-
-    def change_status(id, enabled = true)
-      breakpoint = find_by_id(id)
-      breakpoint.enabled = enabled
-      breakpoint
-    end
-
-    def validate_expression(exp)
-      return unless exp && (exp.empty? || !Pry::Code.complete_expression?(exp))
-
-      fail("Invalid breakpoint conditional: #{expression}")
-    end
-  end
-end