peter_pan 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 692af1cd2a9e3475428ba3ea1a3b432ad130b762
-  data.tar.gz: 187e9b546dec65a4fbd4d380aaeb3dfde279d396
-SHA512: 
-  metadata.gz: 767b95aafa0fea9912984b6265fe34fee6157da042dcbf8bd16c370b3b4a239e3d5d712219590c53f9fe7e07a53c5e3699122139e1b048549451378c810201ba
-  data.tar.gz: 99af0967d7d0b82ce6f339b87e19644007db8dd88236a7784c9c83c52f082e690e362884f392e2ff33461552fd91bc71272ab1d03edf6d17176c03807cbba183
+---
+SHA1:
+  metadata.gz: 32dacbc0c05b114896f17cdcc1bae4f34be30ebb
+  data.tar.gz: 39d8c536659d1a6cb8646fb244f20f94858f2e58
+SHA512:
+  metadata.gz: 08d0925b4cc12dfe91b09b6ec9c3a87be9c872f3d5633ba2ed48202991ce46672ef1110d74b47e1ad897918d48078cc4e478e8dbc2e48d5c6a53ab9628d30813
+  data.tar.gz: 54457998b07f238e54e25ab7fba97596fd09aecbebfde19f2f94c83b0493525ad85f054d75036f81e87d32ddf28a4d8775a1c49f040a9e802f91d6eff8aa2f45

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in peter_pan.gemspec
 gemspec
+
+gem 'dream-cheeky-led', '>=0.0.1.pre2'

data/README.md

@@ -1,46 +1,42 @@
-## Peter Pan - a Ruby gem providing a virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others.
+### Peter Pan - a Ruby gem providing a virtual screen buffer with viewport panning. For the Dream Cheeky LED sign and others, also works just fine with computer screen.
 
 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.
+![Animated image of words panning over an LED display](https://github.com/xunker/peter_pan/raw/master/panning_text_example.gif)
 
-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.
+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. It
+will also work just fine on your computer screen.
 
-This gem uses the "transpo" font from Lewis Clayton's dcled_ruby project
-(https://github.com/Lewis-Clayton/dcled_ruby).
+This gem uses the "transpo" font from Lewis Clayton's [dcled_ruby](https://github.com/Lewis-Clayton/dcled_ruby) project.
 
 ## Installation
 
-Install normally:
+Install normally: `$ gem install peter_pan`
 
-    $ gem install peter_pan
+And then require it normally: `require 'peter_pan'`
 
-And then require it normally:
+To write to a Dream Cheeky LED sign using `examples/*.rb`, also
+install the most current version of the [dream-cheeky-led](https://github.com/Aupajo/dream-cheeky-led) gem:
 
-```ruby
-  require 'peter_pan'
+```shell
+$ gem install dream-cheeky-led --pre
 ```
 
-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
+If you are using Bundler to install the dependencies, version "0.0.1.pre2" or
+greater will be installed automatically
 
 ## Examples
 
-There are basic examples in the `examples/` directory:
+There are basic examples in the `examples/` directory that illustrate basic
+concepts of drawing text to the buffer and panning the viewport over the it.
 
-    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.
+* `bouncer_dream_cheeky.rb` - A pixel that bounces around the Dream Cheeky LED sign.
+* `pan_dream_cheeky.rb` - Pans the Dream Cheeky LED sign over a larger virtual buffer.
+* `pan_to_screen.rb` - Same as _pan_dream_cheeky.rb_, but outputs to screen -- no Dream Cheeky LED sign required!
 
 ## Usage
 
@@ -148,10 +144,10 @@ To print the buffer and viewport without the ascii-art borders, replace
 > p = PeterPan.new( viewport_width: 5, viewport_height: 5 )
 > p.write(0, 0, "Hello.")
 > puts p.show_viewport(5,0)
-     
-     
+
+
   ***
- *   
+ *
  ****
 ```
 
@@ -160,8 +156,29 @@ without the enclosing border.
 
 ### Animated panning the viewport
 
-Please see the examples in `examples/`.
+Check out `examples/pan_dream_cheeky.rb` and `examples/pan_to_screen.rb` to see
+how to animate the movement of the viewport over the buffer.
+
+[This animated image](https://github.com/xunker/peter_pan/raw/master/panning_text_example.gif) shows how `examples/pan_dream_cheeky.rb` looks when running on an actual Dream Cheeky LED sign.
 
 ## Documentation
 
-TODO: add link to RDOC here.
+Detailed docs available [at rubydoc.org](http://rubydoc.org/github/xunker/peter_pan/master/frames)
+
+
+## Source
+
+Source lives on Github: [xunker/peter_pan](https://github.com/xunker/peter_pan).
+
+## Contributing
+
+You'll notice there are no tests in this repo, and that's my fault. That means
+that if you'd like to make some changes or fix some bug, you don't need to
+write tests if you don't want to! Yay!
+
+Here's the process if you'd like to contribute:
+
+  * Fork the repo.
+  * Make your changes. If you can, please make your changes in a topic branch, not master.
+  * Test your changes as well as you can. I'll believe you if you say you did.
+  * Make a pull request.

data/examples/bouncer_dream_cheeky.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#
+# Makes a virtual "ball" bounce around the screen. Uses the peter_pan gem and
+# dream-cheeky-led gem (https://github.com/Aupajo/dream-cheeky-led).
+require 'peter_pan'
+require 'dream-cheeky/led'
+
+message_board = DreamCheeky::LEDMessageBoard.first
+
+height = 7
+width = 21
+
+p = PeterPan.new(
+  viewport_width: width,
+  viewport_height: height,
+  buffer_width: width,
+  buffer_height: height
+)
+
+position_x = rand(6)
+position_y = rand(20)
+
+direction_x = 1
+direction_y = 1
+
+buffer = []
+height.times do
+  buffer << []
+  width.times do
+    buffer.last << 0
+  end
+end
+loop do
+  buffer.each_with_index do |bx, i|
+    buffer[i] = bx.map{|v| v -= 1 if v > 0; v}
+  end
+
+  direction_x = -1 if position_x >= (height-1)
+  direction_y = -1 if position_y >= (width-1)
+  direction_x = 1 if position_x <= 0
+  direction_y = 1 if position_y <= 0
+
+  position_x += direction_x
+  position_y += direction_y
+  
+  buffer[position_x][position_y] = 8
+
+  buffer.each_with_index do |bx, i|
+    # puts bx.map{|v|(v == 0 ? ' ' : v)}.join
+    bx.each_with_index do |by, ii|
+      p.plot(ii,i, (by > 0 ? by : ' '))
+    end
+  end
+  puts p.show_buffer
+
+  message_board.draw(p.show_buffer)
+
+  # message_board.draw_pixels(buffer)
+  # message_board.draw_pixels(buffer.map{|b|b.map{|v|(v>0?1:0)}})
+  sleep 0.04
+  print "\e[2J\e[f" # clear screen
+end

data/lib/peter_pan.rb

@@ -11,7 +11,7 @@ require 'yaml'
 class PeterPan
   attr_reader :viewport_width, :viewport_height, :empty_point_character
 
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 
   # Possible Options:
   #
@@ -155,7 +155,7 @@ class PeterPan
   # 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 
+  # 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)
@@ -171,7 +171,7 @@ class PeterPan
 
   # returns a data structure representing the current font used by #write.
   def font
-    @font ||= YAML.load(File.new("./fonts/#{@font_name}.yml").read)
+    @font ||= YAML.load(File.new("#{Gem.loaded_specs['peter_pan'].full_gem_path}/fonts/#{@font_name}.yml").read)
   end
 
 private
@@ -192,7 +192,7 @@ private
         (by.size-1).upto(buffer_width-1) do |i|
           by[i] = @empty_point_character
         end
-      end 
+      end
     end
 
     buffer_changed!

data/peter_pan.gemspec

@@ -13,11 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/xunker/peter_pan"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).reject{|fn| fn =~ /\.gif$/}
   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"
+  spec.add_development_dependency "rake", "~> 0"
 end

metadata

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