head_music 0.24.0 → 0.24.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46aae73acea5e3331b19a08a02ded3c00fea5731e920207fc9d2b61dd9ebc359
-  data.tar.gz: c2cfdbb52641ad27bd96308fe99da5f59b2e66efdf2f40a4932e8bc6552510c4
+  metadata.gz: 32f5c1ba7401ca32fbb3c8f991757e83c64179308507e755fc152a7bc83bb478
+  data.tar.gz: bb5cb90088d2b316e17083c3bab30720f1226b70882a0fc21e2075e14e433bf1
 SHA512:
-  metadata.gz: 23a9cc4013e6058892effeeaf940947a90ce2e5950eb4c3c622b7036fecbaa14dd4cd4aa5d5dbe5b6ffdefe1ce8e37681b1d8d040e135b1a4c737fca23c84fa6
-  data.tar.gz: 15d30c56ea0b08db8bde6b0d69b38a9605751b370086e6a66db5a74029b1f4c87ab408b0e567e092f0e2418d4f65e1dfe5644358c0fd0f6f676548466b5544ec
+  metadata.gz: 3dd06274ffffa0fbbd8adbb6340d22b27c6aeecc1ff237800145521b53db6230f25a41b30a862d25282bdcba01cb35b5e6f69390ccdd7492a80dcb84849550dc
+  data.tar.gz: 7e4abe930e7abe9b82a04220dcadff5691d2de531ba792c4d2a506c5f6afef16447288ea9de78ea0a32642f67ca69cb45714d9e121a689c2c44e7d56255de376

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 
@@ -34,8 +38,5 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
-AllCops:
-  TargetRubyVersion: 2.4
-
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/head_music.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.5'
 
-  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/content/placement.rb

@@ -5,6 +5,7 @@ class HeadMusic::Placement
   include Comparable
 
   attr_reader :voice, :position, :rhythmic_value, :pitch
+
   delegate :composition, to: :voice
   delegate :spelling, to: :pitch, allow_nil: true
 

data/lib/head_music/content/position.rb

@@ -5,6 +5,7 @@ class HeadMusic::Position
   include Comparable
 
   attr_reader :composition, :bar_number, :count, :tick
+
   delegate :to_s, to: :code
 
   def initialize(composition, code_or_bar, count = nil, tick = nil)

data/lib/head_music/content/voice.rb

@@ -6,6 +6,7 @@ class HeadMusic::Voice
   include Comparable
 
   attr_reader :composition, :placements, :role
+
   delegate :key_signature, to: :composition
 
   def initialize(composition: nil, role: nil)

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,83 @@
+---
+guitar:
+  family: string
+  classifications:
+    - string
+    - chordophone
+  default_clefs:
+    - treble_clef
+  voice: tenor
+piano:
+  family: string
+  classifications:
+    - string
+    - chordophone
+    - keyboard
+  default_clefs:
+    - treble_clef
+    - bass_clef
+violin:
+  family: string
+  alias_name_keys:
+    - fiddle
+  classifications:
+    - string
+    - chordophone
+    - bowed
+  default_clefs:
+    - treble_clef
+  voice: soprano
+viola:
+  family: string
+  classifications:
+    - string
+    - chordophone
+    - bowed
+  default_clefs:
+    - alto_clef
+  voice: alto
+cello:
+  family: string
+  classifications:
+    - string
+    - chordophone
+    - bowed
+  default_clefs:
+    - bass_clef
+  voice: tenor
+double_bass:
+  family: string
+  classifications:
+    - string
+    - chordophone
+    - bowed
+  default_clefs:
+    - bass_clef
+  voice: bass
+harp:
+  family: string
+  classifications:
+    - string
+    - chordophone
+    - plucked
+  default_clefs:
+    - treble_clef
+    - bass_clef
+flute:
+  family: woodwind
+  classifications:
+    - woodwind
+    - wind
+    - aerophone
+    - edge-blown aerophone
+  default_clefs:
+    - treble_clef
+  voice: soprano
+organ:
+  classifications:
+    - aerophone
+    - keyboard
+  default_clefs:
+    - treble_clef
+    - bass_clef
+    - bass_clef