remedy 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2efe0ed0180c60202b73b0cf9f0fce46b51bcfeefe2a83171f4915c9d2b022ad
-  data.tar.gz: 2b11a6544dec2796c6bdf5ce96691be0c7b232f132174d0b79496098252fe5ab
+  metadata.gz: 3a8fe8ed0c57993d0c71fa5d584dce0343e6548d4b42ce70431333fb62d9490d
+  data.tar.gz: 0eab58e635c11d57b167d842ce6411d4970ac9d4a4adb4660b057a4ae2d7b217
 SHA512:
-  metadata.gz: c76c67debc47dd95b9b614a6681923cb5e47f53c4135335c39170243bcb9a007630af5bc364894f33489cde79c5692e9a28d97ed0f5caf0bfbe83e229ad394eb
-  data.tar.gz: a001aa18bd36640ebe267c8d6ae4bf68e7e73d60df0017e31875b222ff30b87169c4c36d06130c27096def9e4ccfa26c50ad350ea1d2cf2adbb42228af5dcf8d
+  metadata.gz: 4206bd86137641bea396f02d9935488e7b099c65515d41312e372f9ad8dc0c80d8352190049a92907f2c6db78e0a1a438fa7743a418ee5cdcfe59612e2cafcb2
+  data.tar.gz: 9f4d5f519809aa4d2c720358f82c888657235781d4713ba705a35331e3ad6c24396b0031b05cae74d5cfef0c1996e8a56180766b363fd473aa42fcd90cc6cc7f

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", "3.2", ruby-head, jruby-9.2, jruby-9.3, jruby-head]
+        ruby: ["2.5", "2.6", "2.7", "3.0", "3.1", "3.2", "3.3", "3.4", ruby-head, jruby-10.0, jruby-head]
 
     steps:
     - uses: actions/checkout@v4

data/README.markdown

@@ -110,7 +110,7 @@ The most interesting function in my opinion is the callback that gets triggered
 Remedy in the Wild
 ------------------
 
-Remedy was originally written for my own console-based game which was sort of like Dwarf Fortress. Most of the project files were lost, but since Remedy was extracted from it and open-sourced it has lived on.
+Remedy was originally written for my own console-based game. Remedy was extracted from it and open-sourced and it has lived on.
 
 Here are some projects that use Remedy:
 

data/examples/from_readme/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "remedy", path: "../.."

data/examples/menu/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "remedy", path: "../.."

data/examples/menu/menu.rb

@@ -11,11 +11,6 @@ class Menu
 
   # will do basic setup and then loop over user input
   def listen
-    # get the screen in a reliable state and clear it
-    ANSI.screen.safe_reset!
-    ANSI.cursor.home!
-    ANSI.command.clear_screen!
-
     # if the user resizes the screen we redraw it to fit the new dimensions
     Console.set_console_resized_hook! do |size|
       draw
@@ -24,10 +19,10 @@ class Menu
     # create an interaction object to handle user input
     interaction = Interaction.new
 
-    # call draw here because interaction blocks until it gets input
+    # call draw here because the interaction loop blocks until it gets input
     draw
 
-    # loop over user input (individual keypresses)
+    # loop over individual keypresses or ANSI codes from the terminal
     interaction.loop do |key|
       @last_key = key
       if key == "q" then
@@ -39,7 +34,7 @@ class Menu
 
   # this tells the Viewport to draw to the screen
   def draw
-    @viewport.draw content, Size([0,0]), header, footer
+    @viewport.draw content, Size.zero, header, footer
   end
 
   # this is the body of our menu, it will be squished if the terminal is too small

data/lib/remedy/console.rb

@@ -23,6 +23,14 @@ module Remedy
       @output ||= $stdout
     end
 
+    def input= new_input
+      @input = new_input
+    end
+
+    def output= new_output
+      @output = new_output
+    end
+
     def raw
       raw!
       result = yield
@@ -52,21 +60,27 @@ module Remedy
     alias_method :height, :rows
 
     def size
+      return @size_override if @size_override
+
       str = [0, 0, 0, 0].pack('SSSS')
-      if input.ioctl(TIOCGWINSZ, str) >= 0 then
+      if input.respond_to?(:ioctl) && input.ioctl(TIOCGWINSZ, str) >= 0 then
         Size.new str.unpack('SSSS').first 2
       else
         raise UnknownConsoleSize, "Unable to get console size"
       end
     end
 
+    def size_override= new_size
+      @size_override = new_size
+    end
+
     def interactive?
       input.isatty
     end
 
     def set_console_resized_hook!
       Console::Resize.set_console_resized_hook! do |*args|
-        yield *args
+        yield(*args)
       end
     end
 

data/lib/remedy/console_resize.rb

@@ -37,6 +37,7 @@ module Remedy; module Console; module Resize
         end
       end
 
+    ensure
       resized!
     end
   end

data/lib/remedy/interaction.rb

@@ -68,7 +68,7 @@ module Remedy
       print " -- #{message}" if message
 
       ANSI.cursor.hide!
-      key = Keyboard.get
+      Keyboard.get
     end
   end
 end

data/lib/remedy/partial.rb

@@ -16,6 +16,7 @@ module Remedy
       reset_width!
       line = "#{line}" # opportunistically convert any object into a string
       @lines += clean line unless line.nil? || line.empty?
+      self
     end
 
     def first
@@ -26,16 +27,17 @@ module Remedy
       lines.last
     end
 
