head_music 0.24.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46aae73acea5e3331b19a08a02ded3c00fea5731e920207fc9d2b61dd9ebc359
-  data.tar.gz: c2cfdbb52641ad27bd96308fe99da5f59b2e66efdf2f40a4932e8bc6552510c4
+  metadata.gz: 0abe4bcc9d5eda30350352723a69a500c1a072d08e39de64d9266a25953771fa
+  data.tar.gz: 25a2b86a64a5c4f31cb75c5de988c59cad7e0a271a78adcde5e3cc2f040b88ef
 SHA512:
-  metadata.gz: 23a9cc4013e6058892effeeaf940947a90ce2e5950eb4c3c622b7036fecbaa14dd4cd4aa5d5dbe5b6ffdefe1ce8e37681b1d8d040e135b1a4c737fca23c84fa6
-  data.tar.gz: 15d30c56ea0b08db8bde6b0d69b38a9605751b370086e6a66db5a74029b1f4c87ab408b0e567e092f0e2418d4f65e1dfe5644358c0fd0f6f676548466b5544ec
+  metadata.gz: 670ca78b363ae669a73e4159b46e5465439824f1e051f15f8846acce3a6790352ac64b33cd41e82d6a602e3ef3582a6e224b9fd4da0fb5fbc85263c82d3e26c7
+  data.tar.gz: 1407f5414eb3842a61745c9943f50f14d866c1318d1a93d9c21ed296d57d5a61ba850f3c6b562c94ca20a9b23ada2098dc445af44184baed3969bfe3c29ab2bb

data/head_music.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'activesupport', '> 5.0'
   spec.add_runtime_dependency 'humanize', '~> 1.3'
+  spec.add_runtime_dependency 'i18n', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '>= 12.3.3'

data/lib/head_music.rb

@@ -12,6 +12,19 @@ require 'head_music/version'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/string/access'
 require 'humanize'
+require 'i18n'
+require 'i18n/backend/fallbacks'
+
+I18n::Backend::Simple.include I18n::Backend::Fallbacks
+I18n.load_path << Dir[File.join(File.dirname(__dir__), 'lib', 'head_music', 'locales', '*.yml')]
+I18n.config.available_locales = %i[en de fr it es en_US en_GB]
+I18n.default_locale = :en
+I18n.fallbacks[:de] = %i[de en_GB en]
+I18n.fallbacks[:en_US] = %i[en_US en en_GB]
+I18n.fallbacks[:en_GB] = %i[en_GB en en_US]
+I18n.fallbacks[:es] = %i[es en]
+I18n.fallbacks[:fr] = %i[fr en_GB en]
+I18n.fallbacks[:it] = %i[it en_GB en]
 
 # utilities
 require 'head_music/utilities/hash_key'
@@ -50,6 +63,7 @@ require 'head_music/scale'
 require 'head_music/scale_degree'
 require 'head_music/scale_type'
 require 'head_music/sign'
+require 'head_music/solmization'
 require 'head_music/sonority'
 require 'head_music/spelling'
 require 'head_music/staff'

data/lib/head_music/chromatic_interval.rb

@@ -6,6 +6,7 @@ class HeadMusic::ChromaticInterval
 
   private_class_method :new
 
+  # TODO: include the Named module
   NAMES = %w[
     perfect_unison minor_second major_second minor_third major_third perfect_fourth tritone perfect_fifth
     minor_sixth major_sixth minor_seventh major_seventh perfect_octave

data/lib/head_music/clef.rb

@@ -1,93 +1,23 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
 # A clef assigns pitches to the lines and spaces of a staff.
 class HeadMusic::Clef
   include HeadMusic::Named
 
-  CLEFS = [
-    {
-      pitch: 'G4', line: 2,
-      names: %w[treble G-clef],
-      modern: true,
-      unicode: '𝄞', html_entity: '𝄞',
-    },
-    {
-      pitch: 'G4', line: 1,
-      names: ['French', 'French violin'],
-      unicode: '𝄞', html_entity: '𝄞',
-    },
-    {
-      pitch: 'G3', line: 2,
-      names: ['choral tenor', 'tenor', 'tenor G-clef'],
-      modern: true,
-      unicode: '𝄠', html_entity: '𝄠',
-    },
-    {
-      pitch: 'F3', line: 3,
-      names: ['baritone'],
-      unicode: '𝄢', html_entity: '𝄢',
-    },
-    {
-      pitch: 'F3', line: 4,
-      names: %w[bass F-clef],
-      modern: true,
-      unicode: '𝄢', html_entity: '𝄢',
-    },
-    {
-      pitch: 'F3', line: 5,
-      names: ['sub-bass'],
-      unicode: '𝄢', html_entity: '𝄢',
-    },
-    {
-      pitch: 'C4', line: 1,
-      names: ['soprano'],
-      unicode: '𝄡', html_entity: '𝄡',
-    },
-    {
-      pitch: 'C4', line: 2,
-      names: ['mezzo-soprano'],
-      unicode: '𝄡', html_entity: '𝄡',
-    },
-    {
-      pitch: 'C4', line: 3,
-      names: %w[alto viola counter-tenor countertenor C-clef],
-      modern: true,
-      unicode: '𝄡', html_entity: '𝄡',
-    },
-    {
-      pitch: 'C4', line: 4,
-      names: ['tenor', 'tenor C-clef'],
-      modern: true,
-      unicode: '𝄡', html_entity: '𝄡',
-    },
-    {
-      pitch: 'C4', line: 5,
-      names: ['baritone', 'baritone C-clef'],
-      unicode: '𝄡', html_entity: '𝄡',
-    },
-    {
-      pitch: nil, line: 3,
-      names: %w[neutral percussion],
-      modern: true,
-      unicode: '𝄥', html_entity: '𝄥',
-    },
-  ].freeze
+  RECORDS = YAML.load_file(File.expand_path('data/clefs.yml', __dir__)).freeze
 
   def self.get(name)
     get_by_name(name)
   end
 
-  attr_reader :pitch, :line, :musical_symbol
+  attr_reader :pitch, :line, :musical_symbols
 
   delegate :ascii, :html_entity, :unicode, to: :musical_symbol
 
-  def initialize(name)
-    @name = name.to_s
-    clef_data = CLEFS.detect { |clef| clef[:names].map(&:downcase).include?(name.downcase) }
-    @pitch = HeadMusic::Pitch.get(clef_data[:pitch])
-    @line = clef_data[:line]
-    @modern = clef_data[:modern]
-    @musical_symbol = HeadMusic::MusicalSymbol.new(clef_data.slice(:ascii, :html_entity, :unicode))
+  def musical_symbol
+    musical_symbols.first
   end
 
   def clef_type
@@ -115,6 +45,59 @@ class HeadMusic::Clef
   end
 
   def ==(other)
-    to_s == other.to_s
+    HeadMusic::Utilities::HashKey.for(self) == HeadMusic::Utilities::HashKey.for(other)
+  end
+
+  def name(locale_code: Locale::DEFAULT_CODE)
+    I18n.translate(name_key, scope: :clefs, locale: locale_code)
+  end
+
+  private_class_method :new
+
+  private
+
+  def initialize(name)
+    record = record_for_name(name)
+    initialize_data_from_record(record)
+  end
+
+  def record_for_name(name)
+    name = name.to_s.strip
+    key = HeadMusic::Utilities::HashKey.for(name)
+    RECORDS.detect do |record|
+      name_keys = name_keys_from_record(record)
+      name_keys.include?(key) || name_key_translations(name_keys).include?(name)
+    end
+  end
+
+  def name_keys_from_record(record)
+    ([record[:name_key]] + [record[:alias_name_keys]]).flatten.compact.uniq.map(&:to_sym)
+  end
+
+  def name_key_translations(name_keys)
+    name_keys.map do |name_key|
+      I18n.config.available_locales.map do |locale_code|
+        I18n.translate(name_key, scope: :clefs, locale: locale_code)
+      end.flatten.uniq.compact
+    end.flatten.uniq.compact
+  end
+
+  def initialize_data_from_record(record)
+    initialize_keys_from_record(record)
+    @pitch = HeadMusic::Pitch.get(record[:pitch])
+    @line = record[:line]
+    @modern = record[:modern]
+    initialize_musical_symbols(record[:symbols])
+  end
+
+  def initialize_keys_from_record(record)
+    @name_key = record[:name_key]
+    @alias_name_keys = [record[:alias_name_keys]].flatten.compact
+  end
+
+  def initialize_musical_symbols(list)
+    @musical_symbols = (list || []).map do |symbol_data|
+      HeadMusic::MusicalSymbol.new(symbol_data.slice(:ascii, :html_entity, :unicode))
+    end
   end
 end

data/lib/head_music/data/clefs.yml

@@ -0,0 +1,126 @@
+---
+- :pitch: G4
+  :line: 2
+  :modern: true
+  :name_key: treble_clef
+  :alias_name_keys:
+  - g_clef
+  - second_line_g_clef
+  - violin_clef
+  :symbols:
+  - :unicode: "\U0001D11E"
+    :html_entity: "𝄞"
+- :pitch: G4
+  :line: 1
+  :name_key: french_violin_clef
+  :alias_name_keys:
+  - french_clef
+  - first_line_g_clef
+  :symbols:
+  - :unicode: "\U0001D11E"
+    :html_entity: "𝄞"
+- :pitch: G3
+  :line: 2
+  :modern: true
+  :name_key: choral_tenor_clef
+  :alias_name_keys:
+  - tenor_clef
+  - tenor_g_clef
+  :symbols:
+  - :unicode: "\U0001D120"
+    :html_entity: "𝄠"
+- :pitch: G3
+  :line: 2
+  :name_key: double_treble_clef
+  :symbols:
+  - :unicode: "\U0001D11E\U0001D11E"
+    :html_entity: "𝄞𝄞"
+- :pitch: F3
+  :line: 3
+  :name_key: baritone_clef
+  :alias_name_keys:
+  - baritone_f_clef
+  - third_line_f_clef
+  :symbols:
+  - :unicode: "\U0001D122"
+    :html_entity: "𝄢"
+- :pitch: F3
+  :line: 4
+  :modern: true
+  :name_key: bass_clef
+  :alias_name_keys:
+  - f_clef
+  - fourth_line_f_clef
+  :symbols:
+  - :unicode: "\U0001D122"
+    :html_entity: "𝄢"
+- :pitch: F3
+  :line: 5
+  :name_key: sub_bass_clef
+  :alias_name_keys:
+  - contrabass_clef
+  - fifth_line_f_clef
+  :symbols:
+  - :unicode: "\U0001D122"
+    :html_entity: "𝄢"
+- :pitch: C4
+  :line: 1
+  :name_key: soprano_clef
+  :alias_name_keys:
+  - first_line_c_clef
+  :symbols:
+  - :unicode: "\U0001D121"
+    :html_entity: "𝄡"
+- :pitch: C4
+  :line: 2
+  :name_key: mezzo_soprano_clef
+  :alias_name_keys:
+  - second_line_c_clef
+  :symbols:
+  - :unicode: "\U0001D121"
+    :html_entity: "𝄡"
+- :pitch: C4
+  :line: 3
+  :modern: true
+  :name_key: alto_clef
+  :alias_name_keys:
+  - c_clef
+  - third_line_c_clef
+  - viola_clef
+  - countertenor_clef
+  :symbols:
+  - :unicode: "\U0001D121"
+    :html_entity: "𝄡"
+- :pitch: C4
+  :line: 4
+  :modern: true
+  :name_key: tenor_clef
+  :alias_name_keys:
+  - tenor_c_clef
+  - fourth_line_c_clef
+  :symbols:
+  - :unicode: "\U0001D121"
+    :html_entity: "𝄡"
+- :pitch: C4
+  :line: 5
+  :name_key: baritone_c_clef
+  :alias_name_keys:
+  - baritone_clef
+  - fifth_line_c_clef
+  :symbols:
+  - :unicode: "\U0001D121"
+    :html_entity: "𝄡"
+- :pitch:
+  :line: 3
+  :modern: true
+  :name_key: neutral_clef
+  :alias_name_keys:
+  - percussion_clef
+  - indefinite_pitch_clef
+  - rhythm_clef
+  - drum_clef
+  :symbols:
+  - :unicode: "\U0001D125"
+    :html_entity: "𝄥"
+  - :unicode: "\U0001D126"
+    :html_entity: "𝄦"

data/lib/head_music/data/instruments.yml

@@ -0,0 +1,36 @@
+---
+- name_key: alto_flute
+- name_key: guitar
+  family: string
+  classifications:
+  - string
+  - chordophone
+  default_clefs:
+  - treble_clef
+- name_key: piano
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - keyboard
+  default_clefs:
+  - treble_clef
+  - bass_clef
+- name_key: violin
+  alias_name_keys:
+  - fiddle
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - bowed
+  default_clefs:
+  - treble_clef
+- name_key: viola
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - bowed
+  default_clefs:
+  - alto_clef

data/lib/head_music/diatonic_interval.rb

@@ -4,6 +4,7 @@
 class HeadMusic::DiatonicInterval
   include Comparable
 
+  # TODO: include Named module
   NUMBER_NAMES = %w[
     unison second third fourth fifth sixth seventh octave
     ninth tenth eleventh twelfth thirteenth fourteenth fifteenth

data/lib/head_music/grand_staff.rb

@@ -6,16 +6,16 @@ class HeadMusic::GrandStaff
     piano: {
       instrument: :piano,
       staves: [
-        { clef: :treble, instrument: :piano },
-        { clef: :bass, instrument: :piano },
+        { clef: :treble_clef, instrument: :piano },
+        { clef: :bass_clef, instrument: :piano },
       ],
     },
     organ: {
       instrument: :organ,
       staves: [
-        { clef: :treble, instrument: :organ },
-        { clef: :bass, instrument: :organ },
-        { clef: :bass, instrument: :pedals },
+        { clef: :treble_clef, instrument: :organ },
+        { clef: :bass_clef, instrument: :organ },
+        { clef: :bass_clef, instrument: :pedals },
       ],
     },
   }.freeze
@@ -41,7 +41,12 @@ class HeadMusic::GrandStaff
 
   def staves
     @staves ||=
-      data[:staves].map { |staff| HeadMusic::Staff.new(staff[:clef], instrument: staff[:instrument] || instrument) }
+      data[:staves].map do |staff|
+        HeadMusic::Staff.new(
+          staff[:clef],
+          instrument: staff[:instrument] || instrument
+        )
+      end
   end
 
   def brace_staves_index_first

data/lib/head_music/instrument.rb

@@ -4,44 +4,57 @@
 class HeadMusic::Instrument
   include HeadMusic::Named
 
-  INSTRUMENTS = {
-    violin: {
-      name: 'violin',
-      family: :string,
-      default_clef: :treble,
-    },
-    piano: {
-      name: 'piano',
-      family: :string,
-      default_system: %i[treble bass],
-    },
-  }.freeze
+  INSTRUMENTS = YAML.load_file(File.expand_path('data/instruments.yml', __dir__)).freeze
 
   def self.get(name)
-    get_by_name(name)
+    return get_by_name(name) if get_by_name(name)
+    return get_by_name(key_for_name(name)) if key_for_name(name)
+
+    new(name)
   end
 
-  def initialize(name)
-    @name = name.to_s
+  attr_reader :name_key, :family, :default_clefs
+
+  def ==(other)
+    to_s == other.to_s
   end
 
-  def data
-    @data ||= INSTRUMENTS[hash_key]
+  private_class_method :new
+
+  private
+
+  def initialize(name)
+    record = record_for_name(name)
+    if record
+      initialize_data_from_record(record)
+    else
+      self.name = name
+    end
   end
 
-  def family
-    data[:family]
+  def record_for_name(name)
+    key = HeadMusic::Utilities::HashKey.for(name)
+    record_for_key(key) || record_for_key(key_for_name(name))
   end
 
-  def default_system
-    data[:default_system]
+  def key_for_name(name)
+    INSTRUMENTS.each do |instrument|
+      I18n.config.available_locales.each do |locale|
+        translation = I18n.t("instruments.#{instrument['name_key']}", locale: locale)
+        return instrument['name_key'] if translation.downcase == name.downcase
+      end
+    end
+    nil
   end
 
-  def default_clef
-    data[:default_clef]
+  def record_for_key(key)
+    INSTRUMENTS.detect { |instrument| instrument['name_key'] == key }
   end
 
-  def ==(other)
-    to_s == other.to_s
+  def initialize_data_from_record(record)
+    @family = record['family']
+    @default_clefs = record['default_clefs']
+    @name_key = record['name_key'].to_sym
+    self.name = I18n.translate(name_key, scope: 'instruments', locale: 'en')
   end
 end