head_music 0.24.0 → 0.24.1

data/lib/head_music/reference_pitch.rb

@@ -7,60 +7,85 @@ class HeadMusic::ReferencePitch
 
   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 },
-  ].freeze
-
-  ALIAS_DATA = [
-    { key: :baroque, name: 'Kammerton' },
-    { key: :classical, name: 'Haydn' },
-    { key: :classical, name: 'Mozart' },
-    { key: :scientific, name: 'philosophical' },
-    { key: :scientific, name: 'Sauveur' },
-    { key: :scientific, name: 'Schiller' },
-    { key: :french, name: 'continental' },
-    { key: :french, name: 'international' },
-    { key: :new_philharmonic, name: 'low' },
-    { key: :old_philharmonic, name: 'high' },
-    { key: :a440, name: 'concert' },
-    { key: :a440, name: 'Stuttgart' },
-    { key: :a440, name: 'Scheibler' },
-    { key: :a440, name: 'ISO 16' },
-    { key: :chorton, name: 'choir' },
+    {
+      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
 
   attr_reader :pitch, :frequency
 
-  def self.aliases
-    @aliases ||= ALIAS_DATA.map { |attributes| HeadMusic::Named::Alias.new(attributes) }
-  end
-
   def self.get(name)
     return name if name.is_a?(self)
     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_key)
-    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
@@ -79,12 +104,42 @@ class HeadMusic::ReferencePitch
 
   private
 
-  def normalized_key
-    @normalized_key ||= begin
-      key = HeadMusic::Utilities::HashKey.for(name.to_s.gsub(/\W?(pitch|tuning|tone)/, ''))
-      HeadMusic::ReferencePitch.aliases.detect do |alias_data|
-        HeadMusic::Utilities::HashKey.for(alias_data.name) == key
-      end&.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

data/lib/head_music/rhythmic_unit.rb

@@ -27,7 +27,7 @@ class HeadMusic::RhythmicUnit
   end
 
   def initialize(canonical_name)
-    @name = canonical_name
+    self.name = canonical_name
     @numerator = 2**numerator_exponent
     @denominator = 2**denominator_exponent
   end

data/lib/head_music/scale_type.rb

@@ -28,7 +28,7 @@ class HeadMusic::ScaleType
     vii: [:locrian],
   }.freeze
 
-  CHROMATIC = [H, H, H, H, H, H, H, H, H, H, H, H].freeze
+  CHROMATIC = ([H] * 12)
 
   MINOR_PENTATONIC = [3, 2, 2, 3, 2].freeze
 

data/lib/head_music/sign.rb

@@ -6,22 +6,37 @@ require 'head_music/musical_symbol'
 class HeadMusic::Sign
   include Comparable
 
-  attr_reader :identifier, :cents, :musical_symbol
+  attr_reader :identifier, :cents, :musical_symbols
 
   delegate :ascii, :unicode, :html_entity, to: :musical_symbol
 
-  SIGN_DATA = [
-    { identifier: :sharp, ascii: '#', unicode: '♯', html_entity: '♯', cents: 100 },
-    { identifier: :flat, ascii: 'b', unicode: '♭', html_entity: '♭', cents: -100 },
-    { identifier: :natural, ascii: '', unicode: '♮', html_entity: '♮', cents: 0 },
-    { identifier: :double_sharp, ascii: 'x', unicode: '𝄪', html_entity: '𝄪', cents: 200 },
-    { identifier: :double_flat, ascii: 'bb', unicode: '𝄫', html_entity: '𝄫', cents: -200 },
+  SIGN_RECORDS = [
+    {
+      identifier: :sharp, cents: 100,
+      symbols: [{ ascii: '#', unicode: '♯', html_entity: '♯' }],
+    },
+    {
+      identifier: :flat, cents: -100,
+      symbols: [{ ascii: 'b', unicode: '♭', html_entity: '♭' }],
+    },
+    {
+      identifier: :natural, cents: 0,
+      symbols: [{ ascii: '', unicode: '♮', html_entity: '♮' }],
+    },
+    {
+      identifier: :double_sharp, cents: 200,
+      symbols: [{ ascii: 'x', unicode: '𝄪', html_entity: '𝄪' }],
+    },
+    {
+      identifier: :double_flat, cents: -200,
+      symbols: [{ ascii: 'bb', unicode: '𝄫', html_entity: '𝄫' }],
+    },
   ].freeze
 
-  SIGN_IDENTIFIERS = SIGN_DATA.map { |attributes| attributes[:identifier] }.freeze
+  SIGN_IDENTIFIERS = SIGN_RECORDS.map { |attributes| attributes[:identifier] }.freeze
 
   def self.all
-    SIGN_DATA.map { |attributes| new(attributes) }
+    SIGN_RECORDS.map { |attributes| new(attributes) }
   end
 
   def self.symbols
@@ -76,16 +91,26 @@ class HeadMusic::Sign
     cents <=> other.cents
   end
 
+  def musical_symbol
+    musical_symbols.first
+  end
+
   private
 
   def initialize(attributes)
     @identifier = attributes[:identifier]
     @cents = attributes[:cents]
-    @musical_symbol = HeadMusic::MusicalSymbol.new(
-      unicode: attributes[:unicode],
-      ascii: attributes[:ascii],
-      html_entity: attributes[:html_entity]
-    )
+    initialize_musical_symbols(attributes[:symbols])
+  end
+
+  def initialize_musical_symbols(list)
+    @musical_symbols = (list || []).map do |record|
+      HeadMusic::MusicalSymbol.new(
+        unicode: record[:unicode],
+        ascii: record[:ascii],
+        html_entity: record[:html_entity]
+      )
+    end
   end
 
   private_class_method :new

data/lib/head_music/solmization.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# A scale degree is a number indicating the ordinality of the spelling in the key signature.
+# TODO: Rewrite to accept a tonal_center and a scale type.
+class HeadMusic::Solmization
+  include HeadMusic::Named
+
+  DEFAULT_SOLMIZATION = 'solfège'
+
+  RECORDS = YAML.load_file(File.expand_path('solmizations.yml', __dir__)).freeze
+
+  attr_reader :syllables
+
+  def self.get(identifier = nil)
+    get_by_name(identifier)
+  end
+
+  private_class_method :new
+
+  private
+
+  def initialize(name = nil)
+    name = nil if name.empty?
+    name ||= DEFAULT_SOLMIZATION
+    record = record_for_name(name)
+    if record
+      initialize_data_from_record(record)
+    else
+      self.name = name
+    end
+  end
+
+  def record_for_name(name)
+    key = HeadMusic::Utilities::HashKey.for(name)
+    RECORDS.detect do |record|
+      name_strings = record[:localized_names].map { |localized_name| localized_name[:name] }
+      name_keys = name_strings.map { |name_string| HeadMusic::Utilities::HashKey.for(name_string) }
+      name_keys.include?(key)
+    end
+  end
+
+  def initialize_data_from_record(record)
+    @syllables = record[:syllables]
+    initialize_localized_names(record[:localized_names])
+  end
+
+  def initialize_localized_names(list)
+    @localized_names = (list || []).map do |name_attributes|
+      HeadMusic::Named::LocalizedName.new(name_attributes.slice(:name, :locale_code, :abbreviation))
+    end
+  end
+end

data/lib/head_music/solmizations.yml

@@ -0,0 +1,20 @@
+---
+- :syllables:
+  - do
+  - re
+  - mi
+  - fa
+  - sol
+  - la
+  - ti
+  :localized_names:
+  - :name: solfège
+  - :name: solfège
+    :locale_code: en
+  - :name: solfège
+    :locale_code: fr
+  - :name: solfeggio
+    :locale_code: it
+  - :name: sol-fa
+  - :name: solfa
+  - :name: solfeo

data/lib/head_music/utilities/hash_key.rb

@@ -6,6 +6,6 @@ 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
+    I18n.transliterate(identifier.to_s).downcase.gsub(/\W+/, '_').to_sym
   end
 end

data/lib/head_music/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeadMusic
-  VERSION = '0.24.0'
+  VERSION = '0.24.1'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.24.1
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,8 @@ files:
 - lib/head_music/content/position.rb
 - lib/head_music/content/rhythmic_value.rb
 - lib/head_music/content/voice.rb
+- lib/head_music/data/clefs.yml
+- lib/head_music/data/instruments.yml
 - lib/head_music/diatonic_interval.rb
 - lib/head_music/grand_staff.rb
 - lib/head_music/harmonic_interval.rb
@@ -138,6 +154,12 @@ files:
 - lib/head_music/interval_cycle.rb
 - lib/head_music/key_signature.rb
 - lib/head_music/letter_name.rb
+- lib/head_music/locales/de.yml
+- lib/head_music/locales/en.yml
+- lib/head_music/locales/en_GB.yml
+- lib/head_music/locales/es.yml
+- lib/head_music/locales/fr.yml
+- lib/head_music/locales/it.yml
 - lib/head_music/melodic_interval.rb
 - lib/head_music/meter.rb
 - lib/head_music/motion.rb
@@ -158,6 +180,8 @@ files:
 - lib/head_music/scale_degree.rb
 - lib/head_music/scale_type.rb
 - lib/head_music/sign.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