scryglass 1.1.0 → 2.0.0

data/lib/scryglass/session_manager.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Scryglass
+  class SessionManager
+    using AnsilessStringRefinement
+    using ArrayFitToRefinement
+    using ClipStringRefinement
+
+    attr_accessor :scry_sessions
+    attr_accessor :binding_trackers_by_receiver
+    attr_accessor :current_binding_receiver
+    attr_accessor :unused_tab_icons
+
+    SESSION_CLOSED_MESSAGE = '(Exited scry! Resume session with just `scry`)'
+
+    NAMED_VARIABLES_MESSAGE = "\nCustom instance variables:"
+
+    def initialize
+      self.scry_sessions = []
+      self.binding_trackers_by_receiver = {}
+      self.current_binding_receiver = nil
+
+      alphabet = ('A'..'Z').to_a
+      digits = ('2'..'9').to_a
+      self.unused_tab_icons =
+        alphabet + digits.product(alphabet).map { |pair| pair.reverse.join }
+    end
+
+    # For consistency, we reference the same binding tracker (and thus
+    #   console_binding) every time for a given receiver.
+    def track_binding!(console_binding)
+      self.current_binding_receiver = console_binding.receiver
+      self.binding_trackers_by_receiver[current_binding_receiver] ||=
+        Scryglass::BindingTracker.new(console_binding: console_binding)
+    end
+
+    def <<(session)
+      set_current_session!(session)
+      session.session_manager = self
+      session.tab_icon = unused_tab_icons.shift
+      # TODO: name that session?
+      self.scry_sessions << session
+    end
+
+    def session_tabs_bar
+      _screen_height, screen_width = $stdout.winsize
+
+      tab_indicators = scry_sessions.map do |session|
+        session.tab_string.clip_at(screen_width / 3, ignore_ansi_codes: true)
+      end
+
+      compressed_tab_indicators = tab_indicators.compress_to(screen_width, ignore_ansi_codes: true)
+
+      packed_tabs = compressed_tab_indicators.join
+      pad_length = screen_width - packed_tabs.ansiless_length
+      packed_tabs + ('#' * pad_length) + "\n" + ('#' * screen_width)
+    end
+
+    def current_session
+      scry_sessions.find(&:session_is_current)
+    end
+
+    def current_console_binding
+      current_binding_tracker.console_binding
+    end
+
+    def run_scry_ui
+      while current_session
+        session_return = current_session.run_scry_ui
+
+        case current_session.signal_to_manager
+        when :return
+          visually_close_ui
+          return session_return
+        when :quit
+          visually_close_ui
+          return
+        when :quit_from_help
+          visually_close_ui(floor_the_cursor: true)
+          return
+        when :delete
+          old_session = current_session
+          visually_close_ui
+          if scry_sessions.index(old_session) > 0
+            change_session_left!
+          else
+            change_session_right!
+          end
+          delete_session!(old_session)
+        when :change_session_left # and if there's only one session?
+          change_session_left!
+        when :change_session_right # and if there's only one session?
+          change_session_right!
+        end
+      end
+    end
+
+    def current_binding_tracker
+      binding_trackers_by_receiver[current_binding_receiver]
+    end
+
+    def current_user_named_variables
+      current_binding_tracker.user_named_variables
+    end
+
+    private
+
+    def visually_close_ui(floor_the_cursor: false)
+      _screen_height, screen_width = $stdout.winsize
+      current_session.set_console_cursor_below_content(
+        floor_the_cursor: floor_the_cursor
+      )
+      puts '·' * screen_width, "\n"
+      puts SESSION_CLOSED_MESSAGE
+      puts user_named_variables_outro if current_user_named_variables.any?
+    end
+
+    def user_named_variables_outro
+      puts NAMED_VARIABLES_MESSAGE
+      puts current_user_named_variables.map { |s| "  #{s}\n" }
+    end
+
+    def delete_session!(session)
+      scry_sessions.delete(session)
+    end
+
+    def session_right_of(session)
+      return scry_sessions.first if session == scry_sessions.last
+
+      index_of_session = scry_sessions.index(session)
+      scry_sessions[index_of_session + 1]
+    end
+
+    def session_left_of(session)
+      index_of_session = scry_sessions.index(session)
+      scry_sessions[index_of_session - 1]
+    end
+
+    def change_session_left!
+      next_session = session_left_of(current_session)
+      set_current_session!(next_session)
+    end
+
+    def change_session_right!
+      next_session = session_right_of(current_session)
+      set_current_session!(next_session)
+    end
+
+    def set_current_session!(session)
+      scry_sessions.each { |session| session.session_is_current = false }
+      session.session_is_current = true
+    end
+  end
+end

