head_music 0.26.3 → 0.28.0

data/lib/head_music/instrument.rb

@@ -4,7 +4,7 @@
 class HeadMusic::Instrument
   include HeadMusic::Named
 
-  INSTRUMENTS = YAML.load_file(File.expand_path('data/instruments.yml', __dir__)).freeze
+  INSTRUMENTS = YAML.load_file(File.expand_path("data/instruments.yml", __dir__)).freeze
 
   def self.get(name)
     return get_by_name(name) if get_by_name(name)
@@ -59,20 +59,20 @@ class HeadMusic::Instrument
 
   def record_for_key(key)
     INSTRUMENTS.each do |name_key, data|
-      return data.merge!('name_key' => name_key) if name_key.to_s == key.to_s
+      return data.merge!("name_key" => name_key) if name_key.to_s == key.to_s
     end
     nil
   end
 
   def initialize_data_from_record(record)
-    @name_key = record['name_key'].to_sym
-    @family = record['family']
-    @standard_staves = record['standard_staves'] || []
-    @classifications = record['classifications'] || []
-    self.name = I18n.translate(name_key, scope: 'instruments', locale: 'en', default: inferred_name)
+    @name_key = record["name_key"].to_sym
+    @family = record["family"]
+    @standard_staves = record["standard_staves"] || []
+    @classifications = record["classifications"] || []
+    self.name = I18n.translate(name_key, scope: "instruments", locale: "en", default: inferred_name)
   end
 
   def inferred_name
-    name_key.to_s.gsub(/_/, ' ')
+    name_key.to_s.tr("_", " ")
   end
 end

data/lib/head_music/interval_cycle.rb

@@ -6,12 +6,12 @@ class HeadMusic::IntervalCycle
 
   def self.get(interval = 7)
     @interval_cycles ||= {}
-    interval = interval.to_s.gsub(/^C/i, '').to_i
+    interval = interval.to_s.gsub(/^C/i, "").to_i
     interval = HeadMusic::ChromaticInterval.get(interval)
-    @interval_cycles[interval.to_i] ||= new(interval: interval, starting_pitch: 'C4')
+    @interval_cycles[interval.to_i] ||= new(interval: interval, starting_pitch: "C4")
   end
 
-  def initialize(interval:, starting_pitch: 'C4')
+  def initialize(interval:, starting_pitch: "C4")
     @interval = interval if interval.is_a?(HeadMusic::DiatonicInterval)
     @interval ||= interval if interval.is_a?(HeadMusic::ChromaticInterval)
     @interval ||= HeadMusic::ChromaticInterval.get(interval) if interval.to_s.match?(/\d/)
@@ -38,15 +38,13 @@ class HeadMusic::IntervalCycle
   protected
 
   def pitches_up
-    @pitches_up ||= begin
-      [starting_pitch].tap do |list|
-        loop do
-          next_pitch = list.last + interval
-          next_pitch -= octave while next_pitch - starting_pitch > 12
-          break if next_pitch.pitch_class == list.first.pitch_class
-
-          list << next_pitch
-        end
+    @pitches_up ||= [starting_pitch].tap do |list|
+      loop do
+        next_pitch = list.last + interval
+        next_pitch -= octave while next_pitch - starting_pitch > 12
+        break if next_pitch.pitch_class == list.first.pitch_class
+
+        list << next_pitch
       end
     end
   end

data/lib/head_music/key_signature.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
 # Represents a key signature.
+# In French, sharps and flats in the key signature are called "altérations".
 class HeadMusic::KeySignature
-  attr_reader :tonic_spelling
-  attr_reader :scale_type
-  attr_reader :scale
+  attr_reader :tonic_spelling, :scale_type, :scale
 
   ORDERED_LETTER_NAMES_OF_SHARPS = %w[F C G D A E B].freeze
   ORDERED_LETTER_NAMES_OF_FLATS = ORDERED_LETTER_NAMES_OF_SHARPS.reverse.freeze
 
   def self.default
-    @default ||= new('C', :major)
+    @default ||= new("C", :major)
   end
 
   def self.get(identifier)
@@ -18,7 +17,7 @@ class HeadMusic::KeySignature
 
     @key_signatures ||= {}
     tonic_spelling, scale_type_name = identifier.strip.split(/\s/)
