scryglass 0.1.0 → 2.0.1

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

@@ -4,6 +4,7 @@ module Scryglass
   class TreePanel < Scryglass::ViewPanel
     using ClipStringRefinement
     using AnsilessStringRefinement
+    using ArrayFitToRefinement
 
     def slide_view_to_cursor
       cursor_tracking = Scryglass.config.cursor_tracking
@@ -54,13 +55,37 @@ module Scryglass
 
     def uncut_header_string
       _screen_height, screen_width = $stdout.winsize
-      header_string = "Press '?' for controls\n".rjust(screen_width, ' ') +
-                      '·' * screen_width
-      if scry_session.special_command_targets.any?
-        special_targets_message = "  (Next command will apply to all selected rows)"
-        header_string[0...special_targets_message.length] = special_targets_message
+      dotted_line = '·' * screen_width
+
+      number_to_move          = scry_session.number_to_move
+      last_search             = scry_session.last_search
+      special_command_targets = scry_session.special_command_targets
+
+      if special_command_targets.any?
+        special_targets_message = "(Next command will apply to all (#{special_command_targets.count}) selected rows)"
+      end
+      if !number_to_move.empty?
+        number_to_move_message = " Move distance: #{number_to_move}"
+      end
+      if last_search
+        last_search_message = " Last search: #{last_search}"
+      end
+      if [special_targets_message, number_to_move_message, last_search].none?
+        controls_key = Scryglass::Session::KEY_MAP[:control_screen]
+        help_key_reminder = "Press '#{controls_key}' for controls      " \
+                            "(v#{Scryglass::VERSION})"
       end
-      header_string
+
+      tree_header_items = [
+        special_targets_message,
+        last_search_message,
+        number_to_move_message,
+        help_key_reminder
+      ]
+
+      fit_tree_header_array = tree_header_items.fit_to(screen_width)
+
+      fit_tree_header_array.join('') + "\n" + dotted_line
     end
 
     def visible_body_slice(uncut_body_string)
@@ -68,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 = "0.1.0"
+  VERSION = "2.0.1"
 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

@@ -8,13 +8,14 @@ Gem::Specification.new do |spec|
   spec.version       = Scryglass::VERSION
   spec.authors       = ["Gavin Myers"]
   spec.email         = ["gavin.myers@annkissam.com"]
+  spec.licenses      = ['MIT']
 
   spec.summary       = 'Scryglass is a ruby console tool for visualizing ' \
     'and actively exploring objects.'
   spec.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 an' \
+    'ActiveRecord relations, and unknown Enumerable types like an ' \
     "expandable/collapsable file tree in an intuitive UI.\n\n" \
     'Objects and child objects can also be inspected through a variety of ' \
     'display lenses, returned directly to the console, and more!'
@@ -38,9 +39,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4.4'
+  spec.required_ruby_version = '>= 2.5.3'
 
-  spec.add_development_dependency 'activesupport', '~> 5.0'
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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,59 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: scryglass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Gavin Myers
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-rescue
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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: '10.0'
+        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.
+  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 an expandable/collapsable file tree in an intuitive UI.
 
   Objects and child objects can also be inspected through a variety of display lenses, returned directly to the console, and more!
 email:
@@ -62,8 +104,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
+- ".irbrc"
 - ".tool-versions"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -80,22 +125,25 @@ files:
 - 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
 - lib/scryglass/view_wrapper.rb
 - scryglass.gemspec
 homepage: https://github.com/annkissam/scryglass
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -103,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.4
+      version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -111,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Scryglass is a ruby console tool for visualizing and actively exploring objects.
 test_files: []