head_music 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84558801b5df822669de2d7be0b1316dc711511a
-  data.tar.gz: c246dbb35d11e8b7815d56a6535420e00096c791
+SHA256:
+  metadata.gz: c5e3afc9754608ddd1d1c10b191f356d4c200733ebfd9e9294693309d7ab53d9
+  data.tar.gz: f92fbe212261872b48e41d1189289f7a0b9aea7643e060a3e96ed223746f1089
 SHA512:
-  metadata.gz: 851820181797720920c79212516349316722dac6a4cd7889f917d2659543dbba5a39f7fce51ac8e5ed08302a1d51d7daa820e93f121bc8d3c681f1321441230e
-  data.tar.gz: ec6881d59cd432e3c392eeafcba2a34edc1c9d51f3842bb0832641546a86c3656c381ac0226c9865152532696e36e16644e59d7b3e54554eec6e9978c25d8c64
+  metadata.gz: 30fac39ee9b758610839343fb7e879ec5422485a83240be3b535be261fc5e31d9f6a2f66c8a34523f90bb95c9f6c3c836ba1a404d07a40634bc2963a1cb584c3
+  data.tar.gz: ef1240d4dcc7b9d159967a1dcad186867c2dc1f7cac8e33df295d77452bb75d0a1888d9d3a99800aeff60d7a00dca94d7a9ece30d8190769ebcacffbceccedf5

data/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-gems-{{ checksum "Gemfile.lock" }}
+          - v1-gems-
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - save_cache:
+          key: v1-gems-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          command: bundle exec rspec
+      - store_test_results:
+          path: test_results

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/examples.txt

data/.pairs

@@ -0,0 +1,8 @@
+# .pairs - configuration for 'git pair'
+# place in project or home directory
+pairs:
+  rh: Rob Head; robert.head
+email:
+  prefix: pair
+  domain: gmail.com
+  no_solo_prefix: true

data/.rubocop.yml

@@ -8,7 +8,7 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 155
 
 Metrics/LineLength:
   Max: 120
@@ -19,5 +19,14 @@ Style/SymbolArray:
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CODE_OF_CONDUCT.md

@@ -22,14 +22,11 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

data/Gemfile

@@ -2,14 +2,14 @@
 
 source 'https://rubygems.org'
 
-ruby '2.4.0'
+ruby '2.5.1'
 
 # Specify your gem's dependencies in head_music.gemspec
 gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', '~> 1.0.0'
-  gem 'rubocop', require: false
+  gem 'rubocop', '>= 0.56.0', require: false
   gem 'rubocop-rspec', require: false
   gem 'simplecov'
 end

data/README.md

@@ -40,4 +40,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/TODO.md

@@ -0,0 +1,18 @@
+# TODO
+
+## User stories
+
+### Done
+
+    As a developer
+    Given a pitch
+    I want to be able to add a functional interval to get another pitch.
+
+FunctionalInterval
+  - def above(pitch) -> pitch
+FunctionalInterval
+  - def below(pitch) -> pitch
+
+Pitch addition and subtraction
+  - define `Pitch#+`, `Pitch#-`
+  - use FunctionalInterval methods

data/head_music.gemspec

@@ -1,7 +1,6 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'head_music/version'
 

data/lib/head_music/chord.rb

@@ -6,23 +6,30 @@ class HeadMusic::Chord
 
   def initialize(pitches)
     raise ArgumentError if pitches.length < 3
+
     @pitches = pitches.map { |pitch| HeadMusic::Pitch.get(pitch) }.sort
   end
 
   def consonant_triad?
-    return false unless three_pitches?
     reduction.root_triad? || reduction.first_inversion_triad? || reduction.second_inversion_triad?
   end
 
   def root_triad?
+    return false unless triad?
+
     intervals.map(&:shorthand).sort == %w[M3 m3]
   end
 
+  # TODO: look up definition of first and second inversion triads. Can they be spread?
   def first_inversion_triad?
+    return false unless triad?
+
     invert.invert.intervals.map(&:shorthand).sort == %w[M3 m3]
   end
 
   def second_inversion_triad?
+    return false unless triad?
+
     invert.intervals.map(&:shorthand).sort == %w[M3 m3]
   end
 
@@ -30,7 +37,7 @@ class HeadMusic::Chord
     @reduction ||= HeadMusic::Chord.new(reduction_pitches)
   end
 
-  def three_pitches?
+  def triad?
     pitches.length == 3
   end
 

data/lib/head_music/circle.rb

@@ -37,6 +37,7 @@ class HeadMusic::Circle
       loop do
         next_pitch_class = list.last + interval
         break if next_pitch_class == list.first
