peter_pan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 692af1cd2a9e3475428ba3ea1a3b432ad130b762
+  data.tar.gz: 187e9b546dec65a4fbd4d380aaeb3dfde279d396
+SHA512: 
+  metadata.gz: 767b95aafa0fea9912984b6265fe34fee6157da042dcbf8bd16c370b3b4a239e3d5d712219590c53f9fe7e07a53c5e3699122139e1b048549451378c810201ba
+  data.tar.gz: 99af0967d7d0b82ce6f339b87e19644007db8dd88236a7784c9c83c52f082e690e362884f392e2ff33461552fd91bc71272ab1d03edf6d17176c03807cbba183

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Nielsen
+
+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.md

@@ -0,0 +1,167 @@
+## Peter Pan - a Ruby gem providing a virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.
+
+Peter Pan gives you a large, virtual text frame buffer and a virtual
+viewport you can move around over it. You can plot points or draw text in the
+buffer and scroll the viewport over it to simulate scrolling text or scrolling
+graphics.
+
+It was written to make it easier to get text on the Dream Cheeky LED sign, but
+it'll work for any thing that that accepts a formatted text string as input.
+
+The dream-cheeky-led gem (https://github.com/Aupajo/dream-cheeky-led) is not a
+dependency, but it can be used in conjunction with this gem to get scrolling
+text and graphics on your Dream Cheeky LED sign.
+
+This gem uses the "transpo" font from Lewis Clayton's dcled_ruby project
+(https://github.com/Lewis-Clayton/dcled_ruby).
+
+## Installation
+
+Install normally:
+
+    $ gem install peter_pan
+
+And then require it normally:
+
+```ruby
+  require 'peter_pan'
+```
+
+To write to a Dream Cheeky LED sign using `examples/dream_cheeky.rb`, also
+install the dream-cheeky-led gem:
+
+    $ gem install dream-cheeky-led --pre
+
+## Examples
+
+There are basic examples in the `examples/` directory:
+
+    dream_cheeky.rb: write to a USB Dream Cheeky Sign
+    to_screen.rb:    write to the screen
+
+These examples show the basic concepts of drawing text to the buffer and
+panning the viewport over the buffer.
+
+## Usage
+
+### Dots
+
+Print dots to the buffer, render the viewport in two places illustrating how
+it only shows the area of the newport:
+
+```ruby
+> require 'peter_pan'
+> p = PeterPan.new
+> p.plot(1,1)
+> p.plot(3,3)
+> p.plot(8,8)
+> p.plot(21,2)
+> p.plot(25,4)
+> puts p.pretty_print_buffer
++--------------------------+
+|                          |
+| *                        |
+|                     *    |
+|   *                      |
+|                         *|
+|                          |
+|                          |
+|                          |
+|                          |
++--------------------------+
+> puts p.pretty_print_viewport(0,0)
++---------------------+
+|                     |
+| *                   |
+|                     |
+|   *                 |
+|                     |
+|                     |
+|                     |
++---------------------+
+> puts p.pretty_print_viewport(5,0)
++---------------------+
+|                     |
+|                     |
+|                *    |
+|                     |
+|                    *|
+|                     |
+|                     |
++---------------------+
+```
+
+### Text
+
+Print text to the buffer and render the viewport over a portion.
+
+```ruby
+> require 'peter_pan'
+> p = PeterPan.new
+> p.write(0, 0, "Hello.")
+> puts p.pretty_print_buffer
++-----------------------------------+
+|*   *        **    **              |
+|*   *         *     *              |
+|*   *  ***    *     *    ***       |
+|***** *   *   *     *   *   *      |
+|*   * *****   *     *   *   *      |
+|*   * *       *     *   *   *  **  |
+|*   *  ***   ***   ***   ***   **  |
++-----------------------------------+
+> puts p.pretty_print_viewport(5,0)
++---------------------+
+|        **    **     |
+|         *     *     |
+|  ***    *     *    *|
+| *   *   *     *   * |
+| *****   *     *   * |
+| *       *     *   * |
+|  ***   ***   ***   *|
++---------------------+
+```
+
+### Change viewport size
+
+The viewport dimensions default to 21x7, the size of the Dream Cheeky LED,
+but can be changed by passing arguments to the initializer.
+
+```ruby
+> p = PeterPan.new( viewport_width: 5, viewport_height: 5 )
+> p.write(0, 0, "Hello.")
+> puts p.pretty_print_viewport(5,0)
++-----+
+|     |
+|     |
+|  ***|
+| *   |
+| ****|
++-----+
+```
+
+### Printing without ascii borders
+
+To print the buffer and viewport without the ascii-art borders, replace
+`pretty_print_viewport`  with 'show_viewport` using the same arguments:
+
+```ruby
+> p = PeterPan.new( viewport_width: 5, viewport_height: 5 )
+> p.write(0, 0, "Hello.")
+> puts p.show_viewport(5,0)
+     
+     
+  ***
+ *   
+ ****
+```
+
+All other `pretty_*` methods have `show_*` counterparts that will return data
+without the enclosing border.
+
+### Animated panning the viewport
+
+Please see the examples in `examples/`.
+
+## Documentation
+
+TODO: add link to RDOC here.

data/Rakefile

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

data/examples/dream_cheeky.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+#
+# Example of using peter_pan with the Dream Cheeky LED display via the
+# dream-cheeky-led gem (https://github.com/Aupajo/dream-cheeky-led).
+require 'peter_pan'
+require 'dream-cheeky/led'
+
+p = PeterPan.new
+
+lines = [
+  "One",
+  "Two",
+  "Three",
+  "Four",
+  "Five"
+]
+
+lines.each_with_index do |line, i|
+  p.write(0, (i*p.font["height"])+(1*i), line)
+end
+
+puts p.pretty_print_buffer
+
+message_board = DreamCheeky::LEDMessageBoard.first
+
+loop do
+  coords = [
+    [0,0],
+    [0, p.buffer_height-p.font["height"]],
+    [p.buffer_width-p.viewport_width, p.buffer_height-p.font["height"]],
+    [p.buffer_width-p.viewport_width, 0],
+    [0,0]
+  ]
+
+  p.path_viewport(coords).each do |vp|
+    message_board.draw(vp)
+    sleep(0.05)
+  end
+end

data/examples/to_screen.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+#
+# Draws words to the virtual butter and then pans the viewport around it.
+require 'peter_pan'
+
+p = PeterPan.new
+
+lines = [
+  "One",
+  "Two",
+  "Three"
+]
+
+lines.each_with_index do |line, i|
+  p.write(0, (i*p.font["height"])+(1*i), line)
+end
+
+loop do
+  coords = [
+    [0,0],
+    [0, p.buffer_height-p.font["height"]],
+    [p.buffer_width-p.viewport_width, p.buffer_height-p.font["height"]],
+    [p.buffer_width-p.viewport_width, 0],
+    [0,0]
+  ]
+
+  p.pretty_pan_viewport(coords).each do |vp|
+    print "\e[2J\e[f" # clear screen
+    puts p.pretty_print_buffer # print whole buffer
+    puts vp # print current viewport frame
+    sleep(0.1)
+  end
+
+end

data/fonts/transpo.yml

@@ -0,0 +1,757 @@
+name: 'transpo'
+version: '0.0.1'
+width: 5
+height: 7
+characters:
+  ' ':
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  '!':
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.....'
+  - '..*..'
+  - '..*..'
+  '"':
+  - '.*.*.'
+  - '.*.*.'
+  - '.*.*.'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  '#':
+  - '.*.*.'
+  - '.*.*.'
+  - '*****'
+  - '.*.*.'
+  - '*****'
+  - '.*.*.'
+  - '.*.*.'
+  '$':
+  - '.*...'
+  - '.*.*.'
+  - '.***.'
+  - '...*.'
+  - '...*.'
+  - '.....'
+  - '.....'
+  '%':
+  - '**...'
+  - '**..*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*..**'
+  - '...**'
+  '&':
+  - '.*...'
+  - '*.*..'
+  - '*.*..'
+  - '.*...'
+  - '*.*.*'
+  - '*..*.'
+  - '.**.*'
+  "'":
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  '(':
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '.*...'
+  - '.*...'
+  - '..*..'
+  - '...*.'
+  ')':
+  - '.*...'
+  - '..*..'
+  - '...*.'
+  - '...*.'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  '*':
+  - '.....'
+  - '..*..'
+  - '*.*.*'
+  - '.***.'
+  - '*.*.*'
+  - '..*..'
+  - '.....'
+  '+':
+  - '.....'
+  - '..*..'
+  - '..*..'
+  - '*****'
+  - '..*..'
+  - '..*..'
+  - '.....'
+  ',':
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.**..'
+  - '..*..'
+  - '.*...'
+  '-':
+  - '.....'
+  - '.....'
+  - '.....'
+  - '*****'
+  - '.....'
+  - '.....'
+  - '.....'
+  '.':
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.**..'
+  - '.**..'
+  '/':
+  - '.....'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*....'
+  - '.....'
+  '0':
+  - '.***.'
+  - '*...*'
+  - '*..**'
+  - '*.*.*'
+  - '**..*'
+  - '*...*'
+  - '.***.'
+  '1':
+  - '..*..'
+  - '.**..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.***.'
+  '2':
+  - '.***.'
+  - '*...*'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*****'
+  '3':
+  - '*****'
+  - '...*.'
+  - '..*..'
+  - '...*.'
+  - '....*'
+  - '*...*'
+  - '.***.'
+  '4':
+  - '...*.'
+  - '..**.'
+  - '.*.*.'
+  - '*..*.'
+  - '*****'
+  - '...*.'
+  - '...*.'
+  '5':
+  - '*****'
+  - '*....'
+  - '****.'
+  - '....*'
+  - '....*'
+  - '*...*'
+  - '.***.'
+  '6':
+  - '..**.'
+  - '.*...'
+  - '*....'
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  '7':
+  - '*****'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '.*...'
+  - '.*...'
+  '8':
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  '9':
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '.****'
+  - '....*'
+  - '...*.'
+  - '.**..'
+  ':':
+  - '.....'
+  - '.**..'
+  - '.**..'
+  - '.....'
+  - '.**..'
+  - '.**..'
+  - '.....'
+  ';':
+  - '.....'
+  - '.**..'
+  - '.**..'
+  - '.....'
+  - '.**..'
+  - '..*..'
+  - '.*...'
+  '<':
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*....'
+  - '.*...'
+  - '..*..'
+  - '...*.'
+  '=':
+  - '.....'
+  - '.....'
+  - '*****'
+  - '.....'
+  - '*****'
+  - '.....'
+  - '.....'
+  '>':
+  - '.*...'
+  - '..*..'
+  - '...*.'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  '?':
+  - '.***.'
+  - '*...*'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.....'
+  - '..*..'
+  '@':
+  - '.***.'
+  - '*...*'
+  - '*.*.*'
+  - '*.***'
+  - '*.*..'
+  - '*....'
+  - '.****'
+  'A':
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '*****'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  'B':
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  'C':
+  - '.***.'
+  - '*...*'
+  - '*....'
+  - '*....'
+  - '*....'
+  - '*...*'
+  - '.***.'
+  'D':
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  'E':
+  - '*****'
+  - '*....'
+  - '*....'
+  - '****.'
+  - '*....'
+  - '*....'
+  - '*****'
+  'F':
+  - '*****'
+  - '*....'
+  - '*....'
+  - '****.'
+  - '*....'
+  - '*....'
+  - '*....'
+  'G':
+  - '.***.'
+  - '*...*'
+  - '*....'
+  - '*.***'
+  - '*...*'
+  - '*...*'
+  - '.****'
+  'H':
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*****'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  'I':
+  - '.***.'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.***.'
+  'J':
+  - '..***'
+  - '...*.'
+  - '...*.'
+  - '...*.'
+  - '...*.'
+  - '*..*.'
+  - '.**..'
+  'K':
+  - '*...*'
+  - '*..*.'
+  - '*.*..'
+  - '**...'
+  - '*.*..'
+  - '*..*.'
+  - '*...*'
+  'L':
+  - '*....'
+  - '*....'
+  - '*....'
+  - '*....'
+  - '*....'
+  - '*....'
+  - '*****'
+  'M':
+  - '*...*'
+  - '**.**'
+  - '*.*.*'
+  - '*.*.*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  'N':
+  - '*...*'
+  - '*...*'
+  - '**..*'
+  - '*.*.*'
+  - '*..**'
+  - '*...*'
+  - '*...*'
+  'O':
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  'P':
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  - '*....'
+  - '*....'
+  - '*....'
+  'Q':
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*.*.*'
+  - '*..*.'
+  - '.**.*'
+  'R':
+  - '****.'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  - '*.*..'
+  - '*..*.'
+  - '*...*'
+  'S':
+  - '.****'
+  - '*....'
+  - '*....'
+  - '.***.'
+  - '....*'
+  - '....*'
+  - '****.'
+  'T':
+  - '*****'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  'U':
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  'V':
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.*.*.'
+  - '.*.*.'
+  - '..*..'
+  'W':
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*.*.*'
+  - '*.*.*'
+  - '.*.*.'
+  'X':
+  - '*...*'
+  - '*...*'
+  - '.*.*.'
+  - '..*..'
+  - '.*.*.'
+  - '*...*'
+  - '*...*'
+  'Y':
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.*.*.'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  'Z':
+  - '*****'
+  - '....*'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*....'
+  - '*****'
+  '[':
+  - '..**.'
+  - '.*..*'
+  - '*...*'
+  - '*****'
+  - '*...*'
+  - '*..*.'
+  - '.**..'
+  '\':
+  - '.....'
+  - '*....'
+  - '.*...'
+  - '..*..'
+  - '...*.'
+  - '....*'
+  - '.....'
+  ']':
+  - '**...'
+  - '..*..'
+  - '..*..'
+  - '...*.'
+  - '..*..'
+  - '..*..'
+  - '**...'
+  '^':
+  - '..*..'
+  - '.*.*.'
+  - '*...*'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  '_':
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '*****'
+  '`':
+  - '..*..'
+  - '..*..'
+  - '...*.'
+  - '.....'
+  - '.....'
+  - '.....'
+  - '.....'
+  'a':
+  - '.....'
+  - '.....'
+  - '.***.'
+  - '....*'
+  - '.****'
+  - '*...*'
+  - '.****'
+  'b':
+  - '*....'
+  - '*....'
+  - '*.**.'
+  - '**..*'
+  - '*...*'
+  - '*...*'
+  - '****.'
+  'c':
+  - '.....'
+  - '.....'
+  - '.***.'
+  - '*....'
+  - '*....'
+  - '*...*'
+  - '.***.'
+  'd':
+  - '....*'
+  - '....*'
+  - '.**.*'
+  - '*..**'
+  - '*...*'
+  - '*...*'
+  - '.****'
+  'e':
+  - '.....'
+  - '.....'
+  - '.***.'
+  - '*...*'
+  - '*****'
+  - '*....'
+  - '.***.'
+  'f':
+  - '..**.'
+  - '.*..*'
+  - '.*...'
+  - '***..'
+  - '.*...'
+  - '.*...'
+  - '.*...'
+  'g':
+  - '.....'
+  - '.****'
+  - '*...*'
+  - '*...*'
+  - '.****'
+  - '....*'
+  - '.***.'
+  'h':
+  - '*....'
+  - '*....'
+  - '*.**.'
+  - '**..*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  'i':
+  - '..*..'
+  - '.....'
+  - '.**..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.***.'
+  'j':
+  - '...*.'
+  - '.....'
+  - '..**.'
+  - '...*.'
+  - '...*.'
+  - '*..*.'
+  - '.**..'
+  'k':
+  - '.*...'
+  - '.*...'
+  - '.*..*'
+  - '.*.*.'
+  - '.**..'
+  - '.*.*.'
+  - '.*..*'
+  'l':
+  - '.**..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '.***.'
+  'm':
+  - '.....'
+  - '.....'
+  - '**.*.'
+  - '*.*.*'
+  - '*.*.*'
+  - '*...*'
+  - '*...*'
+  'n':
+  - '.....'
+  - '.....'
+  - '*.**.'
+  - '**..*'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  'o':
+  - '.....'
+  - '.....'
+  - '.***.'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.***.'
+  'p':
+  - '.....'
+  - '.....'
+  - '****.'
+  - '*...*'
+  - '****.'
+  - '*....'
+  - '*....'
+  'q':
+  - '.....'
+  - '.....'
+  - '.**.*'
+  - '*..**'
+  - '.****'
+  - '....*'
+  - '....*'
+  'r':
+  - '.....'
+  - '.....'
+  - '*.**.'
+  - '**..*'
+  - '*....'
+  - '*....'
+  - '*....'
+  's':
+  - '.....'
+  - '.....'
+  - '.***.'
+  - '*....'
+  - '.***.'
+  - '....*'
+  - '****.'
+  't':
+  - '.*...'
+  - '.*...'
+  - '***..'
+  - '.*...'
+  - '.*...'
+  - '.*..*'
+  - '..**.'
+  'u':
+  - '.....'
+  - '.....'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '*..**'
+  - '.**.*'
+  'v':
+  - '.....'
+  - '.....'
+  - '*...*'
+  - '*...*'
+  - '*...*'
+  - '.*.*.'
+  - '..*..'
+  'w':
+  - '.....'
+  - '.....'
+  - '*...*'
+  - '*...*'
+  - '*.*.*'
+  - '*.*.*'
+  - '.*.*.'
+  'x':
+  - '.....'
+  - '.....'
+  - '*...*'
+  - '.*.*.'
+  - '..*..'
+  - '.*.*.'
+  - '*...*'
+  'y':
+  - '.....'
+  - '.....'
+  - '*...*'
+  - '*...*'
+  - '.****'
+  - '....*'
+  - '.***.'
+  'z':
+  - '.....'
+  - '.....'
+  - '*****'
+  - '...*.'
+  - '..*..'
+  - '.*...'
+  - '*****'
+  '{':
+  - '...**'
+  - '..*..'
+  - '..*..'
+  - '.*...'
+  - '..*..'
+  - '..*..'
+  - '...**'
+  '|':
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  - '..*..'
+  '~':
+  - '.....'
+  - '.*...'
+  - '*.*.*'
+  - '...*.'
+  - '.....'
+  - '.....'
+  - '.....'

data/lib/peter_pan.rb

@@ -0,0 +1,246 @@
+# Peter Pan - a Ruby gem providing a virtual screen buffer with viewport
+# panning. For the Dream Cheeky LED sign and others.
+#
+# Home page at https://github.com/xunker/peter_pan
+#
+# Author::    Matthew Nielsen (mailto:xunker@pyxidis.org)
+# Copyright:: Copyright (c) 2014
+# License::   MIT
+
+require 'yaml'
+class PeterPan
+  attr_reader :viewport_width, :viewport_height, :empty_point_character
+
+  VERSION = "1.0.0"
+
+  # Possible Options:
+  #
+  # * :viewport_width - Viewport width, integer, default 21
+  # * :viewport_height - Viewport height, integer, default 7
+  # * :empty_point_character - the char of an empty cell (default ' ')
+  # * :buffer_width - Buffer width, integer, default 0
+  # * :buffer_height - Buffer height, integer, default 0
+  #
+  # NOTE: The buffer will automatically expand dimensionally to hold
+  # any point that is #plot()'ed or text written with #write().
+  def initialize(opts={})
+    @viewport_width = (opts[:viewport_width] || 21).to_i # x
+    @viewport_height = (opts[:viewport_height] || 7).to_i # y
+    @font_name = 'transpo' # only font for now
+    @empty_point_character = (opts[:empty_point_character] || ' ')
+    buffer_changed!(false)
+    clear_buffer!(
+      :width => (opts[:buffer_width] || 0),
+      :height => (opts[:buffer_height] || 0)
+    )
+  end
+
+  # Draw a point in the virtual buffer.
+  # The virtual buffer will be enlarged automatically.
+  def plot(x, y, value='*')
+    1.upto(y+1) do |i|
+      @buffer[i-1] ||= []
+      1.upto(x+1) do |ii|
+        @buffer[i-1][ii-1] ||= @empty_point_character
+      end
+    end
+
+    @buffer[y][x] = value.to_s.slice(0,1)
+
+    buffer_changed!
+  end
+
+  # Same as #show_buffer but  with an ascii-art border around it.
+  def pretty_print_buffer
+    wrap_frame_with_border(show_buffer)
+  end
+
+  # Return the current buffer as a string delimited by "\n" characters
+  def show_buffer
+    normalize_buffer_width
+
+    @buffer.map{|bx| "#{bx.join}\n" }.join
+  end
+
+  # Return an integer of the width of the buffer at it's widest point.
+  def buffer_width
+    if !@buffer_width || buffer_changed?
+      @buffer_width = 0
+      @buffer.each do |by|
+        @buffer_width = by.size if by.size > @buffer_width
+      end
+    end
+    @buffer_width
+  end
+
+  # Return an integer of the height of the buffer at it tallest point
+  def buffer_height
+    @buffer.size
+  end
+
+  # Show a viewport area of the larger buffer.
+  # width and height of the viewport can be set in the object
+  # initialization for defaults, or manually here.
+  # Returns a string delimited by "\n" characters.
+  def show_viewport(x,y,x2=@viewport_width,y2=@viewport_height)
+    normalize_buffer_width
+
+    y.upto((y2-1)+y).map do |i|
+      buffer_row = @buffer[i] || @viewport_width.times.map{@empty_point_character}
+      sprintf("%-#{x2}s", buffer_row[x..((x2-1)+x)].join) + "\n"
+    end.join
+  end
+
+  # Same as #show_viewort, but with an ascii-art border around it.
+  def pretty_print_viewport(x,y,x2=@viewport_width,y2=@viewport_height)
+    wrap_frame_with_border(show_viewport(x,y,x2,y2))
+  end
+
+  # Move the viewport over the buffer from x1/y1 to x2/y2.
+  # Returns an array of strings. Each string is a frame of the pan path
+  # of the kind returned by #show_viewport.
+  def pan_viewport(x1, y1, x2, y2)
+    calculate_integral_points(x1, y1, x2, y2).map do |px, py|
+      show_viewport(px, py)
+    end
+  end
+
+  # Same as #pan_viewport, but with an ascii-art border around each frame.
+  def pretty_pan_viewport(x1, y1, x2, y2)
+    pan_viewport(x1, y1, x2, y2).map{|vp| wrap_frame_with_border(vp) }
+  end
+
+  # Like pan_viewport, but multiple pairs of coordinates can be passed.
+  # The first pair will be used as the start and the viewport will be
+  # panned from coordinate-pair to coordinate-pair.
+  # It expects to be passed an array-like list of coordinate pairs.
+  # It returns an array of string representing the frames of the pathing.
+  def path_viewport(*coordinates)
+    coordinates.flatten!
+    start_x = coordinates.shift
+    start_y = coordinates.shift
+    coordinates.flatten.each_slice(2).map do |x,y|
+      pan = pan_viewport(start_x, start_y, x, y)
+      start_x = x
+      start_y = y
+      pan
+    end.flatten
+  end
+
+  # Same as #path_viewport, but with an ascii-art border around each frame.
+  def pretty_pan_viewport(*coordinates)
+    path_viewport(coordinates).map{|vp| wrap_frame_with_border(vp) }
+  end
+
+  # Draw a text sprint to the buffer at given coordinates.
+  # * sprite is an ARRAY of string representing the image.
+  def plot_sprite(sprite, x, y)
+    sprite.each_with_index do |line, line_y|
+      line.split('').each_with_index do |c, char_x|
+        plot(char_x + x, line_y + y, c)
+      end
+    end
+  end
+
+  # Write a string to the buffer at the given coordinates.
+  def write(x, y, message)
+    letter_x = x
+    message.split('').each do |c|
+      char = font['characters'][c].map{|l|l.gsub('.', @empty_point_character)}
+      plot_sprite(char, letter_x, y)
+      letter_x = letter_x + font['width'] + 1
+    end
+  end
+
+  # clears everything out of the buffer.
+  # By default, sets the buffer dimensions to 0x0. Optionally, you can pass
+  # :width and :height args and the buffer dimentions will be set accordingly.
+  # By default the buffer will be filled with space character, but you can 
+  # set the char to be used by passing :clear_with
+  def clear_buffer!(opts={})
+    opts = { :width => 0, :height => 0, :clear_with => @empty_point_character }.merge(opts)
+    @buffer = [[]]
+    opts[:height].times do |y|
+      @buffer[y] = []
+      opts[:width].times do |x|
+        @buffer[y][x] = opts[:clear_with].to_s.slice(0,1)
+      end
+    end
+    buffer_changed!
+  end
+
+  # returns a data structure representing the current font used by #write.
+  def font
+    @font ||= YAML.load(File.new("./fonts/#{@font_name}.yml").read)
+  end
+
+private
+
+  def buffer_changed!(val = true)
+    @buffer_changed = val
+  end
+
+  def buffer_changed?
+    !!@buffer_changed
+  end
+
+  def normalize_buffer_width
+    return unless buffer_changed?
+
+    @buffer.each do |by|
+      if by.size < buffer_width
+        (by.size-1).upto(buffer_width-1) do |i|
+          by[i] = @empty_point_character
+        end
+      end 
+    end
+
+    buffer_changed!
+  end
+
+
+  def wrap_frame_with_border(content)
+    content_width = content.index("\n")
+    str = "+#{'-' * content_width}+\n"
+    vp = content
+    str << vp.gsub(/^/, '|').gsub(/$/, '|').gsub(/^\|$/, '')
+    str << "+#{'-' * content_width}+\n"
+    str
+  end
+
+  # Why yes, actually, I did fail Jr. High math. Why do you ask?
+  def calculate_integral_points(x1, y1, x2, y2)
+    x_integrals = calculate_integrals(x1, x2)
+    y_integrals = calculate_integrals(y1, y2)
+
+    (x_integrals, y_integrals) = standardize_integral_lengths(x_integrals, y_integrals)
+
+    x_integrals.zip(y_integrals)
+  end
+
+  def standardize_integral_lengths(one, two)
+    while one.length < two.length
+      one.unshift(one.first)
+    end
+
+    while two.length < one.length
+      two.unshift(two.first)
+    end
+
+    [one, two]
+  end
+
+  def calculate_integrals(starting, ending)
+    integrals = []
+    if starting < ending
+      starting.upto(ending) do |i|
+        integrals << i
+      end
+    else
+      starting.downto(ending) do |i|
+        integrals << i
+      end
+    end
+    integrals
+  end
+end

data/peter_pan.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peter_pan'
+
+Gem::Specification.new do |spec|
+  spec.name          = "peter_pan"
+  spec.version       = PeterPan::VERSION
+  spec.authors       = ["Matthew Nielsen"]
+  spec.email         = ["xunker@pyxidis.org"]
+  spec.description   = %q{A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.}
+  spec.summary       = %q{A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.}
+  spec.homepage      = "https://github.com/xunker/peter_pan"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: peter_pan
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matthew Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-02-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.
+email: 
+- xunker@pyxidis.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/dream_cheeky.rb
+- examples/to_screen.rb
+- fonts/transpo.yml
+- lib/peter_pan.rb
+- peter_pan.gemspec
+homepage: https://github.com/xunker/peter_pan
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.13
+signing_key: 
+specification_version: 4
+summary: A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.
+test_files: []
+