ruby_jard 0.2.2 → 0.2.3

data/lib/ruby_jard/color_schemes/one_half_light_color_scheme.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class ColorSchemes
+    class OneHalfLightColorScheme < ColorScheme
+      # Shameless copy from https://github.com/sonph/onehalf/blob/master/vim/colors/onehalflight.vim
+      GRAY1      = '#eaeaea'
+      GRAY2      = '#d4d4d4'
+      GRAY3      = '#a0a1a7'
+      GRAY4      = '#a0a1a7'
+      GRAY5      = '#383a42'
+
+      WHITE      = '#fafafa'
+      RED        = '#e45649'
+      GREEN      = '#50a14f'
+      YELLOW     = '#c18401'
+      BLUE       = '#0184bc'
+      PURPLE     = '#a626a4'
+      CYAN       = '#0997b3'
+
+      BACKGROUND = WHITE
+      STYLES = {
+        background:            [GRAY5, BACKGROUND],
+        border:                [GRAY3, BACKGROUND],
+        title:                 [WHITE, GREEN],
+        title_highlighted:     [WHITE, YELLOW],
+        title_secondary:       [GRAY5, GRAY2],
+        title_background:      [GRAY3, BACKGROUND],
+        menu_mode:             [YELLOW, BACKGROUND],
+        menu_tips:             [GRAY4, BACKGROUND],
+        thread_id:             [GREEN, BACKGROUND],
+        thread_name:           [GRAY5, BACKGROUND],
+        thread_status_run:     [GREEN, BACKGROUND],
+        thread_status_sleep:   [GRAY4, BACKGROUND],
+        thread_status_other:   [GRAY4, BACKGROUND],
+        thread_location:       [GRAY5, BACKGROUND],
+        frame_id:              [GRAY4, BACKGROUND],
+        frame_id_highlighted:  [YELLOW, BACKGROUND],
+        frame_location:        [GRAY5, BACKGROUND],
+        variable_mark:         [GRAY4, BACKGROUND],
+        variable_mark_inline:  [YELLOW, BACKGROUND],
+        variable_size:         [GRAY5, BACKGROUND],
+        variable_inspection:   [GRAY5, BACKGROUND],
+        variable_assignment:   [GRAY5, BACKGROUND],
+        source_line_mark:      [YELLOW, BACKGROUND],
+        source_lineno:         [GRAY4, BACKGROUND],
+        keyword:               [PURPLE, BACKGROUND],
+        method:                [BLUE, BACKGROUND],
+        comment:               [GRAY4, BACKGROUND],
+        literal:               [YELLOW, BACKGROUND],
+        string:                [GREEN, BACKGROUND],
+        local_variable:        [RED, BACKGROUND],
+        instance_variable:     [RED, BACKGROUND],
+        constant:              [YELLOW, BACKGROUND],
+        normal_token:          [GRAY5, BACKGROUND],
+        object:                [YELLOW, BACKGROUND]
+      }.freeze
+    end
+  end
+end
+
+RubyJard::ColorSchemes.add_color_scheme('one-half-light', RubyJard::ColorSchemes::OneHalfLightColorScheme)

data/lib/ruby_jard/column.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RubyJard
+  ##
+  # This class is an object to contain information of a column in a data drow display on a screen
   class Column
     # Only break at breakable word
     # | this_is_a <endline> |
@@ -12,7 +14,7 @@ module RubyJard
     WORD_WRAP_BREAK_WORD = :break_word
     extend Forwardable
 
-    attr_accessor :spans, :content_length, :width, :word_wrap
+    attr_accessor :spans, :content_length, :width, :content_width, :word_wrap
 
     def initialize(spans: [], word_wrap: WORD_WRAP_NORMAL)
       @spans = spans

data/lib/ruby_jard/commands/continue_command.rb

@@ -11,11 +11,10 @@ module RubyJard
 
       banner <<-BANNER
       Usage: continue
-
-      Continue program execution. The program will stop at the next breakpoint, or run until it finishes.
-
       Examples:
         continue
+
+      Continue program execution. The program will stop at the next breakpoint, or run until it finishes.
       BANNER
 
       def process

