head_music 0.17.0 → 0.18.0

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

@@ -1,15 +1,18 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::OneToOne < HeadMusic::Style::Annotation
   MESSAGE = 'Place a note for each note in the other voice.'
 
   def marks
-    if cantus_firmus && cantus_firmus.notes.length > 0
-      HeadMusic::Style::Mark.for_each(
-        notes_without_match(voice, cantus_firmus) + notes_without_match(cantus_firmus, voice)
-      )
-    end
+    return unless cantus_firmus&.notes
+    return if cantus_firmus.notes.empty?
+    HeadMusic::Style::Mark.for_each(
+      notes_without_match(voice, cantus_firmus) + notes_without_match(cantus_firmus, voice)
+    )
   end
 
   private

data/lib/head_music/style/annotations/prefer_contrary_motion.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::PreferContraryMotion < HeadMusic::Style::Annotation
-  MESSAGE = "Prefer contrary motion. Move voices in different melodic directions."
+  MESSAGE = 'Prefer contrary motion. Move voices in different melodic directions.'
 
   def marks
     return nil if notes.length < 2

data/lib/head_music/style/annotations/prefer_imperfect.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::PreferImperfect < HeadMusic::Style::Annotation
-  MESSAGE = "Prefer imperfect harmonic intervals."
+  MESSAGE = 'Prefer imperfect harmonic intervals.'
 
   def marks
-    if ratio_of_perfect_intervals >= 0.5
-      HeadMusic::Style::Mark.for_all(perfect_intervals.map(&:notes).flatten)
-    end
+    HeadMusic::Style::Mark.for_all(perfect_intervals.map(&:notes).flatten) if ratio_of_perfect_intervals >= 0.5
   end
 
   private

data/lib/head_music/style/annotations/prepare_octave_leaps.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::PrepareOctaveLeaps < HeadMusic::Style::Annotation
-  MESSAGE = "Enter and exit an octave leap from within."
+  MESSAGE = 'Enter and exit an octave leap from within.'
 
   def marks
-    (external_entries + external_exits).map do |trouble_spot|
+    (external_entries + external_exits + octave_ending).map do |trouble_spot|
       HeadMusic::Style::Mark.for_all(trouble_spot)
     end
   end
@@ -13,18 +16,24 @@ class HeadMusic::Style::Annotations::PrepareOctaveLeaps < HeadMusic::Style::Anno
   private
 
   def external_entries
-    melodic_intervals.map.with_index do |melodic_interval, i|
-      if melodic_interval.octave? && i > 0 && !melodic_interval.spans?(notes[i-1].pitch)
-        notes[[i-1, 0].max..(i+1)]
-      end
+    melodic_intervals.each_cons(2).map do |pair|
+      first, second = *pair
+      pair.map(&:notes).uniq if second.octave? && !second.spans?(first.first_note.pitch)
     end.compact
   end
 
   def external_exits
-    melodic_intervals.map.with_index do |melodic_interval, i|
-      if melodic_interval.octave? && (i == (melodic_intervals.length - 1) || !melodic_interval.spans?(notes[i+2].pitch))
-        notes[i..[i+2, notes.length - 1].min]
-      end
+    melodic_intervals.each_cons(2).map do |pair|
+      first, second = *pair
+      pair.map(&:notes).uniq if first.octave? && !first.spans?(second.second_note.pitch)
     end.compact
   end
+
+  def octave_ending
+    octave_ending? ? [melodic_intervals.last.notes] : []
+  end
+
+  def octave_ending?
+    melodic_intervals.last&.octave?
+  end
 end

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

@@ -1,31 +1,36 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
 # Ok, so a rule might be that after the first leap (after previous steps)
 # one should normally move by step in the opposite direction
 # unless another leap (in either direction) creates a consonant triad.
 # - Brian
 class HeadMusic::Style::Annotations::RecoverLargeLeaps < HeadMusic::Style::Annotation
-  MESSAGE = "Recover large leaps by step in the opposite direction."
+  MESSAGE = 'Recover large leaps by step in the opposite direction.'
 
   def marks
-    melodic_intervals.drop(1).to_a.map.with_index do |interval, i|
-      previous_interval = melodic_intervals[i]
-      if unrecovered_leap?(previous_interval, interval, melodic_intervals[i+2])
-        HeadMusic::Style::Mark.for_all((previous_interval.notes + interval.notes).uniq)
+    melodic_intervals.each_cons(3).map do |intervals|
+      if unrecovered_leap?(intervals[0], intervals[1], intervals[2])
+        HeadMusic::Style::Mark.for_all(notes_in_intervals(intervals))
       end
     end.compact
   end
 
   private
 
+  def notes_in_intervals(intervals)
+    (intervals[0].notes + intervals[1].notes).uniq
+  end
+
   def unrecovered_leap?(first_interval, second_interval, third_interval)
     first_interval.large_leap? &&
-    !spelling_consonant_triad?(first_interval, second_interval, third_interval) &&
-    (
-      !direction_changed?(first_interval, second_interval) ||
-      !second_interval.step?
-    )
+      !spelling_consonant_triad?(first_interval, second_interval, third_interval) &&
+      (
+        !direction_changed?(first_interval, second_interval) ||
+        !second_interval.step?
+      )
   end
 
   def spelling_consonant_triad?(first_interval, second_interval, third_interval)

data/lib/head_music/style/annotations/singable_intervals.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::SingableIntervals < HeadMusic::Style::Annotation
-  PERMITTED_ASCENDING = %w[PU m2 M2 m3 M3 P4 P5 m6 P8]
-  PERMITTED_DESCENDING = %w[PU m2 M2 m3 M3 P4 P5 P8]
+  PERMITTED_ASCENDING = %w[PU m2 M2 m3 M3 P4 P5 m6 P8].freeze
+  PERMITTED_DESCENDING = %w[PU m2 M2 m3 M3 P4 P5 P8].freeze
 
-  MESSAGE = "Use only PU, m2, M2, m3, M3, P4, P5, m6 (ascending), P8 in the melodic line."
+  MESSAGE = 'Use only PU, m2, M2, m3, M3, P4, P5, m6 (ascending), P8 in the melodic line.'
 
   def marks
     melodic_intervals.reject { |interval| permitted?(interval) }.map do |unpermitted_interval|

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

@@ -1,21 +1,22 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A voice shouldn't expend the range of a 10th.
 class HeadMusic::Style::Annotations::SingableRange < HeadMusic::Style::Annotation
   MAXIMUM_RANGE = 10
 
   MESSAGE = 'Limit melodic range to a 10th.'
 
   def marks
-    if overage > 0
-      HeadMusic::Style::Mark.for_each(extremes, fitness: HeadMusic::PENALTY_FACTOR**overage)
-    end
+    HeadMusic::Style::Mark.for_each(extremes, fitness: HeadMusic::PENALTY_FACTOR**overage) if overage.positive?
   end
 
   private
 
   def overage
-    notes.length > 0 ? [range.number - MAXIMUM_RANGE, 0].max : 0
+    !notes.empty? ? [range.number - MAXIMUM_RANGE, 0].max : 0
   end
 
   def extremes

data/lib/head_music/style/annotations/single_large_leaps.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::SingleLargeLeaps < HeadMusic::Style::Annotations::RecoverLargeLeaps
-  MESSAGE = "Recover leaps by step, repetition, opposite direction, or spelling triad."
+  MESSAGE = 'Recover leaps by step, repetition, opposite direction, or spelling triad.'
 
   private
 

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

@@ -1,14 +1,15 @@
-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::StartOnPerfectConsonance < HeadMusic::Style::Annotation
   MESSAGE = 'Start on the tonic or a perfect consonance above the tonic (unless bass voice).'
 
   def marks
-    if first_note && ((bass_voice? && !starts_on_tonic?) || !starts_on_perfect_consonance?)
-      HeadMusic::Style::Mark.for(first_note)
-    end
+    return unless first_note && ((bass_voice? && !starts_on_tonic?) || !starts_on_perfect_consonance?)
+    HeadMusic::Style::Mark.for(first_note)
   end
 
   private

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

@@ -1,12 +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::StartOnTonic < HeadMusic::Style::Annotation
   MESSAGE = 'Start on the first scale degree.'
 
   def marks
-    if first_note && !starts_on_tonic?
-      HeadMusic::Style::Mark.for(first_note)
-    end
+    HeadMusic::Style::Mark.for(first_note) if first_note && !starts_on_tonic?
   end
 end

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

@@ -1,28 +1,28 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::StepDownToFinalNote < HeadMusic::Style::Annotation
   MESSAGE = 'Step down to the final note.'
 
   def marks
-    if !last_melodic_interval.nil?
-      fitness = 1
-      fitness *= HeadMusic::PENALTY_FACTOR unless step?
-      fitness *= HeadMusic::PENALTY_FACTOR unless descending?
-      if fitness < 1
-        HeadMusic::Style::Mark.for_all(notes[-2..-1], fitness: fitness)
-      end
-    end
+    return if last_melodic_interval.nil?
+    fitness = 1
+    fitness *= HeadMusic::PENALTY_FACTOR unless step?
+    fitness *= HeadMusic::PENALTY_FACTOR unless descending?
+    HeadMusic::Style::Mark.for_all(notes[-2..-1], fitness: fitness) if fitness < 1
   end
 
   private
 
   def descending?
-    last_melodic_interval && last_melodic_interval.descending?
+    last_melodic_interval&.descending?
   end
 
   def step?
-    last_melodic_interval && last_melodic_interval.step?
+    last_melodic_interval&.step?
   end
 
   def last_melodic_interval

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

@@ -1,19 +1,22 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::StepOutOfUnison < HeadMusic::Style::Annotation
-  MESSAGE = "Exit a unison by step."
+  MESSAGE = 'Exit a unison by step.'
 
   def marks
-    skips_following_unisons.map do |skip|
+    leaps_following_unisons.map do |skip|
       HeadMusic::Style::Mark.for_all(skip.notes)
     end.flatten
   end
 
   private
 
-  def skips_following_unisons
-    melodic_intervals_following_unisons.select(&:skip?)
+  def leaps_following_unisons
+    melodic_intervals_following_unisons.select(&:leap?)
   end
 
   def melodic_intervals_following_unisons
@@ -21,7 +24,7 @@ class HeadMusic::Style::Annotations::StepOutOfUnison < HeadMusic::Style::Annotat
       perfect_unisons.map do |unison|
         note1 = voice.note_at(unison.position)
         note2 = voice.note_following(unison.position)
-        HeadMusic::MelodicInterval.new(voice, note1, note2) if note1 && note2
+        HeadMusic::MelodicInterval.new(note1, note2) if note1 && note2
       end.compact
   end
 

data/lib/head_music/style/annotations/step_to_final_note.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::StepToFinalNote < HeadMusic::Style::Annotation
   MESSAGE = 'Step to the final note.'
 
@@ -11,7 +14,7 @@ class HeadMusic::Style::Annotations::StepToFinalNote < HeadMusic::Style::Annotat
   private
 
   def step_to_final_note?
-    last_melodic_interval && last_melodic_interval.step?
+    last_melodic_interval&.step?
   end
 
   def last_melodic_interval

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

@@ -1,28 +1,28 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::StepUpToFinalNote < HeadMusic::Style::Annotation
   MESSAGE = 'Step up to final note.'
 
   def marks
-    if !last_melodic_interval.nil?
-      fitness = 1
-      fitness *= HeadMusic::PENALTY_FACTOR unless step?
-      fitness *= HeadMusic::PENALTY_FACTOR unless ascending?
-      if fitness < 1
-        HeadMusic::Style::Mark.for_all(notes[-2..-1], fitness: fitness)
-      end
-    end
+    return if last_melodic_interval.nil?
+    fitness = 1
+    fitness *= HeadMusic::PENALTY_FACTOR unless step?
+    fitness *= HeadMusic::PENALTY_FACTOR unless ascending?
+    HeadMusic::Style::Mark.for_all(notes[-2..-1], fitness: fitness) if fitness < 1
   end
 
   private
 
   def ascending?
-    last_melodic_interval && last_melodic_interval.ascending?
+    last_melodic_interval&.ascending?
   end
 
   def step?
-    last_melodic_interval && last_melodic_interval.step?
+    last_melodic_interval&.step?
   end
 
   def last_melodic_interval

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

@@ -1,15 +1,16 @@
-module HeadMusic::Style::Annotations
-end
+# frozen_string_literal: true
+
+# Module for Annotations.
+module HeadMusic::Style::Annotations; end
 
+# A counterpoint guideline
 class HeadMusic::Style::Annotations::UpToFourteenNotes < HeadMusic::Style::Annotation
   MAXIMUM_NOTES = 14
 
   MESSAGE = 'Write up to fourteen notes.'
 
   def marks
-    if overage > 0
-      HeadMusic::Style::Mark.for_each(notes[MAXIMUM_NOTES..-1])
-    end
+    HeadMusic::Style::Mark.for_each(notes[MAXIMUM_NOTES..-1]) if overage.positive?
   end
 
   private

data/lib/head_music/style/mark.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# A mark is a fragment of music with an optional fitness score assigned.
+# Marks are collected into annotations which comment on the fragments.
 class HeadMusic::Style::Mark
   attr_reader :start_position, :end_position, :placements, :fitness
 
@@ -7,15 +11,17 @@ class HeadMusic::Style::Mark
 
   def self.for_all(placements, fitness: nil)
     placements = [placements].flatten.compact
-    return [] if placements.length == 0
-    start_position = placements.map { |placement| placement.position }.sort.first
-    end_position = placements.map { |placement| placement.next_position }.sort.last
+    return [] if placements.empty?
+    start_position = placements.map(&:position).sort.first
+    end_position = placements.map(&:next_position).sort.last
     new(start_position, end_position, placements: placements, fitness: fitness)
   end
 
   def self.for_each(placements, fitness: nil)
     placements = [placements].flatten
-    placements.map { |placement| new(placement.position, placement.next_position, placements: placement, fitness: fitness) }
+    placements.map do |placement|
+      new(placement.position, placement.next_position, placements: placement, fitness: fitness)
+    end
   end
 
   def initialize(start_position, end_position, placements: [], fitness: nil)

data/lib/head_music/style/rulesets/first_species_harmony.rb

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Rulesets
-end
+# frozen_string_literal: true
+
+# Module for rulesets
+module HeadMusic::Style::Rulesets; end
 
+# Rules for first species harmony
 class HeadMusic::Style::Rulesets::FirstSpeciesHarmony
   RULESET = [
     HeadMusic::Style::Annotations::ApproachPerfectionContrarily,
@@ -11,7 +14,7 @@ class HeadMusic::Style::Rulesets::FirstSpeciesHarmony
     HeadMusic::Style::Annotations::OneToOne,
     HeadMusic::Style::Annotations::PreferContraryMotion,
     HeadMusic::Style::Annotations::PreferImperfect,
-  ]
+  ].freeze
 
   def self.analyze(voice)
     RULESET.map { |rule| rule.new(voice) }

data/lib/head_music/style/rulesets/first_species_melody.rb

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Rulesets
-end
+# frozen_string_literal: true
+
+# Module for rulesets
+module HeadMusic::Style::Rulesets; end
 
+# Rules for first species melodies
 class HeadMusic::Style::Rulesets::FirstSpeciesMelody
   RULESET = [
     HeadMusic::Style::Annotations::ConsonantClimax,
@@ -17,7 +20,7 @@ class HeadMusic::Style::Rulesets::FirstSpeciesMelody
     HeadMusic::Style::Annotations::StartOnPerfectConsonance,
     HeadMusic::Style::Annotations::StepOutOfUnison,
     HeadMusic::Style::Annotations::StepUpToFinalNote,
-  ]
+  ].freeze
 
   def self.analyze(voice)
     RULESET.map { |rule| rule.new(voice) }

data/lib/head_music/style/rulesets/fux_cantus_firmus.rb

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Rulesets
-end
+# frozen_string_literal: true
+
+# Module for rulesets
+module HeadMusic::Style::Rulesets; end
 
+# Rules for the cantus firmus according to Fux.
 class HeadMusic::Style::Rulesets::FuxCantusFirmus
   RULESET = [
     HeadMusic::Style::Annotations::AlwaysMove,
@@ -19,7 +22,7 @@ class HeadMusic::Style::Rulesets::FuxCantusFirmus
     HeadMusic::Style::Annotations::StartOnTonic,
     HeadMusic::Style::Annotations::StepDownToFinalNote,
     HeadMusic::Style::Annotations::UpToFourteenNotes,
-  ]
+  ].freeze
 
   def self.analyze(voice)
     RULESET.map { |rule| rule.new(voice) }

data/lib/head_music/style/rulesets/modern_cantus_firmus.rb

@@ -1,6 +1,9 @@
-module HeadMusic::Style::Rulesets
-end
+# frozen_string_literal: true
+
+# Module for rulesets
+module HeadMusic::Style::Rulesets; end
 
+# Modern rules for the cantus firmus
 class HeadMusic::Style::Rulesets::ModernCantusFirmus
   RULESET = [
     HeadMusic::Style::Annotations::AlwaysMove,
@@ -20,7 +23,7 @@ class HeadMusic::Style::Rulesets::ModernCantusFirmus
     HeadMusic::Style::Annotations::StartOnTonic,
     HeadMusic::Style::Annotations::StepToFinalNote,
     HeadMusic::Style::Annotations::UpToFourteenNotes,
-  ]
+  ].freeze
 
   def self.analyze(voice)
     RULESET.map { |rule| rule.new(voice) }

data/lib/head_music/utilities/hash_key.rb

@@ -1,9 +1,11 @@
-module HeadMusic
-  module Utilities
-    class HashKey
-      def self.for(identifier)
-        identifier.to_s.downcase.gsub(/\W+/, '_').to_sym
-      end
-    end
+# frozen_string_literal: true
+
+# A namespace for utilities classes and modules
+module HeadMusic::Utilities; end
+
+# Util for converting an object to a consistent hash key
+module HeadMusic::Utilities::HashKey
+  def self.for(identifier)
+    identifier.to_s.downcase.gsub(/\W+/, '_').to_sym
   end
 end

data/lib/head_music/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HeadMusic
-  VERSION = "0.17.0"
+  VERSION = '0.18.0'
 end

data/lib/head_music/voice.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# A Voice is a stream of music with some indepedence that is conceptually one part or for one performer.
+# The melodic lines in counterpoint are each a voice.
 class HeadMusic::Voice
   include Comparable
 
@@ -11,9 +15,9 @@ class HeadMusic::Voice
   end
 
   def place(position, rhythmic_value, pitch = nil)
-    HeadMusic::Placement.new(self, position, rhythmic_value, pitch).tap { |placement|
+    HeadMusic::Placement.new(self, position, rhythmic_value, pitch).tap do |placement|
       insert_into_placements(placement)
-    }
+    end
   end
 
   def notes
@@ -56,7 +60,7 @@ class HeadMusic::Voice
   def melodic_intervals
     @melodic_intervals ||=
       notes.map.with_index do |note, i|
-        HeadMusic::MelodicInterval.new(self, notes[i-1], note) if i > 0
+        HeadMusic::MelodicInterval.new(notes[i - 1], note) if i.positive?
       end.compact
   end
 

data/lib/head_music.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HeadMusic
   GOLDEN_RATIO = (1 + 5**0.5) / 2.0
   GOLDEN_RATIO_INVERSE = 1 / GOLDEN_RATIO

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,9 +203,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="