remedy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b308f7cf135ba7a8f6ab69ef9c56ff7d640a189c9f44056e14f49b987948ec1f
-  data.tar.gz: 9f1969fea60358a6585974f948f572bdeeeb55afd0f176d6dd220bdd4b29c094
+  metadata.gz: 2efe0ed0180c60202b73b0cf9f0fce46b51bcfeefe2a83171f4915c9d2b022ad
+  data.tar.gz: 2b11a6544dec2796c6bdf5ce96691be0c7b232f132174d0b79496098252fe5ab
 SHA512:
-  metadata.gz: 0d664d1b61638b139bd2aef66ed2facd0d25e4dbaa65a39014892bcb3f967895cbf78304a8b4235cce1a5210384e7cadaa6672fa41a2d2e102c22a80c0cd40ef
-  data.tar.gz: ea8a3d1aeaeb8a0e474bf2a69f6837ab300810dfaf3bd014200e284f6e45058875fa5363e73948228806e35e24957ded1d342d07a8622f089726e94da2e93a3b
+  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.6.3
+3.1.2

data/README.markdown

@@ -5,7 +5,7 @@ Remedy is a console interaction framework along the lines of Curses written in p
 
 [![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)
-[![Build Status](https://img.shields.io/travis/acook/remedy.svg?style=for-the-badge)](https://travis-ci.org/acook/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)
 
 
@@ -70,20 +70,18 @@ For instance to get a keypress from the terminal and display it:
   screen.draw joke
 ```
 
-`Remedy::Partial` has the subclasses `Header`, `Footer`, and `Content`.
-
-You can use the above classes to divide your Views into 3 separate pieces. Content 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.
+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
@@ -102,7 +100,7 @@ The most interesting function in my opinion is the callback that gets triggered
   screen = Viewport.new
 
   Console.set_console_resized_hook! do |size|
-    notice = Content.new
+    notice = Partial.new
     notice << "You just resized your screen!\n\nNew size:"
     notice << size
     screen.draw notice
@@ -114,7 +112,10 @@ 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 a couple of projects that use many of Remedy's features:
+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)
 
@@ -133,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

@@ -7,7 +7,7 @@ include Remedy
 screen = Viewport.new
 
 Console.set_console_resized_hook! do |size|
-  notice = Content.new
+  notice = Partial.new
   notice << "You just resized your screen!\n\nNew size:"
   notice << size
 
@@ -16,7 +16,7 @@ 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!"
 
@@ -24,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
@@ -39,7 +39,7 @@ screen.draw jokes, Size.new(0,0), title, disclaimer
 user_input.get_key
 
 ANSI.cursor.next_line!
-keys = Content.new
+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|
   keys << key

data/examples/menu/menu.rb

@@ -47,7 +47,7 @@ class Menu
     # 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 = Content.new
+    c = Partial.new
     c << <<-CONTENT
 
     1. Do the thing
@@ -61,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 << "Screen size: #{Console.size} You pressed: #{@last_key}"
+    Partial.new << "Screen size: #{Console.size} You pressed: #{@last_key}"
   end
 end
 

data/lib/remedy/version.rb

@@ -1,3 +1,3 @@
 module Remedy
-  VERSION = '0.3.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.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Anthony M. Cook
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-22 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.1.2
-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