data/lib/scryglass/tree_panel.rb

@@ -71,7 +71,9 @@ module Scryglass
         last_search_message = " Last search: #{last_search}"
       end
       if [special_targets_message, number_to_move_message, last_search].none?
-        help_key_reminder = "Press '?' for controls"
+        controls_key = Scryglass::Session::KEY_MAP[:control_screen]
+        help_key_reminder = "Press '#{controls_key}' for controls      " \
+                            "(v#{Scryglass::VERSION})"
       end
 
       tree_header_items = [
@@ -91,27 +93,29 @@ module Scryglass
 
       split_lines = uncut_body_string.split("\n")
       sliced_lines = split_lines.map do |string|
-        ansi_length = string.length - string.ansiless.length
-        slice_length = screen_width + ansi_length
-        string[current_view_coords[:x], slice_length] || '' # If I don't want to
-        #   opacify here, I need to account for nils when the view is fully
-        #   beyond the shorter lines.
+        string.ansi_slice(current_view_coords[:x], screen_width) || '' # If I
+        #   don't want to opacify here, I need to account for nils when the view
+        #   is fully beyond the shorter lines.
       end
 
-      sliced_lines.join("\n")
+      sliced_lines
     end
 
     def recalculate_y_boundaries
-      self.y_boundaries = 0...scry_session.all_ros.select(&:visible?).count
+      number_of_lines = scry_session.all_ros.select(&:visible?).count
+      preview_row = 1
+      self.y_boundaries = 0...(number_of_lines + preview_row)
     end
 
     def recalculate_x_boundaries
       _screen_height, screen_width = $stdout.winsize
 
       split_lines = uncut_body_string.split("\n")
-      length_of_longest_line = split_lines.map(&:length).max
+      length_of_longest_line = split_lines.map(&:ansiless_length).max
       max_line_length = [length_of_longest_line, screen_width].max
-      self.x_boundaries = 0...max_line_length
+      preview_column = 1
+
+      self.x_boundaries = 0...(max_line_length + preview_column)
     end
 
     def top_visible_ro_of_tree_view

data/lib/scryglass/version.rb

@@ -1,3 +1,3 @@
 module Scryglass
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/scryglass/view_panel.rb

@@ -72,11 +72,53 @@ module Scryglass
     end
 
     def visible_body_string
-      visible_body_slice(uncut_body_string)
+      _screen_height, screen_width = $stdout.winsize
+      screen_bottom_index = (body_screen_height - 1)
+      screen_right_edge_index = (screen_width - 1)
+
+      body_array = visible_body_slice(uncut_body_string)
+
+      marked_body_array =
+        body_array.map do |line|
+          last_visible_char_of_line =
+            line.ansiless_pick(screen_right_edge_index)
+
+          if last_visible_char_of_line
+            line.ansiless_set!(screen_right_edge_index, '·')
+          end
+
+          line
+        end
+
+      bottom_edge_line = marked_body_array[screen_bottom_index]
+
+      if bottom_edge_line
+        bottom_edge_line_has_content =
+          !bottom_edge_line.ansiless.tr(' ·', '').empty?
+
+        if bottom_edge_line_has_content
+          bottom_edge_line_dot_preview =
+            bottom_edge_line.ansiless.gsub(/[^\s]/, '·')
+        end
+
+        marked_body_array[screen_bottom_index] =
+          bottom_edge_line_dot_preview ||
+          bottom_edge_line_default_truncation_dots
+      end
+
+      marked_body_array.join("\n")
     end
 
     private
 
+    def bottom_edge_line_default_truncation_dots
+      _screen_height, screen_width = $stdout.winsize
+      dots = '· ··  ···   ··········   ···  ·· ·'
+      pad_length = (screen_width - dots.length) / 2
+
+      (' ' * pad_length) + dots
+    end
+
     def visible_header_slice(uncut_header_string)
       Hexes.simple_screen_slice(uncut_header_string)
     end

data/scryglass.gemspec

@@ -43,5 +43,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 12.0'
-
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_runtime_dependency 'amazing_print'
+  spec.add_runtime_dependency 'method_source'
+  spec.add_runtime_dependency 'binding_of_caller'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scryglass
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Gavin Myers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Scryglass is a ruby console tool for visualizing and actively exploring objects (large, nested, interrelated, or unfamiliar). You can navigate nested arrays, hashes, instance variables, ActiveRecord relations, and unknown Enumerable types like anexpandable/collapsable file tree in an intuitive UI.
 
@@ -50,6 +106,7 @@ extra_rdoc_files: []
 files:
 - ".DS_Store"
 - ".gitignore"
+- ".irbrc"
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
@@ -63,18 +120,19 @@ files:
 - lib/example_material.rb
 - lib/hexes.rb
 - lib/prog.rb
-- lib/refinements/ansi_slice_string_refinement.rb
 - lib/refinements/ansiless_string_refinement.rb
 - lib/refinements/array_fit_to_refinement.rb
 - lib/refinements/clip_string_refinement.rb
 - lib/refinements/constant_defined_string_refinement.rb
 - lib/scryglass.rb
+- lib/scryglass/binding_tracker.rb
 - lib/scryglass/config.rb
 - lib/scryglass/lens_helper.rb
 - lib/scryglass/lens_panel.rb
 - lib/scryglass/ro.rb
 - lib/scryglass/ro_builder.rb
 - lib/scryglass/session.rb
+- lib/scryglass/session_manager.rb
 - lib/scryglass/tree_panel.rb
 - lib/scryglass/version.rb
 - lib/scryglass/view_panel.rb

data/lib/refinements/ansi_slice_string_refinement.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-module AnsiSliceStringRefinement
-  refine String do
-    ## (This really might not do what you expect if your string has (or you are
-    ##   printing) unescaped newlines).
-    def ansi_slice(target_range)
-      unless target_range.is_a?(Range)
-        raise ArgumentError, 'ansi_slice takes a Range as its argument!'
-      end
-      if target_range.min.negative? || target_range.max.negative?
-        raise ArgumentError, 'Range argument must be entirely positive!'
-      end
-
-      return self[target_range] if (self =~ /\e\[[\d\;]*m/).nil? # Just quick
-
-      mock_index = 0 # A scanning index that *doesn't* count ANSI codes
-      result_string_array = []
-
-      ansi_string_breakout.each do |char|
-        char_is_ansi_escape_code = char.is_ansi_escape_code?
-        within_target_range =
-          target_range.include?(mock_index)
-        # char_is_applicable_ansi_code =
-          # (char_is_ansi_escape_code && mock_index <= target_range.max)
-
-        if within_target_range || char_is_ansi_escape_code
-          result_string_array << char
-        end
-
-        mock_index += 1 unless char_is_ansi_escape_code
-      end
-
-      result_string_array.join('')
-    end
-
-    ## Splits string into characters, with each ANSI escape code being its own
-    ##   grouped item, like so:
-    ##     irb> "PLAIN\e[32mCOLOR\e[0mPLAIN".ansi_string_breakout
-    ##     => ["P", "L", "A", "I", "N", "\e[32m", "C", "O", "L", "O", "R",
-    ##         "\e[0m", "P", "L", "A", "I", "N"]
-    def ansi_string_breakout
-      breakout_array = []
-      working_self = self.dup
-
-      while working_self[0]
-        if (working_self =~ /\e\[[\d\;]*m/) == 0 # if begins with
-          end_of_escape_code = (working_self.index('m'))
-          leading_escape_code = working_self[0..end_of_escape_code]
-          breakout_array << leading_escape_code
-          working_self = working_self[(end_of_escape_code + 1)..-1]
-        else
-          leading_character = working_self[0]
-          breakout_array << leading_character
-          working_self = working_self[1..-1]
-        end
-      end
-
-      breakout_array
-    end
-
-    def is_ansi_escape_code?
-      (self =~ /^\e\[[\d\;]*m$/) == 0
-    end
-  end
-end