head_music 5.0.0 → 6.0.1

data/lib/head_music/instrument/{pitch_configuration.rb → pitch_variant.rb}

@@ -1,4 +1,4 @@
-class HeadMusic::Instrument::PitchConfiguration
+class HeadMusic::Instrument::PitchVariant
   attr_reader :key, :attributes
 
   def initialize(key, attributes = {})
@@ -13,12 +13,12 @@ class HeadMusic::Instrument::PitchConfiguration
       HeadMusic::Spelling.get(attributes["fundamental_pitch_spelling"])
   end
 
-  def staff_configurations
-    @staff_configurations ||=
-      (attributes["staff_configurations"] || {}).map do |key, list|
-        HeadMusic::Instrument::StaffConfiguration.new(
+  def staff_schemes
+    @staff_schemes ||=
+      (attributes["staff_schemes"] || {}).map do |key, list|
+        HeadMusic::Instrument::StaffScheme.new(
           key: key,
-          pitch_configuration: self,
+          pitch_variant: self,
           list: list
         )
       end
@@ -28,8 +28,8 @@ class HeadMusic::Instrument::PitchConfiguration
     key.to_s == "default"
   end
 
-  def default_staff_configuration
-    @default_staff_configuration ||=
-      staff_configurations.find(&:default?) || staff_configurations.first
+  def default_staff_scheme
+    @default_staff_scheme ||=
+      staff_schemes.find(&:default?) || staff_schemes.first
   end
 end

data/lib/head_music/instrument/staff.rb

@@ -1,10 +1,10 @@
 class HeadMusic::Instrument::Staff
   DEFAULT_CLEF = "treble_clef"
 
-  attr_reader :staff_configuration, :attributes
+  attr_reader :staff_scheme, :attributes
 
-  def initialize(staff_configuration, attributes)
-    @staff_configuration = staff_configuration
+  def initialize(staff_scheme, attributes)
+    @staff_scheme = staff_scheme
     @attributes = attributes || {}
   end
 
@@ -21,7 +21,7 @@ class HeadMusic::Instrument::Staff
   end
 
   def name_key
-    attributes["name_key"]
+    attributes["name_key"] || ""
   end
 
   def name

data/lib/head_music/instrument/{staff_configuration.rb → staff_scheme.rb}

@@ -1,8 +1,8 @@
-class HeadMusic::Instrument::StaffConfiguration
-  attr_reader :pitch_configuration, :key, :list
+class HeadMusic::Instrument::StaffScheme
+  attr_reader :pitch_variant, :key, :list
 
-  def initialize(pitch_configuration:, key:, list:)
-    @pitch_configuration = pitch_configuration
+  def initialize(pitch_variant:, key:, list:)
+    @pitch_variant = pitch_variant
     @key = key || "default"
     @list = list
   end

data/lib/head_music/instrument.rb

@@ -9,7 +9,7 @@
 #   default_clefs: the default clef or system of clefs for the instrument
 #     - [treble] for instruments that use the treble clef
 #     - [treble, bass] for instruments that use the grand staff
-#   pitch_configurations:
+#   pitch_variants:
 #     a hash of default and alternative fundamental pitches.
 # Associations:
 #   family: the family of the instrument (e.g. "saxophone")
@@ -32,7 +32,7 @@ class HeadMusic::Instrument
   attr_reader(
     :name_key, :alias_name_keys,
     :family_key, :orchestra_section_key,
-    :pitch_configurations, :classification_keys
+    :pitch_variants, :classification_keys
   )
 
   def ==(other)
@@ -75,16 +75,16 @@ class HeadMusic::Instrument
     default_clefs.any?
   end
 
-  def default_pitch_configuration
-    pitch_configurations.find(&:default?) || pitch_configurations.first
+  def default_pitch_variant
+    pitch_variants.find(&:default?) || pitch_variants.first
   end
 
-  def default_staff_configuration
-    default_pitch_configuration&.default_staff_configuration
+  def default_staff_scheme
+    default_pitch_variant&.default_staff_scheme
   end
 
   def default_staves
-    default_staff_configuration&.staves || []
+    default_staff_scheme&.staves || []
   end
 
   def default_clefs
@@ -158,9 +158,9 @@ class HeadMusic::Instrument
   def initialize_attributes(record)
     @orchestra_section_key ||= record["orchestra_section_key"]
     @classification_keys = [@classification_keys, record["classification_keys"]].flatten.compact.uniq
-    @pitch_configurations =
-      (record["pitch_configurations"] || {}).map do |key, attributes|
-        HeadMusic::Instrument::PitchConfiguration.new(key, attributes)
+    @pitch_variants =
+      (record["pitch_variants"] || {}).map do |key, attributes|
+        HeadMusic::Instrument::PitchVariant.new(key, attributes)
       end
   end
 

data/lib/head_music/key_signature/enharmonic_equivalence.rb

@@ -0,0 +1,30 @@
+# Key signatures are enharmonic when all pitch classes in one are respellings of the pitch classes in the other.
+class HeadMusic::KeySignature::EnharmonicEquivalence
+  attr_reader :key_signature
+
+  def self.get(key_signature)
+    key_signature = HeadMusic::KeySignature.get(key_signature)
+    @enharmonic_equivalences ||= {}
+    @enharmonic_equivalences[key_signature.to_s] ||= new(key_signature)
+  end
+
+  def initialize(key_signature)
+    @key_signature = HeadMusic::KeySignature.get(key_signature)
+  end
+
+  def enharmonic_equivalent?(other)
+    other = HeadMusic::KeySignature.get(other)
+
+    p key_signature.pitch_classes.map(&:to_i).sort
+    p other.pitch_classes.map(&:to_i).sort
+    p key_signature.alterations.map(&:to_s).sort
+    p other.alterations.map(&:to_s).sort
+    key_signature.pitch_classes.map(&:to_i).sort == other.pitch_classes.map(&:to_i).sort &&
+      key_signature.alterations.map(&:to_s).sort != other.alterations.map(&:to_s).sort
+  end
+
+  # alias_method :enharmonic?, :enharmonic_equivalent?
+  # alias_method :equivalent?, :enharmonic_equivalent?
+
+  private_class_method :new
+end

data/lib/head_music/key_signature.rb

@@ -21,7 +21,7 @@ class HeadMusic::KeySignature
 
   delegate :pitch_class, to: :tonic_spelling, prefix: :tonic
   delegate :to_s, to: :name
-  delegate :pitches, to: :scale
+  delegate :pitches, :pitch_classes, to: :scale
 
   def initialize(tonic_spelling, scale_type = nil)
     @tonic_spelling = HeadMusic::Spelling.get(tonic_spelling)
@@ -67,19 +67,23 @@ class HeadMusic::KeySignature
     flats.length + double_flats.length * 2
   end
 
-  def signs
-    flats.any? ? flats : sharps
+  def num_alterations
+    num_sharps + num_flats
   end
 
-  alias_method :sharps_and_flats, :signs
-  alias_method :accidentals, :signs
+  def alterations
+    flats.any? ? (double_flats + flats) : (double_sharps + sharps)
+  end
+
+  alias_method :sharps_and_flats, :alterations
+  alias_method :accidentals, :alterations
 
   def name
     [tonic_spelling, scale_type].join(" ")
   end
 
   def ==(other)
-    signs == self.class.get(other).signs
+    alterations == self.class.get(other).alterations
   end
 
   def to_s
@@ -93,38 +97,12 @@ class HeadMusic::KeySignature
   end
 
   def enharmonic_equivalent?(other)
-    other = KeySignature.get(other)
-    enharmonic_equivalence.equivalent?(other)
+    enharmonic_equivalence.enharmonic_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_method :enharmonic?, :enharmonic_equivalent?
-    alias_method :equivalent?, :enharmonic_equivalent?
-
-    private_class_method :new
+    @enharmonic_equivalence ||= HeadMusic::KeySignature::EnharmonicEquivalence.get(self)
   end
 end

data/lib/head_music/motion.rb

@@ -48,7 +48,9 @@ class HeadMusic::Motion
   end
 
   def to_s
-    "#{contrapuntal_motion} motion from #{first_harmonic_interval} to #{second_harmonic_interval}"
+    return "repetition of a #{second_harmonic_interval}" unless contrapuntal_motion != :repetition
+
+    "#{contrapuntal_motion} motion from a #{first_harmonic_interval} to a #{second_harmonic_interval}"
   end
 
   private

data/lib/head_music/pitch_class_set.rb

@@ -10,13 +10,10 @@ class HeadMusic::PitchClassSet
     @pitch_classes = identifiers.map { |identifier| HeadMusic::PitchClass.get(identifier) }.uniq.sort
   end
 
-  def inspect
-    pitch_classes.map(&:to_s).join(" ")
-  end
-
   def to_s
-    pitch_classes.map(&:to_s).join(" ")
+    pitch_classes.map(&:to_i).inspect
   end
+  alias_method :inspect, :to_s
 
   def ==(other)
     pitch_classes == other.pitch_classes

data/lib/head_music/scale.rb

@@ -28,6 +28,10 @@ class HeadMusic::Scale
     @pitches[direction][octaves] ||= determine_scale_pitches(direction, octaves)
   end
 
+  def pitch_classes
+    pitches.map(&:pitch_class).uniq
+  end
+
   def spellings(direction: :ascending, octaves: 1)
     pitches(direction: direction, octaves: octaves).map(&:spelling).map(&:to_s)
   end

data/lib/head_music/version.rb

@@ -1,3 +1,3 @@
 module HeadMusic
-  VERSION = "5.0.0"
+  VERSION = "6.0.1"
 end

data/lib/head_music.rb

@@ -41,11 +41,12 @@ require "head_music/diatonic_interval"
 require "head_music/harmonic_interval"
 require "head_music/instrument_family"
 require "head_music/instrument"
-require "head_music/instrument/pitch_configuration"
-require "head_music/instrument/staff_configuration"
+require "head_music/instrument/pitch_variant"
+require "head_music/instrument/staff_scheme"
 require "head_music/instrument/staff"
 require "head_music/interval_cycle"
 require "head_music/key_signature"
+require "head_music/key_signature/enharmonic_equivalence"
 require "head_music/letter_name"
 require "head_music/melodic_interval"
 require "head_music/meter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Rob Head
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,12 +138,13 @@ files:
 - lib/head_music/diatonic_interval.rb
 - lib/head_music/harmonic_interval.rb
 - lib/head_music/instrument.rb
-- lib/head_music/instrument/pitch_configuration.rb
+- lib/head_music/instrument/pitch_variant.rb
 - lib/head_music/instrument/staff.rb
-- lib/head_music/instrument/staff_configuration.rb
+- lib/head_music/instrument/staff_scheme.rb
 - lib/head_music/instrument_family.rb
 - lib/head_music/interval_cycle.rb
 - lib/head_music/key_signature.rb
+- lib/head_music/key_signature/enharmonic_equivalence.rb
 - lib/head_music/letter_name.rb
 - lib/head_music/locales/de.yml
 - lib/head_music/locales/en.yml