remedy 0.0.3.pre

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in remedy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anthony Cook
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,33 @@
+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.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'remedy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remedy
+
+Usage
+-----
+
+TODO: Write usage instructions here
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/remedy.rb

@@ -0,0 +1,9 @@
+%w{
+  version ansi characters console resized_console content header footer
+  interaction key keyboard partial view viewport
+}.each do |lib|
+  require "remedy/#{lib}"
+end
+
+module Remedy
+end

data/lib/remedy/ansi.rb

@@ -0,0 +1,207 @@
+require 'remedy/console'
+
+module Remedy
+  module ANSI
+    module_function
+
+    def push *sequences
+      Console.output << sequences.join('')
+    end
+
+    def pushesc *sequences
+      push sequences.map{|sequence| esc sequence }
+    end
+
+    def pushe *sequences
+      push sequences.map{|sequence| e sequence }
+    end
+
+    def esc sequence = nil
+      "\e[#{sequence}"
+    end
+
+    def e sequence = nil
+      "\e#{sequence}"
+    end
+
+    def cursor
+      Cursor
+    end
+
+    def screen
+      Screen
+    end
+
+    def command
+      Command
+    end
+
+    def color
+      Color
+    end
+
+    module Command
+      extend ANSI
+
+      module_function
+
+      def code
+        {
+          clear_line: 'K',
+
+          clear_down:   'J',
+          clear_up:     '1J',
+          clear_screen: '2J'
+        }
+      end
+
+      def clear_line!
+        pushesc code[:clear_line]
+      end
+
+      def clear_up!
+        pushesc code[:clear_up]
+      end
+
+      def clear_down!
+        pushesc code[:clear_down]
+      end
+
+      def clear_screen!
+        pushesc code[:clear_screen]
+      end
+    end
+
+    module Cursor
+      extend ANSI
+
+      module_function
+
+      def code
+        {
+          # Movement
+          home: 'H',
+          up: '%{lines}A',
+          down: '%{lines}B',
+          to_column: '%{column}G',
+
+          # May not work on all terminals.
+          next_line: '%{lines}E',
+          prev_line: '%{lines}F',
+
+          # Visiblity
+          show: '?25h',
+          hide: '?25l'
+        }
+      end
+
+      def to_column column
+        esc code[:to_column] % {column: column}
+      end
+
+      def down lines = 1
+        esc code[:down] % {lines: lines}
+      end
+
+      def up lines = 1
+        esc code[:up] % {lines: lines}
+      end
+
+      def next_line lines = 1
+        #esc code[:next_line] % {lines: lines}
+        down(lines) + to_column(0)
+      end
+
+      def prev_line lines = 1
+        #esc code[:prev_line] % {lines: lines}
+        up(lines) + to_column(0)
+      end
+
+
+      def home!
+        pushesc code[:home]
+      end
+
+      def hide!
+        pushesc code[:hide]
+      end
+
+      def show!
+        pushesc code[:show]
+      end
+
+      def next_line! lines = 1
+        push next_line(lines)
+      end
+
+      def prev_line! lines = 1
+        push prev_line(lines)
+      end
+
+      def beginning_of_line!
+        to_column! 0
+      end
+
+    end
+
+    module Screen
+      extend ANSI
+
+      module_function
+
+      def code
+        {
+          up:   'M',
+          down: 'D'
+        }
+      end
+
+      def reset!
+        ANSI.color.reset!
+        ANSI.cursor.home!
+        clear!
+      end
+
+      def safe_reset!
+        ANSI.cursor.home!
+        ANSI.command.clear_down!
+      end
+
+      def clear!
+        ANSI.command.clear_screen!
+      end
+
+      def up! count = 1
+        count.times { pushe code[:up] }
+      end
+
+      def down!  count = 1
+        count.times { pushe code[:down] }
+      end
+    end
+
+    module Color
+      extend ANSI
+
+      module_function
+
+      def code
+        {
+          reset: '0'
+        }
+      end
+
+      def pushc *sequences
+        push sequences.map{|sequence| c sequence }
+      end
+
+      def c sequence
+        "#{esc sequence}m"
+      end
+
+      def reset!
+        pushc code[:reset]
+      end
+    end
+  end
+end

data/lib/remedy/characters.rb

