byebug 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 960dc1ecb2fe9ff5b35966884c7cee07438ea3c5
-  data.tar.gz: 081117a82d94544eaa12479415886bb043e3835c
+  metadata.gz: b1a08f371a915d34451a323c3c74be79b4bf3f15
+  data.tar.gz: 2d30fea81a1d956f67c3e2035efbb4db570b2797
 SHA512:
-  metadata.gz: a8f0ff414f1341bc137b5a08e1091bbc27e315cffee95f65a235e008973156d830c3fccb8441d6cc85357312d1e18405cc4fcb30c1068d30f0131df55e556d22
-  data.tar.gz: c5034ade9a0708f284fc9ea0f4c32d27643052109acdcd9783987b4e7ff2009ee10b39d24f3382d96e0d322b63ed2ca8da49f37d7d6be1be1fb305f43fd99d06
+  metadata.gz: d3303c74e4cb9256df7376f0fcab58880c400cd52a9f73324c225706d89670f6406b9a5d7356e52a9dd70c84628f0720f9a671df7a4c3c60caee93e1ef8cd47b
+  data.tar.gz: 7c6e74528d1ab252dc5a30332476d156519bae2056c260c91a860494e05f345a7acf60a6ae1c85476966d253013efcbb57dbdf84f0ef3530d4c677d8112866df

data/.travis.yml

@@ -1,9 +1,11 @@
 before_script: bundle exec rake compile
 rvm:
 - 2.0.0
-- 2.1.0
-- 2.1.1
+- 2.1
 - ruby-head
 matrix:
   allow_failures:
   - rvm: ruby-head
+addons:
+  code_climate:
+    repo_token: 02530029b1e956220f05076c590b84b9ab078362c9083312eb2ad41cab138408

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 3.2.0
+
+- Bugfixes
+ * Fix bug in remote debugging (#71), thanks @shuky19.
+ * Fix source command (#68), thanks @Olgagr.
+ * Fix bug #71 preventing the test suite from running against ruby-head.
+ * Remove warning reported in #77.
+
+- Removals
+ * `post_mortem` activation through `Byebug.post_mortem` is no longer allowed.
+Use `set post_mortem` instead.
+ * `info stack` command has been removed. Use `where`|`backtrace` instead.
+ * `method iv` command has been removed. Use `var instance` instead.
+
+
 # 3.1.2
 
 * Really fix starting `post_mortem` mode in bin/byebug

data/GUIDE.md

@@ -31,7 +31,7 @@ has terminated normally, the string this position will be `(byebug:ctrl)`. The
 commands available change depending on the program's state.
 
 Byebug automatically lists 10 lines of code centered around the current line
-everytime it is stopped. The current line is marked with `=>`, so the range
+every time it is stopped. The current line is marked with `=>`, so the range
 byebug would like to show is [-3..6]. However since there aren't 5 lines before
 the current line, the range is moved _up_ so we can actually display 10 lines
 of code.
@@ -173,7 +173,7 @@ $ byebug hanoi.rb
 (byebug)
 ```
 
-Recall in the first section iwe said that before the `def` is run, the method it
+Recall in the first section it was stated that before the `def` is run, the method it
 names is undefined. Let's check that out. First let's see what private methods
 we can call before running `def hanoi`.
 
@@ -186,7 +186,7 @@ we can call before running `def hanoi`.
 byebug doesn't understand a command, it will evaluate it as if it was a Ruby
 command. If you don't want this behaviour, you can use `set autoeval off` or
 even drop it in your `.byebugrc` file if you want that behaviour permanently.
-The output of `private_methods`, thought, is unwieldy for our porpuse: check
+The output of `private_methods`, thought, is unwieldy for our purpose: check
 whether `hanoi` method is in the list. Fortunately, byebug has nice formatting
 features: we can sort the output and put it into columns list using the print
 command `ps`.
@@ -440,7 +440,7 @@ same directory as `triangle.rb`.
 require 'minitest/autorun'
 require_relative 'triangle.rb'
 
-class TestTri < MiniTest::Unit::TestCase
+class TestTri < Minitest::Unit::TestCase
   def test_basic
     solutions = []
     0.upto(5) do |i|
@@ -474,7 +474,7 @@ Run options: --seed 13073
 [2, 11] in test-triangle.rb
     2: require_relative 'triangle.rb'
     3: 
-    4: class TestTri < MiniTest::Unit::TestCase
+    4: class TestTri < Minitest::Unit::TestCase
     5:   def test_basic
     6:     byebug
 =>  7:     solutions = []
@@ -495,20 +495,20 @@ Now let's see where we are...
 Displaying frame's full file names is off.
 (byebug) bt
 --> #0  TestTri.test_basic at test-triangle.rb:7
-    #1  MiniTest::Unit::TestCase.run(runner#MiniTest::Unit) at .../2.0.0/minitest/unit.rb:1301
-    #2  MiniTest::Unit.block in _run_suite(suite#Class, type#Symbol) at .../2.0.0/minitest/unit.rb:919
+    #1  Minitest::Unit::TestCase.run(runner#Minitest::Unit) at .../2.0.0/minitest/unit.rb:1301
+    #2  Minitest::Unit.block in _run_suite(suite#Class, type#Symbol) at .../2.0.0/minitest/unit.rb:919
      +-- #3  Array.map at .../2.0.0/minitest/unit.rb:912
-    #4  MiniTest::Unit._run_suite(suite#Class, type#Symbol) at .../2.0.0/minitest/unit.rb:912
-    #5  MiniTest::Unit.block in _run_suites(suites#Array, type#Symbol) at .../2.0.0/minitest/unit.rb:899
+    #4  Minitest::Unit._run_suite(suite#Class, type#Symbol) at .../2.0.0/minitest/unit.rb:912
+    #5  Minitest::Unit.block in _run_suites(suites#Array, type#Symbol) at .../2.0.0/minitest/unit.rb:899
      +-- #6  Array.map at .../2.0.0/minitest/unit.rb:899
-    #7  MiniTest::Unit._run_suites(suites#Array, type#Symbol) at .../2.0.0/minitest/unit.rb:899
-    #8  MiniTest::Unit._run_anything(type#Symbol) at .../2.0.0/minitest/unit.rb:867
-    #9  MiniTest::Unit.run_tests at .../2.0.0/minitest/unit.rb:1060
-    #10 MiniTest::Unit.block in _run(args#Array) at .../2.0.0/minitest/unit.rb:1047
+    #7  Minitest::Unit._run_suites(suites#Array, type#Symbol) at .../2.0.0/minitest/unit.rb:899
+    #8  Minitest::Unit._run_anything(type#Symbol) at .../2.0.0/minitest/unit.rb:867
+    #9  Minitest::Unit.run_tests at .../2.0.0/minitest/unit.rb:1060
+    #10 Minitest::Unit.block in _run(args#Array) at .../2.0.0/minitest/unit.rb:1047
      +-- #11 Array.each at .../2.0.0/minitest/unit.rb:1046
-    #12 MiniTest::Unit._run(args#Array) at .../2.0.0/minitest/unit.rb:1046
-    #13 MiniTest::Unit.run(args#Array) at .../2.0.0/minitest/unit.rb:1035
-    #14 #<Class:MiniTest::Unit>.block in autorun at .../2.0.0/minitest/unit.rb:789
+    #12 Minitest::Unit._run(args#Array) at .../2.0.0/minitest/unit.rb:1046
+    #13 Minitest::Unit.run(args#Array) at .../2.0.0/minitest/unit.rb:1035
+    #14 #<Class:Minitest::Unit>.block in autorun at .../2.0.0/minitest/unit.rb:789
 (byebug)
 ```
 
@@ -863,7 +863,7 @@ Running a program from byebug adds a bit of overhead and slows it down a little.
 Furthermore, by necessity, debuggers change the operation of the program they
 are debugging. And this can lead to unexpected and unwanted differences. It has
 happened so often that the term
-[Heisenbugs](http://en.wikipedia.org/wiki/Heisenbug}) was coined to describe the
+[Heisenbugs](http://en.wikipedia.org/wiki/Heisenbug) was coined to describe the
 situation where using a debugger (among other possibilities) changes the
 behavior of the program so that the bug doesn't manifest itself anymore.
 
@@ -1032,7 +1032,6 @@ info line               -- Line number and file name of current position in
 source file
 info locals             -- Local variables of the current stack frame
 info program            -- Execution status of the program
-info stack              -- Backtrace of the stack
 info variables          -- Local and instance variables of the current stack
 frame
 ```
@@ -1284,23 +1283,6 @@ basically listing `<object>.instance_variables`.
 * `info variables`. Show local and instance variables of `self`.
 * `method instance <object>`. Show methods of `<object>`. Basically this is the
 same as running `ps <object>.instance_methods(false)`.
-* `method iv <object>`. Show method instance variables of `object`. Basically
-this is the same as running
-```
-  <object>.instance_variables.each do |v|
-     puts "%s = %s\n" % [v, <object>.instance_variable_get(v)]
-  end
-```
-* `signature <object>`. Show signature of method `<object>`. _This command is
-available only if the nodewrap gem is installed_.
-
-```ruby
-  def mymethod(a, b=5, &bock)
-  end
-  (byebug) method sig mymethod
-  Mine#mymethod(a, b=5, &bock)
-```
-
 * `method <class-or-module>`. Show methods of the class or module
 `<class-or-module>`. Basically this is the same as running
 `ps <class-or-module>.methods`.

data/Gemfile

@@ -2,11 +2,14 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '~> 10.2'
+gem 'rake', '~> 10.3'
 
-group :development, :test do
+group :development do
   gem 'rake-compiler', '~> 0.9'
-  gem 'mocha', '~> 1.0'
-  gem 'minitest', '~> 5.3'
-  gem 'coveralls', '~> 0.7'
+  gem 'mocha', '~> 1.1'
+  gem 'minitest', '~> 5.4'
+end
+
+group :test do
+  gem 'codeclimate-test-reporter', '~> 0.4', require: nil
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2014  David Rodríguez <deivid.rodriguez@gmail.com>
+Copyright (C) David Rodríguez <deivid.rodriguez@gmail.com>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -3,7 +3,7 @@
 [![Build][TravisBadge]][TravisURL]
 [![Climate][CodeClimateBadge]][CodeClimateURL]
 [![Dependencies][GemnasiumBadge]][GemnasiumURL]
-[![Coverage][CoverallsBadge]][CoverallsURL]
+[![Coverage][CoverageBadge]][CoverageURL]
 [![Gittip][GittipBadge]][GittipURL]
 
 _Debugging in Ruby 2_
@@ -12,6 +12,8 @@ Byebug is a simple to use, feature rich debugger for Ruby 2. It uses the new
 TracePoint API for execution control and the new Debug Inspector API for call
 stack navigation, so it doesn't depend on internal core sources. It's developed
 as a C extension, so it's fast. And it has a full test suite so it's reliable.
+Note that byebug works only for ruby 2.0.0 or newer. For debugging ruby 1.9.3 or
+older, use [debugger](https://github.com/cldwalker/debugger).
 
 It allows you to see what is going on _inside_ a Ruby program while it executes
 and can do four main kinds of things to help you catch bugs in the act:
@@ -43,27 +45,13 @@ Former [debugger](https://github.com/cldwalker/debugger) or
 [ruby-debug](https://github.com/mark-moseley/ruby-debug) users, notice:
 
 * Some gems (rails, rspec) implement debugging flags (-d, --debugger) that early
-require and start the debugger. These flags are a performance penalty and Byebug
-doesn't need them anymore so my recommendation is not to use them.
+require and start the debugger. These flags are a performance penalty and byebug
+doesn't need them anymore so my recommendation is not to use them. In any case,
+both rails and rspec have deprecated these flags in their latest versions.  
 * The startup configuration file is now called `.byebugrc` instead of
 `.rdebugrc`.
 
 
-## What's different from debugger
-
-* Works on Ruby 2.x but it doesn't on 1.9.x (you should probably upgrade
-anyways).
-* Has no MRI internal source code dependencies, just a clean API (no more `bump
-ruby_core_source dependency` entries in CHANGELOG, no more broken debugger's on
-ruby's releases).
-* Fixes a lot of debugger's issues, such as ruby 2.x support or post_mortem
-debugging. It also provides several enhancements, such as the fact the `byebug`
-can now be placed at the end of a block or method call.
-* Actively mantained.
-* Editor agnostic: no external editor built-in support.
-* Pry command is built-in. No need of external gem like debugger-pry.
-
-
 ## Byebug's commands
 
     Command     | Aliases      | Subcommands
@@ -83,11 +71,11 @@ can now be placed at the end of a block or method call.
     `frame`     |              |
     `help`      |              |
     `history`   |              |
-    `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `global_variables` `instance_variables` `line` `locals` `program` `stack` `variables`
+    `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `global_variables` `instance_variables` `line` `locals` `program` `variables`
     `irb`       |              |
     `kill`      |              |
     `list`      |              |
-    `method`    |              | `instance` `iv`
+    `method`    |              | `instance`
     `next`      |              |
     `p`         | `eval`       |
     `pp`        |              |
@@ -165,7 +153,7 @@ starting point of this.
 [CodeClimateURL]: https://codeclimate.com/github/deivid-rodriguez/byebug
 [GemnasiumBadge]: https://gemnasium.com/deivid-rodriguez/byebug.svg
 [GemnasiumURL]: https://gemnasium.com/deivid-rodriguez/byebug
-[CoverallsBadge]: http://img.shields.io/coveralls/deivid-rodriguez/byebug.svg
-[CoverallsURL]: https://coveralls.io/r/deivid-rodriguez/byebug
+[CoverageBadge]: https://codeclimate.com/github/deivid-rodriguez/byebug/badges/coverage.svg
+[CoverageURL]: https://codeclimate.com/github/deivid-rodriguez/byebug
 [GittipBadge]: http://img.shields.io/gittip/deivid-rodriguez.svg
 [GittipURL]: https://www.gittip.com/deivid-rodriguez

data/Rakefile

@@ -13,7 +13,7 @@ class Rake::TestTask
   end
 end
 
-desc "Run MiniTest suite"
+desc 'Run the test suite'
 task :test do
   Rake::TestTask.new do |t|
     t.verbose = true

data/ext/byebug/byebug.c

@@ -236,7 +236,7 @@ line_event(VALUE trace_point, void *data)
 static void
 call_event(VALUE trace_point, void *data)
 {
-  VALUE breakpoint, klass, mid, binding, self, file, line;
+  VALUE breakpoint, klass, msym, mid, binding, self, file, line;
 
   EVENT_SETUP
 
@@ -249,7 +249,8 @@ call_event(VALUE trace_point, void *data)
 
   breakpoint = Qnil;
   klass   = rb_tracearg_defined_class(trace_arg);
-  mid     = SYM2ID(rb_tracearg_method_id(trace_arg));
+  msym    = rb_tracearg_method_id(trace_arg);
+  mid     = NIL_P(msym) ? Qnil : SYM2ID(msym);
   binding = rb_tracearg_binding(trace_arg);
   self    = rb_tracearg_self(trace_arg);
   file    = rb_tracearg_path(trace_arg);

data/lib/byebug.rb

@@ -27,23 +27,9 @@ module Byebug
     Byebug.handler = CommandProcessor.new
 
     def source_reload
-      Object.send(:remove_const, 'SCRIPT_LINES__') if
-        Object.const_defined?('SCRIPT_LINES__')
-      Object.const_set('SCRIPT_LINES__', {})
-    end
-
-    #
-    # Get line +line_number+ from file named +filename+.
-    #
-    # @return "\n" if there was a problem. Leaking blanks are stripped off.
-    #
-    def line_at(filename, line_number)
-      source_reload
-
-      return "\n" unless File.exist?(filename)
-      line = Tracer::Single.get_line(filename, line_number)
-
-      return "#{line.gsub(/^\s+/, '').chomp}"
+      hsh = 'SCRIPT_LINES__'
+      Object.send(:remove_const, hsh) if Object.const_defined?(hsh)
+      Object.const_set(hsh, {})
     end
 
     #
@@ -102,27 +88,6 @@ module Byebug
       processor = ControlCommandProcessor.new(interface)
       processor.process_commands(verbose)
     end
-
-    #
-    # Activates the post-mortem mode.
-    #
-    # By calling Byebug.post_mortem method, you install an at_exit hook that
-    # intercepts any exception not handled by your script and enables
-    # post-mortem mode.
-    #
-    def post_mortem
-      return if self.post_mortem?
-      self.post_mortem = true
-      at_exit { handle_post_mortem if post_mortem? }
-    end
-
-    def handle_post_mortem
-      context = raised_exception.__bb_context
-      file    = raised_exception.__bb_file
-      line    = raised_exception.__bb_line
-      handler.at_line(context, file, line)
-    end
-    private :handle_post_mortem
   end
 end
 

data/lib/byebug/commands/break.rb

@@ -0,0 +1,83 @@
+module Byebug
+  class BreakCommand < Command
+    self.allow_in_post_mortem = false
+    self.allow_in_control = true
+
+    def regexp
+      /^\s* b(?:reak)? (?:\s+ #{Position_regexp})? (?:\s+(.+))? \s*$/x
+    end
+
+    def execute
+      return print BreakCommand.help(nil) if BreakCommand.names.include?(@match[0])
+
+      if @match[1]
+        line, _, _, expr = @match.captures
+      else
+        _, file, line, expr = @match.captures
+      end
+
+      if expr && file.nil? && line.nil?
+        return errmsg "Invalid breakpoint location: #{expr}\n"
+      elsif expr && expr !~ /^\s*if\s+(.+)/
+        return errmsg "Expecting \"if\" in breakpoint condition, got: #{expr}\n"
+      else
+        expr = $1
+      end
+
+      if file.nil? && !@state.context
+        return errmsg "We are not in a state that has an associated file\n"
+      end
+
+      file = @state.file if file.nil?
+      line = @state.line.to_s if line.nil?
+
+      if line =~ /^\d+$/
+        path = CommandProcessor.canonic_file(file)
+        return errmsg "No file named #{path}\n" unless File.exist?(file)
+
+        line, n = line.to_i, File.foreach(file).count
+        return errmsg "There are only #{n} lines in file #{path}\n" if line > n
+
+        autoreload = Setting[:autoreload]
+        possible_lines = LineCache.trace_line_numbers(file, autoreload)
+        if !possible_lines.member?(line)
+          return errmsg \
+            "Line #{line} is not a valid breakpoint in file #{path}\n"
+        end
+
+        b = Byebug.add_breakpoint file, line, expr
+        print "Created breakpoint #{b.id} at #{path}:#{line}\n"
+
+        if !syntax_valid?(expr)
+          errmsg "Incorrect expression \"#{expr}\"; breakpoint disabled.\n"
+          b.enabled = false
+        end
+
+      else
+        klass = bb_warning_eval(file)
+        if klass && klass.kind_of?(Module)
+          class_name = klass.name
+        else
+          return errmsg "Unknown class #{file}\n"
+        end
+
+        method = line.intern
+        b = Byebug.add_breakpoint class_name, method, expr
+        print "Created breakpoint #{b.id} at #{class_name}::#{method}\n"
+      end
+    end
+
+    class << self
+      def names
+        %w(break)
+      end
+
+      def description
+        %{b[reak] file:line [if expr]
+          b[reak] class(.|#)method [if expr]
+
+          Set breakpoint to some position, (optionally) if expr == true}
+      end
+    end
+  end
+end

data/lib/byebug/commands/catchpoint.rb

@@ -1,5 +1,4 @@
 module Byebug
-
   class CatchCommand < Command
     self.allow_in_control = true
 

data/lib/byebug/commands/condition.rb

@@ -1,5 +1,4 @@
 module Byebug
-
   class ConditionCommand < Command
     self.allow_in_post_mortem = false
 
@@ -10,16 +9,22 @@ module Byebug
     def execute
       return print ConditionCommand.help(nil) unless @match[1]
 
-      breakpoints = Byebug.breakpoints.sort_by{|b| b.id }
+      breakpoints = Byebug.breakpoints.sort_by { |b| b.id }
       largest = breakpoints.inject(0) do |tally, b|
         tally = b.id if b.id > tally
       end
 
-      return print "No breakpoints have been set.\n" if 0 == largest
+      return errmsg "No breakpoints have been set\n" if 0 == largest
       return unless pos = get_int(@match[1], "Condition", 1, largest)
 
-      breakpoint = breakpoints.select{ |b| b.id == pos }.first
-      breakpoint.expr = @match[2] if breakpoint
+      breakpoint = breakpoints.select { |b| b.id == pos }.first
+
+      if syntax_valid?(@match[2])
+        breakpoint.expr = @match[2]
+      else
+        return errmsg "Incorrect expression \"#{@match[2]}\", " \
+                      "breakpoint not changed\n"
+      end
     end
 
     class << self
@@ -37,5 +42,4 @@ module Byebug
       end
     end
   end
-
 end