trriad 0.0.1 → 0.0.2.19

data/History.txt

@@ -1,3 +1,16 @@
+== 0.0.2.x 2007-xx-xx
+
+* add "<key>".scale support, you can now do
+  "Bb".scale and get ["Bb", "C", "D", "Eb", "F", "G", "A"]
+* add declarations for the following chord types:
+  maj,6,m6,maj7,m7,dim,+,9,7+5,7b5,m7b5,m9,9+5,9b5,
+  maj9,6add9,7b9,7sus4,7add6,11,11+,11b9,13 and 13b9
+  (m and 7 were already present in 0.0.1)
+* documentation updates
+  * more code comments
+  * website
+  * readme
+
 == 0.0.1 2007-05-30
 
 * 1 major enhancement:

data/Manifest.txt

@@ -5,6 +5,7 @@ README.txt
 Rakefile
 lib/trriad.rb
 lib/trriad/chord.rb
+lib/trriad/chord_data.rb
 lib/trriad/core_ext.rb
 lib/trriad/core_ext/string.rb
 lib/trriad/core_ext/string/chord.rb
@@ -18,3 +19,4 @@ website/index.txt
 website/javascripts/rounded_corners_lite.inc.js
 website/stylesheets/screen.css
 website/template.rhtml
+website/todo.txt

data/README.txt

@@ -1,5 +1,7 @@
 README for trriad
 =================
+More detailed information is at http://trriad.rubyforge.org
+
 This is trriad, a musical library for dealing with chords and stuff.
 
 for now, the following should work:

data/Rakefile

@@ -47,9 +47,9 @@ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
 NAME = "trriad"
-REV = nil 
+#REV = nil 
 # UNCOMMENT IF REQUIRED: 
