ruby_jard 0.2.3 → 0.3.0

data/lib/ruby_jard/color_schemes/one_half_light_color_scheme.rb

@@ -20,40 +20,27 @@ module RubyJard
 
       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]
+        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

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/frame_command.rb

@@ -22,13 +22,13 @@ module RubyJard
 
       def initialize(context = {})
         super(context)
-        @session = context[:session] || RubyJard.current_session
+        @current_backtrace = (context[:session] || RubyJard::Session).current_backtrace
       end
 
       def process
         frame = validate_present!(args.first)
         frame = validate_non_negative_integer!(frame)
-        frame = validate_range!(frame, 0, @session.current_backtrace.length - 1)
+        frame = validate_range!(frame, 0, @current_backtrace.map(&:virtual_pos).compact.max)
         RubyJard::ControlFlow.dispatch(:frame, frame: frame)
       end
     end

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

@@ -4,6 +4,8 @@ module RubyJard
   module Commands
     # Command used to explore stacktrace.
     class ColorSchemeCommand < Pry::ClassCommand
+      include RubyJard::Commands::ColorHelpers
+
       group 'RubyJard'
       description 'Control the color scheme used in Jard'
 
@@ -29,24 +31,44 @@ module RubyJard
           if @color_schemes.names.empty?
             pry_instance.output.puts 'No loaded color schemes'
           else
-            pry_instance.output.puts @color_schemes.names.join("\n")
+            print_color_schemes
           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.'
+                  'You must provide a color scheme name. '\
+                  "Please use `#{highlight('jard 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."
+                  "Color scheme `#{secondary(color_scheme)}` not found. "\
+                  "Please use `#{highlight('jard color-scheme -l')}` to list all color schemes."
           end
 
           @config.color_scheme = color_scheme
           RubyJard::ControlFlow.dispatch(:list)
         end
       end
+
+      private
+
+      def print_color_schemes
+        pry_instance.output.puts
+        pry_instance.output.puts highlight("#{@color_schemes.names.length} available color schemes")
+        pry_instance.output.puts
+        padding = @color_schemes.names.map(&:length).max
+        @color_schemes.names.each do |name|
+          scheme = @color_schemes[name]
+          decorator = RubyJard::Decorators::ColorDecorator.new(scheme.new)
+          pallete = scheme.const_get(:STYLES).keys.map do |style|
+            decorator.decorate(style, '⬤ ')
+          end.join(' ')
+          pry_instance.output.puts "#{name.ljust(padding)} #{pallete}"
+          pry_instance.output.puts
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Control filter, included and excluded
+    class FilterCommand < Pry::ClassCommand
+      include RubyJard::Commands::ColorHelpers
+
+      group 'RubyJard'
+      description 'Filter to keep only relevant location when you debugging'
+
+      match 'filter'
+
+      banner <<-BANNER
+        Usage:
+          jard filter
+          jard filter [everything, gems, application, source_tree]
+          jard filter [include, exclude] pattern
+          jard filter clear
+
+        Ruby Jard has a strong filtering system. This system consists of a filter mode, included list, and excluded list. Filter mode is how Ruby Jard reacts to control flow commands. See https://rubyjard.org/docs/guides/filter for more information.
+
+        Examples:
+
+          jard filter # Show filter status
+
+          jard filter application # Switch to application mode
+          jard filter gems # Switch to gems mode
+          jard filter everything # Switch to everything mode
+          jard filter source_tree # Switch to source tree mode
+
+          jard filter include sidekiq # Include sidekiq pattern
+          jard filter include aws-*
+          jard filter include aws-* active* action* # Multiple patterns separated by <space>
+          jard filter include lib/**/*.erb
+          jard filter include ~/home/lib/**/*.rb
+
+          jard filter exclude sidekiq # exclude sidekiq pattern
+          jard filter exclude aws-*
+          jard filter exclude aws-* active* action* # Multiple patterns separated by <space>
+          jard filter exclude lib/**/*.erb
+          jard filter exclude ~/home/lib/**/*.rb
+
+          jard filter clear # Clear filter
+      BANNER
+
+      def initialize(*args)
+        super(*args)
+        @filters = RubyJard::PathFilter::FILTERS
+        @config = context[:config] || RubyJard.config
+      end
+
+      def process
+        if args.empty?
+          print_current_filter
+          return
+        end
+
+        sub_command = args.shift.to_sym
+
+        case sub_command
+        when *@filters
+          @config.filter = sub_command
+          RubyJard::ControlFlow.dispatch(:list)
+        when :include
+          handle_included
+        when :exclude
+          handle_excluded
+        when :clear
+          handle_clear
+        else
+          raise Pry::CommandError,
+                "Invalid filter '#{secondary(sub_command)}'."\
+                "Please type `#{highlight('jard filter --help')}` for more information"
+        end
+      end
+
+      private
+
+      def print_current_filter
+        pry_instance.output.puts
+        pry_instance.output.puts highlight('Filter mode')
+        pry_instance.output.puts "  #{@config.filter}"
+        pry_instance.output.puts highlight("Included (#{@config.filter_included.length})")
+        @config.filter_included.each do |included|
+          pry_instance.output.puts "  +#{included}"
+        end
+
+        pry_instance.output.puts highlight("Excluded (#{@config.filter_excluded.length})")
+        @config.filter_excluded.each do |excluded|
+          pry_instance.output.puts "  -#{excluded}"
+        end
+        pry_instance.output.puts
+        pry_instance.output.puts "Please type `#{highlight('jard filter --help')}` for more information"
+        pry_instance.output.puts
+      end
+
+      def handle_included
+        if args.empty?
+          raise Pry::CommandError,
+                'Wrong number of arguments! '\
+                "Please type `#{highlight('jard filter --help')}` for more information"
+        end
+        filters = args.map(&:strip)
+        @config.filter_included.append(*filters)
+        @config.filter_included.uniq!
+        filters.each do |filter|
+          @config.filter_excluded.delete(filter) if @config.filter_excluded.include?(filter)
+        end
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+
+      def handle_excluded
+        if args.empty?
+          raise Pry::CommandError,
+                'Wrong number of arguments!'\
+                "Please type `#{highlight('jard filter --help')}` for more information"
+        end
+        filters = args.map(&:strip)
+        @config.filter_excluded.append(*filters)
+        @config.filter_excluded.uniq!
+        filters.each do |filter|
+          @config.filter_included.delete(filter) if @config.filter_included.include?(filter)
+        end
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+
+      def handle_clear
+        @config.filter_excluded.clear
+        @config.filter_included.clear
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end

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

@@ -13,14 +13,22 @@ module RubyJard
         Usage: output
       BANNER
 
-      def self.output_storage
-        RubyJard::ScreenManager.instance.output_storage
+      def initialize(*args)
+        super(*args)
+        @session = (context[:session] || RubyJard::Session)
       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?
+        pry_instance.pager.open(
+          force_open: true,
+          pager_start_at_the_end: true,
+          prompt: 'Program output'
+        ) do |pager|
+          @session.output_buffer.each do |string|
+            string.each do |s|
+              pager.write(s)
+            end
+          end
         end
       end
     end

data/lib/ruby_jard/commands/jard_command.rb

@@ -4,6 +4,7 @@ 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'
+require 'ruby_jard/commands/jard/filter_command'
 
 module RubyJard
   module Commands
@@ -22,7 +23,8 @@ module RubyJard
         'show' => RubyJard::Commands::ShowCommand,
         'hide' => RubyJard::Commands::HideCommand,
         'color-scheme' => RubyJard::Commands::ColorSchemeCommand,
-        'output' => RubyJard::Commands::OutputCommand
+        'output' => RubyJard::Commands::OutputCommand,
+        'filter' => RubyJard::Commands::FilterCommand
       }.freeze
 
       def subcommands(cmd)

data/lib/ruby_jard/config.rb

@@ -31,13 +31,17 @@ module RubyJard
       end
     end
 