+
         list << next_pitch_class
       end
     end

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: ['choral tenor', 'tenor'], modern: true },
+    { pitch: 'G3', line: 2, names: ['choral tenor', 'tenor', 'tenor G-clef'], modern: true },
 
     { pitch: 'F3', line: 3, names: ['baritone'] },
     { pitch: 'F3', line: 4, names: ['bass', 'F-clef'], modern: true },
@@ -16,8 +16,8 @@ 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', 'C-clef'], modern: true },
-    { pitch: 'C4', line: 4, names: ['tenor'], modern: true },
-    { pitch: 'C4', line: 5, names: ['baritone'] },
+    { pitch: 'C4', line: 4, names: ['tenor', 'tenor C-clef'], modern: true },
+    { pitch: 'C4', line: 5, names: ['baritone', 'baritone C-clef'] },
 
     { pitch: nil, line: 3, names: %w[neutral percussion] },
   ].freeze
@@ -33,13 +33,14 @@ class HeadMusic::Clef
     clef_data = CLEFS.detect { |clef| clef[:names].map(&:downcase).include?(name.downcase) }
     @pitch = HeadMusic::Pitch.get(clef_data[:pitch])
     @line = clef_data[:line]
+    @modern = clef_data[:modern]
   end
 
   def clef_type
     "#{pitch.letter_name}-clef"
   end
 
-  def line_pitch(line_number)
+  def pitch_for_line(line_number)
     @line_pitches ||= {}
     @line_pitches[line_number] ||= begin
       steps = (line_number - line) * 2
@@ -47,7 +48,7 @@ class HeadMusic::Clef
     end
   end
 
-  def space_pitch(space_number)
+  def pitch_for_space(space_number)
     @space_pitches ||= {}
     @space_pitches[space_number] ||= begin
       steps = (space_number - line) * 2 + 1
@@ -55,6 +56,10 @@ class HeadMusic::Clef
     end
   end
 
+  def modern?
+    @modern
+  end
+
   def ==(other)
     to_s == other.to_s
   end

data/lib/head_music/consonance.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Consonance is a description of intervals that sound more pleasing.
+# Consonance describes a category or degree of harmonic pleasantness: perfect, imperfect, or dissonant
 class HeadMusic::Consonance
   LEVELS = %w[perfect imperfect dissonant].freeze
 

data/lib/head_music/content/composition.rb

@@ -66,8 +66,7 @@ class HeadMusic::Composition
     @name = name || 'Composition'
     @key_signature = HeadMusic::KeySignature.get(key_signature) if key_signature
     @key_signature ||= HeadMusic::KeySignature.default
-    @meter = HeadMusic::Meter.get(meter) if meter
-    @meter ||= HeadMusic::Meter.default
+    @meter = meter ? HeadMusic::Meter.get(meter) : HeadMusic::Meter.default
   end
 
   def last_meter_change(bar_number)

data/lib/head_music/content/note.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# A note is a pitch with a duration.
+#
 # Note quacks like a placement, but requires a different set of construction arguments
 #   - always has a pitch
 #   - receives a voice and position if unspecified

data/lib/head_music/content/placement.rb

@@ -33,7 +33,7 @@ class HeadMusic::Placement
   end
 
   def to_s
-    "#{rhythmic_value} #{pitch ? pitch : 'rest'} at #{position}"
+    "#{rhythmic_value} #{pitch.presence || 'rest'} at #{position}"
   end
 
   private

data/lib/head_music/content/rhythmic_value.rb

@@ -29,6 +29,7 @@ class HeadMusic::RhythmicValue
 
   def self.dots_from_words(identifier)
     return 0 unless identifier.match?(/dotted/)
+
     modifier, = identifier.split(/_*dotted_*/)
     case modifier
     when /tripl\w/

data/lib/head_music/content/voice.rb

@@ -38,11 +38,11 @@ class HeadMusic::Voice
   end
 
   def highest_pitch
-    pitches.sort.last
+    pitches.max
   end
 
   def lowest_pitch
-    pitches.sort.first
+    pitches.min
   end
 
   def highest_notes
@@ -92,11 +92,13 @@ class HeadMusic::Voice
 
   def earliest_bar_number
     return 1 if notes.empty?
+
     placements.first.position.bar_number
   end
 
   def latest_bar_number
     return 1 if notes.empty?
+
     placements.last.position.bar_number
   end
 

data/lib/head_music/functional_interval.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Represents a functional interval.
+# A functional interval is the distance between two spelled pitches.
 class HeadMusic::FunctionalInterval
   include Comparable
 
@@ -61,7 +61,7 @@ class HeadMusic::FunctionalInterval
     end
 
     def higher_letter
-      HeadMusic::Pitch.middle_c.letter_name.steps(steps)
+      HeadMusic::Pitch.middle_c.letter_name.steps_up(steps)
     end
   end
 
@@ -74,7 +74,7 @@ class HeadMusic::FunctionalInterval
     end
 
     def self.degree_quality_semitones
-      @_degree_quality_semitones ||= begin
+      @degree_quality_semitones ||= begin
         {}.tap do |degree_quality_semitones|
           QUALITY_SEMITONES.each do |degree_name, qualities|
             default_quality = qualities.keys.first
@@ -135,21 +135,20 @@ class HeadMusic::FunctionalInterval
       @low_pitch, @high_pitch = *[pitch1, pitch2].sort
     end
 
-    def simple_number
-      @simple_number ||= @low_pitch.letter_name.steps_to(@high_pitch.letter_name) + 1
+    def number
+      @number ||= @low_pitch.steps_to(@high_pitch) + 1
     end
 
-    def octaves
-      @octaves ||= (high_pitch.number - low_pitch.number) / 12
+    def simple_number
+      @simple_number ||= octave_equivalent? ? 8 : (number - 1) % 7 + 1
     end
 
-    # returns the ordinality of the interval
-    def number
-      simple_number + octaves * 7
+    def octaves
+      @octaves ||= number / 8
     end
 
     def simple?
-      octaves.zero?
+      number <= 8
     end
 
     def compound?
@@ -167,6 +166,12 @@ class HeadMusic::FunctionalInterval
     def steps
       number - 1
     end
+
+    private
+
+    def octave_equivalent?
+      number > 1 && ((number - 1) % 7).zero?
+    end
   end
 
   # Accepts a number and number of semitones and privides the naming methods.
@@ -183,7 +188,7 @@ class HeadMusic::FunctionalInterval
     end
 
     def simple_number
-      @simple_number ||= (number - 1) % 7 + 1
+      @simple_number ||= octave_equivalent? ? 8 : (number - 1) % 7 + 1
     end
 
     def simple_name
@@ -192,7 +197,8 @@ class HeadMusic::FunctionalInterval
 
     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]
+      delta = simple_semitones - (QUALITY_SEMITONES[simple_number_name.to_sym][starting_quality] % 12)
+      delta -= 12 while delta >= 6
       HeadMusic::Quality.from(starting_quality, delta)
     end
 
@@ -207,7 +213,7 @@ class HeadMusic::FunctionalInterval
     def name
       if named_number?
         [quality_name, number_name].join(' ')
-      elsif simple_name == 'perfect unison'
+      elsif simple_name == 'perfect octave'
         "#{octaves.humanize} octaves"
       else
         "#{octaves.humanize} octaves and #{quality.article} #{simple_name}"
@@ -232,12 +238,20 @@ class HeadMusic::FunctionalInterval
     def octaves
       @octaves ||= semitones / 12
     end
+
+    def octave_equivalent?
+      number > 1 && ((number - 1) % 7).zero?
+    end
   end
 
   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
+    :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
@@ -260,7 +274,9 @@ class HeadMusic::FunctionalInterval
 
   def inversion
     inverted_low_pitch = lower_pitch
-    inverted_low_pitch += 12 while inverted_low_pitch < higher_pitch
+    while inverted_low_pitch < higher_pitch
+      inverted_low_pitch = HeadMusic::Pitch.fetch_or_create(lower_pitch.spelling, inverted_low_pitch.octave + 1)
+    end
     HeadMusic::FunctionalInterval.new(higher_pitch, inverted_low_pitch)
   end
   alias invert inversion
@@ -288,6 +304,16 @@ class HeadMusic::FunctionalInterval
     consonance(style).dissonant?
   end
 
+  def above(pitch)
+    pitch = HeadMusic::Pitch.get(pitch)
+    HeadMusic::Pitch.from_number_and_letter(pitch + semitones, pitch.letter_name.steps_up(number - 1))
+  end
+
+  def below(pitch)
+    pitch = HeadMusic::Pitch.get(pitch)
+    HeadMusic::Pitch.from_number_and_letter(pitch - semitones, pitch.letter_name.steps_down(number - 1))
+  end
+
   def <=>(other)
     other = self.class.get(other) unless other.is_a?(HeadMusic::FunctionalInterval)
     semitones <=> other.semitones

data/lib/head_music/grand_staff.rb

@@ -23,7 +23,8 @@ class HeadMusic::GrandStaff
   def self.get(name)
     @grand_staves ||= {}
     hash_key = HeadMusic::Utilities::HashKey.for(name)
-    return nil unless GRAND_STAVES.keys.include?(hash_key)
+    return nil unless GRAND_STAVES.key?(hash_key)
+
     @grand_staves[hash_key] ||= new(hash_key)
   end
 

data/lib/head_music/harmonic_interval.rb

@@ -44,6 +44,7 @@ class HeadMusic::HarmonicInterval
 
   def pitch_orientation
     return if lower_pitch == upper_pitch
+
     if lower_note.voice == voice1
       :up
     elsif lower_note.voice == voice2

data/lib/head_music/key_signature.rb

@@ -15,6 +15,7 @@ class HeadMusic::KeySignature
 
   def self.get(identifier)
     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(/(\w)[b♭]/, '\\1 flat'))

data/lib/head_music/letter_name.rb

@@ -31,6 +31,7 @@ class HeadMusic::LetterName
   def self.from_pitch_class(pitch_class)
     @letter_names ||= {}
     return nil if pitch_class.to_s == pitch_class
+
     pitch_class = pitch_class.to_i % 12
     name = NAMES.detect { |candidate| pitch_class == NATURAL_PITCH_CLASS_NUMBERS[candidate] }
     name ||= HeadMusic::PitchClass::SHARP_SPELLINGS[pitch_class].first
@@ -59,8 +60,12 @@ class HeadMusic::LetterName
     NAMES.index(to_s) + 1
   end
 
-  def steps(num)
-    HeadMusic::LetterName.get(cycle[num % NAMES.length])
+  def steps_up(num)
+    HeadMusic::LetterName.get(series_ascending[num % NAMES.length])
+  end
+
+  def steps_down(num)
+    HeadMusic::LetterName.get(series_descending[num % NAMES.length])
   end
 
   def steps_to(other, direction = :ascending)
@@ -75,11 +80,19 @@ class HeadMusic::LetterName
     end
   end
 
-  def cycle
-    @cycle ||= begin
-      cycle = NAMES
-      cycle = cycle.rotate while cycle.first != to_s
-      cycle
+  def series_ascending
+    @series_ascending ||= begin
+      series = NAMES
+      series = series.rotate while series.first != to_s
+      series
+    end
+  end
+
+  def series_descending
+    @series_descending ||= begin
+      series = NAMES.reverse
+      series = series.rotate while series.first != to_s
+      series
     end
   end
 

data/lib/head_music/melodic_interval.rb

@@ -62,11 +62,11 @@ class HeadMusic::MelodicInterval
   end
 
   def high_pitch
-    pitches.sort.last
+    pitches.max
   end
 
   def low_pitch
-    pitches.sort.first
+    pitches.min
   end
 
   def direction
@@ -82,8 +82,10 @@ class HeadMusic::MelodicInterval
 
   def spells_consonant_triad_with?(other_interval)
     return false if step? || other_interval.step?
+
     combined_pitches = (pitches + other_interval.pitches).uniq
     return false if combined_pitches.length < 3
+
     HeadMusic::Chord.new(combined_pitches).consonant_triad?
   end
 

data/lib/head_music/meter.rb

@@ -67,6 +67,7 @@ class HeadMusic::Meter
     return 80 if strong_beat?(count, tick)
     return 60 if beat?(tick)
     return 40 if strong_ticks.include?(tick)
+
     20
   end
 

data/lib/head_music/octave.rb

@@ -13,12 +13,14 @@ class HeadMusic::Octave
   def self.from_number(identifier)
     return nil unless identifier.to_s == identifier.to_i.to_s
     return nil unless (-2..12).cover?(identifier.to_i)
+
     @octaves ||= {}
     @octaves[identifier.to_i] ||= new(identifier.to_i)
   end
 
   def self.from_name(string)
     return unless string.to_s.match?(HeadMusic::Spelling::MATCHER)
+
     _letter, _sign, octave_string = string.to_s.match(HeadMusic::Spelling::MATCHER).captures
     @octaves ||= {}
     @octaves[octave_string.to_i] ||= new(octave_string.to_i) if octave_string

data/lib/head_music/pitch/enharmonic_equivalence.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# An enharmonic equivalent pitch is the same frequency spelled differently, such as D# and Eb.
+class HeadMusic::Pitch::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

data/lib/head_music/pitch/octave_equivalence.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Octave equivalence is the functional equivalence of pitches with the same spelling separated by one or more octaves.
+class HeadMusic::Pitch::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
+end