head_music 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17a6cfc4f189a661c7f095056b429e32ce17468a
-  data.tar.gz: d3a3cc4b18e87fa0f7af9ba584b5f28946329784
+  metadata.gz: 838a7ebfc5a6873d62ac2d484b655bcc5fe37302
+  data.tar.gz: 669f4f3f9ab721dc93208b39ef22ac7170951ba9
 SHA512:
-  metadata.gz: 2e9b674c4bde48f3ce71ef0768b60461f3af1ebfcfc501ab9500af24b9b61cbc071f176a43d064fba5e5d9e83f0bc53ee80ffd8d34551ea2bd2777926437f1dc
-  data.tar.gz: 04fb64922f6c47d6df0f0cb637ad68b188fffe448dbefe02992aa85169c6ae8993b83383bdf59118391e94c3651ea76ddb7c52c9dd7b93d266d9a0aa8a9d28f0
+  metadata.gz: 0ca1b44616d4aed6f76e5838b99a546b28889fed30802fec1c8e5ee713af89352e1326e89bf9e5195104722a574c7f8db47755fa6b561685c1b18b190fc38525
+  data.tar.gz: cc2a14f96a3ec7e7590c59e2b81023ed41a5e9b2f7fb8fd5d25a860c929ece23fa8e2df32adf15faa508b1ed21856a774642d3e4ba40ec4299ce3d2d640df6dd

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Rob Head
+Copyright (c) 2018 Robert Emerson Head
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/head_music/chord.rb

@@ -11,7 +11,7 @@ class HeadMusic::Chord
 
   def consonant_triad?
     return false unless three_pitches?
-    root_triad? || first_inversion_triad? || second_inversion_triad?
+    reduction.root_triad? || reduction.first_inversion_triad? || reduction.second_inversion_triad?
   end
 
   def root_triad?
@@ -26,8 +26,9 @@ class HeadMusic::Chord
     invert.intervals.map(&:shorthand).sort == %w[M3 m3]
   end
 
-  # TODO
-  def reduction; end
+  def reduction
+    @reduction ||= HeadMusic::Chord.new(reduction_pitches)
+  end
 
   def three_pitches?
     pitches.length == 3
@@ -44,4 +45,29 @@ class HeadMusic::Chord
     new_pitches = pitches.drop(1) + [inverted_pitch]
     HeadMusic::Chord.new(new_pitches)
   end
+
+  def bass_pitch
+    @bass_pitch ||= pitches.first
+  end
+
+  def inspect
+    pitches.map(&:to_s).join(' ')
+  end
+
+  def to_s
+    pitches.map(&:to_s).join(' ')
+  end
+
+  def ==(other)
+    pitches & other.pitches == pitches
+  end
+
+  private
+
+  def reduction_pitches
+    pitches.map do |pitch|
+      pitch = HeadMusic::Pitch.fetch_or_create(pitch.spelling, pitch.octave - 1) while pitch > bass_pitch + 12
+      pitch
+    end.sort
+  end
 end

data/lib/head_music/functional_interval.rb

@@ -36,8 +36,8 @@ class HeadMusic::FunctionalInterval
   delegate :to_s, to: :name
   delegate :perfect?, :major?, :minor?, :diminished?, :augmented?, :doubly_diminished?, :doubly_augmented?, to: :quality
 
-  # Representation of the name of the functional interval
-  class Name
+  # Interprets a string or symbol
+  class Parser
     attr_reader :identifier
 
     def initialize(identifier)
@@ -65,114 +65,197 @@ class HeadMusic::FunctionalInterval
     end
   end
 
-  def self.get(identifier)
-    name = Name.new(identifier)
-    semitones = _degree_quality_semitones.dig(name.degree_name.to_sym, name.quality_name)
-    higher_pitch = HeadMusic::Pitch.from_number_and_letter(HeadMusic::Pitch.middle_c + semitones, name.higher_letter)
-    new(HeadMusic::Pitch.middle_c, higher_pitch)
-  end
+  # Accepts a name and a quality and returns the number of semitones
+  class Semitones
+    attr_reader :count
+
+    def initialize(name, quality_name)
+      @count ||= Semitones.degree_quality_semitones.dig(name, quality_name)
+    end
 
-  def self._degree_quality_semitones
-    @_degree_quality_semitones ||= begin
-      {}.tap do |degree_quality_semitones|
-        QUALITY_SEMITONES.each do |degree_name, qualities|
-          default_quality = qualities.keys.first
-          default_semitones = qualities[default_quality]
-          degree_quality_semitones[degree_name] = _semitones_for_degree(default_quality, default_semitones)
+    def self.degree_quality_semitones
+      @_degree_quality_semitones ||= begin
+        {}.tap do |degree_quality_semitones|
+          QUALITY_SEMITONES.each do |degree_name, qualities|
+            default_quality = qualities.keys.first
+            default_semitones = qualities[default_quality]
+            degree_quality_semitones[degree_name] = _semitones_for_degree(default_quality, default_semitones)
+          end
         end
       end
     end
