ruby_jard 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f057d809cf1b9208df17537c1fb2f80b0380193d497351314d567a75e9ddc5
-  data.tar.gz: 74d8fa560a06dcc07579f1ccf8761c85c65c7110dfd6d0cbe93aeaab817934e4
+  metadata.gz: 9fb53f5406279a5047c3f73ec387bcb889e98e31ed7352393a459d8bc2611e08
+  data.tar.gz: f136e3adb604ce7b469d3528fdf5af617776e25feeeb303f45a94189a94803b2
 SHA512:
-  metadata.gz: d0da56029611ab8712f889b284c2e5a672e8b9609f76636b4cd354f08b65f3429c331324c31fa136572088eabdbf5a7aa1ebaedba526f517f4080145a73e2ff6
-  data.tar.gz: 3fb4581a4e913aa2fbe2985b8b842f76e78f8e1207a6ac0847ea52e898a1e1ac02178ff3ec46949e17b85e383a9fa3853428592ad3e4359aae1c71d008d83975
+  metadata.gz: f44eebc7ef5d413fb8b6ac44b5575a4ac31b71ad419a7800be68884d1c32564738c2d84276d471704c22bdad4cc36173f30bcfe8111f1081a002d7d343fcd400
+  data.tar.gz: 353d35eabfc1a3eb33e32a2c193bb3261b68e794c9a2293f335245f57b23fdf45405b70c6fb9071d10867c56a1051ac4f987c20199931fd5224af0d1d92a545e

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.2.2 - Alpha 3]
+
+### UX/UI
+- Add `wehereami` as an alias for `list` command
+- Add `theme` command to switch theme at runtime
+- Load configuration file when Jard starts
+
+### Bug fixes
+- Backward compatible issue: Array#filter is available in ruby 2.5.x and above.
+- Fix Jard is bypassed when writting something to stdout while debugging (https://github.com/nguyenquangminh0711/ruby_jard/pull/5)
+
 ## [0.2.1 - Alpha 3] - Render mechanism and theme system
 ### UX/UI
 - New color scheme: 256, as the default color scheme. It works well with all 256-color terminal emulators.

data/README.md

@@ -1,21 +1,13 @@
 ![Ruby Jard](./docs/logo.jpg)
 
-Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard supports the following major features at the moment:
-
-- Informative Terminal UI, reduce your mental effort for repeated stuff so that you can focus on killing bugs.
-- Highlighted source code screen.
-- Backtrace visualization and navigation.
-- Auto variable display in the current context.
-- Multi-thread exploration and debugging.
-
-Ruby Jard's core is [Byebug](https://github.com/deivid-rodriguez/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.
+Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard provides modular visual interfaces to show relevant information about your debugging program. Those interfaces are optimized for usability, and highly friendly to developers, especially new comers. They help you reduce the commands you need to type, the mental efforts wasted trying to navigate and grab the information you need. As a result, you can now focus more on the debug flow. 
 
 [![Ruby Jard Demo](./docs/demo.png)](https://asciinema.org/a/350233)
 
 *[(Click for demo video)](https://asciinema.org/a/350233)*
 
+Ruby Jard's core is [Byebug](https://github.com/deivid-rodriguez/byebug), an awesome de factor debugger for Ruby. Therefore, Ruby Jard supports most of Byebug's functionalities.
+
 ## 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.
@@ -110,7 +102,7 @@ An interactive Repl for you to interact with your program, inspect values, updat
 
 **Key binding:** F5
 
-**Alias**: `l`
+**Alias**: `l`, `whereami`
 
 Refresh the whole terminal UI. This command doesn't move you to other steps, nor change any data in your session. It is useful (or the only way) to get back the beautiful UI if you type too much in the REPL console.
 
@@ -186,6 +178,36 @@ Explore the lower frame. See `up` command for more information.
 
 Explore a particular frame with id `<frame_id>`. It's faster than `up` and `down`. See `up` command for more information.
 
+## Color schemes
+
+| Name                                                         | Screenshots                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `256` <br />Default theme, 256 basic colors, supported by all terminals | <img src="./docs/color_schemes/256.png" style="max-width: 400px;" /> |
+| `deep-space`                                                 | <img src="./docs/color_schemes/deep-space.png" style="max-width: 400px;" /> |
+
+
+
+## Configuration
+
+Ruby Jard supports customization via pre-loaded configuration files. You can configure Jard both globally, and per-project.
+
+- The global configuration file is located at `~/.jardrc`.
+- The project configuration file is located at `.jardrc` in working directory when you start Ruby Jard. Per-project ones will override, and merge with global ones.
+
+There are some supported configurations:
+
+| Name           | Description                                                  | Default |
+| -------------- | ------------------------------------------------------------ | ------- |
+| `color_scheme` | Choose your favorite color scheme. The list of color schemes can be looke up in [Color schemes session](#color-schemes), or from `color-scheme -l` command in REPL. | `256`   |
+
+This is a complete example of a configuration file:
+
+```ruby
+config.color_scheme = "deep-space"
+```
+
+## Roadmap
+
 ### [Done] Version 0.1.0: Proof of concept
 
 This version is a bootstrap to see whether my idea works or not, in term of technical possibility and user usability. Luckily, everything works now, and I receive possible feedback from friends and peers.

data/lib/ruby_jard.rb

@@ -7,6 +7,7 @@ require 'forwardable'
 require 'benchmark'
 
 require 'ruby_jard/control_flow'
+require 'ruby_jard/config'
 require 'ruby_jard/keys'
 require 'ruby_jard/key_binding'
 require 'ruby_jard/key_bindings'
@@ -41,7 +42,6 @@ require 'ruby_jard/version'
 module RubyJard
   class Error < StandardError; end
 
-  DEFAULT_COLOR_SCHEME = '256'
   DEFAULT_LAYOUT_TEMPLATES = [
     RubyJard::Layouts::WideLayout,
     RubyJard::Layouts::NarrowLayout
@@ -88,6 +88,10 @@ module RubyJard
     end
     @global_key_bindings
   end
+
+  def self.config
+    @config ||= RubyJard::Config.smart_load
+  end
 end
 
 ##

data/lib/ruby_jard/color_schemes.rb

@@ -18,9 +18,13 @@ module RubyJard
       end
 
       def [](name)
-        color_scheme_registry[name]
+        color_scheme_registry[name.to_s.strip]
       end
       alias get []
+
+      def names
+        color_scheme_registry.keys.sort.dup
+      end
     end
   end
 end

data/lib/ruby_jard/commands/color_scheme_command.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    class ColorSchemeCommand < Pry::ClassCommand
+      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 options(opt)
+        opt.on :l, :list, "List all available color schemes"
+      end
+
+      def process
+        if opts[:l]
+          if args.length != 0
+            raise Pry::CommandError, "Color scheme list command shouldn't have any argument."
+          end
+          pry_instance.pager.page RubyJard::ColorSchemes.names.join("\n")
+        else
+          color_scheme = args.first.to_s.strip
+          if color_scheme.empty?
+            raise Pry::CommandError, "You must provide a color scheme name."
+          end
+          if RubyJard::ColorSchemes[color_scheme].nil?
+            raise Pry::CommandError, "Color scheme `#{color_scheme}` not found. Please use `color-scheme -l` to list all color schemes."
+          end
+          RubyJard::ControlFlow.dispatch(:color_scheme, color_scheme: color_scheme)
+        end
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::ColorSchemeCommand)

data/lib/ruby_jard/commands/list_command.rb

@@ -27,3 +27,4 @@ end
 
 Pry::Commands.add_command(RubyJard::Commands::ListCommand)
 Pry::Commands.alias_command 'l', 'list'
+Pry::Commands.alias_command 'whereami', 'list'

data/lib/ruby_jard/config.rb

@@ -0,0 +1,50 @@
+# 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_reader :color_scheme
+    attr_writer :color_scheme
+
+    CONFIG_FILE_NAME = '.jardrc'
+    DEFAULTS = [
+      DEFAULT_COLOR_SCHEME = '256'
+    ].freeze
+
+    def initialize
+      @color_scheme = DEFAULT_COLOR_SCHEME
+    end
+
+    def config
+      self
+    end
+  end
+end

data/lib/ruby_jard/control_flow.rb

@@ -7,15 +7,16 @@ module RubyJard
   class ControlFlow
     THROW_KEYWORD = :jard_control_flow
     ALLOW_LIST = {
-      continue: [:times],     # lib/ruby_jard/commands/continue_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
-      next: [:times],         # lib/ruby_jard/commands/next_command.rb
-      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/step_command.rb
+      continue: [:times],           # lib/ruby_jard/commands/continue_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
+      next: [:times],               # lib/ruby_jard/commands/next_command.rb
+      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
     }.freeze
 
     attr_reader :command, :arguments

data/lib/ruby_jard/decorators/path_decorator.rb

@@ -20,7 +20,7 @@ module RubyJard
       def initialize(path, lineno)
         @gem = nil
         @gem_version = nil
-        @path = path
+        @path = path.to_s
         @lineno = lineno
         @type = TYPE_UNKNOWN
 

data/lib/ruby_jard/repl_processor.rb

@@ -133,5 +133,10 @@ module RubyJard
     def handle_list_command(_options = {})
       process_commands
     end
+
+    def handle_color_scheme_command(options = {})
+      RubyJard.config.color_scheme = options[:color_scheme]
+      process_commands
+    end
   end
 end

data/lib/ruby_jard/repl_proxy.rb

@@ -8,6 +8,7 @@ require 'ruby_jard/commands/step_command'
 require 'ruby_jard/commands/step_out_command'
 require 'ruby_jard/commands/frame_command'
 require 'ruby_jard/commands/list_command'
+require 'ruby_jard/commands/color_scheme_command'
 
 module RubyJard
   ##
@@ -38,7 +39,6 @@ module RubyJard
     PRY_EXCLUDED_COMMANDS = [
       'pry-backtrace', # Redundant method for normal user
       'watch',         # Conflict with byebug and jard watch
-      'whereami',      # Jard already provides similar. Keeping this command makes conflicted experience
       'edit',          # Sorry, but a file should not be editted while debugging, as it made breakpoints shifted
       'play',          # What if the played files or methods include jard again?
       'stat',          # Included in jard UI

data/lib/ruby_jard/screen_manager.rb

@@ -66,11 +66,15 @@ module RubyJard
     def start
       return if started?
 
+      # Load configurations
+      RubyJard.config
       RubyJard::Console.start_alternative_terminal(@output)
       RubyJard::Console.clear_screen(@output)
 
       def $stdout.write(string)
-        if !RubyJard::ScreenManager.updating? && RubyJard::ScreenManager.started?
+        # NOTE: `RubyJard::ScreenManager.instance` is a must. Jard doesn't work well with delegator
+        # TODO: Debug and fix the issues permanently
+        if !RubyJard::ScreenManager.instance.updating? && RubyJard::ScreenManager.instance.started?
           RubyJard::ScreenManager.instance.output_storage.write(string)
         end
         super
@@ -238,8 +242,10 @@ module RubyJard
     end
 
     def pick_color_scheme
-      # TODO: Fallback to a default color scheme if not found
-      RubyJard::ColorSchemes[RubyJard::DEFAULT_COLOR_SCHEME].new
+      color_scheme_class =
+        RubyJard::ColorSchemes[RubyJard.config.color_scheme] ||
+        RubyJard::ColorSchemes[RubyJard::Config::DEFAULT_COLOR_SCHEME]
+      color_scheme_class.new
     end
   end
 end

data/lib/ruby_jard/screens/backtrace_screen.rb

@@ -62,7 +62,7 @@ module RubyJard
             end
           elsif klass.singleton_class?
             # No easy way to get the original class of a singleton class
-            object.name
+            object.respond_to?(:name) ? object.name : object.to_s
           else
             klass.name
           end

data/lib/ruby_jard/screens/threads_screen.rb

@@ -8,7 +8,7 @@ module RubyJard
       end
 
       def build
-        contexts = RubyJard.current_session.contexts.filter { |c| c.thread.alive? }
+        contexts = RubyJard.current_session.contexts.select { |c| c.thread.alive? }
         contexts = sort_contexts(contexts)
         @rows = contexts.map do |context|
           RubyJard::Row.new(

data/lib/ruby_jard/version.rb

@@ -2,5 +2,5 @@
 
 # Semantic versionn
 module RubyJard
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_jard
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Minh Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -75,6 +75,8 @@ files:
 - _config.yml
 - bin/console
 - docs/_config.yml
+- docs/color_schemes/256.png
+- docs/color_schemes/deep-space.png
 - docs/demo.png
 - docs/guide-ui.png
 - docs/index.md
@@ -102,6 +104,7 @@ files:
 - lib/ruby_jard/color_schemes/256_color_scheme.rb
 - lib/ruby_jard/color_schemes/deep_space_color_scheme.rb
 - lib/ruby_jard/column.rb
+- lib/ruby_jard/commands/color_scheme_command.rb
 - lib/ruby_jard/commands/continue_command.rb
 - lib/ruby_jard/commands/down_command.rb
 - lib/ruby_jard/commands/frame_command.rb
@@ -110,6 +113,7 @@ files:
 - lib/ruby_jard/commands/step_command.rb
 - lib/ruby_jard/commands/step_out_command.rb
 - lib/ruby_jard/commands/up_command.rb
+- lib/ruby_jard/config.rb
 - lib/ruby_jard/console.rb
 - lib/ruby_jard/control_flow.rb
 - lib/ruby_jard/decorators/color_decorator.rb
@@ -172,7 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Just Another Ruby Debugger