-    hash_key = HeadMusic::Utilities::HashKey.for(identifier.gsub(/#|♯/, ' sharp').gsub(/(\w)[b♭]/, '\\1 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
 
@@ -74,11 +73,11 @@ class HeadMusic::KeySignature
     flats.any? ? flats : sharps
   end
 
-  alias sharps_and_flats signs
-  alias accidentals signs
+  alias_method :sharps_and_flats, :signs
+  alias_method :accidentals, :signs
 
   def name
-    [tonic_spelling, scale_type].join(' ')
+    [tonic_spelling, scale_type].join(" ")
   end
 
   def ==(other)
@@ -87,11 +86,11 @@ class HeadMusic::KeySignature
 
   def to_s
     if sharps.any?
-      sharps.length == 1 ? '1 sharp' : "#{sharps.length} sharps"
+      (sharps.length == 1) ? "1 sharp" : "#{sharps.length} sharps"
     elsif flats.any?
-      flats.length == 1 ? '1 flat' : "#{flats.length} flats"
+      (flats.length == 1) ? "1 flat" : "#{flats.length} flats"
     else
-      'no sharps or flats'
+      "no sharps or flats"
     end
   end
 
@@ -125,8 +124,8 @@ class HeadMusic::KeySignature
       (key_signature.signs | other.signs).map(&:to_s).uniq.length == 12
     end
 
-    alias enharmonic? enharmonic_equivalent?
-    alias equivalent? enharmonic_equivalent?
+    alias_method :enharmonic?, :enharmonic_equivalent?
+    alias_method :equivalent?, :enharmonic_equivalent?
 
     private_class_method :new
   end

data/lib/head_music/letter_name.rb

@@ -5,13 +5,13 @@ class HeadMusic::LetterName
   NAMES = %w[C D E F G A B].freeze
 
   NATURAL_PITCH_CLASS_NUMBERS = {
-    'C' => 0,
-    'D' => 2,
-    'E' => 4,
-    'F' => 5,
-    'G' => 7,
-    'A' => 9,
-    'B' => 11,
+    "C" => 0,
+    "D" => 2,
+    "E" => 4,
+    "F" => 5,
+    "G" => 7,
+    "A" => 9,
+    "B" => 11
   }.freeze
 
   def self.all

data/lib/head_music/melodic_interval.rb

@@ -38,7 +38,7 @@ class HeadMusic::MelodicInterval
   end
 
   def to_s
-    [direction, diatonic_interval].join(' ')
+    [direction, diatonic_interval].join(" ")
   end
 
   def ascending?

data/lib/head_music/meter.rb

@@ -5,8 +5,8 @@ class HeadMusic::Meter
   attr_reader :top_number, :bottom_number
 
   NAMED = {
-    common_time: '4/4',
-    cut_time: '2/2',
+    common_time: "4/4",
+    cut_time: "2/2"
   }.freeze
 
   def self.get(identifier)
@@ -14,11 +14,11 @@ class HeadMusic::Meter
     hash_key = HeadMusic::Utilities::HashKey.for(identifier)
     time_signature_string = NAMED[hash_key] || identifier
     @meters ||= {}
-    @meters[hash_key] ||= new(*time_signature_string.split('/').map(&:to_i))
+    @meters[hash_key] ||= new(*time_signature_string.split("/").map(&:to_i))
   end
 
   def self.default
-    get('4/4')
+    get("4/4")
   end
 
   def self.common_time
@@ -39,7 +39,7 @@ class HeadMusic::Meter
   end
 
   def compound?
-    top_number > 3 && top_number / 3 == top_number / 3.0
+    top_number > 3 && (top_number % 3).zero?
   end
 
   def duple?
@@ -89,7 +89,7 @@ class HeadMusic::Meter
   end
 
   def to_s
-    [top_number, bottom_number].join('/')
+    [top_number, bottom_number].join("/")
   end
 
   def ==(other)
@@ -97,10 +97,8 @@ class HeadMusic::Meter
   end
 
   def strong_counts
-    @strong_counts ||= begin
-      (1..counts_per_bar).select do |count|
-        downbeat?(count) || strong_beat_in_duple?(count) || strong_beat_in_triple?(count)
-      end
+    @strong_counts ||= (1..counts_per_bar).select do |count|
+      downbeat?(count) || strong_beat_in_duple?(count) || strong_beat_in_triple?(count)
     end
   end
 
@@ -119,11 +117,18 @@ class HeadMusic::Meter
   end
 
   def strong_beat_in_duple?(count, tick = 0)
-    beat?(tick) && (count == counts_per_bar / 2.0 + 1)
+    return false unless beat?(tick)
+    return false unless counts_per_bar.even?
+
+    (count - 1) == counts_per_bar / 2
   end
 
   def strong_beat_in_triple?(count, tick = 0)
-    beat?(tick) && (counts_per_bar % 3).zero? && counts_per_bar > 6 && count % 3 == 1
+    return false unless beat?(tick)
+    return false unless (counts_per_bar % 3).zero?
+    return false if counts_per_bar < 6
+
+    count % 3 == 1
   end
 
   def beat?(tick)

data/lib/head_music/named.rb

@@ -16,10 +16,10 @@ module HeadMusic::Named
 
     def self.get(code)
       @locales ||= {}
-      parts = code.to_s.split(/[_\-]/)
+      parts = code.to_s.split(/[_-]/)
       language = parts[0].downcase
       region = parts[1]&.upcase
-      key = [language, region].compact.join('_').to_sym
+      key = [language, region].compact.join("_").to_sym
       @locales[key] ||= new(language: language, region: region)
     end
 
@@ -29,7 +29,7 @@ module HeadMusic::Named
     end
 
     def code
-      @code ||= [@language, @region].compact.join('_')
+      @code ||= [@language, @region].compact.join("_")
     end
 
     private_class_method :new

data/lib/head_music/pitch/enharmonic_equivalence.rb

@@ -21,8 +21,8 @@ class HeadMusic::Pitch::EnharmonicEquivalence
     pitch.midi_note_number == other.midi_note_number && pitch.spelling != other.spelling
   end
 
-  alias enharmonic? enharmonic_equivalent?
-  alias equivalent? enharmonic_equivalent?
+  alias_method :enharmonic?, :enharmonic_equivalent?
+  alias_method :equivalent?, :enharmonic_equivalent?
 
   private_class_method :new
 end

data/lib/head_music/pitch/octave_equivalence.rb

@@ -18,7 +18,7 @@ class HeadMusic::Pitch::OctaveEquivalence
     pitch.spelling == other.spelling && pitch.register != other.register
   end
 
-  alias equivalent? octave_equivalent?
+  alias_method :equivalent?, :octave_equivalent?
 
   private_class_method :new
 end

data/lib/head_music/pitch.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# A pitch is a named frequency represented by a spelling and an octive.
+# A pitch is a named frequency represented by a spelling and a register.
 class HeadMusic::Pitch
   include Comparable
 
@@ -34,11 +34,11 @@ class HeadMusic::Pitch
   end
 
   def self.middle_c
-    get('C4')
+    get("C4")
   end
 
   def self.concert_a
-    get('A4')
+    get("A4")
   end
 
   def self.from_pitch_class(pitch_class)
@@ -97,8 +97,8 @@ class HeadMusic::Pitch
     (register + 1) * 12 + letter_name.pitch_class.to_i + sign_semitones.to_i
   end
 
-  alias midi midi_note_number
-  alias number midi_note_number
+  alias_method :midi, :midi_note_number
+  alias_method :number, :midi_note_number
 
   def to_s
     name
@@ -108,8 +108,12 @@ class HeadMusic::Pitch
     midi_note_number
   end
 
+  def helmholtz_notation
+    helmholtz_letter_name + helmholtz_marks
+  end
+
   def natural
-    HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Sign.matcher, ''))
+    HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Sign.matcher, ""))
   end
 
   def +(other)
@@ -123,10 +127,11 @@ class HeadMusic::Pitch
   end
 
   def -(other)
-    if other.is_a?(HeadMusic::DiatonicInterval)
+    case other
+    when HeadMusic::DiatonicInterval
       # return a pitch
       other.below(self)
-    elsif other.is_a?(HeadMusic::Pitch)
+    when HeadMusic::Pitch
       # return an interval
       HeadMusic::ChromaticInterval.get(to_i - other.to_i)
     else
@@ -190,7 +195,7 @@ class HeadMusic::Pitch
   end
 
   def octaves_delta(num_steps)
-    octaves_delta = (num_steps.abs / 7) * (num_steps >= 0 ? 1 : -1)
+    octaves_delta = (num_steps.abs / 7) * ((num_steps >= 0) ? 1 : -1)
     if wrapped_down?(num_steps)
       octaves_delta -= 1
     elsif wrapped_up?(num_steps)
@@ -211,4 +216,14 @@ class HeadMusic::Pitch
     @target_letter_name ||= {}
     @target_letter_name[num_steps] ||= letter_name.steps_up(num_steps)
   end
+
+  def helmholtz_letter_name
+    return spelling.to_s.downcase if HeadMusic::Register.get(register).helmholtz_case == :lower
+
+    spelling.to_s
+  end
+
+  def helmholtz_marks
+    HeadMusic::Register.get(register).helmholtz_marks
+  end
 end

data/lib/head_music/pitch_class.rb

@@ -4,11 +4,11 @@
 class HeadMusic::PitchClass
   include Comparable
 
-  attr_reader :number
-  attr_reader :spelling
+  attr_reader :number, :spelling
 
   SHARP_SPELLINGS = %w[C C♯ D D♯ E F F♯ G G♯ A A♯ B].freeze
   FLAT_SPELLINGS = %w[C D♭ D E♭ E F G♭ G A♭ A B♭ B].freeze
+  FLATTER_SPELLINGS = %w[C D♭ D E♭ F♭ F G♭ G A♭ A B♭ C♭].freeze
   INTEGER_NOTATION = %w[0 1 2 3 4 5 6 7 8 9 t e].freeze
 
   def self.get(identifier)
@@ -22,7 +22,7 @@ class HeadMusic::PitchClass
   end
 
   class << self
-    alias [] get
+    alias_method :[], :get
   end
 
   def initialize(pitch_class_or_midi_number)
@@ -45,6 +45,20 @@ class HeadMusic::PitchClass
     FLAT_SPELLINGS[number]
   end
 
+  def flatter_spelling
+    FLATTER_SPELLINGS[number]
+  end
+
+  def smart_spelling(max_sharps_in_major_key_signature: 6)
+    sharp_key = HeadMusic::KeySignature.get(sharp_spelling)
+    return HeadMusic::Spelling.get(sharp_spelling) if sharp_key.num_sharps <= max_sharps_in_major_key_signature
+
+    flat_key = HeadMusic::KeySignature.get(flat_spelling)
+    return HeadMusic::Spelling.get(flat_spelling) if flat_key.num_sharps <= max_sharps_in_major_key_signature
+
+    HeadMusic::Spelling.get(flatter_spelling)
+  end
+
   # Pass in the number of semitones
   def +(other)
     HeadMusic::PitchClass.get(to_i + other.to_i)
@@ -58,7 +72,7 @@ class HeadMusic::PitchClass
   def ==(other)
     to_i == other.to_i
   end
-  alias enharmonic? ==
+  alias_method :enharmonic?, :==
 
   def <=>(other)
     to_i <=> other.to_i

data/lib/head_music/pitch_class_set.rb

@@ -6,18 +6,18 @@ class HeadMusic::PitchClassSet
   attr_reader :pitch_classes
 
   delegate :empty?, to: :pitch_classes
-  alias empty_set? empty?
+  alias_method :empty_set?, :empty?
 
   def initialize(identifiers)
     @pitch_classes = identifiers.map { |identifier| HeadMusic::PitchClass.get(identifier) }.uniq.sort
   end
 
   def inspect
-    pitch_classes.map(&:to_s).join(' ')
+    pitch_classes.map(&:to_s).join(" ")
   end
 
   def to_s
-    pitch_classes.map(&:to_s).join(' ')
+    pitch_classes.map(&:to_s).join(" ")
   end
 
   def ==(other)
@@ -35,12 +35,12 @@ class HeadMusic::PitchClassSet
   def monochord?
     pitch_classes.length == 1
   end
-  alias monad? monochord?
+  alias_method :monad?, :monochord?
 
   def dichord?
     pitch_classes.length == 2
   end
-  alias dyad? dichord?
+  alias_method :dyad?, :dichord?
 
   def trichord?
     pitch_classes.length == 3

data/lib/head_music/pitch_set.rb