-  end
 
-  def self._semitones_for_degree(quality, default_semitones)
-    {}.tap do |semitones|
-      _degree_quality_modifications(quality).each do |current_quality, delta|
-        semitones[current_quality] = default_semitones + delta
+    def self._semitones_for_degree(quality, default_semitones)
+      {}.tap do |semitones|
+        _degree_quality_modifications(quality).each do |current_quality, delta|
+          semitones[current_quality] = default_semitones + delta
+        end
       end
     end
-  end
 
-  def self._degree_quality_modifications(quality)
-    if quality == :perfect
-      HeadMusic::Quality::PERFECT_INTERVAL_MODIFICATION.invert
-    else
-      HeadMusic::Quality::MAJOR_INTERVAL_MODIFICATION.invert
+    def self._degree_quality_modifications(quality)
+      if quality == :perfect
+        HeadMusic::Quality::PERFECT_INTERVAL_MODIFICATION.invert
+      else
+        HeadMusic::Quality::MAJOR_INTERVAL_MODIFICATION.invert
+      end
     end
   end
 
-  def initialize(pitch1, pitch2)
-    pitch1 = HeadMusic::Pitch.get(pitch1)
-    pitch2 = HeadMusic::Pitch.get(pitch2)
-    @lower_pitch, @higher_pitch = [pitch1, pitch2].sort
-  end
+  # Accepts the letter name count between two notes and categorizes the interval
+  class Category
+    attr_reader :number
 
-  def number
-    simple_number + octaves * 7
-  end
+    def initialize(number)
+      @number = number
+    end
 
-  def steps
-    number - 1
-  end
+    def step?
+      number == 2
+    end
 
-  def simple_number
-    @simple_number ||= @lower_pitch.letter_name.steps_to(@higher_pitch.letter_name) + 1
-  end
+    def skip?
+      number == 3
+    end
 
-  def simple_semitones
-    semitones % 12
-  end
+    def leap?
+      number >= 3
+    end
 
-  def semitones
-    (@higher_pitch - @lower_pitch).to_i
+    def large_leap?
+      number > 3
+    end
   end
 
-  def octaves
-    (higher_pitch.number - lower_pitch.number) / 12
-  end
+  # Encapsulate the distance methods of the interval
+  class Size
+    attr_reader :low_pitch, :high_pitch
 
-  def compound?
-    !simple?
-  end
+    def initialize(pitch1, pitch2)
+      @low_pitch, @high_pitch = *[pitch1, pitch2].sort
+    end
 
-  def simple?
-    octaves.zero?
-  end
+    def simple_number
+      @simple_number ||= @low_pitch.letter_name.steps_to(@high_pitch.letter_name) + 1
+    end
 
-  def simple_name
-    [quality_name, simple_number_name].join(' ')
-  end
+    def octaves
+      @octaves ||= (high_pitch.number - low_pitch.number) / 12
+    end
 
-  def name
-    if named_number?
-      [quality_name, number_name].join(' ')
-    elsif simple_name == 'perfect unison'
-      "#{octaves.humanize} octaves"
-    else
-      "#{octaves.humanize} octaves and #{quality.article} #{simple_name}"
+    # returns the ordinality of the interval
+    def number
+      simple_number + octaves * 7
+    end
+
+    def simple?
+      octaves.zero?
+    end
+
+    def compound?
+      !simple?
     end
-  end
 
-  def shorthand
-    step_shorthand = number == 1 ? 'U' : number
-    [quality.shorthand, step_shorthand].join
+    def simple_semitones
+      @simple_semitones ||= semitones % 12
+    end
+
+    def semitones
+      (high_pitch - low_pitch).to_i
+    end
+
+    def steps
+      number - 1
+    end
   end
 
