ruby_jard 0.2.2 → 0.2.3

data/lib/ruby_jard/commands/step_command.rb

@@ -4,22 +4,27 @@ module RubyJard
   module Commands
     # Command used to Step into the execution of the current line.
     class StepCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Step into the execution of the current line'
 
       match 'step'
 
       banner <<-BANNER
-        Usage: step
-
-        Step into the execution of the current line
-
+        Usage: step [times]
         Examples:
           step
+          step 1
+          step 7
+
+        Step into the execution of the current line.
       BANNER
 
       def process
-        RubyJard::ControlFlow.dispatch(:step)
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:step, times: times.to_i)
       end
     end
   end

data/lib/ruby_jard/commands/step_out_command.rb

@@ -4,22 +4,27 @@ module RubyJard
   module Commands
     # Command used to Step into the execution of the current line.
     class StepOutCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Step out of current frame and move to the execution of the upper frame'
 
       match 'step-out'
 
       banner <<-BANNER
-        Usage: step-out
-
-        Step out of current frame and move to the execution of the upper frame
-
+        Usage: step-out [times]
         Examples:
           step-out
+          step-out 1
+          step-out 7
+
+        Step out of current frame and move to the execution of the upper frame.
       BANNER
 
       def process
-        RubyJard::ControlFlow.dispatch(:step_out)
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:step_out, times: times.to_i)
       end
     end
   end

data/lib/ruby_jard/commands/up_command.rb

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

data/lib/ruby_jard/commands/validation_helpers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Helpers to help validate commands
+    module ValidationHelpers
+      def validate_positive_integer!(input)
+        input = input.to_s.strip
+        unless input =~ /^[+\-\d]+$/
+          raise ::Pry::CommandError, '`argument is not an integer'
+        end
+
+        input = input.to_i
+        raise ::Pry::CommandError, 'argument must be positive' if input <= 0
+
+        input
+      end
+
+      def validate_non_negative_integer!(input)
+        input = input.to_s.strip
+        unless input =~ /^[+\-\d]+$/
+          raise ::Pry::CommandError, 'argument is not an integer'
+        end
+
+        input = input.to_i
+        raise ::Pry::CommandError, 'argument must be positive' if input < 0
+
+        input.to_i
+      end
+
+      def validate_present!(input)
+        input = input.to_s.strip
+        if input.empty?
+          raise ::Pry::CommandError, 'argument must be present'
+        end
+
+        input
+      end
+
+      def validate_range!(input, from, to)
+        if input < from || input > to
+          raise ::Pry::CommandError, "argument must be from #{from} to #{to}"
+        end
+
+        input
+      end
+    end
+  end
+end

data/lib/ruby_jard/config.rb

@@ -31,16 +31,20 @@ module RubyJard
       end
     end
 
-    attr_reader :color_scheme
-    attr_writer :color_scheme
+    attr_accessor :color_scheme, :alias_to_debugger, :layout, :enabled_screens
 
     CONFIG_FILE_NAME = '.jardrc'
     DEFAULTS = [
-      DEFAULT_COLOR_SCHEME = '256'
+      DEFAULT_COLOR_SCHEME = '256',
+      DEFAULT_ALIAS_TO_DEBUGGER = false,
+      DEFAULT_LAYOUT = nil # Pick layout automatically
     ].freeze
 
     def initialize
       @color_scheme = DEFAULT_COLOR_SCHEME
+      @alias_to_debugger = DEFAULT_ALIAS_TO_DEBUGGER
+      @layout = DEFAULT_LAYOUT
+      @enabled_screens = RubyJard::Screens.names
     end
 
     def config

data/lib/ruby_jard/console.rb

@@ -69,28 +69,16 @@ module RubyJard
       end
 
       def getch(input, timeout)
-        return input.getch(min: 0, time: timeout) if input.respond_to?(:getch)
-
-        raw!
-        disable_echo!
-        key =
-          begin
-            input.read_nonblock(255)
-          rescue IO::WaitReadable
-            io = IO.select([input], nil, nil, timeout)
-            if io.nil?
-              nil
-            else
-              retry
-            end
-          rescue IO::WaitWritable
-            nil
-          end
-
-        key
-      ensure
-        cooked!
-        enable_echo!
+        input.read_nonblock(255)
+      rescue IO::WaitReadable
+        io = IO.select([input], nil, nil, timeout)
+        if io.nil?
+          nil
+        else
+          retry
+        end
+      rescue IO::WaitWritable
+        nil
       end
 
       def raw!(output = STDOUT)