-    def length
+    def height
       lines.length
     end
+    alias_method :length, :height
 
     def width
-      @width ||= lines.max{|line| line.length }.length
+      lines.map{|line| line.length }.max || 0
     end
 
     def size
-      Size.new length, width
+      Size.new height, width
     end
 
     def to_a

data/lib/remedy/size.rb

@@ -11,6 +11,10 @@ module Remedy
     end
     attr_accessor :dimensions
 
+    def self.zero
+      self.new([0,0])
+    end
+
     def - other_size
       if other_size.respond_to? :length then
         self.class.new subtract(other_size)
@@ -41,11 +45,13 @@ module Remedy
     def rows
       dimensions[0]
     end
+    alias_method :height, :rows
 
     def cols
       dimensions[1]
     end
-    alias :columns :cols
+    alias_method :columns, :cols
+    alias_method :width, :cols
 
     def [] index
       dimensions[index]

data/lib/remedy/version.rb

@@ -1,3 +1,3 @@
 module Remedy
-  VERSION = '0.3.1'
+  VERSION = '0.5.0'
 end

data/lib/remedy/viewport.rb

@@ -5,14 +5,10 @@ require 'remedy/ansi'
 
 module Remedy
   class Viewport
-    def draw content, center = Size.new(0,0), header = [], footer = []
-      range = range_find content, center, content_size(header,footer)
+    def draw content, scroll = Size.zero, header = Partial.new, footer = Partial.new
+      range = range_find content, scroll, available_space(header,footer)
 
-      if content.size.fits_into? range then
-        viewable_content = content
-      else
-        viewable_content = content.excerpt *range
-      end
+      viewable_content = content.excerpt(*range)
 
       view = View.new viewable_content, header, footer
 
@@ -20,40 +16,49 @@ module Remedy
       Console.output << view
     end
 
-    def range_find partial, center, heightwidth
-      row_size, col_size = heightwidth
-      row_limit, col_limit = partial.size
+    def range_find partial, scroll, available_heightwidth
+      avail_height, avail_width = available_heightwidth
+      partial_height, partial_width = partial.size
+
+      center_row, center_col = scroll
 
-      center_row, center_col = center
+      row_range = get_range center_row, partial_height, avail_height
+      col_range = get_range center_col, partial_width, avail_width
 
-      row_range = center_range center_row, row_size, row_limit
-      col_range = center_range center_col, col_size, col_limit
       [row_range, col_range]
     end
 
-    def content_size header, footer
-      trim = Size [header.length + footer.length, 0]
+    # This determines the maximum amount of room left available for Content
+    # after taking into consideration the height of the Header and Footer
+    def available_space header, footer
+      trim = Size [header.height + footer.height, 0]
       size - trim
     end
 
     def size
-      Size Console.size
+      Console.size
     end
 
-    def center_range center, width, limit
-      range_start = center - (width / 2)
+    def get_range offset, actual, available
+      # if the actual content can fit into the available space, then we're done
+      return (0...actual) if actual <= available
 
-      if range_start + width > limit then
-        range_start = limit - width
-      end
+      # otherwise start looking at the scrolling offset, if any
 
-      if range_start < 0 then
+      # clamp the offset within the possible range of the actual content
+      if offset < 0 then
         range_start = 0
+      elsif offset > actual then
+        range_start = actual
+      else
+        range_start = offset
       end
 
-      range_end = range_start + width
+      # determine the subset of content that can be displayed
+      range_end = range_start + (available - offset)
 
       (range_start...range_end)
     end
+
   end
 end

data/remedy.gemspec

@@ -18,5 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.required_ruby_version = '>=2.5'
+
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
 end

data/spec/viewport_spec.rb

@@ -1,13 +1,34 @@
-require_relative 'spec_helper'
-require 'remedy/viewport'
+require_relative "spec_helper"
+require "remedy/viewport"
 
 describe Remedy::Viewport do
+  let(:console){ ::Remedy::Console }
+  let(:size_override){ Size 20, 40 }
+  let(:stringio){ StringIO.new }
+
+  before(:each) do
+    console.input = stringio
+    console.output = stringio
+    console.size_override = size_override
+  end
+
+  after(:each) do
+    console.input = $stdin
+    console.output = $stdout
+    console.size_override = nil
+  end
+
   it 'should be able to execute the example code from the readme' do
+    expected = "\\e[H\\e[JQ: What's the difference between a duck?\\e[1B\\e[0GA: Purple, because ice cream has no bone\\e[1B\\e[0G"
+
     joke = ::Remedy::Partial.new
     joke << "Q: What's the difference between a duck?"
     joke << "A: Purple, because ice cream has no bones!"
 
     screen = ::Remedy::Viewport.new
-    screen.draw joke unless ENV['CI']
+    screen.draw joke
+
+    actual = stringio.string.inspect[1..-2]
+    expect(actual).to eq expected
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remedy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2025-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 description: Pure Ruby console interaction library in the vein of Curses with MVC-style
   seperation of concerns.
 email:
@@ -37,12 +51,13 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- examples/from_readme/Gemfile
 - examples/from_readme/readme.rb
+- examples/menu/Gemfile
 - examples/menu/menu.rb
 - lib/remedy.rb
 - lib/remedy/ansi.rb
@@ -75,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.1
-  - 2.2.5
-  - 2.1.9
-  - ruby-head
-
-before_install:
-  - gem update bundler
-script: bundle exec rspec
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-sudo: false