head_music 0.17.0 → 0.18.0

data/lib/head_music/style/analysis.rb

@@ -1,36 +1,38 @@
-module HeadMusic
-  module Style
-    class Analysis
-      attr_reader :ruleset, :subject, :annotations
-
-      def initialize(ruleset, subject)
-        @ruleset = ruleset
-        @subject = subject
-      end
-
-      def messages
-        annotations.reject(&:adherent?).map(&:message)
-      end
-      alias_method :annotation_messages, :messages
-
-      def annotations
-        @annotations ||= @ruleset.analyze(subject)
-      end
-
-      def fitness
-        return 1.0 if annotations.length == 0
-        @fitness ||= fitness_scores.inject(:+).to_f / fitness_scores.length
-      end
-
-      def adherent?
-        fitness == 1
-      end
-
-      private
-
-      def fitness_scores
-        @fitness_scores ||= annotations.map(&:fitness)
-      end
-    end
+# frozen_string_literal: true
+
+# A module for style analysis and rules.
+module HeadMusic::Style; end
+
+# An analysis of music according to a ruleset.
+class HeadMusic::Style::Analysis
+  attr_reader :ruleset, :subject
+
+  def initialize(ruleset, subject)
+    @ruleset = ruleset
+    @subject = subject
+  end
+
+  def messages
+    annotations.reject(&:adherent?).map(&:message)
+  end
+  alias annotation_messages messages
+
+  def annotations
+    @annotations ||= @ruleset.analyze(subject)
+  end
+
+  def fitness
+    return 1.0 if annotations.empty?
+    @fitness ||= fitness_scores.inject(:+).to_f / fitness_scores.length
+  end
+
+  def adherent?
+    fitness == 1
+  end
+
+  private
+
+  def fitness_scores
+    @fitness_scores ||= annotations.map(&:fitness)
   end
 end

data/lib/head_music/style/annotation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# An Annotation encapsulates an issue with or comment on a voice
 class HeadMusic::Style::Annotation
   MESSAGE = 'Write music.'
 
@@ -56,11 +59,11 @@ class HeadMusic::Style::Annotation
   protected
 
   def first_note
-    notes && notes.first
+    notes&.first
   end
 
   def last_note
-    notes && notes.last
+    notes&.last
   end
 
   def voices
@@ -68,7 +71,7 @@ class HeadMusic::Style::Annotation
   end
 
   def other_voices
-    @other_voices ||= voices.select { |part| part != voice }
+    @other_voices ||= voices.reject { |part| part == voice }
   end
 
   def cantus_firmus
@@ -85,9 +88,7 @@ class HeadMusic::Style::Annotation
 
   def functional_interval_from_tonic(note)
     tonic_to_use = tonic_pitch
-    while tonic_to_use > note.pitch
-      tonic_to_use -= HeadMusic::Interval.get(:perfect_octave)
-    end
+    tonic_to_use -= HeadMusic::Interval.get(:perfect_octave) while tonic_to_use > note.pitch
     HeadMusic::FunctionalInterval.new(tonic_to_use, note.pitch)
   end
 
@@ -101,23 +102,23 @@ class HeadMusic::Style::Annotation
 
   def motions
     downbeat_harmonic_intervals.map.with_index do |harmonic_interval, i|
-      next_harmonic_interval = downbeat_harmonic_intervals[i+1]
+      next_harmonic_interval = downbeat_harmonic_intervals[i + 1]
       HeadMusic::Motion.new(harmonic_interval, next_harmonic_interval) if next_harmonic_interval
     end.compact
   end
 
   def downbeat_harmonic_intervals
     @downbeat_harmonic_intervals ||=
-      cantus_firmus.notes.map { |cantus_firmus_note|
-        HeadMusic::HarmonicInterval.new(cantus_firmus_note.voice, voice, cantus_firmus_note.position)
-      }.reject { |interval| interval.notes.length < 2 }
+      cantus_firmus.notes.
+      map { |note| HeadMusic::HarmonicInterval.new(note.voice, voice, note.position) }.
+      reject { |interval| interval.notes.length < 2 }
   end
 
   def harmonic_intervals
     @harmonic_intervals ||=
-      positions.map { |position|
-        HeadMusic::HarmonicInterval.new(cantus_firmus, voice, position)
-      }.reject { |harmonic_interval| harmonic_interval.notes.length < 2 }
+      positions.
+      map { |position| HeadMusic::HarmonicInterval.new(cantus_firmus, voice, position) }.
+      reject { |harmonic_interval| harmonic_interval.notes.length < 2 }
   end
 
   def positions

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

@@ -1,14 +1,15 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::AlwaysMove < HeadMusic::Style::Annotation
-  MESSAGE = "Always move to a different note."
+  MESSAGE = 'Always move to a different note.'
 
   def marks
     melodic_intervals.map.with_index do |interval, i|
