byebug 4.0.5 → 5.0.0

data/lib/byebug/commands/pp.rb

@@ -0,0 +1,41 @@
+require 'English'
+require 'pp'
+require 'byebug/command'
+require 'byebug/helpers/eval'
+
+module Byebug
+  #
+  # Evaluation and pretty printing from byebug's prompt.
+  #
+  class PpCommand < Command
+    include Helpers::EvalHelper
+
+    self.allow_in_control = true
+
+    def regexp
+      /^\s* pp \s+/x
+    end
+
+    def execute
+      out = StringIO.new
+      run_with_binding do |b|
+        if Setting[:stack_on_error]
+          PP.pp(bb_eval(@match.post_match, b), out)
+        else
+          PP.pp(bb_warning_eval(@match.post_match, b), out)
+        end
+      end
+      puts out.string
+    rescue
+      out.puts $ERROR_INFO.message
+    end
+
+    def description
+      <<-EOD
+        pp <expression>
+
+        Evaluates <expression> and pretty-prints its value.
+      EOD
+    end
+  end
+end

data/lib/byebug/commands/pry.rb

@@ -23,16 +23,12 @@ module Byebug
       get_binding.pry
     end
 
-    class << self
-      def names
-        %w(pry)
-      end
+    def description
+      <<-EOD
+        pry
 
-      def description
-        prettify <<-EOD
-          pry  Starts a Pry session.
-        EOD
-      end
+        Starts a Pry session.
+      EOD
     end
   end
 end

data/lib/byebug/commands/ps.rb

@@ -0,0 +1,44 @@
+require 'English'
+require 'pp'
+require 'byebug/command'
+require 'byebug/helpers/eval'
+
+module Byebug
+  #
+  # Evaluation, pretty printing, columnizing and sorting from byebug's prompt
+  #
+  class PsCommand < Command
+    include Helpers::EvalHelper
+    include Columnize
+
+    self.allow_in_control = true
+
+    def regexp
+      /^\s* ps \s+/x
+    end
+
+    def execute
+      out = StringIO.new
+      run_with_binding do |b|
+        res = eval_with_setting(b, @match.post_match, Setting[:stack_on_error])
+
+        if res.is_a?(Array)
+          puts "#{columnize(res.map(&:to_s).sort!, Setting[:width])}"
+        else
+          PP.pp(res, out)
+          puts out.string
+        end
+      end
+    rescue
+      out.puts $ERROR_INFO.message
+    end
+
+    def description
+      <<-EOD
+        ps <expression>
+
+        Evaluates <expression>, an array, sort and columnize its value.
+      EOD
+    end
+  end
+end

data/lib/byebug/commands/putl.rb

@@ -0,0 +1,43 @@
+require 'pp'
+require 'byebug/command'
+require 'byebug/helpers/eval'
+
+module Byebug
+  #
+  # Evaluation, pretty printing and columnizing from byebug's prompt.
+  #
+  class PutlCommand < Command
+    include Helpers::EvalHelper
+    include Columnize
+
+    self.allow_in_control = true
+
+    def regexp
+      /^\s* putl (?:\s+ (.+))? \s*$/x
+    end
+
+    def execute
+      out = StringIO.new
+      run_with_binding do |b|
+        res = eval_with_setting(b, @match[1], Setting[:stack_on_error])
+
+        if res.is_a?(Array)
+          puts "#{columnize(res.map(&:to_s), Setting[:width])}"
+        else
+          PP.pp(res, out)
+          puts out.string
+        end
+      end
+    rescue
+      out.puts $ERROR_INFO.message
+    end
+
+    def description
+      <<-EOD
+        putl <expression>
+
+        Evaluates <expression>, an array, and columnize its value.
+      EOD
+    end
+  end
+end

data/lib/byebug/commands/quit.rb

@@ -19,20 +19,16 @@ module Byebug
       exit! # exit -> exit!: No graceful way to stop...
     end
 
