jazz_model 0.1.0 → 0.2.0

data/lib/jazz_model/scale.rb

@@ -1,136 +1,114 @@
 module JazzModel
   # A scale is an ordered collection of tones.
-  # 
+  #
   # == Creating a Scale
-  # 
+  #
   # Scale objects should be created by indexing the +Scale+ class directly:
-  # 
+  #
   #   Scale['Major']
-  # 
-  # An alternative method of resolving a chord is to use the +resolve+ method, 
+  #
+  # An alternative method of resolving a chord is to use the +resolve+ method,
   # though this is likely to become deprecated in the future when chord progression
   # support/representation is added:
   #
   #   Scale.resolve(name)
   #
   # == Associations
-  # 
+  #
   # * +modes+ - Associated modes.
-  # * +main_mode+ - Associated mode with a mode index of 1 (first mode).  This sometimes 
+  # * +main_mode+ - Associated mode with a mode index of 1 (first mode).  This sometimes
   #     the only defined mode such as for the whole tone scale.
   # * +tones+ - A collection of +ScaleTone+s.
   # * +notes+ - An array of notes (delegated through +tones+)
   # * +chords+ - A collection of associated chords with the first mode of this scale.
-  # 
+  #
   # == Modes
-  # 
-  # Each scale can have one or many modes, which really define the relationship to chords. 
+  #
+  # Each scale can have one or many modes, which really define the relationship to chords.
   # Modes are accessible like so (all methods are equal):
-  # 
+  #
   #   Scale['Major']['Dorian']
   #   Scale['Major'][2]
   #   Scale['Major'].modes['Dorian']
   #   Scale['Major'].modes[2]
-  # 
+  #
   # == Examples
-  # 
+  #
   # === Listing Tones in Scales
-  # 
+  #
   #   Scale['Major'].notes
   #   # => ["C", "D", "E", "F", "G", "A", "B"]
-  #  
+  #
   #   Scale['Major'].in_key_of('Eb').notes
   #   Scale['Eb Major'].notes  # Same as above
   #   # => ["Eb", "F", "G", "Ab", "Bb", "C", "D"]
-  # 
+  #
   # === Correctly Interpets Theoretical Keys (not just pitches)
-  # 
+  #
   #   Scale['Gb Major'].notes
   #   # => ["Gb", "Ab", "Bb", "Cb", "Db", "Eb", "F"]
   #   # Note the use of Cb which is theoretically correct over enharmonic B.
-  # 
+  #
   # Also correctly interpet tones off of enharmonic base keys:
-  # 
+  #
   #   Scale['Gb Major'].notes
   #   # => ["Gb", "Ab", "Bb", "Cb", "Db", "Eb", "F"]
   #   Scale['F# Major'].notes
   #   # => ["F#", "G#", "A#", "B", "C#", "D#", "E#"]
-  # 
+  #
   # === Listing Tones within the context of a mode
-  # 
+  #
   #   Scale['Major'].modes['Dorian']
   #   Scale['Major']['Dorian']  # Same as above
   #   # => ["D", "E", "F", "G", "A", "B", "C"]
-  #  
+  #
   #   Scale['Melodic Minor'].modes['Super Locrian'].notes
   #   # => ["B", "C", "D", "Eb", "F", "G", "A"]  # aka. Altered Scale or Dim. Whole Tone
-  # 
+  #
   # == Listing Related Chords
-  # 
+  #
   #   Scale['Major'].chords.symbols
   #   # => ['maj7', 'maj6', '6/9']
   #   Scale['Major']['Dorian'].chords.symbols
   #   # => ['min7', 'min6']
-  #  
+  #
   class Scale < JazzModel::Base
