head_music 0.23.3 → 0.24.3

data/lib/head_music/locales/en_GB.yml

@@ -0,0 +1,3 @@
+en_GB:
+  rudiments:
+    grand_staff: great staff

data/lib/head_music/locales/es.yml

@@ -0,0 +1,53 @@
+es:
+  rudiments:
+    clef: clave
+    consonance: consonancia
+  clefs:
+    alto_clef: clave contralto
+    baritone_c_clef: clave de barítono
+    baritone_clef: clave de barítono
+    baritone_f_clef: clave de fa en tercera
+    bass_clef: clave de bajo
+    c_clef: clave de do
+    choral_tenor_clef: choral tenor clef
+    contrabass_clef: clave de contrabajo
+    countertenor_clef: clave de contratenor
+    double_treble_clef: double clave de sol
+    drum_clef: clave para percusión
+    f_clef: clave de fa
+    fifth_line_c_clef: clave de do en quinta
+    fifth_line_f_clef: clave de fa en quinta
+    first_line_c_clef: clave de do en primera
+    first_line_g_clef: clave de sol en primera
+    fourth_line_c_clef: clave de do en cuarta
+    fourth_line_f_clef: clave de fa en cuarta
+    french_clef: clave de sol en primera
+    french_violin_clef: clave de sol en primera
+    g_clef: clave de sol
+    indefinite_pitch_clef: clave neutral
+    mezzo_soprano_clef: clave de mezzosoprano
+    neutral_clef: clave neutral
+    percussion_clef: clave para percusión
+    second_line_c_clef: clave de do en segunda
+    second_line_g_clef: clave de sol en segunda
+    soprano_clef: clave de soprano
+    sub_bass_clef: clave de fa en quinta
+    tenor_c_clef: clave de do en cuarta
+    tenor_clef: clave de tenor
+    tenor_g_clef: clave de sol en segunda
+    third_line_c_clef: clave de do en tercera
+    third_line_f_clef: clave de fa en tercera
+    treble_clef: clave de sol
+    viola_clef: clave de do
+    violin_clef: clave de sol
+  instruments:
+    accordian: acordeóon
+    alto_flute: flauta alto
+    alto_voice: contralto
+    bagpipe: gaita
+    baritone_voice: baritono
+    bass_voice: bajo
+    guitar: guitarra
+    piano: piano
+    viola: viola
+    violin: violín

data/lib/head_music/locales/fr.yml

@@ -0,0 +1,57 @@
+fr:
+  rudiments:
+    clef: clé
+  clefs:
+    alto_clef: clé alto
+    baritone_c_clef: clé de baryton
+    baritone_clef: clé de baryton
+    baritone_f_clef: clé de fa 3e
+    bass_clef: clé de basse
+    c_clef: clé d'ut
+    choral_tenor_clef: choral tenor clef
+    contrabass_clef: clé de contrebasse
+    countertenor_clef: clé de contre-ténor
+    double_treble_clef: double clé de sol
+    drum_clef: clé de tambour
+    f_clef: clé de fa
+    fifth_line_c_clef: clé d'ut 5e
+    fifth_line_f_clef: clé de fa 5e
+    first_line_c_clef: clé d'ut 1re
+    first_line_g_clef: clé de sol 1re
+    fourth_line_c_clef: clé d'ut 4e
+    fourth_line_f_clef: clé de fa 4e
+    french_clef: clé de sol 1re
+    french_violin_clef: clé de sol 1re
+    g_clef: clé de sol
+    indefinite_pitch_clef: clé à pas indéfini
+    mezzo_soprano_clef: clé de mezzo-soprano
+    neutral_clef: clé neutre
+    percussion_clef: clé de percussion
+    second_line_c_clef: clé d'ut 2e
+    second_line_g_clef: clé de sol 2e
+    soprano_clef: clé de soprano
+    sub_bass_clef: clé de fa 5e
+    tenor_c_clef: clé d'ut 4e
+    tenor_clef: clé de ténor
+    tenor_g_clef: clé de sol 2e
+    third_line_c_clef: clé d'ut 3e
+    third_line_f_clef: clé de fa 3e
+    treble_clef: clé de sol
+    viola_clef: clé d'ut
+    violin_clef: clé de sol
+  instruments:
+    accordian: accordéon
+    alto_flute: flûte alto
+    alto_voice: alto
+    bagpipe: cornemuse
+    baritone_voice: baryton
+    bass_clarinet: clarinette basse
+    bass_voice: basse
+    piano: piano
+    viola: alto
+    violin: violon
+  instrument_voices:
+    alto: alto
+    baritone: baryton
+    bass: basse
+    guitar: guitare

data/lib/head_music/locales/it.yml

@@ -0,0 +1,58 @@
+it:
+  rudiments:
+    clef: chiave
+    consonance: consonanza
+  clefs:
+    alto_clef: chiave di contralto
+    baritone_c_clef: chiave di baritono
+    baritone_clef: chiave di baritono
+    baritone_f_clef: chiave di baritono
+    bass_clef: chiave di basso
+    c_clef: chiave di do
+    choral_tenor_clef: chiave di sol in ottava
+    contrabass_clef: chiave di contrabbasso
+    countertenor_clef: chiave di controtenore
+    double_treble_clef: chiave di sol in ottava
+    drum_clef: chiave di percussione
+    f_clef: chiave di fa
+    fifth_line_c_clef: chiave di do sulla 5ª linea
+    fifth_line_f_clef: chiave di fa sulla 5ª linea
+    first_line_c_clef: chiave di do sulla 1ª linea
+    first_line_g_clef: chiave di sol sulla 1ª linea
+    fourth_line_c_clef: chiave di do sulla 4ª linea
+    fourth_line_f_clef: chiave di fa sulla 4ª linea
+    french_clef: chiave di violino francese
+    french_violin_clef: chiave di violino francese
+    g_clef: chiave di sol
+    indefinite_pitch_clef: chiave neutra
+    mezzo_soprano_clef: chiave di mezzosoprano
+    neutral_clef: chiave neutra
+    percussion_clef: chiave di percussione
+    second_line_c_clef: chiave di do sulla 2ª linea
+    second_line_g_clef: chiave di sol sulla 2ª linea
+    soprano_clef: chiave di soprano
+    sub_bass_clef: chiave di subbasso
+    tenor_c_clef: chiave di tenore
+    tenor_clef: chiave di tenore
+    tenor_g_clef: chiave di sol in ottava
+    third_line_c_clef: chiave di do sulla 3ª linea
+    third_line_f_clef: chiave di fa sulla 3ª linea
+    treble_clef: chiave di violino
+    viola_clef: chiave di viola
+    violin_clef: chiave di violino
+  instruments:
+    accordian: fisarmonica
+    alto_flute: flauto contralto
+    alto_voice: contralto
+    bagpipe: cornamusa
+    baritone_voice: baritono
+    bass_voice: basso
+    guitar: chitarra
+    piccolo: ottavino
+    piano: piano
+    viola: viola
+    violin: violino
+  instrument_voices:
+    alto: contralto
+    baritone: baritono
+    bass: basso

data/lib/head_music/named.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# NameRudiment is a module to be included in classes whose instances may be identified by name.
+module HeadMusic::Named
+  delegate :to_s, to: :name
+
+  # Locale encapsulates a language and optional region or country.
+  class Locale
+    DEFAULT_CODE = :en_US
+
+    attr_reader :language, :region
+
+    def self.default_locale
+      get(DEFAULT_CODE)
+    end
+
+    def self.get(code)
+      @locales ||= {}
+      parts = code.to_s.split(/[_\-]/)
+      language = parts[0].downcase
+      region = parts[1]&.upcase
+      key = [language, region].compact.join('_').to_sym
+      @locales[key] ||= new(language: language, region: region)
+    end
+
+    def initialize(language:, region: nil)
+      @language = language
+      @region = region
+    end
+
+    def code
+      @code ||= [@language, @region].compact.join('_')
+    end
+
+    private_class_method :new
+  end
+
+  # A LocalizedName is the name of a rudiment in a locale.
+  class LocalizedName
+    attr_reader :locale, :name, :abbreviation
+
+    delegate :code, to: :locale, prefix: true
+    delegate :language, :region, to: :locale
+
+    def initialize(name:, locale_code: Locale::DEFAULT_CODE, abbreviation: nil)
+      @name = name
+      @locale = Locale.get(locale_code)
+      @abbreviation = abbreviation
+    end
+  end
+
+  # Adds .get_by_name to the including class.
+  module ClassMethods
+    def get_by_name(name)
+      name = name.to_s
+      @instances ||= {}
+      key = HeadMusic::Utilities::HashKey.for(name)
+      @instances[key] ||= new(name)
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  attr_reader :name_key, :alias_name_keys
+
+  def name=(name)
+    ensure_localized_name(name: name)
+  end
+
+  def name(locale_code: Locale::DEFAULT_CODE)
+    localized_name(locale_code: locale_code)&.name
+  end
+
+  def localized_name(locale_code: Locale::DEFAULT_CODE)
+    locale = Locale.get(locale_code || Locale::DEFAULT_CODE)
+    localized_name_in_matching_locale(locale) ||
+      localized_name_in_locale_matching_language(locale) ||
+      localized_name_in_default_locale ||
+      localized_names.first
+  end
+
+  def ensure_localized_name(name:, locale_code: Locale::DEFAULT_CODE, abbreviation: nil)
+    @localized_names ||= []
+    @localized_names << LocalizedName.new(name: name, locale_code: locale_code, abbreviation: abbreviation)
+    @localized_names.uniq!
+  end
+
+  # Returns an array of LocalizedName instances that are synonymous with the name.
+  def localized_names
+    @localized_names ||= []
+  end
+
+  private
+
+  def localized_name_in_matching_locale(locale)
+    localized_names.detect { |candidate| candidate.locale_code == locale.code }
+  end
+
+  def localized_name_in_locale_matching_language(locale)
+    localized_names.detect { |candidate| candidate.language == locale.language }
+  end
+
+  def localized_name_in_default_locale
+    localized_names.detect { |name| name.locale_code == Locale::DEFAULT_CODE }
+  end
+
+  def hash_key
+    HeadMusic::Utilities::HashKey.for(name)
+  end
+end

data/lib/head_music/octave.rb

@@ -31,6 +31,7 @@ class HeadMusic::Octave
   end
 
   attr_reader :number
+
   delegate :to_i, :to_s, to: :number
 
   def initialize(number)

data/lib/head_music/pitch.rb

@@ -21,8 +21,17 @@ class HeadMusic::Pitch
   delegate :enharmonic_equivalent?, :enharmonic?, to: :enharmonic_equivalence
   delegate :octave_equivalent?, to: :octave_equivalence
 
+  # Fetches a pitch identified by the information passed in.
+  #
+  # Accepts:
+  #   - a Pitch instance
+  #   - a PitchClass instance
+  #   - a name string, such as 'Ab4'
+  #   - a number corresponding to the midi note number
   def self.get(value)
-    from_pitch_class(value) || from_name(value) || from_number(value)
+    from_pitch_class(value) ||
+      from_name(value) ||
+      from_number(value)
   end
 
   def self.middle_c
@@ -48,9 +57,7 @@ class HeadMusic::Pitch
   def self.from_number(number)
     return nil unless number == number.to_i
 
-    spelling = HeadMusic::Spelling.from_number(number)
-    octave = (number.to_i / 12) - 1
-    fetch_or_create(spelling, octave)
+    fetch_or_create(HeadMusic::Spelling.from_number(number), (number.to_i / 12) - 1)
   end
 
   def self.from_number_and_letter(number, letter_name)

data/lib/head_music/pitch_class.rb

@@ -7,8 +7,8 @@ class HeadMusic::PitchClass
   attr_reader :number
   attr_reader :spelling
 
-  SHARP_SPELLINGS = %w[C C# D D# E F F# G G# A A# B].freeze
-  FLAT_SPELLINGS = %w[C Db D Eb E F Gb G Ab A Bb B].freeze
+  SHARP_SPELLINGS = %w[C C♯ D D♯ E F F♯ G G♯ A A♯ B].freeze
+  FLAT_SPELLINGS = %w[C D♭ D E♭ E F G♭ G A♭ A B♭ B].freeze
   INTEGER_NOTATION = %w[0 1 2 3 4 5 6 7 8 9 t e].freeze
 
   def self.get(identifier)

data/lib/head_music/quality.rb

@@ -44,6 +44,7 @@ class HeadMusic::Quality
   end
 
   attr_reader :name
+
   delegate :to_s, to: :name
 
   def initialize(name)

data/lib/head_music/reference_pitch.rb

@@ -3,48 +3,77 @@
 # A reference pitch has a pitch and a frequency
 # With no arguments, it assumes that A4 = 440.0 Hz
 class HeadMusic::ReferencePitch
-  include HeadMusic::NamedRudiment
+  include HeadMusic::Named
 
   DEFAULT_PITCH_NAME = 'A4'
   DEFAULT_FREQUENCY = 440.0
+  DEFAULT_REFERENCE_PITCH_NAME = 'A440'
 
   NAMED_REFERENCE_PITCHES = [
-    { name: 'Baroque', pitch: 'A4', frequency: 415.0 },
-    { name: 'Classical', pitch: 'A4', frequency: 430.0 },
-    { name: 'Scientific', pitch: 'C4', frequency: 256.0 },
-    { name: 'Verdi', pitch: 'A4', frequency: 432.0 }, # Pythagorean tuning
-    { name: 'French', pitch: 'A4', frequency: 435.0 },
-    { name: 'New Philharmonic', pitch: 'A4', frequency: 439.0 },
-    { name: 'A440', pitch: 'A4', frequency: 440.0 },
-    { name: 'Sydney Symphony Orchestra', pitch: 'A4', frequency: 441.0 },
-    { name: 'New York Philharmonic', pitch: 'A4', frequency: 442.0 },
-    { name: 'Berlin Philharmonic', pitch: 'A4', frequency: 443.0 },
-    { name: 'Boston Symphony Orchestra', pitch: 'A4', frequency: 444.0 },
-    { name: 'Old Philharmonic', pitch: 'A4', frequency: 452.4 },
-    { name: 'Chorton', pitch: 'A4', frequency: 466.0 },
+    {
+      frequency: 415.0,
+      key: :baroque,
+      alias_keys: %i[chamber_tone],
+    },
+    {
+      frequency: 430.0,
+      key: :classical,
+      alias_keys: %i[haydn mozart],
+    },
+    {
+      pitch: 'C4',
+      frequency: 256.0,
+      key: :scientific,
+      alias_keys: %i[philosophical sauveur],
+    },
+    {
+      frequency: 432.0,
+      tuning: 'Pythagorean',
+      key: :verdi,
+    },
+    {
+      frequency: 435.0,
+      key: :french,
+      alias_keys: %i[continental international],
+    },
+    {
+      frequency: 439.0,
+      key: :new_philharmonic,
+      alias_keys: %i[low],
+    },
+    {
+      frequency: 440.0,
+      key: :a440,
+      alias_keys: %i[concert stuttgart scheibler iso_16],
+    },
+    {
+      frequency: 441.0,
+      key: :sydney_symphony_orchestra,
+    },
+    {
+      frequency: 442.0,
+      key: :new_york_philharmonic,
+    },
+    {
+      frequency: 443.0,
+      key: :berlin_philharmonic,
+    },
+    {
+      frequency: 444.0,
+      key: :boston_symphony_orchestra,
+    },
+    {
+      frequency: 452.4,
+      key: :old_philharmonic,
+      alias_keys: %i[high],
+    },
+    {
+      frequency: 466.0,
+      key: :chorton,
+      alias_keys: %i[choir],
+    },
   ].freeze
 
-  ALIASES = {
-    kammerton: :baroque,
-    chamber: :baroque,
-    haydn: :classical,
-    mozart: :classical,
-    philosophic: :scientific,
-    sauveur: :scientific,
-    schiller: :scientific,
-    continental: :french,
-    international: :french,
-    low: :new_philharmonic,
-    concert: :a440,
-    stuttgart: :a440,
-    scheibler: :a440,
-    iso_16: :a440,
-    high: :old_philharmonic,
-    choir: :chorton,
-  }.freeze
-
-  NAMED_REFERENCE_PITCH_NAMES = NAMED_REFERENCE_PITCHES.map { |pitch_data| pitch_data[:name] }
-
   attr_reader :pitch, :frequency
 
   def self.get(name)
@@ -52,14 +81,11 @@ class HeadMusic::ReferencePitch
     get_by_name(name)
   end
 
-  def initialize(name = 'A440')
-    @name = name.to_s
-    reference_pitch_data = NAMED_REFERENCE_PITCHES.detect do |candidate|
-      candidate_name_key = HeadMusic::Utilities::HashKey.for(candidate[:name])
-      [candidate_name_key, candidate_name_key.to_s.delete('_').to_sym].include?(normalized_name)
-    end || {}
-    @pitch = HeadMusic::Pitch.get(reference_pitch_data.fetch(:pitch, DEFAULT_PITCH_NAME))
-    @frequency = reference_pitch_data.fetch(:frequency, DEFAULT_FREQUENCY)
+  def initialize(name = DEFAULT_REFERENCE_PITCH_NAME)
+    record = named_reference_pitch_record_for_name(name)
+    @pitch = HeadMusic::Pitch.get(record.fetch(:pitch, DEFAULT_PITCH_NAME))
+    @frequency = record.fetch(:frequency, DEFAULT_FREQUENCY)
+    initialize_keys_from_record(record)
   end
 
   def description
@@ -78,10 +104,42 @@ class HeadMusic::ReferencePitch
 
   private
 
-  def normalized_name
-    @normalized_name ||= begin
-      key = HeadMusic::Utilities::HashKey.for(name.to_s.gsub(/\W?(pitch|tuning|tone)/, ''))
-      ALIASES[key] || key
+  def named_reference_pitch_record_for_name(name)
+    key = HeadMusic::Utilities::HashKey.for(normalized_name_string(name))
+    NAMED_REFERENCE_PITCHES.detect do |record|
+      name_keys_from_record(record).include?(key)
+    end || named_reference_pitch_record_for_name(DEFAULT_REFERENCE_PITCH_NAME)
+  end
+
+  def name_keys_from_record(record)
+    names_from_record(record).map { |name| HeadMusic::Utilities::HashKey.for(name) }
+  end
+
+  def names_from_record(record)
+    name_keys = ([record[:key]] + [record[:alias_keys]]).flatten.compact.uniq
+    normalized_translations_for_keys(name_keys)
+  end
+
+  def normalized_name_string(name)
+    name.gsub(' pitch', '').gsub(' tone', '').gsub(' tuning', '')
+  end
+
+  def initialize_keys_from_record(record)
+    @key = record[:key]
+    @alias_keys = [record[:alias_keys]].flatten.compact
+  end
+
+  def normalized_translations_for_keys(name_keys)
+    name_and_alias_translations_for_keys(name_keys).map do |name|
+      normalized_name_string(name)
     end
   end
+
+  def name_and_alias_translations_for_keys(name_keys)
+    name_keys.map do |name_key|
+      I18n.config.available_locales.map do |locale_code|
+        I18n.translate(name_key, scope: :reference_pitches, locale: locale_code)
+      end.flatten.uniq.compact
+    end.flatten.uniq.compact
+  end
 end