musical_spec 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,30 @@
+# musical_spec
+
+An RSpec formatter that plays higher notes as tests pass and lower notes as
+tests fail. A revelatory auditory experience! It's a subclass of the progress
+formatter, so you still get your pretty dots.
+
+## Usage
+
+This uses [Bloopsaphone](https://github.com/mental/bloopsaphone), which requires PortAudio:
+
+    brew install portaudio
+
+In your Gemfile:
+
+    gem 'musical_spec'
+
+Then run your specs like this:
+
+    $ rspec --format MusicalSpec::Formatter spec/
+
+To always run your specs with MusicalSpec, add the option to your `.rspec` file:
+
+    --format MusicalSpec::Formatter
+
+## Caveats
+
+Due to Bloopsaphone wackiness, this library has to `sleep` while the sounds
+are playing. This will probably slow your test suite down a LOT.
+Also, sometimes the sounds can't keep up with the test suite and some of the
+sounds don't play. The dots still show up though.

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/musical_spec/bloops.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+class SoundPlayer
+  def initialize
+    @bloopsaphone = Bloops.new
+    @sound = @bloopsaphone.sound(Bloops::SQUARE)
+    @sound.sustain = 1
+
+    @note = Note.new
+  end
+
+  def start
+    200.times do
+      @bloopsaphone.clear
+      if success?
+        @note.next!
+      else
+        @note.next!
+        # @note.prev!
+      end
+
+      @bloopsaphone.tune(@sound, @note.note)
+      @bloopsaphone.play
+      sleep 0.1 #while !@bloopsaphone.stopped?
+    end
+  end
+
+  private
+
+  def success?
+    rand(2) == 0
+  end
+end
+
+
+player = SoundPlayer.new
+player.start

data/lib/musical_spec/formatter.rb

@@ -0,0 +1,54 @@
+# RSpec will only require this file, so require the rest of the gem.
+require 'musical_spec'
+require 'rspec/core/formatters/progress_formatter'
+
+module MusicalSpec
+  class Formatter < RSpec::Core::Formatters::ProgressFormatter
+    def initialize(output)
+      super(output)
+      @note   = MusicalSpec::Note.new
+      @player = MusicalSpec::Player.new
+    end
+
+    attr_reader :player
+
+    # Plays a higher note and then calls super.
+    def example_passed(example)
+      play_higher_note
+      super(example)
+    end
+
+    # Plays a lower note and then calls super.
+    def example_failed(example)
+      play_lower_note
+      super(example)
+    end
+
+    # Plays a note without changing the pitch and then calls super.
+    def example_pending(example)
+      play_note
+      super(example)
+    end
+
+    private
+
+    def play_note
+      @player.play(note)
+    end
+
+    def play_higher_note
+      @note.next!
+      play_note
+    end
+
+    def play_lower_note
+      @note.prev!
+      play_note
+    end
+
+
+    def note
+      @note.note
+    end
+  end
+end

data/lib/musical_spec/note.rb

@@ -0,0 +1,67 @@
+module MusicalSpec
+  # Uses scientific notation, e.g. C4 is middle C.
+  class Note
+    # The highest octave this will play. If it goes higher than this, it will be
+    # normalized back down to MAX_OCTAVE.
+    MAX_OCTAVE = 6
+    # The lowest octave this will play. If it goes lower than this, it will be
+    # normalized back up to MIN_OCTAVE.
+    MIN_OCTAVE = 2
+
+    def initialize
+      @letter = 'C'
+      @octave = 4
+    end
+
+    # A string like "C4". Octave (the number) does not go above MAX_OCTAVE or
+    # below MIN_OCTAVE.
+    def note
+      "#{@letter}#{normalized_octave}"
+    end
+
+    # Set the note to a new one, e.g. `note.note = 'A5'`
+    def note=(new_note)
+      new_letter, new_octave = new_note.split('')
+      @letter = new_letter
+      @octave = new_octave.to_i
+
+      note
+    end
+
+    # Increase the pitch, handling octave changes.
+    def next!
+      if @letter == 'B'
+        @letter = 'C'
+        @octave += 1
+      elsif @letter == 'G'
+        @letter = 'A'
+      else
+        @letter.next!
+      end
+    end
+
+    # Decrease the pitch, handling octave changes.
+    def prev!
+      if @letter == 'C'
+        @letter = 'B'
+        @octave -= 1
+      elsif @letter == 'A'
+        @letter = 'G'
+      else
+        @letter = (@letter.ord - 1).chr
+      end
+    end
+
+    private
+
+    def normalized_octave
+      if @octave > MAX_OCTAVE
+        MAX_OCTAVE
+      elsif @octave < MIN_OCTAVE
+        MIN_OCTAVE
+      else
+        @octave
+      end
+    end
+  end
+end

data/lib/musical_spec/player.rb

@@ -0,0 +1,18 @@
+module MusicalSpec
+  # This class plays the music using Bloopsaphone.
+  class Player
+    def initialize
+      @sound = ONE_TRUE_BLOOPSAPHONE.sound(Bloops::SQUARE)
+      @sound.sustain = 0.01
+      ONE_TRUE_BLOOPSAPHONE.tempo = 320
+    end
+
+    # Takes a note string like "C4".
+    def play(note)
+      ONE_TRUE_BLOOPSAPHONE.clear
+      ONE_TRUE_BLOOPSAPHONE.tune(@sound, note)
+      ONE_TRUE_BLOOPSAPHONE.play
+      sleep 0.01 while ! ONE_TRUE_BLOOPSAPHONE.stopped?
+    end
+  end
+end

data/lib/musical_spec/version.rb

@@ -0,0 +1,3 @@
+module MusicalSpec
+  VERSION = "0.0.1"
+end

data/lib/musical_spec.rb

@@ -0,0 +1,10 @@
+require 'bloops'
+
+require "musical_spec/note"
+require "musical_spec/player"
+require "musical_spec/formatter"
+require "musical_spec/version"
+
+module MusicalSpec
+  ONE_TRUE_BLOOPSAPHONE = Bloops.new
+end

data/musical_spec.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/musical_spec/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gabe Berke-Williams"]
+  gem.email         = ["gabe@thoughtbot.com"]
+  gem.description   = %q{A musical formatter for RSpec.}
+  gem.summary       = %q{A musical formatter for RSpec. The sound gets lower as failures pile up, and higher when tests pass.}
+  gem.homepage      = "" # FIXME
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "musical_spec"
+  gem.require_paths = ["lib"]
+  gem.version       = MusicalSpec::VERSION
+
+  gem.add_dependency('bloopsaphone', '~> 0.4')
+  gem.add_dependency('rspec-core', '~> 2.0')
+
+  gem.add_development_dependency('rspec', '~> 2.0')
+  gem.add_development_dependency('bourne', '~> 1.0')
+end

data/spec/musical_spec/formatter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'stringio'
+
+describe MusicalSpec::Formatter do
+  before { subject.player.stubs(:play) }
+
+  it { should be_a RSpec::Core::Formatters::ProgressFormatter }
+
+  it 'plays a higher-pitched sound when an example passes' do
+    subject.example_passed(example)
+    subject.player.should have_received(:play).with('D4')
+  end
+
+  it 'plays a lower-pitched sound when an example fails' do
+    subject.example_failed(example)
+    subject.player.should have_received(:play).with('B3')
+  end
+
+  it 'does not change the note when an example is pending' do
+    subject.example_pending(example)
+    subject.player.should have_received(:play).with('C4')
+  end
+
+  subject { MusicalSpec::Formatter.new(StringIO.new) }
+  let(:example){ RSpec::Core::ExampleGroup.describe.example }
+end

data/spec/musical_spec/note_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe MusicalSpec::Note do
+  it 'defaults to middle C' do
+    subject.note.should == 'C4'
+  end
+
+  it 'sets MAX_OCTAVE to 6' do
+    MusicalSpec::Note::MAX_OCTAVE.should == 6
+  end
+
+  it 'sets MIN_OCTAVE to 2' do
+    MusicalSpec::Note::MIN_OCTAVE.should == 2
+  end
+
+  it 'allows setting the note' do
+    subject.note = 'A4'
+    subject.note.should == 'A4'
+  end
+
+  it 'does not let the octave go above MAX_OCTAVE' do
+    very_high_octave = MusicalSpec::Note::MAX_OCTAVE + 1
+    subject.note = "A#{very_high_octave}"
+    subject.note.should == "A#{MusicalSpec::Note::MAX_OCTAVE}"
+  end
+
+  it 'does not let the octave go below MIN_OCTAVE' do
+    very_low_octave = MusicalSpec::Note::MIN_OCTAVE - 1
+    subject.note = "A#{very_low_octave}"
+    subject.note.should == "A#{MusicalSpec::Note::MIN_OCTAVE}"
+  end
+
+  context '#next!' do
+    it 'increases the note by 1' do
+      subject.note = 'C4'
+      subject.next!
+      subject.note.should == 'D4'
+    end
+
+    it 'changes octaves when moving from B to C' do
+      subject.note = 'B4'
+      subject.next!
+      subject.note.should == 'C5'
+    end
+
+    it 'does not change octaves when moving from G to A' do
+      subject.note = 'G4'
+      subject.next!
+      subject.note.should == 'A4'
+    end
+  end
+
+  context '#prev!' do
+    it 'decreases the note by 1' do
+      subject.note = 'E4'
+      subject.prev!
+      subject.note.should == 'D4'
+    end
+
+    it 'changes octaves when moving from C to B' do
+      subject.note = 'C4'
+      subject.prev!
+      subject.note.should == 'B3'
+    end
+
+    it 'does not change octaves when moving from A to G' do
+      subject.note = 'A4'
+      subject.prev!
+      subject.note.should == 'G4'
+    end
+  end
+end

data/spec/musical_spec/player_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe MusicalSpec::Player do
+  before do
+    @real_bloopsaphone = MusicalSpec::ONE_TRUE_BLOOPSAPHONE
+    MusicalSpec::ONE_TRUE_BLOOPSAPHONE = fake_bloopsaphone
+  end
+
+  after { MusicalSpec::ONE_TRUE_BLOOPSAPHONE = @real_bloopsaphone }
+
+  it 'sets the correct note' do
+    subject.play('C4')
+    fake_bloopsaphone.should have_received(:tune).with(fake_sound, 'C4')
+  end
+
+  it 'clears tunes before playing' do
+    subject.play('C4')
+    fake_bloopsaphone.should have_received(:clear).once
+  end
+
+  it 'plays the tune' do
+    subject.play('C4')
+    fake_bloopsaphone.should have_received(:play).once
+  end
+
+  let(:fake_sound) { stub("Bloopsaphone sound", :sustain= => nil) }
+  let(:fake_bloopsaphone) do
+    stub('Fake Bloopsaphone',
+         :tune  => nil,
+         :tempo= => nil,
+         :play  => nil,
+         :clear => nil,
+         :stopped? => true,
+         :sound => fake_sound)
+  end
+end

data/spec/musical_spec_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe MusicalSpec do
+  it "creates a Bloopsaphone singleton because of thread wackiness" do
+    MusicalSpec::ONE_TRUE_BLOOPSAPHONE.should be_a Bloops
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'bourne'
+
+require 'musical_spec'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: musical_spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gabe Berke-Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bloopsaphone
+  requirement: &2153435480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153435480
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: &2153433840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153433840
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153433380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153433380
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: &2153432720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153432720
+description: A musical formatter for RSpec.
+email:
+- gabe@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/musical_spec.rb
+- lib/musical_spec/bloops.rb
+- lib/musical_spec/formatter.rb
+- lib/musical_spec/note.rb
+- lib/musical_spec/player.rb
+- lib/musical_spec/version.rb
+- musical_spec.gemspec
+- spec/musical_spec/formatter_spec.rb
+- spec/musical_spec/note_spec.rb
+- spec/musical_spec/player_spec.rb
+- spec/musical_spec_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A musical formatter for RSpec. The sound gets lower as failures pile up,
+  and higher when tests pass.
+test_files:
+- spec/musical_spec/formatter_spec.rb
+- spec/musical_spec/note_spec.rb
+- spec/musical_spec/player_spec.rb
+- spec/musical_spec_spec.rb
+- spec/spec_helper.rb
+has_rdoc: