pry-byebug 1.3.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f013e909a35fa66f73ddf492ea5cdce24662fdb
-  data.tar.gz: d9e323fd262e0148ec80dc58e2e526d6d51bb693
+  metadata.gz: 8123f22dc42ff24f284f47d77bdf74679b8025c2
+  data.tar.gz: 1803eaf3cc4e019e64ce84835bb0a288cef8cebe
 SHA512:
-  metadata.gz: a9afd2397a50060b37d1692a98cbde10cbb0eb1cbb7bd8c566fb5d29cf0d4d2ba3530299745b2edca7779531c6ccdfad39c8d76eae9bf33c1cc5494a75895300
-  data.tar.gz: b87b20290a1c94642ef1bc0995ce055b1e0a96e65725bdbab4630f807aa7bb3237a0b1ccc906c43f086f69f1241dab604b3a40c6c259328f143e9a207fcf7bf6
+  metadata.gz: eecedab14af1c1eddfc82d5828a4418a239691b6ef27f67e4340458054e0646edd049ded5cde2dc1ef10efe72bf2abb70b4c759a1145710c2e25b9e59b3faeec
+  data.tar.gz: 33135d020dc22bf50e1a8f57b39a5dce8f5e8c1373cd8f380500a210b8199bf05a5c90084f286c2d003b2379703e025fe63d80465b2007dfa3d10b68849a0495

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Lint/Debugger:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.0.0 (2014-01-09)
+
+- Improvements:
+  * Compatibility with byebug 3
+  * Now pry starts at the first line after binding.pry, not at binding.pry
+- Bugfixes:
+  * 'continue' doesn't finish pry instance (issue #13)
+
+
 ## 1.3.3 (2014-25-06)
 
 * Relaxes pry dependency to support pry 0.10 series and further minor version

data/Gemfile

@@ -2,8 +2,13 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '~> 10.2'
+gem 'rake', '~> 10.3'
 
-group :development, :test do
-  gem 'mocha', '~> 1.0'
+group :development do
+  gem 'rubocop', '~> 0.25'
+end
+
+group :test do
+  gem 'mocha', '~> 1.1'
+  gem 'minitest', '~> 5.4'
 end

data/README.md

@@ -1,5 +1,7 @@
-pry-byebug [![Gem Version][1]][2] [![Build Status][3]][4]
-============
+# pry-byebug
+[![Version][VersionBadge]][VersionURL]
+[![Build][TravisBadge]][TravisURL]
+[![Gittip][GittipBadge]][GittipURL]
 
 _Fast execution control in Pry_
 
@@ -15,9 +17,6 @@ def some_method
 end
 ```
 
-For a complete debugging environment, add
-[pry-stack_explorer][pry-stack_explorer] for call-stack frame navigation.
-
 
 ## Installation
 
@@ -59,25 +58,24 @@ conditional breakpoint. Edit existing breakpoints via various flags.
 
 Examples:
 
-```
-break SomeClass#run            Break at the start of `SomeClass#run`.
-break Foo#bar if baz?          Break at `Foo#bar` only if `baz?`.
-break app/models/user.rb:15    Break at line 15 in user.rb.
-break 14                       Break at line 14 in the current file.
+```ruby
+break SomeClass#run            # Break at the start of `SomeClass#run`.
+break Foo#bar if baz?          # Break at `Foo#bar` only if `baz?`.
+break app/models/user.rb:15    # Break at line 15 in user.rb.
+break 14                       # Break at line 14 in the current file.
 
-break --condition 4 x > 2      Change condition on breakpoint #4 to 'x > 2'.
-break --condition 3            Remove the condition on breakpoint #3.
+break --condition 4 x > 2      # Change condition on breakpoint #4 to 'x > 2'.
+break --condition 3            # Remove the condition on breakpoint #3.
 
-break --delete 5               Delete breakpoint #5.
-break --disable-all            Disable all breakpoints.
+break --delete 5               # Delete breakpoint #5.
+break --disable-all            # Disable all breakpoints.
 
