ruby_jard 0.1.0 → 0.3.0

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,54 @@
+# frozen_string_literal: true
+
+require 'ruby_jard/color_scheme'
+
+module RubyJard
+  ##
+  # Color scheme registry.
+  class ColorSchemes
+    class << self
+      extend Forwardable
+      def_delegators :instance, :add_color_scheme, :[], :get, :names, :each, :length
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    def initialize
+      @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.to_s.strip]
+    end
+    alias_method :get, :[]
+
+    def names
+      @color_scheme_registry.keys.sort.dup
+    end
+
+    def length
+      @color_scheme_registry.length
+    end
+
+    def each(&block)
+      @color_scheme_registry.each(&block)
+    end
+  end
+end
+
+require 'ruby_jard/color_schemes/deep_space_color_scheme'
+require 'ruby_jard/color_schemes/256_color_scheme'
+require 'ruby_jard/color_schemes/256_light_color_scheme'
+require 'ruby_jard/color_schemes/gruvbox_color_scheme'
+require 'ruby_jard/color_schemes/one_half_dark_color_scheme'
+require 'ruby_jard/color_schemes/one_half_light_color_scheme'

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class 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      = '237'
+      GRAY3      = '239'
+      GRAY4      = '245'
+      GRAY5      = '249'
+      WHITE      = '15'
+      RED        = '167'
+      GREEN      = '42'
+      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_secondary:   [WHITE, GRAY3],
+        title_background:  [GRAY2, GRAY2],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY4, BACKGROUND],
+        text_highlighted:  [BLUE, BACKGROUND],
+        text_special:      [ORANGE, BACKGROUND],
+        text_selected:     [GREEN, BACKGROUND],
+        keyword:           [BLUE, BACKGROUND],
+        method:            [YELLOW, BACKGROUND],
+        comment:           [GRAY4, BACKGROUND],
+        literal:           [RED, BACKGROUND],
+        string:            [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/256_light_color_scheme.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class ColorSchemes
+    class X256LightColorScheme < ColorScheme
+      # Shameless copy from https://github.com/sonph/onehalf/blob/master/vim/colors/onehalflight.vim
+      GRAY1      = '237'
+      GRAY2      = '252'
+      GRAY3      = '247'
+      GRAY4      = '247'
+      GRAY5      = '237'
+
+      WHITE      = '231'
+      RED        = '167'
+      GREEN      = '22'
+      YELLOW     = '136'
+      BLUE       = '31'
+      PURPLE     = '127'
+      CYAN       = '31'
+
+      BACKGROUND = WHITE
+      STYLES = {
+        background:        [GRAY5, BACKGROUND],
+        border:            [GRAY3, BACKGROUND],
+        title:             [WHITE, GREEN],
+        title_secondary:   [GRAY5, GRAY2],
+        title_background:  [GRAY3, BACKGROUND],
+        source_line_mark:  [YELLOW, BACKGROUND],
+        source_lineno:     [GRAY4, BACKGROUND],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY5, BACKGROUND],
+        text_highlighted:  [BLUE, BACKGROUND],
+        text_special:      [RED, BACKGROUND],
+        text_selected:     [GREEN, 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('256-light', RubyJard::ColorSchemes::X256LightColorScheme)

data/lib/ruby_jard/color_schemes/deep_space_color_scheme.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class 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      = '#80b57b'
+      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_secondary:   [WHITE, GRAY3],
+        title_background:  [GRAY2, GRAY2],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY4, BACKGROUND],
+        text_highlighted:  [BLUE, BACKGROUND],
+        text_special:      [ORANGE, BACKGROUND],
+        text_selected:     [GREEN, BACKGROUND],
+        keyword:           [BLUE, BACKGROUND],
+        method:            [YELLOW, BACKGROUND],
+        comment:           [GRAY4, BACKGROUND],
+        literal:           [RED, BACKGROUND],
+        string:            [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/color_schemes/gruvbox_color_scheme.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class ColorSchemes
+    class GruvboxColorScheme < ColorScheme
+      # Shameless copy from https://github.com/morhetz/gruvbox
+      GRAY1      = '#282828'
+      GRAY2      = '#3c3836'
+      GRAY3      = '#504945'
+      GRAY4      = '#d5c4a1'
+      GRAY5      = '#ebdbb2'
+      WHITE      = '#f9f5d7'
+      RED        = '#fb4934'
+      GREEN      = '#b8bb26'
+      YELLOW     = '#fabd2f'
+      BLUE       = '#83a598'
+      PURPLE     = '#d3869b'
+      CYAN       = '#8ec07c'
+      ORANGE     = '#fe8019'
+
+      BACKGROUND = GRAY1
+      STYLES = {
+        background:        [WHITE, BACKGROUND],
+        border:            [GRAY3, BACKGROUND],
+        title:             [GRAY2, BLUE],
+        title_secondary:   [WHITE, GRAY3],
+        title_background:  [GRAY2, GRAY2],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY4, BACKGROUND],
+        text_highlighted:  [BLUE, BACKGROUND],
+        text_special:      [ORANGE, BACKGROUND],
+        text_selected:     [GREEN, BACKGROUND],
+        keyword:           [BLUE, BACKGROUND],
+        method:            [YELLOW, BACKGROUND],
+        comment:           [GRAY4, BACKGROUND],
+        literal:           [RED, BACKGROUND],
+        string:            [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('gruvbox', RubyJard::ColorSchemes::GruvboxColorScheme)

data/lib/ruby_jard/color_schemes/one_half_dark_color_scheme.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class ColorSchemes
+    class OneHalfDarkColorScheme < ColorScheme
+      # Shameless copy from https://github.com/sonph/onehalf/blob/master/vim/colors/onehalfdark.vim
+      GRAY1      = '#282c34'
+      GRAY2      = '#313640'
+      GRAY3      = '#5c6370'
+      GRAY4      = '#dcdfe4'
+      GRAY5      = '#dcdfe4'
+      WHITE      = '#dcdfe4'
+      RED        = '#e06c75'
+      GREEN      = '#98c379'
+      YELLOW     = '#e5c07b'
+      BLUE       = '#61afef'
+      PURPLE     = '#c678dd'
+      CYAN       = '#56b6c2'
+
+      BACKGROUND = GRAY1
+      STYLES = {
+        background:        [WHITE, BACKGROUND],
+        border:            [GRAY3, BACKGROUND],
+        title:             [GRAY2, GREEN],
+        title_secondary:   [WHITE, GRAY3],
+        title_background:  [GRAY2, GRAY2],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY4, BACKGROUND],
+        text_highlighted:  [GREEN, BACKGROUND],
+        text_special:      [GREEN, BACKGROUND],
+        text_selected:     [YELLOW, 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-dark', RubyJard::ColorSchemes::OneHalfDarkColorScheme)

data/lib/ruby_jard/color_schemes/one_half_light_color_scheme.rb

@@ -0,0 +1,49 @@
+# 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],
+        text_primary:      [GRAY5, BACKGROUND],
+        text_dim:          [GRAY4, BACKGROUND],
+        text_highlighted:  [BLUE, BACKGROUND],
+        text_special:      [RED, BACKGROUND],
+        text_selected:     [GREEN, 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

@@ -0,0 +1,26 @@
+# 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> |
+    # | 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 :spans, :content_length, :width, :content_width, :word_wrap
+
+    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/color_helpers.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Helper to dedocrate command output
+    module ColorHelpers
+      def special(content)
+        color_decorator.decorate(:text_special, content)
+      end
+
+      def secondary(content)
+        color_decorator.decorate(:text_primary, content)
+      end
+
+      def highlight(content)
+        color_decorator.decorate(:text_highlighted, content)
+      end
+
+      def pick_color_scheme
+        (
+          RubyJard::ColorSchemes[RubyJard.config.color_scheme] ||
+          RubyJard::ColorSchemes[RubyJard::Config::DEFAULT_COLOR_SCHEME]
+        ).new
+      end
+
+      def color_decorator
+        @color_decorator ||= RubyJard::Decorators::ColorDecorator.new(pick_color_scheme)
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/continue_command.rb

@@ -3,9 +3,6 @@
 module RubyJard
   module Commands
     # Command used to continue program execution.
-    # Data attached in the throw:
-    # * command: constant symbol (:continue)
-    # * pry: current context pry instance
     class ContinueCommand < Pry::ClassCommand
       group 'RubyJard'
       description 'Continue program execution.'
@@ -14,20 +11,18 @@ 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
-        throw :control_flow, command: :continue, pry: pry_instance
-      ensure
-        Byebug.stop if Byebug.stoppable?
+        RubyJard::ControlFlow.dispatch(:continue)
       end
     end
   end
 end
 
 Pry::Commands.add_command(RubyJard::Commands::ContinueCommand)
+Pry::Commands.alias_command 'c', 'continue'