music-utils 1.2.0 → 1.2.1

data/.gitignore

@@ -4,8 +4,13 @@
 # build directory
 pkg/
 
-# Gems
-Gemfile.lock
-
 # vim swap files
 *.swp
+
+# bundler config
+.bundle/
+
+# jedit files
+*.*~
+*.*#
+

data/CHANGELOG.md

@@ -1,9 +1,17 @@
+## 1.2.1 (Jun 28, 2011)
+
+Features:
+
+  - Added support to major pentatonic scale and virtually any other scale 
+
+
 ## 1.2.0 (May 25, 2011)
 
 Features:
 
   - Added functionality to calculate the highest note of an interval 
 
+  
 ## 1.1.2 (May 21, 2011)
 
 Features:

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    music-utils (1.2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  music-utils!
+  rake (>= 0.8)
+  rspec

data/README.md

@@ -60,14 +60,14 @@ Testing
 
 To run the tests:
 
-    $ rake
+    $ bin/rake
 
 
 To Do
 -----
 
 * Add validations (notes, alterations, etc) 
-* Add support to pentatonic scale and others
+* Add other scales structures and its tests 
 
 
 Copyright

data/bin/rake

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rake $1

data/lib/music-utils.rb

@@ -1,40 +1,40 @@
-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)
-    Interval.new(note1, note2, step).number
-  end
-    
-  # Returns semitones of interval
-  def MusicUtils.semitones(note1, note2, step = 0)
-    Interval.new(note1, note2, step).semitones
-  end
-
-  # Returns the quality of interval
-  def MusicUtils.quality(note1, note2, step = 0)
-    Interval.new(note1, note2, step).quality
-  end
-
-  # Returns short notation
-  def MusicUtils.short(note1, note2, step = 0)
-    Interval.new(note1, note2, step).short
-  end
-  
+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)
+    Interval.new(note1, note2, step).number
+  end
+    
+  # Returns semitones of interval
+  def MusicUtils.semitones(note1, note2, step = 0)
+    Interval.new(note1, note2, step).semitones
+  end
+
+  # Returns the quality of interval
+  def MusicUtils.quality(note1, note2, step = 0)
+    Interval.new(note1, note2, step).quality
+  end
+
+  # Returns short notation
+  def MusicUtils.short(note1, note2, step = 0)
+    Interval.new(note1, note2, step).short
+  end
+  
   # Returns the second note of an interval
   # calculates from its first note and number 
   # and quality in short notation
-  def MusicUtils.high_note(from, short)
-    Interval.high_note(from, short)
-  end
-  
-  # Returns a scale 
-  def MusicUtils.scale(from, scale)
-    Scales.scale(from, scale)
-  end
-
+  def MusicUtils.high_note(from, short)
+    Interval.high_note(from, short)
+  end
+  
+  # Returns a scale 
+  def MusicUtils.scale(from, scale)
+    Scales.scale(from, scale)
+  end
+
 end

data/lib/music-utils/errors/error.rb

@@ -0,0 +1,6 @@
+module MusicUtils
+	# Tag module for errors
+	module Errors
+	end
+end
+

data/lib/music-utils/errors/interval_errors.rb

@@ -0,0 +1,15 @@
+module MusicUtils
+
+  # This exception its raised when 
+  # a given interval is invalid  
+  class InvalidInterval < StdError
+    attr_reader :interval
+  
+    def initialize(msg, original=$!, interval)
+      super(msg, original)
+      @interval = interval
+    end
+  end
+
+end
+

data/lib/music-utils/errors/note_errors.rb

@@ -0,0 +1,15 @@
+module MusicUtils
+
+  # This exception its raised when 
+  # a given note is invalid  
+  class InvalidNote < StdError
+    attr_reader :note
+  
+    def initialize(msg, original=$!, note)
+      super(msg, original)
+      @note = note
+    end
+  end
+
+end
+

data/lib/music-utils/errors/std_error.rb

@@ -0,0 +1,16 @@
+module MusicUtils
+
+  # Prevents the user of the library
+  # from rescuing the global `StandardError`. 
+  class StdError < StandardError
+    extend Error
+    attr_reader :original
+
+    # Create the error with a message and an original that defaults to 
+    # the exception that is currently active, in this thread, if one exists       
+    def initialize(msg, original=$!)
+      super(msg)
+      @original = original;
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module Scales
   SI  = :si
   
   DIATONIC_SCALE = [DO, RE, MI, FA, SOL, LA, SI]
+  DIATONIC_SCALE_AUX = [DO, DO, RE, RE, MI, FA, FA, SOL, SOL, LA, LA, SI]
   
   # Alterations:
   FLAT    = 'f'
@@ -72,6 +73,7 @@ module Scales
   MAJ_SCALE = [2, 2, 1, 2, 2, 2, 1]
   NATURAL_MIN_SCALE = [2, 1, 2, 2, 1, 2, 2]
   MELODIC_MIN_SCALE = [2, 1, 2, 2, 1, 2, 1]
+  PENTATONIC_MAJ = [2, 2, 3, 2, 3]
   
   # Qualities
   PERF = 'P'
@@ -104,7 +106,8 @@ module Scales
 
     from_note, from_alter = MusicUtils::Note.parse(from)
     
-    diatonic_scale = diatonic_scale_from(from_note)
+    #diatonic_scale = diatonic_scale_from(from_note)
+    diatonic_scale = scale_from(from_note, scale_struct)
     diatonic_scale.delete(from_note)
 
     length = CROMATIC_SCALE.length
@@ -129,22 +132,10 @@ module Scales
 
     scale
   end
-  
-  # Create a diatonic scale starting with the  "from" note
+
+  # Create a diatonic scale starting with the "from" note
   def Scales.diatonic_scale_from(from)
-    diatonic_scale = []
-    length = DIATONIC_SCALE.length
-    i = DIATONIC_SCALE.index(from)
-    c = 0
-    while c < length
-      diatonic_scale << DIATONIC_SCALE[i]
-      i += 1
-      c += 1
-      if i > length - 1
-        i = 0
-      end 
-    end
-    diatonic_scale
+    diatonic_aux_scale_from(from).uniq
   end
 
   # Returns index of the note in the cromatic scale
@@ -165,5 +156,43 @@ module Scales
     i
   end    
 
+  # Create a diatonic scale starting with the "from" note
+  # with notes dups
+  def Scales.diatonic_aux_scale_from(from)
+    diatonic_scale = []
+    length = DIATONIC_SCALE_AUX.length
+    i = DIATONIC_SCALE_AUX.index(from)
+    c = 0
+    while c < length
+      diatonic_scale << DIATONIC_SCALE_AUX[i]
+      i += 1
+      c += 1
+      if i > length - 1
+        i = 0
+      end 
+    end
+    diatonic_scale
+  end
+
+  def Scales.scale_from(from_note, scale_struct)
+    i = 0
+    c = 0
+    scale = []
+    scale << from_note
+    
+    ds = diatonic_aux_scale_from(from_note)
+    
+    while c < scale_struct.size
+      i += scale_struct[c]
+      if scale.last != ds[i]
+        scale << ds[i]  
+      else
+        scale << ds[i + 1]
+      end
+        c += 1
+    end
+    scale
+  end	  
+  
 end
 end

data/lib/music-utils/version.rb

@@ -1,3 +1,3 @@
 module MusicUtils
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/spec/music-utils_spec.rb

@@ -309,25 +309,25 @@ describe MusicUtils do
   context "Scales" do
     context "Major scale" do
       context "Natural notes" do
-        it "the major scale of DO should be [DO, RE, MI, FA, SOL, LA, SI, DO]" do
+        it "the major scale of DO should be [DO, RE, MI, FA, SOL, LA, SI]" do
           MusicUtils.scale(DO, MAJ_SCALE).should == [DO, RE, MI, FA, SOL, LA, SI]
         end
-        it "the major scale of RE should be [RE, MI, FAS, SOL, LA, SI, DOS, RE]" do
+        it "the major scale of RE should be [RE, MI, FAS, SOL, LA, SI, DOS]" do
           MusicUtils.scale(RE, MAJ_SCALE).should == [RE, MI, FAS, SOL, LA, SI, DOS]
         end
