ruby_jard 0.1.0 → 0.3.0

data/lib/ruby_jard/commands/down_command.rb

@@ -3,26 +3,27 @@
 module RubyJard
   module Commands
     # Command used to explore stacktrace.
-    # Data attached in the throw:
-    # * command: constant symbol (:down)
-    # * pry: current context pry instance
     class DownCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Explore the frames bellow the current stopped line in the backtrace'
 
       match 'down'
 
       banner <<-BANNER
-      Usage: down
-
-      Explore the frames bellow the current stopped line in the backtrace.
-
+      Usage: down [-h] [times]
       Examples:
         down
+        down 1
+        down 7
+
+      Explore the frames bellow the current stopped line in the backtrace. All the C frames will be skipped.
       BANNER
 
       def process
-        throw :control_flow, command: :down, pry: pry_instance
+        times = validate_positive_integer!(args.first || 1)
+        RubyJard::ControlFlow.dispatch(:down, times: times.to_i)
       end
     end
   end

data/lib/ruby_jard/commands/exit_command.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to exit program execution.
+    class ExitCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Exit program execution.'
+
+      match 'exit'
+
+      banner <<-BANNER
+      Usage: exit
+      Examples:
+        exit
+
+      Exit program execution. The program will stop at the next breakpoint, or run until it finishes.
+      BANNER
+
+      def process
+        RubyJard::ControlFlow.dispatch(:exit)
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::ExitCommand)

data/lib/ruby_jard/commands/frame_command.rb

@@ -3,31 +3,33 @@
 module RubyJard
   module Commands
     # Command used to explore stacktrace.
-    # Data attached in the throw:
-    # * command: constant symbol (:frame)
-    # * pry: current context pry instance
-    # * frame (optional): frame id of the destination frame
     class FrameCommand < Pry::ClassCommand
+      include RubyJard::Commands::ValidationHelpers
+
       group 'RubyJard'
       description 'Explore to any frame of current stacktrace.'
 
       match 'frame'
 
       banner <<-BANNER
-      Usage: frame
+      Usage: frame [FRAME_ID]
 
       Explore to any frame of current stacktrace.
 
       Examples:
-        frame [FRAME_ID]
+        frame 4 # Jump to frame 4 in the backtrace
       BANNER
 
+      def initialize(context = {})
+        super(context)
+        @current_backtrace = (context[:session] || RubyJard::Session).current_backtrace
+      end
+
       def process
-        throw :control_flow,
-              command: :frame,
-              pry: pry_instance,
-              # TODO: Remove redundant options
-              options: { frame: args.first }
+        frame = validate_present!(args.first)
+        frame = validate_non_negative_integer!(frame)
+        frame = validate_range!(frame, 0, @current_backtrace.map(&:virtual_pos).compact.max)
+        RubyJard::ControlFlow.dispatch(:frame, frame: frame)
       end
     end
   end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+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'
+
+      match 'color-scheme'
+
+      banner <<-BANNER
+        Usage: color-scheme -l
+               color-scheme [scheme-name]
+      BANNER
+
+      def initialize(context = {})
+        super(context)
+        @color_schemes = context[:color_schemes] || RubyJard::ColorSchemes
+        @config = context[:config] || RubyJard.config
+      end
+
+      def options(opt)
+        opt.on :l, :list, 'List all available color schemes'
+      end
+
+      def process
+        if opts[:l]
+          if @color_schemes.names.empty?
+            pry_instance.output.puts 'No loaded color schemes'
+          else
+            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 `#{highlight('jard color-scheme -l')}` to list all color schemes."
+          end
+
+          if @color_schemes[color_scheme].nil?
+            raise Pry::CommandError,
+                  "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/hide_command.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Show a screen
+    class HideCommand < Pry::ClassCommand
+      description 'Hide a screen'
+      banner <<-BANNER
+        Usage: jard hide [-h] [screen]
+      BANNER
+      match 'hide'
+
+      def initialize(context = {})
+        super(context)
+
+        @screens = context[:screens] || RubyJard::Screens
+        @config = context[:config] || RubyJard.config
+      end
+
+      def process
+        screen = args.first.to_s.strip
+
+        if screen.empty?
+          raise Pry::CommandError,
+                "Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        unless @screens.names.include?(screen)
+          raise Pry::CommandError,
+                "Screen `#{screen}` not found. Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        @config.enabled_screens.delete(screen)
+
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class OutputCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Show all current program output'
+
+      match 'output'
+
+      banner <<-BANNER
+        Usage: output
+      BANNER
+
+      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,
+          prompt: 'Program output'
+        ) do |pager|
+          @session.output_buffer.each do |string|
+            string.each do |s|
+              pager.write(s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    ##
+    # Show a screen
+    class ShowCommand < Pry::ClassCommand
+      description 'Show a screen'
+      banner <<-BANNER
+        Usage: jard show [-h] [screen]
+      BANNER
+      match 'show'
+
+      def initialize(context = {})
+        super(context)
+
+        @screens = context[:screens] || RubyJard::Screens
+        @config = context[:config] || RubyJard.config
+      end
+
+      def process
+        screen = args.first.to_s.strip
+
+        if screen.empty?
+          raise Pry::CommandError,
+                "Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        unless @screens.names.include?(screen)
+          raise Pry::CommandError,
+                "Screen `#{screen}` not found. Please input one of the following: #{@screens.names.join(', ')}"
+        end
+
+        @config.enabled_screens << screen
+        @config.enabled_screens.uniq!
+
+        RubyJard::ControlFlow.dispatch(:list)
+      end
+    end
+  end
+end

data/lib/ruby_jard/commands/jard_command.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+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
+    # Command used to explore stacktrace.
+    class JardCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Show all current program output'
+
+      match 'jard'
+
+      banner <<-BANNER
+        Usage: jard [-h] [sub commands]
+      BANNER
+
+      SUB_COMMANDS = {
+        'show' => RubyJard::Commands::ShowCommand,
+        'hide' => RubyJard::Commands::HideCommand,
+        'color-scheme' => RubyJard::Commands::ColorSchemeCommand,
+        'output' => RubyJard::Commands::OutputCommand,
+        'filter' => RubyJard::Commands::FilterCommand
+      }.freeze
+
+      def subcommands(cmd)
+        SUB_COMMANDS.each do |command_name, sub_command|
+          cmd.command command_name do |opt|
+            opt.description sub_command.description
+            opt.run do |_, arguments|
+              @ran_sub_command = true
+              sub_command.new(context).send(:call_safely, *arguments)
+            end
+          end
+        end
+      end
+
+      def process
+        return if @ran_sub_command
+        return if ['-h', '--help'].include?(args.first) || SUB_COMMANDS.keys.include?(args.first)
+
+        pry_instance.output.puts help
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::JardCommand)