head_music 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eff7c01e7dbb6e69538d9cdcbad34c55fc9f05e
-  data.tar.gz: e78e38ddd5ec3e8c77aae6a9dc371df7183ef29d
+  metadata.gz: 3ff78a490907bb272ceebc6b8d7b635ec7ddc629
+  data.tar.gz: a0dc85d1b1862519ea0ef6fb2469778180e86bab
 SHA512:
-  metadata.gz: 98da361ccd151df8d8b8d31688a783cbf3586845e06bf5584e6131b0eb657f18f820f0111e86cdd6a38e65770a99a64588e5693d938aa364b317f590f01db330
-  data.tar.gz: 67bfc70343e9c9733671aea1e9d1d80291ee4233e70fe60899e22efe61f8f6132cff06e54804aa34e3b098080db22919ba38a695a615d42219ba04ee2a3f1c74
+  metadata.gz: 0bd80123c3cb687b3bdf9feae1bf82bbfbe71dcfd0a40714d5e698d4859e1578db55e2cf447f0c4515547053ac0d2f46379ab7593c038a221f84679f6c7bd263
+  data.tar.gz: 6fd59458857b94183c868f3c303f237bab322d455b9bb485a64282e6799ac188fd35bb30329ff903ae1a8bb5bf4bddcf9d1471290570085b44875ec854236c27

data/lib/head_music/composition.rb

@@ -45,6 +45,14 @@ class HeadMusic::Composition
     [voices.map(&:earliest_bar_number), 1].flatten.max
   end
 
+  def cantus_firmus_voice
+    voices.detect(&:cantus_firmus?)
+  end
+
+  def counterpoint_voice
+    voices.reject(&:cantus_firmus?).first
+  end
+
   private
 
   def ensure_attributes(name, key_signature, meter)

data/lib/head_music/key_signature.rb

@@ -3,8 +3,8 @@ class HeadMusic::KeySignature
   attr_reader :scale_type
   attr_reader :scale
 
