pry-byebug 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5b8fdd92c518cf1c6800d1c1d1c481c5c0154f4
-  data.tar.gz: 92484d0776f36921b38ff4f89f8a3c867c076544
+  metadata.gz: 3769aa2736d9bf6a9ebab95ddf421e9ae696f3c9
+  data.tar.gz: ac34175906a7f0a79724558cedf23c3e073a77a3
 SHA512:
-  metadata.gz: ac47acea5c530840ecaac8e51dffaf0c0d88ff45f78c1aebbd2ffba67e89461cf0cf9ef400cfdfc7b53b6c1e24ebd9405d24eca1ab90ed70dd37034ffd4d2b8b
-  data.tar.gz: a0f259126736dea8c91727c1a506fc87a4ff94626ae609892cc83e3c68e33eda8ed5767511a027189e8a7c2db4495010f1643f8915b1df95b0c02103ce36f8fe
+  metadata.gz: 40e82bbce5bb4a06fda3e35012ebbd5ada29dba254227f52a0d8eeaf5a31f5caa045aae9812925dda5db1e9060752d0110369e875f1df8f834580db9ab48aaad
+  data.tar.gz: e1b28d266d1ec106afd76d33325cbe8f1229ee93b7adbdf4cae6faaf7224e0e9cdc7919c97ff6dc7d3ef7695956226349669eb25c397ca79a582207c7f130a3b

data/CHANGELOG.md

