jazz_model 0.1.0

data/lib/jazz_model/scale_tone.rb

@@ -0,0 +1,24 @@
+module JazzModel
+  # Represents one tone in a scale.  
+  # 
+  # == Attributes
+  # 
+  # * +tone+ - A tone index from 0-11 representing the relative position of the 
+  #    tone within the chromatic scale.
+  # 
+  # * +letter_index+ - A 0-6 value representing the relative letter position, which 
+  #    helps to disambiguate theoretic values such as Eb and D#.  See +Key+.
+  # 
+  # == Key Context
+  # 
+  # +key+ is delgated to chord to access the scale's key context.
+  #
+  class ScaleTone < Tone
+  	belongs_to :scale
+	
+  	acts_as_list :scope => :scale
+	
+  	delegate :key, :to => :scale
+	
+  end
+end

data/lib/jazz_model/tone.rb

@@ -0,0 +1,51 @@
+module JazzModel
+  # Abstract base class for the concept of a tone. 
+  # Eventually will be expanded with common functionality for 
+  # all tone objects.  
+  # 
+  class Tone < JazzModel::Base
+  	self.abstract_class = true
+	
+  	# Defines constants representing intervals
+  	module Interval
+  		ROOT = 0
+  		MINOR_2ND = 1
+  		MAJOR_2ND = 2
+  		AUGMENTED_2ND = 3
+  		MINOR_3RD = 3
+  		MAJOR_3RD = 4
+  		PERFECT_4TH = 5
+  		AUGMENTED_4TH = 6
+  		DIMINISHED_5TH = 6
+  		TRITONE = 6
+  		PERFECT_5TH = 7
+  		AUGMENTED_5TH = 8
+  		MINOR_6TH = 8
+  		MAJOR_6TH = 9
+  		DIMINISHED_7TH = 9
+  		MINOR_7TH = 10
+  		DOMINANT_7TH = 10
+  		MAJOR_7TH = 11
+  		OCTAVE = 12
+  	end
+	
+  	# Defines constants representing letter intervals
+  	module LetterInterval
+  		FIRST = 0
+  		SECOND = 1
+  		THIRD = 2
+  		FOURTH = 3
+  		FIFTH = 4
+  		SIXTH = 5
+  		SEVENTH = 6
+  	end
+	
+  	module Offsets
+  		LOWERED = -1
+  		RAISED = 1
+  		DOUBLE_LOWERED = -2
+  		DOUBLE_RAISED = 2
+  	end
+	
+  end
+end

data/lib/jazz_model/tone_sequence.rb

@@ -0,0 +1,62 @@
+module JazzModel
+  # This module is mixed in wherever a collection of tones is being returned 
+  # and handles some of the fundamental logic involved in key and mode calculations 
+  # and note values.
+  # 
+  module ToneSequence
+  	# Takes manually specified key context for this collection or 
+  	# delegates to th association owner.
+  	def key
+  		@key || (proxy_owner.key if proxy_owner.respond_to?(:key))
+  	end
+	
+  	# Manually specifies the key context for this tone sequence only.
+  	def in_key_of(in_key = nil)
+  		@key = in_key.instance_of?(String) ? Key[in_key] : in_key
+  		self
+  	end
+	
+  	# Shifts indexes to simulate a key change
+  	def in_key_context!
+  		self.each do |tone| 
+  			tone.tone = (tone.tone + key.index) % 12
+  			tone.letter_index = (tone.letter_index + key.letter_index) % 7
+  		end
+  		true
+  	end
+	
+  	# Takes manually specified mode context for this collection or 
+  	# delegates to the association owner.
+  	def mode
+  		@mode || (proxy_owner.mode if proxy_owner.respond_to?(:mode))
+  	end
+	
+  	# Manually specifies the mode context for this tone sequence only.
+  	def in_mode(mode)
+  		@mode = mode
+  		self
+  	end
+	
+  	# Shifts mode positions to place tone sequence in mode context
+  	def in_mode_context!
+  		self.each {|tone| tone.position = (tone.position - mode) % self.count + 1}
+  		true
+  	end
+	
+  	# TODO: Have to use this until we figure out how to override find/default collection result
+  	def all
+  		in_key_context! if key
+  		in_mode_context! if mode
+  		self.sort_by(&:position)
+  	end
+	
+  	# Does the magic in determining the actual note from the tones 
+  	# with tone and letter indexes. 
+  	def notes
+  		all.map do |tone|
+  			Key.from_index(tone.tone, tone.letter_index).name
+  		end.extend(NoteSequence)
+  	end
+	
+  end
+end