-break                          List all breakpoints. (Same as `breakpoints`)
-break --show 2                 Show details about breakpoint #2.
+break                          # List all breakpoints. (Same as `breakpoints`)
+break --show 2                 # Show details about breakpoint #2.
 ```
 
 Type `break --help` from a Pry session to see all available options.
 
-
 **breakpoints**: List all defined breakpoints. Pass `-v` or `--verbose` to see
 the source code around each breakpoint.
 
@@ -88,28 +86,22 @@ Only supports MRI 2.0.0 or newer. For MRI 1.9.3 or older, use
 [pry-debugger][pry-debugger]
 
 
-## Contributors
+## Credits
 
-* Tee Parham (@teeparham)
-* Gopal Patel (@nixme)
-* John Mair (@banister)
-* Nicolas Viennot (@nviennot)
-* Benjamin R. Haskell (@benizi)
-* Joshua Hou (@jshou)
-* ...and others who helped with [pry-nav][pry-nav]
+* Gopal Patel (@nixme), creator of [pry-debugger][pry-debugger], and everybody
+who contributed to it. pry-byebug is a fork of pry-debugger so it wouldn't
+exist as it is without those contributions.
+* John Mair (@banister), creator of [pry][pry].
 
-Patches and bug reports are welcome. Just send a [pull request][pullrequests] or
-file an [issue][issues]. [Project changelog][changelog].
+Patches and bug reports are welcome.
 
-[pry]:                http://pry.github.com
-[byebug]:             https://github.com/deivid-rodriguez/byebug
-[pry-debugger]:       https://github.com/nixme/pry-debugger
+[pry]: http://pry.github.com
+[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
-[pullrequests]:       https://github.com/deivid-rodriguez/pry-byebug/pulls
-[issues]:             https://github.com/deivid-rodriguez/pry-byebug/issues
-[changelog]:          https://github.com/deivid-rodriguez/pry-byebug/blob/master/CHANGELOG.md
-[pry-nav]:            https://github.com/nixme/pry-nav
-[1]: https://badge.fury.io/rb/pry-byebug.png
-[2]: http://badge.fury.io/rb/pry-byebug
-[3]: https://secure.travis-ci.org/deivid-rodriguez/pry-byebug.png
-[4]: http://travis-ci.org/deivid-rodriguez/pry-byebug
+[VersionBadge]: https://badge.fury.io/rb/pry-byebug.png
+[VersionURL]: http://badge.fury.io/rb/pry-byebug
+[TravisBadge]: https://secure.travis-ci.org/deivid-rodriguez/pry-byebug.png
+[TravisURL]: http://travis-ci.org/deivid-rodriguez/pry-byebug
+[GittipBadge]: http://img.shields.io/gittip/deivid-rodriguez.svg
+[GittipURL]: https://www.gittip.com/deivid-rodriguez

data/lib/pry-byebug/base.rb

@@ -1,12 +1,12 @@
 module PryByebug
-  extend self
-
+  #
   # 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
+  #
   def check_file_context(target)
     file = target.eval('__FILE__')
-    file == Pry.eval_path || (file !~ /(\(.*\))|<.*>/ && file != '' && file != '-e')
+    file == Pry.eval_path || !Pry::Helpers::BaseHelpers.not_a_real_file?(file)
   end
+  module_function :check_file_context
 
   # Reference to currently running pry-remote server. Used by the processor.
   attr_accessor :current_remote_server

data/lib/pry-byebug/breakpoints.rb

@@ -1,5 +1,5 @@
 module PryByebug
-
+  #
   # Wrapper for Byebug.breakpoints that respects our Processor and has better
   # failure behavior. Acts as an Enumerable.
   #
@@ -7,6 +7,9 @@ module PryByebug
     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)
@@ -17,6 +20,9 @@ module PryByebug
       end
     end
 
+    #
+    # Breakpoint in a Class#method location
+    #
     class MethodBreakpoint < SimpleDelegator
       def initialize(byebug_bp, method)
         __setobj__ byebug_bp
@@ -36,32 +42,35 @@ module PryByebug
       @breakpoints ||= []
     end
 
-    # Add method breakpoint.
+    #
+    # Adds a method breakpoint.
+    #
     def add_method(method, expression = nil)
       validate_expression expression
-      Pry.processor.debugging = true
       owner, name = method.split(/[\.#]/)
-      byebug_bp = Byebug.add_breakpoint(owner, name.to_sym, expression)
+      byebug_bp = Byebug::Breakpoint.add(owner, name.to_sym, expression)
       bp = MethodBreakpoint.new byebug_bp, method
       breakpoints << bp
       bp
     end
 
-    # Add file breakpoint.
+    #
+    # Adds a file breakpoint.
+    #
     def add_file(file, line, expression = nil)
       real_file = (file != Pry.eval_path)
-      raise ArgumentError, 'Invalid file!' if real_file && !File.exist?(file)
+      fail(ArgumentError, 'Invalid file!') if real_file && !File.exist?(file)
       validate_expression expression
 
-      Pry.processor.debugging = true
-
       path = (real_file ? File.expand_path(file) : file)
-      bp = FileBreakpoint.new Byebug.add_breakpoint(path, line, expression)
+      bp = FileBreakpoint.new Byebug::Breakpoint.add(path, line, expression)
       breakpoints << bp
       bp
     end
 
-    # Change the conditional expression for a breakpoint.
+    #
+    # Changes the conditional expression for a breakpoint.
+    #
     def change(id, expression = nil)
       validate_expression expression
 
@@ -70,33 +79,40 @@ module PryByebug
       breakpoint
     end
 
-    # Delete an existing breakpoint with the given ID.
+    #
+    # Deletes an existing breakpoint with the given ID.
+    #
     def delete(id)
-      deleted = Byebug.started? && 
-        Byebug.remove_breakpoint(id) &&
-        breakpoints.delete(find_by_id(id))
-      raise ArgumentError, "No breakpoint ##{id}" if not deleted
-      Pry.processor.debugging = false if to_a.empty?
+      deleted = Byebug.started? &&
+        Byebug::Breakpoint.remove(id) && breakpoints.delete(find_by_id(id))
+      fail(ArgumentError, "No breakpoint ##{id}") unless deleted
     end
 
-    # Delete all breakpoints.
-    def clear
+    #
+    # Deletes all breakpoints.
+    #
+    def delete_all
       @breakpoints = []
       Byebug.breakpoints.clear if Byebug.started?
-      Pry.processor.debugging = false
     end
 
-    # Enable a disabled breakpoint with the given ID.
+    #
+    # Enables a disabled breakpoint with the given ID.
+    #
     def enable(id)
       change_status id, true
     end
 
-    # Disable a breakpoint with the given ID.
+    #
+    # Disables a breakpoint with the given ID.
+    #
     def disable(id)
       change_status id, false
     end
 
-    # Disable all breakpoints.
+    #
+    # Disables all breakpoints.
+    #
     def disable_all
       each do |breakpoint|
         breakpoint.enabled = false
@@ -117,12 +133,11 @@ module PryByebug
 
     def find_by_id(id)
       breakpoint = find { |b| b.id == id }
-      raise ArgumentError, "No breakpoint ##{id}!" unless breakpoint
+      fail(ArgumentError, "No breakpoint ##{id}!") unless breakpoint
       breakpoint
     end
 
-
-   private
+    private
 
     def change_status(id, enabled = true)
       breakpoint = find_by_id(id)
@@ -130,11 +145,10 @@ module PryByebug
       breakpoint
     end
 
-    def validate_expression(expression)
-      if expression &&   # `nil` implies no expression given, so pass
-          (expression.empty? || !Pry::Code.complete_expression?(expression))
-        raise "Invalid breakpoint conditional: #{expression}"
-      end
+    def validate_expression(exp)
+      return unless exp && (exp.empty? || !Pry::Code.complete_expression?(exp))
+
+      fail("Invalid breakpoint conditional: #{expression}")
     end
   end
 end

data/lib/pry-byebug/cli.rb

@@ -1 +1 @@
-require 'pry-byebug'
+require 'pry-byebug'

data/lib/pry-byebug/commands.rb

@@ -1,6 +1,9 @@
 require 'pry'
 require 'pry-byebug/breakpoints'
 
+#
+# Container for all of pry-byebug's functionality
+#
 module PryByebug
   Commands = Pry::CommandSet.new do
     create_command 'step' do
@@ -73,7 +76,7 @@ module PryByebug
 
       def process
         check_file_context
-        run 'exit-all'
+        breakout_navigation :continue
       end
     end
     alias_command 'c', 'continue'
@@ -95,91 +98,100 @@ module PryByebug
 
         Examples:
 
-          break SomeClass#run            Break at the start of `SomeClass#run`.
-          break Foo#bar if baz?          Break at `Foo#bar` only if `baz?`.
-          break app/models/user.rb:15    Break at line 15 in user.rb.
-          break 14                       Break at line 14 in the current file.
+          break SomeClass#run         Break at the start of `SomeClass#run`.
+          break Foo#bar if baz?       Break at `Foo#bar` only if `baz?`.
+          break app/models/user.rb:15 Break at line 15 in user.rb.
+          break 14                    Break at line 14 in the current file.
 
-          break --condition 4 x > 2      Add/change condition on breakpoint #4.
-          break --condition 3            Remove the condition on breakpoint #3.
+          break --condition 4 x > 2   Add/change condition on breakpoint #4.
+          break --condition 3         Remove the condition on breakpoint #3.
 
-          break --delete 5               Delete breakpoint #5.
-          break --disable-all            Disable all breakpoints.
+          break --delete 5            Delete breakpoint #5.
+          break --disable-all         Disable all breakpoints.
 
-          break                          List all breakpoints. (Same as `breakpoints`)
-          break --show 2                 Show details about breakpoint #2.
+          break                       List all breakpoints.
+          break --show 2              Show details about breakpoint #2.
       BANNER
 
       def options(opt)
-        opt.on :c, :condition,     'Change the condition of a breakpoint.', :argument => true, :as => Integer
-        opt.on :s, :show,          'Show breakpoint details and source.',   :argument => true, :as => Integer
-        opt.on :D, :delete,        'Delete a breakpoint.',                  :argument => true, :as => Integer
-        opt.on :d, :disable,       'Disable a breakpoint.',                 :argument => true, :as => Integer
-        opt.on :e, :enable,        'Enable a disabled breakpoint.',         :argument => true, :as => Integer
-        opt.on     :'disable-all', 'Disable all breakpoints.'
-        opt.on     :'delete-all',  'Delete all breakpoints.'
-        method_options(opt)
+        defaults = { argument: true, as: Integer }
+
+        opt.on :c, :condition, 'Change condition of a breakpoint.', defaults
+        opt.on :s, :show, 'Show breakpoint details and source.', defaults
+        opt.on :D, :delete, 'Delete a breakpoint.', defaults
+        opt.on :d, :disable, 'Disable a breakpoint.', defaults
+        opt.on :e, :enable, 'Enable a disabled breakpoint.', defaults
+        opt.on :'disable-all', 'Disable all breakpoints.'
+        opt.on :'delete-all', 'Delete all breakpoints.'
       end
 
       def process
-        Pry.processor.pry = _pry_
-
-        { :delete        => :delete,
-          :disable       => :disable,
-          :enable        => :enable,
-          :'disable-all' => :disable_all,
-          :'delete-all'  => :clear
-        }.each do |action, method|
-          if opts.present?(action)
-            Breakpoints.__send__ method, *(method == action ? [opts[action]] : [])
-            return run 'breakpoints'
-          end
+        all = %w(condition show delete disable enable disable-all delete-all)
+        all.each do |option|
+          next unless opts.present?(option)
+
+          method_name = "process_#{option.gsub('-', '_')}"
+          return send(method_name)
         end
 
-        if opts.present?(:condition)
-          Breakpoints.change(opts[:condition], args.empty? ? nil : args.join(' '))
+        new_breakpoint unless args.empty?
+      end
+
+      %w(delete disable enable).each do |command|
+        define_method(:"process_#{command}") do
+          Breakpoints.send(command, opts[command])
           run 'breakpoints'
-        elsif opts.present?(:show)
-          print_full_breakpoint Breakpoints.find_by_id(opts[:show])
-        elsif args.empty?
+        end
+      end
+
+      %w(disable-all delete-all).each do |command|
+        method_name = command.gsub('-', '_')
+        define_method(:"process_#{method_name}") do
+          Breakpoints.send(method_name)
           run 'breakpoints'
-        else
-          new_breakpoint
         end
       end
 
+      def process_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)
+      end
+
       def new_breakpoint
         place = args.shift
         condition = args.join(' ') if 'if' == args.shift
 
         bp =
           case place
-          when /^(\d+)$/       # Line number only
-            line = $1
-            unless PryByebug.check_file_context(target)
-              raise ArgumentError, 'Line number declaration valid only in a file context.'
-            end
+          when /^(\d+)$/
+            line = Regexp.last_match[1]
+            errmsg = 'Line number declaration valid only in a file context.'
+            check_file_context(errmsg)
+
             Breakpoints.add_file(target.eval('__FILE__'), line.to_i, condition)