-      if interval.shorthand == 'PU'
-        HeadMusic::Style::Mark.for_all(notes[i..i+1])
-      end
+      HeadMusic::Style::Mark.for_all(notes[i..i + 1]) if interval.shorthand == 'PU'
     end.compact
   end
 end

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

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::ApproachPerfectionContrarily < HeadMusic::Style::Annotation
   MESSAGE = 'Approach perfect consonances by contrary motion.'
 

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

@@ -1,10 +1,13 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::AtLeastEightNotes < HeadMusic::Style::Annotation
   MINIMUM_NOTES = 8
 
-  MESSAGE = "Write at least eight notes."
+  MESSAGE = 'Write at least eight notes.'
 
   def marks
     placements.empty? ? no_placements_mark : deficiency_mark
@@ -14,15 +17,14 @@ class HeadMusic::Style::Annotations::AtLeastEightNotes < HeadMusic::Style::Annot
 
   def no_placements_mark
     HeadMusic::Style::Mark.new(
-      HeadMusic::Position.new(composition, "1:1"),
-      HeadMusic::Position.new(composition, "2:1"),
+      HeadMusic::Position.new(composition, '1:1'),
+      HeadMusic::Position.new(composition, '2:1'),
       fitness: 0
     )
   end
 
   def deficiency_mark
-    if notes.length < MINIMUM_NOTES
-      HeadMusic::Style::Mark.for_all(placements, fitness: notes.length.to_f / MINIMUM_NOTES)
-    end
+    return unless notes.length < MINIMUM_NOTES
+    HeadMusic::Style::Mark.for_all(placements, fitness: notes.length.to_f / MINIMUM_NOTES)
   end
 end

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::AvoidCrossingVoices < HeadMusic::Style::Annotation
-  MESSAGE = "Avoid crossing voices. Maintain the high-low relationship between voices."
+  MESSAGE = 'Avoid crossing voices. Maintain the high-low relationship between voices.'
 
   def marks
     crossings.map do |crossing|
@@ -19,11 +22,11 @@ class HeadMusic::Style::Annotations::AvoidCrossingVoices < HeadMusic::Style::Ann
   end
 
   def predominant_pitch_orientation
-    pitch_orientations
-      .compact
-      .group_by { |orientation| orientation }
-      .max { |a, b| a[1].length <=> b[1].length }
-      .first
+    pitch_orientations.
+      compact.
+      group_by { |orientation| orientation }.
+      max { |a, b| a[1].length <=> b[1].length }.
+      first
   end
 
   def pitch_orientations

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::AvoidOverlappingVoices < HeadMusic::Style::Annotation
-  MESSAGE = "Avoid overlapping voices. Maintain the high-low relationship between voices even for adjacent notes."
+  MESSAGE = 'Avoid overlapping voices. Maintain the high-low relationship between voices even for adjacent notes.'
 
   def marks
     overlappings
@@ -24,15 +27,19 @@ class HeadMusic::Style::Annotations::AvoidOverlappingVoices < HeadMusic::Style::
 
   def overlappings_for_voices(voices, comparison_operator)
     [].tap do |marks|
-      voices.each do |higher_voice|
-        overlapped_notes = voice.notes.select do |note|
-          preceding_note = higher_voice.note_preceding(note.position)
-          following_note = higher_voice.note_following(note.position)
-          (preceding_note && preceding_note.pitch.send(comparison_operator, note.pitch)) ||
-            (following_note && following_note.pitch.send(comparison_operator, note.pitch))
-        end
+      voices.each do |a_voice|
+        overlapped_notes = overlappings_with_voice(a_voice, comparison_operator)
         marks << HeadMusic::Style::Mark.for_each(overlapped_notes)
       end
     end.flatten.compact
   end
+
+  def overlappings_with_voice(other_voice, comparison_operator)
+    voice.notes.drop(1).select do |note|
+      preceding_note = other_voice.note_preceding(note.position)
+      following_note = other_voice.note_following(note.position)
+      preceding_note&.pitch&.send(comparison_operator, note.pitch) ||
+        following_note&.pitch&.send(comparison_operator, note.pitch)
+    end
+  end
 end

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

@@ -1,11 +1,14 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotation
-  MESSAGE = "Peak on a consonant high or low note one time or twice with a step between."
+  MESSAGE = 'Peak on a consonant high or low note one time or twice with a step between.'
 
   def marks
-    HeadMusic::Style::Mark.for_each(highest_notes) if !adherent_climax?
+    HeadMusic::Style::Mark.for_each(highest_notes) unless adherent_climax?
   end
 
   private
@@ -16,13 +19,13 @@ class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotat
 
   def adherent_high_pitch?
     notes? && highest_pitch_consonant_with_tonic? &&
-      ( highest_pitch_appears_once? || highest_pitch_appears_twice_with_step_between? )
+      (highest_pitch_appears_once? || highest_pitch_appears_twice_with_step_between?)
   end
 
   def adherent_low_pitch?
     notes? &&
-    lowest_pitch_consonant_with_tonic? &&
-      ( lowest_pitch_appears_once? || lowest_pitch_appears_twice_with_step_between? )
+      lowest_pitch_consonant_with_tonic? &&
+      (lowest_pitch_appears_once? || lowest_pitch_appears_twice_with_step_between?)
   end
 
   def highest_pitch_consonant_with_tonic?
@@ -53,14 +56,14 @@ class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotat
 
   def highest_pitch_appears_twice_with_step_between?
     highest_pitch_appears_twice? &&
-    single_note_between_highest_notes? &&
-    step_between_highest_notes?
+      single_note_between_highest_notes? &&
+      step_between_highest_notes?
   end
 
   def lowest_pitch_appears_twice_with_step_between?
     lowest_pitch_appears_twice? &&
-    single_note_between_lowest_notes? &&
-    step_between_lowest_notes?
+      single_note_between_lowest_notes? &&
+      step_between_lowest_notes?
   end
 
   def highest_pitch_appears_twice?
@@ -72,11 +75,11 @@ class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotat
   end
 
   def step_between_highest_notes?
-    HeadMusic::MelodicInterval.new(voice, highest_notes.first, notes_between_highest_notes.first).step?
+    HeadMusic::MelodicInterval.new(highest_notes.first, notes_between_highest_notes.first).step?
   end
 
   def step_between_lowest_notes?
-    HeadMusic::MelodicInterval.new(voice, lowest_notes.first, notes_between_lowest_notes.first).step?
+    HeadMusic::MelodicInterval.new(lowest_notes.first, notes_between_lowest_notes.first).step?
   end
 
   def single_note_between_highest_notes?
@@ -103,8 +106,8 @@ class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotat
   def descending_melody?
     # account for the possibility of opening with an octave leap
     notes.length > 1 &&
-    [first_note.pitch, second_note.pitch].include?(highest_pitch) &&
-    highest_pitch.spelling == tonic_spelling
+      [first_note.pitch, second_note.pitch].include?(highest_pitch) &&
+      highest_pitch.spelling == tonic_spelling
   end
 
   def second_note

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::ConsonantDownbeats < HeadMusic::Style::Annotation
-  MESSAGE = "Use consonant harmonic intervals on every downbeat."
+  MESSAGE = 'Use consonant harmonic intervals on every downbeat.'
 
   def marks
     dissonant_pairs.map do |dissonant_pair|

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::Diatonic < HeadMusic::Style::Annotation
-  MESSAGE = "Use only notes in the key signature."
+  MESSAGE = 'Use only notes in the key signature.'
 
   def marks
     HeadMusic::Style::Mark.for_each(notes_not_in_key_excluding_penultimate_leading_tone)
@@ -13,8 +16,8 @@ class HeadMusic::Style::Annotations::Diatonic < HeadMusic::Style::Annotation
   def notes_not_in_key_excluding_penultimate_leading_tone
     notes_not_in_key.reject do |note|
       penultimate_note &&
-      note == penultimate_note &&
-      HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).sign == '#'
+        note == penultimate_note &&
+        HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).sign == '#'
     end
   end
 

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

@@ -1,12 +1,14 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A melodic line should have direction changes.
 class HeadMusic::Style::Annotations::DirectionChanges < HeadMusic::Style::Annotation
   def marks
-    if overage > 0
-      penalty_exponent = overage**0.5
-      HeadMusic::Style::Mark.for_all(notes, fitness: HeadMusic::PENALTY_FACTOR**penalty_exponent)
-    end
+    return unless overage.positive?
+    penalty_exponent = overage**0.5
+    HeadMusic::Style::Mark.for_all(notes, fitness: HeadMusic::PENALTY_FACTOR**penalty_exponent)
   end
 
   private

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

@@ -1,14 +1,14 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; 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
   MESSAGE = 'End on the first or the fifth scale degree.'
 
   def marks
-    if last_note && !ends_on_perfect_consonance?
-      HeadMusic::Style::Mark.for(last_note)
-    end
+    HeadMusic::Style::Mark.for(last_note) if last_note && !ends_on_perfect_consonance?
   end
 
   private

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

@@ -1,13 +1,14 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::EndOnTonic < HeadMusic::Style::Annotation
   MESSAGE = 'End on the first scale degree.'
 
   def marks