@@ -0,0 +1,155 @@
+module Remedy
+  module Characters
+    module_function
+
+    def [] sequence_to_match
+      all[sequence_to_match]
+    end
+
+    def all
+      @all ||= printable.merge(nonprintable)
+    end
+
+    def printable
+      @printable ||= whitespace.merge(
+        alphabetical.merge(
+          numeric.merge(
+            punctuation)))
+    end
+
+    def whitespace
+      {
+        ' '  => :space,
+        "\t" => :tab,
+        "\r" => :carriage_return,
+        "\n" => :line_feed
+      }
+    end
+
+    def alphabetical
+      @alphabetics ||= get_alphabetics
+    end
+
+    def numeric
+      {
+        '0' => :zero,
+        '1' => :one,
+        '2' => :two,
+        '3' => :three,
+        '4' => :four,
+        '5' => :five,
+        '6' => :six,
+        '7' => :seven,
+        '8' => :eight,
+        '9' => :nine
+      }
+    end
+
+    def punctuation
+      {
+        '.' => :period,
+        ',' => :comma,
+        ':' => :colon,
+        ';' => :semicolon,
+
+        '"' => :double_quote,
+        "'" => :single_quote,
+        '`' => :back_quote,
+
+        '[' => :left_bracket,
+        ']' => :right_bracked,
+        '(' => :left_paren,
+        ')' => :right_paren,
+
+        '^' => :caret,
+        '_' => :underscore,
+        '-' => :dash,
+        '~' => :tilde,
+
+        '!' => :bang,
+        '?' => :query,
+
+        '|'       => :solid_pipe,
+        "\u00A6"  => :broken_pipe,
+
+        '/'  => :forward_slash,
+        "\\" => :back_slash
+      }
+    end
+
+    def nonprintable
+      @nonprintable ||= special.merge(directional).merge(escape).merge(control)
+    end
+
+    def special
+      {
+        "\177"  => :backspace
+      }
+    end
+
+    def directional
+      {
+        "\e[A" => :up,
+        "\e[B" => :down,
+        "\e[D" => :left,
+        "\e[C" => :right
+      }
+    end
+
+    def escape
+      {
+        "\e" => :escape,
+
+        "\e[3~" => :delete
+      }
+    end
+
+    def control
+      {
+        "\u0003" => :control_c,
+        "\u0004" => :control_d,
+        "\u0012" => :control_r
+      }
+    end
+
+    def gremlins
+      {
+        space:           "\u2420",
+        tab:             "\u21B9",
+        carriage_return: "\u23CE",
+        line_feed:       "\u240A",
+
+        control_c: "\u2404",
+        control_d: "\u2403",
+        control_r: "\u2412",
+
+        escape: "\u238B",
+
+        backspace: "\u2408",
+        delete:    "\u232B",
+
+        up:    "\u2191",
+        down:  "\u2193",
+        left:  "\u2190",
+        right: "\u2192"
+      }
+    end
+
+    def alternate_names
+      {
+        control_c: :end_of_transmission,
+        control_d: :end_of_text,
+
+        control_r: :device_control_two
+      }
+    end
+
+    def get_alphabetics
+      letters = ('a'..'z').to_a + ('A'..'Z').to_a
+      letters.inject(Hash.new) do |alphas, letter|
+        alphas[letter] = letter.to_sym
+        alphas
+      end
+    end
+  end
+end

data/lib/remedy/console.rb

@@ -0,0 +1,61 @@
+require 'remedy/console_resized'
+
+module Remedy
+  module Console
+    require 'io/console'
+
+    TIOCGWINSZ = 0x40087468
+
+    module_function
+
+    def input
+      STDIN
+    end
+
+    def output
+      STDOUT
+    end
+
+    def raw
+      raw!
+      result = yield
+    ensure
+      cooked!
+
+      return result
+    end
+
+    def raw!
+      input.echo = false
+      input.raw!
+    end
+
+    def cooked!
+      input.echo = true
+      input.cooked!
+    rescue NoMethodError
+      %x{stty -raw echo 2> /dev/null}
+    end
+
+    def size
+      str = [0, 0, 0, 0].pack('SSSS')
+      if input.ioctl(TIOCGWINSZ, str) >= 0 then
+        str.unpack('SSSS').first 2
+      else
+        raise UnknownConsoleSize, "Unable to get console size"
+      end
+    end
+
+    def interactive?
+      input.isatty
+    end
+
+    def set_console_resized_hook!
+      ConsoleResized.set_console_resized_hook! do
+        yield
+      end
+    end
+
+    class UnknownConsoleSize < IOError; end
+  end
+end

data/lib/remedy/console_resized.rb

@@ -0,0 +1,46 @@
+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

data/lib/remedy/content.rb

@@ -0,0 +1,4 @@
+require 'partial'
+
+class Content < Partial
+end

data/lib/remedy/footer.rb

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

data/lib/remedy/header.rb

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

data/lib/remedy/interaction.rb

@@ -0,0 +1,65 @@
+require 'remedy/keyboard'
+require 'remedy/ansi'
+
+class Interaction
+  def initialize message = nil
+    @message = message
+  end
+
+  attr_accessor :message
+
+  def confirm message = 'Confirm?'
+    ANSI.cursor.home!
+    ANSI.command.clear_line!
+
+    print message, ' y/n '
+    if Keyboard.get === :y then
+      yield if block_given?
+      true
+    else
+      false
+    end
+  end
+
+  def quit!
+    confirm 'Are you sure you want to quit? You will lose everything. :(' do
+      ANSI.cursor.home!
+      ANSI.command.clear_down!
+      ANSI.cursor.show!
+
+      puts " -- Bye!"
+      exit
+    end
+  end
+
+  def debug!
+    require 'pry'
+    binding.pry
+  end
+
+  def display key
+    ANSI.command.clear_line!
+    print " -- You pressed: #{key.inspect}"
+  end
+
+  def loop
+    Keyboard.raise_on_control_c!
+
+    super do
+      print " -- #{message}" if message
+
+      ANSI.cursor.hide!
+      key = Keyboard.get
+
+      if key == ?\C-q then
+        display key
+        quit!
+      elsif key == ?\C-d and defined? Pry then
+        display key
+        debug!
+      end
+
+      yield key
+    end
+  end
+end

data/lib/remedy/key.rb

@@ -0,0 +1,117 @@
+require 'remedy/characters'
+
+module Remedy
+  class Key
+
+    def initialize character_sequence
+      @character_sequence = character_sequence
+    end
+
+    def seq
+      @character_sequence
+    end
+
+    def raw
+      seq
+    end
+
+    def name
+      @name ||= Characters[seq] || :unknown
+    end
+
+    def glyph
+      @glyph ||= get_glyph
+    end
+
+    def printable?
+      @printable ||= !!Characters.printable[seq]
+    end
+
+    def nonprintable?
+      @nonprintable ||= !!Characters.nonprintable[seq]
+    end
+
+    def control?
+      @control ||= !!Characters.control[seq]
+    end
+
+    def punctuation?
+      @control ||= !!Characters.punctuation[seq]
+    end
+
+    def gremlin?
+      @gremlin ||= !!Characters.gremlins[name]
+    end
+
+    def control_c?
+      @control_c ||= seq == Characters.control.key(:control_c)
+    end
+
+    def recognized?
+      @recognized ||= name != :unknown
+    end
+
+    def single?
+      @single ||= raw.length == 1
+    end
+
+    def sequence?
+      @sequence ||= raw.legnth > 1
+    end
+
+    def to_s
+      @to_s ||= name.to_s
+    end
+
+    def value
+      raw_value = raw.bytes.to_a.join(' ')
+      single? ? raw_value : "(#{raw_value})"
+    end
+
+    def inspect
+      "<#{self.class} #{name.inspect} value:#{value} glyph:#{glyph}>"
+    end
+
+    def == key
+      if key.respond_to? :raw then
+        key.raw == raw
+      else
+        "#{raw}" == "#{key}"
+      end
+    end
+
+    def eql? key
+      if key.is_a? self.class then
+        self == key
+      end
+    end
+
+    def === object
+      "#{object}" =~ /#{to_s}/i
+    end
+
+    def hash
+      raw.hash
+    end
+
+    protected
+
+    def get_glyph
+      if punctuation? then
+        seq
+      elsif gremlin? then
+        Characters.gremlins[name]
+      else
+        recognized? ? name : ''
+      end
+    end
+  end
+
+  def Key object
+    if object.is_a? Key then
+      object
+    else
+      Key.new object
+    end
+  end
+end

data/lib/remedy/keyboard.rb