-  	include KeyContext
-  	include ModeContext
-	  
-		has_many :modes, :extend => ModeSequence, :dependent => :destroy
-		has_many :tones, :class_name => 'ScaleTone', :extend => ToneSequence, :dependent => :destroy
-	
-  	delegate :notes, :to => :tones
-  	delegate :chords, :to => :main_mode
-	
-  	class << self
-  		def resolve(symbol)
-  			in_key = nil
-			
-  			return nil if symbol.nil?
-  			symbol = symbol.dup
-			
-  			Key.all.each do |k|
-  				if symbol.starts_with?(k.name)
-  					in_key = k
-  					symbol.gsub!(/^#{k.name}/, '').strip!
-  					break
-  				end
-  			end
-			
-  			scale = Scale.find_by_name(symbol)
-			
-  			# Perhaps the matched key was really part of the name of the chord, try that:
-  			if scale.nil? && !in_key.nil?
-  				symbol = in_key.name + symbol
-  				scale = Scale.all.detect {|s| s.name == symbol}
-  			end
-			
-  			# If still not found, must be invalid:
-  			return nil if scale.nil?
-			
-  			scale.key = in_key
-  			scale
-  		end
-  		alias_method :[], :resolve
-  	end
-	
-  	def [](name)
-  		name.is_a?(String) ? self.modes.find_by_name(name) : self.modes.find_by_mode(name)
-  	end
-	
-  	def main_mode
-  		self[1]
-  	end
-	
-  	def symmetric?
-  		!self.symmetry_index.nil?
-  	end
-	
-	
-  	def to_xml(options = {})
-  		super(options.merge(:skip_types => true))
-  	end
-	
-  end
+    include KeyContext
+    include ModeContext
 
-end
+    has_many :modes, extend: ModeSequence, dependent: :destroy
+    has_many :tones, class_name: "ScaleTone", extend: ToneSequence, dependent: :destroy
+
+    delegate :notes, to: :tones
+    delegate :chords, to: :main_mode
+
+    class << self
+      # Resolves a scale name, optionally prefixed with a key (such as
+      # "Eb Major"), into a scale.
+      def resolve(symbol)
+        return nil if symbol.nil?
+
+        KeyContext.each_split(symbol) do |in_key, rest|
+          scale = find_by_name(rest) or next
+          scale.key = in_key
+          return scale
+        end
+        nil
+      end
+      alias_method :[], :resolve
+    end
+
+    # Finds a mode of this scale by name or number, passing along key context.
+    def [](name)
+      modes[name]
+    end
+
+    def main_mode
+      self[1]
+    end
+
+    def symmetric?
+      !symmetry_index.nil?
+    end
+  end
+end

data/lib/jazz_model/scale_tone.rb

@@ -1,24 +1,23 @@
 module JazzModel
-  # Represents one tone in a scale.  
-  # 
+  # Represents one tone in a scale.
+  #
   # == Attributes
-  # 
-  # * +tone+ - A tone index from 0-11 representing the relative position of the 
+  #
+  # * +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 
+  #
+  # * +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
-	
+    belongs_to :scale
+
+    acts_as_list scope: :scale
+
+    delegate :key, to: :scale
   end
-end
+end

data/lib/jazz_model/tone.rb

@@ -1,51 +1,50 @@
 module JazzModel
-  # Abstract base class for the concept of a tone. 
-  # Eventually will be expanded with common functionality for 
-  # all tone objects.  
-  # 
+  # 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
-	
+    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
+end

data/lib/jazz_model/tone_sequence.rb

@@ -1,62 +1,60 @@
 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 
+  # 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
-	
+    # Takes manually specified key context for this collection or
+    # delegates to the association owner.
+    def key
+      @key || (owner.key if 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.is_a?(String) ? Key[in_key] : in_key
+      self
+    end
+
+    # Takes manually specified mode context for this collection or
+    # delegates to the association owner.
+    def mode
+      @mode || (owner.mode if owner.respond_to?(:mode))
+    end
+
+    # Manually specifies the mode context for this tone sequence only.
+    def in_mode(mode)
+      @mode = mode
+      self
+    end
+
+    # Returns the tones ordered by position with key and mode context applied.
+    # Each tone is a copy, so the underlying records are never modified.
+    def in_context
+      tones = to_a
+      tones.map do |tone|
+        tone.dup.tap do |t|
+          if key
+            t.tone = (tone.tone + key.index) % 12
+            t.letter_index = (tone.letter_index + key.letter_index) % 7
+          end
+          t.position = (tone.position - mode) % tones.size + 1 if mode
+        end
+      end.sort_by(&:position)
+    end
+
+    # Does the magic in determining the actual note from the tones
+    # with tone and letter indexes.
+    def notes
+      in_context.map do |tone|
+        Key.from_index(tone.tone, tone.letter_index).name
+      end
+    end
+
+    private
+
+    def owner
+      proxy_association.owner if respond_to?(:proxy_association)
+    end
   end
-end
+end

data/lib/jazz_model/version.rb

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

data/lib/jazz_model/voicing.rb

@@ -1,12 +1,11 @@
 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
-	
+    belongs_to :chord
+    has_many :voicing_tones
+
+    delegate :key, to: :chord
   end
-end
+end

data/lib/jazz_model/voicing_tone.rb

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

data/lib/jazz_model.rb

@@ -1,12 +1,11 @@
+require "active_support"
+require "active_record"
+require "acts_as_tree"
+require "acts_as_list"
+
 module JazzModel
-  require "rubygems"
-  require "active_support"
-  require "active_record"
-  require "acts_as_tree"
-  require "acts_as_list"
-  
   extend ActiveSupport::Autoload
-  
+
   autoload :Base
   autoload :Chord
   autoload :ChordCollection
@@ -20,7 +19,6 @@ module JazzModel
   autoload :Mode
   autoload :ModeContext
   autoload :ModeSequence
-  autoload :NoteSequence
   autoload :NotesCollection
   autoload :Scale
   autoload :ScaleTone
@@ -28,7 +26,6 @@ module JazzModel
   autoload :ToneSequence
   autoload :Voicing
   autoload :VoicingTone
-  
+
   autoload :Definition
-  
 end