nyan-cat-formatter 0.0.7 → 0.0.8

data/README.md

@@ -14,12 +14,28 @@ The rainbow changes colors as it runs. See it in action [here](http://vimeo.com/
 
 Works with RSpec 1.3 and RSpec 2.
 
-```
-rspec --format NyanCatFormatter
-```
+Using  Nyan Cat
+---------------
 
-Installing Nyan Cat
-----------
+You can either specify the formatting when using the `rspec` command:
+
+    rspec --format NyanCatFormatter
+
+Or add `--format NyanCatFormatter` to a `.rspec` file placed in your project's root directory,
+so that you won't have to specify the `--format` option everytime you run the command.
+
+###Using with Bundler
+
+To use Nyan Cat with a project that uses Bundler (Rails or Sinatra f.e.) you need to add Nyan Cat dependecy to your Gemfile:
+
+    group :test do
+      gem "nyan-cat-formatter"
+    end
+
+And then run `bundle install`.
+
+Installing it
+-------------
 
 ```
 $ gem install nyan-cat-formatter
@@ -31,22 +47,34 @@ If you want to use Nyan Cat as your default formatter, simply put the options in
 --format NyanCatFormatter
 ```
 
-Using with Rails rake spec
-----------
+Playing the Nyan Cat song 
+-------------------------
+
+You can then enjoy playback in two ways:
 
-To use Nyan Cat with Rails "rake spec" you need to add Nyan Cat dependecy in your Gemfile.
+**1. Play the song only when desired using a command line option:**
+
+Use the following command to run your specs:
 
 ```
-group :test do
-  gem "nyan-cat-formatter"
-end
+$ rspec spec -f NyanCatMusicFormatter
 ```
-And then
+
+And enjoy the site of Nyan Cat running across your terminal to the Nyan Cat song!
+
+**2. Play the song by default when you run your specs:**
+
+Make sure your .rspec file in your application's root directory contains the following:
 
 ```
-bundle install
+--color
+--format NyanCatMusicFormatter
 ```
 
+Then run `rspec spec` and enjoy Nyan Cat formatted text output accompanied by the Nyan Cat song by default!
+
+**This currently only works on Mac OSx.**
+
 Contributing
 ----------
 

data/demo.rb

@@ -0,0 +1,30 @@
+require_relative 'spec/spec_helper'
+require 'stringio'
+
+describe NyanCatFormatter do
+
+  before do
+    @output = StringIO.new
+    @formatter = NyanCatFormatter.new(@output)
+    @formatter.start(2)
+    @example = RSpec::Core::ExampleGroup.describe.example
+
+    @samples = [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1,
+      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
+
+    sleep(0.1)  # Just to slow it down a little :-)
+  end
+
+  100.times do |index|
+    it "should perform passing specs" do
+      @formatter.current.should == @samples.sample
+    end
+
+    it "should perform pending specs" do
+      if @samples.sample == 1
+        pending
+      end
+    end
+  end
+
+end

data/lib/nyan_cat_formatter.rb

@@ -2,11 +2,11 @@
 
 rspec_bin = $0.split('/').last
 if rspec_bin == 'spec'
-  ['spec', 'rspec1', 'spec/runner/formatter/base_text_formatter'].each {|f| require f}
+  ['spec', 'nyan_cat_formatter/rspec1', 'spec/runner/formatter/base_text_formatter'].each {|f| require f}
   parent_class = Spec::Runner::Formatter::BaseTextFormatter
   rspec_module = RSpec1
 else
-  ['rspec2','rspec/core/formatters/base_text_formatter'].each {|f| require f}
+  ['nyan_cat_formatter/rspec2', 'rspec/core/formatters/base_text_formatter'].each {|f| require f}
   parent_class = RSpec::Core::Formatters::BaseTextFormatter
   rspec_module = RSpec2
 end
@@ -171,6 +171,5 @@ NyanCatFormatter = Class.new(parent_class) do
     else mark
     end
   end
-
 end
 

data/lib/{rspec1.rb → nyan_cat_formatter/rspec1.rb}

@@ -40,6 +40,7 @@ module RSpec1
   end
 
   def dump_summary(duration, example_count, failure_count, pending_count)
+    system("killall -9 afplay") if File.exists?(File.expand_path("~/.nyan-cat.mp3")) && RUBY_PLATFORM.downcase.include?("darwin")
     @output.puts "\nYou've Nyaned for #{duration} seconds\n".each_char.map {|c| rainbowify(c)}.join
     summary = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
     summary << ", #{pending_count} pending" if pending_count > 0

data/lib/{rspec2.rb → nyan_cat_formatter/rspec2.rb}

@@ -28,11 +28,11 @@ module RSpec2
   end
 
   def dump_summary(duration, example_count, failure_count, pending_count)
+    system("killall -9 afplay")  if File.exists?("#{ROOT}/data/nyan-cat.mp3") && RUBY_PLATFORM.downcase.include?("darwin")
     dump_profile if profile_examples? && failure_count == 0
     summary = "\nYou've Nyaned for #{format_seconds(duration)} seconds\n".split(//).map { |c| rainbowify(c) }
     output.puts summary.join
     output.puts colorise_summary(summary_line(example_count, failure_count, pending_count))
-
     if respond_to?(:dump_commands_to_rerun_failed_examples)
       dump_commands_to_rerun_failed_examples
     end

data/lib/nyan_cat_music_formatter.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+require 'nyan_cat_formatter'
+
+NyanCatMusicFormatter = Class.new(NyanCatFormatter) do
+  def osx?
+    platform.include?("darwin")
+  end
+
+  def kernel=(kernel)
+    @kernel = kernel
+  end
+
+  def kernel
+    @kernel ||= Kernel
+  end
+
+  def platform=(platform)
+    @platform = platform
+  end
+
+  def platform
+    @platform ||= RUBY_PLATFORM
+  end
+
+  def start input
+    super
+    kernel.system("afplay '#{ROOT}/data/nyan-cat.mp3' &") if osx?
+  end
+end

data/nyan-cat-formatter.gemspec

@@ -1,8 +1,10 @@
 $:.push File.expand_path("../lib", __FILE__)
 
+ROOT = "#{File.dirname(__FILE__)}" unless defined?(ROOT)
+
 Gem::Specification.new do |s|
   s.name        = "nyan-cat-formatter"
-  s.version     = "0.0.7"
+  s.version     = "0.0.8"
   s.authors     = ["Matt Sears"]
   s.email       = ["matt@mattsears.com"]
   s.homepage    = "http://mtts.rs/nyancat"

data/spec/nyan_cat_formatter_spec.rb

@@ -34,10 +34,11 @@ describe NyanCatFormatter do
 
       it 'should relax Nyan Cat' do
         @formatter.example_passed(@example)
-        @formatter.nyan_cat.should == [ "_,------,   ",
-          "_|  /\\_/\\ ",
-          "~|_( ^ .^)  ",
-          " \"\"  \"\" "
+        @formatter.nyan_cat.should == [
+          '_,------,   ',
+          '_|  /\_/\ ',
+          '~|_( ^ .^)  ',
+          ' ""  "" '
         ].join("\n")
       end
 
@@ -61,10 +62,11 @@ describe NyanCatFormatter do
 
       it 'should alert Nyan Cat' do
         @formatter.example_pending(@example)
-        @formatter.nyan_cat.should == [ "_,------,   ",
-          "_|  /\\_/\\ ",
-          "~|_( o .o)  ",
-          " \"\"  \"\" "
+        @formatter.nyan_cat.should == [
+          '_,------,   ',
+          '_|  /\_/\ ',
+          '~|_( o .o)  ',
+          ' ""  "" '
         ].join("\n")
       end
 
@@ -84,10 +86,11 @@ describe NyanCatFormatter do
 
       it 'should alert Nyan Cat' do
         @formatter.example_failed(@example)
-        @formatter.nyan_cat.should == [ "_,------,   ",
-          "_|  /\\_/\\ ",
-          "~|_( o .o)  ",
-          " \"\"  \"\" "
+        @formatter.nyan_cat.should == [
+          '_,------,   ',
+          '_|  /\_/\ ',
+          '~|_( o .o)  ',
+          ' ""  "" '
         ].join("\n")
       end
 

data/spec/nyan_cat_music_formatter_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'stringio'
+require 'nyan_cat_music_formatter'
+
+class MockKernel
+  def system(string)
+    seen << string
+  end
+
+  def seen
+    @seen ||= []
+  end
+end
+
+describe NyanCatMusicFormatter do
+  def path_to_mp3
+    "'#{ROOT}/data/nyan-cat.mp3'"
+  end
+
+  let(:stdout)      { StringIO.new }
+  let(:formatter)   { described_class.new stdout }
+  let(:mock_kernel) { MockKernel.new }
+
+  before { formatter.kernel = mock_kernel }
+
+  describe 'kernel' do
+    it 'defaults to Kernel' do
+      described_class.new(stdout).kernel.should == Kernel
+    end
+
+    it 'can be set' do
+      formatter = described_class.new stdout
+      formatter.kernel = 'something else'
+      formatter.kernel.should == 'something else'
+    end
+  end
+
+  describe 'platform' do
+    it 'defaults to RUBY_PLATFORM' do
+      described_class.new(stdout).platform.should equal RUBY_PLATFORM
+    end
+
+    it 'can be set' do
+      formatter = described_class.new stdout
+      formatter.platform = 'something else'
+      formatter.platform.should == 'something else'
+    end
+  end
+
+  describe 'start' do
+    it 'sets the total amount of specs' do
+      formatter.start 3
+      formatter.example_count.should == 3
+    end
+
+    it 'sets the current to 0' do
+      formatter.start 3
+      formatter.current.should == 0
+    end
+
+    context 'when on OS X' do
+      before { formatter.platform = 'darwin' }
+
+      it 'plays the song in the background' do
+        formatter.start 3
+        mock_kernel.seen.should include "afplay #{path_to_mp3} &"
+      end
+    end
+
+    context 'when not on OS X' do
+      before { formatter.platform = 'windows' }
+
+      it 'does not play the song' do
+        formatter.start 4
+        mock_kernel.seen.should be_empty
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nyan-cat-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70317825820840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317825820840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70317825820400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317825820400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Nyan Cat inspired RSpec formatter! '
 email:
 - matt@mattsears.com
@@ -49,11 +59,15 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- data/nyan-cat.mp3
+- demo.rb
 - lib/nyan_cat_formatter.rb
-- lib/rspec1.rb
-- lib/rspec2.rb
+- lib/nyan_cat_formatter/rspec1.rb
+- lib/nyan_cat_formatter/rspec2.rb
+- lib/nyan_cat_music_formatter.rb
 - nyan-cat-formatter.gemspec
 - spec/nyan_cat_formatter_spec.rb
+- spec/nyan_cat_music_formatter_spec.rb
 - spec/spec_helper.rb
 homepage: http://mtts.rs/nyancat
 licenses: []
@@ -75,10 +89,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: nyan-cat-formatter
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Nyan Cat inspired RSpec formatter!
 test_files:
 - spec/nyan_cat_formatter_spec.rb
+- spec/nyan_cat_music_formatter_spec.rb
 - spec/spec_helper.rb