nyan 0.0.3 → 0.0.4

data/.gitignore

@@ -3,3 +3,4 @@
 .rvmrc
 Gemfile.lock
 pkg/*
+tmp/*

data/README.md

@@ -5,6 +5,8 @@ Your favourite aging meme is reheated as an RSpec custom formatter.
 
 For entertainment purposes only.
 
+![NYAN?](https://github.com/kapoq/nyan/raw/master/docs/nyan_animated.gif)
+
 FAQ
 ---
 
@@ -35,6 +37,7 @@ Probably need a new graphics card or something.
 Requirements
 ------------
 
+* Your terminal window should have a **black background** and be at least 180 columns x 50 rows.
 * RSpec 2 (tested against RSpec 2.6)
 
 Install
@@ -51,14 +54,15 @@ Alternatively install directly:
 Usage
 -----
 
+Your terminal window should have a **black background** and be at
+least 180 columns x 50 rows.
+
     $ rspec spec -f Nyan::Formatter
 
 Or if you want the joy of Nyan without running specs, use the binary:
 
     $ nyan
 
-Your terminal should be at least 180 columns x 50 rows.
-
 Development
 -----------
 

data/lib/nyan.rb

@@ -2,6 +2,7 @@ require "nyan/version"
 
 require "nyan/colour"
 require "nyan/shape"
+require "nyan/buffer"
 require "nyan/sprite"
 require "nyan/stage"
 
@@ -11,6 +12,7 @@ module Nyan
   BLOCK   = "\xE2\x96\x88"
   SPACE   = "\x20"
   NEWLINE = "\n"
+  NOTHING = ""
   
   require "nyan/sprites/rainbow"
   require "nyan/sprites/cat_head"

data/lib/nyan/buffer.rb

@@ -0,0 +1,18 @@
+module Nyan
+  class Buffer < Array
+    def initialize(height, width, default)
+      @height  = height
+      @width   = width
+      @default = default
+      super(height) do
+        Array.new(width) do
+          default
+        end
+      end
+    end
+
+    def to_s
+      join
+    end
+  end
+end

data/lib/nyan/colour.rb

@@ -2,26 +2,36 @@ require 'ansi'
 include ANSI::Code
 
 module Nyan
-  module Colour    
+  module Colour
+    TWINKLY = "X"
+    
     MAP = {
       "#" => "#{bright}#{black}",
       "b" => "#{dark}#{black}",
       "R" => "#{bright}#{magenta}",
       "p" => "#{dark}#{magenta}",
-      "2" => "#{bright}#{yellow}",
       "`" => "#{dark}#{yellow}",
       "o" => "#{bright}#{white}",
       "_" => "#{bright}#{white}",
       "." => "#{dark}#{white}",
       "1" => "#{bright}#{red}",
+      "2" => "#{bright}#{yellow}",
       "3" => "#{bright}#{green}",
       "4" => "#{bright}#{blue}",
-      "5" => "#{bright}#{magenta}"
+      "5" => "#{bright}#{magenta}",
     }
 
+    def self.twinkly?(char)
+      TWINKLY == char
+    end
+    
     def self.colourize(char)
-      escape_codes = MAP.fetch(char, reset)
-      "#{escape_codes}#{Nyan::BLOCK}"
+      escape_codes = if twinkly?(char)
+                       rand > 0.5 ? "#{bright}#{white}" : "#{bright}#{black}"
+                     else
+                       MAP.fetch(char, "")
+                     end
+      "#{escape_codes}#{BLOCK}"
     end
   end
 end

data/lib/nyan/flight.rb

@@ -1,10 +1,10 @@
 module Nyan
   class Flight
-    def initialize
-      @stage   = Stage.new
-      
+    def initialize(options = {})
+      @framerate = options.fetch(:framerate, 0.09)
+            
+      @stage    = Stage.new(options.fetch(:stage, {}))
       @rainbow  = Sprite.new(:x => 0, :y => 17, :z => 1, :frames => Nyan::Rainbow.to_frames)
-
       @cat_head = Sprite.new(:x        => Nyan::Rainbow::TOTAL_LENGTH - 2,
                             :y         => 17,
                             :z         => 100,
@@ -19,7 +19,6 @@ module Nyan
                               when [:offset, :initial]  then @x -= 2
                               end
                             end)
-
       @pop_tart = Sprite.new(:x => @cat_head.x - 20,
                             :y => @cat_head.y - 2,
                             :z => @cat_head.z - 1,
@@ -34,7 +33,7 @@ module Nyan
     def next!
       maybe_add_a_twinkly_star
       @stage.play!
-      while Time.now - @tick_time < 0.09; end
+      while Time.now - @tick_time < @framerate; end
       @tick_time = Time.now
     end
 

data/lib/nyan/sprites/star.rb

@@ -75,7 +75,7 @@ X.........X
 EOF
 
     def self.to_frames
-      @frames ||= SHAPE_LIST.gsub(/\./, SPACE).gsub(/X/, "@").split(/--./m)
+      @frames ||= SHAPE_LIST.gsub(/\./, SPACE).split(/--./m)
     end
   end
 end

data/lib/nyan/stage.rb

@@ -1,9 +1,6 @@
 module Nyan
   class Stage
     include Shape
-
-    SPACE   = "\x20"
-    NOTHING = ""
     
     attr_reader :output, :height, :width
     
@@ -35,7 +32,7 @@ module Nyan
 
     def render
       clear_buffer
-      sprites.sort.each { |s| write_to_buffer(s) }
+      sprites.sort.reverse.each { |s| write_to_buffer(s) }
       print_buffer
     end
 
@@ -70,40 +67,46 @@ module Nyan
     private
 
     def clear_buffer
-      @buffer = Array.new(height) do
-        Array.new(width) do
-          { :char => SPACE, :colourized_char => SPACE }
-        end
-      end
+      @buffer = Buffer.new(height, width, SPACE)
     end
     
     def write_to_buffer(sprite)
-      sprite.lines.each_with_index do |line, i|
-        line_y = sprite.y + i
-        previous_colourized_char = nil
-        if line_y.between?(top, bottom)
-          line.chomp.chars.each_with_index do |char, j|
-            char_x = sprite.x + j
-            if char_x.between?(left, right) && char != Nyan::SPACE
-              colourized_char = Colour.colourize(char)
-              colourized_char = Nyan::BLOCK if colourized_char == previous_colourized_char
-              @buffer[line_y][char_x] = { :char => char, :colourized_char => colourized_char }
-              previous_colourized_char = colourized_char
-            end
+      sprite.lines.each_with_index do |row, i|
+        @last_char_with_colour = nil
+        y = sprite.y + i
+        next unless y.between?(top, bottom)
+        row.chomp.chars.each_with_index do |char, j|
+          x = sprite.x + j
+          next unless x.between?(left, right)
+          if char_writeable?(char) && buffer_writeable_at_point?(x, y)
+            @buffer[y][x] = coloured? && new_colour_or_continue(char) || char
+          else
+            @last_char_with_colour = nil
           end
         end
       end
     end
 
-    def print_buffer
-      key = coloured? ? :colourized_char : :char
-      @buffer.each_with_index do |row, i|
-        output.print move(i, 0)
-        output.print clear_line
-        output.print reset
-        output.print row.map { |h| h[key] }.join
-        output.print "\n" unless i == bottom
+    def char_writeable?(char)
+      SPACE != char
+    end
+      
+    def buffer_writeable_at_point?(x, y)
+      SPACE == @buffer[y][x]
+    end
+
+    def new_colour_or_continue(char)
+      coloured_char = Colour.colourize(char)
+      if coloured_char == @last_char_with_colour
+        BLOCK
+      else
+        @last_char_with_colour = coloured_char
       end
     end
+
+    def print_buffer
+     output.print move(top, left)
+     output.print @buffer.to_s
+    end
   end
 end

data/lib/nyan/version.rb

@@ -1,3 +1,3 @@
 module Nyan
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/nyan.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.description = "Your favourite aging meme is reheated as an RSpec custom formatter. For entertainment purposes only. WARNING: enterprise-ready"
 
   s.add_dependency "ansi"
-  s.add_dependency "rspec"
+  s.add_dependency "rspec", "~> 2"
   
   s.add_development_dependency "guard-rspec"
   s.add_development_dependency "rake"

data/spec/lib/colour_spec.rb

@@ -2,14 +2,39 @@ require 'spec_helper'
 
 describe Nyan::Colour do
   describe ".colourize" do
-    it "looks up the char in the map" do
-      Nyan::Colour::MAP.should_receive(:fetch).with("X", anything)
-      Nyan::Colour.colourize("X")
+    context "when the char is not twinkly" do
+      before do
+        Nyan::Colour.stub(:twinkly? => false)
+      end
+      
+      it "looks up the char in the map" do
+        Nyan::Colour::MAP.should_receive(:fetch).with("X", anything)
+        Nyan::Colour.colourize("X")
+      end
+      
+      it "returns the escape code for the colour followed by a block char" do
+        Nyan::Colour::MAP.stub(:fetch => "__ESC__")
+        Nyan::Colour.colourize("X").should eql "__ESC__#{Nyan::BLOCK}"
+      end
     end
-    
-    it "returns the escape code for the colour followed by a block char" do
-      Nyan::Colour::MAP.stub(:fetch => "__ESC__")
-      Nyan::Colour.colourize("X").should eql "__ESC__#{Nyan::BLOCK}"
+
+    context "when the char is not twinkly" do
+      before do
+        Nyan::Colour.stub(:twinkly? => true)
+      end
+
+      it "does not look up the char in the map" do
+        Nyan::Colour::MAP.should_not_receive(:fetch)
+        Nyan::Colour.colourize("X")
+      end
+
+      it "returns a different escape code depending on the value of a random number" do
+        Nyan::Colour.should_receive(:rand).and_return(0)
+        r1 = Nyan::Colour.colourize("X")
+        Nyan::Colour.should_receive(:rand).and_return(1)
+        r2 = Nyan::Colour.colourize("X")
+        r1.should_not eq r2
+      end
     end
   end
 end

data/test/benchmarking.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler'
+
+nyan_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(nyan_dir) unless $LOAD_PATH.include?(nyan_dir)
+require "nyan"
+
+require 'benchmark'
+require 'stringio'
+
+s = StringIO.new
+real_stdout = $stdout
+$stdout     = s
+
+colour_flight = Nyan::Flight.new(:framerate => 0, :stage => { :output => real_stdout })
+bw_flight     = Nyan::Flight.new(:framerate => 0, :stage => { :output => real_stdout, :coloured => false })
+
+COUNT = 50
+Benchmark.bmbm do |b|
+  b.report("Colour:") {
+    COUNT.times { colour_flight.next! }
+  }
+  b.report("B&W:") {
+    COUNT.times { bw_flight.next! }
+  }
+end
+
+$stdout = real_stdout
+print cls
+puts s.string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nyan
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-08 00:00:00.000000000 +02:00
-default_executable: 
+date: 2011-10-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &10787560 !ruby/object:Gem::Requirement
+  requirement: &12071560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,21 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10787560
+  version_requirements: *12071560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10787140 !ruby/object:Gem::Requirement
+  requirement: &12071020 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *10787140
+  version_requirements: *12071020
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &10786720 !ruby/object:Gem::Requirement
+  requirement: &12070600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10786720
+  version_requirements: *12070600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10835020 !ruby/object:Gem::Requirement
+  requirement: &12070120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10835020
+  version_requirements: *12070120
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &10834560 !ruby/object:Gem::Requirement
+  requirement: &12069540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10834560
+  version_requirements: *12069540
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &10834140 !ruby/object:Gem::Requirement
+  requirement: &12068840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10834140
+  version_requirements: *12068840
 description: ! 'Your favourite aging meme is reheated as an RSpec custom formatter.
   For entertainment purposes only. WARNING: enterprise-ready'
 email:
@@ -94,7 +93,9 @@ files:
 - README.md
 - Rakefile
 - bin/nyan
+- docs/nyan_animated.gif
 - lib/nyan.rb
+- lib/nyan/buffer.rb
 - lib/nyan/colour.rb
 - lib/nyan/flight.rb
 - lib/nyan/formatter.rb
@@ -114,7 +115,7 @@ files:
 - spec/lib/sprite_spec.rb
 - spec/lib/stage_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+- test/benchmarking.rb
 homepage: https://github.com/kapoq/nyan
 licenses: []
 post_install_message: 
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Nyan Cat flies across your terminal while your RSpec specs run!