-    attr_accessor :color_scheme, :alias_to_debugger, :layout, :enabled_screens
+    attr_accessor :color_scheme, :alias_to_debugger, :layout, :enabled_screens,
+                  :filter, :filter_included, :filter_excluded
 
     CONFIG_FILE_NAME = '.jardrc'
     DEFAULTS = [
       DEFAULT_COLOR_SCHEME = '256',
       DEFAULT_ALIAS_TO_DEBUGGER = false,
-      DEFAULT_LAYOUT = nil # Pick layout automatically
+      DEFAULT_LAYOUT = nil, # Pick layout automatically
+      DEFAULT_FILTER = RubyJard::PathFilter::FILTER_APPLICATION,
+      DEFAULT_FILTER_INCLUDED = [].freeze,
+      DEFAULT_FILTER_EXCLUDED = [].freeze
     ].freeze
 
     def initialize
@@ -45,6 +49,9 @@ module RubyJard
       @alias_to_debugger = DEFAULT_ALIAS_TO_DEBUGGER
       @layout = DEFAULT_LAYOUT
       @enabled_screens = RubyJard::Screens.names
+      @filter = DEFAULT_FILTER
+      @filter_included = DEFAULT_FILTER_INCLUDED.dup
+      @filter_excluded = DEFAULT_FILTER_EXCLUDED.dup
     end
 
     def config

data/lib/ruby_jard/decorators/array_decorator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Decorators
+    ##
+    # Decorate Array data structure, supports singleline and multiline form.
+    class ArrayDecorator
+      def initialize(generic_decorator)
+        @generic_decorator = generic_decorator
+        @attributes_decorator = RubyJard::Decorators::AttributesDecorator.new(generic_decorator)
+      end
+
+      def match?(variable)
+        RubyJard::Reflection.call_is_a?(variable, Array)
+      end
+
+      def decorate_singleline(variable, line_limit:, depth: 0)
+        spans = []
+        spans << RubyJard::Span.new(content: '[', styles: :text_primary)
+        spans += @attributes_decorator.inline_values(
+          variable.each_with_index, total: variable.length, line_limit: line_limit - 2, depth: depth + 1
+        )
+        spans << RubyJard::Span.new(content: ']', styles: :text_primary)
+
+        spans
+      end
+
+      def decorate_multiline(variable, first_line_limit:, lines:, line_limit:, depth: 0)
+        if variable.length > lines * 2
+          return do_decorate_multiline(variable, lines: lines, line_limit: line_limit, depth: depth)
+        end
+
+        singleline = decorate_singleline(variable, line_limit: first_line_limit, depth: depth)
+        if (singleline.map(&:content_length).sum < line_limit && same_type?(variable, lines)) || variable.length <= 1
+          [singleline]
+        else
+          do_decorate_multiline(variable, lines: lines, line_limit: line_limit, depth: depth)
+        end
+      end
+
+      private
+
+      def same_type?(variable, sample)
+        variable.first(sample).map { |item| RubyJard::Reflection.call_class(item) }.uniq.length <= 1
+      end
+
+      def do_decorate_multiline(variable, lines:, line_limit:, depth: 0)
+        spans = [[RubyJard::Span.new(content: '[', styles: :text_primary)]]
+
+        item_count = 0
+        variable.each_with_index do |value, index|
+          spans << @attributes_decorator.value(value, line_limit: line_limit, depth: depth + 1)
+
+          item_count += 1
+          break if index >= lines - 2
+        end
+
+        spans << last_line(variable.length, item_count)
+      end
+
+      def last_line(total, item_count)
+        if total > item_count
+          [
+            RubyJard::Span.new(
+              content: "▸ #{total - item_count} more...",
+              margin_left: 2, styles: :text_dim
+            ),
+            RubyJard::Span.new(
+              content: ']',
+              styles: :text_primary
+            )
+          ]
+        else
+          [RubyJard::Span.new(content: ']', styles: :text_primary)]
+        end
+      end
+    end
+  end
+end