-#REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
 VERS = Trriad::VERSION::STRING + (REV ? ".#{REV}" : "")
 CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
 RDOC_OPTS = ['--quiet', '--title', 'trriad documentation',

data/lib/trriad.rb

@@ -4,5 +4,6 @@ end
 require 'fileutils'
 
 require File.dirname(__FILE__) + '/trriad/version'
+require File.dirname(__FILE__) + '/trriad/chord_data'
 require File.dirname(__FILE__) + '/trriad/chord'
 require File.dirname(__FILE__) + '/trriad/core_ext.rb'

data/lib/trriad/chord.rb

@@ -1,69 +1,42 @@
 module Trriad
   module Chord
 
-CHORDS = {
-            "m"   => "1,3b,5",
-            "7"   => "1,3,5,7b"
-         }
-
-NOTESSHARP = "C,C#,D,D#,E,F,F#,G,G#,A,A#,B".split(",")
-NOTESFLAT  = "C,Db,D,Eb,E,F,Gb,G,Ab,A,Bb,B".split(",")
-
-DISTANCES = "2,2,1,2,2,2,1".split(",")
-
-SHARPS = "G,D,A,E,F,C".split(",")
-FLATS = "Bb,Eb,Ab,Db,Gb,Cb,Fb".split(",")
-
-#puts CHORDS
-#puts CHORDS["m"]
-
-def self.valid_note(note)
-  NOTESSHARP.include?(note) ? true : 
-  NOTESFLAT.include?(note)  ? true : 
-  false
-end
-
-def next_semi(root)
-  if NOTESSHARP.include?(root) then
-    at=NOTESSHARP.index(root)
-    tmp=NOTESSHARP + NOTESSHARP
-    at+=1
-    tmp[at]
-  else
-    if NOTESFLAT.include?(root) then
-      at=NOTESFLAT.index(root)
-      at+=1
-      NOTESFLAT[at]
+    # check if it's a valid note
+    # returns true of false
+    def self.valid_note(note)
+      NOTES[:sharp].include?(note) ? true : 
+      NOTES[:flat].include?(note)  ? true : 
+      false
     end
-  end
-end
-
-def get_toonladder(root)
-  result="#{root}"
-  cur=root
-  DISTANCES.each { |distance|
-    1.upto(distance.to_i) {
-      cur=next_semi(cur)
-    }
-    result += ",#{cur}"
-  }
-  result
-end
 
-#puts next_semi("C")
-#puts next_semi("Db")
-#puts get_toonladder("C")
-
-#NOTESSHARP.each { |root|
-#  puts get_toonladder(root)
-#}
+    # get the next semi note
+    # return the note as a string
+    def self.next_semi(root, accidental = :sharp)
+      if NOTES[accidental].include?(root) then
+        at=NOTES[accidental].index(root)
+        tmp=NOTES[accidental] + NOTES[accidental]
+        at+=1
+        tmp[at]
+      end
+    end
 
-#NOTESFLAT.each { |root|
-#  puts get_toonladder(root)
-#}
-#puts valid_note("C")
-#puts valid_note("C#")
-#puts valid_note("Db")
+    # get the scale of a root note
+    # returns an array of strings with the scale notes
+    def self.get_scale(root)
+      accitental = nil
+      accidental = :flat if KEYS[:flat].include?(root)
+      accidental = :sharp if KEYS[:sharp].include?(root)
+  
+      result="#{root}"
+      cur=root
+      DISTANCES.each { |distance|
+        1.upto(distance.to_i) {
+          cur=next_semi(cur,accidental)
+        }
+        result += ",#{cur}"
+      }
+      result.split(',')
+    end
 
   end
 end

data/lib/trriad/chord_data.rb

@@ -0,0 +1,53 @@
+module Trriad
+  module Chord
+
+# all the different chord notations
+CHORDS = {
+            "maj"   => "1,3,5".split(','),
+            "m"     => "1,3b,5".split(','),
+            "7"     => "1,3,5,7b".split(','),
+            "6"     => "1,3,5,6".split(','),
+            "m6"    => "1,3b,5,6".split(','),
+            "maj7"  => "1,3,5,7".split(','),
+            "m7"    => "1,3b,5,7".split(','),
+            "dim"   => "1,3b,5b,6".split(','),
+            "+"     => "1,3,5#".split(','),
+            "9"     => "1,3,5,7b,9".split(','),
+            "7+5"   => "1,3,5#,7b".split(','),
+            "7b5"   => "1,3,5b,7b".split(','),
+            "m7b5"  => "1,3b,5b,7b".split(','),
+            "m9"    => "1,3b,5,7b,9".split(','),
+            "9+5"   => "1,3,5#,7b,9".split(','),
+            "9b5"   => "1,3,5b,7b,9".split(','),
+            "maj9"  => "1,3,5,7,9".split(','),
+            "6add9" => "1,3,5,6,9".split(','),
+            "7b9"   => "1,3,5,7b,9b".split(','),
+            "7sus4" => "1,4,5,7b".split(','),
+            "7add6" => "1,3,5,6,7b".split(','),
+            "11"    => "1,3,5,7b,9,11".split(','),
+            "11+"   => "1,3,5,7b,9,11#".split(','),
+            "11b9"  => "1,3,5,7b,9b,11".split(','),
+            "13"    => "1,3,5,7b,9,11,13".split(','),
+            "13b9"  => "1,3,5,7b,9b,11,13".split(','),
+         }
+
+# sharp and flat available notes
+NOTES = {
+          :sharp => "C,C#,D,D#,E,F,F#,G,G#,A,A#,B".split(","),
+          :flat  => "C,Db,D,Eb,E,F,Gb,G,Ab,A,Bb,B".split(",")
+        }
+
+#DISTANCES = "2,2,1,2,2,2,1".split(",")
+# the semitone distances for a major key
+DISTANCES = "2,2,1,2,2,2".split(",")
+
+# differentiate the keys with sharps and flats
+KEYS = {
+          # since we only have :sharp an :flat, I need to put "C" somewhere
+          # so it's in :sharp
+          :sharp => "C,G,D,A,E,B,F#,C#".split(","),
+          :flat  => "Bb,Eb,Ab,Db,Gb,Cb,Fb".split(","),
+       }
+
+  end
+end

data/lib/trriad/core_ext.rb

@@ -1 +1,2 @@
+# core extensions for trriad
 Dir[File.dirname(__FILE__) + "/core_ext/*.rb"].each { |file| require(file) }

data/lib/trriad/core_ext/string/chord.rb

@@ -1,10 +1,16 @@
 module Trriad
   module CoreExtensions
     module String
+      #String extension module for chords
       module Chord
+        #is this a valid note?
         def is_valid_note()
           Trriad::Chord::valid_note(self)
         end
+        #get the of a root note
+        def scale()
+          Trriad::Chord::get_scale(self)
+        end
       end
     end
   end

data/lib/trriad/version.rb

@@ -2,7 +2,7 @@ module Trriad #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/trriad_spec.rb

@@ -29,3 +29,16 @@ describe "Invalid Note" do
     !"Ebb".is_valid_note() 
   end
 end
+
+describe "Scale" do
+  it "C should be C,D,E,F,G,A,B" do
+    "C".scale == "C,D,E,F,G,A,B"
+  end
+  it "F# should be F#,G#,A#,B,C#,D#,E#" do
+    "F#".scale == "F#,G#,A#,B,C#,D#,E#"
+  end
+  it "Bb should be Bb,C,D,E,F,G,A" do
+    "Bb".scale == "Bb,C,D,E,F,G,A"
+  end
+
+end

data/website/index.txt

@@ -22,10 +22,21 @@ h2. Demonstration of usage
 
 For now, trriad isn't able to much things... just the following:
 
-"C".is_valid_note() -> true
+h3. getting scales
 
-"W".is_valid_note() -> false
+"C".scale  => ["C", "D", "E", "F", "G", "A", "B"]
 
+"Bb".scale => ["Bb", "C", "D", "Eb", "F", "G", "A"]
+
+h3. checking for valid notes
+
+"C".is_valid_note -> true
+
+"W".is_valid_note -> false
+
+
+h2. Todo
+"Todo":todo.html
 
 h2. Forum
 

data/website/template.rhtml

@@ -42,7 +42,12 @@
     </p>
 </div>
 
-<!-- insert site tracking codes here, like Google Urchin -->
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-68330-5";
+urchinTracker();
+</script>
 
 </body>
 </html>

data/website/todo.txt

@@ -0,0 +1,7 @@
+h1. Todo list for ttriad
+
+ * "C".to_chord -> "C,E,G"
+ * "C,Eb,G".to_notation -> "Cm"
+ * different chords (m,m7,dim,maj,etc)
+ * scales (diatonic, chromatic, etc)
+ 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: trriad
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-05-30 00:00:00 +02:00
+  version: 0.0.2.19
+date: 2007-05-31 00:00:00 +02:00
 summary: Ruby gem for dealing with several musical items like describing notes, transposing notes, build chords, etc
 require_paths: 
 - lib
@@ -36,6 +36,7 @@ files:
 - Rakefile
 - lib/trriad.rb
 - lib/trriad/chord.rb
+- lib/trriad/chord_data.rb
 - lib/trriad/core_ext.rb
 - lib/trriad/core_ext/string.rb
 - lib/trriad/core_ext/string/chord.rb
@@ -49,6 +50,7 @@ files:
 - website/javascripts/rounded_corners_lite.inc.js
 - website/stylesheets/screen.css
 - website/template.rhtml
+- website/todo.txt
 test_files: []
 
 rdoc_options: 
@@ -60,6 +62,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 - website/index.txt
+- website/todo.txt
 executables: []
 
 extensions: []