-    class << self
-      def names
-        %w(quit)
-      end
+    def description
+      <<-EOD
+        q[uit] [!|unconditionally]
 
-      def description
-        prettify <<-EOD
-          q[uit] [!|unconditionally] Exits from byebug.
+        Exits from byebug.
 
-          Normally we prompt before exiting. However if the parameter
-          "unconditionally" is given or command is suffixed with !, we exit
-          without asking further questions.
-        EOD
-      end
+        Normally we prompt before exiting. However if the parameter
+        "unconditionally" is given or command is suffixed with !, we exit
+        without asking further questions.
+      EOD
     end
   end
 end

data/lib/byebug/commands/restart.rb

@@ -29,19 +29,13 @@ module Byebug
       exec(cmd)
     end
 
-    class << self
-      def names
-        %w(restart)
-      end
-
-      def description
-        prettify <<-EOD
-          restart|R [args]
+    def description
+      <<-EOD
+        restart|R [args]
 
-          Restart the program. This is a re-exec - all byebug state
-          is lost. If command arguments are passed those are used.
-        EOD
-      end
+        Restart the program. This is a re-exec - all byebug state
+        is lost. If command arguments are passed those are used.
+      EOD
     end
   end
 end

data/lib/byebug/commands/save.rb

@@ -1,45 +1,18 @@
 require 'byebug/command'
 
 module Byebug
-  #
-  # Default file where commands are saved
-  #
-  RESTART_FILE = '.byebug-save'
-
   #
   # Save current settings to use them in another debug session.
   #
   class SaveCommand < Command
     self.allow_in_control = true
 
-    def save_breakpoints(file)
-      Byebug.breakpoints.each do |b|
-        file.puts "break #{b.source}:#{b.pos}#{" if #{b.expr}" if b.expr}"
-      end
-    end
-
-    def save_catchpoints(file)
-      Byebug.catchpoints.keys.each do |c|
-        file.puts "catch #{c}"
-      end
-    end
-
-    def save_displays(file)
-      @state.display.each { |d| file.puts "display #{d[1]}" if d[0] }
-    end
-
-    def save_settings(file)
-      %w(autoeval autoirb autolist basename).each do |setting|
-        file.puts "set #{setting} #{Setting[setting.to_sym]}"
-      end
-    end
-
     def regexp
       /^\s* sa(?:ve)? (?:\s+(\S+))? \s*$/x
     end
 
     def execute
-      file = File.open(@match[1] || RESTART_FILE, 'w')
+      file = File.open(@match[1] || Setting[:savefile], 'w')
 
       save_breakpoints(file)
       save_catchpoints(file)
@@ -50,21 +23,39 @@ module Byebug
       file.close
     end
 
-    class << self
-      def names
-        %w(save)
+    def description
+      <<-EOD
+        save[ FILE]
+
+        Saves current byebug state to FILE as a script file. This includes
+        breakpoints, catchpoints, display expressions and some settings. If no
+        filename is given, we will fabricate one.
+
+        Use the "source" command in another debug session to restore them.
+      EOD
+    end
+
+    private
+
+    def save_breakpoints(file)
+      Byebug.breakpoints.each do |b|
+        file.puts "break #{b.source}:#{b.pos}#{" if #{b.expr}" if b.expr}"
       end
+    end
 
-      def description
-        prettify <<-EOD
-          save[ FILE]
+    def save_catchpoints(file)
+      Byebug.catchpoints.keys.each do |c|
+        file.puts "catch #{c}"
+      end
+    end
 
-          Saves current byebug state to FILE as a script file. This includes
-          breakpoints, catchpoints, display expressions and some settings. If
-          no filename is given, we will fabricate one.
+    def save_displays(file)
+      @state.display.each { |d| file.puts "display #{d[1]}" if d[0] }
+    end
 
-          Use the "source" command in another debug session to restore them.
-        EOD
+    def save_settings(file)
+      %w(autoeval autoirb autolist basename).each do |setting|
+        file.puts "set #{setting} #{Setting[setting.to_sym]}"
       end
     end
   end

data/lib/byebug/commands/set.rb

@@ -1,10 +1,13 @@
 require 'byebug/command'
+require 'byebug/helpers/parse'
 
 module Byebug
   #
   # Change byebug settings.
   #
   class SetCommand < Command
+    include Helpers::ParseHelper
+
     self.allow_in_control = true
 
     def regexp
@@ -12,14 +15,15 @@ module Byebug
     end
 
     def execute
-      key, value = @match[:setting], @match[:value]
-      return puts(SetCommand.help) if key.nil? && value.nil?
+      key = @match[:setting]
+      value = @match[:value]
+      return puts(help) if key.nil? && value.nil?
 
       setting = Setting.find(key)
       return errmsg(pr('set.errors.unknown_setting', key: key)) unless setting
 
       if !setting.boolean? && value.nil?
-        value, err = nil, pr('set.errors.must_specify_value', key: key)
+        err = pr('set.errors.must_specify_value', key: key)
       elsif setting.boolean?
         value, err = get_onoff(value, key =~ /^no/ ? false : true)
       elsif setting.integer?
@@ -45,28 +49,22 @@ module Byebug
       end
     end
 
-    class << self
-      def names
-        %w(set)
-      end
-
-      def description
-        prettify <<-EOD
-          set <setting> <value>
+    def help
+      description + Setting.help_all
+    end
 
-          Modifies parts of byebug environment.
+    def description
+      <<-EOD
+        set <setting> <value>
 
-          Boolean values take "on", "off", "true", "false", "1" or "0". If you
-          don't specify a value, the boolean setting will be enabled.
-          Conversely, you can use "set no<setting> to disable them.
+        Modifies parts of byebug environment.
 
-          You can see these environment settings with the "show" command.
-        EOD
-      end
+        Boolean values take "on", "off", "true", "false", "1" or "0". If you
+        don't specify a value, the boolean setting will be enabled. Conversely,
+        you can use "set no<setting>" to disable them.
 
-      def help(subcmd = nil)
-        Setting.help('set', subcmd)
-      end
+        You can see these environment settings with the "show" command.
+      EOD
     end
   end
 end

data/lib/byebug/commands/show.rb

@@ -13,7 +13,7 @@ module Byebug
 
     def execute
       key = @match[:setting]
-      return puts(self.class.help) if key.nil?
+      return puts(help) unless key
 
       setting = Setting.find(key)
       return errmsg(pr('show.errors.unknown_setting', key: key)) unless setting
@@ -21,23 +21,17 @@ module Byebug
       puts Setting.settings[setting.to_sym]
     end
 
-    class << self
-      def names
-        %w(show)
-      end
-
-      def description
-        prettify <<-EOD
-          show <setting> <value>
+    def help
+      description + Setting.help_all
+    end
 
-          Generic command for showing byebug settings. You can change them with
-          the "set" command.
-        EOD
-      end
+    def description
+      <<-EOD
+        show <setting> <value>
 
-      def help(subcmd = nil)
-        Setting.help('show', subcmd)
-      end
+        Generic command for showing byebug settings. You can change them with
+        the "set" command.
+      EOD
     end
   end
 end

data/lib/byebug/commands/source.rb

@@ -14,7 +14,7 @@ module Byebug
     end
 
     def execute
-      return puts(self.class.help) if self.class.names.include?(@match[0])
+      return puts(help) unless @match[1]
 
       unless @state && @state.interface
         return errmsg(pr('source.errors.not_available'))
@@ -28,18 +28,12 @@ module Byebug
       @state.interface.read_file(file)
     end
 
-    class << self
-      def names
-        %w(source)
-      end
-
-      def description
-        prettify <<-EOD
-          source <file>
+    def description
+      <<-EOD
+        source <file>
 
-          Executes file <file> containing byebug commands.
-        EOD
-      end
+        Executes file <file> containing byebug commands.
+      EOD
     end
   end
 end