ruby_jard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eaeb2003b2133100d1723d4fc5b3de3ea0ce6c1fd9f5e754a69ac7a489198d4
-  data.tar.gz: a1389c55f973eacda0e4fa6fdbf4b4f6f23feb6cf1ab38050f7fd3f8a1d689ed
+  metadata.gz: 94dbda134fd22365f583f71fa2aaddffae206045cc8da4fd6ee51e2eeaebfca7
+  data.tar.gz: af8c443ac2c40619cead142c3e77dd3b7f7ad59c19993966edcdd1eae8c31a3d
 SHA512:
-  metadata.gz: 04f8ca93a51eef68e3139fa58a5d7acb5ece7f79023dcff53bde4796628518f7fdc86a40903df1d680f4e13c86542a9b48fdc228a899c15674bb9a18e33d8419
-  data.tar.gz: 73608c00fe978926adaf05361e7d1467a6c9da325e6cdeba71ed25ddb00e8d027b788ca9154c2c74c13f4b36dbe4502b2e9f12fb9c82ba815b0967c7fa84765e
+  metadata.gz: 6d18a6894bcb24bae3bf30244dfcf1f39412e9804df5897e7adac6b74cdb8929b3353a8a0999ec55b687bfa60e87890a5db637bfe7d046b30a470b0d5158c46e
+  data.tar.gz: 7eaacc77cd4eaa4fdb7e183292872cef01217e5c92f75bea1882d454dad1ad1ae97ff3790ca129e76de4f893167d1b1b81b6deb7eb44b6931d67a23cca03f7f5

data/.rubocop.yml

@@ -1,9 +1,19 @@
+Naming/MethodParameterName:
+  Enabled: false
 Style/SymbolArray:
   Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
 Metrics/MethodLength:
   Max: 20
 Metrics/PerceivedComplexity:
   Max: 15
+Metrics/AbcSize:
+  Enabled: false
 Metrics/ParameterLists:
   Enabled: false
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+## [0.2.0 - Alpha 2] - UI completeness
+
+### UX/UI
+- Improve box drawing.
+- Isolate jard-related UI in an alternative termnial, just like Vim or Less.
+- Restore printed information from STDOUT and STDERR after jard exits.
+- Support keyboard shortcut.
+- Support erb, haml highlighting.
+- Increase contrast and enhance color scheme.
+- Remove `finish` command.
+- Add `frame` command.
+- Add `step-out` command.
+- Remove useless inline variables.
+- Indicate types and inline variables in variable screen.
+
+### Bug fixes
+- Fix line number and loc mismatching if the current source viewport is at the start of the file.
+- Multiple layout broken, overlapping text glitches.
+
+### Internal & Refactoring
+- Refactor screen's data flow.
+- Standardize control flow.
+- Replace `tty-cursor`, `tty-screen` by native Ruby alternative.
+- Replace `tty-box` by home-growing solution.
+- Remove text decorator.
+- Implement color decorator
+- Implement keybinding register and matching mechanism.
+- Implement ReplProxy to wrap around Pry instance.
+- Utility to debug and benchmark.
+
+## [0.1.0 - Alpha] - Alpha initial version
+**Release date**: July 1st 2020
+
+- Default Terminal UI, in which the layout and display are responsive to support different screen size.
+- Highlighted source code screen.
+- Stacktrace visulization and navigation.
+- Auto explore and display variables in the current context.
+- Multi-thread exploration and debugging.

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 gemspec
 

data/README.md

@@ -1,10 +1,73 @@
 # RubyJard
 
- Just another ruby debugger. Jard provides an unified experience debugging Ruby source code in different platforms and editors. Jard is heavily under development. So, nothing to see here :smile:. When everything is ready, I'll update this file.
+Jard stands for Just Another Ruby Debugger. It implements a layer of UI wrapping around byebug, aims to provide a unified experience when debugging Ruby source code. Ruby Jard supports the following major features at the moment:
+
+- Default Terminal UI, in which the layout and display are responsive to support different screen sizes.
+- Highlighted source code screen.
+- Stacktrace visualization and navigation.
+- Auto explore and display variables in the current context.
+- Multi-thread exploration and debugging.
+
+In the roadmap:
+- Dynamic breakpoints.
+- Watch expressions.
+- Support different screen sizes.
+- Minimal layout configuration.
+- Fully layout configuration with Tmux.
+- Integrate with Vim.
+- Integrate with Visual Studio Code.
+- Encrypted remote debugging.
+- Some handful debug tools and data visualization.
+
+Ruby Jard's core is Byebug, an awesome de factor debugger for Ruby. Therefore, Ruby Jard supports most of Byebug's functionalities.
+
+If you still don't know what it is, let's watch this video. This is a record of debugging Code Ray - A syntax highlighter for Ruby.
+
+[![asciicast](https://asciinema.org/a/ejWK3Px55QNQmhM4nbd1lSigW.svg)](https://asciinema.org/a/ejWK3Px55QNQmhM4nbd1lSigW)
+
+## Getting Started
+
+**Warning**: Ruby Jard is still under heavy development. Bugs and weird behaviors are expected. If you see one, please don't hesitate to open an issue. I'll try my best to fix.
+
+Add `ruby_jard` to your Gemfile, recommend to put it in test or development environment.
+
+``` ruby
+gem 'ruby_jard'
+```
+
+Add magic method `jard` before the line you want to debug, just like `byebug`
+
+```ruby
+def test_method
+  a = 1
+  b = 2
+  jard # Debugger will stop here
+  c = a + b
+end
+```
+
+## Guides
+
+![Guide UI](./docs/guide-ui.png)
+
+The main page of the debugging UI includes 4 screens:
+- Source: Show the current file, surrounding the source code of the executing line.
+- Stacktrace: Show the current thread's stack trace. You can use `up`, `down`, `frame` to navigate through the stack trace.
+- Variables: Show all the variables in the current context, including local variables, instance variables, and constants.
+- Threads: Show all the threads of the process. This screen is valuable in case you are debugging a multi-threaded program.
+
+At this alpha state, Ruby Jard support some basic commands:
+- `next`: continue the execution to the next line.
+- `step`: continue the execution, do deep into the implementation of methods in the current line.
+- `continue`: continue the execution. The program gonna stops at the next breakpoint.
+- `finish`: Finish the execution of the current frame, and go back.
+- `up`: explore the stack trace, jump to the upper frame of the current program
+- `down`: explore the stack trace, jump to the lower frame of the current program
+- `frame`: explore the stack trace, jump to a precise frame in the stack trace.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_jard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby_jard/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/nguyenquangminh0711/ruby_jard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nguyenquangminh0711/ruby_jard/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/lib/ruby_jard.rb

@@ -1,21 +1,16 @@
 # frozen_string_literal: true
 
 require 'pry'
-require 'coderay'
 require 'byebug/core'
 require 'byebug/attacher'
-require 'tty-cursor'
-require 'tty-box'
-require 'tty-screen'
-
-require 'ruby_jard/commands/continue_command'
-require 'ruby_jard/commands/up_command'
-require 'ruby_jard/commands/down_command'
-require 'ruby_jard/commands/next_command'
-require 'ruby_jard/commands/step_command'
-require 'ruby_jard/commands/finish_command'
-require 'ruby_jard/commands/frame_command'
+require 'forwardable'
+require 'benchmark'
 
+require 'ruby_jard/control_flow'
+require 'ruby_jard/keys'
+require 'ruby_jard/key_binding'
+require 'ruby_jard/key_bindings'
+require 'ruby_jard/repl_proxy'
 require 'ruby_jard/repl_processor'
 require 'ruby_jard/screen_manager'
 
@@ -46,9 +41,51 @@ require 'ruby_jard/version'
 module RubyJard
   class Error < StandardError; end
 
+  DEFAULT_LAYOUT_TEMPLATES = [
+    RubyJard::Layouts::WideLayout
+  ].freeze
+
   def self.current_session
     @current_session ||= RubyJard::Session.new
   end
+
+  def self.benchmark(name)
+    @benchmark_depth ||= 0
+    @benchmark_depth += 1
+    return_value = nil
+    time = Benchmark.realtime { return_value = yield }
+    debug("#{' ' * @benchmark_depth}Benchmark `#{name}`: #{time}")
+    @benchmark_depth -= 1
+    return_value
+  end
+
+  def self.debug(*info)
+    @debug_info ||= []
+    @debug_info += info
+    File.open('./jard_debugs.txt', 'a') do |f|
+      info.each do |line|
+        f.puts line
+      end
+    end
+  end
+
+  def self.debug_info
+    @debug_info ||= []
+  end
+
+  def self.clear_debug
+    @debug_info = []
+  end
+
+  def self.global_key_bindings
+    return @global_key_bindings if defined?(@global_key_bindings)
+
+    @global_key_bindings = RubyJard::KeyBindings.new
+    RubyJard::Keys::DEFAULT_KEY_BINDINGS.each do |sequence, action|
+      @global_key_bindings.push(sequence, action)
+    end
+    @global_key_bindings
+  end
 end
 
 ##

data/lib/ruby_jard/box_drawer.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # Drawer to draw a nice single-line box that maximize screen area
+  #
+  # Each screen has 4 corners and clock-wise corresponding ID:
+  # - Top-left => 1
+  # - Top-right => 2
+  # - Bottom-right => 3
+  # - Bottom-left => 4
+  #
+  # For each screen, add each point to a coordinator hash.
+  # - If a point is occupied by 1 screen, draw normal box corner symbol.
+  # - If a point is occupied by 2 screens, look up in a map, and draw corresponding intersection corner symbol.
+  # - If a point is occupied by 3 or more screens, it's definitely a + symbol.
+  #
+  # The corner list at each point (x, y) is unique. If 2 screens overlap a point with same corner ID, it means
+  # 2 screens overlap, and have same corner symbol.
+  class BoxDrawer
+    CORNERS = [
+      TOP_LEFT = 1,
+      TOP_RIGHT = 2,
+      BOTTOM_RIGHT = 3,
+      BOTTOM_LEFT = 4
+    ].freeze
+
+    HORIZONTAL_LINE = '─'
+    VERTICAL_LINE = '│'
+    CROSS_CORNER = '┼'
+
+    NORMALS_CORNERS = {
+      TOP_LEFT => '┌',
+      TOP_RIGHT => '┐',
+      BOTTOM_RIGHT => '┘',
+      BOTTOM_LEFT => '└'
+    }.freeze
+
+    OVERLAPPED_CORNERS = {
+      [TOP_LEFT, TOP_RIGHT] => '┬',
+      [TOP_LEFT, BOTTOM_RIGHT] => '┼',
+      [TOP_LEFT, BOTTOM_LEFT] => '├',
+      [TOP_RIGHT, BOTTOM_RIGHT] => '┤',
+      [TOP_RIGHT, BOTTOM_LEFT] => '┼',
+      [BOTTOM_RIGHT, BOTTOM_LEFT] => '┴'
+    }.freeze
+
+    def initialize(output:, screens:)
+      @output = output
+      @screens = screens
+      @color_decorator = RubyJard::Decorators::ColorDecorator.new
+    end
+
+    def draw
+      draw_basic_lines
+      corners = calculate_corners
+      draw_corners(corners)
+      draw_titles
+    end
+
+    private
+
+    def draw_basic_lines
+      # Exclude the corners
+      @screens.each do |screen|
+        RubyJard::Console.move_to(@output, screen.x + 1, screen.y)
+        @output.print HORIZONTAL_LINE * (screen.width - 2)
+
+        RubyJard::Console.move_to(@output, screen.x + 1, screen.y + screen.height - 1)
+        @output.print HORIZONTAL_LINE * (screen.width - 2)
+
+        (screen.y + 1..screen.y + screen.height - 2).each do |moving_y|
+          RubyJard::Console.move_to(@output, screen.x, moving_y)
+          @output.print VERTICAL_LINE
+          RubyJard::Console.move_to(@output, screen.x + screen.width - 1, moving_y)
+          @output.print VERTICAL_LINE
+        end
+      end
+    end
+
+    def draw_corners(corners)
+      corners.each do |x, corners_x|
+        corners_x.each do |y, ids|
+          RubyJard::Console.move_to(@output, x, y)
+
+          case ids.length
+          when 1
+            @output.print NORMALS_CORNERS[ids.first]
+          when 2
+            ids = ids.sort
+            @output.print OVERLAPPED_CORNERS[ids]
+          else
+            @output.print CROSS_CORNER
+          end
+        end
+      end
+    end
+
+    def draw_titles
+      @screens.each do |screen|
+        next unless screen.respond_to?(:title)
+        RubyJard::Console.move_to(@output, screen.x + 2, screen.y)
+        @output.print ' '
+        @output.print @color_decorator.decorate(screen.title, :bright_yellow, :bold)
+        @output.print ' '
+      end
+    end
+
+    def calculate_corners
+      corners = {}
+      @screens.each do |screen|
+        mark_corner(corners, screen.x, screen.y, TOP_LEFT)
+        mark_corner(corners, screen.x + screen.width - 1, screen.y, TOP_RIGHT)
+        mark_corner(corners, screen.x + screen.width - 1, screen.y + screen.height - 1, BOTTOM_RIGHT)
+        mark_corner(corners, screen.x, screen.y + screen.height - 1, BOTTOM_LEFT)
+      end
+      corners
+    end
+
+    def mark_corner(corners, x, y, id)
+      corners[x] ||= {}
+      corners[x][y] ||= []
+      corners[x][y] << id unless corners[x][y].include?(id)
+    end
+  end
+end

data/lib/ruby_jard/column.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RubyJard
+  class Column
+    extend Forwardable
+
+    attr_accessor :column_template, :spans, :content_length, :width
+
+    def_delegators :@column_template, :margin_left, :margin_right
+
+    def initialize(column_template:)
+      @column_template = column_template
+      @spans = []
+      @width = 0
+      @content_length = 0
+    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.'
@@ -22,9 +19,7 @@ module RubyJard
       BANNER
 
       def process
-        throw :control_flow, command: :continue, pry: pry_instance
-      ensure
-        Byebug.stop if Byebug.stoppable?
+        RubyJard::ControlFlow.dispatch(:continue)
       end
     end
   end

data/lib/ruby_jard/commands/down_command.rb

@@ -3,9 +3,6 @@
 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
       group 'RubyJard'
       description 'Explore the frames bellow the current stopped line in the backtrace'
@@ -22,7 +19,7 @@ module RubyJard
       BANNER
 
       def process
-        throw :control_flow, command: :down, pry: pry_instance
+        RubyJard::ControlFlow.dispatch(:down)
       end
     end
   end

data/lib/ruby_jard/commands/frame_command.rb

@@ -3,10 +3,6 @@
 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
       group 'RubyJard'
       description 'Explore to any frame of current stacktrace.'
@@ -14,20 +10,25 @@ module RubyJard
       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 process
-        throw :control_flow,
-              command: :frame,
-              pry: pry_instance,
-              # TODO: Remove redundant options
-              options: { frame: args.first }
+        frame = args.first
+        raise Pry::CommandError, 'Frame ID is required' if frame.nil?
+        raise Pry::CommandError, 'Frame ID must be numeric' unless frame =~ /^\d+$/i
+
+        frame = frame.to_i
+        if frame >= RubyJard.current_session.backtrace.length || frame < 0
+          raise Pry::CommandError, "Frame #{frame} does not exist!"
+        else
+          RubyJard::ControlFlow.dispatch(:frame, frame: args.first)
+        end
       end
     end
   end