byebug 3.0.0 → 3.1.0

data/lib/byebug/helper.rb

@@ -1,69 +1,38 @@
 module Byebug
-
   module ParseFunctions
     Position_regexp = '(?:(\d+)|(.+?)[:.#]([^.:\s]+))'
 
     # Parse 'str' of command 'cmd' as an integer between
     # min and max. If either min or max is nil, that
     # value has no bound.
-    def get_int(str, cmd, min=nil, max=nil, default=1)
-      return default unless str
+    def get_int(str, cmd, min = nil, max = nil, default = 1)
+      unless str
+        return default if default
+        print "You need to specify an argument for \"#{cmd}\"\n"
+        return nil
+      end
+
       begin
         int = Integer(str)
         if min and int < min
-          print "\"#{cmd}\" argument \"#{str}\" needs to be at least #{min}.\n"
+          print "\"#{cmd}\" argument \"#{str}\" needs to be at least #{min}\n"
           return nil
         elsif max and int > max
-          print "\"#{cmd}\" argument \"#{str}\" needs to be at most #{max}.\n"
+          print "\"#{cmd}\" argument \"#{str}\" needs to be at most #{max}\n"
           return nil
         end
         return int
       rescue
-        print "\"#{cmd}\" argument \"#{str}\" needs to be a number.\n"
+        print "\"#{cmd}\" argument \"#{str}\" needs to be a number\n"
         return nil
       end
     end
 
-    # Return true if arg is 'on' or 1 and false arg is 'off' or 0.
-    # Any other value raises RuntimeError.
-    def get_onoff(arg, default=nil, print_error=true)
-      if arg.nil? or arg == ''
-        if default.nil?
-          if print_error
-            print "Expecting 'on', 1, 'off', or 0. Got nothing.\n"
-            raise RuntimeError
-          end
-          return default
-        end
-      end
-      case arg.downcase
-      when '1', 'on'
-        return true
-      when '0', 'off'
-        return false
-      else
-        if print_error
-          print "Expecting 'on', 1, 'off', or 0. Got: #{arg.to_s}.\n"
-          raise RuntimeError
-        end
-      end
-    end
-
-    # Return 'on' or 'off' for supplied parameter. The parameter should
-    # be true, false or nil.
-    def show_onoff(bool)
-      if not [TrueClass, FalseClass, NilClass].member?(bool.class)
-        return "??"
-      end
-      return bool ? 'on' : 'off'
-    end
-
     # Return true if code is syntactically correct for Ruby.
     def syntax_valid?(code)
-      eval("BEGIN {return true}\n#{code}", nil, "", 0)
+      eval("BEGIN {return true}\n#{code}", nil, '', 0)
     rescue SyntaxError
       false
     end
-
   end
 end

data/lib/byebug/history.rb

@@ -2,33 +2,25 @@ require 'readline'
 
 module Byebug
   class History
-    DEFAULT_FILE = File.expand_path("#{ENV['HOME']||'.'}/.byebug_hist")
-    DEFAULT_MAX_SIZE = 256
-
-    @file = DEFAULT_FILE
-    @max_size = DEFAULT_MAX_SIZE
-
     class << self
-      attr_accessor :file, :max_size
-
       def load
-        open(@file, 'r') do |file|
+        open(Setting[:histfile], 'r') do |file|
           file.each do |line|
             line.chomp!
             Readline::HISTORY << line
           end
-        end if File.exist?(@file)
+        end if File.exist?(Setting[:histfile])
       end
 
       def save
-        open(@file, 'w') do |file|
-          Readline::HISTORY.to_a.last(@max_size).each do |line|
+        open(Setting[:histfile], 'w') do |file|
+          Readline::HISTORY.to_a.last(Setting[:histsize]).each do |line|
             file.puts line unless line.strip.empty?
           end
         end
       end
 
-      def to_s(size = @max_size)
+      def to_s(size = Setting[:histsize])
         n_entries = Readline::HISTORY.length < size ? Readline::HISTORY.length : size
 
         first = Readline::HISTORY.length - n_entries

data/lib/byebug/processors/command_processor.rb

@@ -33,7 +33,7 @@ module Byebug
       return filename if ['(irb)', '-e'].include?(filename)
 
       # For now we want resolved filenames
