music-transcription 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2990163ab7471c99ce5b1df3b4899937125d06f7
-  data.tar.gz: 097b4ef37645684ebcf3aac659999f742afc593f
+  metadata.gz: 2519d2fe69e6b6d5944695bae502dece8dd456c9
+  data.tar.gz: b4da4b389692c5eb70bb2505d003a783fd565833
 SHA512:
-  metadata.gz: 15b1e4dca0a5359ef7cf0bb975da7217c592abae21a770b4004c2037dc12bfe5583ebca5d73517ff928f1061fdddde92a146614bcc73f00acd2f8f37fb9e81d6
-  data.tar.gz: 8453d7fecb15559942a1c8efb42bb0404718b96599e1515497b012f94cc23b5e81aca96307d6921386b9c2856dde122fbdbcb3a3bc5a6718bced2a773793d5a8
+  metadata.gz: 80a849288ffc1c279b5083ea6d878bb7de606d9f69b6885263945a5b95e1617a5c33cea586639fa8560c6ef72c4669892c2a4c913a0a0234d2b38d46693d36dd
+  data.tar.gz: a4ca68fad70b5cee5939fa319e23a0fc3580ed0b3016e03b2046ea3e56f1f84d5610c9857f31ac29f409c8b673f4b6b4d3b762f02366dd02132bd72543a1c995

data/lib/music-transcription/model/note.rb

@@ -44,7 +44,7 @@ class Note
   
   def transpose! diff
     unless diff.is_a?(Pitch)
-      diff = Pitch.make_from_semitone(diff)
+      diff = Pitch.from_semitones(diff)
     end
     
     @pitches = @pitches.map {|pitch| pitch + diff}

data/lib/music-transcription/model/pitch.rb

@@ -43,12 +43,6 @@ class Pitch
     return self.ratio() * BASE_FREQ
   end
   
-  # Set the pitch according to the given frequency. Uses the current base_freq 
-  # to determine what the pitch ratio should be, and sets it accordingly.
-  def freq= freq
-    self.ratio = freq / BASE_FREQ
-  end
-
   # Calculate the total semitone count. Converts octave to semitone count
   # before adding to existing semitone count.
   # @return [Fixnum] total semitone count
@@ -56,17 +50,6 @@ class Pitch
     return (@octave * SEMITONES_PER_OCTAVE) + @semitone
   end
   
-  # Set the Pitch ratio according to a total number of semitones.
-  # @param [Fixnum] semitone The total number of semitones to use.
-  # @raise [NonIntegerError] if semitone is not an Integer
-  def total_semitone= semitone
-    unless semitone.is_a?(Integer)
-      raise NonIntegerError, "semitone #{semitone} is not a Integer"
-    end
-    @octave, @semitone = 0, semitone
-    normalize!
-  end
-
   # Calculate the pitch ratio. Raises 2 to the power of the total semitone
   # count divided by semitones-per-octave.
   # @return [Float] ratio
@@ -74,16 +57,6 @@ class Pitch
     2.0**(self.total_semitone.to_f / SEMITONES_PER_OCTAVE)
   end
 
-  # Represent the Pitch ratio according to a ratio.
-  # @param [Numeric] ratio The ratio to represent.
-  # @raise [NonPositiveError] unless ratio is > 0
-  def ratio= ratio
-    raise NonPositiveError, "ratio #{ratio} is not > 0" unless ratio > 0
-    
-    x = Math.log2 ratio
-    self.total_semitone = (x * SEMITONES_PER_OCTAVE).round
-  end
-
   # Round to the nearest semitone.
   def round
     self.clone.round!
@@ -119,19 +92,23 @@ class Pitch
   # Add pitches by adding the total semitone count of each.
   # @param [Pitch] other The pitch object to add. 
   def + (other)
-    self.class.new(
-      octave: (@octave + other.octave),
-      semitone: (@semitone + other.semitone)
-    )
+    if other.is_a? Integer
+      return Pitch.new(octave: @octave, semitone: @semitone + other)
+    else
+      return Pitch.new(octave: (@octave + other.octave),
+        semitone: (@semitone + other.semitone))
+    end
   end
 
   # Add pitches by subtracting the total semitone count.
   # @param [Pitch] other The pitch object to subtract.
   def - (other)
-    self.class.new(
-      octave: (@octave - other.octave),
-      semitone: (@semitone - other.semitone),
-    )
+    if other.is_a? Integer
+      return Pitch.new(octave: @octave, semitone: @semitone - other)
+    else
+      return Pitch.new(octave: (@octave - other.octave),
+        semitone: (@semitone - other.semitone))
+    end
   end
   
   # Produce an identical Pitch object.
@@ -139,17 +116,6 @@ class Pitch
     Marshal.load(Marshal.dump(self))  # is this cheating?
   end
   
-  # Balance out the octave and semitone count. 
-  def normalize!
-    semitoneTotal = (@octave * SEMITONES_PER_OCTAVE) + @semitone
-    
-    @octave = semitoneTotal / SEMITONES_PER_OCTAVE
-    semitoneTotal -= @octave * SEMITONES_PER_OCTAVE
-    
-    @semitone = semitoneTotal
-    return self
-  end
-  
   def to_s(sharpit = false)
     letter = case semitone
     when 0 then "C"
@@ -169,16 +135,32 @@ class Pitch
     return letter + octave.to_s
   end
   
