terminal-scroll-area 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40c9d9bbc20a2507effd83bcb58b1079d900fc44a7d06ca84353ff1d9aa197b2
+  data.tar.gz: 7d86e009629484903f837f0546d93dea58ad0b7753aeff9fa03012a89f7e83a9
+SHA512:
+  metadata.gz: c23164544666966a7b5ba12aca35fe911de61a084df75bb1ea620d1d8d93aab8314293c633e3725af939dfe00084b575ded9d676e71d37f2ab1bee77e0ec4488
+  data.tar.gz: 59cfee4ad6c585515b44e897f8047e5fd282112c950c040f9db283b02bb21feca9e85ec78a63f9aab6d12f5e5d66227ca65fd0b0b1a222b8d49284b26dc60361

data/README.md

@@ -0,0 +1,82 @@
+# Terminal Scroll Area
+
+This gem lets the user display large text on terminal by creating a scroll area in which only a specified portion of the text is displayed at a time. This portion can be moved to reveal other parts of the text, analogous to a GUI scroll area, or a more general purpose pager. This gem is useful when your program needs to display a large amount of text that may not fit into the screen.
+
+The `ScrollArea` class, which is not interactive, does not use Curses or a similar screen management library. The `InteractiveScrollArea` class does not rely on the Curses library and instead uses the [TTY toolkit](https://github.com/piotrmurach/tty), which has cross platform support and support for many types of terminals/terminal emulators. Therefore this gem should also have the same level of support.
+
+# Usage
+
+## `ScrollArea` class
+
+- Simple scroll area which lets you programmatically scroll the content in all directions.
+- Initialise:
+
+```rb
+# Only display 5 lines at a time with
+# 5 characters in each line.
+width = 5
+height = 5
+scroll = ScrollArea.new(width, height)
+```
+
+- Set the content that the scroll area will contain:
+
+```rb
+# Set content all at once:
+scroll.content = "some text"
+
+# Or use add_string/add_line:
+scroll.add_string("some string")
+
+# Same as add_string, but adds a newline
+# after the string
+scroll.add_line("some line")
+```
+
+- Render scroll area to get the portion of the entire content which is in view:
+
+```rb
+# Render and print the currently visible
+# portion of the text.
+print(scroll.render)
+```
+
+- Scroll in all directions to reveal other portions:
+
+```rb
+# also available: 
+# - scroll_down
+# - scroll_left
+# - scroll_right
+scroll.scroll_up
+```
+
+- Scroll area lets you access some values you may find useful:
+
+```rb
+# The starting coordinates of the window which is displayed.
+scroll.start_x
+scroll.start_y
+
+# The ending coordinates of the window which is displayed.
+scroll.end_x
+scroll.end_y
+```
+
+## `InteractiveScrollArea`
+
+- Regular `ScrollArea` lets you scroll the content with `scroll_<direction>` methods. `InteractiveScrollArea` displays an interactive scroll area where the user can use arrow keys to control scrolling of the content (e.g. up arrow scrolls up, etc.).
+- This class will automatically print a new rendering of the area after user has triggered a scroll event by pressing a key. The previously printed rendering is removed and the updated rendering is printed in the same area, thereby giving the feeling of interactivity.
+
+```rb
+width = 5
+height = 5
+interactive = InteractiveScrollArea(width, height)
+
+# add_string and add_line are also available.
+interactive.content = "some text"
+
+# Starts a loop, allowing user to use arrow keys to
+# scroll the content. Press Ctrl + C to exit.
+interactive.scroll
+```

data/lib/terminal-scroll-area.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'terminal-scroll-area/scroll_area'
+require_relative 'terminal-scroll-area/interactive_scroll_area'

data/lib/terminal-scroll-area/interactive_scroll_area.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'tty-reader'
+require 'tty-cursor'
+require_relative 'scroll_area'
+
+# Interactice scroll area which scrolls and reprints
+# the content in response to user pressing arrow keys.
+class InteractiveScrollArea
+  attr_reader :content
+  attr_accessor :width, :height, :scroll_area
+
+  def initialize(width, height)
+    @width = width
+    @height = height
+
+    @scroll_area = ScrollArea.new(@width, @height)
+
+    @reader = TTY::Reader.new(interrupt: :exit)
+    @reader.subscribe(self)
+  end
+
+  def scroll
+    print_in_place(@scroll_area.render)
+    TTY::Cursor.invisible do
+      loop do
+        @reader.read_keypress
+      end
+    end
+  end
+
+  def content=(new_content)
+    @scroll_area.content = new_content
+  end
+
+  def add_string(string)
+    @scroll_area.add_string(string)
+  end
+
+  def add_line(line)
+    @scroll_area.add_line(line)
+  end
+
+  def keydown(_event)
+    @scroll_area.scroll_down
+    print_in_place(@scroll_area.render)
+  end
+
+  def keyup(_event)
+    @scroll_area.scroll_up
+    print_in_place(@scroll_area.render)
+  end
+
+  def keyright(_event)
+    @scroll_area.scroll_right
+    print_in_place(@scroll_area.render)
+  end
+
+  def keyleft(_event)
+    @scroll_area.scroll_left
+    print_in_place(@scroll_area.render)
+  end
+
+  private
+
+  def print_in_place(text)
+    cursor = TTY::Cursor
+
+    # Scrolling down is needed if there are less lines under
+    # the terminal prompt than the content height. Or else, clearing
+    # lines upwards by the content height will remove the prompt as well.
+    in_place = TTY::Cursor.scroll_down * (@height - 1)
+    in_place << cursor.clear_lines(@height, :up)
+    in_place << cursor.save
+    in_place << text
+    in_place << cursor.restore
+
+    print(in_place)
+  end
+end

data/lib/terminal-scroll-area/scroll_area.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Scroll area which only shows a specific area of the content
+# it holds at a time. Able to scroll area in all directions
+# to show a different area of the content.
+class ScrollArea
+  attr_reader :start_x, :start_y, :content
+  attr_accessor :width, :height
+
+  def initialize(width, height)
+    @width = width
+    @height = height
+    @start_x = 0
+    @start_y = 0
+    @content = ''
+    update_content_dimensions
+  end
+
+  def render
+    crop_text(@content, @start_x, @start_y, end_x, end_y)
+  end
+
+  def content=(new_content)
+    @content = new_content
+    update_content_dimensions
+  end
+
+  def add_string(string)
+    self.content += string
+  end
+
+  def add_line(line)
+    self.content += "#{line}\n"
+  end
+
+  def scroll_up
+    return if @line_count < @height
+
+    @start_y -= 1 if @start_y.positive?
+  end
+
+  def scroll_down
+    return if @line_count < @height
+
+    @start_y += 1 if end_y < (@line_count - 1)
+  end
+
+  def scroll_left
+    return if @col_count < @width
+
+    @start_x -= 1 if @start_x >= 1
+  end
+
+  def scroll_right
+    return if @col_count < @width
+
+    @start_x += 1 if end_x < (@col_count - 1)
+  end
+
+  def end_x
+    @start_x + (@width - 1)
+  end
+
+  def end_y
+    @start_y + (@height - 1)
+  end
+
+  private
+
+  def update_content_dimensions
+    @line_count = @content.split("\n").length
+    @col_count = @content.split("\n").map(&:length).max
+  end
+
+  def crop_text(text, x_start, y_start, x_end, y_end)
+    return '' if x_start >= @col_count || y_start >= @line_count
+
+    lines = text.split("\n")
+    lines = lines[y_start..y_end]
+    lines = lines.map { |line| line[x_start..x_end] }
+    lines.join("\n")
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: terminal-scroll-area
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilkut Kutlar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: tty-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description: This gem lets user display large text on terminal by creating a scroll
+  area in which only a specified portion of the text is displayed at a time. This
+  portion can be moved to reveal other parts of the text, analogous to a GUI scroll
+  area.
+email:
+- ilkutkutlar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/terminal-scroll-area.rb
+- lib/terminal-scroll-area/interactive_scroll_area.rb
+- lib/terminal-scroll-area/scroll_area.rb
+homepage: https://github.com/ilkutkutlar/terminal-scroll-area
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Scroll area to display large text on terminal
+test_files: []