data/lib/ruby_jard/control_flow.rb

@@ -7,7 +7,8 @@ module RubyJard
   class ControlFlow
     THROW_KEYWORD = :jard_control_flow
     ALLOW_LIST = {
-      continue: [:times],           # lib/ruby_jard/commands/continue_command.rb
+      continue: [],                 # lib/ruby_jard/commands/continue_command.rb
+      exit: [],                     # lib/ruby_jard/commands/exit_command.rb
       frame: [:frame],              # lib/ruby_jard/commands/frame_command.rb
       up: [:times],                 # lib/ruby_jard/commands/up_command.rb
       down: [:times],               # lib/ruby_jard/commands/down_command.rb
@@ -15,8 +16,7 @@ module RubyJard
       step: [:times],               # lib/ruby_jard/commands/step_command.rb
       step_out: [:times],           # lib/ruby_jard/commands/step_out_command.rb
       key_binding: [:action],       # lib/ruby_jard/commands/step_command.rb
-      list: [],                     # lib/ruby_jard/commands/list_command.rb
-      color_scheme: [:color_scheme] # lib/ruby_jard/commands/colorscheme_command.rb
+      list: []                      # lib/ruby_jard/commands/list_command.rb
     }.freeze
 
     attr_reader :command, :arguments

data/lib/ruby_jard/decorators/color_decorator.rb

@@ -4,6 +4,12 @@ module RubyJard
   module Decorators
     ##
     # Manipulate and decorate color for texts.
+    # This class translate colors to corresponding escape sequences.
+    # Support 24-bit color (#51617d format) or 256 colors (https://jonasjacek.github.io/colors/)
+    # Example:
+    # - #fafafa => \e[38;2;250;250;250m
+    # - #aaa => \e[38;2;170;170;170m
+    # - 77 => \e[38;2;170;170;170m
     class ColorDecorator
       HEX_PATTERN_6 = /^#([A-Fa-f0-9]{2})([A-Fa-f0-9]{2})([A-Fa-f0-9]{2})$/i.freeze
       HEX_PATTERN_3 = /^#([A-Fa-f0-9]{1})([A-Fa-f0-9]{1})([A-Fa-f0-9]{1})$/i.freeze
@@ -35,22 +41,20 @@ module RubyJard
         "#{foreground}#{background}#{translate_styles(styles)}#{content}#{CSI_RESET}"
       end
 
-      private
-
       def translate_color(color, foreground)
-        if matches = HEX_PATTERN_6.match(color.to_s)
+        if (matches = HEX_PATTERN_6.match(color.to_s))
           red = matches[1].to_i(16)
           green = matches[2].to_i(16)
           blue = matches[3].to_i(16)
           sequence = foreground ? CSI_FOREGROUND_24BIT : CSI_BACKGROUND_24BIT
           format sequence, red, green, blue
-        elsif matches = HEX_PATTERN_3.match(color.to_s)
+        elsif (matches = HEX_PATTERN_3.match(color.to_s))
           red = (matches[1] * 2).to_i(16)
           green = (matches[2] * 2).to_i(16)
           blue = (matches[3] * 2).to_i(16)
           sequence = foreground ? CSI_FOREGROUND_24BIT : CSI_BACKGROUND_24BIT
           format sequence, red, green, blue
-        elsif matches = XTERM_NUMBER_PATTERN.match(color.to_s)
+        elsif (matches = XTERM_NUMBER_PATTERN.match(color.to_s))
           color = matches[1]
           sequence = foreground ? CSI_FOREGROUND_256 : CSI_BACKGROUND_256
           format sequence, color
@@ -59,6 +63,8 @@ module RubyJard
         end
       end
 
+      private
+
       def translate_styles(styles = [])
         styles.map { |key| STYLES_CSI_MAP[key] }.compact.join
       end

data/lib/ruby_jard/decorators/loc_decorator.rb

@@ -156,7 +156,7 @@ module RubyJard
           @opened << kind
           open_token(kind)
         end
-        alias begin_line begin_group
+        alias_method :begin_line, :begin_group
 
         def end_group(_kind)
           return unless @opened.pop

data/lib/ruby_jard/decorators/path_decorator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module RubyJard
   module Decorators
     ##
@@ -8,7 +10,7 @@ module RubyJard
     # location of the file.
     # If it's from the current working dir, strip the working dir.
     class PathDecorator