-      if Command.settings[:basename]
+      if Setting[:basename]
         File.basename(filename)
       else
         Pathname.new(filename).cleanpath.to_s
@@ -75,7 +75,7 @@ module Byebug
     protect :at_catchpoint
 
     def at_tracing(context, file, line)
-      if file != @last_file || line != @last_line || Command.settings[:linetrace_plus]
+      if file != @last_file || line != @last_line || Setting[:tracing_plus]
         @last_file, @last_line = file, line
         print "Tracing: #{CommandProcessor.canonic_file(file)}:#{line} " \
               "#{Byebug.line_at(file,line)}\n"
@@ -85,7 +85,7 @@ module Byebug
     protect :at_tracing
 
     def at_line(context, file, line)
-      Byebug.source_reload if Command.settings[:autoreload]
+      Byebug.source_reload if Setting[:autoreload]
       process_commands(context, file, line)
     end
     protect :at_line
@@ -117,7 +117,7 @@ module Byebug
         state = State.new(cmds, context, @display, file, @interface, line)
 
         # Change default when in irb or code included in command line
-        Command.settings[:autolist] = 0 if ['(irb)', '-e'].include?(file)
+        Setting[:autolist] = false if ['(irb)', '-e'].include?(file)
 
         # Bind commands to the current state.
         commands = cmds.map { |cmd| cmd.new(state) }
@@ -154,14 +154,14 @@ module Byebug
       def process_commands(context, file, line)
         state, commands = always_run(context, file, line, 1)
 
-        if Command.settings[:testing]
+        if Setting[:testing]
           Thread.current.thread_variable_set('state', state)
         else
           Thread.current.thread_variable_set('state', nil)
         end
 
         preloop(commands, context)
-        print state.location if Command.settings[:autolist] == 0
+        print state.location if Setting[:autolist] == 0
 
         while !state.proceed?
           input = @interface.command_queue.empty? ?

data/lib/byebug/setting.rb

@@ -0,0 +1,82 @@
+module Byebug
+  class Setting
+    attr_accessor :value
+
+    def initialize
+      @value = false
+    end
+
+    def self.settings
+      @settings ||= {}
+    end
+
+    def self.[](name)
+      settings[name].value
+    end
+
+    def self.[]=(name, value)
+      settings[name].value = value
+    end
+
+    def self.boolean?(name)
+      key = (name =~ /^no/ ? name[2..-1] : name).to_sym
+      settings[key].boolean?
+    end
+
+    def self.integer?(name)
+      settings[name.to_sym].integer?
+    end
+
+    def boolean?
+      [true, false].include?(value)
+    end
+
+    def integer?
+      integer = Integer(value) rescue nil
+      integer ? true : false
+    end
+
+    def self.exists?(name)
+      key = (name =~ /^no/ ? name[2..-1] : name).to_sym
+      boolean?(key) ? settings.include?(key) : settings.include?(name.to_sym)
+    end
+
+    def self.load
+      Dir.glob(File.expand_path('../settings/*.rb', __FILE__)).each do |file|
+        require file
+      end
+      Byebug.constants.grep(/[a-z]Setting/).map do |name|
+        setting = Byebug.const_get(name).new
+        settings[setting.to_sym] = setting
+      end
+    end
+
+    def self.find(shortcut)
+      abbr = shortcut =~ /^no/ ? shortcut[2..-1] : shortcut
+      matches = settings.select do |key, value|
+        value.boolean? ? key =~ /#{abbr}/ : key =~ /#{shortcut}/
+      end
+      matches.size == 1 ? matches.keys.first : nil
+    end
+
+    def self.format()
+      output = "List of settings supported in byebug:\n"
+      width = settings.keys.max_by(&:size).size
+      settings.values.each do |setting|
+        output << sprintf("%-#{width}s -- %s\n", setting.to_sym, setting.help)
+      end
+      output
+    end
+
+    def to_sym
+      name = self.class.name.gsub(/^Byebug::/, '').gsub(/Setting$/, '')
+      name.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+    end
+
+    def to_s
+      "#{to_sym} is #{value ? 'on' : 'off'}\n"
+    end
+  end
+
+  Setting.load
+end

data/lib/byebug/settings/autoeval.rb