-  SHARPS = %w{F# C# G# D# A# E# B#}
-  FLATS = %w{Bb Eb Ab Db Gb Cb Fb}
+  SHARPS = %w{F♯ C♯ G♯ D♯ A♯ E♯ B♯}
+  FLATS = %w{B♭ E♭ A♭ D♭ G♭ C♭ F♭}
 
   def self.default
     @default ||= new('C', :major)
@@ -14,7 +14,7 @@ class HeadMusic::KeySignature
     return identifier if identifier.is_a?(HeadMusic::KeySignature)
     @key_signatures ||= {}
     tonic_spelling, scale_type_name = identifier.strip.split(/\s/)
-    hash_key = HeadMusic::Utilities::HashKey.for(identifier.gsub(/#/, 'sharp').gsub(/b/, 'flat'))
+    hash_key = HeadMusic::Utilities::HashKey.for(identifier.gsub(/#|♯/, 'sharp').gsub(/b|♭/, 'flat'))
     @key_signatures[hash_key] ||= new(tonic_spelling, scale_type_name)
   end
 
@@ -55,7 +55,7 @@ class HeadMusic::KeySignature
   end
 
   def name
-    [tonic_spelling.to_s, scale_type.to_s].join(' ')
+    [tonic_spelling, scale_type].join(' ')
   end
 
   def ==(other)

data/lib/head_music/language.rb

@@ -0,0 +1,54 @@
+class HeadMusic::Language
+  include Comparable
+  include HeadMusic::NamedRudiment
+
+  LANGUAGES = [
+    { name: 'American English', short_name: 'English', abbreviation: 'en-US' },
+    { name: 'British English', abbreviation: 'en-GB' },
+    { name: 'French', native_name: 'Français', abbreviation: 'fr' },
+    { name: 'German', native_name: 'Deutsche', abbreviation: 'de' },
+    { name: 'Italian', native_name: 'Italiano', abbreviation: 'it' },
+    { name: 'Spanish', native_name: 'Español', abbreviation: 'es' },
+    { name: 'Russian', native_name: 'русский', abbreviation: 'ru' },
+  ]
+
+  LANGUAGES.map { |language| ::HeadMusic::Utilities::HashKey.for(language[:name]) }.each do |language_key|
+    define_singleton_method(language_key) { HeadMusic::Language.get(language_key) }
+  end
+
+  LANGUAGES.map { |language| ::HeadMusic::Utilities::HashKey.for(language[:native_name]) }.reject(&:nil?).each do |language_key|
+    define_singleton_method(language_key) { HeadMusic::Language.get(language_key) }
+  end
+
+  LANGUAGES.map { |language| ::HeadMusic::Utilities::HashKey.for(language[:short_name]) }.reject(&:nil?).each do |language_key|
+    define_singleton_method(language_key) { HeadMusic::Language.get(language_key) }
+  end
+
+  def self.default
+    self.english
+  end
+
+  def self.get(name)
+    get_by_name(name) || default
+  end
+
+  attr_accessor :name, :native_name, :short_name
+
+  def initialize(identifier)
+    identifier_key = HeadMusic::Utilities::HashKey.for(identifier)
+    language_data = LANGUAGES.detect { |data|
+      [:name, :native_name, :short_name].map { |key| HeadMusic::Utilities::HashKey.for(data[key]) }.include?(identifier_key)
+    }
+    @name = language_data[:name]
+    @native_name = language_data[:native_name]
+    @short_name = language_data[:short_name]
+  end
+
+  def <=>(other)
+    name.to_s <=> other.to_s
+  end
+
+  def inspect
+    [name, native_name, short_name].reject(&:nil?).join(' / ')
+  end
+end

data/lib/head_music/octave.rb

@@ -3,8 +3,6 @@ class HeadMusic::Octave
 
   DEFAULT = 4
 
-  MATCHER = /(-?\d+)$/
-
   def self.get(identifier)
     from_number(identifier) || from_name(identifier) || default
   end
@@ -18,7 +16,7 @@ class HeadMusic::Octave
 
   def self.from_name(string)
     if string.to_s.match(HeadMusic::Spelling::MATCHER)
-      _letter, _accidental, octave_string = string.to_s.match(HeadMusic::Spelling::MATCHER).captures
+      _letter, _sign, octave_string = string.to_s.match(HeadMusic::Spelling::MATCHER).captures
       @octaves ||= {}
       @octaves[octave_string.to_i] ||= new(octave_string.to_i) if octave_string
     end

data/lib/head_music/pitch.rb

@@ -5,9 +5,9 @@ class HeadMusic::Pitch
   attr_reader :octave
 
   delegate :letter_name, :letter_name_cycle, to: :spelling
-  delegate :accidental, :sharp?, :flat?, to: :spelling
+  delegate :sign, :sharp?, :flat?, to: :spelling
   delegate :pitch_class, to: :spelling
-  delegate :semitones, to: :accidental, prefix: true, allow_nil: true
+  delegate :semitones, to: :sign, prefix: true, allow_nil: true
 
   delegate :smallest_interval_to, to: :pitch_class
 
@@ -32,17 +32,17 @@ class HeadMusic::Pitch
     natural_letter_pitch = get(HeadMusic::LetterName.get(letter_name).pitch_class)
     natural_letter_pitch += 12 while (number - natural_letter_pitch.to_i).to_i >= 11
     natural_letter_pitch = get(natural_letter_pitch)
-    accidental_interval = natural_letter_pitch.smallest_interval_to(HeadMusic::PitchClass.get(number))
-    accidental = HeadMusic::Accidental.for_interval(accidental_interval)
-    spelling = HeadMusic::Spelling.fetch_or_create(letter_name, accidental)
+    sign_interval = natural_letter_pitch.smallest_interval_to(HeadMusic::PitchClass.get(number))
+    sign = HeadMusic::Sign.by(:semitones, sign_interval) if sign_interval != 0
+    spelling = HeadMusic::Spelling.fetch_or_create(letter_name, sign)
     fetch_or_create(spelling, natural_letter_pitch.octave)
   end
 
   def self.fetch_or_create(spelling, octave)
     @pitches ||= {}
     if spelling && (-1..9).include?(octave)
-      key = [spelling, octave].join
-      @pitches[key] ||= new(spelling, octave)
+      hash_key = [spelling, octave].join
+      @pitches[hash_key] ||= new(spelling, octave)
     end
   end
 
@@ -56,7 +56,7 @@ class HeadMusic::Pitch
   end
 
   def midi_note_number
-    (octave + 1) * 12 + letter_name.pitch_class.to_i + accidental_semitones.to_i
+    (octave + 1) * 12 + letter_name.pitch_class.to_i + sign_semitones.to_i
   end
 
   alias_method :midi, :midi_note_number
@@ -93,7 +93,8 @@ class HeadMusic::Pitch
   end
 
   def ==(value)
-    to_s == value.to_s
+    other = HeadMusic::Pitch.get(value)
+    to_s == other.to_s
   end
 
   def <=>(other)

data/lib/head_music/scale.rb

@@ -8,7 +8,7 @@ class HeadMusic::Scale
     root_pitch = HeadMusic::Pitch.get(root_pitch)
     scale_type = HeadMusic::ScaleType.get(scale_type || :major)
     @scales ||= {}
-    name = [root_pitch.to_s, scale_type].join(' ')
+    name = [root_pitch, scale_type].join(' ')
     hash_key = HeadMusic::Utilities::HashKey.for(name)
     @scales[hash_key] ||= new(root_pitch, scale_type)
   end

data/lib/head_music/scale_degree.rb

@@ -16,21 +16,20 @@ class HeadMusic::ScaleDegree
     scale.letter_name_cycle.index(spelling.letter_name.to_s) + 1
   end
 
-  def accidental
-    spelling.accidental
-    scale_degree_usual_spelling.accidental
-    accidental_semitones = spelling.accidental && spelling.accidental.semitones || 0
-    usual_accidental_semitones = scale_degree_usual_spelling.accidental && scale_degree_usual_spelling.accidental.semitones || 0
-    HeadMusic::Accidental.for_interval(accidental_semitones - usual_accidental_semitones)
+  def sign
+    sign_semitones = spelling.sign && spelling.sign.semitones || 0
+    usual_sign_semitones = scale_degree_usual_spelling.sign && scale_degree_usual_spelling.sign.semitones || 0
+    delta = sign_semitones - usual_sign_semitones
+    HeadMusic::Sign.by(:semitones, delta) if delta != 0
   end
 
   def to_s
-    "#{accidental}#{degree}"
+    "#{sign}#{degree}"
   end
 
   def <=>(other)
     if other.is_a?(HeadMusic::ScaleDegree)
-      [degree, accidental.semitones] <=> [other.degree, other.accidental.semitones]
+      [degree, sign.semitones] <=> [other.degree, other.sign.semitones]
     else
       to_s <=> other.to_s
     end
@@ -39,7 +38,7 @@ class HeadMusic::ScaleDegree
   def name_for_degree
     if scale_type.diatonic?
       NAME_FOR_DIATONIC_DEGREE[degree] ||
-      (scale_type.intervals.last == 1 || accidental == '#' ? 'leading tone' : 'subtonic')
+      (scale_type.intervals.last == 1 || sign == '#' ? 'leading tone' : 'subtonic')
     end
   end
 

data/lib/head_music/sign.rb

@@ -0,0 +1,72 @@
+class HeadMusic::Sign
+  include Comparable
+
+  attr_reader :identifier, :name, :ascii, :unicode, :html_entity, :cents
+
+  def self.all
+    @all ||= [
+      new(identifier: :sharp, name: 'sharp', ascii: '#', unicode: '♯', html_entity: '♯', cents: 100),
+      new(identifier: :flat, name: 'flat', ascii: 'b', unicode: "♭", html_entity: '♭', cents: -100),
+      new(identifier: :natural, name: 'natural', ascii: '', unicode: '♮', html_entity: '♮', cents: 0),
+      new(identifier: :double_sharp, name: 'double sharp', ascii: '##', unicode: '𝄪', html_entity: '𝄪', cents: 200),
+      new(identifier: :double_flat, name: 'double flat', ascii: 'bb', unicode: '𝄫', html_entity: '𝄫', cents: -200),
+    ]
+  end
+
+  def self.symbols
+    @sign_symbols ||= all.map { |sign| [sign.ascii, sign.unicode] }.flatten.reject { |s| s.nil? || s.empty? }
+  end
+
+  def self.matcher
+    @matcher ||= Regexp.new symbols.join('|')
+  end
+
+  def self.symbol?(candidate)
+    /^(#{matcher})$/.match?(candidate)
+  end
+
+  def self.get(identifier)
+    return identifier if identifier.is_a?(HeadMusic::Sign)
+    all.detect do |sign|
+      sign.representions.include?(identifier)
+    end
+  end
+
+  def self.by(key, value)
+    all.detect do |sign|
+      if %i[cents semitones].include?(key.to_sym)
+        sign.send(key) == value
+      end
+    end
+  end
+
+  def representions
+    [identifier, identifier.to_s, name, ascii, unicode, html_entity].reject { |representation| representation.to_s.strip == '' }
+  end
+
+  def semitones
+    cents / 100.0
+  end
+
+  def to_s
+    unicode
+  end
+
+  def <=>(other)
+    other = HeadMusic::Sign.get(other)
+    self.cents <=> other.cents
+  end
+
+  private
+
+  def initialize(attributes)
+    @identifier = attributes[:identifier]
+    @name = attributes[:name]
+    @ascii = attributes[:ascii]
+    @unicode = attributes[:unicode]
+    @html_entity = attributes[:html_entity]
+    @cents = attributes[:cents]
+  end
+
+  private_class_method :new
+end

data/lib/head_music/spelling.rb

@@ -1,9 +1,9 @@
 class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])([b#]*)(\-?\d+)?\s*$/i
+  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(\-?\d+)?\s*$/i
 
   attr_reader :pitch_class
   attr_reader :letter_name
-  attr_reader :accidental
+  attr_reader :sign
 
   delegate :number, to: :pitch_class, prefix: true
   delegate :to_i, to: :pitch_class_number
@@ -11,6 +11,7 @@ class HeadMusic::Spelling
   delegate :enharmonic?, to: :pitch_class
 
   def self.get(identifier)
+    return identifier if identifier.is_a?(HeadMusic::Spelling)
     from_name(identifier) || from_number(identifier)
   end
 
@@ -20,11 +21,11 @@ class HeadMusic::Spelling
 
   def self.from_name(name)
     if match(name)
-      letter_name, accidental_string, _octave = match(name).captures
+      letter_name, sign_string, _octave = match(name).captures
       letter_name = HeadMusic::LetterName.get(letter_name)
       return nil unless letter_name
-      accidental = HeadMusic::Accidental.get(accidental_string)
-      fetch_or_create(letter_name, accidental)
+      sign = HeadMusic::Sign.get(sign_string)
+      fetch_or_create(letter_name, sign)
     end
   end
 
@@ -38,26 +39,26 @@ class HeadMusic::Spelling
   def self.from_number_and_letter(number, letter_name)
     letter_name = HeadMusic::LetterName.get(letter_name)
     natural_letter_pitch_class = letter_name.pitch_class
-    accidental_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::PitchClass.get(number))
-    accidental = HeadMusic::Accidental.for_interval(accidental_interval)
-    fetch_or_create(letter_name, accidental)
+    sign_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::PitchClass.get(number))
+    sign = HeadMusic::Sign.by(:semitones, sign_interval) if sign_interval != 0
+    fetch_or_create(letter_name, sign)
   end
 
-  def self.fetch_or_create(letter_name, accidental)
+  def self.fetch_or_create(letter_name, sign)
     @spellings ||= {}
-    key = [letter_name, accidental].join
-    @spellings[key] ||= new(letter_name, accidental)
+    hash_key = [letter_name, sign].join
+    @spellings[hash_key] ||= new(letter_name, sign)
   end
 
-  def initialize(letter_name, accidental = nil)
+  def initialize(letter_name, sign = nil)
     @letter_name = HeadMusic::LetterName.get(letter_name.to_s)
-    @accidental = HeadMusic::Accidental.get(accidental.to_s)
-    accidental_semitones = @accidental ? @accidental.semitones : 0
-    @pitch_class = HeadMusic::PitchClass.get(letter_name.pitch_class + accidental_semitones)
+    @sign = HeadMusic::Sign.get(sign)
+    sign_semitones = @sign ? @sign.semitones : 0
+    @pitch_class = HeadMusic::PitchClass.get(letter_name.pitch_class + sign_semitones)
   end
 
   def name
-    [letter_name, accidental].join
+    [letter_name, sign].join
   end
 
   def to_s
@@ -65,15 +66,16 @@ class HeadMusic::Spelling
   end
 
   def sharp?
-    accidental && accidental == '#'
+    sign && sign == '#'
   end
 
   def flat?
-    accidental && accidental == 'b'
+    sign && sign == 'b'
   end
 
   def ==(value)
-    to_s == value.to_s
+    other = HeadMusic::Spelling.get(value)
+    to_s == other.to_s
   end
 
   def scale(scale_type_name = nil)

data/lib/head_music/style/annotations/diatonic.rb

@@ -14,7 +14,7 @@ class HeadMusic::Style::Annotations::Diatonic < HeadMusic::Style::Annotation
     notes_not_in_key.reject do |note|
       penultimate_note &&
       note == penultimate_note &&
-      HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).accidental == '#'
+      HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).sign == '#'
     end
   end
 

data/lib/head_music/version.rb

@@ -1,3 +1,3 @@
 module HeadMusic
-  VERSION = "0.16.2"
+  VERSION = "0.17.0"
 end

data/lib/head_music.rb

@@ -11,9 +11,13 @@ require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/string/access'
 require 'humanize'
 
+# utilities
+require 'head_music/utilities/hash_key'
+
+# modules
 require 'head_music/named_rudiment'
 
-require 'head_music/accidental'
+# rudiments
 require 'head_music/bar'
 require 'head_music/chord'
 require 'head_music/circle'
@@ -26,6 +30,7 @@ require 'head_music/harmonic_interval'
 require 'head_music/instrument'
 require 'head_music/interval'
 require 'head_music/key_signature'
+require 'head_music/language'
 require 'head_music/letter_name'
 require 'head_music/melodic_interval'
 require 'head_music/meter'
@@ -43,13 +48,17 @@ require 'head_music/rhythmic_value'
 require 'head_music/scale'
 require 'head_music/scale_degree'
 require 'head_music/scale_type'
+require 'head_music/sign'
 require 'head_music/spelling'
 require 'head_music/staff'
+require 'head_music/voice'
 
+# analysis
 require 'head_music/style/analysis'
 require 'head_music/style/annotation'
 require 'head_music/style/mark'
 
+# annotations
 require 'head_music/style/annotations/always_move'
 require 'head_music/style/annotations/approach_perfection_contrarily'
 require 'head_music/style/annotations/at_least_eight_notes'
@@ -84,10 +93,8 @@ require 'head_music/style/annotations/step_to_final_note'
 require 'head_music/style/annotations/step_up_to_final_note'
 require 'head_music/style/annotations/up_to_fourteen_notes'
 
+# rulesets
 require 'head_music/style/rulesets/fux_cantus_firmus'
 require 'head_music/style/rulesets/modern_cantus_firmus'
 require 'head_music/style/rulesets/first_species_melody'
 require 'head_music/style/rulesets/first_species_harmony'
-
-require 'head_music/utilities/hash_key'
-require 'head_music/voice'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,7 +116,6 @@ files:
 - circle.yml
 - head_music.gemspec
 - lib/head_music.rb
-- lib/head_music/accidental.rb
 - lib/head_music/bar.rb
 - lib/head_music/chord.rb
 - lib/head_music/circle.rb
@@ -129,6 +128,7 @@ files:
 - lib/head_music/instrument.rb
 - lib/head_music/interval.rb
 - lib/head_music/key_signature.rb
+- lib/head_music/language.rb
 - lib/head_music/letter_name.rb
 - lib/head_music/melodic_interval.rb
 - lib/head_music/meter.rb
@@ -147,6 +147,7 @@ files:
 - lib/head_music/scale.rb
 - lib/head_music/scale_degree.rb
 - lib/head_music/scale_type.rb
+- lib/head_music/sign.rb
 - lib/head_music/spelling.rb
 - lib/head_music/staff.rb
 - lib/head_music/style/analysis.rb

data/lib/head_music/accidental.rb

@@ -1,42 +0,0 @@
-class HeadMusic::Accidental
-  ACCIDENTAL_SEMITONES = {
-    '#' => 1,
-    '##' => 2,
-    'b' => -1,
-    'bb' => -2
-  }
-
-  attr_reader :string
-
-  def self.get(identifier)
-    for_symbol(identifier) || for_interval(identifier)
-  end
-
-  def self.for_symbol(identifier)
-    @accidentals ||= {}
-    @accidentals[identifier.to_s] ||= new(identifier.to_s) if ACCIDENTAL_SEMITONES.keys.include?(identifier.to_s)
-  end
-
-  def self.for_interval(semitones)
-    @accidentals ||= {}
-    @accidentals[semitones.to_i] ||= ACCIDENTAL_SEMITONES.key(semitones.to_i)
-  end
-
-  def initialize(string)
-    @string = string
-  end
-
-  def to_s
-    string
-  end
-
-  def ==(value)
-    to_s == value.to_s
-  end
-
-  def semitones
-    ACCIDENTAL_SEMITONES.fetch(string, 0)
-  end
-
-  private_class_method :new
-end