@@ -0,0 +1,66 @@
+require 'remedy/console'
+require 'remedy/key'
+
+module Keyboard
+  module_function
+
+  def get
+    parse raw_get
+  end
+
+  def raw_get
+    Console.raw do
+      input = STDIN.getc.chr
+
+      if input == "\e" then
+        input << STDIN.read_nonblock(3) rescue nil
+        input << STDIN.read_nonblock(2) rescue nil
+      end
+
+      input
+    end
+  end
+
+  def parse sequence
+    key = Key.new sequence
+    $log.debug "Key read", key
+
+    if raise_on_control_c? && key.control_c? then
+      raise ControlC, "User pressed Control-C"
+    elsif key.recognized? then
+      key
+    elsif raise_on_unrecognized_key? then
+      raise UnrecognizedInput, %Q{Unknown key or byte sequence: "#{sequence}" : #{key.inspect}}
+    else
+      key
+    end
+  end
+
+  def raise_on_unrecognized_key?
+    @raise_on_unrecognized_key
+  end
+
+  def raise_on_unrecognized_key!
+    @raise_on_unrecognized_key = true
+  end
+
+  def dont_raise_on_unrecognized_key!
+    @raise_on_unrecognized_key = false
+  end
+
+  def raise_on_control_c?
+    @raise_on_control_c
+  end
+
+  def raise_on_control_c!
+    @raise_on_control_c = true
+  end
+
+  def dont_raise_on_control_c!
+    @raise_on_control_c = false
+  end
+
+  class ControlC < Interrupt; end
+  class UnrecognizedInput < IOError; end
+end
+

data/lib/remedy/partial.rb

@@ -0,0 +1,70 @@
+module Remedy
+  class Partial
+    def initialize collection = Array.new
+      @lines = Array.new
+      self + collection
+    end
+    attr_accessor :lines
+
+    def + new_lines
+      new_lines.each do |line|
+        self << line
+      end
+    end
+
+    def << line
+      reset_width!
+      @lines += clean line unless line.nil? || line.empty?
+    end
+
+    def first
+      lines.first
+    end
+
+    def last
+      lines.last
+    end
+
+    def length
+      lines.length
+    end
+
+    def width
+      @width ||= lines.max{|line| line.length }
+    end
+
+    def size
+      Size.new length, width
+    end
+
+    def to_a
+      lines
+    end
+
+    def to_s
+      lines.join '\n'
+    end
+
+    def join seperator
+      lines.join seperator
+    end
+
+    def excerpt lines_range, width_range
+      self.class.new lines[lines_range].map { |line| line[width_range] }
+    end
+
+    protected
+
+    def reset_width!
+      @width = nil
+    end
+
+    def clean line
+      Array split(line)
+    end
+
+    def split line
+      line.split /\r\n|\n\r|\n|\r/
+    end
+  end
+end

data/lib/remedy/version.rb

@@ -0,0 +1,3 @@
+module Remedy
+  VERSION = "0.0.3.pre"
+end

data/lib/remedy/view.rb

@@ -0,0 +1,43 @@
+module Remedy
+  class View
+    def initialize body, header = [], footer = []
+      @header, @body, @footer = header, body, footer
+    end
+    attr_accessor :body, :header, :footer, :length
+
+    def to_s force_recompile = false
+      unless @view.nil? || force_recompile then
+        @view
+      else
+        reset_length!
+        @view = compile!
+      end
+    end
+
+    protected
+
+    def compile!
+      compiled_view = String.new
+      reset_length!
+
+      merged.each do |line|
+        compiled_view << row(line)
+      end
+
+      compiled_view
+    end
+
+    def merged
+      @header.to_a + @body.to_a + @footer.to_a
+    end
+
+    def row line
+      @length += 1
+      "#{line}#{ANSI.cursor.next_line}"
+    end
+
+    def reset_length!
+      @length = 0
+    end
+  end
+end

data/lib/remedy/viewport.rb

@@ -0,0 +1,58 @@
+require 'remedy/view'
+require 'remedy/size'
+require 'remedy/content'
+
+module Remedy
+  class Viewport
+    def draw content, center = Size.new(0,0), header = [], footer = []
+      range = range_find content, center, content_size(header,footer)
+
+      if content.size.fits_into? range then
+        viewable_content = content
+      else
+        viewable_content = content.excerpt *range
+      end
+
+      view = View.new viewable_content, header, footer
+
+      ANSI.screen.safe_reset!
+      Console.output << view
+    end
+
+    def range_find map, center, heightwidth
+      row_size, col_size = heightwidth
+      row_limit, col_limit = map.size
+
+      center_row, center_col = center.coords
+
+      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]
+      size - trim
+    end
+
+    def size
+      Size Console.size
+    end
+
+    def center_range center, width, limit
+      range_start = center - (width / 2)
+
+      if range_start + width > limit then
+        range_start = limit - width
+      end
+
+      if range_start < 0 then
+        range_start = 0
+      end
+
+      range_end = range_start + width
+
+      (range_start...range_end)
+    end
+  end
+end

data/remedy.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remedy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "remedy"
+  gem.version       = Remedy::VERSION
+  gem.authors       = ["Anthony M. Cook"]
+  gem.email         = ["anthonymichaelcook@gmail.com"]
+  gem.description   = %q{Pure Ruby console interaction library in the vein of Curses with baked-in MVC support.}
+  gem.summary       = %q{MVC Console Interaction Library}
+  gem.homepage      = "http://github.com/acook/remedy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: remedy
+version: !ruby/object:Gem::Version
+  version: 0.0.3.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Anthony M. Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-31 00:00:00.000000000 Z
+dependencies: []
+description: Pure Ruby console interaction library in the vein of Curses with baked-in
+  MVC support.
+email:
+- anthonymichaelcook@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/remedy.rb
+- lib/remedy/ansi.rb
+- lib/remedy/characters.rb
+- lib/remedy/console.rb
+- lib/remedy/console_resized.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
+- lib/remedy/partial.rb
+- lib/remedy/version.rb
+- lib/remedy/view.rb
+- lib/remedy/viewport.rb
+- remedy.gemspec
+homepage: http://github.com/acook/remedy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MVC Console Interaction Library
+test_files: []
+has_rdoc: