music-utils 0.5.2 → 1.0.0

data/.gitignore

@@ -2,4 +2,7 @@
 .redcar/
 
 # build directory
-pkg/
+pkg/
+
+# Gems
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.0.0 (May 6, 2011)
+
+Features:
+
+  - Added MusicUtils module
+  - New shortcuts for clasify intervals on MusicUtils module
+
+
+## 0.5.2 (April 29, 2011)
+
+Features:
+
+  - Extracted some common logic into helper methods
+
+
 ## 0.5.1 (April 27, 2011)
 
 Features:

data/Gemfile

@@ -1,3 +1,2 @@
 source "http://rubygems.org"
-gem "rake", ' ~> 0.8'
-gem "rspec", '~> 2.5'
+gemspec

data/README.md

@@ -1,30 +1,35 @@
 music-utils
 =========
 
-Utils for music. At the moment only one class to classify intervals.
+Utils for music. At the moment only to classify interval.
 
 Examples
 --------
 Simple intervals:
   
-  * Interval.new('do', 'mi', 0).number    #=> 3 (3th)
-  * Interval.new('do', 'mi', 0).semitone  #=> 4 (semi-tones)
-  * Interval.new('do', 'mi', 0).quality   #=> M (major)
-  * Interval.new('do#', 'mi', 0).quality  #=> m (minor)
+  * MusicUtils.number('do', 'mi')         #=> 3 (3th)
+  * MusicUtils.semitones('do', 'mi')      #=> 4 (semi-tones)
+  * MusicUtils.quality('do', 'mi')        #=> M (major)
+  * MusicUtils.quality('do#', 'mi')       #=> m (minor)
 
 Compound intervals:
   
-  * Interval.new('do', 'mi', 1).number    #=> 10 (10th)
-  * Interval.new('do', 'mi', 1).semitone  #=> 16 (semi-tones)
-  * Interval.new('do', 'mi', 1).quality   #=> M (major)
-  * Interval.new('dob', 'mi#', 1).quality #=> AA (augmented plus)
+  * MusicUtils.number('do', 'mi', 1)      #=> 10 (10th)
+  * MusicUtils.semitones('do', 'mi', 1)   #=> 16 (semi-tones)
+  * MusicUtils.quality('do', 'mi', 1)     #=> M (major)
+  * MusicUtils.quality('dob', 'mi#', 1)   #=> AA (augmented plus)
 
 Short Notation:
 
-  * Interval.new('do', 're', 0).short     #=> M2
-  * Interval.new('do', 're', 1).short     #=> M9
-  * Interval.new('do#', 'mi', 0).short    #=> m3
-  * Interval.new('do#', 'mi', 1).short    #=> m10
+  * MusicUtils.short('do', 're')          #=> M2
+  * MusicUtils.short('do', 're', 1)       #=> M9
+  * MusicUtils.short('do#', 'mi')         #=> m3
+  * MusicUtils.short('do#', 'mi', 1)      #=> m10
+
+Installation
+-----------
+
+    gem install music-utils
 
 To Do
 -----

data/Rakefile

@@ -1,6 +1,3 @@
-require 'rubygems'
-require 'bundler/setup'
-
 require 'rake'
 require 'rspec/core/rake_task'
 
@@ -16,27 +13,8 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
 end
 
 # Gems tasks
-desc "Load the gemspec"
-task :load_gemspec do
-  @gemspec = eval(File.read(Dir["*.gemspec"].first))
-end
-
-desc "Validate the gemspec"
-task :gemspec => :load_gemspec do
-  @gemspec.validate
-end
-
-desc "Build gem locally"
-task :build => :gemspec do
-  system "gem build #{@gemspec.name}.gemspec"
-  FileUtils.mkdir_p "pkg"
-  FileUtils.mv "#{@gemspec.name}-#{@gemspec.version}.gem", "pkg"
-end
-
-desc "Install gem locally"
-task :install => :build do
-  system "gem install pkg/#{@gemspec.name}-#{@gemspec.version}"
-end
+require "bundler"
+Bundler::GemHelper.install_tasks
 
 desc "Clean automatically generated files"
 task :clean do

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

@@ -0,0 +1,109 @@
+require 'music-utils/scales/scales'
+
+# This class represents a music interval
+module MusicUtils
+  
+  class Interval
+    include Scales
+  
+    def initialize(note1, note2, step)
+      @note1 = note1
+      @note2 = note2
+      @step = step
+    end
+  
+    # It classifies the diatonic interval
+    def number
+      # initialize counter and index of scale
+      i = note1_index
+      count = 1
+  
+      count, i = no_unison(count, i)
+  
+      # Counting notes
+      until_find_note2(i) { count += 1 }
+  
+      count = count + (8 * @step) - 1 if @step > 0
+      count
+    end
+  
+    # Returns the number of semitones
+    def semitones
+      # initialize counter and index of scale
+      i = note1_index 
+      count = 0
+  
+      count, i = no_unison(count, i)
+      
+      # counting semi-tones
+      until_find_note2(i) do |i|
+        # from 'mi' to 'fa' and 'si' to 'do' there 1 semi-tone
+        if DIATONIC_SCALE[i] == 'fa' or DIATONIC_SCALE[i] == 'do'
+          count += 1
+        else
+          count += 2
+        end
+      end
+      
+      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
+  
+      alter = @note2[2..3]
+  
+      alter.each_char do |c|
+        count -= 1 if c == 'b'
+        count += 1 if c == '#'
+      end
+  
+      count
+    end
+    
+    # Returns the quality of the interval
+    def quality
+      s = ( @step > 0 and semitones - (12 * @step) ) || semitones
+      n = ( @step > 0 and number - (7 * @step) ) || number
+      QUALITIES[n][s]
+    end
+  
+    # Returns the class interval in the short notation
+    def short
+      quality + number.to_s 
+    end
+  
+    private
+  
+    # Common loop to search note 2 
+    def until_find_note2(i)
+      # search note2
+      while DIATONIC_SCALE[i] != @note2[0..1]
+        i += 1
+        if i > DIATONIC_SCALE.length
+          i = 0; next 
+        end
+        yield i
+      end
+    end
+    
+    # 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]
+        count += 1; i += 1
+      end
+      [count, i]
+    end
+    
+    # Returns index of note 1
+    def note1_index
+      DIATONIC_SCALE.index(@note1[0..1])
+    end
+  
+  end
+  
+end

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

@@ -0,0 +1,13 @@
+# Scales module
+module Scales
+  DIATONIC_SCALE = ['do', 're', 'mi', 'fa', 'sol', 'la', 'si']
+  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'}
+      }
+end

data/lib/music-utils/version.rb

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

data/lib/music-utils.rb

@@ -0,0 +1,26 @@
+require 'music-utils/interval/interval'
+
+# Music utils 
+module MusicUtils
+  
+  # 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
+
+end

data/music-utils.gemspec

@@ -1,22 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "music-utils/version"
 
 Gem::Specification.new do |s|
   # Basic Info
-  s.name          = 'music-utils'
-  s.version       = '0.5.2'
-  s.summary       = 'music-utils'
-  s.description   = 'Utils for music. At the moment only one class to classify intervals.'
+  s.name          = "music-utils"
+  s.version       = MusicUtils::VERSION
   s.platform      = Gem::Platform::RUBY
-  s.authors       = ['Jorge Luis Pérez']
-  s.email         = ['jorgeluis700@gmail.com']
-  s.homepage      = 'http://github.com/jorgeluis700/music-utils'
-  s.license       = 'MIT'
-  
-  # Files and Paths
-  s.files         = `git ls-files`.split("\n")
-  s.require_path  = 'lib'
+  s.authors       = ["Jorge Luis Pérez"]
+  s.email         = ["jorgeluis700@gmail.com"]
+  s.homepage      = "http://github.com/jorgeluis700/music-utils"
+  s.summary       = %q{Utils for music}
+  s.description   = %q{Utils for music. At the moment only to classify intervals.}
+  s.license       = %q{MIT}
+
+  # Files
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
   
-  # Dependencies
-  s.add_development_dependency('rspec')
+  # Ruby Gems Version
   s.required_rubygems_version = ">= 1.3.6"
 
+  # Dependencies
+  s.add_development_dependency  "rake", ">= 0.8"
+  s.add_development_dependency  "bundler"
+  s.add_development_dependency  "rspec"
+  
 end

data/spec/{interval_spec.rb → interval/interval_spec.rb}

@@ -1,6 +1,7 @@
-require 'interval'
+require 'music-utils/interval/interval'
 
-describe Interval do
+describe  MusicUtils::Interval do
+  include MusicUtils
   
   context "Number of intervals" do
     it "the number of simple interval do-mi should be a 3rd" do
@@ -22,22 +23,22 @@ describe Interval do
   context "Number of semitones of intervals" do
     it "simple interval do-mi should be 4 semitones" do
       i = Interval.new('do', 'mi', 0)
-      i.semitone.should == 4
+      i.semitones.should == 4
     end
 
     it "simple interval dob-mi# should be 6 semitones" do
       i = Interval.new('dob', 'mi#', 0)
-      i.semitone.should == 6
+      i.semitones.should == 6
     end
 
     it "simple interval do-do should be 12 semitones" do
       i = Interval.new('do', 'do', 0)
-      i.semitone.should == 12
+      i.semitones.should == 12
     end
     
     it "compound interval do-mi should be 16 semitones" do
       i = Interval.new('do', 'mi', 1)
-      i.semitone.should == 16
+      i.semitones.should == 16
     end
   end
 

data/spec/music-utils_spec.rb

@@ -0,0 +1,45 @@
+require 'music-utils'
+
+describe MusicUtils do
+
+  context "Intervals" do
+
+    context "By number" do
+      it "the number of simple interval do-mi should be a 3rd" do
+        MusicUtils.number('do', 'mi').should == 3
+      end
+      it "the number of do-mi compound interval should be a 10th" do
+        MusicUtils.number('do', 'mi', 1).should == 10
+      end
+    end
+      
+    context "By semitones" do  
+      it "simple interval do-mi should be 4 semitones" do
+        MusicUtils.semitones('do', 'mi').should == 4
+      end
+      it "compound interval do-mi should be 16 semitones" do
+        MusicUtils.semitones('do', 'mi', 1).should == 16
+      end
+    end
+    
+    context "By quality" do  
+      it "quality of interval do-mi should be M" do
+        MusicUtils.quality('do', 'mi').should == 'M'
+      end
+      it "quality of compound interval do-mi should be M" do
+        MusicUtils.quality('do', 'mi', 1).should == 'M'
+      end
+    end
+
+    context "By short notation" do  
+      it "the short notation of do#-mi interval should be m3" do
+        MusicUtils.short('do#', 'mi').should == 'm3'
+      end
+      it "the short notation of do#-mi compound interval should be m10" do
+        MusicUtils.short('do#', 'mi', 1).should == 'm10'
+      end
+    end
+    
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: music-utils
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-29 00:00:00.000000000Z
+date: 2011-05-06 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &20979048 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *20979048
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &20978820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20978820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &24028992 !ruby/object:Gem::Requirement
+  requirement: &20978544 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24028992
-description: Utils for music. At the moment only one class to classify intervals.
+  version_requirements: *20978544
+description: Utils for music. At the moment only to classify intervals.
 email:
 - jorgeluis700@gmail.com
 executables: []
@@ -32,13 +54,16 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/interval.rb
+- lib/music-utils.rb
+- lib/music-utils/interval/interval.rb
+- lib/music-utils/scales/scales.rb
+- lib/music-utils/version.rb
 - music-utils.gemspec
-- spec/interval_spec.rb
+- spec/interval/interval_spec.rb
+- spec/music-utils_spec.rb
 homepage: http://github.com/jorgeluis700/music-utils
 licenses:
 - MIT
@@ -52,9 +77,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 934369633
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -66,5 +88,5 @@ rubyforge_project:
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: music-utils
+summary: Utils for music
 test_files: []

data/Gemfile.lock

@@ -1,21 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  rake (~> 0.8)
-  rspec (~> 2.5)

data/lib/interval.rb

@@ -1,117 +0,0 @@
-# Scales module
-module Scales
-  DIATONIC_SCALE = ['do', 're', 'mi', 'fa', 'sol', 'la', 'si']
-  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'}
-      }
-end
-
-# This class represents a music interval
-class Interval
-  include Scales
-
-  def initialize(note1, note2, step)
-    @note1 = note1
-    @note2 = note2
-    @step = step
-  end
-
-  # It classifies the diatonic interval
-  def number
-    # initialize counter and index of scale
-    i = note1_index
-    count = 1
-
-    count, i = no_unison(count, i)
-
-    # Counting notes
-    until_find_note2(i) { count += 1 }
-
-    count = count + (8 * @step) - 1 if @step > 0
-    count
-  end
-
-  # Returns the number of semitones
-  def semitone
-    # initialize counter and index of scale
-    i = note1_index 
-    count = 0
-
-    count, i = no_unison(count, i)
-    
-    # counting semi-tones
-    until_find_note2(i) do |i|
-      # from 'mi' to 'fa' and 'si' to 'do' there 1 semi-tone
-      if DIATONIC_SCALE[i] == 'fa' or DIATONIC_SCALE[i] == 'do'
-        count += 1
-      else
-        count += 2
-      end
-    end
-    
-    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
-
-    alter = @note2[2..3]
-
-    alter.each_char do |c|
-      count -= 1 if c == 'b'
-      count += 1 if c == '#'
-    end
-
-    count
-  end
-  
-  # Returns the quality of the interval
-  def quality
-    s = ( @step > 0 and semitone - (12 * @step) ) || semitone
-    n = ( @step > 0 and number - (7 * @step) ) || number
-    QUALITIES[n][s]
-  end
-
-  # Returns the class interval in the short notation
-  def short
-    quality + number.to_s 
-  end
-
-  private
-
-  # Common loop to search note 2 
-  def until_find_note2(i)
-    # search note2
-    while DIATONIC_SCALE[i] != @note2[0..1]
-      i += 1
-      if i > DIATONIC_SCALE.length
-        i = 0; next 
-      end
-      yield i
-    end
-  end
-  
-  # 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]
-      count += 1; i += 1
-    end
-    [count, i]
-  end
-  
-  # Returns index of note 1
-  def note1_index
-    DIATONIC_SCALE.index(@note1[0..1])
-  end
- 
-end