-  def self.make_from_freq(freq)
-    pitch = Pitch.new()
-    pitch.ratio = freq / BASE_FREQ
-    return pitch
+  def self.from_ratio ratio
+    raise NonPositiveError, "ratio #{ratio} is not > 0" unless ratio > 0
+    x = Math.log2 ratio
+    semitones = (x * SEMITONES_PER_OCTAVE).round
+    from_semitones(semitones)
+  end
+  
+  def self.from_freq freq
+    from_ratio(freq / BASE_FREQ)
+  end
+  
+  def self.from_semitones semitones
+    Pitch.new(semitone: semitones)
   end
   
-  def self.make_from_semitone semitones
-    pitch = Pitch.new()
-    pitch.total_semitone = semitones
-    return pitch
+  private
+  
+  # Balance out the octave and semitone count. 
+  def normalize!
+    semitoneTotal = (@octave * SEMITONES_PER_OCTAVE) + @semitone
+    
+    @octave = semitoneTotal / SEMITONES_PER_OCTAVE
+    semitoneTotal -= @octave * SEMITONES_PER_OCTAVE
+    
+    @semitone = semitoneTotal
+    return self
   end
 end
 

data/lib/music-transcription/version.rb

@@ -2,6 +2,6 @@
 module Music
 module Transcription
   # music-transcription version
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end
 end

data/spec/model/pitch_spec.rb

@@ -17,11 +17,11 @@ describe Pitch do
     ]
   end
   
-  it "should be constructible with no parameters (no error raised)" do
+  it "should be constructable with no parameters (no error raised)" do
     lambda { Pitch.new }.should_not raise_error
   end
   
-  it "should be hash-makeable" do
+  it "should take keyword args" do
     obj = Pitch.new octave: 4, semitone: 3
     obj.octave.should eq(4)
     obj.semitone.should eq(3)
@@ -41,25 +41,36 @@ describe Pitch do
     end
   end
 
-  it "should allow setting by ratio" do
-    @cases.each do |case_data|
-      p = Pitch.new
-      p.ratio = case_data[:ratio]
-            
-      p.octave.should eq case_data[:octave]
-      p.semitone.should eq case_data[:semitone]
-      p.total_semitone.should eq case_data[:total_semitone]
+  describe '.from_ratio' do
+    it 'should return a Pitch with given ratio' do
+      @cases.each do |case_data|
+        p = Pitch.from_ratio case_data[:ratio]
+        
+        p.octave.should eq case_data[:octave]
+        p.semitone.should eq case_data[:semitone]
+        p.total_semitone.should eq case_data[:total_semitone]
+      end
     end
   end
 
-  it "should setting by total_semitone" do    
-    @cases.each do |case_data|
-      p = Pitch.new
-      p.total_semitone = case_data[:total_semitone] 
-      
-      p.octave.should eq case_data[:octave]
-      p.semitone.should eq case_data[:semitone]
-      p.total_semitone.should eq case_data[:total_semitone]
+  describe '.from_semitones' do
+    it 'should return a Pitch with given total semitones' do
+      @cases.each do |case_data|
+        p = Pitch.from_semitones case_data[:total_semitone]
+        
+        p.octave.should eq case_data[:octave]
+        p.semitone.should eq case_data[:semitone]
+        p.total_semitone.should eq case_data[:total_semitone]
+      end
+    end
+  end
+
+  describe '.from_freq' do
+    it 'should make a pitch whose freq is approximately the given freq' do
+      [16.35, 440.0, 987.77].each do |given_freq|
+	pitch = Pitch.from_freq given_freq
+	pitch.freq.should be_within(0.01).of(given_freq)
+      end
     end
   end
   
@@ -96,6 +107,22 @@ describe Pitch do
     (p3 - p1).should eq(Pitch.new semitone: 2)
   end
   
+  it "should be addable and subtractable with integers" do
+    p1 = Pitch.new semitone: 1
+    p2 = Pitch.new semitone: 2
+    p3 = Pitch.new semitone: 3
+    
+    (p1 + 2).should eq(Pitch.new semitone: 3) 
+    (p1 + 3).should eq(Pitch.new semitone: 4)
+    (p2 + 3).should eq(Pitch.new semitone: 5)
+    
+    (p1 - 2).should eq(Pitch.new semitone: -1) 
+    (p1 - 3).should eq(Pitch.new semitone: -2)
+    (p2 - 3).should eq(Pitch.new semitone: -1)
+    (p3 - 2).should eq(Pitch.new semitone: 1)
+    (p3 - 1).should eq(Pitch.new semitone: 2)
+  end
+  
   it "should have freq of 440 for A4" do
     a4 = Pitch.new octave: 4, semitone: 9
     a4.freq.should be_within(0.01).of(440.0)
@@ -139,23 +166,4 @@ describe Pitch do
       end
     end
   end
-
-  describe '.make_from_freq' do
-    it 'should make a pitch whose freq is approximately the given freq' do
-      [16.35, 440.0, 987.77].each do |given_freq|
-	pitch = Pitch.make_from_freq given_freq
-	pitch.freq.should be_within(0.01).of(given_freq)
-      end
-    end
-  end
-  
-  describe '.make_from_semitone' do
-    context 'given an integer less than 12' do
-      before(:all) { @pitch = Pitch.make_from_semitone(11) }
-      
-      it 'semitone should equal given integer' do
-	@pitch.semitone.should eq 11
-      end
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: music-transcription
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - James Tunnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler