head_music 0.20.0 → 0.22.0

data/lib/head_music/pitch.rb

@@ -7,10 +7,14 @@ class HeadMusic::Pitch
   attr_reader :spelling
   attr_reader :octave
 
-  delegate :letter_name, :letter_name_cycle, to: :spelling
+  delegate :letter_name, to: :spelling
+  delegate :series_ascending, :series_descending, to: :letter_name, prefix: true
   delegate :sign, :sharp?, :flat?, to: :spelling
   delegate :pitch_class, to: :spelling
+  delegate :number, to: :pitch_class, prefix: true
+  delegate :pitch_class_number, to: :natural, prefix: true
   delegate :semitones, to: :sign, prefix: true, allow_nil: true
+  delegate :steps_to, to: :letter_name, prefix: true
 
   delegate :smallest_interval_to, to: :pitch_class
 
@@ -31,16 +35,19 @@ class HeadMusic::Pitch
 
   def self.from_pitch_class(pitch_class)
     return nil unless pitch_class.is_a?(HeadMusic::PitchClass)
+
     fetch_or_create(pitch_class.sharp_spelling)
   end
 
   def self.from_name(name)
     return nil unless name == name.to_s
+
     fetch_or_create(HeadMusic::Spelling.get(name), HeadMusic::Octave.get(name).to_i)
   end
 
   def self.from_number(number)
     return nil unless number == number.to_i
+
     spelling = HeadMusic::Spelling.from_number(number)
     octave = (number.to_i / 12) - 1
     fetch_or_create(spelling, octave)
@@ -64,6 +71,7 @@ class HeadMusic::Pitch
   def self.fetch_or_create(spelling, octave = nil)
     octave ||= HeadMusic::Octave::DEFAULT
     return unless spelling && (-1..9).cover?(octave)
+
     @pitches ||= {}
     hash_key = [spelling, octave].join
     @pitches[hash_key] ||= new(spelling, octave)
@@ -94,15 +102,24 @@ class HeadMusic::Pitch
   end
 
   def natural
-    HeadMusic::Pitch.get(to_s.gsub(/[#b]/, ''))
+    HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Sign.matcher, ''))
   end
 
   def +(other)
-    HeadMusic::Pitch.get(to_i + other.to_i)
+    if other.is_a?(HeadMusic::FunctionalInterval)
+      # return a pitch
+      other.above(self)
+    else
+      # assume value represents an interval in semitones and return another pitch
+      HeadMusic::Pitch.get(to_i + other.to_i)
+    end
   end
 
   def -(other)
-    if other.is_a?(HeadMusic::Pitch)
+    if other.is_a?(HeadMusic::FunctionalInterval)
+      # return a pitch
+      other.below(self)
+    elsif other.is_a?(HeadMusic::Pitch)
       # return an interval
       HeadMusic::Interval.get(to_i - other.to_i)
     else
@@ -132,16 +149,33 @@ class HeadMusic::Pitch
     tuning.frequency_for(self)
   end
 
+  def steps_to(other)
+    other = HeadMusic::Pitch.get(other)
+    letter_name_steps_to(other) + 7 * octave_changes_to(other)
+  end
+
   private_class_method :new
 
   private
 
+  def octave_changes_to(other)
+    other.octave - octave - octave_adjustment_to(other)
+  end
+
+  def octave_adjustment_to(other)
+    (pitch_class_above?(other) ? 1 : 0)
+  end
+
+  def pitch_class_above?(other)
+    natural_pitch_class_number > other.natural_pitch_class_number
+  end
+
   def enharmonic_equivalence
-    @enharmonic_equivalence ||= EnharmonicEquivalence.get(self)
+    @enharmonic_equivalence ||= HeadMusic::Pitch::EnharmonicEquivalence.get(self)
   end
 
   def octave_equivalence
-    @octave_equivalence ||= OctaveEquivalence.get(self)
+    @octave_equivalence ||= HeadMusic::Pitch::OctaveEquivalence.get(self)
   end
 
   def tuning
@@ -168,56 +202,6 @@ class HeadMusic::Pitch
 
   def target_letter_name(num_steps)
     @target_letter_name ||= {}
-    @target_letter_name[num_steps] ||= letter_name.steps(num_steps)
-  end
-
-  # 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)
-      @enharmonic_equivalences ||= {}
-      @enharmonic_equivalences[pitch.to_s] ||= new(pitch)
-    end
-
-    attr_reader :pitch
-
-    delegate :pitch_class, to: :pitch
-
-    def initialize(pitch)
-      @pitch = HeadMusic::Pitch.get(pitch)
-    end
-
-    def enharmonic_equivalent?(other)
-      other = HeadMusic::Pitch.get(other)
-      pitch.midi_note_number == other.midi_note_number && pitch.spelling != other.spelling
-    end
-
-    alias enharmonic? enharmonic_equivalent?
-    alias equivalent? enharmonic_equivalent?
-
-    private_class_method :new
-  end
-
-  # Octave equivalence is the functional equivalence of pitches with the same spelling separated by one or more octaves.
-  class OctaveEquivalence
-    def self.get(pitch)
-      @octave_equivalences ||= {}
-      @octave_equivalences[pitch.to_s] ||= new(pitch)
-    end
-
-    attr_reader :pitch
-
-    def initialize(pitch)
-      @pitch = pitch
-    end
-
-    def octave_equivalent?(other)
-      other = HeadMusic::Pitch.get(other)
-      pitch.spelling == other.spelling && pitch.octave != other.octave
-    end
-
-    alias equivalent? octave_equivalent?
-
-    private_class_method :new
+    @target_letter_name[num_steps] ||= letter_name.steps_up(num_steps)
   end
 end

data/lib/head_music/pitch_class.rb

@@ -7,6 +7,7 @@ class HeadMusic::PitchClass
 
   SHARP_SPELLINGS = %w[C C# D D# E F F# G G# A A# B].freeze
   FLAT_SPELLINGS = %w[C Db D Eb E F Gb G Ab A Bb B].freeze
+  INTEGER_NOTATION = %w[0 1 2 3 4 5 6 7 8 9 t e].freeze
 
   def self.get(identifier)
     @pitch_classes ||= {}
@@ -30,6 +31,10 @@ class HeadMusic::PitchClass
     number
   end
 
+  def to_integer_notation
+    INTEGER_NOTATION[number]
+  end
+
   def sharp_spelling
     SHARP_SPELLINGS[number]
   end

data/lib/head_music/rhythmic_unit.rb

@@ -45,6 +45,7 @@ class HeadMusic::RhythmicUnit
     return :longa if relative_value == 4
     return :breve if relative_value == 2
     return :open if [0.5, 1].include? relative_value
+
     :closed
   end
 

data/lib/head_music/scale.rb

@@ -2,7 +2,7 @@
 
 # A scale contains ordered pitches starting at a tonal center.
 class HeadMusic::Scale
-  SCALE_REGEX = /^[A-G][#b]?\s+\w+$/
+  SCALE_REGEX = /^[A-G][#b]?\s+\w+$/.freeze
 
   def self.get(root_pitch, scale_type = nil)
     root_pitch, scale_type = root_pitch.split(/\s+/) if root_pitch.is_a?(String) && scale_type =~ SCALE_REGEX
@@ -15,7 +15,7 @@ class HeadMusic::Scale
     @scales[hash_key] ||= new(root_pitch, scale_type)
   end
 
-  delegate :letter_name_cycle, to: :root_pitch
+  delegate :letter_name_series_ascending, :letter_name_series_descending, to: :root_pitch
 
   attr_reader :root_pitch, :scale_type
 
@@ -53,6 +53,7 @@ class HeadMusic::Scale
     pitches = [root_pitch]
     %i[ascending descending].each do |single_direction|
       next unless [single_direction, :both].include?(direction)
+
       (1..octaves).each do
         pitches += octave_scale_pitches(single_direction, semitones_from_root)
         semitones_from_root += 12 * direction_sign(single_direction)
@@ -101,16 +102,19 @@ class HeadMusic::Scale
 
   def diatonic_letter_for_step(direction, step)
     return unless scale_type.diatonic?
-    direction == :ascending ? letter_name_cycle[step % 7] : letter_name_cycle[-step % 7]
+
+    direction == :ascending ? letter_name_series_ascending[step % 7] : letter_name_series_descending[step % 7]
   end
 
   def child_scale_letter_for_step(semitones_from_root)
     return unless scale_type.parent
+
     parent_scale_pitch_for(semitones_from_root).letter_name
   end
 
   def flat_letter_for_step(semitones_from_root)
     return unless root_pitch.flat?
+
     HeadMusic::PitchClass::FLAT_SPELLINGS[pitch_class_number(semitones_from_root)]
   end
 

data/lib/head_music/scale_degree.rb

@@ -17,7 +17,7 @@ class HeadMusic::ScaleDegree
   end
 
   def degree
-    scale.letter_name_cycle.index(spelling.letter_name.to_s) + 1
+    scale.letter_name_series_ascending.index(spelling.letter_name.to_s) + 1
   end
 
   def sign
@@ -41,6 +41,7 @@ class HeadMusic::ScaleDegree
 
   def name_for_degree
     return unless scale_type.diatonic?
+
     NAME_FOR_DIATONIC_DEGREE[degree] ||
       (scale_type.intervals.last == 1 || sign == '#' ? 'leading tone' : 'subtonic')
   end

data/lib/head_music/sign.rb

@@ -17,7 +17,7 @@ class HeadMusic::Sign
   end
 
   def self.symbols
-    @sign_symbols ||= all.map { |sign| [sign.ascii, sign.unicode] }.flatten.reject { |s| s.nil? || s.empty? }
+    @symbols ||= all.map { |sign| [sign.ascii, sign.unicode] }.flatten.reject { |s| s.nil? || s.empty? }
   end
 
   def self.matcher
@@ -30,6 +30,7 @@ class HeadMusic::Sign
 
   def self.get(identifier)
     return identifier if identifier.is_a?(HeadMusic::Sign)
+
     all.detect do |sign|
       sign.representions.include?(identifier)
     end

data/lib/head_music/spelling.rb

@@ -4,7 +4,7 @@
 # Composite of a LetterName and an optional Sign.
 # Does not include the octave. See Pitch for that.
 class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(\-?\d+)?\s*$/i
+  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(\-?\d+)?\s*$/i.freeze
 
   attr_reader :pitch_class
   attr_reader :letter_name
@@ -12,11 +12,12 @@ 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 :series_ascending, :series_descending, to: :letter_name, prefix: true
   delegate :enharmonic?, to: :enharmonic_equivalence
 
   def self.get(identifier)
     return identifier if identifier.is_a?(HeadMusic::Spelling)
+
     from_name(identifier) || from_number(identifier)
   end
 
@@ -26,15 +27,18 @@ class HeadMusic::Spelling
 
   def self.from_name(name)
     return nil unless matching_string(name)
+
     letter_name, sign_string, _octave = matching_string(name).captures
     letter_name = HeadMusic::LetterName.get(letter_name)
     return nil unless letter_name
+
     sign = HeadMusic::Sign.get(sign_string)
     fetch_or_create(letter_name, sign)
   end
 
   def self.from_number(number)
     return nil unless number == number.to_i
+
     pitch_class_number = number.to_i % 12
     letter_name = HeadMusic::LetterName.from_pitch_class(pitch_class_number)
     from_number_and_letter(number, letter_name)

data/lib/head_music/style/analysis.rb

@@ -23,6 +23,7 @@ class HeadMusic::Style::Analysis
 
   def fitness
     return 1.0 if annotations.empty?
+
     @fitness ||= fitness_scores.inject(:+).to_f / fitness_scores.length
   end
 

data/lib/head_music/style/annotation.rb

@@ -41,11 +41,11 @@ class HeadMusic::Style::Annotation
   end
 
   def start_position
-    [marks].flatten.compact.map(&:start_position).sort.first
+    [marks].flatten.compact.map(&:start_position).min
   end
 
   def end_position
-    [marks].flatten.compact.map(&:end_position).sort.last
+    [marks].flatten.compact.map(&:end_position).max
   end
 
   def marks

data/lib/head_music/style/guidelines/at_least_eight_notes.rb

@@ -25,6 +25,7 @@ class HeadMusic::Style::Guidelines::AtLeastEightNotes < HeadMusic::Style::Annota
 
   def deficiency_mark
     return unless notes.length < MINIMUM_NOTES
+
     HeadMusic::Style::Mark.for_all(placements, fitness: notes.length.to_f / MINIMUM_NOTES)
   end
 end

data/lib/head_music/style/guidelines/direction_changes.rb

@@ -7,6 +7,7 @@ module HeadMusic::Style::Guidelines; end
 class HeadMusic::Style::Guidelines::DirectionChanges < HeadMusic::Style::Annotation
   def marks
     return unless overage.positive?
+
     penalty_exponent = overage**0.5
     HeadMusic::Style::Mark.for_all(notes, fitness: HeadMusic::PENALTY_FACTOR**penalty_exponent)
   end
@@ -15,6 +16,7 @@ class HeadMusic::Style::Guidelines::DirectionChanges < HeadMusic::Style::Annotat
 
   def overage
     return 0 if notes.length < 2
+
     [notes_per_direction - self.class.maximum_notes_per_direction, 0].max
   end
 

data/lib/head_music/style/guidelines/limit_octave_leaps.rb

@@ -9,6 +9,7 @@ class HeadMusic::Style::Guidelines::LimitOctaveLeaps < HeadMusic::Style::Annotat
 
   def marks
     return if octave_leaps.length <= 1
+
     octave_leaps.map do |leap|
       HeadMusic::Style::Mark.for_all(leap.notes)
     end

data/lib/head_music/style/guidelines/mostly_conjunct.rb

@@ -25,6 +25,7 @@ class HeadMusic::Style::Guidelines::MostlyConjunct < HeadMusic::Style::Annotatio
 
   def conjunct_ratio
     return 1 if melodic_intervals.empty?
+
     melodic_intervals.count(&:step?).to_f / melodic_intervals.length
   end
 end

data/lib/head_music/style/guidelines/notes_same_length.rb

@@ -53,8 +53,9 @@ class HeadMusic::Style::Guidelines::NotesSameLength < HeadMusic::Style::Annotati
 
   def most_common_rhythmic_values
     return [] if notes.empty?
+
     occurrences = occurrences_by_rhythmic_value
-    highest_count = occurrences.values.sort.last
+    highest_count = occurrences.values.max
     occurrences.select { |_rhythmic_value, count| count == highest_count }.keys
   end
 

data/lib/head_music/style/guidelines/one_to_one.rb

@@ -10,6 +10,7 @@ class HeadMusic::Style::Guidelines::OneToOne < HeadMusic::Style::Annotation
   def marks
     return unless cantus_firmus&.notes
     return if cantus_firmus.notes.empty?
+
     HeadMusic::Style::Mark.for_each(
       notes_without_match(voice, cantus_firmus) + notes_without_match(cantus_firmus, voice)
     )

data/lib/head_music/style/guidelines/prefer_contrary_motion.rb

@@ -10,6 +10,7 @@ class HeadMusic::Style::Guidelines::PreferContraryMotion < HeadMusic::Style::Ann
   def marks
     return nil if notes.length < 2
     return nil if direct_motion_ratio <= 0.5
+
     direct_motions.map { |motion| HeadMusic::Style::Mark.for_all(motion.notes) }
   end
 
@@ -21,6 +22,7 @@ class HeadMusic::Style::Guidelines::PreferContraryMotion < HeadMusic::Style::Ann
 
   def direct_motion_ratio
     return 0 if motions.empty?
+
     direct_motions.count / motions.count.to_f
   end
 end

data/lib/head_music/style/guidelines/prefer_imperfect.rb

@@ -15,6 +15,7 @@ class HeadMusic::Style::Guidelines::PreferImperfect < HeadMusic::Style::Annotati
 
   def ratio_of_perfect_intervals
     return 0 if downbeat_harmonic_intervals_in_middle.nil?
+
     perfect_intervals.length.to_f / downbeat_harmonic_intervals.length
   end
 

data/lib/head_music/style/guidelines/single_large_leaps.rb

@@ -14,6 +14,7 @@ class HeadMusic::Style::Guidelines::SingleLargeLeaps < HeadMusic::Style::Guideli
     return false if spelling_consonant_triad?(first_interval, second_interval, third_interval)
     return false if second_interval.step?
     return false if second_interval.repetition?
+
     !direction_changed?(first_interval, second_interval) && second_interval.leap?
   end
 end

data/lib/head_music/style/guidelines/start_on_perfect_consonance.rb

@@ -9,6 +9,7 @@ class HeadMusic::Style::Guidelines::StartOnPerfectConsonance < HeadMusic::Style:
 
   def marks
     return unless first_note && ((bass_voice? && !starts_on_tonic?) || !starts_on_perfect_consonance?)
+
     HeadMusic::Style::Mark.for(first_note)
   end
 

data/lib/head_music/style/guidelines/step_down_to_final_note.rb

@@ -9,6 +9,7 @@ class HeadMusic::Style::Guidelines::StepDownToFinalNote < HeadMusic::Style::Anno
 
   def marks
     return if last_melodic_interval.nil?
+
     fitness = 1
     fitness *= HeadMusic::PENALTY_FACTOR unless step?
     fitness *= HeadMusic::PENALTY_FACTOR unless descending?

data/lib/head_music/style/guidelines/step_out_of_unison.rb

@@ -29,6 +29,6 @@ class HeadMusic::Style::Guidelines::StepOutOfUnison < HeadMusic::Style::Annotati
   end
 
   def perfect_unisons
-    @unisons ||= harmonic_intervals.select(&:perfect_consonance?).select(&:unison?)
+    @perfect_unisons ||= harmonic_intervals.select(&:perfect_consonance?).select(&:unison?)
   end
 end

data/lib/head_music/style/guidelines/step_up_to_final_note.rb

@@ -9,6 +9,7 @@ class HeadMusic::Style::Guidelines::StepUpToFinalNote < HeadMusic::Style::Annota
 
   def marks
     return if last_melodic_interval.nil?
+
     fitness = 1
     fitness *= HeadMusic::PENALTY_FACTOR unless step?
     fitness *= HeadMusic::PENALTY_FACTOR unless ascending?

data/lib/head_music/style/mark.rb

@@ -12,8 +12,9 @@ class HeadMusic::Style::Mark
   def self.for_all(placements, fitness: nil)
     placements = [placements].flatten.compact
     return [] if placements.empty?
-    start_position = placements.map(&:position).sort.first
-    end_position = placements.map(&:next_position).sort.last
+
+    start_position = placements.map(&:position).min
+    end_position = placements.map(&:next_position).max
     new(start_position, end_position, placements: placements, fitness: fitness)
   end
 

data/lib/head_music/tuning.rb

@@ -3,8 +3,8 @@
 # A tuning has a reference pitch and frequency and provides frequencies for all pitches
 # The base class assumes equal temperament tuning. By default, A4 = 440.0 Hz
 class HeadMusic::Tuning
-  REFERENCE_FREQUENCY = 440.0
   REFERENCE_PITCH_NAME = 'A4'
+  REFERENCE_FREQUENCY = 440.0
 
   attr_reader :reference_pitch, :reference_frequency
 
@@ -18,3 +18,8 @@ class HeadMusic::Tuning
     reference_frequency * (2**(1.0 / 12))**(pitch - reference_pitch).semitones
   end
 end
+
+# TODO: other tunings
+# Create website that hosts videos on theory and history, handy charts, etc.
+# one of those charts can be a frequency table in various tunings
+# maybe show pythagorean commas and such. or cents sharp or flat relative to either equal temperment or just intonation

data/lib/head_music/version.rb

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

data/lib/head_music.rb

@@ -36,6 +36,8 @@ require 'head_music/meter'
 require 'head_music/motion'
 require 'head_music/octave'
 require 'head_music/pitch'
+require 'head_music/pitch/enharmonic_equivalence'
+require 'head_music/pitch/octave_equivalence'
 require 'head_music/pitch_class'
 require 'head_music/quality'
 require 'head_music/rhythm'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,18 +102,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
 - ".gitignore"
+- ".pairs"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
-- circle.yml
 - head_music.gemspec
 - lib/head_music.rb
 - lib/head_music/chord.rb
@@ -140,6 +144,8 @@ files:
 - lib/head_music/named_rudiment.rb
 - lib/head_music/octave.rb
 - lib/head_music/pitch.rb
+- lib/head_music/pitch/enharmonic_equivalence.rb
+- lib/head_music/pitch/octave_equivalence.rb
 - lib/head_music/pitch_class.rb
 - lib/head_music/quality.rb
 - lib/head_music/rhythm.rb
@@ -213,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The rudiments of western music theory.

data/circle.yml

@@ -1,9 +0,0 @@
-## Customize the test machine
-machine:
-  timezone:
-    America/Los_Angeles # Set the timezone
-
-  # Version of ruby to use
-  ruby:
-    version:
-      2.4.0