@@ -9,7 +9,7 @@ class HeadMusic::PitchSet
     seventh_chord: [3, 5, 7],
     ninth_chord: [2, 3, 5, 7],
     eleventh_chord: [2, 3, 4, 5, 7],
-    thirteenth_chord: [2, 3, 4, 5, 6, 7], # a.k.a. diatonic scale
+    thirteenth_chord: [2, 3, 4, 5, 6, 7] # a.k.a. diatonic scale
   }.freeze
 
   attr_reader :pitches
@@ -54,20 +54,23 @@ class HeadMusic::PitchSet
   end
 
   def integer_notation
+    # questions:
+    # - should this be absolute? 0 = C?
+    # - should there be both absolute and relative versions?
     @integer_notation ||= begin
       return [] if pitches.empty?
-      diatonic_intervals_above_bass_pitch.map { |interval| interval.semitones % 12 }.flatten.sort.unshift(0)
+      diatonic_intervals_above_bass_pitch.map { |interval| interval.semitones % 12 }.flatten.sort.unshift(0).uniq
     end
   end
 
   def invert
-    inverted_pitch = pitches[0] + HeadMusic::DiatonicInterval.get('perfect octave')
+    inverted_pitch = pitches[0] + HeadMusic::DiatonicInterval.get("perfect octave")
     new_pitches = pitches.drop(1) + [inverted_pitch]
     HeadMusic::PitchSet.new(new_pitches)
   end
 
   def uninvert
-    inverted_pitch = pitches[-1] - HeadMusic::DiatonicInterval.get('perfect octave')
+    inverted_pitch = pitches[-1] - HeadMusic::DiatonicInterval.get("perfect octave")
     new_pitches = [inverted_pitch] + pitches[0..-2]
     HeadMusic::PitchSet.new(new_pitches)
   end
@@ -77,11 +80,11 @@ class HeadMusic::PitchSet
   end
 
   def inspect
-    pitches.map(&:to_s).join(' ')
+    pitches.map(&:to_s).join(" ")
   end
 
   def to_s
-    pitches.map(&:to_s).join(' ')
+    pitches.map(&:to_s).join(" ")
   end
 
   def ==(other)

data/lib/head_music/quality.rb

@@ -3,13 +3,13 @@
 # A quality is a categorization of an interval.
 class HeadMusic::Quality
   SHORTHAND = {
-    perfect: 'P',
-    major: 'M',
-    minor: 'm',
-    diminished: 'd',
-    augmented: 'A',
-    doubly_diminished: 'dd',
-    doubly_augmented: 'AA',
+    perfect: "P",
+    major: "M",
+    minor: "m",
+    diminished: "d",
+    augmented: "A",
+    doubly_diminished: "dd",
+    doubly_augmented: "AA"
   }.freeze
   NAMES = SHORTHAND.keys
 
@@ -18,7 +18,7 @@ class HeadMusic::Quality
     -1 => :diminished,
     0 => :perfect,
     1 => :augmented,
-    2 => :doubly_augmented,
+    2 => :doubly_augmented
   }.freeze
 
   MAJOR_INTERVAL_MODIFICATION = {
@@ -26,7 +26,7 @@ class HeadMusic::Quality
     -1 => :minor,
     0 => :major,
     1 => :augmented,
-    2 => :doubly_augmented,
+    2 => :doubly_augmented
   }.freeze
 
   def self.get(identifier)
@@ -36,10 +36,11 @@ class HeadMusic::Quality
   end
 
   def self.from(starting_quality, delta)
-    if starting_quality == :perfect
-      PERFECT_INTERVAL_MODIFICATION[delta].to_s.gsub(/_+/, ' ')
-    elsif starting_quality == :major
-      MAJOR_INTERVAL_MODIFICATION[delta].to_s.gsub(/_+/, ' ')
+    case starting_quality
+    when :perfect
+      PERFECT_INTERVAL_MODIFICATION[delta].to_s.gsub(/_+/, " ")
+    when :major
+      MAJOR_INTERVAL_MODIFICATION[delta].to_s.gsub(/_+/, " ")
     end
   end
 
@@ -60,7 +61,7 @@ class HeadMusic::Quality
   end
 
   def article
-    %w[a e i o u h].include?(name.to_s.first) ? 'an' : 'a'
+    %w[a e i o u h].include?(name.to_s.first) ? "an" : "a"
   end
 
   NAMES.each do |method_name|