musical_spec 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a575ba2688860d3bc63cc531189e182f03232c10
+  data.tar.gz: 5e79b0c2477e34e4e9ef275e84322cc2649b9b31
+SHA512:
+  metadata.gz: fd1d50386d1a78e1ee0ad789f6582f21c8378eab2cf94f309e3e741becc7d2ebb4a84fe541a36f0461ae3c8e77bf145bb337e7303232832c7b316225adb7a72b
+  data.tar.gz: 54e6e51ac8a6a0a3ca38447d91f0984e2589ca1156ce9acf43d863e404388efc8d210b5bb2fc8d9472f4adca2f2e988e82a5a49af38ecda56813aecc76a98bfe

data/{Changelog.md → NEWS.md}

@@ -1,3 +1,7 @@
+## 0.0.3 / 2015-10-23
+
+* Requires RSpec 3+
+
 ## 0.0.2 / 2011-11-27
 
 * Formatter correctly will not go higher than the highest note now, instead of

data/README.md

@@ -1,8 +1,10 @@
 # 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.
+"A revelatory auditory experience!" - _Anonymous_
+
+An RSpec 3 formatter that plays higher notes as tests pass and lower notes as
+tests fail. It's a subclass of the progress formatter, so you still get your
+pretty dots.
 
 ## Usage
 

data/Rakefile

@@ -1,6 +1,5 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/musical_spec/formatter.rb

@@ -4,51 +4,49 @@ require 'rspec/core/formatters/progress_formatter'
 
 module MusicalSpec
   class Formatter < RSpec::Core::Formatters::ProgressFormatter
-    def initialize(output)
+    RSpec::Core::Formatters.register self, :example_passed, :example_failed,
+      :example_pending
+
+    def initialize(output, note = nil)
       super(output)
-      @note   = Note.new
+      @note = Note.new(note)
       @player = Player.new
     end
 
     attr_reader :player
 
-    # Plays a higher note and then calls super.
-    def example_passed(example)
+    # Plays a higher note then print a progress dot
+    def example_passed(notification)
       play_higher_note
-      super(example)
+      super
     end
 
-    # Plays a lower note and then calls super.
-    def example_failed(example)
+    # Plays a lower note then print a progress dot
+    def example_failed(notification)
       play_lower_note
-      super(example)
+      super
     end
 
-    # Plays a note without changing the pitch and then calls super.
-    def example_pending(example)
+    # Plays a note without changing the pitch then print a progress dot
+    def example_pending(notification)
       play_note
-      super(example)
+      super
     end
 
     private
 
     def play_note
-      @player.play(note)
+      @player.play(@note)
     end
 
     def play_higher_note
-      @note.next!
+      @note.higher!
       play_note
     end
 
     def play_lower_note
-      @note.prev!
+      @note.lower!
       play_note
     end
-
-
-    def note
-      @note.note
-    end
   end
 end

data/lib/musical_spec/note.rb

@@ -7,15 +7,9 @@ module MusicalSpec
 
     # Takes 1 optional argument, a note string like "C4".
     def initialize(desired_note_string = nil)
-      if desired_note_string.nil?
-        self.note = LOWEST_NOTE.to_s
-      else
-        self.note = desired_note_string
-      end
+      self.note = desired_note_string || LOWEST_NOTE.to_s
     end
 
-    attr_reader :letter, :octave
-
     # A string like "C4".
     def to_s
       "#{letter}#{octave}"
@@ -32,42 +26,50 @@ module MusicalSpec
 
     # Increase the pitch, handling octave changes. Will not go above
     # MusicalSpec::HIGHEST_NOTE.
-    def next!
-      if self != HIGHEST_NOTE
-        if @letter == 'B'
-          @letter = 'C'
+    def higher!
+      if below_highest_note?
+        if @letter == SCALE_PROGRESSION.last
+          @letter = SCALE_PROGRESSION.first
           @octave += 1
-        elsif @letter == 'G'
-          @letter = 'A'
         else
