music-utils 1.1.0 → 1.1.1

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.1.1 (May 20, 2011)
+
+Features:
+
+  - Minor implementation improvements
+  
+
 ## 1.1.0 (May 19, 2011)
 
 Features:

data/README.md

@@ -1,35 +1,67 @@
 music-utils
-=========
+===========
+
+Utils to clasify music intervals, create scales and more.
 
-Utils for music. For now to classify music intervals and create scales.
 
 Examples
 --------
-Simple and Compound intervals:
+
+### Intervals
+
+Simples:
   
-    MusicUtils.number(:do, :mi)                 #=> 3 (3th)
-    MusicUtils.semitones(:do, :mi, 1)           #=> 16 (semi-tones)
-    MusicUtils.quality(:do, :mi)                #=> M (major)
+    MusicUtils.number(:do, :mi)                   #=> 3 (3th)
+    MusicUtils.semitones(:do, :mi)                #=> 4 (semi-tones)
+    MusicUtils.quality(:do, :mi)                  #=> M (major)
+
+Compounds:
+
+    MusicUtils.number(:do, :mi, 1)                #=> 3 (3th)
+    MusicUtils.semitones(:do, :mi, 1)             #=> 16 (semi-tones)
+    MusicUtils.quality(:do, :mi, 1)               #=> M (major)
 
 Short Notation:
 
-    MusicUtils.short(:do, :re)                  #=> M2
-    MusicUtils.short(:do, :re, 1)               #=> M9
+    MusicUtils.short(:do, :mi)                    #=> M2
+    MusicUtils.short(:do, :mi, 1)                 #=> M9
+
+### Scales
 
 Create scales:
 
-    MusicUtils.scale(:fa, MusicUtils::MAJ_SCALE) #=> [:fa, :sol, :la, :sib, :do, :re, :mi]
+    MusicUtils.scale(:fa, MusicUtils::MAJ_SCALE)  #=> [:fa, :sol, :la, :sib, :do, :re, :mi]
 
 
 Installation
 -----------
 
     gem install music-utils
+    
+
+Usage
+-----
+The `MusicUtils` module has constants to refer to common items like notes and scales. 
+
+    require 'music-utils'
+    
+    MusicUtils.short(MusicUtils::SOL, MusicUtils::DOF)
+    MusicUtils.scale(MusicUtils::SOL, MusicUtils::MAJ_SCALE)
+
+
+Testing
+-------
+
+To run the tests:
+
+    $ rake
+
 
 To Do
 -----
-  * Add more rspec examples
-  * Add validations (notes, alterations, etc) 
+
+* Add validations (notes, alterations, etc) 
+
 
 Copyright
 ---------

data/Rakefile

@@ -31,5 +31,5 @@ end
 # Profiler tasks
 desc "Run profiler"
 task :profile do
-  `ruby -w -rprofile benchmark/music-utils_bm.rb 10000`
+  `ruby -w -rprofile benchmark/music-utils_bm.rb 1000`
 end

data/benchmark/music-utils_bm.rb

@@ -4,7 +4,9 @@ require 'music-utils'
 require 'music-utils/scales/scales'
 require 'benchmark'
 
-n = (ARGV[0].to_i != 0) ? ARGV[0].to_i : 100000
+include MusicUtils::Scales
+
+n = (ARGV[0].to_i != 0) ? ARGV[0].to_i : 50000
 label_width = 60
 
 # Helper method to print benchmarks titles 
@@ -18,22 +20,34 @@ end
 title 'Classifying do-mi interval', n
 Benchmark.bm(label_width) do |b|
   b.report('with strings (number):') do 
-    n.times { MusicUtils.number('do', 'mi') }
+    n.times { MusicUtils.number('do', 'sol') }
   end
   b.report('with strings (quality):') do 
-    n.times { MusicUtils.quality('do', 'mi') }
+    n.times { MusicUtils.quality('do', 'sol') }
   end
   b.report('with strings (short notation):') do 
-    n.times { MusicUtils.short('do', 'mi') }
+    n.times { MusicUtils.short('do', 'sol') }
   end
   
   b.report('with scales (number):') do
-    n.times { MusicUtils.number(Scales::DO, Scales::MI) }
+    n.times { MusicUtils.number(DO, SOL) }
   end
   b.report('with scales (quality):') do
-    n.times { MusicUtils.quality(Scales::DO, Scales::MI) }
+    n.times { MusicUtils.quality(DO, SOL) }
   end
   b.report('with scales (short notation):') do
-    n.times { MusicUtils.short(Scales::DO, Scales::MI) }
+    n.times { MusicUtils.short(DO, SOL) }
+  end
+end
+
+title 'Create scales', n
+Benchmark.bm(label_width) do |b|
+  b.report('FA major scale: ') do 
+    n.times { MusicUtils.scale(:fa, MusicUtils::MAJ_SCALE) }
+  end
+  b.report('SIb natural minor scale: ') do 
+    n.times { MusicUtils.scale(:sif, MusicUtils::NATURAL_MIN_SCALE) }
   end
 end
+
+

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

@@ -1,5 +1,6 @@
 require 'music-utils/note/note'
 
+module MusicUtils
 # Scales module
 module Scales
   
@@ -148,3 +149,4 @@ module Scales
   end
 
 end
+end

data/lib/music-utils/version.rb

@@ -1,3 +1,3 @@
 module MusicUtils
-  VERSION = '1.1.0'
-end
+  VERSION = '1.1.1'
+end

data/music-utils.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   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.summary       = %q{Utils for common music tasks.}
+  s.description   = %q{Utils to classify music intervals, create scales and more. See README.md and CHANGELOG.md on homepage for more info.}
   s.license       = %q{MIT}
 
   # Files

data/spec/music-utils_spec.rb

@@ -1,7 +1,7 @@
 require 'music-utils'
 
 describe MusicUtils do
-  include Scales
+  include MusicUtils::Scales
   
   context "Intervals" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: music-utils
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-19 00:00:00.000000000Z
+date: 2011-05-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &75690210 !ruby/object:Gem::Requirement
+  requirement: &74447040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *75690210
+  version_requirements: *74447040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &75690020 !ruby/object:Gem::Requirement
+  requirement: &74446850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75690020
+  version_requirements: *74446850
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &75689790 !ruby/object:Gem::Requirement
+  requirement: &74446620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +43,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75689790
-description: Utils for music. At the moment only to classify intervals.
+  version_requirements: *74446620
+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: []
@@ -90,5 +91,5 @@ rubyforge_project:
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Utils for music
+summary: Utils for common music tasks.
 test_files: []