@@ -0,0 +1,20 @@
+module Byebug
+  class AutoevalSetting < Setting
+    def initialize
+      EvalCommand.unknown = true
+    end
+
+    def help
+      'If true, byebug will evaluate every unrecognized command. If false, ' \
+      'need to use the `eval` command to evaluate stuff'
+    end
+
+    def value=(v)
+      EvalCommand.unknown = v
+    end
+
+    def value
+      EvalCommand.unknown
+    end
+  end
+end

data/lib/byebug/settings/autoirb.rb

@@ -0,0 +1,19 @@
+module Byebug
+  class AutoirbSetting < Setting
+    def initialize
+      IrbCommand.always_run = 0
+    end
+
+    def help
+      'Invoke IRB on every stop'
+    end
+
+    def value=(v)
+      IrbCommand.always_run = v ? 1 : 0
+    end
+
+    def value
+      IrbCommand.always_run == 1
+    end
+  end
+end

data/lib/byebug/settings/autolist.rb

@@ -0,0 +1,19 @@
+module Byebug
+  class AutolistSetting < Setting
+    def initialize
+      ListCommand.always_run = 1
+    end
+
+    def help
+      'If true, `list` command is run everytime byebug stops'
+    end
+
+    def value=(v)
+      ListCommand.always_run = v ? 1 : 0
+    end
+
+    def value
+      ListCommand.always_run == 1
+    end
+  end
+end

data/lib/byebug/settings/autoreload.rb

@@ -0,0 +1,11 @@
+module Byebug
+  class AutoreloadSetting < Setting
+    def initialize
+      @value = true
+    end
+
+    def help
+      'Reload source code when changed'
+    end
+  end
+end

data/lib/byebug/settings/autosave.rb

@@ -0,0 +1,11 @@
+module Byebug
+  class AutosaveSetting < Setting
+    def initialize
+      @value = true
+    end
+
+    def help
+      'If true, command history record is saved on exit'
+    end
+  end
+end

data/lib/byebug/settings/basename.rb

@@ -0,0 +1,7 @@
+module Byebug
+  class BasenameSetting < Setting
+    def help
+      'Filename display style.'
+    end
+  end
+end

data/lib/byebug/settings/callstyle.rb

@@ -0,0 +1,15 @@
+module Byebug
+  class CallstyleSetting < Setting
+    def initialize
+      @value = :long
+    end
+
+    def help
+      'Set how you want method call parameters to be displayed'
+    end
+
+    def to_s
+      "Frame display callstyle is :#{value}"
+    end
+  end
+end

data/lib/byebug/settings/forcestep.rb

@@ -0,0 +1,11 @@
+module Byebug
+  class ForcestepSetting < Setting
+    def help
+      'If true, next/step commands always move to a new line'
+    end
+
+    def print
+      "forced-stepping is #{self.getter}"
+    end
+  end
+end

data/lib/byebug/settings/fullpath.rb

@@ -0,0 +1,11 @@
+module Byebug
+  class FullpathSetting < Setting
+    def initialize
+      @value = true
+    end
+
+    def help
+      'Display full file names in frames'
+    end
+  end
+end

data/lib/byebug/settings/histfile.rb

@@ -0,0 +1,16 @@
+module Byebug
+  class HistfileSetting < Setting
+    def initialize
+      @value = File.expand_path("#{ENV['HOME']||'.'}/.byebug_hist")
+    end
+
+    def help
+      "Customize file where history is loaded from and saved to. By default, " \
+      "~/.byebug_hist"
+    end
+
+    def to_s
+      "The command history file is #{value}\n"
+    end
+  end
+end

data/lib/byebug/settings/histsize.rb

@@ -0,0 +1,18 @@
+module Byebug
+  class HistsizeSetting < Setting
+    DEFAULT = 256
+
+    def initialize
+      @value = DEFAULT
+    end
+
+    def help
+      "Customize maximum number of commands that can be stored in byebug's " \
+      "history record. By default, #{DEFAULT}"
+    end
+
+    def to_s
+      "Maximum size of byebug's command history is #{value}"
+    end
+  end
+end

data/lib/byebug/settings/linetrace.rb

@@ -0,0 +1,15 @@
+module Byebug
+  class LinetraceSetting < Setting
+    def help
+      'Enable line execution tracing'
+    end
+
+    def value=(v)
+      Byebug.tracing = v
+    end
+
+    def value
+      Byebug.tracing?
+    end
+  end
+end