head_music 7.0.5 → 8.0.0

data/lib/head_music/{spelling.rb → rudiment/spelling.rb}

@@ -1,8 +1,11 @@
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
 # Represents the spelling of a pitch, such as C# or Db.
 # Composite of a LetterName and an optional Alteration.
 # Does not include the octave. See Pitch for that.
-class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])(#{HeadMusic::Alteration.matcher}?)(-?\d+)?\s*$/i
+class HeadMusic::Rudiment::Spelling
+  MATCHER = /^\s*([A-G])(#{HeadMusic::Rudiment::Alteration.matcher}?)(-?\d+)?\s*$/i
 
   attr_reader :pitch_class, :letter_name, :alteration
 
@@ -13,7 +16,7 @@ class HeadMusic::Spelling
   delegate :sharp?, :flat?, :double_sharp?, :double_flat?, to: :alteration, allow_nil: true
 
   def self.get(identifier)
-    return identifier if identifier.is_a?(HeadMusic::Spelling)
+    return identifier if identifier.is_a?(HeadMusic::Rudiment::Spelling)
 
     from_name(identifier) || from_number(identifier)
   end
@@ -26,10 +29,10 @@ class HeadMusic::Spelling
     return nil unless matching_string(name)
 
     letter_name, sign_string, _octave = matching_string(name).captures
-    letter_name = HeadMusic::LetterName.get(letter_name)
+    letter_name = HeadMusic::Rudiment::LetterName.get(letter_name)
     return nil unless letter_name
 
-    alteration = HeadMusic::Alteration.get(sign_string)
+    alteration = HeadMusic::Rudiment::Alteration.get(sign_string)
     fetch_or_create(letter_name, alteration)
   end
 
@@ -37,15 +40,15 @@ class HeadMusic::Spelling
     return nil unless number == number.to_i
 
     pitch_class_number = number.to_i % 12
-    letter_name = HeadMusic::LetterName.from_pitch_class(pitch_class_number)
+    letter_name = HeadMusic::Rudiment::LetterName.from_pitch_class(pitch_class_number)
     from_number_and_letter(number, letter_name)
   end
 
   def self.from_number_and_letter(number, letter_name)
-    letter_name = HeadMusic::LetterName.get(letter_name)
+    letter_name = HeadMusic::Rudiment::LetterName.get(letter_name)
     natural_letter_pitch_class = letter_name.pitch_class
-    alteration_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::PitchClass.get(number))
-    alteration = HeadMusic::Alteration.by(:semitones, alteration_interval) if alteration_interval != 0
+    alteration_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::Rudiment::PitchClass.get(number))
+    alteration = HeadMusic::Rudiment::Alteration.by(:semitones, alteration_interval) if alteration_interval != 0
     fetch_or_create(letter_name, alteration)
   end
 
@@ -56,10 +59,10 @@ class HeadMusic::Spelling
   end
 
   def initialize(letter_name, alteration = nil)
-    @letter_name = HeadMusic::LetterName.get(letter_name.to_s)
-    @alteration = HeadMusic::Alteration.get(alteration)
+    @letter_name = HeadMusic::Rudiment::LetterName.get(letter_name.to_s)
+    @alteration = HeadMusic::Rudiment::Alteration.get(alteration)
     alteration_semitones = @alteration ? @alteration.semitones : 0
-    @pitch_class = HeadMusic::PitchClass.get(letter_name.pitch_class + alteration_semitones)
+    @pitch_class = HeadMusic::Rudiment::PitchClass.get(letter_name.pitch_class + alteration_semitones)
   end
 
   def name
@@ -71,12 +74,12 @@ class HeadMusic::Spelling
   end
 
   def ==(other)
-    other = HeadMusic::Spelling.get(other)
+    other = HeadMusic::Rudiment::Spelling.get(other)
     to_s == other.to_s
   end
 
   def scale(scale_type_name = nil)
-    HeadMusic::Scale.get(self, scale_type_name)
+    HeadMusic::Rudiment::Scale.get(self, scale_type_name)
   end
 
   def natural?
@@ -94,7 +97,7 @@ class HeadMusic::Spelling
   # Enharmonic equivalence occurs when two spellings refer to the same pitch class, such as D# and Eb.
   class EnharmonicEquivalence
     def self.get(spelling)
-      spelling = HeadMusic::Spelling.get(spelling)
+      spelling = HeadMusic::Rudiment::Spelling.get(spelling)
       @enharmonic_equivalences ||= {}
       @enharmonic_equivalences[spelling.to_s] ||= new(spelling)
     end
@@ -102,11 +105,11 @@ class HeadMusic::Spelling
     attr_reader :spelling
 
     def initialize(spelling)
-      @spelling = HeadMusic::Spelling.get(spelling)
+      @spelling = HeadMusic::Rudiment::Spelling.get(spelling)
     end
 
     def enharmonic_equivalent?(other)
-      other = HeadMusic::Spelling.get(other)
+      other = HeadMusic::Rudiment::Spelling.get(other)
       spelling != other && spelling.pitch_class_number == other.pitch_class_number
     end
 

data/lib/head_music/{tuning.rb → rudiment/tuning.rb}

@@ -1,16 +1,19 @@
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
 # A tuning has a reference pitch and frequency and provides frequencies for all pitches
 # The base class assumes equal temperament tuning. By default, A4 = 440.0 Hz
-class HeadMusic::Tuning
+class HeadMusic::Rudiment::Tuning
   attr_accessor :reference_pitch
 
   delegate :pitch, :frequency, to: :reference_pitch, prefix: true
 
   def initialize(reference_pitch: :a440)
-    @reference_pitch = HeadMusic::ReferencePitch.get(reference_pitch)
+    @reference_pitch = HeadMusic::Rudiment::ReferencePitch.get(reference_pitch)
   end
 
   def frequency_for(pitch)
-    pitch = HeadMusic::Pitch.get(pitch)
+    pitch = HeadMusic::Rudiment::Pitch.get(pitch)
     reference_pitch_frequency * (2**(1.0 / 12))**(pitch - reference_pitch.pitch).semitones
   end
 end

data/lib/head_music/style/annotation.rb

@@ -82,8 +82,8 @@ class HeadMusic::Style::Annotation
 
   def diatonic_interval_from_tonic(note)
     tonic_to_use = tonic_pitch
-    tonic_to_use -= HeadMusic::ChromaticInterval.get(:perfect_octave) while tonic_to_use > note.pitch
-    HeadMusic::DiatonicInterval.new(tonic_to_use, note.pitch)
+    tonic_to_use -= HeadMusic::Rudiment::ChromaticInterval.get(:perfect_octave) while tonic_to_use > note.pitch
+    HeadMusic::Analysis::DiatonicInterval.new(tonic_to_use, note.pitch)
   end
 
   def bass_voice?
@@ -96,21 +96,21 @@ class HeadMusic::Style::Annotation
 
   def motions
     downbeat_harmonic_intervals.each_cons(2).map do |harmonic_interval_pair|
-      HeadMusic::Motion.new(*harmonic_interval_pair)
+      HeadMusic::Analysis::Motion.new(*harmonic_interval_pair)
     end
   end
 
   def downbeat_harmonic_intervals
     @downbeat_harmonic_intervals ||=
       cantus_firmus.notes
-        .map { |note| HeadMusic::HarmonicInterval.new(note.voice, voice, note.position) }
+        .map { |note| HeadMusic::Analysis::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) }
+        .map { |position| HeadMusic::Analysis::HarmonicInterval.new(cantus_firmus, voice, position) }
         .reject { |harmonic_interval| harmonic_interval.notes.length < 2 }
   end
 
@@ -128,6 +128,6 @@ class HeadMusic::Style::Annotation
   end
 
   def tonic_pitch
-    @tonic_pitch ||= HeadMusic::Pitch.get(tonic_spelling)
+    @tonic_pitch ||= HeadMusic::Rudiment::Pitch.get(tonic_spelling)
   end
 end

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

@@ -36,12 +36,12 @@ class HeadMusic::Style::Guidelines::ConsonantClimax < HeadMusic::Style::Annotati
 
   def diatonic_interval_to_highest_pitch
     @diatonic_interval_to_highest_pitch ||=
-      HeadMusic::DiatonicInterval.new(tonic_pitch, highest_pitch)
+      HeadMusic::Analysis::DiatonicInterval.new(tonic_pitch, highest_pitch)
   end
 
   def diatonic_interval_to_lowest_pitch
     @diatonic_interval_to_lowest_pitch ||=
-      HeadMusic::DiatonicInterval.new(tonic_pitch, lowest_pitch)
+      HeadMusic::Analysis::DiatonicInterval.new(tonic_pitch, lowest_pitch)
   end
 
   def highest_pitch_appears_once?
@@ -73,11 +73,11 @@ class HeadMusic::Style::Guidelines::ConsonantClimax < HeadMusic::Style::Annotati
   end
 
   def step_between_highest_notes?
-    HeadMusic::MelodicInterval.new(highest_notes.first, notes_between_highest_notes.first).step?
+    HeadMusic::Analysis::MelodicInterval.new(highest_notes.first, notes_between_highest_notes.first).step?
   end
 
   def step_between_lowest_notes?
-    HeadMusic::MelodicInterval.new(lowest_notes.first, notes_between_lowest_notes.first).step?
+    HeadMusic::Analysis::MelodicInterval.new(lowest_notes.first, notes_between_lowest_notes.first).step?
   end
 
   def single_note_between_highest_notes?

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

@@ -15,7 +15,7 @@ class HeadMusic::Style::Guidelines::Diatonic < HeadMusic::Style::Annotation
     notes_not_in_key.reject do |note|
       penultimate_note &&
         note == penultimate_note &&
-        HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).alteration == "#"
+        HeadMusic::Rudiment::ScaleDegree.new(key_signature, note.pitch.spelling).alteration == "#"
     end
   end
 

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

@@ -22,7 +22,7 @@ class HeadMusic::Style::Guidelines::StepOutOfUnison < HeadMusic::Style::Annotati
       perfect_unisons.map do |unison|
         note1 = voice.note_at(unison.position)
         note2 = voice.note_following(unison.position)
-        HeadMusic::MelodicInterval.new(note1, note2) if note1 && note2
+        HeadMusic::Analysis::MelodicInterval.new(note1, note2) if note1 && note2
       end.compact
   end
 

data/lib/head_music/version.rb

@@ -1,3 +1,3 @@
 module HeadMusic
-  VERSION = "7.0.5"
+  VERSION = "8.0.0"
 end

data/lib/head_music.rb

@@ -32,50 +32,42 @@ require "head_music/utilities/hash_key"
 require "head_music/named"
 
 # rudiments
-require "head_music/alteration"
-require "head_music/chromatic_interval"
-require "head_music/circle"
-require "head_music/clef"
-require "head_music/consonance"
-require "head_music/diatonic_interval"
-require "head_music/diatonic_interval/category"
-require "head_music/diatonic_interval/naming"
-require "head_music/diatonic_interval/parser"
-require "head_music/diatonic_interval/semitones"
-require "head_music/diatonic_interval/size"
-require "head_music/harmonic_interval"
-require "head_music/instrument_family"
-require "head_music/instrument"
-require "head_music/instrument/staff_scheme"
-require "head_music/instrument/staff"
-require "head_music/instrument/variant"
-require "head_music/interval_cycle"
-require "head_music/key_signature"
-require "head_music/key_signature/enharmonic_equivalence"
-require "head_music/letter_name"
-require "head_music/melodic_interval"
-require "head_music/meter"
-require "head_music/motion"
-require "head_music/musical_symbol"
-require "head_music/pitch"
-require "head_music/pitch/enharmonic_equivalence"
-require "head_music/pitch/octave_equivalence"
-require "head_music/pitch_class"
-require "head_music/pitch_class_set"
-require "head_music/pitch_set"
-require "head_music/quality"
-require "head_music/reference_pitch"
-require "head_music/register"
-require "head_music/rhythm"
-require "head_music/rhythmic_unit"
-require "head_music/scale"
-require "head_music/scale_degree"
-require "head_music/scale_type"
-require "head_music/solmization"
-require "head_music/sonority"
-require "head_music/spelling"
-require "head_music/staff"
-require "head_music/tuning"
+require "head_music/rudiment/alteration"
+require "head_music/rudiment/chromatic_interval"
+require "head_music/rudiment/circle"
+require "head_music/rudiment/clef"
+require "head_music/rudiment/consonance"
+require "head_music/rudiment/interval_cycle"
+require "head_music/rudiment/key_signature"
+require "head_music/rudiment/key_signature/enharmonic_equivalence"
+require "head_music/rudiment/letter_name"
+require "head_music/rudiment/meter"
+require "head_music/rudiment/musical_symbol"
+require "head_music/rudiment/pitch"
+require "head_music/rudiment/pitch/enharmonic_equivalence"
+require "head_music/rudiment/pitch/octave_equivalence"
+require "head_music/rudiment/pitch_class"
+require "head_music/rudiment/pitch_class_set"
+require "head_music/rudiment/pitch_set"
+require "head_music/rudiment/quality"
+require "head_music/rudiment/reference_pitch"
+require "head_music/rudiment/register"
+require "head_music/rudiment/rhythm"
+require "head_music/rudiment/rhythmic_unit"
+require "head_music/rudiment/scale"
+require "head_music/rudiment/scale_degree"
+require "head_music/rudiment/scale_type"
+require "head_music/rudiment/solmization"
+require "head_music/rudiment/sonority"
+require "head_music/rudiment/spelling"
+require "head_music/rudiment/tuning"
+
+# instruments
+require "head_music/instruments/instrument_family"
+require "head_music/instruments/instrument"
+require "head_music/instruments/staff_scheme"
+require "head_music/instruments/staff"
+require "head_music/instruments/variant"
 
 # content
 require "head_music/content/bar"
@@ -84,14 +76,26 @@ require "head_music/content/note"
 require "head_music/content/placement"
 require "head_music/content/position"
 require "head_music/content/rhythmic_value"
+require "head_music/content/staff"
 require "head_music/content/voice"
 
 # analysis
+require "head_music/analysis/diatonic_interval"
+require "head_music/analysis/diatonic_interval/category"
+require "head_music/analysis/diatonic_interval/naming"
+require "head_music/analysis/diatonic_interval/parser"
+require "head_music/analysis/diatonic_interval/semitones"
+require "head_music/analysis/diatonic_interval/size"
+require "head_music/analysis/harmonic_interval"
+require "head_music/analysis/melodic_interval"
+require "head_music/analysis/motion"
+
+# style analysis
 require "head_music/style/analysis"
 require "head_music/style/annotation"
 require "head_music/style/mark"
 
-# guidelines
+# style guidelines
 require "head_music/style/guidelines/always_move"
 require "head_music/style/guidelines/approach_perfection_contrarily"
 require "head_music/style/guidelines/at_least_eight_notes"
@@ -126,7 +130,7 @@ require "head_music/style/guidelines/step_to_final_note"
 require "head_music/style/guidelines/step_up_to_final_note"
 require "head_music/style/guidelines/up_to_fourteen_notes"
 
-# guides
+# style guides
 require "head_music/style/guides/fux_cantus_firmus"
 require "head_music/style/guides/modern_cantus_firmus"
 require "head_music/style/guides/first_species_melody"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 7.0.5
+  version: 8.0.0
 platform: ruby
 authors:
 - Rob Head
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2025-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,37 +120,30 @@ files:
 - bin/setup
 - head_music.gemspec
 - lib/head_music.rb
-- lib/head_music/alteration.rb
-- lib/head_music/chromatic_interval.rb
-- lib/head_music/circle.rb
-- lib/head_music/clef.rb
-- lib/head_music/consonance.rb
+- lib/head_music/analysis/diatonic_interval.rb
+- lib/head_music/analysis/diatonic_interval/category.rb
+- lib/head_music/analysis/diatonic_interval/naming.rb
+- lib/head_music/analysis/diatonic_interval/parser.rb
+- lib/head_music/analysis/diatonic_interval/semitones.rb
+- lib/head_music/analysis/diatonic_interval/size.rb
+- lib/head_music/analysis/harmonic_interval.rb
+- lib/head_music/analysis/melodic_interval.rb
+- lib/head_music/analysis/motion.rb
 - lib/head_music/content/bar.rb
 - lib/head_music/content/composition.rb
 - lib/head_music/content/note.rb
 - lib/head_music/content/placement.rb
 - lib/head_music/content/position.rb
 - lib/head_music/content/rhythmic_value.rb
+- lib/head_music/content/staff.rb
 - lib/head_music/content/voice.rb
-- lib/head_music/data/clefs.yml
-- lib/head_music/data/instrument_families.yml
-- lib/head_music/data/instruments.yml
-- lib/head_music/diatonic_interval.rb
-- lib/head_music/diatonic_interval/category.rb
-- lib/head_music/diatonic_interval/naming.rb
-- lib/head_music/diatonic_interval/parser.rb
-- lib/head_music/diatonic_interval/semitones.rb
-- lib/head_music/diatonic_interval/size.rb
-- lib/head_music/harmonic_interval.rb
-- lib/head_music/instrument.rb
-- lib/head_music/instrument/staff.rb
-- lib/head_music/instrument/staff_scheme.rb
-- lib/head_music/instrument/variant.rb
-- lib/head_music/instrument_family.rb
-- lib/head_music/interval_cycle.rb
-- lib/head_music/key_signature.rb
-- lib/head_music/key_signature/enharmonic_equivalence.rb
-- lib/head_music/letter_name.rb
+- lib/head_music/instruments/instrument.rb
+- lib/head_music/instruments/instrument_families.yml
+- lib/head_music/instruments/instrument_family.rb
+- lib/head_music/instruments/instruments.yml
+- lib/head_music/instruments/staff.rb
+- lib/head_music/instruments/staff_scheme.rb
+- lib/head_music/instruments/variant.rb
 - lib/head_music/locales/de.yml
 - lib/head_music/locales/en.yml
 - lib/head_music/locales/en_GB.yml
@@ -158,30 +151,38 @@ files:
 - lib/head_music/locales/fr.yml
 - lib/head_music/locales/it.yml
 - lib/head_music/locales/ru.yml
-- lib/head_music/melodic_interval.rb
-- lib/head_music/meter.rb
-- lib/head_music/motion.rb
-- lib/head_music/musical_symbol.rb
 - lib/head_music/named.rb
-- lib/head_music/pitch.rb
-- lib/head_music/pitch/enharmonic_equivalence.rb
-- lib/head_music/pitch/octave_equivalence.rb
-- lib/head_music/pitch_class.rb
-- lib/head_music/pitch_class_set.rb
-- lib/head_music/pitch_set.rb
-- lib/head_music/quality.rb
-- lib/head_music/reference_pitch.rb
-- lib/head_music/register.rb
-- lib/head_music/rhythm.rb
-- lib/head_music/rhythmic_unit.rb
-- lib/head_music/scale.rb
-- lib/head_music/scale_degree.rb
-- lib/head_music/scale_type.rb
-- lib/head_music/solmization.rb
-- lib/head_music/solmizations.yml
-- lib/head_music/sonority.rb
-- lib/head_music/spelling.rb
-- lib/head_music/staff.rb
+- lib/head_music/rudiment/alteration.rb
+- lib/head_music/rudiment/chromatic_interval.rb
+- lib/head_music/rudiment/circle.rb
+- lib/head_music/rudiment/clef.rb
+- lib/head_music/rudiment/clefs.yml
+- lib/head_music/rudiment/consonance.rb
+- lib/head_music/rudiment/interval_cycle.rb
+- lib/head_music/rudiment/key_signature.rb
+- lib/head_music/rudiment/key_signature/enharmonic_equivalence.rb
+- lib/head_music/rudiment/letter_name.rb
+- lib/head_music/rudiment/meter.rb
+- lib/head_music/rudiment/musical_symbol.rb
+- lib/head_music/rudiment/pitch.rb
+- lib/head_music/rudiment/pitch/enharmonic_equivalence.rb
+- lib/head_music/rudiment/pitch/octave_equivalence.rb
+- lib/head_music/rudiment/pitch_class.rb
+- lib/head_music/rudiment/pitch_class_set.rb
+- lib/head_music/rudiment/pitch_set.rb
+- lib/head_music/rudiment/quality.rb
+- lib/head_music/rudiment/reference_pitch.rb
+- lib/head_music/rudiment/register.rb
+- lib/head_music/rudiment/rhythm.rb
+- lib/head_music/rudiment/rhythmic_unit.rb
+- lib/head_music/rudiment/scale.rb
+- lib/head_music/rudiment/scale_degree.rb
+- lib/head_music/rudiment/scale_type.rb
+- lib/head_music/rudiment/solmization.rb
+- lib/head_music/rudiment/solmizations.yml
+- lib/head_music/rudiment/sonority.rb
+- lib/head_music/rudiment/spelling.rb
+- lib/head_music/rudiment/tuning.rb
 - lib/head_music/style/analysis.rb
 - lib/head_music/style/annotation.rb
 - lib/head_music/style/guidelines/always_move.rb
@@ -222,7 +223,6 @@ files:
 - lib/head_music/style/guides/fux_cantus_firmus.rb
 - lib/head_music/style/guides/modern_cantus_firmus.rb
 - lib/head_music/style/mark.rb
-- lib/head_music/tuning.rb
 - lib/head_music/utilities/hash_key.rb
 - lib/head_music/version.rb
 homepage: https://github.com/roberthead/head_music
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: The rudiments of western music theory.

data/lib/head_music/rhythm.rb

@@ -1,3 +0,0 @@
-module HeadMusic::Rhythm
-  PPQN = PULSES_PER_QUARTER_NOTE = 960
-end