music-utils 1.0.0 → 1.0.1

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.1 (May 6, 2011)
+
+Features:
+
+  - Added benchmarks to project
+  - Performance increased about 30 percent to classify intervals
+
+
 ## 1.0.0 (May 6, 2011)
 
 Features:

data/benchmark/music-utils_bm.rb

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'music-utils'
+require 'music-utils/scales/scales'
+require 'benchmark'
+
+n = 100_000
+
+Benchmark.bmbm(15) do |b|
+  b.report('with strings:') do 
+    n.times { MusicUtils.short('do', 'mi') }
+  end
+  b.report('with symbols:') do
+    n.times { MusicUtils.short(:do, :mi) }
+  end
+  b.report('with scales:') do
+    n.times { MusicUtils.short(Scales::DO, Scales::MI) }
+  end
+end

data/lib/music-utils.rb

@@ -1,7 +1,9 @@
 require 'music-utils/interval/interval'
+require 'music-utils/scales/scales'
 
 # Music utils 
 module MusicUtils
+  include Scales
   
   # Returns the number of the interval
   def MusicUtils.number(note1, note2, step = 0)

data/lib/music-utils/interval/interval.rb

@@ -7,8 +7,10 @@ module MusicUtils
     include Scales
   
     def initialize(note1, note2, step)
-      @note1 = note1
-      @note2 = note2
+      @note1 = note1[0..1].to_sym
+      @note1_alt = note1[2..3]
+      @note2 = note2[0..1].to_sym
+      @note2_alt = note2[2..3]
       @step = step
     end
   
@@ -36,9 +38,9 @@ module MusicUtils
       count, i = no_unison(count, i)
       
       # counting semi-tones
-      until_find_note2(i) do |i|
+      until_find_note2(i) do |ii|
         # from 'mi' to 'fa' and 'si' to 'do' there 1 semi-tone
-        if DIATONIC_SCALE[i] == 'fa' or DIATONIC_SCALE[i] == 'do'
+        if DIATONIC_SCALE[ii] == Scales::FA or DIATONIC_SCALE[ii] == Scales::DO
           count += 1
         else
           count += 2
@@ -48,19 +50,15 @@ module MusicUtils
       count = count + (12 * @step) if @step > 0
       
       # counting notes alterations
-      alter = @note1[2..3]
-      
-      alter.each_char do |c|
-        count += 1 if c == 'b'
-        count -= 1 if c == '#'
-      end
+      count += 1 if @note1_alt == Scales::FLAT
+      coutn += 2 if @note1_alt == Scales::DFLAT
+      count -= 1 if @note1_alt == Scales::SHARP
+      count -= 1 if @note1_alt == Scales::DSHARP
   
-      alter = @note2[2..3]
-  
-      alter.each_char do |c|
-        count -= 1 if c == 'b'
-        count += 1 if c == '#'
-      end
+      count -= 1 if @note2_alt == Scales::FLAT
+      count -= 2 if @note2_alt == Scales::DFLAT
+      count += 1 if @note2_alt == Scales::SHARP
+      count -= 2 if @note2_alt == Scales::DSHARP
   
       count
     end
@@ -82,7 +80,7 @@ module MusicUtils
     # Common loop to search note 2 
     def until_find_note2(i)
       # search note2
-      while DIATONIC_SCALE[i] != @note2[0..1]
+      while DIATONIC_SCALE[i] != @note2
         i += 1
         if i > DIATONIC_SCALE.length
           i = 0; next 
@@ -93,7 +91,7 @@ module MusicUtils
     
     # Jumps to the next note if note 1 and note 2 are the same
     def no_unison(count, i)   
-      if @note1[0..1] == @note2[0..1]
+      if @note1 == @note2
         count += 1; i += 1
       end
       [count, i]
@@ -101,7 +99,7 @@ module MusicUtils
     
     # Returns index of note 1
     def note1_index
-      DIATONIC_SCALE.index(@note1[0..1])
+      DIATONIC_SCALE.index(@note1)
     end
   
   end

data/lib/music-utils/scales/scales.rb

@@ -1,13 +1,41 @@
 # Scales module
 module Scales
-  DIATONIC_SCALE = ['do', 're', 'mi', 'fa', 'sol', 'la', 'si']
+  
+  # Notes
+  DO = :do
+  RE = :re
+  MI = :mi
+  FA = :fa
+  SOL = :sol
+  LA = :la
+  SI = :si
+  
+  DIATONIC_SCALE = [DO, RE, MI, FA, SOL, LA, SI]
+
+  # Alterations:
+  FLAT = 'b'
+  DFLAT = FLAT + FLAT
+  SHARP = '#'
+  DSHARP = SHARP + SHARP
+
+  # Qualities
+  PERF = 'P'
+  MAJ = 'M'
+  MIN = 'm'
+  AUG = 'A'
+  AUGP = AUG + AUG
+  DIM = 'd'
+  DIMP = DIM + DIM
+
+  # Qualities hash
   QUALITIES = {
-        2 => {0 => 'd', 1 => 'm', 2 => 'M', 3 => 'A', 4 => 'AA'},
-        3 => {1 => 'dd', 2 => 'd', 3 => 'm', 4 => 'M', 5 => 'A', 6 => 'AA'},
-        4 => {3 => 'dd', 4 => 'd', 5 => 'P', 6 => 'A', 7 => 'AA'},
-        5 => {5 => 'dd', 6 => 'd', 7 => 'P', 8 => 'A', 9 => 'AA'},
-        6 => {6 => 'dd', 7 => 'd', 8 => 'm', 9 => 'M', 10 => 'A', 11 => 'AA'},
-        7 => {8 => 'dd', 9 => 'd', 10 => 'm', 11 => 'M', 12 => 'A', 13 => 'AA'},
-        8 => {10 => 'dd', 11 => 'd', 12 => 'P', 13 => 'A', 14 => 'AA'}
+        2 => {0 => DIM, 1 => MIN, 2 => MAJ, 3 => AUG, 4 => AUGP},
+        3 => {1 => DIMP, 2 => DIM, 3 => MIN, 4 => MAJ, 5 => AUG, 6 => AUGP},
+        4 => {3 => DIMP, 4 => DIM, 5 => PERF, 6 => AUG, 7 => AUGP},
+        5 => {5 => DIMP, 6 => DIM, 7 => PERF, 8 => AUG, 9 => AUGP},
+        6 => {6 => DIMP, 7 => DIM, 8 => MIN, 9 => MAJ, 10 => AUG, 11 => AUGP},
+        7 => {8 => DIMP, 9 => DIM, 10 => MIN, 11 => MAJ, 12 => AUG, 13 => AUGP},
+        8 => {10 => DIMP, 11 => DIM, 12 => PERF, 13 => AUG, 14 => AUGP}
       }
+
 end

data/lib/music-utils/version.rb

@@ -1,3 +1,3 @@
 module MusicUtils
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: music-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-06 00:00:00.000000000Z
+date: 2011-05-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &20979048 !ruby/object:Gem::Requirement
+  requirement: &83068570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *20979048
+  version_requirements: *83068570
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &20978820 !ruby/object:Gem::Requirement
+  requirement: &83068380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20978820
+  version_requirements: *83068380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20978544 !ruby/object:Gem::Requirement
+  requirement: &83109790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20978544
+  version_requirements: *83109790
 description: Utils for music. At the moment only to classify intervals.
 email:
 - jorgeluis700@gmail.com
@@ -57,6 +57,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/music-utils_bm.rb
 - lib/music-utils.rb
 - lib/music-utils/interval/interval.rb
 - lib/music-utils/scales/scales.rb