byebug 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9de6831ec3ce9e27c6e2cca6a3e230f30d4c4498
+  data.tar.gz: 80c1890643664250f76be3332437054636223e6d
+SHA512:
+  metadata.gz: e57c240bc36528ad61d3e44be7819b9e72effe76f61e8895b9e24a8df9ee9a4eabbed01a6edfb6e42529128a02a0b1233761af4f2cf49e0119b49e2bfb4507a5
+  data.tar.gz: 88ce74faec5aef2ae39487e9be5912b1da806e2c8b8fe4513fcb9b0859a1432cc4ab764f95522ba2f01df853ee1fe97d737dd849bc8b42a6b56497fb1986c567

data/.gitignore

@@ -4,6 +4,8 @@ vendor/bundle
 doc
 
 .rvmrc
+.ruby-version
+.ruby-gemset
 .gdbinit
 .gdb_history
 .bundle

data/README.md

@@ -1,5 +1,37 @@
-## Description
+# Byebug [![Build Status](https://secure.travis-ci.org/deivid-rodriguez/byebug.png)](http://travis-ci.org/deivid-rodriguez/byebug) [![Code Climate](https://codeclimate.com/github/deivid-rodriguez/byebug.png)](https://codeclimate.com/github/deivid-rodriguez/byebug) [![Dependency Status](https://gemnasium.com/deivid-rodriguez/byebug.png)](https://gemnasium.com/deivid-rodriguez/byebug)
 
-Experimenting with github and ruby and mixing
-[debugger](https://github.com/cldwalker/debugger) and
-[debase](https://github.com/denofevil/debase) into a 2.0 compatible debugger.
+A Ruby 2.0 debugger.
+
+
+## Install
+
+Just type
+
+    $ gem install byebug
+
+or if you use bundler, drop
+
+    gem 'byebug'
+
+in your Gemfile
+
+
+## Usage
+
+Wherever you want to start debugging, simply drop:
+
+    byebug
+
+and the execution will stop and allow you to start debugging.
+
+## Credits
+
+Everybody who has ever contributed to this forked and reforked piece of
+software, specially:
+
+* Kent Sibilev and Mark Moseley, original authors of
+[ruby-debug](https://github.com/mark-moseley/ruby-debug).
+* Gabriel Horner, [debugger](https://github.com/cldwalker/debugger)'s mantainer.
+* Koichi Sasada, author of the new C debugging API for Ruby.
+* Dennis Ushakov, author of [debase](https://github.com/denofevil/debase), the
+starting point of this.

data/Rakefile

@@ -2,6 +2,7 @@
 require 'rake/testtask'
 require 'rake/extensiontask'
 require 'rubygems/package_task'
+require 'bundler/gem_tasks'
 
 Rake::ExtensionTask.new('byebug')
 
@@ -15,9 +16,6 @@ task :test do
   end
 end
 
-desc "Test everything - same as test."
-task :check => :test
-
 base_spec = eval(File.read('byebug.gemspec'), binding, 'byebug.gemspec')
 
 # Rake task to build the default package

data/bin/byebug

@@ -14,14 +14,13 @@
 #
 #<tt>-A | --annotate</tt> <i>level</i>::
 #    Set gdb-style annotation to <i>level</i>, a number.  Additional
-#    information is output automatically when program state is
-#    changed. This can be used by front-ends such as GNU Emacs to post
-#    this updated information without having to poll for it.
+#    information is output automatically when program state is changed. This
+#    can be used by front-ends such as GNU Emacs to post this updated
+#    information without having to poll for it.
 #
 #<tt>--client</tt>::
-#    Connect to a remote byebug. Used with another rdebug invocation
-#    using <tt>--server</tt>.  See also <tt>--host</tt> and
-#    <tt>--cport</tt> options
+#    Connect to a remote byebug. Used with another byebug invocation using
+#    <tt>--server</tt>.  See also <tt>--host</tt> and <tt>--cport</tt> options
 #
 #<tt>--cport=</tt><i>port</i>::
 #    Use port <i>port</i> for access to byebug control.
@@ -30,13 +29,12 @@
 #    Set $DEBUG true.
 #
 #<tt>--emacs</tt>::
-#    Activates full GNU Emacs mode. Is the equivalent of setting the
-#    options <tt>--emacs-basic --annotate=3 --no-stop --no-control
-#    --post-mortem</tt>.
+#    Activates full GNU Emacs mode. Is the equivalent of setting the options
+#    <tt>--emacs-basic --annotate=3 --no-stop --no-control --post-mortem</tt>.
 #
 #<tt>--emacs-basic</tt>::
-#     Activates GNU Emacs mode. Byebug prompts are prefaced with two
-#     octal 032 characters.
+#     Activates GNU Emacs mode. Byebug prompts are prefaced with two octal 032
+#     characters.
 #
 #<tt>-h | --host=</tt><i>host</i>::
 #     Use host name <i>host</i> for remote debugging.
@@ -66,8 +64,7 @@
 #      Show lines before executing them.
 #
 #<tt>--no-quit</tt>::
-#      Do not quit when script terminates. Instead rerun the
-#      program.
+#      Do not quit when script terminates. Instead rerun the program.
 #
 #<tt>--version</tt>::
 #      Show the version number and exit.
@@ -76,24 +73,24 @@
 #      Turn on verbose mode.
 #
 #<tt>--v</tt>::
-#      Print the version number, then turn on verbose mode if
-#      a script name is given. If no script name is given
-#     just exit after printing the version number.
+#      Print the version number, then turn on verbose mode if a script name is
+#      given. If no script name is given just exit after printing the version
+#      number.
 #
 #<tt>--nx</tt>::
-#      Don’t execute commands  found in any initialization
-#      files, e.g. <tt>.rdebugrc</tt>.
+#      Don’t execute commands found in any initialization files like
+#      <tt>.byebugrc</tt>.
 #
 #<tt>--keep-frame-binding</tt>::
 #      Keep frame bindings.
 #
 #<tt>--script=</tt><i>file</i>::
-#      Name of the script file to run
+#      Name of the script file to run.
 #
 #<tt>-s | --server</tt>::
-#      Listen for remote connections. Another rdebug session
-#      accesses using the <tt>--client</tt>  option. See also the
-#      <tt>--host</tt>, <tt>--port</tt> and <tt>--cport</tt> options
+#      Listen for remote connections. Another byebug session accesses using the
+#      <tt>--client</tt>  option. See also the <tt>--host</tt>, <tt>--port</tt>
+#      and <tt>--cport</tt> options
 #
 #<tt>-w | --wait</tt>::
 #      Wait for a client connection; implies <tt>-s</tt> option.
@@ -107,7 +104,7 @@ require File.dirname(__FILE__) + "/../lib/byebug"
 
 def debug_program(options)
   # Make sure Ruby script syntax checks okay.
-  # Otherwise we get a load message that looks like rdebug has a problem.
+  # Otherwise we get a load message that looks like byebug has a problem.
   output = `ruby -c "#{Byebug::PROG_SCRIPT}" 2>&1`
   if $?.exitstatus != 0 and RUBY_PLATFORM !~ /mswin/
     puts output
@@ -212,7 +209,7 @@ EOB
     opts.on('--no-stop', 'Do not stop when script is loaded') do
       options.stop = false
     end
-    opts.on('-nx', 'Not run byebug initialization files (e.g. .rdebugrc') do
+    opts.on('-nx', 'Not run byebug initialization files (e.g. .byebugrc') do
       options.nx = true
     end
     opts.on('-p', '--port PORT', Integer, 'Port used for remote debugging') do
@@ -289,8 +286,7 @@ unless defined?(OPTS_INITFILE)
 end
 begin
   initfile = File.join(HOME_DIR, OPTS_INITFILE)
-  eval(File.read(initfile)) if
-    File.exist?(initfile)
+  eval(File.read(initfile)) if File.exist?(initfile)
 rescue
 end
 
@@ -299,11 +295,11 @@ begin
   if not defined? Byebug::ARGV
     Byebug::ARGV = ARGV.clone
   end
-  rdebug_path = File.expand_path($0)
+  byebug_path = File.expand_path($0)
   if RUBY_PLATFORM =~ /mswin/
-    rdebug_path += '.cmd' unless rdebug_path =~ /\.cmd$/i
+    byebug_path += '.cmd' unless byebug_path =~ /\.cmd$/i
   end
-  Byebug::RDEBUG_SCRIPT = rdebug_path
+  Byebug::RDEBUG_SCRIPT = byebug_path
   Byebug::RDEBUG_FILE = __FILE__
   Byebug::INITIAL_DIR = Dir.pwd
   opts.parse! ARGV
@@ -350,7 +346,7 @@ else
     # start control thread
     Byebug.start_control(options.host, options.cport) if options.control
 
-    # load initrc script (e.g. .rdebugrc)
+    # load initrc script (e.g. .byebugrc)
     Byebug.run_init_script(StringIO.new) unless options.nx
 
     # run restore-settings startup script if specified

data/byebug.gemspec

@@ -5,6 +5,7 @@ require File.dirname(__FILE__) + "/lib/byebug/version"
 Gem::Specification.new do |s|
   s.name = %q{byebug}
   s.version = Byebug::VERSION
+
   s.authors = ["David Rodríguez", "Kent Sibilev", "Mark Moseley"]
   s.email = "deivid.rodriguez@mail.com"
   s.homepage = "http://github.com/deivid-rodriguez/byebug"
@@ -14,16 +15,21 @@ Gem::Specification.new do |s|
     the rest of the gem was forked from debugger. The core component provides
     support that front-ends can build on. It provides breakpoint handling,
     bindings for stack frames among other things.}
-  s.required_rubygems_version = ">= 1.3.6"
+
+  s.required_ruby_version = '>= 2.0.0'
+  s.required_rubygems_version = ">= 2.0.3"
+
   s.extra_rdoc_files = [ "README.md" ]
   s.files = `git ls-files`.split("\n")
   s.extensions << "ext/byebug/extconf.rb"
   s.executables = ["byebug"]
+
   s.add_dependency "columnize", "~> 0.3.6"
   s.add_dependency "debugger-linecache", '~> 1.2.0'
-  s.add_development_dependency 'rake', '~> 10.0.3'
+  s.add_development_dependency 'rake', '~> 10.0.4'
   s.add_development_dependency 'rake-compiler', '~> 0.8.3'
   s.add_development_dependency 'mocha', '~> 0.13.3'
   s.add_development_dependency 'minitest', '~> 4.7.0'
+
   s.license = "BSD"
 end

data/lib/byebug.rb

@@ -95,7 +95,7 @@ module Byebug
       Breakpoint.remove breakpoints, id
     end
 
-    def interface=(value) # :nodoc:
+    def interface=(value)
       handler.interface = value
     end
 
@@ -231,7 +231,7 @@ module Byebug
       socket.close
     end
 
-    #
+    ##
     # Runs normal byebug initialization scripts.
     #
     # Reads and executes the commands from init file (if any) in the current
@@ -242,15 +242,15 @@ module Byebug
     #
     def run_init_script(out = handler.interface)
       cwd_script  = File.expand_path(File.join(".", INITFILE))
-      run_script(cwd_script, out) if File.exists?(script_file)
+      run_script(cwd_script, out) if File.exists?(cwd_script)
 
       home_script = File.expand_path(File.join(ENV['HOME'].to_s, INITFILE))
       if File.exists?(home_script) and cwd_script != home_script
-         run_script(home_script_file, out)
+         run_script(home_script, out)
       end
     end
 
-    #
+    ##
     # Runs a script file
     #
     def run_script(file, out = handler.interface, verbose=false)
@@ -367,6 +367,7 @@ class Module
   #   EOD
   # end
 end
+
 module Kernel
 
   ##

data/lib/byebug/command.rb

@@ -4,6 +4,17 @@ require_relative 'helper'
 
 module Byebug
 
+  module CommandFunctions
+    ##
+    # Pad a string with dots at the end to fit :width setting
+    #
+    def pad_with_dots(string)
+      if string.size > Command.settings[:width]
+        string[Command.settings[:width]-3 .. -1] = "..."
+      end
+    end
+  end
+
   # Root dir for byebug
   BYEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
     defined?(BYEBUG_DIR)
@@ -13,6 +24,15 @@ module Byebug
     SubcmdStruct = Struct.new(:name, :min, :short_help, :long_help) unless
       defined?(SubcmdStruct)
 
+    def print_subcommands
+      cmd_name = self.class.name.chomp("Command").downcase
+      errmsg "#{cmd_name} must be followed by the name of a subcommand.\n"
+      print "List of #{cmd_name} subcommands:\n\n"
+      for subcmd in Subcommands do
+        print "#{cmd_name} #{subcmd.name} -- #{subcmd.short_help}\n"
+      end
+    end
+
     include Columnize
 
     # Find param in subcmds. param id downcased and can be abbreviated
@@ -35,7 +55,7 @@ module Byebug
 
       DEF_OPTIONS = {
         :allow_in_control     => false,
-        :allow_in_post_mortem => true ,
+        :allow_in_post_mortem => false ,
         :event                => true ,
         :always_run           => 0    ,
         :unknown              => false,
@@ -78,7 +98,7 @@ module Byebug
       private :settings_map
 
       def settings
-        unless true and defined? @settings and @settings
+        unless defined? @settings and @settings
           @settings = Object.new
           map = settings_map
           c = class << @settings; self end
@@ -127,23 +147,19 @@ module Byebug
       end
     end
 
-    register_setting_var(:basename, false)  # use basename in showing files?
+    # Register default settings
+    register_setting_var(:basename, false)
     register_setting_var(:callstyle, :last)
     register_setting_var(:byebugtesting, false)
     register_setting_var(:force_stepping, false)
     register_setting_var(:full_path, true)
-    register_setting_var(:listsize, 10)    # number of lines in list command
+    register_setting_var(:autolist, 1)
+    register_setting_var(:listsize, 10)
     register_setting_var(:stack_trace_on_error, false)
-    register_setting_var(:tracing_plus, false) # different linetrace lines?
-
-    # width of line output. Use COLUMNS value if it exists and is not too large.
-    width = ENV['COLUMNS'].to_i
-    width = 80 unless width > 10
-    register_setting_var(:width, width)
-
-    if not defined? Byebug::ARGV
-      Byebug::ARGV = ARGV.clone
-    end
+    register_setting_var(:tracing_plus, false)
+    register_setting_var(:width,
+                         ENV['COLUMNS'].to_i > 10 ? ENV['COLUMNS'].to_i : 80)
+    Byebug::ARGV = ARGV.clone unless defined? Byebug::ARGV
     register_setting_var(:argv, Byebug::ARGV)
 
     def initialize(state)
@@ -192,10 +208,6 @@ module Byebug
         @state.context.frame_binding(@state.frame_pos)
       end
 
-      #def line_at(file, line)
-      #  Byebug.line_at(file, line)
-      #end
-
       def get_context(thnum)
         Byebug.contexts.find{|c| c.thnum == thnum}
       end

data/lib/byebug/commands/control.rb

@@ -28,12 +28,12 @@ module Byebug
           print "Ruby program #{Byebug::PROG_SCRIPT} not executable... " \
                 "We'll add a call to Ruby.\n"
           ruby = begin defined?(Gem) ? Gem.ruby : "ruby" rescue "ruby" end
-          rdebug_script = "#{ruby} -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
+          byebug_script = "#{ruby} -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
         else
-          rdebug_script = Byebug::PROG_SCRIPT
+          byebug_script = Byebug::PROG_SCRIPT
         end
       else
-        rdebug_script = Byebug::RDEBUG_SCRIPT
+        byebug_script = Byebug::RDEBUG_SCRIPT
       end
 
       begin
@@ -52,7 +52,7 @@ module Byebug
           argv = Command.settings[:argv]
         end
       end
-      cmd = "#{rdebug_script} #{argv.compact.join(' ')}"
+      cmd = "#{byebug_script} #{argv.compact.join(' ')}"
 
       # An execv would be preferable to the "exec" below.
       print "Re exec'ing:\n\t#{cmd}\n"

data/lib/byebug/commands/frame.rb

@@ -109,19 +109,20 @@ module Byebug
       #end
     end
 
-    # Check if call stack is truncated.  This can happen if
-    # Byebug.start is not called low enough in the call stack. An
-    # array of additional callstack lines from caller is returned if
-    # definitely truncated, false if not, and nil if we don't know.
+    ##
+    # Check if call stack is truncated. This can happen if Byebug.start is not
+    # called low enough in the call stack. An array of additional callstack
+    # lines from caller is returned if definitely truncated, false if not, and
+    # nil if we don't know.
     #
-    # We determine truncation based on a passed in sentinal set via
-    # caller which can be nil.
+    # We determine truncation based on a passed in sentinal set via caller which
+    # can be nil.
     #
-    # First we see if we can find our position in caller. If so, then
-    # we compare context position to that in caller using sentinal
-    # as a place to start ignoring additional caller entries. sentinal
-    # is set by rdebug, but if it's not set, i.e. nil then additional
-    # entries are presumably ones that we haven't recorded in context
+    # First we see if we can find our position in caller. If so, then we compare
+    # context position to that in caller using sentinal as a place to start
+    # ignoring additional caller entries. sentinal is set by byebug, but if it's
+    # nil then additional entries are presumably ones that we haven't recorded
+    # in context
     def truncated_callstack?(context, sentinal=nil, cs=caller)
       recorded_size = context.stack_size
       to_find_fl = "#{context.frame_file(0)}:#{context.frame_line(0)}"

data/lib/byebug/commands/info.rb

@@ -9,58 +9,56 @@ module Byebug
       if Byebug.catchpoints and not Byebug.catchpoints.empty?
         Byebug.catchpoints.each do |exception, hits|
           print "#{exception}: #{exception.is_a?(Class)}\n"
-          #print "#{exception}\n"
         end
       else
         print "No exceptions set to be caught.\n"
       end
     end
+
   end
 
   # Implements byebug "info" command.
   class InfoCommand < Command
     self.allow_in_control = true
-    Subcommands =
-      [
-       ['args', 1, 'Argument variables of current stack frame'],
-       ['breakpoints', 1, 'Status of user-settable breakpoints',
-        'Without argument, list info about all breakpoints.  With an integer ' \
-        'argument, list info on that breakpoint.'],
-       ['catch', 3, 'Exceptions that can be caught in the current stack frame'],
-       ['display', 2, 'Expressions to display when program stops'],
-       ['file', 4, 'Info about a particular file read in',
-        'After the file name is supplied, you can list file attributes that ' \
-        'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
-        '"lines", "mtime", "path" and "sha1".'],
-       ['files', 5, 'File names and timestamps of files read in'],
-       ['global_variables', 2, 'Global variables'],
-       ['instance_variables', 2,
-        'Instance variables of the current stack frame'],
-       ['line', 2,
-        'Line number and file name of current position in source file'],
-       ['locals', 2, 'Local variables of the current stack frame'],
-       ['program', 2, 'Execution status of the program'],
-       ['stack', 2, 'Backtrace of the stack'],
-#      ['thread', 6,  'List info about thread NUM',
-#       'If no thread number is given, we list info for all threads. '         \
-#       '\'terse\' and \'verbose\' options are possible. If \'terse\', just '  \
-#       'give summary thread name information. See "help info threads" for '   \
-#       'more detail about this summary information. If \'verbose\' appended ' \
-#       'to the end of the command, then the entire stack trace is given for ' \
-#       'each thread.'],
-#      ['threads', 7, 'information of currently-known threads',
-#       'This information includes whether the thread is the current thread ' \
-#       '(+), it\'s suspended ($) or it\'s ignored (!), plus the thread '     \
-#       'number and the top stack item. If \'verbose\' is given then the '    \
-#       'entire stack frame is shown.'],
-       ['variables', 1,
-        'Local and instance variables of the current stack frame']
+    Subcommands = [
+      ['args', 1, 'Argument variables of current stack frame'],
+      ['breakpoints', 1, 'Status of user-settable breakpoints',
+       'Without argument, list info about all breakpoints. With an integer ' \
+       'argument, list info on that breakpoint.'],
+      ['catch', 3, 'Exceptions that can be caught in the current stack frame'],
+      ['display', 2, 'Expressions to display when program stops'],
+      ['file', 4, 'Info about a particular file read in',
+       'After the file name is supplied, you can list file attributes that ' \
+       'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
+       '"lines", "mtime", "path" and "sha1".'],
+      ['files', 5, 'File names and timestamps of files read in'],
+      ['global_variables', 2, 'Global variables'],
+      ['instance_variables', 2,
+       'Instance variables of the current stack frame'],
+      ['line', 2,
+       'Line number and file name of current position in source file'],
+      ['locals', 2, 'Local variables of the current stack frame'],
+      ['program', 2, 'Execution status of the program'],
+      ['stack', 2, 'Backtrace of the stack'],
+#     ['thread', 6,  'List info about thread NUM',
+#      'If no thread number is given, we list info for all threads. '         \
+#      '\'terse\' and \'verbose\' options are possible. If \'terse\', just '  \
+#      'give summary thread name information. See "help info threads" for '   \
+#      'more detail about this summary information. If \'verbose\' appended ' \
+#      'to the end of the command, then the entire stack trace is given for ' \
+#      'each thread.'],
+#     ['threads', 7, 'information of currently-known threads',
+#      'This information includes whether the thread is the current thread ' \
+#      '(+), it\'s suspended ($) or it\'s ignored (!), plus the thread '     \
+#      'number and the top stack item. If \'verbose\' is given then the '    \
+#      'entire stack frame is shown.'],
+      ['variables', 1,
+       'Local and instance variables of the current stack frame']
       ].map do |name, min, short_help, long_help|
       SubcmdStruct.new(name, min, short_help, long_help)
     end unless defined?(Subcommands)
 
-    InfoFileSubcommands =
-      [
+    InfoFileSubcommands = [
        ['all', 1, 'All file information available - breakpoints, lines, mtime' \
          ', path and sha1'],
        ['basic', 2, 'basic information - path, number of lines'],
@@ -74,9 +72,8 @@ module Byebug
       SubcmdStruct.new(name, min, short_help, long_help)
     end unless defined?(InfoFileSubcommands)
 
-#   InfoThreadSubcommands =
-#     [
-#      ['terse', 1,   'summary information'],
+#   InfoThreadSubcommands = [
+#      ['terse', 1, 'summary information'],
 #      ['verbose', 1, 'summary information and stack frame info'],
 #     ].map do |name, min, short_help, long_help|
 #     SubcmdStruct.new(name, min, short_help, long_help)
@@ -88,11 +85,7 @@ module Byebug
 
     def execute
       if !@match[1]
-        errmsg "\"info\" must be followed by the name of an info command:\n"
-        print "List of info subcommands:\n\n"
-        for subcmd in Subcommands do
-          print "info #{subcmd.name} -- #{subcmd.short_help}\n"
-        end
+        print_subcommands
       else
         args = @match[1].split(/[ \t]+/)
         param = args.shift
@@ -114,9 +107,7 @@ module Byebug
       args = @state.context.frame_args(@state.frame_pos)
       args.each do |name|
         s = "#{name} = #{locals[name].inspect}"
-        if s.size > self.class.settings[:width]
-          s[self.class.settings[:width]-3 .. -1] = "..."
-        end
+        pad_with_dots(s)
         print "#{s}\n"
       end
     end
@@ -278,9 +269,7 @@ module Byebug
             s = "*Error in evaluation*"
           end
         end
-        if s.size > self.class.settings[:width]
-          s[self.class.settings[:width]-3 .. -1] = "..."
-        end
+        pad_with_dots(s)
         print "#{s}\n"
       end
     end
@@ -381,7 +370,7 @@ module Byebug
         errmsg "info global_variables not available here.\n"
         return
       end
-      var_list(global_variables)
+      var_global
     end
 
     def info_variables(*args)
@@ -404,9 +393,7 @@ module Byebug
             s = "#{name} = *Error in evaluation*"
           end
         end
-        if s.size > self.class.settings[:width]
-          s[self.class.settings[:width]-3 .. -1] = "..."
-        end
+        pad_with_dots(s)
         s.gsub!('%', '%%')  # protect against printf format strings
         print "#{s}\n"
       end