remedy 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdbe9a3b67f8ad38de63244c77014eb1ba7ddbce
-  data.tar.gz: 7ef6bbf5a6010383486459e468db45fbf20ed92e
+  metadata.gz: c57a50932b4e8ce59e0c961d944c67c5cb93b444
+  data.tar.gz: ed2b6bfb4d72f4dab134e3cbdec8abb89a1477c9
 SHA512:
-  metadata.gz: ca6f9629d52f68d5ef4012f4e7883d63b5b51441c028905b2b43c20b6bdd95da1c27c1653a6179728d6bc9d068573242d2812bc772af02ea3115ad2574be082f
-  data.tar.gz: 54356ac5892f891fb28c491a31c2b344bdce5e7fe28c8e4d556b85511e0f2fdcd1f079260dd3c0d1ebe7010d493237bcbdeb8b81c52d1b0ad262e4c311585bbe
+  metadata.gz: 7c458b0e9eacccfb956afd4f29456ece91dc17eec562f37b7ee2fd05bf3ec40f7067bea1d0f46feb6250cc0cd4862a4811d80b805aae1d613ed70e55edc8a97a
+  data.tar.gz: 20cc90d989ec4545ae2fb697b7a1520175f2a27a377f6aa63e10c5db492c9a5b5450e9e4d84ee3c581b2dafb08324d70ee98bc90906e0b88514af2cc97dceb40

data/.travis.yml

@@ -1,4 +1,16 @@
 language: ruby
 rvm:
-  - 2.1.2
+  - 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

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in remedy.gemspec
 gemspec
 
-gem 'pry'
-gem 'pry-doc'
-gem 'pry-theme'
+unless ENV['CI'] then
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'pry-theme'
+end

data/README.markdown

@@ -1,14 +1,10 @@
 Remedy
 ======
 
