byebug 3.5.1 → 4.0.0

data/lib/byebug/runner.rb

@@ -1,95 +1,143 @@
-require 'slop'
-require 'ostruct'
+require 'optparse'
 require 'English'
 require 'byebug/core'
-require 'byebug/options'
 
 module Byebug
   #
   # Responsible for starting the debugger when started from the command line.
   #
   class Runner
-    BYEBUG_SCRIPT = File.expand_path('../../../../bin/byebug')
-    IGNORED_FILES << BYEBUG_SCRIPT
-
     #
-    # Debug a script only if syntax checks okay.
+    # Special working modes that don't actually start the debugger.
     #
-    def debug_program(options)
-      unless File.executable?(Byebug.debugged_program)
-        output = `ruby -c "#{Byebug.debugged_program}" 2>&1`
-        if $CHILD_STATUS.exitstatus != 0
-          Byebug.puts output
-          exit $CHILD_STATUS.exitstatus
-        end
-      end
+    attr_accessor :help, :version, :remote
 
-      status = Byebug.debug_load(Byebug.debugged_program, options[:stop])
-      Byebug.puts "#{status}\n#{status.backtrace}" if status
+    #
+    # @param stop [Boolean] Whether the runner should stop right before
+    # starting the program.
+    #
+    # @param quit [Boolean] Whether the runner should quit right after
+    # finishing the program.
+    #
+    def initialize(stop = true, quit = true)
+      @stop, @quit = stop, quit
     end
 
-    include MiscUtils
     #
-    # Extracts path to program to be debugged from ARGV
+    # Usage banner.
     #
-    # Used for restarts.
-    #
-    def debugged_program_from_argv
-      abort_with_err('You must specify a program to debug...') if ARGV.empty?
+    def banner
+      <<-EOB.gsub(/^ {8}/, '')
 
-      prog_script_try = which(ARGV.first)
-      if prog_script_try == which('ruby')
-        ARGV.shift
-        return which(ARGV.first)
-      end
+          byebug #{Byebug::VERSION}
+
+          Usage: byebug [options] <script.rb> -- <script.rb parameters>
+
+      EOB
+    end
+
+    #
+    # Debugs a script only if syntax checks okay.
+    #
+    def debug_program
+      check_syntax($PROGRAM_NAME)
 
-      prog_script_try
+      status = Byebug.debug_load($PROGRAM_NAME, @stop)
+      Byebug.puts "#{status}\n#{status.backtrace}" if status
     end
 
-    def abort_with_err(msg)
-      Byebug.errmsg(msg)
-      abort
+    #
+    # Exits and outputs error message if syntax of the given program is invalid.
+    #
+    def check_syntax(program_name)
+      output = `ruby -c "#{program_name}" 2>&1`
+      return unless $CHILD_STATUS.exitstatus != 0
+
+      Byebug.errmsg(output)
+      exit($CHILD_STATUS.exitstatus)
     end
 
     #
     # Starts byebug to debug a program
     #
     def run
-      opts = Byebug::Options.parse
-
-      return Byebug.puts("\n  Running byebug #{VERSION}\n") if opts[:version]
-      return Byebug.puts("#{opts.help}\n") if opts[:help]
+      prepare_options.order!($ARGV)
 
-      if opts[:remote]
-        port, host = opts[:remote].pop.to_i, opts[:remote].pop || 'localhost'
-        Byebug.puts "Connecting to byebug server #{host}:#{port}..."
-        Byebug.start_client(host, port)
+      if version
+        Byebug.puts("\n  Running byebug #{version}\n")
         return
       end
 
-      Byebug.debugged_program = debugged_program_from_argv
-      abort_with_err("The script doesn't exist") unless Byebug.debugged_program
-
-      # Set up trace hook for byebug
-      Byebug.start
-
-      # load initrc script (e.g. .byebugrc)
-      Byebug.run_init_script(StringIO.new) if opts[:rc]
+      if help
+        Byebug.puts("#{help}\n")
+        return
+      end
 
-      # Post Mortem mode status
-      Byebug::Setting[:post_mortem] = opts[:'post-mortem']
+      if remote
+        Byebug.start_client(*remote)
+        return
+      end
 
-      # Line Tracing Status
-      Byebug::Setting[:linetrace] = opts[:trace]
+      Byebug.setup_cmd_line_args
 
       loop do
-        debug_program(opts)
+        debug_program
 
-        break if opts[:quit]
+        break if @quit
 
         processor = Byebug::ControlCommandProcessor.new
         processor.process_commands
       end
     end
+
+    def prepare_options
+      OptionParser.new(banner, 25) do |opts|
+        opts.banner = banner
+
+        opts.on '-d', '--debug', 'Set $DEBUG=true' do
+          $DEBUG = true
+        end
+
+        opts.on('-I', '--include list', 'Add to paths to $LOAD_PATH') do |list|
+          $LOAD_PATH.push(list.split(':')).flatten!
+        end
+
+        opts.on '-m', '--[no-]post-mortem', 'Use post-mortem mode' do |v|
+          Setting[:post_mortem] = v
+        end
+
+        opts.on '-q', '--[no-]quit', 'Quit when script finishes' do |v|
+          @quit = v
+        end
+
+        opts.on '-x', '--[no-]rc', 'Run byebug initialization file' do |v|
+          Byebug.run_init_script if v
+        end
+
+        opts.on '-s', '--[no-]stop', 'Stop when script is loaded' do |v|
+          @stop = v
+        end
+
+        opts.on '-r', '--require file', 'Require library before script' do |lib|
+          require lib
+        end
+
+        opts.on '-R', '--remote [host:]port', 'Remote debug [host:]port' do |p|
+          self.remote = Byebug.parse_host_and_port(p)
+        end
+
+        opts.on '-t', '--[no-]trace', 'Turn on line tracing' do |v|
+          Setting[:linetrace] = v
+        end
+
+        opts.on '-v', '--version', 'Print program version' do
+          self.version = VERSION
+        end
+
+        opts.on('-h', '--help', 'Display this message') do
+          self.help = opts.help
+        end
+      end
+    end
   end
 end

data/lib/byebug/setting.rb

@@ -1,3 +1,5 @@
+require 'byebug/helper'
+
 module Byebug
   #
   # Parent class for all byebug settings.
@@ -11,27 +13,6 @@ module Byebug
       @value = self.class::DEFAULT
     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
@@ -42,68 +23,64 @@ module Byebug
       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)
+    def help
+      "\n  #{banner}.\n\n"
     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
+    def to_sym
+      name = self.class.name.gsub(/^Byebug::/, '').gsub(/Setting$/, '')
+      name.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
     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
+    def to_s
+      "#{to_sym} is #{value ? 'on' : 'off'}\n"
     end
 
-    def self.help_all
-      output = "  List of settings supported in byebug:\n  --\n"
-      width = settings.keys.max_by(&:size).size
-      settings.values.each do |sett|
-        output << format("  %-#{width}s -- %s\n", sett.to_sym, sett.banner)
+    class << self
+      include StringFunctions
+
+      def settings
+        @settings ||= {}
       end
-      output + "\n"
-    end
 
-    def self.help(cmd, subcmd)
-      if subcmd
-        camelized = subcmd.split('_').map { |w| w.capitalize }.join
-        setting = Byebug.const_get("#{camelized}Setting").new
-        <<-EOH.gsub(/^ {8}/, '')
+      def [](name)
+        settings[name].value
+      end
 
-          #{cmd} #{setting.to_sym} <value>
+      def []=(name, value)
+        settings[name].value = value
+      end
 
-          #{setting.banner}.
+      def 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.values.first : nil
+      end
 
-        EOH
-      else
-        command = Byebug.const_get("#{cmd.capitalize}Command")
-        command.description + help_all
+      def help_all
+        output = "  List of settings supported in byebug:\n  --\n"
+        width = settings.keys.max_by(&:size).size
+        settings.values.each do |sett|
+          output << format("  %-#{width}s -- %s\n", sett.to_sym, sett.banner)
+        end
+        output + "\n"
       end
-    end
 
-    def help
-      "\n  #{banner}.\n\n"
-    end
+      def help(cmd, subcmd)
+        unless subcmd
+          command = Byebug.const_get("#{cmd.capitalize}Command")
+          return command.description + help_all
+        end
 
-    def to_sym
-      name = self.class.name.gsub(/^Byebug::/, '').gsub(/Setting$/, '')
-      name.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
-    end
+        setting = find(subcmd)
+        prettify <<-EOS
+          #{cmd} #{setting.to_sym} <value>
 
-    def to_s
-      "#{to_sym} is #{value ? 'on' : 'off'}\n"
+          #{setting.banner}.
+        EOS
+      end
     end
   end
-
-  Setting.load
 end

data/lib/byebug/settings/autoeval.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting for automatic evaluation of unknown commands.

data/lib/byebug/settings/autoirb.rb

@@ -1,3 +1,6 @@
+require 'byebug/setting'
+require 'byebug/commands/irb'
+
 module Byebug
   #
   # Setting for automatically invoking IRB on every stop.

data/lib/byebug/settings/autolist.rb

@@ -1,3 +1,6 @@
+require 'byebug/setting'
+require 'byebug/commands/list'
+
 module Byebug
   #
   # Setting for automatically listing source code on every stop.

data/lib/byebug/settings/autosave.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting for automatically saving previously entered commands to history

data/lib/byebug/settings/basename.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Command to display short paths in file names.

data/lib/byebug/settings/callstyle.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to customize the verbosity level for stack frames.

data/lib/byebug/settings/fullpath.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to display full paths in backtraces.

data/lib/byebug/settings/histfile.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to customize the file where byebug's history is saved.

data/lib/byebug/settings/histsize.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to customize the number of byebug commands to be saved in history.

data/lib/byebug/settings/linetrace.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to enable/disable linetracing.

data/lib/byebug/settings/listsize.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to customize the number of source code lines to be displayed every

data/lib/byebug/settings/post_mortem.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to enable/disable post_mortem mode, i.e., a debugger prompt after
@@ -26,9 +28,12 @@ module Byebug
   # prompt back to the user before program termination.
   #
   def self.handle_post_mortem
+    return unless Byebug.raised_exception
+
     context = Byebug.raised_exception.__bb_context
-    file    = Byebug.raised_exception.__bb_file
-    line    = Byebug.raised_exception.__bb_line
+    file = Byebug.raised_exception.__bb_file
+    line = Byebug.raised_exception.__bb_line
+
     Byebug.handler.at_line(context, file, line)
   end
 

data/lib/byebug/settings/stack_on_error.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to enable/disable the display of backtraces when evaluations raise

data/lib/byebug/settings/verbose.rb

@@ -1,3 +1,5 @@
+require 'byebug/setting'
+
 module Byebug
   #
   # Setting to show verbose output about TracePoint API events.