head_music 0.23.1 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df85a8374d61221a2217a55bc0766bbfde35a5040768353f8d006f53755acff
-  data.tar.gz: 9d749a3a8def07c981019ba936a2718a2c3a89e661ab945437223e902df830f2
+  metadata.gz: 0abe4bcc9d5eda30350352723a69a500c1a072d08e39de64d9266a25953771fa
+  data.tar.gz: 25a2b86a64a5c4f31cb75c5de988c59cad7e0a271a78adcde5e3cc2f040b88ef
 SHA512:
-  metadata.gz: 6e58ad0dd9dcb2358195aa47a59801eaae763a5c27926088318308b37c7b86ec0edc3cb0b14ffb314661209a4d7c652c5f8826c663c1f80f781e1933b3ac452a
-  data.tar.gz: a9deabf2b150cb062a617c9439094d4328a8c5fb0b390d915b73205fe226b82f3b96fe57c4eb542f29c23c62484e2513e0a68366840ac677660b38991975dabc
+  metadata.gz: 670ca78b363ae669a73e4159b46e5465439824f1e051f15f8846acce3a6790352ac64b33cd41e82d6a602e3ef3582a6e224b9fd4da0fb5fbc85263c82d3e26c7
+  data.tar.gz: 1407f5414eb3842a61745c9943f50f14d866c1318d1a93d9c21ed296d57d5a61ba850f3c6b562c94ca20a9b23ada2098dc445af44184baed3969bfe3c29ab2bb

data/.rubocop.yml

@@ -1,6 +1,9 @@
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/LineLength:
+  Max: 120
+
 Metrics/BlockLength:
   Exclude:
     - 'Gemfile'
@@ -10,15 +13,21 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 155
 
-Metrics/LineLength:
-  Max: 120
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
 
 Style/SymbolArray:
   Enabled: true
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
@@ -26,7 +35,7 @@ Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.4
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/Gemfile

@@ -9,7 +9,7 @@ gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', '~> 1.0.0'
-  gem 'rubocop', '>= 0.56.0', require: false
+  gem 'rubocop', '>= 0.80.0', require: false
   gem 'rubocop-rspec', require: false
   gem 'simplecov'
 end

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

@@ -24,11 +24,12 @@ 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', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
 end

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'
@@ -28,11 +41,13 @@ require 'head_music/diatonic_interval'
 require 'head_music/grand_staff'
 require 'head_music/harmonic_interval'
 require 'head_music/instrument'
+require 'head_music/interval_cycle'
 require 'head_music/key_signature'
 require 'head_music/letter_name'
 require 'head_music/melodic_interval'
 require 'head_music/meter'
 require 'head_music/motion'
+require 'head_music/musical_symbol'
 require 'head_music/octave'
 require 'head_music/pitch'
 require 'head_music/pitch/enharmonic_equivalence'
@@ -48,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

@@ -1,45 +1,54 @@
 # frozen_string_literal: true
 
+require 'head_music/interval_cycle'
+
 # A Circle of Fifths or Fourths shows relationships between pitch classes
-# TODO: Replace or empower with IntervalCycle (?)
-# https://en.wikipedia.org/wiki/Interval_cycle
-class HeadMusic::Circle
+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)
+    diatonic_interval = HeadMusic::DiatonicInterval.get(interval)
+    @circles[interval] ||= new(interval: diatonic_interval, starting_pitch: 'C4')
   end
 
-  attr_reader :interval, :pitch_classes
-
-  def initialize(interval)
-    @interval = interval.to_i
-    @pitch_classes = pitch_classes_by_interval
+  def index(pitch_class)
+    pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
   end
 
-  def index(pitch_class)
-    @pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
+  alias spellings_up spellings
+
+  def key_signatures_up
+    spellings_up.map { |spelling| HeadMusic::KeySignature.new(spelling) }
   end
 
-  private_class_method :new
+  def key_signatures_down
+    spellings_down.map { |spelling| HeadMusic::KeySignature.new(spelling) }
+  end
 
-  private
+  def spellings_down
+    pitches_down.map(&:spelling)
+  end
 
-  def pitch_classes_by_interval
-    [HeadMusic::PitchClass.get(0)].tap do |list|
-      loop do
-        next_pitch_class = list.last + interval
-        break if next_pitch_class == list.first
+  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_class
+          list << next_pitch
+        end
       end
     end
   end
+
+  private_class_method :new
 end

data/lib/head_music/clef.rb

@@ -1,39 +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: ['treble', 'G-clef'], modern: true },
-    { pitch: 'G4', line: 1, names: ['French', 'French violin'] },
-    { pitch: 'G3', line: 2, names: ['choral tenor', 'tenor', 'tenor G-clef'], modern: true },
-
-    { pitch: 'F3', line: 3, names: ['baritone'] },
-    { pitch: 'F3', line: 4, names: ['bass', 'F-clef'], modern: true },
-    { pitch: 'F3', line: 5, names: ['sub-bass'] },
-
-    { pitch: 'C4', line: 1, names: ['soprano'] },
-    { pitch: 'C4', line: 2, names: ['mezzo-soprano'] },
-    { pitch: 'C4', line: 3, names: ['alto', 'viola', 'counter-tenor', 'countertenor', 'C-clef'], modern: true },
-    { pitch: 'C4', line: 4, names: ['tenor', 'tenor C-clef'], modern: true },
-    { pitch: 'C4', line: 5, names: ['baritone', 'baritone C-clef'] },
+  include HeadMusic::Named
 
-    { pitch: nil, line: 3, names: %w[neutral percussion] },
-  ].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
+  attr_reader :pitch, :line, :musical_symbols
 
-  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]
+  delegate :ascii, :html_entity, :unicode, to: :musical_symbol
+
+  def musical_symbol
+    musical_symbols.first
   end
 
   def clef_type
@@ -61,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: "𝄦"