-      GEM_PATTERN = /(.*)\-(\d+\.\d+[\.\d]*[\.\d]*[\-\.\w]*)/i.freeze
+      GEM_PATTERN = /(.*)-(\d+\.\d+[.\d]*[.\d]*[-.\w]*)/i.freeze
       PATH_TYPES = [
         TYPE_UNKNOWN = :unknown,
         TYPE_PWD = :pwd,
@@ -28,14 +30,16 @@ module RubyJard
       end
 
       def decorate
-        if path.start_with?(Dir.pwd)
-          @type = TYPE_PWD
+        try_parse_gem_path
+        return if gem?
+
+        @type = TYPE_PWD
+        if @path.start_with?(Dir.pwd)
           @path = @path[Dir.pwd.length..-1]
+          @path = @path[1..-1] if @path.start_with?('/')
         else
-          decorate_gem_path
+          try_relative_path
         end
-
-        @path = @path[1..-1] if @path.start_with?('/')
       end
 
       def gem?
@@ -44,7 +48,7 @@ module RubyJard
 
       private
 
-      def decorate_gem_path
+      def try_parse_gem_path
         gem_paths.each do |gem_path|
           next unless path.start_with?(gem_path)
 
@@ -65,6 +69,15 @@ module RubyJard
         end
       end
 
+      def try_relative_path
+        relative_path = Pathname.new(@path).relative_path_from(Pathname.pwd).to_s
+        if relative_path.length < @path.length
+          @path = relative_path
+        end
+      rescue ArgumentError
+        # Fail to get relative path, ignore
+      end
+
       def gem_paths
         paths = []
 

data/lib/ruby_jard/decorators/source_decorator.rb

@@ -12,6 +12,8 @@ module RubyJard
         @file = file
         @lineno = lineno
         @window = window
+        @window_start = 0
+        @window_end = 0
         @codes = []
 
         decorate

data/lib/ruby_jard/frame.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # This class is a wrapper for Byebug::Frame. This class prevents direct
+  # access to Byebug's internal data structure, provides some more helpers
+  # and make Jard easier to test.
+  class Frame
+    attr_reader :pos
+
+    def initialize(context, pos)
+      @context = context
+      @pos = pos
+    end
+
+    def frame_file
+      @context.frame_file(@pos)
+    end
+
+    def frame_line
+      @context.frame_line(@pos)
+    end
+
+    def frame_location
+      frame_backtrace = @context.backtrace[@pos]
+      return nil if frame_backtrace.nil?
+
+      frame_backtrace.first
+    end
+
+    def frame_self
+      @context.frame_self(@pos)
+    end
+
+    def frame_class
+      @context.frame_class(@pos)
+    end
+
+    def frame_binding
+      @context.frame_binding(@pos)
+    end
+
+    def frame_method
+      @context.frame_method(@pos)
+    end
+
+    def c_frame?
+      frame_binding.nil?
+    end
+
+    def thread
+      @context.thread
+    end
+  end
+end

data/lib/ruby_jard/keys.rb

@@ -34,8 +34,6 @@ module RubyJard
     SHIFT_F10 = "\e[21;2~"
     SHIFT_F11 = "\e[23;2~"
     SHIFT_F12 = "\e[24;2~"
-
-    # rubocop:disable Layout/HashAlignment
     DEFAULT_KEY_BINDINGS = {
       F5       => (ACTION_LIST     = :list),
       F6       => (ACTION_UP       = :up),
@@ -45,6 +43,5 @@ module RubyJard
       F8       => (ACTION_NEXT     = :next),
       F9       => (ACTION_CONTINUE = :continue)
     }.freeze
-    # rubocop:enable Layout/HashAlignment
   end
 end

data/lib/ruby_jard/layout.rb

@@ -4,9 +4,15 @@ module RubyJard
   ##
   # Data object to store calculated layout
   class Layout
-    attr_accessor :template, :box_width, :box_height, :box_x, :box_y, :width, :height, :x, :y
+    attr_accessor :template, :parent_template,
+                  :box_width, :box_height, :box_x, :box_y,
+                  :width, :height, :x, :y
 
-    def initialize(template:, width: 0, height: 0, x: 0, y: 0, box_width:, box_height:, box_x:, box_y:)
+    def initialize(
+      template: nil, parent_template: nil,
+      width: 0, height: 0, x: 0, y: 0,
+      box_width: 0, box_height: 0, box_x: 0, box_y: 0
+    )
       @template = template
       @box_width = box_width
       @box_height = box_height
@@ -16,6 +22,7 @@ module RubyJard
       @height = height
       @x = x
       @y = y
+      @parent_template = parent_template
     end
   end
 end