ruby_jard 0.2.0 → 0.2.1

data/javascripts/main.js

@@ -0,0 +1 @@
+console.log('This would be the main JS file.');

data/lib/ruby_jard.rb

@@ -41,8 +41,10 @@ require 'ruby_jard/version'
 module RubyJard
   class Error < StandardError; end
 
+  DEFAULT_COLOR_SCHEME = '256'
   DEFAULT_LAYOUT_TEMPLATES = [
-    RubyJard::Layouts::WideLayout
+    RubyJard::Layouts::WideLayout,
+    RubyJard::Layouts::NarrowLayout
   ].freeze
 
   def self.current_session
@@ -95,20 +97,3 @@ module Kernel
     RubyJard.current_session.attach
   end
 end
-
-##
-# Globally configure Byebug. Byebug doesn't allow configuration by instance.
-# So, I have no choice.
-# TODO: Byebug autoloaded configuration may override those values.
-Byebug::Setting[:autolist] = false
-Byebug::Setting[:autoirb] = false
-Byebug::Setting[:autopry] = false
-Byebug::Context.processor = RubyJard::ReplProcessor
-# Exclude all files in Ruby Jard source code from the stacktrace.
-Byebug::Context.ignored_files = Byebug::Context.all_files + Dir.glob(
-  File.join(
-    File.expand_path(__dir__, '../lib'),
-    '**',
-    '*.rb'
-  )
-)

data/lib/ruby_jard/box_drawer.rb

@@ -45,10 +45,10 @@ module RubyJard
       [BOTTOM_RIGHT, BOTTOM_LEFT] => '┴'
     }.freeze
 
-    def initialize(output:, screens:)
+    def initialize(output:, screens:, color_scheme:)
       @output = output
       @screens = screens
-      @color_decorator = RubyJard::Decorators::ColorDecorator.new
+      @color_decorator = RubyJard::Decorators::ColorDecorator.new(color_scheme)
     end
 
     def draw
@@ -63,17 +63,26 @@ module RubyJard
     def draw_basic_lines
       # Exclude the corners
       @screens.each do |screen|
-        RubyJard::Console.move_to(@output, screen.x + 1, screen.y)
-        @output.print HORIZONTAL_LINE * (screen.width - 2)
+        RubyJard::Console.move_to(
+          @output,
+          screen.layout.box_x + 1,
+          screen.layout.box_y
+        )
+        @output.print colorize_border(HORIZONTAL_LINE * (screen.layout.box_width - 2))
 
-        RubyJard::Console.move_to(@output, screen.x + 1, screen.y + screen.height - 1)
-        @output.print HORIZONTAL_LINE * (screen.width - 2)
+        RubyJard::Console.move_to(
+          @output,
+          screen.layout.box_x + 1,
+          screen.layout.box_y + screen.layout.box_height - 1
+        )
+        @output.print colorize_border(HORIZONTAL_LINE * (screen.layout.box_width - 2))
 
-        (screen.y + 1..screen.y + screen.height - 2).each do |moving_y|
-          RubyJard::Console.move_to(@output, screen.x, moving_y)
-          @output.print VERTICAL_LINE
-          RubyJard::Console.move_to(@output, screen.x + screen.width - 1, moving_y)
-          @output.print VERTICAL_LINE
+        (screen.layout.box_y + 1..screen.layout.box_y + screen.layout.box_height - 2).each do |moving_y|
+          RubyJard::Console.move_to(@output, screen.layout.box_x, moving_y)
+          @output.print colorize_border(VERTICAL_LINE)
+
+          RubyJard::Console.move_to(@output, screen.layout.box_x + screen.layout.box_width - 1, moving_y)
+          @output.print colorize_border(VERTICAL_LINE)
         end
       end
     end
@@ -85,12 +94,12 @@ module RubyJard
 
           case ids.length
           when 1
-            @output.print NORMALS_CORNERS[ids.first]
+            @output.print colorize_border(NORMALS_CORNERS[ids.first])
           when 2
             ids = ids.sort
-            @output.print OVERLAPPED_CORNERS[ids]
+            @output.print colorize_border(OVERLAPPED_CORNERS[ids])
           else
-            @output.print CROSS_CORNER
+            @output.print colorize_border(CROSS_CORNER)
           end
         end
       end
@@ -99,20 +108,53 @@ module RubyJard
     def draw_titles
       @screens.each do |screen|
         next unless screen.respond_to?(:title)
-        RubyJard::Console.move_to(@output, screen.x + 2, screen.y)
-        @output.print ' '
-        @output.print @color_decorator.decorate(screen.title, :bright_yellow, :bold)
-        @output.print ' '
+
+        RubyJard::Console.move_to(@output, screen.layout.box_x + 1, screen.layout.box_y)
+        total_length = 0
+        title_parts = Array(screen.title)
+        title_parts.each_with_index do |title_part, index|
+          if index == 0
+            @output.print @color_decorator.decorate(:title, " #{title_part} ")
+          else
+            @output.print @color_decorator.decorate(:title_secondary, " #{title_part} ")
+          end
+          total_length += title_part.length + 2
+        end
+        title_background = screen.layout.box_width - total_length - 2
+        @output.print @color_decorator.decorate(
+          :title_background,
+          ' ' * (title_background < 0 ? 0 : title_background)
+        )
       end
     end
 
     def calculate_corners
       corners = {}
       @screens.each do |screen|
-        mark_corner(corners, screen.x, screen.y, TOP_LEFT)
-        mark_corner(corners, screen.x + screen.width - 1, screen.y, TOP_RIGHT)
-        mark_corner(corners, screen.x + screen.width - 1, screen.y + screen.height - 1, BOTTOM_RIGHT)
-        mark_corner(corners, screen.x, screen.y + screen.height - 1, BOTTOM_LEFT)
+        mark_corner(
+          corners,
+          screen.layout.box_x,
+          screen.layout.box_y,
+          TOP_LEFT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x + screen.layout.box_width - 1,
+          screen.layout.box_y,
+          TOP_RIGHT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x + screen.layout.box_width - 1,
+          screen.layout.box_y + screen.layout.box_height - 1,
+          BOTTOM_RIGHT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x,
+          screen.layout.box_y + screen.layout.box_height - 1,
+          BOTTOM_LEFT
+        )
       end
       corners
     end
@@ -122,5 +164,9 @@ module RubyJard
       corners[x][y] ||= []
       corners[x][y] << id unless corners[x][y].include?(id)
     end
+
+    def colorize_border(content)
+      @color_decorator.decorate(:border, content)
+    end
   end
 end

data/lib/ruby_jard/color_scheme.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # Abstract class of all color scheme.
+  class ColorScheme
+    def initialize(styles: self.class.const_get(:STYLES))
+      @styles = {}
+      styles.each do |element, element_styles|
+        update(element, element_styles)
+      end
+    end
+
+    ##
+    # Fetch the styles for a particular element defined in the scheme.
+    # This method returns an array of two or more elements:
+    # - First element is foreground color
+    # - Second element is background color
+    # - The rest is decorating items, such as underline, italic
+    def styles_for(element)
+      @styles[element].dup
+    end
+
+    def update(element, styles)
+      @styles[element] = styles
+    end
+  end
+end

data/lib/ruby_jard/color_schemes.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # Color scheme registry.
+  module ColorSchemes
+    class << self
+      def color_scheme_registry
+        @color_scheme_registry ||= {}
+      end
+
+      def add_color_scheme(name, color_scheme_class)
+        unless color_scheme_class < RubyJard::ColorScheme
+          raise RubyJard::Error, "#{color_scheme_class} must implement, and inherit from #{RubyJard::ColorScheme}"
+        end
+
+        color_scheme_registry[name] = color_scheme_class
+      end
+
+      def [](name)
+        color_scheme_registry[name]
+      end
+      alias get []
+    end
+  end
+end