data/lib/jazz_model/version.rb

@@ -0,0 +1,3 @@
+module JazzModel
+  VERSION = "0.1.0"
+end

data/lib/jazz_model/voicing.rb

@@ -0,0 +1,12 @@
+module JazzModel
+  # Represents a specific piano voicing.
+  # Work in progress!
+  # 
+  class Voicing < JazzModel::Base
+  	belongs_to :chord
+  	has_many :voicing_tones
+	
+  	delegate :key, :to => :chord
+	
+  end
+end

data/lib/jazz_model/voicing_tone.rb

@@ -0,0 +1,11 @@
+module JazzModel
+  # Represents a tone in a piano voicing.
+  # Work in progress!
+  # 
+  class VoicingTone < Tone
+  	belongs_to :voicing
+	
+  	acts_as_list :scope => :voicing
+	
+  end
+end

data/spec/chord_collection_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe JazzModel::ChordCollection do
+  subject { JazzModel::Scale['Major'].modes[1].chords }
+  
+  it "should emit symbols list" do
+    subject.to_s(:symbols).should be_starts_with('maj')
+  end
+  
+  it "should emit names list" do
+    subject.to_s(:names).should be_starts_with('Major')
+  end
+  
+  it "should resolve chord within" do
+    subject['maj'].should_not be_nil
+  end
+  
+  it "should resolve chord within with key context" do
+    subject['Cmaj'].should_not be_nil
+  end
+end

data/spec/chord_quality_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe JazzModel::ChordQuality do
+  subject { JazzModel::ChordQuality.new }
+  
+  it { should be_valid }
+  
+  context "of Major" do
+    subject { JazzModel::ChordQuality.find_by_name('Major') }
+    it { should be_valid }
+  end
+  
+  context "of Minor" do
+    subject { JazzModel::ChordQuality.find_by_name('Minor') }
+    it { should be_valid }
+  end
+  
+  context "of Dominant" do
+    subject { JazzModel::ChordQuality.find_by_name('Dominant') }
+    it { should be_valid }
+  end
+  
+  context "of Diminished" do
+    subject { JazzModel::ChordQuality.find_by_name('Diminished') }
+    it { should be_valid }
+  end
+end

data/spec/chord_scale_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe JazzModel::ChordScale do
+  subject { JazzModel::ChordScale.new }
+  
+  it { should be_valid }
+end

data/spec/chord_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe JazzModel::Chord do
+  subject { JazzModel::Chord.new }
+  
+  it { should be_valid }
+  
+  pairings = {
+    'Cmaj' => %w[C E G],
+    'Cmin' => %w[C Eb G],
+    'Cmaj7' => %w[C E G B],
+    'Cmin7' => %w[C Eb G Bb],
+    'C7' => %w[C E G Bb],
+    'Cfulldim' => %w[C Eb Gb Bbb]
+  }
+  
+  pairings.each do |chord_symbol, notes|
+    context "as #{chord_symbol}" do
+      it "should give valid notes" do
+        chord = JazzModel::Chord[chord_symbol]
+        chord.should_not be_nil
+        chord.notes.should == notes
+      end
+    end
+  end
+end
+
+
+

data/spec/chord_symbol_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe JazzModel::ChordSymbol do
+  subject { JazzModel::ChordSymbol.new }
+  it { should be_valid }
+end

data/spec/chord_tone_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+describe JazzModel::ChordTone do
+  subject { JazzModel::ChordTone.new }
+  it { should be_valid }
+end

