scryglass 0.1.0

data/lib/scryglass/tree_panel.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Scryglass
+  class TreePanel < Scryglass::ViewPanel
+    using ClipStringRefinement
+    using AnsilessStringRefinement
+
+    def slide_view_to_cursor
+      cursor_tracking = Scryglass.config.cursor_tracking
+
+      current_ro = scry_session.current_ro
+
+      ## Here we calculate the ro_in_center_of_view:
+      visible_ros_from_center = (body_screen_height / 2)
+      scanning_ro = top_visible_ro_of_tree_view
+      visible_ros_from_center.times do
+        next_visible_ro = scanning_ro.next_visible_ro_down
+        scanning_ro = next_visible_ro if next_visible_ro
+      end
+      ro_in_center_of_view = scanning_ro
+
+      ## We don't need to do anything if current_ro is already in the center:
+      relative_index = current_ro.index - ro_in_center_of_view.index
+      return if relative_index.zero?
+
+      ## Establish the number of visible ros between current_ro and center point
+      index_span = [ro_in_center_of_view.index, current_ro.index]
+      ros_between_them = scry_session.all_ros[index_span.min...index_span.max]
+      visible_count_between_them = ros_between_them.count(&:visible?)
+
+      direction = :up   if relative_index.negative?
+      direction = :down if relative_index.positive?
+
+      ## If view movement is needed, and how far, depends on the tracking config
+      case cursor_tracking
+      when :flexible_range
+        flex_range = body_screen_height / 3
+        if visible_count_between_them >= flex_range
+          distance_to_flex_range = visible_count_between_them - flex_range
+          move_view_up(distance_to_flex_range)   if direction == :up
+          move_view_down(distance_to_flex_range) if direction == :down
+        end
+      when :dead_center
+        move_view_up(visible_count_between_them)   if direction == :up
+        move_view_down(visible_count_between_them) if direction == :down
+      end
+    end
+
+    private
+
+    def uncut_body_string
+      body_array_from_ro(top_visible_ro_of_tree_view).join("\n")
+    end
+
+    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
+      end
+      header_string
+    end
+
+    def visible_body_slice(uncut_body_string)
+      _screen_height, screen_width = $stdout.winsize
+
+      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.
+      end
+
+      sliced_lines.join("\n")
+    end
+
+    def recalculate_y_boundaries
+      self.y_boundaries = 0...scry_session.all_ros.select(&:visible?).count
+    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
+      max_line_length = [length_of_longest_line, screen_width].max
+      self.x_boundaries = 0...max_line_length
+    end
+
+    def top_visible_ro_of_tree_view
+      top_ro = scry_session.top_ro
+
+      scanning_ro = top_ro
+      top_ros = [scanning_ro]
+      until top_ros.count > current_view_coords[:y] || scanning_ro.next_visible_ro_down.nil? #I shouldn't need this?
+        scanning_ro = scanning_ro.next_visible_ro_down
+        top_ros << scanning_ro
+      end
+      top_ros.last
+    end
+
+    def body_array_from_ro(ro)
+      y, _x = $stdout.winsize
+      non_header_view_size = y - visible_header_string.split("\n").count
+      display_array = []
+
+      scanning_ro = ro
+      display_array << scanning_ro.to_s
+
+      while scanning_ro.next_visible_ro_down && display_array.count < non_header_view_size
+        scanning_ro = scanning_ro.next_visible_ro_down
+        display_array << scanning_ro.to_s
+      end
+
+      display_array
+    end
+  end
+end

data/lib/scryglass/version.rb

@@ -0,0 +1,3 @@
+module Scryglass
+  VERSION = "0.1.0"
+end

data/lib/scryglass/view_panel.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Scryglass
+  class ViewPanel
+    using AnsilessStringRefinement
+
+    attr_accessor :current_view_coords, :x_boundaries, :y_boundaries
+    attr_accessor :scry_session
+
+    def initialize(scry_session:)
+      self.scry_session = scry_session
+      self.current_view_coords = { x: 0, y: 0 }
+
+      recalculate_boundaries
+    end
+
+    def ensure_correct_view_coords
+      _screen_height, screen_width = $stdout.winsize
+      top_boundary    = y_boundaries.min
+      bottom_boundary = y_boundaries.max
+      left_boundary   = x_boundaries.min
+      right_boundary  = x_boundaries.max
+
+      ## Snap View, Vertical
+      screen_bottom_index = (body_screen_height - 1)
+      top_edge_of_view = current_view_coords[:y]
+      bottom_edge_of_view = current_view_coords[:y] + screen_bottom_index
+      if bottom_edge_of_view > bottom_boundary
+        current_view_coords[:y] = [bottom_boundary - screen_bottom_index, 0].max
+      elsif top_edge_of_view < top_boundary
+        current_view_coords[:y] = top_boundary
+      end
+
+      ## Snap View, Horizontal
+      screen_right_edge_index = (screen_width - 1)
+      left_edge_of_view = current_view_coords[:x]
+      right_edge_of_view = current_view_coords[:x] + screen_right_edge_index
+      if !x_boundaries.include?(left_edge_of_view)
+        current_view_coords[:x] = left_boundary
+      elsif !x_boundaries.include?(right_edge_of_view)
+        current_view_coords[:x] = right_boundary - screen_right_edge_index
+      end
+    end
+
+    def move_view_up(distance)
+      current_view_coords[:y] -= distance
+    end
+
+    def move_view_down(distance)
+      current_view_coords[:y] += distance
+    end
+
+    def move_view_left(distance)
+      current_view_coords[:x] -= distance
+    end
+
+    def move_view_right(distance)
+      current_view_coords[:x] += distance
+    end
+
+    def screen_string
+      Hexes.opacify_screen_string(visible_header_string + "\n" + visible_body_string)
+    end
+
+    def recalculate_boundaries
+      recalculate_y_boundaries
+      recalculate_x_boundaries
+    end
+
+    def visible_header_string
+      visible_header_slice(uncut_header_string)
+    end
+
+    def visible_body_string
+      visible_body_slice(uncut_body_string)
+    end
+
+    private
+
+    def visible_header_slice(uncut_header_string)
+      Hexes.simple_screen_slice(uncut_header_string)
+    end
+
+    def body_screen_height
+      screen_height, _screen_width = $stdout.winsize
+      # It would be more efficient, but technically overall less accurate, to
+      #   avoid recalculating visible_header_string here (and everywhere that calls this)
+      screen_height - visible_header_string.split("\n").count
+    end
+  end
+end

data/lib/scryglass/view_wrapper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Scryglass
+  class ViewWrapper
+    attr_accessor :model, :string, :string_lambda
+
+    def initialize(model, string: nil, string_lambda: nil)
+      unless !!string ^ !!string_lambda
+        raise ArgumentError, 'Must provide either `string` or `string_lambda`, ' \
+                             'but not both.'
+      end
+
+      self.model = model
+      self.string = string
+      self.string_lambda = string_lambda
+    end
+
+    def to_s
+      return string if string
+      return string_lambda.call(model) if string_lambda
+    end
+  end
+end

data/scryglass.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scryglass/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scryglass"
+  spec.version       = Scryglass::VERSION
+  spec.authors       = ["Gavin Myers"]
+  spec.email         = ["gavin.myers@annkissam.com"]
+
+  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' \
+    "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!'
+  spec.homepage      = "https://github.com/annkissam/scryglass"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.4.4'
+
+  spec.add_development_dependency 'activesupport', '~> 5.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: scryglass
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gavin Myers
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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.
+
+  Objects and child objects can also be inspected through a variety of display lenses, returned directly to the console, and more!
+email:
+- gavin.myers@annkissam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example_config.rb
+- lib/example_material.rb
+- lib/hexes.rb
+- lib/prog.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/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/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: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Scryglass is a ruby console tool for visualizing and actively exploring objects.
+test_files: []