head_music 7.0.5 → 8.0.1

data/lib/head_music/{instrument.rb → instruments/instrument.rb}

@@ -1,3 +1,6 @@
+# Namespace for instrument definitions, categorization, and configuration
+module HeadMusic::Instruments; end
+
 # A musical instrument.
 # An instrument object can be assigned to a staff object.
 # Attributes:
@@ -14,17 +17,17 @@
 # Associations:
 #   family: the family of the instrument (e.g. "saxophone")
 #   orchestra_section: the section of the orchestra (e.g. "strings")
-class HeadMusic::Instrument
+class HeadMusic::Instruments::Instrument
   include HeadMusic::Named
 
-  INSTRUMENTS = YAML.load_file(File.expand_path("data/instruments.yml", __dir__)).freeze
+  INSTRUMENTS = YAML.load_file(File.expand_path("instruments.yml", __dir__)).freeze
 
   def self.get(name)
     get_by_name(name)
   end
 
   def self.all
-    HeadMusic::InstrumentFamily.all
+    HeadMusic::Instruments::InstrumentFamily.all
     @all ||=
       INSTRUMENTS.map { |key, _data| get(key) }.sort_by { |instrument| instrument.name.downcase }
   end
@@ -48,7 +51,7 @@ class HeadMusic::Instrument
   def family
     return unless family_key
 
-    HeadMusic::InstrumentFamily.get(family_key)
+    HeadMusic::Instruments::InstrumentFamily.get(family_key)
   end
 
   # Returns true if the instrument sounds at a different pitch than written.
@@ -70,7 +73,7 @@ class HeadMusic::Instrument
   end
 
   def pitched?
-    return false if default_clefs.compact.uniq == [HeadMusic::Clef.get("neutral_clef")]
+    return false if default_clefs.compact.uniq == [HeadMusic::Rudiment::Clef.get("neutral_clef")]
 
     default_clefs.any?
   end
@@ -139,7 +142,7 @@ class HeadMusic::Instrument
 
   def initialize_family(record)
     @family_key = record["family_key"]
-    @family = HeadMusic::InstrumentFamily.get(family_key)
+    @family = HeadMusic::Instruments::InstrumentFamily.get(family_key)
   end
 
   def inherit_family_attributes(record)
@@ -160,7 +163,7 @@ class HeadMusic::Instrument
     @classification_keys = [@classification_keys, record["classification_keys"]].flatten.compact.uniq
     @variants =
       (record["variants"] || {}).map do |key, attributes|
-        HeadMusic::Instrument::Variant.new(key, attributes)
+        HeadMusic::Instruments::Variant.new(key, attributes)
       end
   end
 

data/lib/head_music/{data → instruments}/instrument_families.yml

@@ -47,7 +47,12 @@ cymbal:
   classification_keys:
     - percussion
     - idiophone
+    - unpitched
   orchestra_section_key: percussion
+didgeridoo:
+  classification_keys:
+    - aerophone
+    - wind
 double_bass:
   classification_keys:
     - bowed
@@ -69,11 +74,13 @@ glockenspiel:
     - struck
     - metal
     - mallet
+    - pitched
   orchestra_section_key: percussion
 gong:
   classification_keys:
     - percussion
     - idiophone
+    - unpitched
   orchestra_section_key: percussion
 guitar:
   classification_keys:
@@ -81,6 +88,13 @@ guitar:
     - plucked
     - string
   orchestra_section_key: string
+harmonica:
+  classification_keys:
+    - reed
+    - free-reed
+    - aerophone
+    - wind
+  orchestra_section_key: woodwind
 harp:
   classification_keys:
     - chordophone
@@ -104,6 +118,7 @@ kettledrum:
   classification_keys:
     - percussion
     - membranophone
+    - pitched
   orchestra_section_key: percussion
 lute:
   classification_keys:
@@ -125,6 +140,7 @@ marimba:
     - struck
     - wood
     - mallet
+    - pitched
   orchestra_section_key: percussion
 oboe:
   classification_keys:
@@ -166,16 +182,40 @@ saxophone:
     - wind
     - woodwind
   orchestra_section_key: woodwind
+sitar:
+  classification_keys:
+    - chordophone
+    - plucked
+    - string
+  orchestra_section_key: string
 snare_drum:
   classification_keys:
     - percussion
     - membranophone
+    - unpitched
+  orchestra_section_key: percussion
+steelpan:
+  classification_keys:
+    - percussion
+    - idiophone
+    - struck
+    - metal
+    - pitched
   orchestra_section_key: percussion
 synthesizer:
   classification_keys:
     - electronic
     - keyboard
   orchestra_section_key: keyboard
+tabla:
+  classification_keys:
+    - percussion
+    - membranophone
+    - pitched
+  orchestra_section_key: percussion
+theremin:
+  classification_keys:
+    - electronic
 trombone:
   classification_keys:
     - aerophone
@@ -194,6 +234,12 @@ tuba:
     - brass
     - wind
   orchestra_section_key: brass
+ukulele:
+  classification_keys:
+    - chordophone
+    - plucked
+    - string
+  orchestra_section_key: string
 vibraphone:
   classification_keys:
     - percussion
@@ -202,6 +248,7 @@ vibraphone:
     - keyboard
     - mallet
     - metal
+    - pitched
   orchestra_section_key: percussion
 violin:
   classification_keys:
@@ -218,6 +265,7 @@ woodblock:
     - percussion
     - struck
     - idiophone
+    - unpitched
   orchestra_section_key: percussion
 xylophone:
   classification_keys:
@@ -227,4 +275,5 @@ xylophone:
     - keyboard
     - mallet
     - wood
+    - pitched
   orchestra_section_key: percussion

data/lib/head_music/{instrument_family.rb → instruments/instrument_family.rb}

@@ -1,12 +1,15 @@
+# Namespace for instrument definitions, categorization, and configuration
+module HeadMusic::Instruments; end
+
 # An *InstrumentFamily* is a species of instrument
 # that may exist in a variety of keys or other variations.
 # For example, _saxophone_ is an instrument family, while
 # _alto saxophone_ and _baritone saxophone_ are specific instruments.
-class HeadMusic::InstrumentFamily
+class HeadMusic::Instruments::InstrumentFamily
   include HeadMusic::Named
 
   INSTRUMENT_FAMILIES =
-    YAML.load_file(File.expand_path("data/instrument_families.yml", __dir__)).freeze
+    YAML.load_file(File.expand_path("instrument_families.yml", __dir__)).freeze
 
   attr_reader :name_key, :classification_keys, :orchestra_section_key
   attr_accessor :name

data/lib/head_music/{data → instruments}/instruments.yml

@@ -458,6 +458,13 @@ cymbal:
       staff_schemes:
         default:
           - clef: neutral_clef
+didgeridoo:
+  family_key: didgeridoo
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: neutral_clef
 double_bass:
   alias_name_keys:
     - contrabass
@@ -561,6 +568,15 @@ hammered_dulcimer:
         default:
           - clef: treble_clef
   orchestra_section_key: percussion
+harmonica:
+  alias_name_keys:
+    - mouth_organ
+  family_key: harmonica
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
 harp:
   family_key: harp
   variants:
@@ -963,6 +979,13 @@ subcontrabass_saxophone:
             sounding_transposition: -38
   range_categories:
     - subcontrabass
+sitar:
+  family_key: sitar
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
 snare_drum:
   alias_name_keys:
     - side_drum
@@ -997,6 +1020,15 @@ sousaphone:
             sounding_transposition: 0
   range_categories:
     - bass
+steelpan:
+  alias_name_keys:
+    - steel_drum
+  family_key: steelpan
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
 suspended_cymbal:
   family_key: cymbal
   variants:
@@ -1005,6 +1037,8 @@ suspended_cymbal:
         default:
           - clef: neutral_clef
 synthesizer:
+  alias_name_keys:
+    - electronic_keyboard
   family_key: synthesizer
   variants:
     default:
@@ -1014,6 +1048,13 @@ synthesizer:
             name_key: right_hand
           - clef: bass_clef
             name_key: left_hand
+tabla:
+  family_key: tabla
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: neutral_clef
 tam_tam:
   alias_name_keys:
     - gong
@@ -1069,6 +1110,13 @@ tenor_voice:
             sounding_transposition: -12
   range_categories:
     - tenor
+theremin:
+  family_key: theremin
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
 timpani:
   alias_name_keys:
     - kettledrum
@@ -1148,6 +1196,74 @@ tuba:
       staff_schemes:
         default:
           - clef: bass_clef
+ukulele:
+  alias_name_keys:
+    - soprano_ukulele
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
+  range_categories:
+    - soprano
+    - alto
+pocket_ukulele:
+  alias_name_keys:
+    - sopranino_ukulele
+    - piccolo_ukulele
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
+  range_categories:
+    - sopranino
+    - soprano
+concert_ukulele:
+  alias_name_keys:
+    - alto_ukulele
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
+  range_categories:
+    - soprano
+    - alto
+tenor_ukulele:
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
+  range_categories:
+    - tenor
+baritone_ukulele:
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: treble_clef
+  range_categories:
+    - alto
+    - tenor
+    - baritone
+bass_ukulele:
+  family_key: ukulele
+  variants:
+    default:
+      staff_schemes:
+        default:
+          - clef: bass_clef
+  range_categories:
+    - bass
+    - baritone
+    - tenor
 vibraphone:
   alias_name_keys:
     - vibes

data/lib/head_music/{instrument → instruments}/staff.rb

@@ -1,4 +1,7 @@
-class HeadMusic::Instrument::Staff
+# Namespace for instrument definitions, categorization, and configuration
+module HeadMusic::Instruments; end
+
+class HeadMusic::Instruments::Staff
   DEFAULT_CLEF = "treble_clef"
 
   attr_reader :staff_scheme, :attributes
@@ -9,7 +12,7 @@ class HeadMusic::Instrument::Staff
   end
 
   def clef
-    HeadMusic::Clef.get(smart_clef_key)
+    HeadMusic::Rudiment::Clef.get(smart_clef_key)
   end
 
   def smart_clef_key

data/lib/head_music/{instrument → instruments}/staff_scheme.rb

@@ -1,4 +1,9 @@
-class HeadMusic::Instrument::StaffScheme
+require_relative "staff"
+
+# Namespace for instrument definitions, categorization, and configuration
+module HeadMusic::Instruments; end
+
+class HeadMusic::Instruments::StaffScheme
   attr_reader :variant, :key, :list
 
   def initialize(variant:, key:, list:)
@@ -13,7 +18,7 @@ class HeadMusic::Instrument::StaffScheme
 
   def staves
     @staves ||= list.map do |attributes|
-      HeadMusic::Instrument::Staff.new(self, attributes)
+      HeadMusic::Instruments::Staff.new(self, attributes)
     end
   end
 end

data/lib/head_music/{instrument → instruments}/variant.rb

@@ -1,4 +1,7 @@
-class HeadMusic::Instrument::Variant
+# Namespace for instrument definitions, categorization, and configuration
+module HeadMusic::Instruments; end
+
+class HeadMusic::Instruments::Variant
   attr_reader :key, :attributes
 
   def initialize(key, attributes = {})
@@ -10,13 +13,13 @@ class HeadMusic::Instrument::Variant
     return unless attributes["pitch_designation"].to_s != ""
 
     @pitch_designation ||=
-      HeadMusic::Spelling.get(attributes["pitch_designation"])
+      HeadMusic::Rudiment::Spelling.get(attributes["pitch_designation"])
   end
 
   def staff_schemes
     @staff_schemes ||=
       (attributes["staff_schemes"] || {}).map do |key, list|
-        HeadMusic::Instrument::StaffScheme.new(
+        HeadMusic::Instruments::StaffScheme.new(
           key: key,
           variant: self,
           list: list

data/lib/head_music/locales/en.yml

@@ -86,6 +86,7 @@ en:
       mezzo_soprano_voice: mezzo-soprano
       percussion: percussion
       percussion_instrument: percussion instrument
+      pitched: pitched
       plucked: plucked
       plucked_instrument: plucked instrument
       reed: reed
@@ -95,6 +96,7 @@ en:
       stringed_instrument: stringed instrument
       strings: strings
       struck: struck
+      unpitched: unpitched
       voice: voice
       wind: wind
       wind_instrument: wind instrument
@@ -119,6 +121,7 @@ en:
       alto_flute: alto flute
       alto_recorder: alto recorder
       alto_saxophone: alto saxophone
+      alto_ukulele: alto ukulele
       alto_voice: alto
       arpeggione: arpeggione
       bagpipe: bagpipe
@@ -126,6 +129,7 @@ en:
       baritone_horn: baritone horn
       baritone_oboe: baritone oboe
       baritone_saxophone: baritone saxophone
+      baritone_ukulele: baritone ukulele
       baritone_voice: baritone
       bass: bass
       bass_clarinet: bass clarinet
@@ -137,6 +141,7 @@ en:
       bass_trombone: bass trombone
       bass_trumpet: bass trumpet
       bass_tuba: bass tuba
+      bass_ukulele: bass ukulele
       bass_voice: bass
       basset_horn: basset horn
       basset_recorder: basset recorder
@@ -154,6 +159,7 @@ en:
       clavichord: clavichord
       concert_bells: concert bells
       concert_cymbals: concert cymbals
+      concert_ukulele: concert ukulele
       contra_great_bass_recorder: contra-great bass recorder
       contrabass: contrabass
       contrabass_clarinet: contrabass clarinet
@@ -171,8 +177,10 @@ en:
       crotales: crotales
       cymbal: cymbal
       descant: descant
+      didgeridoo: didgeridoo
       double_bass: double bass
       double_contrabass_recorder: double-contrabass recorder
+      electronic_keyboard: electronic keyboard
       english_horn: English horn
       euphonium: euphonium
       fiddle: fiddle
@@ -188,6 +196,7 @@ en:
       great_highland_bagpipe: great highland bagpipe
       guitar: guitar
       hammered_dulcimer: hammered dulcimer
+      harmonica: harmonica
       harp: harp
       harpsichord: harpsichord
       hautbois_d_amour: hautbois d'amour
@@ -204,6 +213,7 @@ en:
       mezzo_soprano: mezzo-soprano
       mezzo_soprano_voice: mezzo-soprano
       military_drum: military drum
+      mouth_organ: mouth_organ
       natural_horn: natural horn
       oboe: oboe
       oboe_d_amore: oboe d'amore
@@ -219,25 +229,33 @@ en:
       piccolo_recorder: piccolo recorder
       piccolo_saxophone: piccolo saxophone
       piccolo_trumpet: piccolo trumpet
+      piccolo_ukulele: piccolo ukulele
       pipe_organ: pipe organ
+      pocket_trumpet: pocket trumpet
+      pocket_ukulele: pocket ukulele
       quart_bass_recorder: quart bass recorder
       recorder: recorder
       ride_cymbal: ride cymbal
       saxophone: saxophone
       side_drum: side drum
+      sitar: sitar
       snare_drum: snare drum
       sopranino_clarinet: sopranino clarinet
       sopranino_recorder: sopranino recorder
       sopranino_saxophone: sopranino saxophone
+      sopranino_ukulele: sopranino ukulele
       sopranissimo_recorder: sopranissimo recorder
       sopranissimo_saxophone: sopranissimo saxophone
       soprano: soprano
       soprano_clarinet: soprano clarinet
       soprano_recorder: soprano recorder
       soprano_saxophone: soprano saxophone
+      soprano_ukulele: soprano ukulele
       soprano_voice: soprano
       soprillo: soprillo
       sousaphone: sousaphone
+      steelpan: steelpan
+      steel_drum: steel drum
       string_bass: string bass
       sub_bass_recorder: sub-bass recorder
       sub_contrabass_recorder: sub-contrabass recorder
@@ -245,6 +263,7 @@ en:
       subcontrabass_saxophone: subcontrabass saxophone
       suspended_cymbal: suspended cymbal
       synthesizer: synthesizer
+      tabla: tabla
       tabor: tabor
       tam_tam: tam-tam
       tambourine: tambourine
@@ -255,7 +274,9 @@ en:
       tenor_saxophone: tenor saxophone
       tenor_trombone: tenor trombone
       tenor_tuba: tenor tuba
+      tenor_ukulele: tenor ukulele
       tenor_voice: tenor
+      theremin: theremin
       timpani: timpani
       timpanum: timpanum
       tom_drum: tom drum
@@ -266,6 +287,7 @@ en:
       trumpet: trumpet
       tuba: tuba
       tubular_bells: tubular bells
+      ukulele: ukulele
       vibes: vibes
       vibraphone: vibraphone
       viola: viola

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

@@ -1,8 +1,11 @@
-require "head_music/musical_symbol"
+require "head_music/rudiment/musical_symbol"
 
-# A Alteration is a symbol that modifies pitch, such as a sharp, flat, or natural.
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
+# An Alteration is a symbol that modifies pitch, such as a sharp, flat, or natural.
 # In French, sharps and flats in the key signature are called "altérations".
-class HeadMusic::Alteration
+class HeadMusic::Rudiment::Alteration
   include Comparable
 
   attr_reader :identifier, :cents, :musical_symbols
@@ -51,7 +54,7 @@ class HeadMusic::Alteration
   end
 
   def self.get(identifier)
-    return identifier if identifier.is_a?(HeadMusic::Alteration)
+    return identifier if identifier.is_a?(HeadMusic::Rudiment::Alteration)
 
     all.detect do |alteration|
       alteration.representions.include?(identifier)
@@ -86,7 +89,7 @@ class HeadMusic::Alteration
   end
 
   def <=>(other)
-    other = HeadMusic::Alteration.get(other)
+    other = HeadMusic::Rudiment::Alteration.get(other)
     cents <=> other.cents
   end
 
@@ -104,7 +107,7 @@ class HeadMusic::Alteration
 
   def initialize_musical_symbols(list)
     @musical_symbols = (list || []).map do |record|
-      HeadMusic::MusicalSymbol.new(
+      HeadMusic::Rudiment::MusicalSymbol.new(
         unicode: record[:unicode],
         ascii: record[:ascii],
         html_entity: record[:html_entity]

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

@@ -1,5 +1,8 @@
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
 # A chromatic interval is the distance between two pitches measured in half-steps.
-class HeadMusic::ChromaticInterval
+class HeadMusic::Rudiment::ChromaticInterval
   include Comparable
   include HeadMusic::Named
 
@@ -37,7 +40,7 @@ class HeadMusic::ChromaticInterval
   end
 
   def simple
-    HeadMusic::ChromaticInterval.get(semitones % 12)
+    HeadMusic::Rudiment::ChromaticInterval.get(semitones % 12)
   end
 
   def simple?
@@ -60,11 +63,11 @@ class HeadMusic::ChromaticInterval
   alias_method :specific_interval, :semitones
 
   def +(other)
-    HeadMusic::ChromaticInterval.get(to_i + other.to_i)
+    HeadMusic::Rudiment::ChromaticInterval.get(to_i + other.to_i)
   end
 
   def -(other)
-    HeadMusic::ChromaticInterval.get((to_i - other.to_i).abs)
+    HeadMusic::Rudiment::ChromaticInterval.get((to_i - other.to_i).abs)
   end
 
   def <=>(other)

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

@@ -1,10 +1,13 @@
 require "yaml"
 
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
 # A clef assigns pitches to the lines and spaces of a staff.
-class HeadMusic::Clef
+class HeadMusic::Rudiment::Clef
   include HeadMusic::Named
 
-  RECORDS = YAML.load_file(File.expand_path("data/clefs.yml", __dir__)).freeze
+  RECORDS = YAML.load_file(File.expand_path("clefs.yml", __dir__)).freeze
 
   def self.get(name)
     get_by_name(name)
@@ -82,7 +85,7 @@ class HeadMusic::Clef
 
   def initialize_data_from_record(record)
     initialize_keys_from_record(record)
-    @pitch = HeadMusic::Pitch.get(record[:pitch])
+    @pitch = HeadMusic::Rudiment::Pitch.get(record[:pitch])
     @line = record[:line]
     @modern = record[:modern]
     initialize_musical_symbols(record[:symbols])
@@ -95,7 +98,7 @@ class HeadMusic::Clef
 
   def initialize_musical_symbols(list)
     @musical_symbols = (list || []).map do |symbol_data|
-      HeadMusic::MusicalSymbol.new(**symbol_data.slice(:ascii, :html_entity, :unicode))
+      HeadMusic::Rudiment::MusicalSymbol.new(**symbol_data.slice(:ascii, :html_entity, :unicode))
     end
   end
 end

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

@@ -1,5 +1,8 @@
+# A module for music rudiments
+module HeadMusic::Rudiment; end
+
 # Consonance describes a category or degree of harmonic pleasantness: perfect, imperfect, or dissonant
-class HeadMusic::Consonance
+class HeadMusic::Rudiment::Consonance
   LEVELS = %w[perfect imperfect dissonant].freeze
 
   def self.get(name)