head_music 0.23.2 → 0.24.2

data/lib/head_music/rhythmic_unit.rb

@@ -2,7 +2,7 @@
 
 # A rhythmic unit is a rudiment of duration consisting of doublings and divisions of a whole note.
 class HeadMusic::RhythmicUnit
-  include HeadMusic::NamedRudiment
+  include HeadMusic::Named
 
   MULTIPLES = ['whole', 'double whole', 'longa', 'maxima'].freeze
   FRACTIONS = [
@@ -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_degree.rb

@@ -8,6 +8,7 @@ class HeadMusic::ScaleDegree
   NAME_FOR_DIATONIC_DEGREE = [nil, 'tonic', 'supertonic', 'mediant', 'subdominant', 'dominant', 'submediant'].freeze
 
   attr_reader :key_signature, :spelling
+
   delegate :scale, to: :key_signature
   delegate :scale_type, to: :scale
 

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,16 +6,37 @@ require 'head_music/musical_symbol'
 class HeadMusic::Sign
   include Comparable
 
-  attr_reader :identifier, :cents, :symbol
+  attr_reader :identifier, :cents, :musical_symbols
+
+  delegate :ascii, :unicode, :html_entity, to: :musical_symbol
+
+  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_RECORDS.map { |attributes| attributes[:identifier] }.freeze
 
   def self.all
-    @all ||= [
-      new(identifier: :sharp, ascii: '#', unicode: '♯', html_entity: '♯', cents: 100),
-      new(identifier: :flat, ascii: 'b', unicode: '♭', html_entity: '♭', cents: -100),
-      new(identifier: :natural, ascii: '', unicode: '♮', html_entity: '♮', cents: 0),
-      new(identifier: :double_sharp, ascii: '##', unicode: '𝄪', html_entity: '𝄪', cents: 200),
-      new(identifier: :double_flat, ascii: 'bb', unicode: '𝄫', html_entity: '𝄫', cents: -200),
-    ]
+    SIGN_RECORDS.map { |attributes| new(attributes) }
   end
 
   def self.symbols
@@ -57,6 +78,10 @@ class HeadMusic::Sign
     cents / 100.0
   end
 
+  SIGN_IDENTIFIERS.each do |key|
+    define_method(:"#{key}?") { identifier == key }
+  end
+
   def to_s
     unicode
   end
@@ -66,19 +91,26 @@ class HeadMusic::Sign
     cents <=> other.cents
   end
 
-  delegate :ascii, :html_entity, :unicode, to: :symbol
+  def musical_symbol
+    musical_symbols.first
+  end
 
   private
 
   def initialize(attributes)
     @identifier = attributes[:identifier]
     @cents = attributes[:cents]
+    initialize_musical_symbols(attributes[:symbols])
+  end
 
-    @symbol = HeadMusic::Symbol.new(
-      unicode: attributes[:unicode],
-      ascii: attributes[:ascii],
-      html_entity: attributes[:html_entity]
-    )
+  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/spelling.rb

@@ -4,7 +4,7 @@
 # Composite of a LetterName and an optional Sign.
 # Does not include the octave. See Pitch for that.
 class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(\-?\d+)?\s*$/i.freeze
+  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(-?\d+)?\s*$/i.freeze
 
   attr_reader :pitch_class
   attr_reader :letter_name
@@ -14,6 +14,7 @@ class HeadMusic::Spelling
   delegate :to_i, to: :pitch_class_number
   delegate :series_ascending, :series_descending, to: :letter_name, prefix: true
   delegate :enharmonic?, to: :enharmonic_equivalence
+  delegate :sharp?, :flat?, :double_sharp?, :double_flat?, to: :sign, allow_nil: true
 
   def self.get(identifier)
     return identifier if identifier.is_a?(HeadMusic::Spelling)
@@ -73,14 +74,6 @@ class HeadMusic::Spelling
     name
   end
 
-  def sharp?
-    sign && sign == '#'
-  end
-
-  def flat?
-    sign && sign == 'b'
-  end
-
   def ==(other)
     other = HeadMusic::Spelling.get(other)
     to_s == other.to_s
@@ -90,6 +83,10 @@ class HeadMusic::Spelling
     HeadMusic::Scale.get(self, scale_type_name)
   end
 
+  def natural?
+    !sign || sign.natural?
+  end
+
   private_class_method :new
 
   private

data/lib/head_music/tuning.rb

@@ -12,12 +12,9 @@ class HeadMusic::Tuning
   end
 
   def frequency_for(pitch)
-    pitch = HeadMusic::Pitch.get(pitch) unless pitch.is_a?(HeadMusic::Pitch)
+    pitch = HeadMusic::Pitch.get(pitch)
     reference_pitch_frequency * (2**(1.0 / 12))**(pitch - reference_pitch.pitch).semitones
   end
 end
 
 # TODO: other tunings
-# Create website that hosts videos on theory and history, handy charts, etc.
-# one of those charts can be a frequency table in various tunings
-# maybe show pythagorean commas and such. or cents sharp or flat relative to either equal temperment or just intonation

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.23.2'
+  VERSION = '0.24.2'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.24.2
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-25 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,11 +154,17 @@ 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
 - lib/head_music/musical_symbol.rb
-- lib/head_music/named_rudiment.rb
+- lib/head_music/named.rb
 - lib/head_music/octave.rb
 - lib/head_music/pitch.rb
 - lib/head_music/pitch/enharmonic_equivalence.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
@@ -216,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/head_music/named_rudiment.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-# NameRudiment is a module to be included in classes whose instances may be identified by name.
-module HeadMusic::NamedRudiment
-  attr_reader :name
-  delegate :to_s, to: :name
-
-  def initialize(name)
-    @name = name.to_s
-  end
-
-  def hash_key
-    HeadMusic::Utilities::HashKey.for(name)
-  end
-
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  # Adds .get_by_name to the including class.
-  module ClassMethods
-    def get_by_name(name)
-      name = name.to_s
-      @instances_by_name ||= {}
-      key = HeadMusic::Utilities::HashKey.for(name)
-      @instances_by_name[key] ||= new(name)
-    end
-  end
-end