data/lib/ruby_jard/color_schemes/256_color_scheme.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module ColorSchemes
+    class X256ColorScheme < ColorScheme
+      # Basic 256 colors that nearly all terminal supports. Just for backward-compatibility
+      # https://en.wikipedia.org/wiki/ANSI_escape_code
+      GRAY1      = '234'
+      GRAY2      = '238'
+      GRAY3      = '241'
+      GRAY4      = '245'
+      GRAY5      = '249'
+      WHITE      = '15'
+      RED        = '167'
+      GREEN      = '40'
+      DARK_GREEN = '34'
+      YELLOW     = '184'
+      BLUE       = '75'
+      PURPLE     = '177'
+      CYAN       = '50'
+      ORANGE     = '208'
+      PINK       = '206'
+
+      BACKGROUND = nil
+      STYLES = {
+        background:           [WHITE, BACKGROUND],
+        border:               [GRAY2, BACKGROUND],
+        title:                [GRAY1, BLUE],
+        title_highlighted:    [GRAY1, ORANGE],
+        title_secondary:      [WHITE, GRAY3],
+        title_background:     [WHITE, GRAY2],
+        control_buttons:      [GRAY4, BACKGROUND],
+        thread_id:            [BLUE, BACKGROUND],
+        thread_name:          [WHITE, 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: [GREEN, BACKGROUND],
+        frame_location:       [GRAY5, BACKGROUND],
+        variable_mark:        [GRAY4, BACKGROUND],
+        variable_mark_inline: [GREEN, BACKGROUND],
+        variable_size:        [GRAY5, BACKGROUND],
+        variable_inspection:  [GRAY4, BACKGROUND],
+        variable_assignment:  [WHITE, BACKGROUND],
+        source_line_mark:     [GREEN, BACKGROUND],
+        source_lineno:        [GRAY4, BACKGROUND],
+        keyword:              [BLUE, BACKGROUND],
+        method:               [YELLOW, BACKGROUND],
+        comment:              [GRAY4, BACKGROUND],
+        literal:              [RED, BACKGROUND],
+        string:               [DARK_GREEN, BACKGROUND],
+        local_variable:       [PURPLE, BACKGROUND],
+        instance_variable:    [PURPLE, BACKGROUND],
+        constant:             [BLUE, BACKGROUND],
+        normal_token:         [GRAY5, BACKGROUND],
+        object:               [CYAN, BACKGROUND]
+      }.freeze
+    end
+  end
+end
+
+RubyJard::ColorSchemes.add_color_scheme('256', RubyJard::ColorSchemes::X256ColorScheme)

data/lib/ruby_jard/color_schemes/deep_space_color_scheme.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module ColorSchemes
+    class DeepSpaceColorScheme < ColorScheme
+      # Shameless copy from https://github.com/tyrannicaltoucan/vim-deep-space/blob/master/colors/deep-space.vim
+      GRAY1      = '#1b202a'
+      GRAY2      = '#232936'
+      GRAY3      = '#323c4d'
+      GRAY4      = '#51617d'
+      GRAY5      = '#9aa7bd'
+      WHITE      = '#fff'
+      RED        = '#b15e7c'
+      GREEN      = '#96f08d'
+      DARK_GREEN = '#709d6c'
+      YELLOW     = '#e8cb6b'
+      BLUE       = '#78b5ff'
+      PURPLE     = '#b08aed'
+      CYAN       = '#56adb7'
+      ORANGE     = '#f28d5e'
+      PINK       = '#c47ebd'
+
+      BACKGROUND = GRAY1
+      STYLES = {
+        background:           [WHITE, BACKGROUND],
+        border:               [GRAY3, BACKGROUND],
+        title:                [GRAY2, BLUE],
+        title_highlighted:    [GRAY2, ORANGE],
+        title_secondary:      [WHITE, GRAY3],
+        title_background:     [WHITE, GRAY2],
+        control_buttons:      [GRAY4, BACKGROUND],
+        thread_id:            [BLUE, BACKGROUND],
+        thread_name:          [WHITE, 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: [GREEN, BACKGROUND],
+        frame_location:       [GRAY5, BACKGROUND],
+        variable_mark:        [GRAY4, BACKGROUND],
+        variable_mark_inline: [GREEN, BACKGROUND],
+        variable_size:        [GRAY5, BACKGROUND],
+        variable_inspection:  [GRAY4, BACKGROUND],
+        variable_assignment:  [WHITE, BACKGROUND],
+        source_line_mark:     [GREEN, BACKGROUND],
+        source_lineno:        [GRAY4, BACKGROUND],
+        keyword:              [BLUE, BACKGROUND],
+        method:               [YELLOW, BACKGROUND],
+        comment:              [GRAY4, BACKGROUND],
+        literal:              [RED, BACKGROUND],
+        string:               [DARK_GREEN, BACKGROUND],
+        local_variable:       [PURPLE, BACKGROUND],
+        instance_variable:    [PURPLE, BACKGROUND],
+        constant:             [BLUE, BACKGROUND],
+        normal_token:         [GRAY5, BACKGROUND],
+        object:               [CYAN, BACKGROUND]
+      }.freeze
+    end
+  end
+end
+
+RubyJard::ColorSchemes.add_color_scheme('deep-space', RubyJard::ColorSchemes::DeepSpaceColorScheme)

data/lib/ruby_jard/column.rb

@@ -2,17 +2,23 @@
 
 module RubyJard
   class Column
+    # Only break at breakable word
+    # | this_is_a <endline> |
+    # | really_long_content |
+    WORD_WRAP_NORMAL = :normal
+    # Break the word, and move the rest to the next line
+    # | this_is_a really_lon|
+    # | g_content           |
+    WORD_WRAP_BREAK_WORD = :break_word
     extend Forwardable
 
-    attr_accessor :column_template, :spans, :content_length, :width
+    attr_accessor :spans, :content_length, :width, :word_wrap
 
-    def_delegators :@column_template, :margin_left, :margin_right
-
-    def initialize(column_template:)
-      @column_template = column_template
-      @spans = []
+    def initialize(spans: [], word_wrap: WORD_WRAP_NORMAL)
+      @spans = spans
       @width = 0
       @content_length = 0
+      @word_wrap = word_wrap
     end
   end
 end

data/lib/ruby_jard/commands/continue_command.rb

@@ -26,3 +26,4 @@ module RubyJard
 end
 
 Pry::Commands.add_command(RubyJard::Commands::ContinueCommand)
+Pry::Commands.alias_command 'c', 'continue'

data/lib/ruby_jard/commands/list_command.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class ListCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Refresh the current UI'
+
+      match 'list'
+
+      banner <<-BANNER
+      Usage:
+        - list
+        - l
+
+      Refresh the current UI.
+
+      BANNER
+
+      def process
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::ListCommand)
+Pry::Commands.alias_command 'l', 'list'