@@ -1,8 +1,24 @@
+## 3.2.0 (2015-07-18)
+
+- Improvements:
+  * Allow continue to receive a line number argument (#56).
+  * Refactorings + RuboCop.
+  * Up to date dependencies.
+
+- Bugfixes:
+  * Don't conflict with `break` and `next` Ruby keywords inside multiline
+statements (#44).
+
+- Removals:
+  * `breaks` command. It was broken anyways (#47).
+
+
 ## 3.1.0 (2015-04-14)
 
 - Improvements:
   * Add frame nav commands up, down and frame.
 
+
 ## 3.0.1 (2015-04-02)
 
 - Improvements:
@@ -77,7 +93,7 @@ level releases.
 
 
 ## 1.1.0 (2013-06-06)
- 
+
 * Adds a test suite (thanks @teeparham!)
 * Uses byebug ~> 1.4.0
 * Uses s, n, f and c aliases by default (thanks @jgakos!)

data/README.md

@@ -1,8 +1,9 @@
 # pry-byebug
 [![Version][VersionBadge]][VersionURL]
 [![Build][TravisBadge]][TravisURL]
-[![Inline docs][InchCIBadge]](InchCIURL)
+[![Inline docs][InchCIBadge]][InchCIURL]
 [![Gittip][GittipBadge]][GittipURL]
+[![Coverage][CoverageBadge]][CoverageURL]
 
 _Fast execution control in Pry_
 
@@ -92,7 +93,7 @@ end
 ## Breakpoints
 
 You can set and adjust breakpoints directly from a Pry session using the
-following commands:
+`break` command:
 
 **break:** Set a new breakpoint from a line number in the current file, a file
 and line number, or a method. Pass an optional expression to create a
@@ -112,15 +113,12 @@ break --condition 3            # Remove the condition on breakpoint #3.
 break --delete 5               # Delete breakpoint #5.
 break --disable-all            # Disable all breakpoints.
 
-breaks                         # List all breakpoints. (Same as `breakpoints`)
+break                          # List all 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.
-
 
 ## Caveats
 
@@ -141,6 +139,7 @@ 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.svg
 [VersionURL]: http://badge.fury.io/rb/pry-byebug
 [TravisBadge]: https://secure.travis-ci.org/deivid-rodriguez/pry-byebug.svg
@@ -149,3 +148,5 @@ Patches and bug reports are welcome.
 [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
+[CoverageBadge]: https://img.shields.io/codeclimate/coverage/github/deivid-rodriguez/pry-byebug.svg
+[CoverageURL]: https://codeclimate.com/github/deivid-rodriguez/pry-byebug

data/lib/byebug/processors/pry_processor.rb

@@ -38,9 +38,9 @@ module Byebug
 
       return_value = nil
 
-      command = catch(:breakout_nav) do  # Throws from PryByebug::Commands
+      command = catch(:breakout_nav) do # Throws from PryByebug::Commands
         return_value = yield
-        {}    # Nothing thrown == no navigational command
+        {} # Nothing thrown == no navigational command
       end
 
       # Pry instance to resume after stepping
@@ -55,9 +55,7 @@ module Byebug
     # Set up a number of navigational commands to be performed by Byebug.
     #
     def perform(action, options = {})
-      return unless [
-        :next, :step, :finish, :up, :down, :frame
-      ].include?(action)
+      return unless %i(next step finish up down frame).include?(action)
 
       send("perform_#{action}", options)
     end

data/lib/pry-byebug.rb

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

data/lib/pry-byebug/cli.rb

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

data/lib/pry-byebug/commands.rb

@@ -0,0 +1,8 @@
+require 'pry-byebug/commands/next'
+require 'pry-byebug/commands/step'
+require 'pry-byebug/commands/continue'
+require 'pry-byebug/commands/finish'
+require 'pry-byebug/commands/up'
+require 'pry-byebug/commands/down'
+require 'pry-byebug/commands/frame'
+require 'pry-byebug/commands/breakpoint'

data/lib/pry-byebug/commands/breakpoint.rb

@@ -0,0 +1,135 @@
+require 'pry/byebug/breakpoints'
+require 'pry-byebug/helpers/breakpoints'
+require 'pry-byebug/helpers/multiline'
+
+module PryByebug
+  #
+  # Add, show and remove breakpoints
+  #
+  class BreakCommand < Pry::ClassCommand
+    include Helpers::Breakpoints
+    include Helpers::Multiline
+
+    match 'break'
+    group 'Byebug'
+    description 'Set or edit a breakpoint.'
+
+    banner <<-BANNER
+      Usage:   break <METHOD | FILE:LINE | LINE> [if CONDITION]
+               break --condition N [CONDITION]
+               break [--show | --delete | --enable | --disable] N
+               break [--delete-all | --disable-all]
+               break
+      Aliases: breakpoint
+
+      Set a breakpoint. Accepts a line number in the current file, a file and
+      line number, or a method, and an optional condition.
+
+      Pass appropriate flags to manipulate existing breakpoints.
+
+      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 --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 --show 2              Show details about breakpoint #2.
+        break                       List all breakpoints.
+    BANNER
+
+    def 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
+      return if check_multiline_context
+
+      PryByebug.check_file_context(target)
+
+      option, = opts.to_hash.find { |key, _value| opts.present?(key) }
+      return send(option_to_method(option)) if option
+
+      return new_breakpoint unless args.empty?
+
+      print_all
+    end
+
+    private
+
+    %w(delete disable enable disable_all delete_all).each do |command|
+      define_method(:"process_#{command}") do
+        breakpoints.send(*[command, opts[command]].compact)
+        print_all
+      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 = add_breakpoint(place, condition)
+
+      print_full_breakpoint(bp)
+    end
+
+    def option_to_method(option)
+      "process_#{option.to_s.gsub('-', '_')}"
+    end
+
+    def print_all
+      print_breakpoints_header
+      breakpoints.each { |b| print_short_breakpoint(b) }
+    end
+
+    def add_breakpoint(place, condition)
+      case place
+      when /^(\d+)$/
+        errmsg = 'Line number declaration valid only in a file context.'
+        PryByebug.check_file_context(target, errmsg)
+
+        lineno = Regexp.last_match[1].to_i
+        breakpoints.add_file(current_file, lineno, condition)
+      when /^(.+):(\d+)$/
+        file = Regexp.last_match[1]
+        lineno = Regexp.last_match[2].to_i
+        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.'
+          PryByebug.check_file_context(target, errmsg)
+          place = target.eval('self.class.to_s') + place
+        end
+        breakpoints.add_method(place, condition)
+      else
+        fail(ArgumentError, 'Cannot identify arguments as breakpoint')
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::BreakCommand)
+Pry::Commands.alias_command 'breakpoint', 'break'

data/lib/pry-byebug/commands/continue.rb

@@ -0,0 +1,37 @@
+require 'pry-byebug/helpers/navigation'
+require 'pry-byebug/helpers/breakpoints'
+
+module PryByebug
+  #
+  # Continue program execution until the next breakpoint
+  #
+  class ContinueCommand < Pry::ClassCommand
+    include Helpers::Navigation
+    include Helpers::Breakpoints
+
+    match 'continue'
+    group 'Byebug'
+    description 'Continue program execution and end the Pry session.'
+
+    banner <<-BANNER
+      Usage: continue [LINE]
+
+      Continue program execution until the next breakpoint, or the program
+      ends. Optionally continue to the specified line number.
+
+      Examples:
+        continue   #=> Continue until the next breakpoint.
+        continue 4 #=> Continue to line number 4.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakpoints.add_file(current_file, args.first.to_i) if args.first
+
+      breakout_navigation :continue
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::ContinueCommand)

data/lib/pry-byebug/commands/down.rb

@@ -0,0 +1,33 @@
+require 'pry-byebug/helpers/navigation'
+
+module PryByebug
+  #
+  # Travel down the frame stack
+  #
+  class DownCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match 'down'
+    group 'Byebug'
+
+    description 'Move current frame down.'
+
+    banner <<-BANNER
+      Usage: down [TIMES]
+
+      Move current frame down. By default, moves by 1 frame.
+
+      Examples:
+        down   #=> Move down 1 frame.
+        down 5 #=> Move down 5 frames.
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :down, times: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::DownCommand)

data/lib/pry-byebug/commands/finish.rb

@@ -0,0 +1,26 @@
+require 'pry-byebug/helpers/navigation'
+
+module PryByebug
+  #
+  # Run until the end of current frame
+  #
+  class FinishCommand < Pry::ClassCommand
+    include PryByebug::Helpers::Navigation
+
+    match 'finish'
+    group 'Byebug'
+    description 'Execute until current stack frame returns.'
+
+    banner <<-BANNER
+      Usage: finish
+    BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :finish
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::FinishCommand)