-  def quality
-    HeadMusic::Quality.get(quality_name)
+  # Accepts a number and number of semitones and privides the naming methods.
+  class Naming
+    attr_reader :number, :semitones
+
+    def initialize(number:, semitones:)
+      @number = number
+      @semitones = semitones
+    end
+
+    def simple_semitones
+      @simple_semitones ||= semitones % 12
+    end
+
+    def simple_number
+      @simple_number ||= (number - 1) % 7 + 1
+    end
+
+    def simple_name
+      [quality_name, simple_number_name].join(' ')
+    end
+
+    def quality_name
+      starting_quality = QUALITY_SEMITONES[simple_number_name.to_sym].keys.first
+      delta = simple_semitones - QUALITY_SEMITONES[simple_number_name.to_sym][starting_quality]
+      HeadMusic::Quality.from(starting_quality, delta)
+    end
+
+    def simple_number_name
+      NUMBER_NAMES[simple_number - 1]
+    end
+
+    def number_name
+      NUMBER_NAMES[number - 1] || (number.to_s + NAME_SUFFIXES[number % 10])
+    end
+
+    def name
+      if named_number?
+        [quality_name, number_name].join(' ')
+      elsif simple_name == 'perfect unison'
+        "#{octaves.humanize} octaves"
+      else
+        "#{octaves.humanize} octaves and #{quality.article} #{simple_name}"
+      end
+    end
+
+    def shorthand
+      step_shorthand = number == 1 ? 'U' : number
+      [quality.shorthand, step_shorthand].join
+    end
+
+    private
+
+    def named_number?
+      number < NUMBER_NAMES.length
+    end
+
+    def quality
+      @quality ||= HeadMusic::Quality.get(quality_name)
+    end
+
+    def octaves
+      @octaves ||= semitones / 12
+    end
   end
 
-  def quality_name
-    starting_quality = QUALITY_SEMITONES[simple_number_name.to_sym].keys.first
-    delta = simple_semitones - QUALITY_SEMITONES[simple_number_name.to_sym][starting_quality]
-    HeadMusic::Quality.from(starting_quality, delta)
+  delegate :step?, :skip?, :leap?, :large_leap?, to: :category
+  delegate :simple_number, :octaves, :number, :simple?, :compound?, :semitones, :simple_semitones, :steps, to: :size
+  delegate(
+    :simple_semitones, :simple_name, :quality_name, :simple_number_name, :number_name, :name, :shorthand, to: :naming
+  )
+
+  # Accepts a name and returns the interval with middle c on the bottom
+  def self.get(identifier)
+    name = Parser.new(identifier)
+    semitones = Semitones.new(name.degree_name.to_sym, name.quality_name).count
+    higher_pitch = HeadMusic::Pitch.from_number_and_letter(HeadMusic::Pitch.middle_c + semitones, name.higher_letter)
+    new(HeadMusic::Pitch.middle_c, higher_pitch)
   end
 
-  def simple_number_name
-    NUMBER_NAMES[simple_number - 1]
+  def initialize(pitch1, pitch2)
+    pitch1 = HeadMusic::Pitch.get(pitch1)
+    pitch2 = HeadMusic::Pitch.get(pitch2)
+    @lower_pitch, @higher_pitch = [pitch1, pitch2].sort
   end
 
-  def number_name
-    NUMBER_NAMES[number - 1] || (number.to_s + NAME_SUFFIXES[number % 10])
+  def quality
+    HeadMusic::Quality.get(quality_name)
   end
 
   def inversion
@@ -180,6 +263,7 @@ class HeadMusic::FunctionalInterval
     inverted_low_pitch += 12 while inverted_low_pitch < higher_pitch
     HeadMusic::FunctionalInterval.new(higher_pitch, inverted_low_pitch)
   end
+  alias invert inversion
 
   def consonance(style = :standard_practice)
     consonance_for_perfect(style) ||
@@ -190,6 +274,7 @@ class HeadMusic::FunctionalInterval
   def consonance?(style = :standard_practice)
     consonance(style).perfect? || consonance(style).imperfect?
   end
+  alias consonant? consonance?
 
   def perfect_consonance?(style = :standard_practice)
     consonance(style).perfect?
@@ -203,22 +288,6 @@ class HeadMusic::FunctionalInterval
     consonance(style).dissonant?
   end
 
-  def step?
-    number == 2
-  end
-
-  def skip?
-    number == 3
-  end
-
-  def leap?
-    number >= 3
-  end
-
-  def large_leap?
-    number > 3
-  end
-
   def <=>(other)
     other = self.class.get(other) unless other.is_a?(HeadMusic::FunctionalInterval)
     semitones <=> other.semitones
@@ -234,6 +303,18 @@ class HeadMusic::FunctionalInterval
 
   private
 
+  def size
+    @size ||= Size.new(@lower_pitch, @higher_pitch)
+  end
+
+  def category
+    @category ||= Category.new(number)
+  end
+
+  def naming
+    @naming ||= Naming.new(number: number, semitones: semitones)
+  end
+
   def named_number?
     number < NUMBER_NAMES.length
   end

data/lib/head_music/octave.rb

@@ -39,5 +39,13 @@ class HeadMusic::Octave
     to_i <=> other.to_i
   end
 
+  def +(other)
+    self.class.get(to_i + other.to_i)
+  end
+
+  def -(other)
+    self.class.get(to_i - other.to_i)
+  end
+
   private_class_method :new
 end