-        it "the major scale of MI should be [MI, FAS, SOLS, LA, SI, DOS, RES, MI]" do
+        it "the major scale of MI should be [MI, FAS, SOLS, LA, SI, DOS, RES]" do
           MusicUtils.scale(MI, MAJ_SCALE).should == [MI, FAS, SOLS, LA, SI, DOS, RES]
         end
-        it "the major scale of FA should be [FA, SOL, LA, SIF, DO, RE, MI, FA]" do
+        it "the major scale of FA should be [FA, SOL, LA, SIF, DO, RE, MI]" do
           MusicUtils.scale(FA, MAJ_SCALE).should == [FA, SOL, LA, SIF, DO, RE, MI]
         end
-        it "the major scale of SOL should be [SOL, LA, SI, DO, RE, MI, FAS, SOL]" do
+        it "the major scale of SOL should be [SOL, LA, SI, DO, RE, MI, FAS]" do
           MusicUtils.scale(SOL, MAJ_SCALE).should == [SOL, LA, SI, DO, RE, MI, FAS]
         end
-        it "the major scale of LA should be [LA, SI, DOS, RE, MI, FAS, SOLS, LA]" do
+        it "the major scale of LA should be [LA, SI, DOS, RE, MI, FAS, SOLS]" do
           MusicUtils.scale(LA, MAJ_SCALE).should == [LA, SI, DOS, RE, MI, FAS, SOLS]
         end
-        it "the major scale of SI should be [SI, DOS, RES, MI, FAS, SOLS, LAS, SI]" do
+        it "the major scale of SI should be [SI, DOS, RES, MI, FAS, SOLS, LAS]" do
           MusicUtils.scale(SI, MAJ_SCALE).should == [SI, DOS, RES, MI, FAS, SOLS, LAS]
         end
       end
@@ -451,8 +451,78 @@ describe MusicUtils do
           end
         end
       end
