musical_spec 0.0.1 → 0.0.2

data/Changelog.md

@@ -0,0 +1,11 @@
+## 0.0.2 / 2011-11-27
+
+* Formatter correctly will not go higher than the highest note now, instead of
+  doing that odd 3-note trill that it did before. The vagaries of scientific pitch
+  notation!
+* Music starts at the lowest possible pitch and climbs to the highest, so now
+  you get the full scale instead of getting to the highest note too early.
+
+## 0.0.1 / 2011-11-26
+
+Yeah, so this exists now.

data/lib/musical_spec/formatter.rb

@@ -6,8 +6,8 @@ module MusicalSpec
   class Formatter < RSpec::Core::Formatters::ProgressFormatter
     def initialize(output)
       super(output)
-      @note   = MusicalSpec::Note.new
-      @player = MusicalSpec::Player.new
+      @note   = Note.new
+      @player = Player.new
     end
 
     attr_reader :player

data/lib/musical_spec/note.rb

@@ -1,22 +1,24 @@
 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
+    include Comparable
 
-    def initialize
-      @letter = 'C'
-      @octave = 4
+    SCALE_PROGRESSION = %w(C D E F G A B)
+
+    # 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
     end
 
-    # A string like "C4". Octave (the number) does not go above MAX_OCTAVE or
-    # below MIN_OCTAVE.
-    def note
-      "#{@letter}#{normalized_octave}"
+    attr_reader :letter, :octave
+
+    # A string like "C4".
+    def to_s
+      "#{letter}#{octave}"
     end
 
     # Set the note to a new one, e.g. `note.note = 'A5'`
@@ -25,42 +27,46 @@ module MusicalSpec
       @letter = new_letter
       @octave = new_octave.to_i
 
-      note
+      to_s
     end
 
-    # Increase the pitch, handling octave changes.
+    # Increase the pitch, handling octave changes. Will not go above
+    # MusicalSpec::HIGHEST_NOTE.
     def next!
-      if @letter == 'B'
-        @letter = 'C'
-        @octave += 1
-      elsif @letter == 'G'
-        @letter = 'A'
-      else
-        @letter.next!
+      if self != HIGHEST_NOTE
+        if @letter == 'B'
+          @letter = 'C'
+          @octave += 1
+        elsif @letter == 'G'
+          @letter = 'A'
+        else
+          @letter.next!
+        end
       end
     end
 
-    # Decrease the pitch, handling octave changes.
+    # Decrease the pitch, handling octave changes. Will not go below
+    # MusicalSpec::LOWEST_NOTE.
     def prev!
-      if @letter == 'C'
-        @letter = 'B'
-        @octave -= 1
-      elsif @letter == 'A'
-        @letter = 'G'
-      else
-        @letter = (@letter.ord - 1).chr
+      if self != LOWEST_NOTE
+        if @letter == 'C'
+          @letter = 'B'
+          @octave -= 1
+        elsif @letter == 'A'
+          @letter = 'G'
+        else
+          @letter = (@letter.ord - 1).chr
+        end
       end
     end
 
-    private
-
-    def normalized_octave
-      if @octave > MAX_OCTAVE
-        MAX_OCTAVE
-      elsif @octave < MIN_OCTAVE
-        MIN_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)
       else
-        @octave
+        octave <=> other_octave
       end
     end
   end

data/lib/musical_spec/version.rb

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

data/lib/musical_spec.rb

@@ -6,5 +6,14 @@ require "musical_spec/formatter"
 require "musical_spec/version"
 
 module MusicalSpec
+  # Create a singleton due to Bloopsaphone's thread wackiness.
   ONE_TRUE_BLOOPSAPHONE = Bloops.new
+
+  # The highest note the formatter will play. If it goes higher than this, it
+  # will be normalized back down.
+  HIGHEST_NOTE = Note.new('B6')
+
+  # The lowest note this formatter will play. If it goes lower than this, it
+  # will be normalized back up.
+  LOWEST_NOTE  = Note.new('C2')
 end

data/spec/musical_spec/note_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: musical_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bloopsaphone
-  requirement: &2153435480 !ruby/object:Gem::Requirement
+  requirement: &2153575200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2153435480
+  version_requirements: *2153575200
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &2153433840 !ruby/object:Gem::Requirement
+  requirement: &2153574000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153433840
+  version_requirements: *2153574000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153433380 !ruby/object:Gem::Requirement
+  requirement: &2153573280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2153433380
+  version_requirements: *2153573280
 - !ruby/object:Gem::Dependency
   name: bourne
-  requirement: &2153432720 !ruby/object:Gem::Requirement
+  requirement: &2153572800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2153432720
+  version_requirements: *2153572800
 description: A musical formatter for RSpec.
 email:
 - gabe@thoughtbot.com
@@ -63,6 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Changelog.md
 - Gemfile
 - README.md
 - Rakefile