data/spec/definition_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe JazzModel::Definition do
+  context "after creating a definition" do
+    before(:all) do
+      JazzModel::Definition.define :my_definition => [:keys] do
+        JazzModel::Scale.create!(:name => "Sample")
+      end
+    end
+    
+    it "should have registered my_definition" do
+      JazzModel::Definition[:my_definition].should_not be_nil
+    end
+    
+    describe "the definition" do
+      before { @definition = JazzModel::Definition[:my_definition] }
+      
+      it "should list keys as an included_definition" do
+        @definition.included_definitions.should include(:keys)
+      end
+      
+      context "when loaded" do
+        before { @definition.load }
+        
+        it "should create keys" do
+          JazzModel::Key.find_by_name("C").should_not be_nil
+        end
+        
+        it "should create sample scale" do
+          JazzModel::Scale.find_by_name("Sample").should_not be_nil
+        end
+      end
+    end
+  end
+end

data/spec/key_context_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe JazzModel::KeyContext do
+  describe "chord without context" do
+    subject { JazzModel::Chord['maj7'] } 
+    
+    it "should accept key context" do
+      subject.in_key_of('G').key.name.should == 'G'
+    end
+    
+    it "should should accept then remove key context" do
+      subject.in_key_of('G').without_key.key.should be_nil
+    end
+  end
+  
+  describe "chord with context" do
+    subject { JazzModel::Chord['Fmaj7'] }
+    
+    it "should have correct context" do
+      subject.key.name.should == 'F'
+    end
+    
+    it "should be put out of context" do
+      subject.without_key.key.should be_nil
+    end
+  end
+end

data/spec/key_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe JazzModel::Key do
+  it "should default to C" do
+    JazzModel::Key.default.name.should == "C"
+  end
+  
+  it "should expose 12 primary keys" do
+    JazzModel::Key.should have(12).primaries
+  end
+  
+  it "should treat Eb and D# as enharmonic" do
+    JazzModel::Key['Eb'].should be_enharmonic_with(JazzModel::Key['D#'])
+  end
+end

data/spec/mode_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe JazzModel::Mode do
+  subject { JazzModel::Scale['CMajor'].modes['Dorian'] }
+  
+  it "should yield correct notes" do
+    subject.notes.should == ['D', 'E', 'F', 'G', 'A', 'B', 'C']
+  end
+end

data/spec/notes_collection_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe JazzModel::NotesCollection do
+  it "should recognize invalid keys" do
+    JazzModel::NotesCollection['C,E,G,H'].should have(3).keys
+  end
+  
+  it "should accept key context" do
+    JazzModel::NotesCollection['C,E,G,A'].in_key_of('A').should have(1).chords
+  end
+  
+  pairings = {
+    'A C E G' => %w[Amin7 C6]
+  }
+  
+  pairings.each do |notes, chords|
+    context "as #{notes}" do
+      it "should give correct chords" do
+        notes_collection = JazzModel::NotesCollection[notes]
+        notes_collection.should_not be_nil
+        notes_collection.chords.symbols.to_set.should == chords.to_set
+      end
+    end
+  end
+end

data/spec/scale_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe JazzModel::Scale do
+  subject { JazzModel::Scale['Major'] }
+  
+  it { should be_valid }
+  
+  it "should recognize symmetric scale" do
+    JazzModel::Scale['Diminished'].should be_symmetric
+  end
+  
+  it "should recognize asymmetric scale" do
+    JazzModel::Scale['Major'].should_not be_symmetric
+  end
+  
+  it "should accept numeric mode context" do
+    subject.in_mode(2).notes.first.should == 'D'
+  end
+  
+  it "should accept named mode context" do
+    subject.in_mode('Dorian').notes.first.should == 'D'
+  end
+  
+  it "should remove mode context" do
+    subject.in_mode('Dorian').without_mode.notes.first.should == 'C'
+  end
+  
+  pairings = {
+    'C Major' => %w[C D E F G A B],
+    'C Harmonic Minor' => %w[C D Eb F G Ab B]
+  }
+  
+  pairings.each do |scale, notes|
+    context "as #{scale}" do
+      it "should give correct notes" do
+        scale = JazzModel::Scale[scale]
+        scale.should_not be_nil
+        scale.notes.should == notes
+      end
+    end
+  end
+end