-      
+      context "Pentatonic major" do
+        context "Natural notes" do
+          it "the pentatonic major scale of DO should be [DO, RE, MI, SOL, LA]" do
+            MusicUtils.scale(DO, PENTATONIC_MAJ).should == [DO, RE, MI, SOL, LA]
+          end
+          it "the pentatonic major scale of RE should be [RE, MI, FAS, LA, SI]" do
+            MusicUtils.scale(RE, PENTATONIC_MAJ).should == [RE, MI, FAS, LA, SI]
+          end
+          it "the pentatonic major scale of MI should be [MI, FAS, SOLS, SI, DOS]" do
+            MusicUtils.scale(MI, PENTATONIC_MAJ).should == [MI, FAS, SOLS, SI, DOS]
+          end
+          it "the pentatonic major scale of FA should be [FA, SOL, LA, DO, RE]" do
+            MusicUtils.scale(FA, PENTATONIC_MAJ).should == [FA, SOL, LA, DO, RE]
+          end
+          it "the pentatonic major scale of SOL should be [SOL, LA, SI, RE, MI]" do
+            MusicUtils.scale(SOL, PENTATONIC_MAJ).should == [SOL, LA, SI, RE, MI]
+          end
+          it "the pentatonic major scale of LA should be [LA, SI, DOS, MI, FAS]" do
+            MusicUtils.scale(LA, PENTATONIC_MAJ).should == [LA, SI, DOS, MI, FAS]
+          end
+          it "the pentatonic major scale of SI should be [SI, DOS, RES, FAS, SOLS]" do
+            MusicUtils.scale(SI, PENTATONIC_MAJ).should == [SI, DOS, RES, FAS, SOLS]
+          end
+        end
+        context "Sharped notes" do
+          it "the major pentatonic of DO# should be  [DOS, RES, MIS, SOLS, LAS]" do
+            MusicUtils.scale(DOS, PENTATONIC_MAJ).should == [DOS, RES, MIS, SOLS, LAS]
+          end
+          it "the major pentatonic of RE# should be [RES, MIS, FASS, LAS, SIS]" do
+            MusicUtils.scale(RES, PENTATONIC_MAJ).should == [RES, MIS, FASS, LAS, SIS]
+          end
+          it "the major pentatonic of MI# should be  [MIS, FASS, SOLSS, SIS, DOSS]" do
+            MusicUtils.scale(MIS, PENTATONIC_MAJ).should == [MIS, FASS, SOLSS, SIS, DOSS]
+          end
+          it "the major pentatonic of FA# should be [FAS, SOLS, LAS, DOS, RES]" do
+            MusicUtils.scale(FAS, PENTATONIC_MAJ).should == [FAS, SOLS, LAS, DOS, RES]
+          end
+          it "the major pentatonic of SOL# should be [SOLS, LAS, SIS, RES, MIS]" do
+            MusicUtils.scale(SOLS, PENTATONIC_MAJ).should == [SOLS, LAS, SIS, RES, MIS]
+          end
+          it "the major pentatonic of LA# should be  [LAS, SIS, DOSS, MIS, FASS]" do
+            MusicUtils.scale(LAS, PENTATONIC_MAJ).should == [LAS, SIS, DOSS, MIS, FASS]
+          end
+          it "the major pentatonic of SI# should be [SIS, DOSS, RESS, FASS, SOLSS]" do
+            MusicUtils.scale(SIS, PENTATONIC_MAJ).should == [SIS, DOSS, RESS, FASS, SOLSS]
+          end
+        end
+        context "Flated notes" do
+          it "the major pentatonic of DOb should be [DOF, REF, MIF, SOLF, LAF]" do
+            MusicUtils.scale(DOF, PENTATONIC_MAJ).should == [DOF, REF, MIF, SOLF, LAF]
+          end
+          it "the major pentatonic of REb should be [REF, MIF, FA, LAF, SIF]" do
+            MusicUtils.scale(REF, PENTATONIC_MAJ).should == [REF, MIF, FA, LAF, SIF]
+          end
+          it "the major pentatonic of MIb should be [MIF, FA, SOL, SIF, DO]" do
+            MusicUtils.scale(MIF, PENTATONIC_MAJ).should == [MIF, FA, SOL, SIF, DO]
+          end
+          it "the major pentatonic of FAb should be  [FAF, SOLF, LAF, DOF, REF]" do
+            MusicUtils.scale(FAF, PENTATONIC_MAJ).should == [FAF, SOLF, LAF, DOF, REF]
+          end
+          it "the major pentatonic of SOLb should be [SOLF, LAF, SIF, REF, MIF]" do
+            MusicUtils.scale(SOLF, PENTATONIC_MAJ).should == [SOLF, LAF, SIF, REF, MIF]
+          end
+          it "the major pentatonic of LAb should be [LAF, SIF, DO, MIF, FA]" do
+            MusicUtils.scale(LAF, PENTATONIC_MAJ).should == [LAF, SIF, DO, MIF, FA]
+          end
+          it "the major pentatonic of SIb should be [SIF, DO, RE, FA, SOL]" do
+            MusicUtils.scale(SIF, PENTATONIC_MAJ).should == [SIF, DO, RE, FA, SOL]
+          end
+        end
+      end
     end
   end
-
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: music-utils
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-25 00:00:00.000000000Z
+date: 2011-06-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &85461120 !ruby/object:Gem::Requirement
+  requirement: &83229490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *85461120
+  version_requirements: *83229490
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &85460930 !ruby/object:Gem::Requirement
+  requirement: &80893800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85460930
+  version_requirements: *80893800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &85460700 !ruby/object:Gem::Requirement
+  requirement: &80897410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,23 +43,30 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85460700
+  version_requirements: *80897410
 description: Utils to classify music intervals, create scales and more. See README.md
   and CHANGELOG.md on homepage for more info.
 email:
 - jorgeluis700@gmail.com
-executables: []
+executables:
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - benchmark/music-utils_bm.rb
+- bin/rake
 - lib/music-utils.rb
+- lib/music-utils/errors/error.rb
+- lib/music-utils/errors/interval_errors.rb
+- lib/music-utils/errors/note_errors.rb
+- lib/music-utils/errors/std_error.rb
 - lib/music-utils/interval/interval.rb
 - lib/music-utils/note/note.rb
 - lib/music-utils/scales/scales.rb
@@ -80,6 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 869210273
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -88,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Utils for common music tasks.