data/lib/ruby_jard/commands/down_command.rb

@@ -4,22 +4,26 @@ module RubyJard
   module Commands
     # Command used to explore stacktrace.
     class DownCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Explore the frames bellow the current stopped line in the backtrace'
 
       match 'down'
 
       banner <<-BANNER
-      Usage: down
-
-      Explore the frames bellow the current stopped line in the backtrace.
-
+      Usage: down [-h] [times]
       Examples:
         down
+        down 1
+        down 7
+
+      Explore the frames bellow the current stopped line in the backtrace. All the C frames will be skipped.
       BANNER
 
       def process
-        RubyJard::ControlFlow.dispatch(:down)
+        times = validate_positive_integer!(args.first || 1)
+        RubyJard::ControlFlow.dispatch(:down, times: times.to_i)
       end
     end
   end

data/lib/ruby_jard/commands/exit_command.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to exit program execution.
+    class ExitCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Exit program execution.'
+
+      match 'exit'
+
+      banner <<-BANNER
+      Usage: exit
+      Examples:
+        exit
+
+      Exit program execution. The program will stop at the next breakpoint, or run until it finishes.
+      BANNER
+
+      def process
+        RubyJard::ControlFlow.dispatch(:exit)
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::ExitCommand)

data/lib/ruby_jard/commands/frame_command.rb

@@ -4,6 +4,8 @@ module RubyJard
   module Commands
     # Command used to explore stacktrace.
     class FrameCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Explore to any frame of current stacktrace.'
 
@@ -18,17 +20,16 @@ module RubyJard
         frame 4 # Jump to frame 4 in the backtrace
       BANNER
 
+      def initialize(context = {})
+        super(context)
+        @session = context[:session] || RubyJard.current_session
+      end
+
       def process
-        frame = args.first
-        raise Pry::CommandError, 'Frame ID is required' if frame.nil?
-        raise Pry::CommandError, 'Frame ID must be numeric' unless frame =~ /^\d+$/i
-
-        frame = frame.to_i
-        if frame >= RubyJard.current_session.backtrace.length || frame < 0
-          raise Pry::CommandError, "Frame #{frame} does not exist!"
-        else
-          RubyJard::ControlFlow.dispatch(:frame, frame: args.first)
-        end
+        frame = validate_present!(args.first)
+        frame = validate_non_negative_integer!(frame)
+        frame = validate_range!(frame, 0, @session.current_backtrace.length - 1)
+        RubyJard::ControlFlow.dispatch(:frame, frame: frame)
       end
     end
   end