-          @letter.next!
+          @letter = SCALE_PROGRESSION[SCALE_PROGRESSION.index(@letter) + 1]
         end
       end
     end
 
     # Decrease the pitch, handling octave changes. Will not go below
     # MusicalSpec::LOWEST_NOTE.
-    def prev!
-      if self != LOWEST_NOTE
-        if @letter == 'C'
-          @letter = 'B'
+    def lower!
+      if above_lowest_note?
+        if @letter == SCALE_PROGRESSION.first
+          @letter = SCALE_PROGRESSION.last
           @octave -= 1
-        elsif @letter == 'A'
-          @letter = 'G'
         else
-          @letter = (@letter.ord - 1).chr
+          @letter = SCALE_PROGRESSION[SCALE_PROGRESSION.index(@letter) - 1]
         end
       end
     end
 
+    protected
+
+    attr_reader :letter, :octave
+
     def <=>(other_note)
-      other_letter = other_note.letter
-      other_octave = other_note.octave
-      if octave == other_octave
-        SCALE_PROGRESSION.index(letter) <=> SCALE_PROGRESSION.index(other_letter)
+      if octave == other_note.octave
+        SCALE_PROGRESSION.index(letter) <=> SCALE_PROGRESSION.index(other_note.letter)
       else
-        octave <=> other_octave
+        octave <=> other_note.octave
       end
     end
+
+    private
+
+    def below_highest_note?
+      self < HIGHEST_NOTE
+    end
+
+    def above_lowest_note?
+      self > LOWEST_NOTE
+    end
   end
 end

data/lib/musical_spec/player.rb

@@ -7,10 +7,10 @@ module MusicalSpec
       ONE_TRUE_BLOOPSAPHONE.tempo = 320
     end
 
-    # Takes a note string like "C4".
+    # Takes a Note instance.
     def play(note)
       ONE_TRUE_BLOOPSAPHONE.clear
-      ONE_TRUE_BLOOPSAPHONE.tune(@sound, note)
+      ONE_TRUE_BLOOPSAPHONE.tune(@sound, note.to_s)
       ONE_TRUE_BLOOPSAPHONE.play
       sleep 0.01 while ! ONE_TRUE_BLOOPSAPHONE.stopped?
     end

data/lib/musical_spec/version.rb

@@ -1,3 +1,3 @@
 module MusicalSpec
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/musical_spec.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "https://github.com/gabebw/musical_spec"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -16,8 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = MusicalSpec::VERSION
 
   gem.add_dependency('bloopsaphone', '~> 0.4')
-  gem.add_dependency('rspec-core', '~> 2.0')
+  gem.add_dependency('rspec-core', '~> 3.0')
 
-  gem.add_development_dependency('rspec', '~> 2.0')
-  gem.add_development_dependency('bourne', '~> 1.0')
+  gem.add_development_dependency('rspec', '~> 3.0')
 end

data/spec/musical_spec/formatter_spec.rb

@@ -2,25 +2,51 @@ require 'spec_helper'
 require 'stringio'
 
 describe MusicalSpec::Formatter do
-  before { subject.player.stubs(:play) }
+  it 'is a ProgressFormatter' do
+    formatter = MusicalSpec::Formatter.new('C4')
+    expect(formatter).to be_a RSpec::Core::Formatters::ProgressFormatter
+  end
+
+  it 'tells RSpec that it can handle passed/failed/pending specs' do
+    registered_formatters = RSpec::Core::Formatters::Loader.formatters
 
-  it { should be_a RSpec::Core::Formatters::ProgressFormatter }
+    expect(registered_formatters[MusicalSpec::Formatter]).to eq [
+      :example_passed,
+      :example_failed,
+      :example_pending
+    ]
+  end
 
   it 'plays a higher-pitched sound when an example passes' do
-    subject.example_passed(example)
-    subject.player.should have_received(:play).with('D4')
+    formatter = formatter_with_note('E4')
+    formatter.example_passed(example)
+    expect(formatter.player).to have_played('F4').once
   end
 
   it 'plays a lower-pitched sound when an example fails' do
-    subject.example_failed(example)
-    subject.player.should have_received(:play).with('B3')
+    formatter = formatter_with_note('E4')
+    formatter.example_failed(example)
+    expect(formatter.player).to have_played('D4').once
   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')
+    formatter = formatter_with_note('E4')
+    formatter.example_pending(example)
+    expect(formatter.player).to have_played('E4').once
+  end
+
+  def formatter_with_note(note)
+    MusicalSpec::Formatter.new(StringIO.new, note).tap do |formatter|
+      allow(formatter.player).to receive(:play)
+    end
+  end
+
+  def have_played(note_string)
+    note = MusicalSpec::Note.new(note_string)
+    have_received(:play).with(note)
   end
 
-  subject { MusicalSpec::Formatter.new(StringIO.new) }
-  let(:example){ RSpec::Core::ExampleGroup.describe.example }
+  def example
+    RSpec::Core::ExampleGroup.describe.example
+  end
 end

data/spec/musical_spec/note_spec.rb

@@ -2,97 +2,97 @@ require 'spec_helper'
 
 describe MusicalSpec::Note do
   it 'defaults to the lowest note' do
-    subject.to_s.should == MusicalSpec::LOWEST_NOTE.to_s
+    expect(subject.to_s).to eq(MusicalSpec::LOWEST_NOTE.to_s)
   end
 
   it 'can be initialized with a note' do
-    MusicalSpec::Note.new('E4').to_s.should == 'E4'
+    expect(MusicalSpec::Note.new('E4').to_s).to eq('E4')
   end
 
   it 'does not go higher than B6' do
     subject.note = 'B6'
-    subject.next!
-    subject.to_s.should == 'B6'
+    subject.higher!
+    expect(subject.to_s).to eq('B6')
   end
 
   it 'does not go lower than C2' do
     subject.note = 'C2'
-    subject.prev!
-    subject.to_s.should == 'C2'
+    subject.lower!
+    expect(subject.to_s).to eq('C2')
   end
 
   it 'allows setting the note' do
     subject.note = 'A4'
-    subject.to_s.should == 'A4'
+    expect(subject.to_s).to eq('A4')
   end
 
-  context '#next!' do
+  context '#higher!' do
     it 'increases the note by 1' do
       subject.note = 'C4'
-      subject.next!
-      subject.to_s.should == 'D4'
+      subject.higher!
+      expect(subject.to_s).to eq('D4')
     end
 
     it 'changes octaves when moving from B to C' do
       subject.note = 'B4'
-      subject.next!
-      subject.to_s.should == 'C5'
+      subject.higher!
+      expect(subject.to_s).to eq('C5')
     end
 
     it 'does not change octaves when moving from G to A' do
       subject.note = 'G4'
-      subject.next!
-      subject.to_s.should == 'A4'
+      subject.higher!
+      expect(subject.to_s).to eq('A4')
     end
   end
 
-  context '#prev!' do
+  context '#lower!' do
     it 'decreases the note by 1' do
       subject.note = 'E4'
-      subject.prev!
-      subject.to_s.should == 'D4'
+      subject.lower!
+      expect(subject.to_s).to eq('D4')
     end
 
     it 'changes octaves when moving from C to B' do
       subject.note = 'C4'
-      subject.prev!
-      subject.to_s.should == 'B3'
+      subject.lower!
+      expect(subject.to_s).to eq('B3')
     end
 
     it 'does not change octaves when moving from A to G' do
       subject.note = 'A4'
-      subject.prev!
-      subject.to_s.should == 'G4'
+      subject.lower!
+      expect(subject.to_s).to eq('G4')
     end
   end
 
   context '<=>' do
     it 'knows that D4 < E4' do
-      d4.should be < e4
+      expect(d4).to be < e4
     end
 
     it 'knows that E4 > D4' do
-      e4.should be > d4
+      expect(e4).to be > d4
     end
 
     it 'knows that C4 > B3' do
-      c4.should be > b3
+      expect(c4).to be > b3
     end
 
     it 'knows that B3 < C4' do
-      b3.should be < c4
+      expect(b3).to be < c4
     end
 
     it 'knows that A4 > G4' do
-      a4.should be > g4
+      expect(a4).to be > g4
     end
 
     it 'knows that A4 == A4' do
-      a4.should == a4
+      expect(a4).to eq(a4)
     end
 
     it 'knows that G4 < A4' do
-      g4.should be < a4
+      expect(g4).to be < a4
     end
 
     let(:d4) { MusicalSpec::Note.new('D4') }

data/spec/musical_spec/player_spec.rb

@@ -1,36 +1,56 @@
 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')
+    bloopsaphone_mock = build_bloopsaphone_mock
+    sound = bloopsaphone_mock.sound
+    with_one_true_bloopsaphone(bloopsaphone_mock) do
+      subject.play(MusicalSpec::Note.new('C4'))
+      expect(bloopsaphone_mock).to have_received(:tune).with(sound, 'C4')
+    end
   end
 
   it 'clears tunes before playing' do
-    subject.play('C4')
-    fake_bloopsaphone.should have_received(:clear).once
+    bloopsaphone_mock = build_bloopsaphone_mock
+    with_one_true_bloopsaphone(bloopsaphone_mock) do
+      subject.play(MusicalSpec::Note.new('C4'))
+      expect(bloopsaphone_mock).to have_received(:clear).once
+    end
   end
 
   it 'plays the tune' do
-    subject.play('C4')
-    fake_bloopsaphone.should have_received(:play).once
+    bloopsaphone_mock = build_bloopsaphone_mock
+    with_one_true_bloopsaphone(bloopsaphone_mock) do
+      subject.play(MusicalSpec::Note.new('C4'))
+      expect(bloopsaphone_mock).to have_received(:play).once
+    end
+  end
+
+  def fake_sound
+    double("Bloopsaphone sound", "sustain=" => nil)
+  end
+
+  def build_bloopsaphone_mock
+    double(
+      'Fake Bloopsaphone',
+      :tune  => nil,
+      :tempo= => nil,
+      :play  => nil,
+      :clear => nil,
+      :stopped? => true,
+      :sound => fake_sound,
+    )
   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)
+  def with_one_true_bloopsaphone(new_bloopsaphone)
+    real_bloopsaphone = MusicalSpec::ONE_TRUE_BLOOPSAPHONE
+    MusicalSpec.send(:remove_const, :ONE_TRUE_BLOOPSAPHONE)
+    MusicalSpec.const_set(:ONE_TRUE_BLOOPSAPHONE, new_bloopsaphone)
+    begin
+      yield
+    ensure
+      MusicalSpec.send(:remove_const, :ONE_TRUE_BLOOPSAPHONE)
+      MusicalSpec.const_set(:ONE_TRUE_BLOOPSAPHONE, real_bloopsaphone)
+    end
   end
 end

data/spec/musical_spec_spec.rb

@@ -1,7 +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
+describe MusicalSpec::ONE_TRUE_BLOOPSAPHONE do
+  it "is a Bloopsaphone singleton because of thread wackiness" do
+    expect(MusicalSpec::ONE_TRUE_BLOOPSAPHONE).to be_a Bloops
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,60 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: musical_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Gabe Berke-Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-27 00:00:00.000000000Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bloopsaphone
-  requirement: &2153575200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2153575200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &2153574000 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153574000
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153573280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2153573280
-- !ruby/object:Gem::Dependency
-  name: bourne
-  requirement: &2153572800 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: *2153572800
+        version: '3.0'
 description: A musical formatter for RSpec.
 email:
 - gabe@thoughtbot.com
@@ -62,13 +59,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Changelog.md
+- ".gitignore"
 - Gemfile
+- NEWS.md
 - 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
@@ -79,29 +75,28 @@ files:
 - spec/musical_spec/player_spec.rb
 - spec/musical_spec_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/gabebw/musical_spec
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A musical formatter for RSpec. The sound gets lower as failures pile up,
   and higher when tests pass.
 test_files:
@@ -110,4 +105,3 @@ test_files:
 - spec/musical_spec/player_spec.rb
 - spec/musical_spec_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/musical_spec/bloops.rb

@@ -1,36 +0,0 @@
-#!/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