remedy 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346c9d17734819cc9516ee578ae4b647e70c13c876c7a84e3ffe74e9cb956e27
-  data.tar.gz: 4add78044a3161d6eae52452a6a0bd3f3ba46a18b238af7b533f996ac6599ac6
+  metadata.gz: 2efe0ed0180c60202b73b0cf9f0fce46b51bcfeefe2a83171f4915c9d2b022ad
+  data.tar.gz: 2b11a6544dec2796c6bdf5ce96691be0c7b232f132174d0b79496098252fe5ab
 SHA512:
-  metadata.gz: e3a676f7b7df84dc9732aad2518a4bf2d53625736f0928ed3c2dea7f613d727d3fb6539b724939fa83c427cff098d39fcc7ee09412b195d44dca05d3e28dbbbd
-  data.tar.gz: a6f5a5cc4a4523b6220b426b4016b6370c814f38a2effc993c729a1456e22f3dd9765c43d62bb1f5a8e0ee351a4e14530a87286b58e87409ba9b5c2968cf46ff
+  metadata.gz: c76c67debc47dd95b9b614a6681923cb5e47f53c4135335c39170243bcb9a007630af5bc364894f33489cde79c5692e9a28d97ed0f5caf0bfbe83e229ad394eb
+  data.tar.gz: a001aa18bd36640ebe267c8d6ae4bf68e7e73d60df0017e31875b222ff30b87169c4c36d06130c27096def9e4ccfa26c50ad350ea1d2cf2adbb42228af5dcf8d

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    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]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # 'bundle install' and cache gems
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+3.1.2

data/README.markdown

@@ -1,10 +1,13 @@
 Remedy
 ======
 
