ruby_jard 0.1.0 → 0.3.0

data/Gemfile

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 gemspec
 
-gem 'aruba', '~> 1.0.2'
+if Gem.path.all? { |path| Dir[File.join(path, 'gems/jard_merge_sort*')].empty? }
+  puts '[HACK] Install jard_merge_sort'
+  puts `gem install ./spec/examples/jard_merge_sort/jard_merge_sort-0.1.0.gem`
+end
+
 gem 'byebug', '~> 11.1.0'
-gem 'pry', '~> 0.13.0'
+gem 'jard_merge_sort', require: false
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 0.86'
+gem 'rubocop', '~> 0.89.1'
+gem 'rubocop-rspec', '~> 1.43.1', require: false
+
+group :test do
+  gem 'parallel_tests'
+  gem 'rspec-retry'
+end

data/README.md

@@ -1,10 +1,102 @@
-# RubyJard
+[<img src="./website/static/img/logo/logo-full.png" width="400" />](https://rubyjard.org/)
 
- 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.
+![Gem](https://img.shields.io/gem/v/ruby_jard?label=Latest%20version&style=for-the-badge) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/nguyenquangminh0711/ruby_jard/Rspec/master?label=Build&style=for-the-badge) ![GitHub stars](https://img.shields.io/github/stars/nguyenquangminh0711/ruby_jard?style=for-the-badge) [![From Vietnam with <3](https://raw.githubusercontent.com/webuild-community/badge/master/svg/love-modern.svg)](https://webuild.community)
+
+Ruby Jard provides a rich Terminal UI that visualizes everything your need, navigates your program with pleasure, stops at matter places only, reduces manual and mental efforts. You can now focus on real debugging.
+
+Please visit [https://rubyjard.org/](https://rubyjard.org/) for more information.
+
+[![RubyJard Demo](https://asciinema.org/a/358874.svg)](https://asciinema.org/a/358874)
+
+*[(Click for demo video)](https://asciinema.org/a/358874)*
+
+**Note**: 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](https://github.com/nguyenquangminh0711/ruby_jard/issues). I'll try my best to fix.
+
+## Install Ruby Jard
+
+### Bundler
+
+Add one of those lines into your Gemfile. **Note**: Ruby Jard is discouraged to use on production environment.
+
+```ruby
+gem 'ruby_jard', group: :development
+```
+
+```bash
+❯ bundle install
+```
+
+If you would like to use Ruby Jard to debug a test, you can add to group test too.
+
+
+```ruby
+gem 'ruby_jard', group: [:development, :test]
+```
+
+If you would like to use edged developing version of Ruby Jard:
+
+```ruby
+gem 'ruby_jard', group: :development, git: 'https://github.com/nguyenquangminh0711/ruby_jard'
+```
+
+### Ruby Gem
+
+If you want to install Ruby Jard independently from bundler:
+
+```bash
+gem install ruby_jard
+```
+
+If you want to install a specific version published on [Ruby gems](https://rubygems.org/gems/ruby_jard):
+
+```bash
+gem install ruby_jard@0.2.3
+```
+
+## Run your program with Ruby Jard
+
+![How to run your program with Ruby Jard](./website/static/img/getting_started/how-to-use.gif)
+
+To use Ruby Jard, you just need to put `jard` magic method **before** any places you want to stop. Jard supports stopping at anywhere, including top level binding, instance methods, class methods, string evaluation, or even inside a class declaration.
+
+```ruby
+def test_method(input)
+  a = 1
+  b = 2
+  jard # Debugger will stop here
+  c = a + b + input
+end
+
+class TestClass
+  jard # Yes, it can stop here too
+  @dirty_class_method = 1 + 1
+
+  def test_method
+    jard
+  end
+
+  def self.test_class_method
+    jard
+  end
+end
+
+jard
+test_method(5)
+```
+
+Afterward, run your program, just like normally. If your program meets `jard` execution break point, it gonna stop, show the UI, and let you debug.
+
+In case you meet error `undefined local variable or method jard`, please require ruby_jard manually at initializing scripts. If you use Ruby Jard with famous frameworks, ruby_jard will be loaded by default
+
+```ruby
+require 'ruby_jard'
+```
+
+Please visit [https://rubyjard.org/](https://rubyjard.org/) for more information.
 
 ## 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/benchmark/path_filter_bench.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'benchmark'
+require 'ruby_jard'
+require 'securerandom'
+require 'jard_merge_sort'
+
+##
+# Benchmark lib/ruby_jard/path_filter.rb
+class PathFilterBench
+  include Benchmark
+
+  def initialize
+    config = RubyJard::Config.new
+    config.filter = :application
+    @path_filter = RubyJard::PathFilter.new(config: config)
+  end
+
+  def execute
+    n = 500_000
+    file = File.expand_path('../lib/ruby_jard/path_filter.rb')
+    gem_file = JardMergeSort::Sorter.instance_method(:sort).source_location[0]
+    stdlib_file = SecureRandom.method(:uuid).source_location[0]
+
+    Benchmark.benchmark(CAPTION, 7, FORMAT) do |x|
+      x.report('App file     ') { n.times { @path_filter.match?(file) } }
+      x.report('Gem file     ') { n.times { @path_filter.match?(gem_file) } }
+      x.report('Stdlib file  ') { n.times { @path_filter.match?(stdlib_file) } }
+      x.report('(eval)       ') { n.times { @path_filter.match?('(eval)') } }
+      x.report('<internal:gc>') { n.times { @path_filter.match?('<internal:gc>') } }
+      x.report('nil          ') { n.times { @path_filter.match?(nil) } }
+      x.report('Other file   ') { n.times { @path_filter.match?(file) } }
+      x.report('Base line    ') { n.times { File.expand_path('abc/def.rb').start_with?('abc/') } }
+    end
+  end
+end
+
+PathFilterBench.new.execute
+
+# Commit 9858faa422a35b4a7a13c5ac986e35bf16fb8029
+# App file       4.528750   0.168117   4.696867 (  4.698018)
+# Gem file       6.003084   0.235965   6.239049 (  6.239139)
+# Stdlib file    6.198815   0.203962   6.402777 (  6.402885)
+# (eval)         0.830737   0.000104   0.830841 (  0.830878)
+# <internal:gc>  0.747695   0.000000   0.747695 (  0.747713)
+# Other file     4.317924   0.191915   4.509839 (  4.509897)
+# Base line      0.026612   0.000000   0.026612 (  0.026614)
+
+# Latest
+# App file       1.217831   0.147700   1.365531 (  1.365815)
+# Gem file       2.569692   0.180220   2.749912 (  2.750003)
+# Stdlib file    2.450189   0.171845   2.622034 (  2.622073)
+# (eval)         0.312905   0.000080   0.312985 (  0.312986)
+# <internal:gc>  0.457472   0.000116   0.457588 (  0.457589)
+# nil            0.191749   0.000000   0.191749 (  0.191761)
+# Other file     1.207719   0.143965   1.351684 (  1.351699)
+# Base line      0.631581   0.143966   0.775547 (  0.775573)

data/bin/console

@@ -11,5 +11,4 @@ require 'ruby_jard'
 # require "pry"
 # Pry.start
 
-require 'pry'
-Pry.start(__FILE__)
+IRB.start(__FILE__)

data/lib/ruby_jard.rb

@@ -1,24 +1,25 @@
 # 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/path_classifier'
+require 'ruby_jard/path_filter'
+require 'ruby_jard/control_flow'
+require 'ruby_jard/config'
+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'
+require 'ruby_jard/reflection'
 
+require 'ruby_jard/frame'
+require 'ruby_jard/thread_info'
 require 'ruby_jard/session'
 require 'ruby_jard/version'
 
@@ -46,8 +47,56 @@ require 'ruby_jard/version'
 module RubyJard
   class Error < StandardError; end
 
-  def self.current_session
-    @current_session ||= RubyJard::Session.new
+  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.error(exception)
+    File.open('./jard_errors.txt', 'a') do |f|
+      f.puts '--- Error ---'
+      f.puts exception.message
+      f.puts exception.backtrace
+    end
+  rescue StandardError
+    # Ignore
+  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
+
+  def self.config
+    @config ||= RubyJard::Config.smart_load
   end
 end
 
@@ -55,23 +104,10 @@ end
 # Monkey-patch Kernel module to allow putting jard command anywhere.
 module Kernel
   def jard
-    RubyJard.current_session.attach
+    RubyJard::Session.instance.attach
   end
-end
 
-##
-# Globally configure Byebug. Byebug doesn't allow configuration by instance.
-# So, I have no choice.
-# TODO: Byebug autoloaded configuration may override those values.
-Byebug::Setting[:autolist] = false
-Byebug::Setting[:autoirb] = false
-Byebug::Setting[:autopry] = false
-Byebug::Context.processor = RubyJard::ReplProcessor
-# Exclude all files in Ruby Jard source code from the stacktrace.
-Byebug::Context.ignored_files = Byebug::Context.all_files + Dir.glob(
-  File.join(
-    File.expand_path(__dir__, '../lib'),
-    '**',
-    '*.rb'
-  )
-)
+  if RubyJard.config.alias_to_debugger
+    alias_method :debugger, :jard
+  end
+end

data/lib/ruby_jard/box_drawer.rb

@@ -0,0 +1,175 @@
+# 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:, color_scheme:)
+      @output = output
+      @screens = screens
+      @color_decorator = RubyJard::Decorators::ColorDecorator.new(color_scheme)
+    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.layout.box_x + 1,
+          screen.layout.box_y
+        )
+        @output.print colorize_border(HORIZONTAL_LINE * (screen.layout.box_width - 2))
+
+        RubyJard::Console.move_to(
+          @output,
+          screen.layout.box_x + 1,
+          screen.layout.box_y + screen.layout.box_height - 1
+        )
+        @output.print colorize_border(HORIZONTAL_LINE * (screen.layout.box_width - 2))
+
+        (screen.layout.box_y + 1..screen.layout.box_y + screen.layout.box_height - 2).each do |moving_y|
+          RubyJard::Console.move_to(@output, screen.layout.box_x, moving_y)
+          @output.print colorize_border(VERTICAL_LINE)
+
+          RubyJard::Console.move_to(@output, screen.layout.box_x + screen.layout.box_width - 1, moving_y)
+          @output.print colorize_border(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 colorize_border(NORMALS_CORNERS[ids.first])
+          when 2
+            ids = ids.sort
+            @output.print colorize_border(OVERLAPPED_CORNERS[ids])
+          else
+            @output.print colorize_border(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.layout.box_x + 1, screen.layout.box_y)
+        total_length = 0
+        title_parts = Array(screen.title)
+        title_parts.each_with_index do |title_part, index|
+          break if total_length >= screen.layout.box_width
+
+          title_part = title_part[0..screen.layout.box_width - total_length - 2 - 1 - 2]
+          if index == 0
+            @output.print @color_decorator.decorate(:title, " #{title_part} ")
+          else
+            @output.print @color_decorator.decorate(:title_secondary, " #{title_part} ")
+          end
+          total_length += title_part.length + 2
+        end
+        title_background = screen.layout.box_width - total_length - 2
+        @output.print @color_decorator.decorate(
+          :title_background,
+          HORIZONTAL_LINE * (title_background < 0 ? 0 : title_background)
+        )
+      end
+    end
+
+    def calculate_corners
+      corners = {}
+      @screens.each do |screen|
+        mark_corner(
+          corners,
+          screen.layout.box_x,
+          screen.layout.box_y,
+          TOP_LEFT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x + screen.layout.box_width - 1,
+          screen.layout.box_y,
+          TOP_RIGHT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x + screen.layout.box_width - 1,
+          screen.layout.box_y + screen.layout.box_height - 1,
+          BOTTOM_RIGHT
+        )
+        mark_corner(
+          corners,
+          screen.layout.box_x,
+          screen.layout.box_y + screen.layout.box_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
+
+    def colorize_border(content)
+      @color_decorator.decorate(:border, content)
+    end
+  end
+end