head_music 0.11.9 → 0.13.2

data/lib/head_music/spelling.rb

@@ -1,5 +1,5 @@
 class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])([b#]*)(\-?\d+)?\s*$/
+  MATCHER = /^\s*([A-G])([b#]*)(\-?\d+)?\s*$/i
 
   attr_reader :pitch_class
   attr_reader :letter_name

data/lib/head_music/style/analysis.rb

@@ -8,12 +8,23 @@ module HeadMusic
         @subject = subject
       end
 
+      def messages
+        annotations.reject(&:perfect?).map(&:message)
+      end
+
       def annotations
         @annotations ||= @ruleset.analyze(subject)
       end
 
       def fitness
-        annotations.map(&:fitness).reduce(1, :*)
+        return 1.0 if annotations.length == 0
+        fitness_scores.inject(:+).to_f / fitness_scores.length
+      end
+
+      private
+
+      def fitness_scores
+        annotations.map(&:fitness)
       end
     end
   end

data/lib/head_music/style/annotation.rb

@@ -1,8 +1,12 @@
 class HeadMusic::Style::Annotation
+  MESSAGE = 'Write music.'
+
   attr_reader :voice
 
   delegate(
     :composition,
+    :highest_pitch,
+    :lowest_pitch,
     :highest_notes,
     :lowest_notes,
     :melodic_intervals,
@@ -14,6 +18,9 @@ class HeadMusic::Style::Annotation
     to: :voice
   )
 
+  delegate :key_signature, to: :composition
+  delegate :tonic_spelling, to: :key_signature
+
   def initialize(voice)
     @voice = voice
   end
@@ -39,6 +46,70 @@ class HeadMusic::Style::Annotation
   end
 
   def message
-    raise NotImplementedError
+    self.class::MESSAGE
+  end
+
+  def first_note
+    notes && notes.first
+  end
+
+  def last_note
+    notes && notes.last
+  end
+
+  def voices
+    @voices ||= voice.composition.voices
+  end
+
+  def other_voices
+    @other_voices ||= voices.select { |part| part != voice }
+  end
+
+  def cantus_firmus
+    @cantus_firmus ||= other_voices.detect(&:cantus_firmus?) || other_voices.first
+  end
+
+  def higher_voices
+    @higher_voices ||= unsorted_higher_voices.sort_by(&:highest_pitch).reverse
+  end
+
+  def lower_voices
+    @lower_voices ||= unsorted_lower_voices.sort_by(&:lowest_pitch).reverse
+  end
+
+  def functional_interval_from_tonic(note)
+    HeadMusic::FunctionalInterval.new(tonic_spelling, note.spelling)
+  end
+
+  def bass_voice?
+    lower_voices.empty?
+  end
+
+  def starts_on_tonic?
+    tonic_spelling == first_note.spelling
+  end
+
+  def motions
+    downbeat_harmonic_intervals.map.with_index do |harmonic_interval, i|
+      next_harmonic_interval = downbeat_harmonic_intervals[i+1]
+      HeadMusic::Motion.new(harmonic_interval, next_harmonic_interval) if next_harmonic_interval
+    end.reject(&:nil?)
+  end
+
+  def downbeat_harmonic_intervals
+    @downbeat_harmonic_intervals ||= cantus_firmus.notes.map do |cantus_firmus_note|
+      interval = HeadMusic::HarmonicInterval.new(cantus_firmus_note.voice, voice, cantus_firmus_note.position)
+      interval.notes.length == 2 ? interval : nil
+    end.reject(&:nil?)
+  end
+
+  private
+
+  def unsorted_higher_voices
+    other_voices.select { |part| part.highest_pitch > highest_pitch }
+  end
+
+  def unsorted_lower_voices
+    other_voices.select { |part| part.lowest_pitch < lowest_pitch }
   end
 end

data/lib/head_music/style/annotations/always_move.rb

@@ -2,9 +2,7 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::AlwaysMove < HeadMusic::Style::Annotation
-  def message
-    "Always move to a different note."
-  end
+  MESSAGE = "Always move to a different note."
 
   def marks
     melodic_intervals.map.with_index do |interval, i|

data/lib/head_music/style/annotations/approach_perfection_contrarily.rb

@@ -0,0 +1,24 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::ApproachPerfectionContrarily < HeadMusic::Style::Annotation
+  MESSAGE = 'Step down to final note.'
+
+  def marks
+    motions_to_perfect_consonance_approached_directly.map do |bad_motion|
+      HeadMusic::Style::Mark.for_all(bad_motion.notes)
+    end
+  end
+
+  private
+
+  def motions_to_perfect_consonance_approached_directly
+    motions_to_perfect_consonance.select(&:direct?)
+  end
+
+  def motions_to_perfect_consonance
+    motions.select do |motion|
+      motion.second_harmonic_interval.perfect_consonance?
+    end
+  end
+end

data/lib/head_music/style/annotations/at_least_eight_notes.rb

@@ -4,9 +4,7 @@ end
 class HeadMusic::Style::Annotations::AtLeastEightNotes < HeadMusic::Style::Annotation
   MINIMUM_NOTES = 8
 
-  def message
-    "Write at least eight notes."
-  end
+  MESSAGE = "Write at least eight notes."
 
   def marks
     placements.empty? ? no_placements_mark : deficiency_mark
@@ -15,17 +13,16 @@ class HeadMusic::Style::Annotations::AtLeastEightNotes < HeadMusic::Style::Annot
   private
 
   def no_placements_mark
-    return HeadMusic::Style::Mark.new(
+    HeadMusic::Style::Mark.new(
       HeadMusic::Position.new(composition, "1:1"),
       HeadMusic::Position.new(composition, "2:1"),
-      fitness: HeadMusic::PENALTY_FACTOR**MINIMUM_NOTES
+      fitness: 0
     )
   end
 
   def deficiency_mark
-    deficiency = [MINIMUM_NOTES - notes.length, 0].max
-    if deficiency > 0
-      HeadMusic::Style::Mark.for_all(placements, fitness: HeadMusic::PENALTY_FACTOR**deficiency)
+    if notes.length < MINIMUM_NOTES
+      HeadMusic::Style::Mark.for_all(placements, fitness: notes.length.to_f / MINIMUM_NOTES)
     end
   end
 end

data/lib/head_music/style/annotations/avoid_crossing_voices.rb

@@ -0,0 +1,40 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::AvoidCrossingVoices < HeadMusic::Style::Annotation
+  MESSAGE = "Avoid crossing voices."
+
+  def marks
+    crossings
+  end
+
+  private
+
+  def crossings
+    crossings_of_lower_voices + crossings_of_higher_voices
+  end
+
+  def crossings_of_lower_voices
+    [].tap do |marks|
+      lower_voices.each do |lower_voice|
+        lower_voice.notes.each do |lower_voice_note|
+          notes_during = voice.notes_during(lower_voice_note)
+          crossed_notes = notes_during.select { |note| note.pitch < lower_voice_note.pitch }
+          marks << HeadMusic::Style::Mark.for_all(crossed_notes)
+        end
+      end
+    end
+  end
+
+  def crossings_of_higher_voices
+    [].tap do |marks|
+      higher_voices.each do |higher_voice|
+        higher_voice.notes.each do |higher_voice_note|
+          notes_during = voice.notes_during(higher_voice_note)
+          crossed_notes = notes_during.select { |note| note.pitch > lower_voice_note.pitch }
+          marks << HeadMusic::Style::Mark.for_all(crossed_notes)
+        end
+      end
+    end
+  end
+end

data/lib/head_music/style/annotations/avoid_overlapping_voices.rb

@@ -0,0 +1,42 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::AvoidOverlappingVoices < HeadMusic::Style::Annotation
+  MESSAGE = "Avoid overlapping voices."
+
+  def marks
+    overlappings
+  end
+
+  private
+
+  def overlappings
+    overlappings_of_lower_voices + overlappings_of_higher_voices
+  end
+
+  def overlappings_of_lower_voices
+    [].tap do |marks|
+      lower_voices.each do |lower_voice|
+        overlapped_notes = voice.notes.select do |note|
+          preceding_note = lower_voice.note_preceding(note.position)
+          following_note = lower_voice.note_following(note.position)
+          (preceding_note && preceding_note.pitch > note.pitch) || (following_note && following_note.pitch > note.pitch)
+        end
+        marks << HeadMusic::Style::Mark.for_each(overlapped_notes)
+      end
+    end
+  end
+
+  def overlappings_of_higher_voices
+    [].tap do |marks|
+      higher_voices.each do |higher_voice|
+        overlapped_notes = voice.notes.select do |note|
+          preceding_note = higher_voice.note_preceding(note.position)
+          following_note = lower_voice.note_following(note.position)
+          (preceding_note && preceding_note.pitch < note.pitch) || (following_note && following_note.pitch < note.pitch)
+        end
+        marks << HeadMusic::Style::Mark.for_each(overlapped_notes)
+      end
+    end
+  end
+end

data/lib/head_music/style/annotations/consonant_climax.rb

@@ -2,16 +2,14 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotation
-  def message
-    "Peak on a consonant high note one time."
-  end
+  MESSAGE = "Peak on a consonant high note one time."
 
   def marks
     if notes
       improper_climaxes = highest_notes.select.with_index do |note, i|
-        tonic_pitch = HeadMusic::Pitch.get(composition.key_signature.tonic_spelling)
+        tonic_pitch = HeadMusic::Pitch.get(tonic_spelling)
         interval = HeadMusic::FunctionalInterval.new(tonic_pitch, note.pitch)
-        interval.consonance.dissonant? || i > 0
+        interval.consonance(:melodic).dissonant? || i > 0
       end
       HeadMusic::Style::Mark.for_each(improper_climaxes)
     end

data/lib/head_music/style/annotations/consonant_downbeats.rb

@@ -0,0 +1,22 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::ConsonantDownbeats < HeadMusic::Style::Annotation
+  MESSAGE = "Use consonant harmonic intervals."
+
+  def marks
+    dissonant_pairs.map do |dissonant_pair|
+      HeadMusic::Style::Mark.for_all(dissonant_pair)
+    end.flatten
+  end
+
+  private
+
+  def dissonant_pairs
+    dissonant_intervals.map(&:notes).reject(&:nil?)
+  end
+
+  def dissonant_intervals
+    downbeat_harmonic_intervals.select { |interval| interval.dissonance?(:two_part_harmony) }
+  end
+end

data/lib/head_music/style/annotations/diatonic.rb

@@ -2,9 +2,7 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::Diatonic < HeadMusic::Style::Annotation
-  def message
-    "Use only notes in the key signature."
-  end
+  MESSAGE = "Use only notes in the key signature."
 
   def marks
     HeadMusic::Style::Mark.for_each(notes_not_in_key)

data/lib/head_music/style/annotations/direction_changes.rb

@@ -4,9 +4,7 @@ end
 class HeadMusic::Style::Annotations::DirectionChanges < HeadMusic::Style::Annotation
   MAXIMUM_NOTES_PER_DIRECTION = 3
 
-  def message
-    "Balance ascending and descending motion."
-  end
+  MESSAGE = "Balance ascending and descending motion."
 
   def marks
     if overage > 0

data/lib/head_music/style/annotations/end_on_perfect_consonance.rb

@@ -3,9 +3,7 @@ end
 
 # marks the voice if the first note is not the first or fifth scale degree of the key.
 class HeadMusic::Style::Annotations::EndOnPerfectConsonance < HeadMusic::Style::Annotation
-  def message
-    'End on the tonic or a perfect consonance above the tonic.'
-  end
+  MESSAGE = 'End on the tonic or the fifth scale degree.'
 
   def marks
     if last_note && !ends_on_perfect_consonance?
@@ -16,14 +14,6 @@ class HeadMusic::Style::Annotations::EndOnPerfectConsonance < HeadMusic::Style::
   private
 
   def ends_on_perfect_consonance?
-    functional_interval.perfect_consonance?(:two_part_harmony)
-  end
-
-  def functional_interval
-    HeadMusic::FunctionalInterval.new(composition.key_signature.tonic_spelling, last_note.spelling)
-  end
-
-  def last_note
-    notes.last
+    functional_interval_from_tonic(last_note).perfect_consonance?(:two_part_harmony)
   end
 end

data/lib/head_music/style/annotations/end_on_tonic.rb

@@ -2,9 +2,7 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::EndOnTonic < HeadMusic::Style::Annotation
-  def message
-    'End on the tonic.'
-  end
+  MESSAGE = 'End on the tonic.'
 
   def marks
     if !notes.empty? && !ends_on_tonic?
@@ -15,10 +13,10 @@ class HeadMusic::Style::Annotations::EndOnTonic < HeadMusic::Style::Annotation
   private
 
   def ends_on_tonic?
-    notes &&
-    notes.last &&
-    composition &&
-    composition.key_signature &&
-    composition.key_signature.tonic_spelling == notes.last.spelling
+    tonic_spelling == last_note_spelling
+  end
+
+  def last_note_spelling
+    last_note && last_note.spelling
   end
 end

data/lib/head_music/style/annotations/limit_octave_leaps.rb

@@ -0,0 +1,20 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::LimitOctaveLeaps < HeadMusic::Style::Annotation
+  MESSAGE = "Use a maximum of one octave skip."
+
+  def marks
+    if octave_leaps.length > 1
+      octave_leaps.map do |leap|
+        HeadMusic::Style::Mark.for_all(leap.notes)
+      end
+    end
+  end
+
+  private
+
+  def octave_leaps
+    melodic_intervals.select(&:octave?)
+  end
+end

data/lib/head_music/style/annotations/mostly_conjunct.rb

@@ -2,9 +2,7 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::MostlyConjunct < HeadMusic::Style::Annotation
-  def message
-    "Use mostly conjunct motion."
-  end
+  MESSAGE = "Use mostly conjunct motion."
 
   def marks
     marks_for_skips_and_leaps if conjunct_ratio <= 0.5

data/lib/head_music/style/annotations/no_rests.rb

@@ -2,11 +2,9 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::NoRests < HeadMusic::Style::Annotation
-  def message
-    "Use only notes."
-  end
+  MESSAGE = "Use only notes."
 
   def marks
-    rests.map { |rest| HeadMusic::Style::Mark.for(rest) }
+    HeadMusic::Style::Mark.for_each(rests)
   end
 end

data/lib/head_music/style/annotations/no_unisons_in_middle.rb

@@ -0,0 +1,39 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::NoUnisonsInMiddle < HeadMusic::Style::Annotation
+  MESSAGE = "Unisons may only be used in the first and last note."
+
+  def marks
+    unison_pairs.map do |notes|
+      HeadMusic::Style::Mark.for_all(notes)
+    end.flatten
+  end
+
+  private
+
+  def unison_pairs
+    middle_unisons.map(&:notes).reject(&:nil?)
+  end
+
+  def middle_unisons
+    middle_intervals.select { |interval| interval.perfect_consonance? && interval.unison? }
+  end
+
+  def middle_intervals
+    [harmonic_intervals[1..-2]].flatten.reject(&:nil?)
+  end
+
+  def harmonic_intervals
+    cantus_firmus.notes.map do |cantus_firmus_note|
+      counterpoint_notes = voice.notes_during(cantus_firmus_note)
+      counterpoint_notes.map { |note|
+        HarmonicInterval.new(cantus_firmus_note.voice, voice, note.position)
+      }
+    end.flatten
+  end
+
+  def positions
+    voices.map(:notes).flatten.map(&:position).sort.uniq
+  end
+end

data/lib/head_music/style/annotations/notes_same_length.rb

@@ -2,9 +2,7 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::NotesSameLength < HeadMusic::Style::Annotation
-  def message
-    'Use consistent rhythmic unit.'
-  end
+  MESSAGE = 'Use consistent rhythmic unit.'
 
   def marks
     preferred_value = first_most_common_rhythmic_value

data/lib/head_music/style/annotations/one_to_one.rb

@@ -2,14 +2,12 @@ module HeadMusic::Style::Annotations
 end
 
 class HeadMusic::Style::Annotations::OneToOne < HeadMusic::Style::Annotation
-  def message
-    'Place a note for each note in the other voice.'
-  end
+  MESSAGE = 'Place a note for each note in the other voice.'
 
   def marks
-    if other_voice && other_voice.notes.length > 0
+    if cantus_firmus && cantus_firmus.notes.length > 0
       HeadMusic::Style::Mark.for_each(
-        notes_without_match(voice, other_voice) + notes_without_match(other_voice, voice)
+        notes_without_match(voice, cantus_firmus) + notes_without_match(cantus_firmus, voice)
       )
     end
   end
@@ -21,12 +19,4 @@ class HeadMusic::Style::Annotations::OneToOne < HeadMusic::Style::Annotation
       voice2.notes.map(&:position).include?(voice1_note.position)
     end
   end
-
-  def other_voice
-    other_voices.detect(&:cantus_firmus?) || other_voices.first
-  end
-
-  def other_voices
-    @other_voices ||= voice.composition.voices.select { |part| part != voice }
-  end
 end

data/lib/head_music/style/annotations/prefer_contrary_motion.rb

@@ -0,0 +1,23 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::PreferContraryMotion < HeadMusic::Style::Annotation
+  MESSAGE = "Prefer contrary motion."
+
+  def marks
+    return nil if notes.length < 2
+    return nil if direct_motion_ratio <= 0.5
+    direct_motions.map { |motion| HeadMusic::Style::Mark.for_all(motion.notes) }
+  end
+
+  private
+
+  def direct_motions
+    motions.select(&:direct?)
+  end
+
+  def direct_motion_ratio
+    return 0 if motions.empty?
+    direct_motions.count / motions.count.to_f
+  end
+end

data/lib/head_music/style/annotations/prefer_imperfect.rb

@@ -0,0 +1,23 @@
+module HeadMusic::Style::Annotations
+end
+
+class HeadMusic::Style::Annotations::PreferImperfect < HeadMusic::Style::Annotation
+  MESSAGE = "Use consonant harmonic intervals."
+
+  def marks
+    if ratio_of_perfect_intervals > 0.5
+      HeadMusic::Style::Mark.for_all(perfect_intervals.map(&:notes).flatten)
+    end
+  end
+
+  private
+
+  def ratio_of_perfect_intervals
+    return 0 if downbeat_harmonic_intervals.empty?
+    perfect_intervals.length.to_f / downbeat_harmonic_intervals.length
+  end
+
+  def perfect_intervals
+    downbeat_harmonic_intervals.select { |interval| interval.perfect_consonance?(:two_part_harmony) }
+  end
+end

data/lib/head_music/style/annotations/recover_large_leaps.rb

@@ -6,9 +6,7 @@ end
 # unless another leap (in either direction) creates a consonant triad.
 # - Brian
 class HeadMusic::Style::Annotations::RecoverLargeLeaps < HeadMusic::Style::Annotation
-  def message
-    "Recover leaps by step in the opposite direction."
-  end
+  MESSAGE = "Recover leaps by step in the opposite direction."
 
   def marks
     melodic_intervals.drop(1).to_a.map.with_index do |interval, i|
@@ -22,7 +20,7 @@ class HeadMusic::Style::Annotations::RecoverLargeLeaps < HeadMusic::Style::Annot
   private
 
   def unrecovered_leap?(first_interval, second_interval)
-    first_interval.leap? &&
+    first_interval.large_leap? &&
     !spelling_consonant_triad?(first_interval, second_interval) &&
     (
       !direction_changed?(first_interval, second_interval) ||

data/lib/head_music/style/annotations/singable_intervals.rb

@@ -5,9 +5,7 @@ class HeadMusic::Style::Annotations::SingableIntervals < HeadMusic::Style::Annot
   PERMITTED_ASCENDING = %w[m2 M2 m3 M3 P4 P5 m6 P8]
   PERMITTED_DESCENDING = %w[m2 M2 m3 M3 P4 P5 P8]
 
-  def message
-    "Use only m2, M2, m3, M3, P4, P5, m6 (ascending), P8."
-  end
+  MESSAGE = "Use only m2, M2, m3, M3, P4, P5, m6 (ascending), P8."
 
   def marks
     melodic_intervals.reject { |interval| permitted?(interval) }.map do |unpermitted_interval|

data/lib/head_music/style/annotations/{limit_range.rb → singable_range.rb}

@@ -1,12 +1,10 @@
 module HeadMusic::Style::Annotations
 end
 
-class HeadMusic::Style::Annotations::LimitRange < HeadMusic::Style::Annotation
+class HeadMusic::Style::Annotations::SingableRange < HeadMusic::Style::Annotation
   MAXIMUM_RANGE = 10
 
-  def message
-    'Limit melodic range to a 10th.'
-  end
+  MESSAGE = 'Limit melodic range to a 10th.'
 
   def marks
     if overage > 0

data/lib/head_music/style/annotations/start_on_perfect_consonance.rb

@@ -3,12 +3,10 @@ end
 
 # marks the voice if the first note is not the first or fifth scale degree of the key.
 class HeadMusic::Style::Annotations::StartOnPerfectConsonance < HeadMusic::Style::Annotation
-  def message
-    'Start on the tonic or a perfect consonance above the tonic.'
-  end
+  MESSAGE = 'Start on the tonic or a perfect consonance above the tonic.'
 
   def marks
-    if first_note && !starts_on_perfect_consonance?
+    if first_note && ((bass_voice? && !starts_on_tonic?) || !starts_on_perfect_consonance?)
       HeadMusic::Style::Mark.for(first_note)
     end
   end
@@ -16,14 +14,6 @@ class HeadMusic::Style::Annotations::StartOnPerfectConsonance < HeadMusic::Style
   private
 
   def starts_on_perfect_consonance?
-    functional_interval.perfect_consonance?(:two_part_harmony)
-  end
-
-  def functional_interval
-    HeadMusic::FunctionalInterval.new(composition.key_signature.tonic_spelling, first_note.spelling)
-  end
-
-  def first_note
-    notes.first
+    functional_interval_from_tonic(first_note).perfect_consonance?(:two_part_harmony)
   end
 end