-Remedy is a console interaction framework along the lines of Curses written in pure Ruby with an Object-Oriented approach and well-seperated concerns making it easy to use what you need and ignore the rest.
+Remedy is a console interaction framework along the lines of Curses written in pure Ruby. It is modular, making it easy to use what you need and ignore the rest.
+
+[![Gem Version](https://img.shields.io/gem/v/remedy.svg?style=for-the-badge)](https://rubygems.org/gems/remedy)
+[![Gem Downloads](https://img.shields.io/gem/dt/remedy.svg?style=for-the-badge)](https://rubygems.org/gems/remedy)
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/acook/remedy/ci.yml?style=for-the-badge)](https://github.com/acook/remedy/actions/workflows/ci.yml)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/acook/remedy?style=for-the-badge)](https://codeclimate.com/github/acook/remedy/maintainability)
 
-[![TravisCI](http://img.shields.io/travis/acook/remedy.svg?style=flat)](https://travis-ci.org/acook/remedy)
-[![Code Climate](https://codeclimate.com/github/acook/remedy/badges/gpa.svg)](https://codeclimate.com/github/acook/remedy)
 
 If you have any suggestions or find any bugs, drop them in GitHub/issues so I can keep track of them. Thanks!
 
@@ -42,6 +45,8 @@ There are objects for input as well as output, including low level console keyst
 
 The `Interaction` object wraps raw keyboard reads and streamlines some aspects of accepting keyboard input.
 
+For instance to get a keypress from the terminal and display it:
+
 ```ruby
   include Remedy
   user_input = Interaction.new
@@ -65,20 +70,18 @@ The `Interaction` object wraps raw keyboard reads and streamlines some aspects o
   screen.draw joke
 ```
 
-`Remedy::Partial` has the subclasses `Header`, `Footer`, and `Content`.
-
-You can use the above classes to divide your Views into 3 seperate pieces. Content will be truncated as needed to accomodate the header and footer and the dimensions of the console. You can also specify the cursor/scroll position of the content being drawn, and when specifying headers or footers, you must.
+Content in `Remedy::Partial`s will be truncated as needed to accommodate the header and footer and the dimensions of the console. You can also specify the cursor/scroll position of the content being drawn, and when specifying headers or footers, you must.
 
 ```ruby
   include Remedy
-  title = Header.new
+  title = Partial.new
   title << "Someone Said These Were Good"
 
   jokes = Content.new
   jokes << %q{1. A woman gets on a bus with her baby. The bus driver says: 'Ugh, that's the ugliest baby I've ever seen!' The woman walks to the rear of the bus and sits down, fuming. She says to a man next to her: 'The driver just insulted me!' The man says: 'You go up there and tell him off. Go on, I'll hold your monkey for you.'}
   jokes << %q{2. I went to the zoo the other day, there was only one dog in it, it was a shitzu.}
 
-  disclaimer = Footer.new
+  disclaimer = Partial.new
   disclaimer << "According to a survey they were funny. I didn't make them."
 
   screen = Viewport.new
@@ -95,14 +98,34 @@ The most interesting function in my opinion is the callback that gets triggered
   include Remedy
 
   screen = Viewport.new
-  notice = Content.new
-  notice << "You just resized your screen!\n\nBrilliant!"
 
-  Console.set_console_resized_hook! do
+  Console.set_console_resized_hook! do |size|
+    notice = Partial.new
+    notice << "You just resized your screen!\n\nNew size:"
+    notice << size
     screen.draw notice
   end
 ```
 
+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.
+
+Here are some projects that use Remedy:
+
+- A screenreader-friendly code editor for blind and visually impaired programmers: [Viper](https://github.com/edhowland/viper)
+- [The Official ElasticSearch Ruby Connector](https://github.com/elastic/connectors-ruby)
+- A multiplayer Yahtzee for web and console: [YahtzeeGame](https://github.com/ProgrammingPractice/YahtzeeGame)
+- Twitter/RSS/Facebook reader: [noizee](https://github.com/acook/noizee)
+
+Check them out!
+
+Examples
+--------
+
+The `examples` directory has a couple of running implementations to get you started!
+
 Contributing
 ------------
 
@@ -111,4 +134,3 @@ Contributing
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-

data/examples/from_readme/readme.rb

@@ -1,19 +1,22 @@
+require 'bundler'
+Bundler.require
 require 'remedy'
 
 include Remedy
 
 screen = Viewport.new
 
-notice = Content.new
-notice << "You just resized your screen!\n\nBrilliant!"
+Console.set_console_resized_hook! do |size|
+  notice = Partial.new
+  notice << "You just resized your screen!\n\nNew size:"
+  notice << size
 
-Console.set_console_resized_hook! do
   screen.draw notice
 end
 
 user_input = Interaction.new "press any key to continue"
 
-joke = Content.new
+joke = Partial.new
 joke << "Q: What's the difference between a duck?"
 joke << "A: Purple, because ice cream has no bones!"
 
@@ -21,14 +24,14 @@ screen.draw joke
 
 user_input.get_key
 
-title = Header.new
+title = Partial.new
 title << "Someone Said These Were Good"
 
-jokes = Content.new
+jokes = Partial.new
 jokes << %q{1. A woman gets on a bus with her baby. The bus driver says: 'Ugh, that's the ugliest baby I've ever seen!' The woman walks to the rear of the bus and sits down, fuming. She says to a man next to her: 'The driver just insulted me!' The man says: 'You go up there and tell him off. Go on, I'll hold your monkey for you.'}
 jokes << %q{2. I went to the zoo the other day, there was only one dog in it, it was a shitzu.}
 
-disclaimer = Footer.new
+disclaimer = Partial.new
 disclaimer << "According to a survey they were funny. I didn't make them."
 
 screen.draw jokes, Size.new(0,0), title, disclaimer
@@ -36,11 +39,12 @@ screen.draw jokes, Size.new(0,0), title, disclaimer
 user_input.get_key
 
 ANSI.cursor.next_line!
-loop_demo = Interaction.new "press q to exit, or any other key to display it\n"
+keys = Partial.new
+loop_demo = Interaction.new "press q to exit, or any other key to display that key's name\n"
 loop_demo.loop do |key|
-  ANSI.cursor.beginning_of_line!
-  ANSI.command.clear_line!
-  puts key
+  keys << key
+
+  screen.draw keys
   break if key == ?q
 end
 

data/examples/menu/menu.rb

@@ -1,12 +1,23 @@
+require 'bundler'
+Bundler.require
 require 'remedy'
 
 class Menu
   include Remedy
 
+  def initialize
+    @viewport = Viewport.new
+  end
+
   # 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
+    Console.set_console_resized_hook! do |size|
       draw
     end
 
@@ -28,11 +39,14 @@ class Menu
 
   # this tells the Viewport to draw to the screen
   def draw
-    Viewport.new.draw content, Size([0,0]), header, footer
+    @viewport.draw content, Size([0,0]), header, footer
   end
 
   # this is the body of our menu, it will be squished if the terminal is too small
   def content
+    # this creates a new content every time we draw
+    # you may want to only create a new content/header/footer when they change
+    # or create your own Partial subclass
     c = Partial.new
     c << <<-CONTENT
 
@@ -47,12 +61,12 @@ class Menu
 
   # headers are displayed the top of the viewport
   def header
-    Header.new << "The time is: #{Time.now}"
+    Partial.new << "The time is: #{Time.now}"
   end
 
   # footers are displayed the bottom of the viewport
   def footer
-    Footer.new << "You pressed: #{@last_key}"
+    Partial.new << "Screen size: #{Console.size} You pressed: #{@last_key}"
   end
 end
 

data/lib/remedy/console.rb

@@ -42,19 +42,19 @@ module Remedy
     end
 
     def columns
-      size.last
+      size.cols
     end
     alias_method :width, :columns
 
     def rows
-      size.first
+      size.rows
     end
     alias_method :height, :rows
 
     def size
       str = [0, 0, 0, 0].pack('SSSS')
       if input.ioctl(TIOCGWINSZ, str) >= 0 then
-        str.unpack('SSSS').first 2
+        Size.new str.unpack('SSSS').first 2
       else
         raise UnknownConsoleSize, "Unable to get console size"
       end
@@ -65,8 +65,8 @@ module Remedy
     end
 
     def set_console_resized_hook!
-      Console::Resize.set_console_resized_hook! do
-        yield
+      Console::Resize.set_console_resized_hook! do |*args|
+        yield *args
       end
     end
 

data/lib/remedy/console_resize.rb

@@ -24,18 +24,21 @@ module Remedy; module Console; module Resize
   def set_console_resized_hook!
     @resize_count = 0
 
-    command = lambda { |x|
+    Signal.trap 'SIGWINCH' do
       resizing!
-      sleep 0.25
 
       if resized? then
-        yield
+        begin
+          yield Console.size
+        rescue Exception => ex
+          # Ruby will eat *any* errors inside a trap,
+          # so we need to expose them for debuggability
+          p ex
+        end
       end
 
       resized!
-    }
-
-    Signal.trap 'SIGWINCH', command
+    end
   end
 
   def default_console_resized_hook!

data/lib/remedy/key.rb

@@ -15,6 +15,10 @@ module Remedy
       seq
     end
 
+    def enc
+      seq.dump[1..-2]
+    end
+
     def name
       @name ||= Characters[seq] || :unknown
     end
@@ -51,6 +55,10 @@ module Remedy
       @recognized ||= name != :unknown
     end
 
+    def known?
+      !!Characters[seq]
+    end
+
     def single?
       @single ||= raw.length == 1
     end
@@ -60,7 +68,7 @@ module Remedy
     end
 
     def to_s
-      @to_s ||= name.to_s
+      @to_s ||= known? ? name.to_s : enc
     end
 
     def value

data/lib/remedy/partial.rb

@@ -14,6 +14,7 @@ module Remedy
 
     def << line
       reset_width!
+      line = "#{line}" # opportunistically convert any object into a string
       @lines += clean line unless line.nil? || line.empty?
     end
 
@@ -64,7 +65,7 @@ module Remedy
     end
 
     def split line
-      line.split /\r\n|\n\r|\n|\r/
+      line.split(/\r\n|\n\r|\n|\r/)
     end
   end
 end

data/lib/remedy/size.rb

@@ -39,12 +39,13 @@ module Remedy
     end
 
     def rows
-      dimensions.first
+      dimensions[0]
     end
 
     def cols
       dimensions[1]
     end
+    alias :columns :cols
 
     def [] index
       dimensions[index]

data/lib/remedy/version.rb

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

data/lib/remedy/viewport.rb

@@ -1,6 +1,5 @@
 require 'remedy/view'
 require 'remedy/size'
-require 'remedy/content'
 require 'remedy/console'
 require 'remedy/ansi'
 

data/lib/remedy.rb

@@ -3,7 +3,7 @@ module Remedy
 
   def libs
     %w{
-      version ansi characters console console_resize content header footer
+      version ansi characters console console_resize
       interaction key keyboard partial view viewport
     }
   end

data/spec/viewport_spec.rb

@@ -3,7 +3,7 @@ require 'remedy/viewport'
 
 describe Remedy::Viewport do
   it 'should be able to execute the example code from the readme' do
-    joke = ::Remedy::Content.new
+    joke = ::Remedy::Partial.new
     joke << "Q: What's the difference between a duck?"
     joke << "A: Purple, because ice cream has no bones!"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remedy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Anthony M. Cook
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,6 +32,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -47,9 +49,6 @@ files:
 - lib/remedy/characters.rb
 - lib/remedy/console.rb
 - lib/remedy/console_resize.rb
-- lib/remedy/content.rb
-- lib/remedy/footer.rb
-- lib/remedy/header.rb
 - lib/remedy/interaction.rb
 - lib/remedy/key.rb
 - lib/remedy/keyboard.rb
@@ -68,7 +67,7 @@ homepage: http://github.com/acook/remedy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Pure Ruby Console Interaction Library
 test_files:

data/lib/remedy/content.rb

@@ -1,4 +0,0 @@
-require 'remedy/partial'
-
-class Remedy::Content < Remedy::Partial
-end

data/lib/remedy/footer.rb

@@ -1,4 +0,0 @@
-require 'remedy/partial'
-
-class Remedy::Footer < Remedy::Partial
-end

data/lib/remedy/header.rb

@@ -1,4 +0,0 @@
-require 'remedy/partial'
-
-class Remedy::Header < Remedy::Partial
-end