data/lib/pry-byebug/commands/frame.rb

@@ -0,0 +1,33 @@
+require 'pry-byebug/helpers/navigation'
+
+module PryByebug
+  #
+  # Move to a specific frame in the callstack
+  #
+  class FrameCommand < Pry::ClassCommand
+    include Helpers::Navigation
+
+    match 'frame'
+    group 'Byebug'
+
+    description 'Move to specified frame #.'
+
+    banner <<-BANNER
+        Usage: frame [TIMES]
+
+        Move to specified frame #.
+
+        Examples:
+          frame   #=> Show current frame #.
+          frame 5 #=> Move to frame 5.
+      BANNER
+
+    def process
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :frame, index: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::FrameCommand)

data/lib/pry-byebug/commands/next.rb

@@ -0,0 +1,37 @@
+require 'pry-byebug/helpers/navigation'
+require 'pry-byebug/helpers/multiline'
+
+module PryByebug
+  #
+  # Run a number of lines and then stop again
+  #
+  class NextCommand < Pry::ClassCommand
+    include Helpers::Navigation
+    include Helpers::Multiline
+
+    match 'next'
+    group 'Byebug'
+    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
+      return if check_multiline_context
+
+      PryByebug.check_file_context(target)
+
+      breakout_navigation :next, lines: args.first
+    end
+  end
+end
+
+Pry::Commands.add_command(PryByebug::NextCommand)