-    if !notes.empty? && !ends_on_tonic?
-      HeadMusic::Style::Mark.for(notes.last)
-    end
+    HeadMusic::Style::Mark.for(notes.last) if !notes.empty? && !ends_on_tonic?
   end
 
   private
@@ -17,6 +18,6 @@ class HeadMusic::Style::Annotations::EndOnTonic < HeadMusic::Style::Annotation
   end
 
   def last_note_spelling
-    last_note && last_note.spelling
+    last_note&.spelling
   end
 end

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::FrequentDirectionChanges < HeadMusic::Style::Annotations::DirectionChanges
-  MESSAGE = "Change melodic direction frequently."
+  MESSAGE = 'Change melodic direction frequently.'
 
   def self.maximum_notes_per_direction
     3

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

@@ -1,14 +1,16 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline: Use a maximum of one octave leap.
 class HeadMusic::Style::Annotations::LimitOctaveLeaps < HeadMusic::Style::Annotation
-  MESSAGE = "Use a maximum of one octave leap."
+  MESSAGE = 'Use a maximum of one octave leap.'
 
   def marks
-    if octave_leaps.length > 1
-      octave_leaps.map do |leap|
-        HeadMusic::Style::Mark.for_all(leap.notes)
-      end
+    return if octave_leaps.length <= 1
+    octave_leaps.map do |leap|
+      HeadMusic::Style::Mark.for_all(leap.notes)
     end
   end
 

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::ModerateDirectionChanges < HeadMusic::Style::Annotations::DirectionChanges
-  MESSAGE = "Change melodic direction occasionally."
+  MESSAGE = 'Change melodic direction occasionally.'
 
   def self.maximum_notes_per_direction
     5

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

@@ -1,10 +1,13 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::MostlyConjunct < HeadMusic::Style::Annotation
-  MESSAGE = "Use mostly conjunct motion."
+  MESSAGE = 'Use mostly conjunct motion.'
 
-  MINIMUM_CONJUNCT_PORTION = HeadMusic::GOLDEN_RATIO_INVERSE ** 2
+  MINIMUM_CONJUNCT_PORTION = HeadMusic::GOLDEN_RATIO_INVERSE**2
   # ~38%
   # Fux is 5/13 for lydian cantus firmus
 
@@ -16,7 +19,7 @@ class HeadMusic::Style::Annotations::MostlyConjunct < HeadMusic::Style::Annotati
 
   def marks_for_skips_and_leaps
     melodic_intervals.map.with_index do |interval, i|
-      HeadMusic::Style::Mark.for_all(notes[i..i+1], fitness: HeadMusic::SMALL_PENALTY_FACTOR) unless interval.step?
+      HeadMusic::Style::Mark.for_all(notes[i..i + 1], fitness: HeadMusic::SMALL_PENALTY_FACTOR) unless interval.step?
     end.compact
   end
 

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::NoRests < HeadMusic::Style::Annotation
-  MESSAGE = "Place a note in each measure."
+  MESSAGE = 'Place a note in each measure.'
 
   def marks
     HeadMusic::Style::Mark.for_each(rests)

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

@@ -1,8 +1,11 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::NoUnisonsInMiddle < HeadMusic::Style::Annotation
-  MESSAGE = "Unisons may only be used in the first and last note."
+  MESSAGE = 'Unisons may only be used in the first and last note.'
 
   def marks
     unison_pairs.map do |notes|

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

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::NotesSameLength < HeadMusic::Style::Annotation
   MESSAGE = 'Use consistent rhythmic unit.'
 
@@ -15,8 +18,8 @@ class HeadMusic::Style::Annotations::NotesSameLength < HeadMusic::Style::Annotat
   end
 
   def wrong_length_notes
-    all_but_last_note.select.with_index do |note|
-      note.rhythmic_value != first_most_common_rhythmic_value
+    all_but_last_note.reject do |note|
+      note.rhythmic_value == first_most_common_rhythmic_value
     end
   end
 
@@ -28,7 +31,7 @@ class HeadMusic::Style::Annotations::NotesSameLength < HeadMusic::Style::Annotat
     last_note.nil? ||
       [
         first_most_common_rhythmic_value.total_value,
-        first_most_common_rhythmic_value.total_value * 2
+        first_most_common_rhythmic_value.total_value * 2,
       ].include?(last_note.rhythmic_value.total_value)
   end
 
@@ -56,7 +59,7 @@ class HeadMusic::Style::Annotations::NotesSameLength < HeadMusic::Style::Annotat
   end
 
   def occurrences_by_rhythmic_value
-    rhythmic_values.inject(Hash.new(0)) { |hash, value| hash[value] += 1; hash }
+    rhythmic_values.each_with_object(Hash.new(0)) { |value, hash| hash[value] += 1; }
   end
 
   def rhythmic_values