-Remedy is a console interaction framework along the lines of Curses written in pure Ruby with an Object-Oriented approach and baked-in support for bulding MVC applications.
+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.
 
 [![TravisCI](http://img.shields.io/travis/acook/remedy.svg?style=flat)](https://travis-ci.org/acook/remedy)
-
-THIS SOFTWARE IS PRE-ALPHA!!
-----------------------------
-
-It's under active development and is being used in my own projects. However, expect bugs, missing features, etc.
+[![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!
 
@@ -18,13 +14,13 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-  gem 'remedy', '~> 0.0.4.pre'
+  gem 'remedy'
 ```
 
 If you're only going to use part of Remedy, you can tell Bundler to not automatically require the whole thing:
 
 ```ruby
-  gem 'remedy', '~> 0.0.4.pre', require: false
+  gem 'remedy', require: false
 ```
 
 And then execute:
@@ -33,7 +29,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install remedy --pre
+    $ gem install remedy
 
 Usage
 -----

data/lib/remedy.rb

@@ -3,7 +3,7 @@ module Remedy
 
   def libs
     %w{
-      version ansi characters console console_resized content header footer
+      version ansi characters console console_resize content header footer
       interaction key keyboard partial view viewport
     }
   end
@@ -12,4 +12,3 @@ end
 Remedy.libs.each do |lib|
   require "remedy/#{lib}"
 end
-

data/lib/remedy/characters.rb

@@ -6,6 +6,8 @@ module Remedy
       all[sequence_to_match]
     end
 
+    # Character Groups
+
     def all
       @all ||= printable.merge(nonprintable)
     end
@@ -14,39 +16,46 @@ module Remedy
       @printable ||= whitespace.merge(
         alphabetical.merge(
           numeric.merge(
-            punctuation)))
-    end
-
-    def whitespace
-      {
-        ' '  => :space,
-        "\t" => :tab,
-        "\r" => :carriage_return,
-        "\n" => :line_feed
-      }
+            punctuation
+          )
+        )
+      )
     end
 
     def alphabetical
       @alphabetics ||= get_alphabetics
     end
 
+    def nonprintable
+      @nonprintable ||= special.merge(directional).merge(escape).merge(control)
+    end
+
+    def whitespace
+      @whitespace ||= {
+        ?\s => :space,
+        ?\t => :tab,
+        ?\r => :carriage_return,
+        ?\n => :line_feed
+      }
+    end
+
     def numeric
-      {
-        '0' => :zero,
-        '1' => :one,
-        '2' => :two,
-        '3' => :three,
-        '4' => :four,
-        '5' => :five,
-        '6' => :six,
-        '7' => :seven,
-        '8' => :eight,
-        '9' => :nine
+      @numeric ||= {
+        ?0 => :zero,
+        ?1 => :one,
+        ?2 => :two,
+        ?3 => :three,
+        ?4 => :four,
+        ?5 => :five,
+        ?6 => :six,
+        ?7 => :seven,
+        ?8 => :eight,
+        ?9 => :nine
       }
     end
 
     def punctuation
-      {
+      @punctuation ||= {
         '.' => :period,
         ',' => :comma,
         ':' => :colon,
@@ -77,18 +86,13 @@ module Remedy
       }
     end
 
-    def nonprintable
-      @nonprintable ||= special.merge(directional).merge(escape).merge(control)
-    end
-
     def special
       {
-        "\177"  => :backspace
       }
     end
 
     def directional
-      {
+      @directional ||= {
         "\e[A" => :up,
         "\e[B" => :down,
         "\e[D" => :left,
@@ -97,7 +101,7 @@ module Remedy
     end
 
     def escape
-      {
+      @escape ||= {
         "\e" => :escape,
 
         "\e[3~" => :delete
@@ -105,13 +109,24 @@ module Remedy
     end
 
     def control
-      {
-        "\u0003" => :control_c,
-        "\u0004" => :control_d,
-        "\u0012" => :control_r
+      control_chars = {
+        27.chr => :control_left_square_bracket,
+        28.chr => :control_backslash,
+        29.chr => :control_right_square_bracket,
+        30.chr => :control_caret,
+        31.chr => :control_underscore,
+        127.chr => :delete,
+        177.chr => :backspace
       }
+      (?a..?z).each.with_index do |letter, index|
+        control_chars.merge!({(index + 1).chr => "control_#{letter}".to_sym})
+      end
+
+      control_chars
     end
 
+    # Glyphs and Alternate Names
+
     def gremlins
       {
         space:           "\u2420",
@@ -137,10 +152,38 @@ module Remedy
 
     def alternate_names
       {
+        control_a: :start_of_heading,
+        control_b: :start_of_text,
         control_c: :end_of_transmission,
         control_d: :end_of_text,
-
-        control_r: :device_control_two
+        control_e: :enquiry,
+        control_f: :acknowledge,
+        control_g: :bel,
+        control_h: :backspace,
+        control_i: :horizontal_tabulation,
+        control_j: :line_feed,
+        control_k: :vertical_tabulation,
+        control_l: :form_feed,
+        control_m: :carriage_return,
+        control_n: :shift_out,
+        control_o: :shift_in,
+        control_p: :data_link_escape,
+        control_q: :device_control_one,
+        control_r: :device_control_two,
+        control_s: :device_control_three,
+        control_t: :device_control_four,
+        control_u: :negative_acknowledge,
+        control_v: :sychnronous_idle,
+        control_w: :end_of_transmission_block,
+        control_x: :cancel,
+        control_y: :end_of_medium,
+        control_z: :substitute,
+
+        control_left_square_bracket:  :escape,
+        control_backslash:            :file_separator,
+        control_right_square_bracket: :group_separator,
+        control_caret:                :record_separator,
+        control_underscore:           :unit_separator
       }
     end
 

data/lib/remedy/console.rb

@@ -1,4 +1,4 @@
-require 'remedy/console_resized'
+require 'remedy/console_resize'
 
 module Remedy
   module Console
@@ -9,11 +9,11 @@ module Remedy
     module_function
 
     def input
-      STDIN
+      @input ||= $stdin
     end
 
     def output
-      STDOUT
+      @output ||= $stdout
     end
 
     def raw
@@ -21,7 +21,6 @@ module Remedy
       result = yield
     ensure
       cooked!
-
       return result
     end
 
@@ -33,15 +32,13 @@ module Remedy
     def cooked!
       input.echo = true
       input.cooked!
-    rescue NoMethodError
-      %x{stty -raw echo 2> /dev/null}
     end
 
     def columns
       size.last
     end
     alias_method :width, :columns
-    
+
     def rows
       size.first
     end
@@ -61,7 +58,7 @@ module Remedy
     end
 
     def set_console_resized_hook!
-      ConsoleResized.set_console_resized_hook! do
+      Console::Resize.set_console_resized_hook! do
         yield
       end
     end

data/lib/remedy/console_resize.rb

@@ -0,0 +1,44 @@
+module Remedy; module Console; module Resize
+  module_function
+
+  def resizing?
+    @resize_count > 0
+  end
+
+  def resizing!
+    @resize_count = @resize_count < 1 ? 1 : @resize_count + 1
+  end
+
+  def resized?
+    @resize_count <= 1
+  end
+
+  def resized!
+    @resize_count = @resize_count < 0 ? 0 : @resize_count - 1
+  end
+
+  def resizer?
+    @resize_count == 1
+  end
+
+  def set_console_resized_hook!
+    @resize_count = 0
+
+    command = lambda { |x|
+      resizing!
+      sleep 0.25
+
+      if resized? then
+        yield
+      end
+
+      resized!
+    }
+
+    Signal.trap 'SIGWINCH', command
+  end
+
+  def default_console_resized_hook!
+    Signal.trap 'SIGWINCH', 'DEFAULT'
+  end
+end; end; end

data/lib/remedy/content.rb

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

data/lib/remedy/footer.rb

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

data/lib/remedy/header.rb

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

data/lib/remedy/interaction.rb

@@ -63,5 +63,12 @@ module Remedy
         yield key
       end
     end
+
+    def get_key
+      print " -- #{message}" if message
+
+      ANSI.cursor.hide!
+      key = Keyboard.get
+    end
   end
 end

data/lib/remedy/key.rb

@@ -56,7 +56,7 @@ module Remedy
     end
 
     def sequence?
-      @sequence ||= raw.legnth > 1
+      @sequence ||= raw.length > 1
     end
 
     def to_s

data/lib/remedy/version.rb

@@ -1,3 +1,3 @@
 module Remedy
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/spec/key_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper'
+require 'remedy/key'
+
+describe Remedy::Key do
+  subject(:key){ described_class.new keypress }
+
+  let(:keypress){ "\e[A" }
+
+  describe '#raw' do
+    it 'gives the same sequence it was initialized with' do
+      expect(key.raw).to equal(keypress)
+    end
+  end
+
+  describe '#name' do
+    it 'gives the name of the key' do
+      expect(key.name).to equal(:up)
+    end
+  end
+
+  describe '#glyph' do
+    it 'gives the individual character respresentation of the key' do
+      expect(key.glyph).to eq("\u2191")
+    end
+  end
+
+  describe '#nonprintable?' do
+    it 'indicates that a keypress is a nonprintable character or sequence' do
+      expect(key.nonprintable?).to be(true)
+    end
+  end
+
+  describe '#sequence?' do
+    it 'determines if a keypress is an escape sequence' do
+      expect(key.sequence?).to be(true)
+    end
+  end
+
+  describe 'control characters' do
+    let(:keypress){ 3.chr }
+
+    it 'recognizes control c' do
+      expect(key.control_c?).to be(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler.require(:test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remedy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Anthony M. Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,7 +44,7 @@ files:
 - lib/remedy/ansi.rb
 - lib/remedy/characters.rb
 - lib/remedy/console.rb
-- lib/remedy/console_resized.rb
+- lib/remedy/console_resize.rb
 - lib/remedy/content.rb
 - lib/remedy/footer.rb
 - lib/remedy/header.rb
@@ -57,6 +57,7 @@ files:
 - lib/remedy/view.rb
 - lib/remedy/viewport.rb
 - remedy.gemspec
+- spec/key_spec.rb
 - spec/remedy_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/acook/remedy
@@ -78,11 +79,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: MVC Console Interaction Library
 test_files:
+- spec/key_spec.rb
 - spec/remedy_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/remedy/console_resized.rb

@@ -1,46 +0,0 @@
-module Remedy
-  module ConsoleResized
-    module_function
-
-    def resizing?
-      @resize_count > 0
-    end
-
-    def resizing!
-      @resize_count = @resize_count < 1 ? 1 : @resize_count + 1
-    end
-
-    def resized?
-      @resize_count <= 1
-    end
-
-    def resized!
-      @resize_count = @resize_count < 0 ? 0 : @resize_count - 1
-    end
-
-    def resizer?
-      @resize_count == 1
-    end
-
-    def set_console_resized_hook!
-      @resize_count = 0
-
-      command = lambda { |x|
-        resizing!
-        sleep 0.25
-
-        if resized? then
-          yield
-        end
-
-        resized!
-      }
-
-      Signal.trap 'SIGWINCH', command
-    end
-
-    def default_console_resized_hook!
-      Signal.trap 'SIGWINCH', 'DEFAULT'
-    end
-  end
-end