-          when /^(.+):(\d+)$/  # File and line number
-            Breakpoints.add_file($1, $2.to_i, condition)
+          when /^(.+):(\d+)$/
+            file, lineno = Regexp.last_match[1], Regexp.last_match[2].to_i
+            Breakpoints.add_file(file, lineno, condition)
           when /^(.*)[.#].+$/  # Method or class name
-            if $1.strip.empty?
-              unless PryByebug.check_file_context(target)
-                raise ArgumentError, 'Method name declaration valid only in a file context.'
-              end
+            if Regexp.last_match[1].strip.empty?
+              errmsg = 'Method name declaration valid only in a file context.'
+              check_file_context(errmsg)
               place = target.eval('self.class.to_s') + place
             end
-            Breakpoints.add_method(place,condition)
+            Breakpoints.add_method(place, condition)
           else
-            raise ArgumentError, 'Cannot identify arguments as breakpoint'
+            fail(ArgumentError, 'Cannot identify arguments as breakpoint')
           end
 
-        print_full_breakpoint bp
+        print_full_breakpoint(bp)
       end
     end
     alias_command 'breakpoint', 'break'
 
-
     create_command 'breakpoints' do
       description 'List defined breakpoints.'
 
@@ -195,27 +207,16 @@ module PryByebug
       end
 
       def process
-        if Breakpoints.count > 0
-          if opts.verbose?   # Long-form with source output
-            Breakpoints.each { |b| print_full_breakpoint(b) }
-          else               # Simple table output
-            max_width = [Math.log10(Breakpoints.count).ceil, 1].max
-            header = "#{' ' * (max_width - 1)}#  Enabled  At "
-
-            output.puts
-            output.puts text.bold(header)
-            output.puts text.bold('-' * header.size)
-            Breakpoints.each do |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
-            end
-            output.puts
-          end
+        errmsg = 'No breakpoints defined.'
+        return output.puts text.bold(errmsg) unless Breakpoints.count > 0
+
+        if opts.verbose?
+          Breakpoints.each { |b| print_full_breakpoint(b) }
         else
-          output.puts text.bold('No breakpoints defined.')
+          output.puts
+          print_breakpoints_header
+          Breakpoints.each { |b| print_short_breakpoint(b) }
+          output.puts
         end
       end
     end
@@ -224,28 +225,27 @@ module PryByebug
     helpers do
       def breakout_navigation(action, times = nil)
         _pry_.binding_stack.clear # Clear the binding stack.
-        throw :breakout_nav, {    # Break out of the REPL loop and signal tracer
-          :action => action,
-          :times  => times,
-          :pry    => _pry_
-        }
+
+        # Break out of the REPL loop and signal tracer
+        throw :breakout_nav, action: action, times: times, pry: _pry_
       end
 
       # Ensures that a command is executed in a local file context.
-      def check_file_context
-        unless PryByebug.check_file_context(target)
-          raise Pry::CommandError, 'Cannot find local context. Did you use `binding.pry`?'
-        end
+      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)
       end
 
-      # Print out full information about a breakpoint including surrounding code
-      # at that point.
+      #
+      # Print out full information about a breakpoint.
+      #
+      # Includes surrounding code at that point.
+      #
       def print_full_breakpoint(breakpoint)
-        line = breakpoint.pos
         output.print text.bold("Breakpoint #{breakpoint.id}: ")
-        output.print "#{breakpoint.to_s} "
+        output.print "#{breakpoint} "
         output.print breakpoint.enabled? ? '(Enabled)' : '(Disabled)'
-        output.puts  ' :'
+        output.puts ' :'
         if (expr = breakpoint.expr)
           output.puts "#{text.bold('Condition:')} #{expr}"
         end
@@ -253,6 +253,34 @@ module PryByebug
         output.puts breakpoint.source_code.with_line_numbers.to_s
         output.puts
       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
+      end
+
+      #
+      # Prints a header for the breakpoint list.
+      #
+      def print_breakpoints_header
+        header = "#{' ' * (max_width - 1)}#  Enabled  At "
+
+        output.puts text.bold(header)
+        output.puts text.bold('-' * header.size)
+      end
+
+      #
+      # Max width of breakpoints id column
+      #
+      def max_width
+        [Math.log10(Breakpoints.count).ceil, 1].max
+      end
     end
   end
 end