head_music 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2261f261fb02f64ef7142d521b9ac01c1cb1e2c8
-  data.tar.gz: de8ced9611c0b4c4db2e7e4449341095eaa82986
+  metadata.gz: 84558801b5df822669de2d7be0b1316dc711511a
+  data.tar.gz: c246dbb35d11e8b7815d56a6535420e00096c791
 SHA512:
-  metadata.gz: 5e8b3efc74e53e4a3ab83c56c16879c974111a5da9de8abe9c2b362ddea98c96ff43df38d06e6ec110ea00133fd5a208a4b41897b10a76ab01d3799173c1d508
-  data.tar.gz: a9765c3240a4cca996d25532d9d513fa3f4a0d0984209cbba2599fd1b7f221a6159e0ac6729e503f65861fdd0f259b9ad8bedc4f66379bbc2cbb895f2a29a97e
+  metadata.gz: 851820181797720920c79212516349316722dac6a4cd7889f917d2659543dbba5a39f7fce51ac8e5ed08302a1d51d7daa820e93f121bc8d3c681f1321441230e
+  data.tar.gz: ec6881d59cd432e3c392eeafcba2a34edc1c9d51f3842bb0832641546a86c3656c381ac0226c9865152532696e36e16644e59d7b3e54554eec6e9978c25d8c64

data/.rubocop.yml

@@ -8,7 +8,7 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
 
 Metrics/ClassLength:
-  Max: 120
+  Max: 150
 
 Metrics/LineLength:
   Max: 120

data/lib/head_music/clef.rb

@@ -7,7 +7,7 @@ class HeadMusic::Clef
   CLEFS = [
     { pitch: 'G4', line: 2, names: ['treble', 'G-clef'], modern: true },
     { pitch: 'G4', line: 1, names: ['French', 'French violin'] },
-    { pitch: 'G3', line: 2, names: ['tenor'], modern: true },
+    { pitch: 'G3', line: 2, names: ['choral tenor', 'tenor'], modern: true },
 
     { pitch: 'F3', line: 3, names: ['baritone'] },
     { pitch: 'F3', line: 4, names: ['bass', 'F-clef'], modern: true },
@@ -15,7 +15,7 @@ class HeadMusic::Clef
 
     { pitch: 'C4', line: 1, names: ['soprano'] },
     { pitch: 'C4', line: 2, names: ['mezzo-soprano'] },
-    { pitch: 'C4', line: 3, names: ['alto', 'viola', 'counter-tenor', 'countertenor'], modern: true },
+    { pitch: 'C4', line: 3, names: ['alto', 'viola', 'counter-tenor', 'countertenor', 'C-clef'], modern: true },
     { pitch: 'C4', line: 4, names: ['tenor'], modern: true },
     { pitch: 'C4', line: 5, names: ['baritone'] },
 

data/lib/head_music/key_signature.rb

@@ -17,7 +17,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(/(\w)[b♭]/, '\\1 flat'))
     @key_signatures[hash_key] ||= new(tonic_spelling, scale_type_name)
   end
 
@@ -67,4 +67,50 @@ class HeadMusic::KeySignature
   def ==(other)
     signs == self.class.get(other).signs
   end
+
+  def to_s
+    if sharps.any?
+      sharps.length == 1 ? '1 sharp' : "#{sharps.length} sharps"
+    elsif flats.any?
+      flats.length == 1 ? '1 flat' : "#{flats.length} flats"
+    else
+      'no sharps or flats'
+    end
+  end
+
+  def enharmonic_equivalent?(other)
+    other = KeySignature.get(other)
+    enharmonic_equivalence.equivalent?(other)
+  end
+
+  private
+
+  def enharmonic_equivalence
+    @enharmonic_equivalence ||= EnharmonicEquivalence.get(self)
+  end
+
+  # Key signatures are enharmonic when all pitch classes in one are respellings of the pitch classes in the other.
+  class EnharmonicEquivalence
+    def self.get(key_signature)
+      key_signature = HeadMusic::KeySignature.get(key_signature)
+      @enharmonic_equivalences ||= {}
+      @enharmonic_equivalences[key_signature.to_s] ||= new(key_signature)
+    end
+
+    attr_reader :key_signature
+
+    def initialize(key_signature)
+      @key_signature = HeadMusic::KeySignature.get(key_signature)
+    end
+
+    def enharmonic_equivalent?(other)
+      other = HeadMusic::KeySignature.get(other)
+      (key_signature.signs | other.signs).map(&:to_s).uniq.length == 12
+    end
+
+    alias enharmonic? enharmonic_equivalent?
+    alias equivalent? enharmonic_equivalent?
+
+    private_class_method :new
+  end
 end

data/lib/head_music/pitch.rb

@@ -171,7 +171,7 @@ class HeadMusic::Pitch
     @target_letter_name[num_steps] ||= letter_name.steps(num_steps)
   end
 
-  # Enharmonic equivalence occurs when two pitches are spelled differently but refer to the same frequency, such as D♯ and E♭.
+  # An enharmonic equivalent pitch is the same frequency spelled differently, such as D# and Eb.
   class EnharmonicEquivalence
     def self.get(pitch)
       pitch = HeadMusic::Pitch.get(pitch)

data/lib/head_music/pitch_class.rb

@@ -64,7 +64,7 @@ class HeadMusic::PitchClass
   end
 
   def white_key?
-    [0,2,4,5,7,9,11].include?(number)
+    [0, 2, 4, 5, 7, 9, 11].include?(number)
   end
 
   def black_key?

data/lib/head_music/scale.rb

@@ -9,8 +9,9 @@ class HeadMusic::Scale
     root_pitch = HeadMusic::Pitch.get(root_pitch)
     scale_type = HeadMusic::ScaleType.get(scale_type || :major)
     @scales ||= {}
-    name = [root_pitch, scale_type].join(' ')
-    hash_key = HeadMusic::Utilities::HashKey.for(name)
+    hash_key = HeadMusic::Utilities::HashKey.for(
+      [root_pitch, scale_type].join(' ').gsub(/#|♯/, 'sharp').gsub(/(\w)[b♭]/, '\\1flat')
+    )
     @scales[hash_key] ||= new(root_pitch, scale_type)
   end
 

data/lib/head_music/spelling.rb

@@ -13,7 +13,7 @@ class HeadMusic::Spelling
   delegate :number, to: :pitch_class, prefix: true
   delegate :to_i, to: :pitch_class_number
   delegate :cycle, to: :letter_name, prefix: true
-  delegate :enharmonic?, to: :pitch_class
+  delegate :enharmonic?, to: :enharmonic_equivalence
 
   def self.get(identifier)
     return identifier if identifier.is_a?(HeadMusic::Spelling)
@@ -88,7 +88,13 @@ class HeadMusic::Spelling
 
   private_class_method :new
 
-  # Enharmonic equivalence occurs when two spellings refer to the same pitch class, such as D♯ and E♭.
+  private
+
+  def enharmonic_equivalence
+    @enharmonic_equivalence ||= EnharmonicEquivalence.get(self)
+  end
+
+  # Enharmonic equivalence occurs when two spellings refer to the same pitch class, such as D# and Eb.
   class EnharmonicEquivalence
     def self.get(spelling)
       spelling = HeadMusic::Spelling.get(spelling)

data/lib/head_music/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeadMusic
-  VERSION = '0.19.2'
+  VERSION = '0.20.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport