byebug 4.0.5 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86c24793f077ce32dceea91c8bde07dce922a274
-  data.tar.gz: f166af0f5a9b01024978ebf2ebb5d9b7103d8a7b
+  metadata.gz: 96c7056e0b0872cdba9ffbc43941b6c804ee5db8
+  data.tar.gz: c06eaaf13304aca7e289301fa61a7c0735f16647
 SHA512:
-  metadata.gz: 19d9a87a1f69496bdb00574437c3913b167d2da92d1b1b35c64412a70adfc8309f2bc78bdac5233bea310bd46543af2966b762453318e450ff6d73092626b16d
-  data.tar.gz: cfe46396685e6cec68816f38b70183317cf7585e1bbec594de6e670962151a5cd1eb4e1eb2483c0aafe43e94d741589c595c8d8e5a4cecb5124200b617c04b05
+  metadata.gz: 1fbf5703563d4b88ec8b5b843704a51b78d4f47f5f9e6735942fc1a75c881f440ff4569220e0c6c4f101bda57e1ec16f3089cf26fa3b068c32b97246ee60fd7e
+  data.tar.gz: 0ddec536c7c8ae53485105eaf226946d1fcc3510cd1b0a3220f446d18fbbe2433068de2e922ce44192dc5c559ad5fb74d9a76264327f273be3f127b6f32201f0

data/CHANGELOG.md

@@ -1,12 +1,34 @@
+## 5.0.0
+### Fixed
+* [#136](https://github.com/deivid-rodriguez/byebug/issues/136). `frame`
+command not working with negative numbers (thanks @ark6).
+
+### Added
+* IDE support and a new command/subcommand API for plugins.
+* Add a "savefile" setting holding the file where "save" command saves current
+debugger's state.
+
+### Changed
+* `disable` no longer disable all breakpoints, it just shows command's help
+instead. To disable all breakpoints now you need to do `disable breakpoints`
+(or `dis b`). Similarly, you can't no longer use `dis 1 2 3` but need to do
+`dis b 1 2 3` to disable specific breakpoints. The same applies to the `enable`
+command.
+
+### Removed
+* `help set <setting>` no longer works. `help set` includes that same output and
+it's not verbose enough so that this is a problem. Same with `help show
+<setting>`.
+
 ## 4.0.5 - 2015-04-02
 ### Fixed
-* #131
+* [#131](https://github.com/deivid-rodriguez/byebug/issues/131)
 * Thread commands help format should be consistent with the rest of the help
 system now.
 
 ## 4.0.4 - 2015-03-27
 ### Fixed
-* #127
+* [#127](https://github.com/deivid-rodriguez/byebug/issues/127)
 
 ## 4.0.3 - 2015-03-19
 ### Fixed
@@ -14,13 +36,15 @@ system now.
 
 ## 4.0.2 - 2015-03-16
 ### Fixed
-* Removed `rb-readline` as a dependency and show a help message whenever
-requiring readline fails instead (#118)
+* [#118](https://github.com/deivid-rodriguez/byebug/issues/118). Remove
+`rb-readline` as a dependency and show a help message whenever requiring
+`readline` fails instead.
 
 ## 4.0.1 - 2015-03-13
 ### Fixed
 * .yml files needed for printers support were missing from the release... :S
-* Add `rb-readline` as a dependency (#118)
+* [#118](https://github.com/deivid-rodriguez/byebug/issues/118). Add `readline`
+as a dependency.
 
 ## 4.0.0 - 2015-03-13
 ### Added
@@ -35,9 +59,10 @@ requiring readline fails instead (#118)
 ### Changed
 - A lot of internal refactoring.
 - `tracevar` now requires the full global variable name (with "$").
-- `catch` command is not allowed in post_mortem mode anymore. It was not
-working anyways (#92).
-- `step` is now more user friendly when used in combination with `up` (see #85).
+- [#92](https://github.com/deivid-rodriguez/byebug/issues/92). The `catch`
+command is not allowed in post_mortem mode anymore. It was not working anyways.
+- [#85](https://github.com/deivid-rodriguez/byebug/issues/85). `step` is now
+more user friendly when used in combination with `up`.
 - `var const` can now be called without an argument and will show constants in
 the current scope.
 - `break` with a class name now creates breakpoints regardless of class not
@@ -48,17 +73,21 @@ created anyways.
 - Code reloading issues.
 - `set fullpath` was not showing fullpaths. Now it is.
 - `up`, `down` and `frame` commands now work in post_mortem mode (#93).
-- Fixes in rc file (.byebugrc): invalid commands are just ignored instead of
+- rc file (`.byebugrc`) loading: invalid commands are just ignored instead of
 aborting, global (home) rc file is now properly loaded before project's file.
-- Backtraces not working in `post_mortem` mode (#93).
+- [#93](https://github.com/deivid-rodriguez/byebug/issues/93). Backtraces not
+working in `post_mortem` mode.
 - 'cmd1 ; cmd2 ; ...; cmdN' syntax which allows running several commands
 sequentially.
-- Finish command not stopping at the correct line (#101).
-- `break` with namespaced class, like `break A::B#c` should now work (#106).
+- [#101](https://github.com/deivid-rodriguez/byebug/issues/101). `finish`
+command not stopping at the correct line.
+- [#106](https://github.com/deivid-rodriguez/byebug/issues/106). `break` with
+namespaced class, like `break A::B#c` should now work.
 - Command history is now persisted before exiting byebug.
 - Setting breakpoint in a method would stop not only at the beginning of the
 method but also at the beginning of every block inside the method.
-- Setting breakpoints on module methods (#122, @x-yuri).
+- [#122](https://github.com/deivid-rodriguez/byebug/issues/122). Setting
+breakpoints on module methods (@x-yuri).
 
 ### Removed
 - `autoreload` setting as it's not necessary anymore. Code should always be up
@@ -82,12 +111,14 @@ autoevaluate it.
 
 ## 3.5.1 - 2014-09-29
 ### Fixed
-- Windows installation (#79).
+- [#79](https://github.com/deivid-rodriguez/byebug/issues/79). Windows
+installation.
 - `condition` command not properly detecting invalid breakpoint ids.
 
 ## 3.5.0 - 2014-09-28
 ### Fixed
-- Byebug's history messing other programs using Readline (#81).
+- [#81](https://github.com/deivid-rodriguez/byebug/issues/81). Byebug's history
+messing up other programs using Readline.
 - Readline's history not being properly saved and inmediately available.
 - User not being notified when trying to debug a non existent script.
 
@@ -98,14 +129,14 @@ autoevaluate it.
 
 ## 3.4.2 - 2014-09-26
 ### Fixed
-- Debugging commands invoked by ruby exectuable (#67), as in `byebug --
-ruby -Itest test/controllers/posts_controller_test.rb -n
-test_should_get_index`.
-
+- [#67](https://github.com/deivid-rodriguez/byebug/issues/67). Debugging
+commands invoked by ruby executable, as in `byebug -- ruby -Itest a_test.rb
+-n test_something`.
 
 ## 3.4.1 - 2014-09-25
 ### Fixed
-- Use of threads inside `eval` command (#54).
+- [#54](https://github.com/deivid-rodriguez/byebug/issues/54). Use of threads
+inside `eval` command.
 - `list` command not listing backwards after reaching the end of the file.
 
 ## 3.4.0 - 2014-09-01
@@ -138,16 +169,17 @@ default behaviour though.
 
 ## 3.2.0 - 2014-08-02
 ### Fixed
-- Remote debugging (#71), thanks @shuky19.
-- `source` command (#68), thanks @Olgagr.
-- `ruby-head` support (#71).
+- [#71](https://github.com/deivid-rodriguez/byebug/issues/71). Remote debugging
+(thanks @shuky19).
+- [#69](https://github.com/deivid-rodriguez/byebug/issues/69). `source` command
+(thanks @Olgagr).
 
 ### Removed
 - `post_mortem` activation through `Byebug.post_mortem`. Use `set post_mortem`
 instead.
 - `info stack` command. Use `where` instead.
 - `method iv` command. Use `var instance` instead.
-- Warning reported in #77.
+- [#77](https://github.com/deivid-rodriguez/byebug/issues/77). Warning.
 
 ## 3.1.2 - 2014-04-23
 ### Fixed
@@ -179,8 +211,8 @@ global variable tracing.
 - Plain `byebug` not working when `pry-byebug` installed.
 - `post_mortem` mode.
 - Command history not being saved after regular program termination.
-- (Again) Calling `Byebug.start` with `Timeout.timeout` (#54), thanks
-@zmoazeni!
+- [#54](https://github.com/deivid-rodriguez/byebug/issues/54). (Again) calling
+`Byebug.start` with `Timeout.timeout` (thanks @zmoazeni).
 
 ### Added
 - Allow disabling `post_mortem` mode.
@@ -191,7 +223,7 @@ like shell's `history` command.
 - `show/set history filename` is now `show/set histfile`
 - `show/set history size` is now `show/set histsize`
 - `show/set history save` is now `show/set autosave`
-- `finish` semantic, see
+- `finish` semantics, see
 [61f9b4d](https://github.com/deivid-rodriguez/byebug/commit/61f9b4d).
 - Use `per project` history file by default.
 
@@ -200,8 +232,12 @@ like shell's `history` command.
 command work is always saved now.
 
 ## 2.7.0 - 2014-02-24
-- `IGNORED_FILES` slowing down startup (#52).
-- Calling `Byebug.start` with `Timeout.timeout` (#53, #54).
+### Fixed
+- [#52](https://github.com/deivid-rodriguez/byebug/issues/52). `IGNORED_FILES`
+slowing down startup.
+- [#53](https://github.com/deivid-rodriguez/byebug/issues/53) and
+[#54](https://github.com/deivid-rodriguez/byebug/issues/54). Calling
+`Byebug.start` with `Timeout.timeout`.
 
 ## 2.6.0 - 2014-02-08
 ### Fixed
@@ -213,13 +249,14 @@ command work is always saved now.
 
 ## 2.4.1 - 2013-12-05
 ### Fixed
-- Installation error in Mac OSX (#40), thanks @luislavena.
+- [#40](https://github.com/deivid-rodriguez/byebug/issues/40). Installation
+error in Mac OSX (thanks @luislavena).
 
 ## 2.4.0 - 2013-12-02
 ### Fixed
 - `thread list` showing too many threads.
-- Fix setting post mortem mode with "set post_mortem". Now this is the only
-post mortem functionality available as specifying "Byebug.post_mortem" with a
+- Fix setting post mortem mode with `set post_mortem`. Now this is the only
+post mortem functionality available as specifying `Byebug.post_mortem` with a
 block has been removed in this version.
 
 ### Added
@@ -250,7 +287,8 @@ library (thanks @nobu).
 
 ## 2.2.1 - 2013-09-24
 ### Fixed
-- Compilation issue introduced in 2.2.0 (#26).
+- [#26](https://github.com/deivid-rodriguez/byebug/issues/26). Compilation issue
+introduced in `2.2.0`.
 
 ### Changed
 - `show/set stack_trace_on_error` is now `show/set stack_on_error`.
@@ -289,7 +327,7 @@ library (thanks @nobu).
 - `jump` command. It had never worked.
 
 ### Changed
-- Varoius internal refactorings.
+- Several internal refactorings.
 
 ## 1.8.2 - 2013-08-16
 ### Fixed

data/CONTRIBUTING.md

@@ -1,3 +1,29 @@
+## Getting started
+
+The following steps should help you getting started:
+
+* `Byebug` depends on the TracePoint API provided by `ruby-core`. This is a
+young API and a lot of bugs have been recently corrected, so make sure you
+always have the lastest patch level release installed.
+* Get a local clone of `byebug`'s source code.
+* Run `bundle install` to get development & test dependencies installed.
+* Install the [overcommit][] hooks using `bundle exec overcommit --install`.
+They will review your changes before they are committed, checking they are
+consistent with the project's code style. If you're changing C files, make sure
+you have the GNU indent utility installed in your system. `sudo apt-get install
+indent` for linux or `brew install gnu-indent --with-default-names` should do
+the job.
+* Make sure you compile the C-extension using `bundle exec rake compile`.
+Otherwise you won't be able to use `byebug`.
+* Run the test suite using the default rake task (`bundle exec rake`). This
+task is composed of 2 subtasks: `bundle exec rake compile` && `bundle exec rake
+test`.
+
+After having done this, just read the code and improve it! Your contribution is
+appreciated a lot!
+
+[overcommit]: https://github.com/brigade/overcommit/
+
 ## Byebug as a C-extension
 
 Byebug is a gem developed as a C-extension. The debugger internal's
@@ -8,34 +34,3 @@ or the feature you are willing to add. You can learn more about C-extensions
 [here](http://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1.html)
 or
 [here](http://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2.html).
-
-
-## Prerequisites
-
-`Byebug` depends on the TracePoint API provided by `ruby-core`. This is a young
-API and a lot of bugs have been recently corrected. Without this fixes,
-`byebug` will fail to work properly, so make sure you have always the last
-patch level releases of Ruby installed.
-
-Also, if you are developing on linux, make sure you have the GNU indent utility
-installed for automatic check of code style in C files. If you're developing in
-MacOSX, just make sure you keep a consistent style if you edit the C-extension
-files. Travis CI will do the automatic check anyways.
-
-
-## Getting started
-
-Once you have a local clone of `byebug`, you can start digging in the source
-code. First run `bundle install` to get development & test dependencies
-installed. Also make sure you compile the C-extension using `bundle exec rake
-compile`, otherwise you won't be able to use your local clone. You can also run
-the test suite as the default rake task (`bundle exec rake`). This task is
-composed of 4 subtasks:
-
-    bundle exec rake compile # compiles the C-extension
-    bundle exec rake test # Run the test suite
-    bundle exec rake rubocop # Run RuboCop's checks on the Ruby files
-    bundle exec rake ccop # Run `indent`'s checks on the C files
-
-After having done this, just read the code and improve it! Your contribution is
-appreciated a lot!

data/README.md

@@ -97,7 +97,7 @@ are debugging rails, start the server and once the execution gets to your
     `frame`     |              |
     `help`      |              |
     `history`   |              |
-    `info`      |              | `args` `breakpoints` `catch` `display` `file` `files` `line` `program`
+    `info`      |              | `args` `breakpoints` `catch` `display` `file` `line` `program`
     `irb`       |              |
     `kill`      |              |
     `list`      |              |
@@ -110,8 +110,8 @@ are debugging rails, start the server and once the execution gets to your
     `quit`      | `exit`       |
     `restart`   |              |
     `save`      |              |
-    `set`       |              | `autoeval` `autoirb` `autolist` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `stack_on_error` `verbose` `width`
-    `show`      |              | `autoeval` `autoirb` `autolist` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `stack_on_error` `verbose` `width`
+    `set`       |              | `autoeval` `autoirb` `autolist` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `verbose` `width`
+    `show`      |              | `autoeval` `autoirb` `autolist` `autosave` `basename` `callstyle` `fullpath` `histfile` `histsize` `linetrace` `listsize` `post_mortem` `savefile` `stack_on_error` `verbose` `width`
     `source`    |              |
     `step`      |              |
     `thread`    |              | `current` `list` `resume` `stop` `switch`

data/lib/byebug/breakpoint.rb

@@ -48,7 +48,8 @@ module Byebug
     # @param filename [String] File name to inspect for possible breakpoints
     #
     def self.potential_lines(filename)
-      name, lines = "#{Time.new.to_i}_#{rand(2**31)}", {}
+      name = "#{Time.new.to_i}_#{rand(2**31)}"
+      lines = {}
       iseq = RubyVM::InstructionSequence.compile(File.read(filename), name)
 
       iseq.disasm.each_line do |line|

data/lib/byebug/command.rb

@@ -1,29 +1,36 @@
 require 'columnize'
 require 'forwardable'
-require 'byebug/helper'
+require 'byebug/helpers/string'
 
 module Byebug
   #
   # Parent class of all byebug commands.
   #
-  # Subclasses need to implement a `regexp` and an `execute` command.
+  # Subclasses need to implement a `regexp` method and an `execute` method.
   #
   class Command
     extend Forwardable
 
-    include ParseFunctions
-    include FileFunctions
-
-    Subcmd = Struct.new(:name, :min, :help)
+    include Helpers::StringHelper
 
     def initialize(state)
-      @match, @state = nil, state
+      @match = nil
+      @state = state
     end
 
     def match(input)
       @match = regexp.match(input)
     end
 
+    def_delegators :'self.class', :to_name, :description
+
+    #
+    # Default help text for a command.
+    #
+    def help
+      prettify(description)
+    end
+
     def_delegator :"Byebug.printer", :print, :pr
     def_delegator :"Byebug.printer", :print_collection, :prc
     def_delegator :"Byebug.printer", :print_variables, :prv
@@ -65,8 +72,6 @@ module Byebug
     end
 
     class << self
-      include StringFunctions
-
       attr_accessor :allow_in_control
       attr_writer :allow_in_post_mortem, :always_run
 
@@ -78,49 +83,22 @@ module Byebug
         @always_run ||= 0
       end
 
-      def help(subcmd = nil)
-        return format_subcmd(subcmd) if subcmd
-
-        output = description
-        output += format_subcmds if defined? self::Subcommands
-        output
+      #
+      # Name of the command, as executed by the user.
+      #
+      def to_name
+        name.gsub(/^Byebug::/, '').gsub(/Command$/, '').downcase
       end
 
-      def find(subcmds, str)
-        str.downcase!
-        subcmds.each do |subcmd|
-          if (str.size >= subcmd.min) && (subcmd.name[0..str.size - 1] == str)
-            return subcmd
-          end
-        end
-
-        nil
-      end
-
-      def format_subcmd(subcmd_name)
-        subcmd = find(self::Subcommands, subcmd_name)
-        return "Invalid \"#{names.join('|')}\" " \
-               "subcommand \"#{args[1]}\"." unless subcmd
-
-        "\n  #{subcmd.help}.\n\n"
-      end
-
-      def format_subcmds
-        header = names.join('|')
-        s = "  List of \"#{header}\" subcommands:\n  --\n"
-        w = self::Subcommands.map(&:name).max_by(&:size).size
-        self::Subcommands.each do |subcmd|
-          s += format("  %s %-#{w}s -- %s\n", header, subcmd.name, subcmd.help)
-        end
-        s + "\n"
-      end
-
-      def commands
-        @commands ||= []
-      end
+      #
+      # Available subcommands for the current command
+      #
+      # A subcommand is any class defined inside the parent's command class
+      #
+      def subcommands
+        const_list = constants(false).map { |const| const_get(const, false) }
 
-      def inherited(klass)
-        commands << klass
+        const_list.select { |c| c.is_a?(Class) }
       end
     end
   end

data/lib/byebug/commands/break.rb

@@ -1,10 +1,15 @@
 require 'byebug/command'
+require 'byebug/helpers/file'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
   # Implements breakpoint functionality
   #
   class BreakCommand < Command
+    include Helpers::FileHelper
+    include Helpers::ParseHelper
+
     self.allow_in_post_mortem = false
     self.allow_in_control = true
 
@@ -13,7 +18,7 @@ module Byebug
     end
 
     def execute
-      return puts(self.class.help) unless @match[1]
+      return puts(help) unless @match[1]
 
       b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])
 
@@ -27,25 +32,24 @@ module Byebug
       errmsg(e.message)
     end
 
-    class << self
-      def names
-        %w(break)
-      end
+    def short_description
+      'Set breakpoint to some position, (optionally) if expr == true'
+    end
 
-      def description
-        prettify <<-EOD
-          b[reak] [file:]line [if expr]
-          b[reak] [module::...]class(.|#)method [if expr]
+    def description
+      <<-EOD
+        b[reak] [file:]line [if expr]
+        b[reak] [module::...]class(.|#)method [if expr]
 
-          Set breakpoint to some position, (optionally) if expr == true
-        EOD
-      end
+        #{short_description}
+      EOD
     end
 
     private
 
     def line_breakpoint(loc)
-      line, file_line = loc.match(/^(\d+)$/), loc.match(/^([^:]+):(\d+)$/)
+      line = loc.match(/^(\d+)$/)
+      file_line = loc.match(/^([^:]+):(\d+)$/)
       return nil unless line || file_line
 
       f, l = line ? [@state.file, line[1]] : [file_line[1], file_line[2]]
@@ -57,7 +61,8 @@ module Byebug
 
     def method_breakpoint(location)
       location.match(/([^.#]+)[.#](.+)/) do |match|
-        k, m = bb_warning_eval(match[1]), match[2]
+        k = bb_warning_eval(match[1])
+        m = match[2]
 
         klass = k && k.is_a?(Module) ? k.name : match[1]
         method = m.intern
@@ -67,7 +72,8 @@ module Byebug
     end
 
     def check_errors(file, line)
-      path, deco_path = File.expand_path(file), normalize(file)
+      path = File.expand_path(file)
+      deco_path = normalize(file)
 
       fail(pr('break.errors.source', file: deco_path)) unless File.exist?(path)