peter_pan 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32dacbc0c05b114896f17cdcc1bae4f34be30ebb
-  data.tar.gz: 39d8c536659d1a6cb8646fb244f20f94858f2e58
+  metadata.gz: 7af280d2399f0a47856d1bae570e0c98176d7369
+  data.tar.gz: c405a19e53f81ea1721d606602536e2a633885dc
 SHA512:
-  metadata.gz: 08d0925b4cc12dfe91b09b6ec9c3a87be9c872f3d5633ba2ed48202991ce46672ef1110d74b47e1ad897918d48078cc4e478e8dbc2e48d5c6a53ab9628d30813
-  data.tar.gz: 54457998b07f238e54e25ab7fba97596fd09aecbebfde19f2f94c83b0493525ad85f054d75036f81e87d32ddf28a4d8775a1c49f040a9e802f91d6eff8aa2f45
+  metadata.gz: dda7045e56251553a8f2b9c2d25fde495f92da5fd03517f127ec1e63c62937438c3a2eaa8c580c3be4e969acf81f91edb61ffa7e9976e8844b1f5a55e65831f5
+  data.tar.gz: 17ccf499dfb2360f770bfdbec8e65bd799c2637075ccdf7ef5a002005ac57e98e86b57673b1a39ee646a474874b96dad81651fa63204c732a45aa31e10fd9585

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.2.2
+  - 2.1.5
+  - 2.0.0
+sudo: false
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'dream-cheeky-led', '>=0.0.1.pre2'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,44 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/peter_pan.svg)](http://badge.fury.io/rb/peter_pan)
 ### 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
@@ -165,6 +166,17 @@ how to animate the movement of the viewport over the buffer.
 
 Detailed docs available [at rubydoc.org](http://rubydoc.org/github/xunker/peter_pan/master/frames)
 
+## Changes
+
+### 1.1.0 July 16, 2015
+`#write` will remove characters that are not in the included font.
+
+### 1.0.1 July 15, 2015
+Fixed issue with loading font file.
+
+### 1.0.0
+Initial Release
+
 
 ## Source
 
@@ -172,13 +184,10 @@ 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 sure the existing tests pass.
+  * Write tests for your feature/fix.
   * Make a pull request.

data/Rakefile

@@ -1 +1,12 @@
+#!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+require "rspec/core/version"
+
+task default: :spec
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec, :default) do |t|
+  t.ruby_opts = %w[-w]
+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.1"
+  VERSION = "1.1.0"
 
   # Possible Options:
   #
@@ -128,7 +128,7 @@ class PeterPan
   end
 
   # Same as #path_viewport, but with an ascii-art border around each frame.
-  def pretty_pan_viewport(*coordinates)
+  def pretty_path_viewport(*coordinates)
     path_viewport(coordinates).map{|vp| wrap_frame_with_border(vp) }
   end
 
@@ -143,11 +143,10 @@ class PeterPan
   end
 
   # Write a string to the buffer at the given coordinates.
-  def write(x, y, message)
-    letter_x = x
+  def write(letter_x, letter_y, message)
     message.split('').each do |c|
-      char = font['characters'][c].map{|l|l.gsub('.', @empty_point_character)}
-      plot_sprite(char, letter_x, y)
+      char = font_character(c)
+      plot_sprite(char, letter_x, letter_y)
       letter_x = letter_x + font['width'] + 1
     end
   end
@@ -176,6 +175,12 @@ class PeterPan
 
 private
 
+  # return the font character for a given character. If no character exists,
+  # return '?' instead.
+  def font_character(char)
+    (font['characters'][char] || font['characters']['?']).map{|l|l.gsub('.', @empty_point_character)}
+  end
+
   def buffer_changed!(val = true)
     @buffer_changed = val
   end

data/peter_pan.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign, but also works with a plain old computer screen.}
+  spec.summary       = %q{A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign, but also works with a plain old computer screen.}
   spec.homepage      = "https://github.com/xunker/peter_pan"
   spec.license       = "MIT"
 
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/lib/peter_pan_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe PeterPan do
+  describe '#write' do
+    let(:letter_x) { 0 }
+    let(:letter_y) { 1 }
+    it 'writes all characters in the string to the buffer' do
+      chars = 'ABC'
+      chars.split('').each do |char|
+        expected_character = subject.send(:font_character, char)
+        expect(subject).to receive(:plot_sprite).with(expected_character, letter_x, letter_y)
+        subject.write(letter_x, letter_y, char)
+      end
+    end
+    context 'font does not have a character' do
+      let(:char) { 'あ' }
+      it 'prints ? instead' do
+        ques_character = subject.send(:font_character, '?')
+        expect(subject).to receive(:plot_sprite).with(ques_character, letter_x, letter_y)
+        subject.write(letter_x, letter_y, char)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peter_pan
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A virtual screen buffer with viewport panning. For the Dream Cheeky LED
-  sign and others.
+  sign, but also works with a plain old computer screen.
 email:
 - xunker@pyxidis.org
 executables: []
@@ -47,7 +61,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -57,6 +74,8 @@ files:
 - fonts/transpo.yml
 - lib/peter_pan.rb
 - peter_pan.gemspec
+- spec/lib/peter_pan_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/xunker/peter_pan
 licenses:
 - MIT
@@ -80,6 +99,8 @@ rubyforge_project:
 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.
-test_files: []
+summary: A virtual screen buffer with viewport panning. For the Dream Cheeky LED sign,
+  but also works with a plain old computer screen.
+test_files:
+- spec/lib/peter_pan_spec.rb
+- spec/spec_helper.rb