data/lib/head_music/style/analysis.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-# A module for style analysis and rules.
+# A module for style analysis and guidelines.
 module HeadMusic::Style; end
 
-# An analysis of music according to a ruleset.
+# An analysis of music according to a style guide.
 class HeadMusic::Style::Analysis
-  attr_reader :ruleset, :subject
+  attr_reader :guide, :voice
 
-  def initialize(ruleset, subject)
-    @ruleset = ruleset
-    @subject = subject
+  def initialize(guide, voice)
+    @guide = guide
+    @voice = voice
   end
 
   def messages
@@ -18,7 +18,7 @@ class HeadMusic::Style::Analysis
   alias annotation_messages messages
 
   def annotations
-    @annotations ||= @ruleset.analyze(subject)
+    @annotations ||= @guide.analyze(voice)
   end
 
   def fitness

data/lib/head_music/style/{annotations → guidelines}/always_move.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::AlwaysMove < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::AlwaysMove < HeadMusic::Style::Annotation
   MESSAGE = 'Always move to a different note.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/approach_perfection_contrarily.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::ApproachPerfectionContrarily < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::ApproachPerfectionContrarily < HeadMusic::Style::Annotation
   MESSAGE = 'Approach perfect consonances by contrary motion.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/at_least_eight_notes.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::AtLeastEightNotes < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::AtLeastEightNotes < HeadMusic::Style::Annotation
   MINIMUM_NOTES = 8
 
   MESSAGE = 'Write at least eight notes.'

data/lib/head_music/style/{annotations → guidelines}/avoid_crossing_voices.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::AvoidCrossingVoices < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::AvoidCrossingVoices < HeadMusic::Style::Annotation
   MESSAGE = 'Avoid crossing voices. Maintain the high-low relationship between voices.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/avoid_overlapping_voices.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::AvoidOverlappingVoices < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::AvoidOverlappingVoices < HeadMusic::Style::Annotation
   MESSAGE = 'Avoid overlapping voices. Maintain the high-low relationship between voices even for adjacent notes.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/consonant_climax.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::ConsonantClimax < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::ConsonantClimax < HeadMusic::Style::Annotation
   MESSAGE = 'Peak on a consonant high or low note one time or twice with a step between.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/consonant_downbeats.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::ConsonantDownbeats < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::ConsonantDownbeats < HeadMusic::Style::Annotation
   MESSAGE = 'Use consonant harmonic intervals on every downbeat.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/diatonic.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::Diatonic < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::Diatonic < HeadMusic::Style::Annotation
   MESSAGE = 'Use only notes in the key signature.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/direction_changes.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A melodic line should have direction changes.
-class HeadMusic::Style::Annotations::DirectionChanges < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::DirectionChanges < HeadMusic::Style::Annotation
   def marks
     return unless overage.positive?
     penalty_exponent = overage**0.5

data/lib/head_music/style/{annotations → guidelines}/end_on_perfect_consonance.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # marks the voice if the first note is not the first or fifth scale degree of the key.
-class HeadMusic::Style::Annotations::EndOnPerfectConsonance < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::EndOnPerfectConsonance < HeadMusic::Style::Annotation
   MESSAGE = 'End on the first or the fifth scale degree.'
 
   def marks

data/lib/head_music/style/{annotations → guidelines}/end_on_tonic.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline
-class HeadMusic::Style::Annotations::EndOnTonic < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::EndOnTonic < HeadMusic::Style::Annotation
   MESSAGE = 'End on the first scale degree.'
 
   def marks

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
+
+# A counterpoint guideline
+class HeadMusic::Style::Guidelines::FrequentDirectionChanges < HeadMusic::Style::Guidelines::DirectionChanges
+  MESSAGE = 'Change melodic direction frequently.'
+
+  def self.maximum_notes_per_direction
+    3
+  end
+end

data/lib/head_music/style/{annotations → guidelines}/limit_octave_leaps.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Module for Annotations.
-module HeadMusic::Style::Annotations; end
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
 
 # A counterpoint guideline: Use a maximum of one octave leap.
-class HeadMusic::Style::Annotations::LimitOctaveLeaps < HeadMusic::Style::Annotation
+class HeadMusic::Style::Guidelines::LimitOctaveLeaps < HeadMusic::Style::Annotation
   MESSAGE = 'Use a maximum of one octave leap.'
 
   def marks

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Module for style guidelines.
+module HeadMusic::Style::Guidelines; end
+
+# A counterpoint guideline
+class HeadMusic::Style::Guidelines::ModerateDirectionChanges < HeadMusic::Style::Guidelines::DirectionChanges
+  MESSAGE = 'Change melodic direction occasionally.'
+
+  def self.maximum_notes_per_direction
+    5
+  end
+end