head_music 0.23.3 → 0.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c9d3d90728c4751d6a84e85709800a2afa51eee3f15f21f37dc7ec1a4c9897a
-  data.tar.gz: 1d70bf4966c1ffb0cff66468d52a49a52a712b341a5ac9849482c64d5f406988
+  metadata.gz: 282655f6692a3065a0f4e8faf6b2e6938b53ab36c5d229183cfa4c747906414e
+  data.tar.gz: ac59b613c452d5ec06981b19c94da581f9474aeb8923f5040409c8b47668670e
 SHA512:
-  metadata.gz: 52447f9c047fcf064f5710a833202129bf878971080eb6aab54b0cce8921fb5381fefc999cba7ee8ca3a15de87f9f04843a39eaf1283efeef9516e8c0e92e20e
-  data.tar.gz: a4c5039cd26a401e50e83fb53425e9aeae6d134bf0f96d99a84a9b9b1e19ddbb0dcb7bc50e573abb008ee8af7d7373c1a0804ad97116933919dcff86cb625dc1
+  metadata.gz: 7e4d3d051057115e4b5751eb5113722dd50716daff6b73da4d21ae6a180b9eeb3ff42afe54be3b6a6b73e6c791b57cb58f0748349877966f487026ece28a79a7
+  data.tar.gz: a80791c1504b9ab101ef8ffd82efcd80e17686e09a7761c40ade3d310ca0c6b10f3387138e2ce73a83bf9a9b6550d5f10039de31bac389020033e01a62e7f00e

data/.rubocop.yml

@@ -1,6 +1,13 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/LineLength:
+  Max: 120
+
 Metrics/BlockLength:
   Exclude:
     - 'Gemfile'
@@ -10,9 +17,6 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 155
 
-Metrics/LineLength:
-  Max: 120
-
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 
@@ -34,8 +38,5 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
-AllCops:
-  TargetRubyVersion: 2.4
-
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/Rakefile

@@ -9,5 +9,5 @@ task default: :spec
 
 desc 'Open an irb session preloaded with this library'
 task :console do
-  sh 'irb -rubygems -I lib -r head_music.rb'
+  sh 'irb -I lib -r head_music.rb'
 end

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,12 +12,25 @@ 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'
 
 # modules
-require 'head_music/named_rudiment'
+require 'head_music/named'
 
 # rudiments
 require 'head_music/chromatic_interval'
@@ -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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-# An interval is the distance between two pitches.
+# A chromatic interval is the distance between two pitches measured in half-steps.
 class HeadMusic::ChromaticInterval
   include Comparable
 
   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
@@ -40,6 +41,10 @@ class HeadMusic::ChromaticInterval
     semitones
   end
 
+  def diatonic_name
+    NAMES[simple.semitones].gsub(/_/, ' ')
+  end
+
   # diatonic set theory
   alias specific_interval semitones
 

data/lib/head_music/circle.rb

@@ -5,39 +5,50 @@ require 'head_music/interval_cycle'
 # A Circle of Fifths or Fourths shows relationships between pitch classes
 class HeadMusic::Circle < HeadMusic::IntervalCycle
   def self.of_fifths
-    get(7)
+    get(:perfect_fifth)
   end
 
   def self.of_fourths
-    get(5)
+    get(:perfect_fourth)
   end
 
-  def self.get(interval = 7)
+  def self.get(interval = :perfect_fifth)
     @circles ||= {}
-    @circles[interval.to_i] ||= new(interval)
-  end
-
-  attr_reader :interval, :pitch_classes
-
-  # Accepts an interval (as an integer number of semitones)
-  def initialize(interval)
-    @interval = interval.to_i
-    @pitch_classes = pitch_classes_by_interval
+    diatonic_interval = HeadMusic::DiatonicInterval.get(interval)
+    @circles[interval] ||= new(interval: diatonic_interval, starting_pitch: 'C4')
   end
 
   def index(pitch_class)
-    @pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
+    pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
   end
 
-  private_class_method :new
+  alias spellings_up spellings
 
-  private
+  def key_signatures_up
+    spellings_up.map { |spelling| HeadMusic::KeySignature.new(spelling) }
+  end
 
-  def interval_cycle
-    @interval_cycle ||= HeadMusic::IntervalCycle.get(interval)
+  def key_signatures_down
+    spellings_down.map { |spelling| HeadMusic::KeySignature.new(spelling) }
   end
 
-  def pitch_classes_by_interval
-    interval_cycle.send(:pitch_classes_by_interval)
+  def spellings_down
+    pitches_down.map(&:spelling)
   end
+
+  def pitches_down
+    @pitches_down ||= begin
+      [starting_pitch].tap do |list|
+        loop do
+          next_pitch = list.last - interval
+          next_pitch += octave while starting_pitch - next_pitch > 12
+          break if next_pitch.pitch_class == list.first.pitch_class
+
+          list << next_pitch
+        end
+      end
+    end
+  end
+
+  private_class_method :new
 end

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::NamedRudiment
-
-  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
+  include HeadMusic::Named
+
+  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: "𝄦"