ruby_jard 0.1.0 → 0.3.0

data/lib/ruby_jard/commands/list_command.rb

@@ -0,0 +1,31 @@
+# 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
+      Examples:
+        list
+        l
+        whereami
+
+      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'
+Pry::Commands.alias_command 'whereami', 'list'

data/lib/ruby_jard/commands/next_command.rb

@@ -3,29 +3,32 @@
 module RubyJard
   module Commands
     # Command used to continue program execution to the next line.
-    # Data attached in the throw:
-    # * command: constant symbol (:next)
-    # * pry: current context pry instance
     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
-        throw :control_flow, command: :next, pry: pry_instance
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:next, times: times.to_i)
       end
     end
   end
 end
 
 Pry::Commands.add_command(RubyJard::Commands::NextCommand)
+Pry::Commands.alias_command 'n', 'next'

data/lib/ruby_jard/commands/step_command.rb

@@ -3,29 +3,32 @@
 module RubyJard
   module Commands
     # Command used to Step into the execution of the current line.
-    # Data attached in the throw:
-    # * command: constant symbol (:step)
-    # * pry: current context pry instance
     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
-        throw :control_flow, command: :step, pry: pry_instance
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:step, times: times.to_i)
       end
     end
   end
 end
 
 Pry::Commands.add_command(RubyJard::Commands::StepCommand)
+Pry::Commands.alias_command 's', 'step'

data/lib/ruby_jard/commands/step_out_command.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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 [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
+        times = validate_positive_integer!(args.first || 1)
+
+        RubyJard::ControlFlow.dispatch(:step_out, times: times.to_i)
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::StepOutCommand)
+Pry::Commands.alias_command 'so', 'step-out'

data/lib/ruby_jard/commands/up_command.rb

@@ -3,26 +3,28 @@
 module RubyJard
   module Commands
     # Command used to explore stacktrace.
-    # Data attached in the throw:
-    # * command: constant symbol (:up)
-    # * pry: current context pry instance
     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
-        throw :control_flow, command: :up, pry: pry_instance
+        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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # Another reinvent-the-wheel configuration
+  class Config
+    class << self
+      def smart_load
+        config = RubyJard::Config.new
+
+        path = File.expand_path(File.join(Dir.pwd, CONFIG_FILE_NAME))
+        load_config(config, path) if File.exist?(path)
+
+        path = File.expand_path(File.join('~/', CONFIG_FILE_NAME))
+        load_config(config, path) if File.exist?(path)
+
+        config
+      rescue StandardError => e
+        # Fallback to default setting
+        STDOUT.puts "Fail to load jard configurations at #{path}. Error: #{e}"
+        RubyJard::Config.new
+      end
+
+      private
+
+      def load_config(config, path)
+        config_content = File.read(path)
+        config.instance_eval(config_content)
+
+        config
+      end
+    end
+
+    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_FILTER = RubyJard::PathFilter::FILTER_APPLICATION,
+      DEFAULT_FILTER_INCLUDED = [].freeze,
+      DEFAULT_FILTER_EXCLUDED = [].freeze
+    ].freeze
+
+    def initialize
+      @color_scheme = DEFAULT_COLOR_SCHEME
+      @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
+      self
+    end
+  end
+end

data/lib/ruby_jard/console.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'tty-screen'
+require 'io/console'
+require 'English'
+
+module RubyJard
+  # Wrapper for utilities to control screen
+  class Console
+    class << self
+      def start_alternative_terminal(output)
+        return unless output.tty?
+
+        output.print tput('smcup')
+      rescue RubyJard::Error
+        # If tput not found, fallback to hard-coded sequence.
+        output.print "\e[?1049h\e[22;0;0t"
+      end
+
+      def stop_alternative_terminal(output)
+        return unless output.tty?
+
+        output.print tput('rmcup')
+      rescue RubyJard::Error
+        # If tput not found, fallback to hard-coded sequence.
+        output.print "\e[?1049l\e[23;0;0t"
+      end
+
+      def move_to(output, x, y)
+        return unless output.tty?
+
+        output.print format("\e[%<row>d;%<col>dH", row: y + 1, col: x + 1)
+      end
+
+      def screen_size(output)
+        return [0, 0] unless output.tty?
+
+        [TTY::Screen.width, TTY::Screen.height]
+      end
+
+      def clear_screen(output)
+        return unless output.tty?
+
+        output.print "\e[3J"
+      end
+
+      def clear_screen_to_end(output)
+        return unless output.tty?
+
+        output.print "\e[0J"
+      end
+
+      def disable_cursor!(output = STDOUT)
+        return unless output.tty?
+
+        output.print tput('civis')
+      rescue RubyJard::Error
+        # If tput not found, fallback to hard-coded sequence.
+        output.print "\e[?25l"
+      end
+
+      def enable_cursor!(output = STDOUT)
+        return unless output.tty?
+
+        output.print tput('cnorm')
+      rescue RubyJard::Error
+        # If tput not found, fallback to hard-coded sequence.
+        output.print "\e[?12l\e[?25h"
+      end
+
+      def getch(input, timeout)
+        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)
+        return unless output.tty?
+
+        begin
+          output.raw!
+        rescue StandardError
+          stty('raw')
+        end
+      end
+
+      def cooked!(output = STDOUT)
+        return unless output.tty?
+
+        begin
+          output.cooked!
+        rescue StandardError
+          # If stty not found, or raise error, nothing I can do
+          stty('-raw')
+        end
+      end
+
+      def disable_echo!(output = STDOUT)
+        return unless output.tty?
+
+        begin
+          output.echo = false
+        rescue StandardError
+          # If stty not found, or raise error, nothing I can do
+          stty('-echo')
+        end
+      end
+
+      def enable_echo!(output = STDOUT)
+        return unless output.tty?
+
+        begin
+          output.echo = true
+        rescue StandardError
+          # If stty not found, or raise error, nothing I can do
+          stty('echo')
+        end
+      end
+
+      def cached_tput
+        @cached_tput ||= {}
+      end
+
+      def tput(*args)
+        command = "tput #{args.join(' ')}"
+        return cached_tput[command] unless cached_tput[command].nil?
+
+        output = `#{command}`
+        if $CHILD_STATUS.success?
+          cached_tput[command] = output
+        else
+          raise RubyJard::Error, "Fail to call `#{command}`: #{$CHILD_STATUS}"
+        end
+      rescue StandardError => e
+        raise RubyJard::Error, "Fail to call `#{command}`. Error: #{e}"
+      end
+
+      def stty(*args)
+        command = "stty #{args.join(' ')}"
+        output = `#{command}`
+        if $CHILD_STATUS.success?
+          output
+        else
+          raise RubyJard::Error, "Fail to call `#{command}`: #{$CHILD_STATUS}"
+        end
+      rescue StandardError => e
+        raise RubyJard::Error, "Fail to call `#{command}`. Error: #{e}"
+      end
+    end
+  end
+end