ruby_jard 0.2.2 → 0.2.3

data/lib/ruby_jard/screens/variables_screen.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module RubyJard
-  module Screens
+  class Screens
+    ##
+    # Display the relevant variables and constants of current context, scopes
     class VariablesScreen < RubyJard::Screen
       TYPE_SYMBOLS = {
         # Intertal classes for those values may differ between Ruby versions
@@ -24,12 +26,21 @@ module RubyJard
       DEFAULT_TYPE_SYMBOL = :var
 
       KINDS = [
-        KIND_LOC = :local_variable,
-        KIND_INS = :instance_variable,
-        KIND_CON = :constant
+        KIND_LOC  = :local_variable,
+        KIND_INS  = :instance_variable,
+        KIND_CON  = :constant,
+        KIND_SELF = :self
       ].freeze
 
+      KIND_STYLES = {
+        KIND_LOC  => :local_variable,
+        KIND_INS  => :instance_variable,
+        KIND_CON  => :constant,
+        KIND_SELF => :constant
+      }.freeze
+
       KIND_PRIORITIES = {
+        KIND_SELF => 0,
         KIND_LOC => 1,
         KIND_INS => 2,
         KIND_CON => 3
@@ -47,7 +58,11 @@ module RubyJard
       end
 
       def build
-        variables = fetch_local_variables + fetch_instance_variables + fetch_constants
+        variables =
+          self_variable +
+          fetch_local_variables +
+          fetch_instance_variables +
+          fetch_constants
         variables = sort_variables(variables)
         @rows = variables.map do |variable|
           RubyJard::Row.new(
@@ -90,7 +105,7 @@ module RubyJard
         RubyJard::Span.new(
           margin_right: 1,
           content: variable[1].to_s,
-          styles: variable[0].to_sym
+          styles: KIND_STYLES[variable[0].to_sym]
         )
       end
 
@@ -112,8 +127,15 @@ module RubyJard
       end
 
       def span_inspection(variable)
+        inspection =
+          case variable[0]
+          when KIND_SELF
+            variable[2].to_s
+          else
+            variable[2].inspect
+          end
         # Hard limit: screen area
-        inspection = variable[2].inspect[0..@layout.height * @layout.width]
+        inspection = inspection[0..@layout.height * @layout.width]
         # TODO: This is just a workable. Should write a decorator to inspect objects accurately
         ["\n", "\r", "\r\n"].each do |esc|
           inspection.gsub!(esc, esc.inspect)
@@ -122,46 +144,35 @@ module RubyJard
           content: inspection,
           styles: :variable_inspection
         )
+      rescue StandardError
+        RubyJard::Span.new(
+          content: '<Fail to inspect>',
+          styles: :variable_inspection
+        )
       end
 
       private
 
-      def current_binding
-        RubyJard.current_session.frame._binding
-      end
-
-      def current_frame
-        RubyJard.current_session.frame
-      end
-
-      def current_frame_scope
-        RubyJard.current_session.backtrace[RubyJard.current_session.frame.pos][1]
-      end
-
-      def current_frame_scope_class
-        RubyJard.current_session.backtrace[RubyJard.current_session.frame.pos][2]
-      end
-
       def fetch_local_variables
-        variables = current_binding.local_variables
+        variables = @session.current_frame.frame_binding.local_variables
         # Exclude Pry's sticky locals
         pry_sticky_locals =
           if variables.include?(:pry_instance)
-            current_binding.local_variable_get(:pry_instance).sticky_locals.keys
+            @session.current_frame.frame_binding.local_variable_get(:pry_instance).sticky_locals.keys
           else
             []
           end
         variables -= pry_sticky_locals
         variables.map do |variable|
-          [KIND_LOC, variable, current_binding.local_variable_get(variable)]
+          [KIND_LOC, variable, @session.current_frame.frame_binding.local_variable_get(variable)]
         rescue NameError
           nil
         end.compact
       end
 
       def fetch_instance_variables
-        current_frame_scope.instance_variables.map do |variable|
-          [KIND_INS, variable, current_frame_scope.instance_variable_get(variable)]
+        @session.current_frame.frame_self.instance_variables.map do |variable|
+          [KIND_INS, variable, @session.current_frame.frame_self.instance_variable_get(variable)]
         rescue NameError
           nil
         end.compact
@@ -170,13 +181,14 @@ module RubyJard
       def fetch_constants
         # Filter out truly constants (CONSTANT convention) only
         constant_source =
-          if current_frame_scope_class&.singleton_class?
-            current_frame_scope
+          if @session.current_frame.frame_class&.singleton_class?
+            @session.current_frame.frame_self
           else
-            current_frame_scope_class
+            @session.current_frame.frame_class
           end
 
         return [] unless constant_source.respond_to?(:constants)
+        return [] if toplevel_binding?
 
         constants = constant_source.constants.select { |v| v.to_s.upcase == v.to_s }
         constants.map do |variable|
@@ -188,6 +200,18 @@ module RubyJard
         end.compact
       end
 
+      def toplevel_binding?
+        @session.current_frame.frame_self == TOPLEVEL_BINDING.receiver
+      rescue StandardError
+        false
+      end
+
+      def self_variable
+        [[KIND_SELF, :self, @session.current_frame.frame_self]]
+      rescue StandardError
+        []
+      end
+
       def sort_variables(variables)
         # Sort by kind
         # Sort by "internal" character so that internal variable is pushed down
@@ -219,8 +243,8 @@ module RubyJard
       def inline_tokens
         return @inline_tokens if defined?(@inline_tokens)
 
-        current_file = RubyJard.current_session.frame.file
-        current_line = RubyJard.current_session.frame.line
+        current_file = @session.current_frame.frame_file
+        current_line = @session.current_frame.frame_line
         source_decorator = RubyJard::Decorators::SourceDecorator.new(current_file, current_line, 1)
         _spans, tokens = loc_decorator.decorate(
           source_decorator.codes[current_line - source_decorator.window_start],
@@ -237,6 +261,7 @@ module RubyJard
 
         @inline_tokens
       end
+
       def loc_decorator
         @loc_decorator ||= RubyJard::Decorators::LocDecorator.new
       end
@@ -244,4 +269,4 @@ module RubyJard
   end
 end
 
-RubyJard::Screens.add_screen(:variables, RubyJard::Screens::VariablesScreen)
+RubyJard::Screens.add_screen('variables', RubyJard::Screens::VariablesScreen)

data/lib/ruby_jard/session.rb

@@ -11,17 +11,16 @@ module RubyJard
   # other processes. Therefore, an internal, jard-specific data mapping should
   # be built.
   class Session
-    attr_reader :backtrace, :frame, :contexts, :current_context
+    attr_accessor :threads, :current_frame, :current_backtrace
 
     def initialize(options = {})
       @options = options
-
-      @backtrace = []
-      @frame = nil
-      @contexts = []
-
       @started = false
       @session_lock = Mutex.new
+
+      @current_frame = nil
+      @current_backtrace = []
+      @threads = []
     end
 
     def start
@@ -54,13 +53,23 @@ module RubyJard
       start unless started?
 
       Byebug.attach
-      Byebug.current_context.step_out(2, false)
+      Byebug.current_context.step_out(3, true)
     end
 
     def update
-      @backtrace = Byebug.current_context.backtrace
-      @frame = Byebug.current_context.frame
-      @contexts = Byebug.contexts
+      current_context = Byebug.current_context
+      @current_frame = RubyJard::Frame.new(current_context, current_context.frame.pos)
+      @current_backtrace = current_context.backtrace.map.with_index do |_frame, index|
+        RubyJard::Frame.new(current_context, index)
+      end
+      @threads =
+        Byebug
+        .contexts
+        .reject(&:ignored?)
+        .reject { |c| c.thread.name.to_s =~ /<<Jard:.*>>/ }
+        .map do |context|
+          RubyJard::Frame.new(context, 0)
+        end
     end
 
     def lock

data/lib/ruby_jard/span.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module RubyJard
+  ##
+  # Smallest unit of texts. A span includes content, margin, and styles of a particular
+  # text chunk. All decorators and presenters return single/a list of spans.
   class Span
     extend Forwardable
 

data/lib/ruby_jard/templates/layout_template.rb

@@ -18,7 +18,7 @@ module RubyJard
         min_width: nil, min_height: nil,
         height: nil, width: nil,
         children: [],
-        fill_width: nil, fill_height: nil
+        fill_width: true, fill_height: true
       )
         @height_ratio = height_ratio
         @width_ratio = width_ratio

data/lib/ruby_jard/templates/screen_template.rb

@@ -9,7 +9,7 @@ module RubyJard
       attr_reader :screen, :row_template, :height_ratio, :width_ratio,
                   :min_width, :min_height,
                   :height, :width,
-                  :fill_width, :fill_height
+                  :adjust_mode
 
       def initialize(
         screen: nil,
@@ -17,7 +17,7 @@ module RubyJard
         height_ratio: nil, width_ratio: nil,
         min_width: nil, min_height: nil,
         height: nil, width: nil,
-        fill_width: nil, fill_height: nil
+        adjust_mode: nil
       )
         @screen = screen
         @row_template = row_template
@@ -27,8 +27,7 @@ module RubyJard
         @min_height = min_height
         @height = height
         @width = width
-        @fill_width = fill_width
-        @fill_height = fill_height
+        @adjust_mode = adjust_mode
       end
     end
   end

data/lib/ruby_jard/version.rb

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

data/ruby_jard.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'byebug', '~> 11.1.0'
+  spec.add_runtime_dependency 'byebug', '>= 9.1', '< 12.0'
   spec.add_runtime_dependency 'pry', '~> 0.13.0'
   spec.add_runtime_dependency 'tty-screen', '~> 0.8.1'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: ruby_jard
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Minh Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +67,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -75,8 +84,12 @@ files:
 - _config.yml
 - bin/console
 - docs/_config.yml
+- docs/color_schemes/256-light.png
 - docs/color_schemes/256.png
 - docs/color_schemes/deep-space.png
+- docs/color_schemes/gruvbox.png
+- docs/color_schemes/one-half-dark.png
+- docs/color_schemes/one-half-light.png
 - docs/demo.png
 - docs/guide-ui.png
 - docs/index.md
@@ -102,17 +115,27 @@ files:
 - lib/ruby_jard/color_scheme.rb
 - lib/ruby_jard/color_schemes.rb
 - lib/ruby_jard/color_schemes/256_color_scheme.rb
+- lib/ruby_jard/color_schemes/256_light_color_scheme.rb
 - lib/ruby_jard/color_schemes/deep_space_color_scheme.rb
+- lib/ruby_jard/color_schemes/gruvbox_color_scheme.rb
+- lib/ruby_jard/color_schemes/one_half_dark_color_scheme.rb
+- lib/ruby_jard/color_schemes/one_half_light_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/exit_command.rb
 - lib/ruby_jard/commands/frame_command.rb
+- lib/ruby_jard/commands/jard/color_scheme_command.rb
+- lib/ruby_jard/commands/jard/hide_command.rb
+- lib/ruby_jard/commands/jard/output_command.rb
+- lib/ruby_jard/commands/jard/show_command.rb
+- lib/ruby_jard/commands/jard_command.rb
 - lib/ruby_jard/commands/list_command.rb
 - lib/ruby_jard/commands/next_command.rb
 - 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/commands/validation_helpers.rb
 - lib/ruby_jard/config.rb
 - lib/ruby_jard/console.rb
 - lib/ruby_jard/control_flow.rb
@@ -121,24 +144,30 @@ files:
 - lib/ruby_jard/decorators/loc_decorator.rb
 - lib/ruby_jard/decorators/path_decorator.rb
 - lib/ruby_jard/decorators/source_decorator.rb
+- lib/ruby_jard/frame.rb
 - lib/ruby_jard/key_binding.rb
 - lib/ruby_jard/key_bindings.rb
 - lib/ruby_jard/keys.rb
 - lib/ruby_jard/layout.rb
 - lib/ruby_jard/layout_calculator.rb
-- lib/ruby_jard/layouts/narrow_layout.rb
+- lib/ruby_jard/layout_picker.rb
+- lib/ruby_jard/layouts.rb
+- lib/ruby_jard/layouts/narrow_horizontal_layout.rb
+- lib/ruby_jard/layouts/narrow_vertical_layout.rb
+- lib/ruby_jard/layouts/tiny_layout.rb
 - lib/ruby_jard/layouts/wide_layout.rb
+- lib/ruby_jard/pager.rb
 - lib/ruby_jard/repl_processor.rb
 - lib/ruby_jard/repl_proxy.rb
 - lib/ruby_jard/row.rb
 - lib/ruby_jard/row_renderer.rb
 - lib/ruby_jard/screen.rb
+- lib/ruby_jard/screen_adjuster.rb
 - lib/ruby_jard/screen_drawer.rb
 - lib/ruby_jard/screen_manager.rb
 - lib/ruby_jard/screen_renderer.rb
 - lib/ruby_jard/screens.rb
 - lib/ruby_jard/screens/backtrace_screen.rb
-- lib/ruby_jard/screens/empty_screen.rb
 - lib/ruby_jard/screens/menu_screen.rb
 - lib/ruby_jard/screens/source_screen.rb
 - lib/ruby_jard/screens/threads_screen.rb

data/lib/ruby_jard/commands/color_scheme_command.rb

@@ -1,42 +0,0 @@
-# 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)