data/lib/ruby_jard/commands/jard/color_scheme_command.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class ColorSchemeCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Control the color scheme used in Jard'
+
+      match 'color-scheme'
+
+      banner <<-BANNER
+        Usage: color-scheme -l
+               color-scheme [scheme-name]
+      BANNER
+
+      def initialize(context = {})
+        super(context)
+        @color_schemes = context[:color_schemes] || RubyJard::ColorSchemes
+        @config = context[:config] || RubyJard.config
+      end
+
+      def options(opt)
+        opt.on :l, :list, 'List all available color schemes'
+      end
+
+      def process
+        if opts[:l]
+          if @color_schemes.names.empty?
+            pry_instance.output.puts 'No loaded color schemes'
+          else
+            pry_instance.output.puts @color_schemes.names.join("\n")
+          end
+        else
+          color_scheme = args.first.to_s.strip
+          if color_scheme.empty?
+            raise Pry::CommandError,
+                  'You must provide a color scheme name. Please use `color-scheme -l` to list all color schemes.'
+          end
+
+          if @color_schemes[color_scheme].nil?
+            raise Pry::CommandError,
+                  "Color scheme `#{color_scheme}` not found. Please use `color-scheme -l` to list all color schemes."
+          end
+
+          @config.color_scheme = color_scheme
+          RubyJard::ControlFlow.dispatch(:list)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/jard/hide_command.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Show a screen
+    class HideCommand < Pry::ClassCommand
+      description 'Hide a screen'
+      banner <<-BANNER
+        Usage: jard hide [-h] [screen]
+      BANNER
+      match 'hide'
+
+      def initialize(context = {})
+        super(context)
+
+        @screens = context[:screens] || RubyJard::Screens
+        @config = context[:config] || RubyJard.config
+      end
+
+      def process
+        screen = args.first.to_s.strip
+
+        if screen.empty?
+          raise Pry::CommandError,
+                "Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        unless @screens.names.include?(screen)
+          raise Pry::CommandError,
+                "Screen `#{screen}` not found. Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        @config.enabled_screens.delete(screen)
+
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/jard/output_command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class OutputCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Show all current program output'
+
+      match 'output'
+
+      banner <<-BANNER
+        Usage: output
+      BANNER
+
+      def self.output_storage
+        RubyJard::ScreenManager.instance.output_storage
+      end
+
+      def process
+        pry_instance.pager.open(force_open: true, pager_start_at_the_end: true) do |pager|
+          self.class.output_storage.rewind
+          pager.write self.class.output_storage.read_nonblock(2048) until self.class.output_storage.eof?
+        end
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/jard/show_command.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Show a screen
+    class ShowCommand < Pry::ClassCommand
+      description 'Show a screen'
+      banner <<-BANNER
+        Usage: jard show [-h] [screen]
+      BANNER
+      match 'show'
+
+      def initialize(context = {})
+        super(context)
+
+        @screens = context[:screens] || RubyJard::Screens
+        @config = context[:config] || RubyJard.config
+      end
+
+      def process
+        screen = args.first.to_s.strip
+
+        if screen.empty?
+          raise Pry::CommandError,
+                "Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        unless @screens.names.include?(screen)
+          raise Pry::CommandError,
+                "Screen `#{screen}` not found. Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        @config.enabled_screens << screen
+        @config.enabled_screens.uniq!
+
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/jard_command.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'ruby_jard/commands/jard/show_command'
+require 'ruby_jard/commands/jard/hide_command'
+require 'ruby_jard/commands/jard/color_scheme_command'
+require 'ruby_jard/commands/jard/output_command'
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class JardCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Show all current program output'
+
+      match 'jard'
+
+      banner <<-BANNER
+        Usage: jard [-h] [sub commands]
+      BANNER
+
+      SUB_COMMANDS = {
+        'show' => RubyJard::Commands::ShowCommand,
+        'hide' => RubyJard::Commands::HideCommand,
+        'color-scheme' => RubyJard::Commands::ColorSchemeCommand,
+        'output' => RubyJard::Commands::OutputCommand
+      }.freeze
+
+      def subcommands(cmd)
+        SUB_COMMANDS.each do |command_name, sub_command|
+          cmd.command command_name do |opt|
+            opt.description sub_command.description
+            opt.run do |_, arguments|
+              @ran_sub_command = true
+              sub_command.new(context).send(:call_safely, *arguments)
+            end
+          end
+        end
+      end
+
+      def process
+        return if @ran_sub_command
+        return if ['-h', '--help'].include?(args.first) || SUB_COMMANDS.keys.include?(args.first)
+
+        pry_instance.output.puts help
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::JardCommand)

data/lib/ruby_jard/commands/list_command.rb

@@ -10,12 +10,13 @@ module RubyJard
       match 'list'
 
       banner <<-BANNER
-      Usage:
-        - list
-        - l
+      Usage: list
+      Examples:
+        list
+        l
+        whereami
 
       Refresh the current UI.
-
       BANNER
 
       def process

data/lib/ruby_jard/commands/next_command.rb

@@ -4,22 +4,27 @@ module RubyJard
   module Commands
     # Command used to continue program execution to the next line.
     class NextCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Next into the execution of the current line'
 
       match 'next'
 
       banner <<-BANNER
-      Usage: next
-
-      Continue program execution to the next line. If the current frame reaches the end, it continue the next line of upper frame.
-
+      Usage: next [times]
       Examples:
         next
+        next 1
+        next 7
+
+      Continue program execution to the next line. If the current frame reaches the end, it continue the next line of upper frame.
       BANNER
 
       def process
-        RubyJard::ControlFlow.dispatch(:next)
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:next, times: times.to_i)
       end
     end
   end