head_music 0.17.0 → 0.18.0

data/Gemfile

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+ruby '2.4.0'
+
 # Specify your gem's dependencies in head_music.gemspec
 gemspec
 
 group :test do
-  gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'simplecov'
 end

data/Rakefile

@@ -1,11 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
-desc "Open an irb session preloaded with this library"
+desc 'Open an irb session preloaded with this library'
 task :console do
-  sh "irb -rubygems -I lib -r head_music.rb"
+  sh 'irb -rubygems -I lib -r head_music.rb'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "head_music"
+require 'bundler/setup'
+require 'head_music'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "head_music"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/circle.yml

@@ -6,4 +6,4 @@ machine:
   # Version of ruby to use
   ruby:
     version:
-      2.3.1
+      2.4.0

data/head_music.gemspec

@@ -1,33 +1,35 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'head_music/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "head_music"
+  spec.name          = 'head_music'
   spec.version       = HeadMusic::VERSION
-  spec.authors       = ["Rob Head"]
-  spec.email         = ["robert.head@gmail.com"]
+  spec.authors       = ['Rob Head']
+  spec.email         = ['robert.head@gmail.com']
 
-  spec.summary       = %q{The rudiments of western music theory.}
-  spec.description   = %q{Work with the elements of western music theory, such as pitches, scales, intervals, and chords.}
-  spec.homepage      = "https://github.com/roberthead/head_music"
-  spec.license       = "MIT"
+  spec.summary       = 'The rudiments of western music theory.'
+  spec.description   = 'Work with the elements of western music theory, such as pitches, scales, intervals, and chords.'
+  spec.homepage      = 'https://github.com/roberthead/head_music'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '> 2.3.0'
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_runtime_dependency "activesupport", "~> 5.0"
-  spec.add_runtime_dependency "humanize", "~> 1.3"
+  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'humanize', '~> 1.3'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2'
 end

data/lib/head_music/bar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Representation of a bar in a composition
 # Encapsulates meter and key signature changes
 class HeadMusic::Bar

data/lib/head_music/chord.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# A Chord is a collection of three or more pitches
 class HeadMusic::Chord
   attr_reader :pitches
 
@@ -7,12 +10,27 @@ class HeadMusic::Chord
   end
 
   def consonant_triad?
-    pitches.length == 3 &&
-    (
-      intervals.map(&:shorthand).sort == %w[M3 m3] ||
-      invert.intervals.map(&:shorthand).sort == %w[M3 m3] ||
-      invert.invert.intervals.map(&:shorthand).sort == %w[M3 m3]
-    )
+    return false unless three_pitches?
+    root_triad? || first_inversion_triad? || second_inversion_triad?
+  end
+
+  def root_triad?
+    intervals.map(&:shorthand).sort == %w[M3 m3]
+  end
+
+  def first_inversion_triad?
+    invert.invert.intervals.map(&:shorthand).sort == %w[M3 m3]
+  end
+
+  def second_inversion_triad?
+    invert.intervals.map(&:shorthand).sort == %w[M3 m3]
+  end
+
+  # TODO
+  def reduction; end
+
+  def three_pitches?
+    pitches.length == 3
   end
 
   def intervals

data/lib/head_music/circle.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+# A Circle of Fifths or Fourths shows relationships between pitch classes
+# TODO: Replace or empower with IntervalCycle (?)
+# https://en.wikipedia.org/wiki/Interval_cycle
 class HeadMusic::Circle
   def self.of_fifths
     get(7)

data/lib/head_music/clef.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# A clef assigns pitches to the lines and spaces of a staff.
 class HeadMusic::Clef
   include HeadMusic::NamedRudiment
 
@@ -16,8 +19,8 @@ class HeadMusic::Clef
     { pitch: 'C4', line: 4, names: ['tenor'], modern: true },
     { pitch: 'C4', line: 5, names: ['baritone'] },
 
-    { pitch: nil, line: 3, names: ['neutral', 'percussion'] }
-  ]
+    { pitch: nil, line: 3, names: %w[neutral percussion] },
+  ].freeze
 
   def self.get(name)
     get_by_name(name)

data/lib/head_music/composition.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# A composition is a portion of music.
 class HeadMusic::Composition
   attr_reader :name, :key_signature, :meter, :voices
 

data/lib/head_music/consonance.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
+# Consonance is a description of intervals that sound more pleasing.
 class HeadMusic::Consonance
-  LEVELS = %w[perfect imperfect dissonant]
+  LEVELS = %w[perfect imperfect dissonant].freeze
 
   def self.get(name)
     @consonances ||= {}
@@ -15,7 +18,7 @@ class HeadMusic::Consonance
   end
 
   def ==(other)
-    self.to_s == other.to_s
+    to_s == other.to_s
   end
 
   LEVELS.each do |method_name|

data/lib/head_music/functional_interval.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
+
+# Represents a functional interval.
 class HeadMusic::FunctionalInterval
   include Comparable
 
-  NUMBER_NAMES = %w[unison second third fourth fifth sixth seventh octave ninth tenth eleventh twelfth thirteenth fourteenth fifteenth sixteenth seventeenth]
-  NAME_SUFFIXES = Hash.new('th').merge({ 1 => 'st', 2 => 'nd', 3 => 'rd' })
+  NUMBER_NAMES = %w[
+    unison second third fourth fifth sixth seventh octave
+    ninth tenth eleventh twelfth thirteenth fourteenth fifteenth
+    sixteenth seventeenth
+  ].freeze
+  NAME_SUFFIXES = Hash.new('th').merge(1 => 'st', 2 => 'nd', 3 => 'rd').freeze
 
   QUALITY_SEMITONES = {
     unison: { perfect: 0 },
@@ -21,43 +28,75 @@ class HeadMusic::FunctionalInterval
     fourteenth: { major: 23 },
     fifteenth: { perfect: 24 },
     sixteenth: { major: 26 },
-    seventeenth: { major: 28 }
-  }
+    seventeenth: { major: 28 },
+  }.freeze
 
   attr_reader :lower_pitch, :higher_pitch
 
   delegate :to_s, to: :name
   delegate :perfect?, :major?, :minor?, :diminished?, :augmented?, :doubly_diminished?, :doubly_augmented?, to: :quality
 
-  def self.get(name)
-    words = name.to_s.split(/[_ ]+/)
-    quality_name, degree_name = words[0..-2].join(' '), words.last
-    lower_pitch = HeadMusic::Pitch.get('C4')
-    steps = NUMBER_NAMES.index(degree_name)
-    higher_letter = lower_pitch.letter_name.steps(steps)
-    semitones = degree_quality_semitones.dig(degree_name.to_sym, quality_name.to_sym)
-    higher_pitch = HeadMusic::Pitch.from_number_and_letter(lower_pitch + semitones, higher_letter)
-    new(lower_pitch, higher_pitch)
-  end
-
-  def self.degree_quality_semitones
-    @degree_quality_semitones ||= begin
-      degree_quality_semitones = QUALITY_SEMITONES
-      QUALITY_SEMITONES.each do |degree_name, qualities|
-        default_quality = qualities.keys.first
-        if default_quality == :perfect
-          modification_hash = HeadMusic::Quality::PERFECT_INTERVAL_MODIFICATION.invert
-        else
-          modification_hash = HeadMusic::Quality::MAJOR_INTERVAL_MODIFICATION.invert
-        end
-        default_semitones = qualities[default_quality]
-        modification_hash.each do |quality_name, delta|
-          if quality_name != default_quality
-            degree_quality_semitones[degree_name][quality_name] = default_semitones + delta
-          end
+  # Representation of the name of the functional interval
+  class Name
+    attr_reader :identifier
+
+    def initialize(identifier)
+      @identifier = identifier
+    end
+
+    def words
+      identifier.to_s.split(/[_ ]+/)
+    end
+
+    def quality_name
+      words[0..-2].join(' ').to_sym
+    end
+
+    def degree_name
+      words.last
+    end
+
+    def steps
+      NUMBER_NAMES.index(degree_name)
+    end
+
+    def higher_letter
+      HeadMusic::Pitch.middle_c.letter_name.steps(steps)
+    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
+
+  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
-      degree_quality_semitones
+    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
+      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
     end
   end
 
@@ -96,7 +135,7 @@ class HeadMusic::FunctionalInterval
   end
 
   def simple?
-    octaves == 0
+    octaves.zero?
   end
 
   def simple_name
@@ -104,7 +143,7 @@ class HeadMusic::FunctionalInterval
   end
 
   def name
-    if number < NUMBER_NAMES.length
+    if named_number?
       [quality_name, number_name].join(' ')
     elsif simple_name == 'perfect unison'
       "#{octaves.humanize} octaves"
@@ -125,7 +164,7 @@ 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]
-    HeadMusic::Quality::from(starting_quality, delta)
+    HeadMusic::Quality.from(starting_quality, delta)
   end
 
   def simple_number_name
@@ -133,16 +172,12 @@ class HeadMusic::FunctionalInterval
   end
 
   def number_name
-    NUMBER_NAMES[number - 1] || begin
-      number.to_s + NAME_SUFFIXES[number % 10]
-    end
+    NUMBER_NAMES[number - 1] || (number.to_s + NAME_SUFFIXES[number % 10])
   end
 
   def inversion
     inverted_low_pitch = lower_pitch
-    while inverted_low_pitch < higher_pitch
-      inverted_low_pitch += 12
-    end
+    inverted_low_pitch += 12 while inverted_low_pitch < higher_pitch
     HeadMusic::FunctionalInterval.new(higher_pitch, inverted_low_pitch)
   end
 
@@ -169,11 +204,11 @@ class HeadMusic::FunctionalInterval
   end
 
   def step?
-    number <= 2
+    number == 2
   end
 
   def skip?
-    number >= 3
+    number == 3
   end
 
   def leap?
@@ -185,10 +220,8 @@ class HeadMusic::FunctionalInterval
   end
 
   def <=>(other)
-    if !other.is_a?(HeadMusic::FunctionalInterval)
-      other = self.class.get(other)
-    end
-    self.semitones <=> other.semitones
+    other = self.class.get(other) unless other.is_a?(HeadMusic::FunctionalInterval)
+    semitones <=> other.semitones
   end
 
   NUMBER_NAMES.each do |interval_name|
@@ -201,12 +234,16 @@ class HeadMusic::FunctionalInterval
 
   private
 
+  def named_number?
+    number < NUMBER_NAMES.length
+  end
+
   def consonance_for_perfect(style = :standard_practice)
     HeadMusic::Consonance.get(dissonant_fourth?(style) ? :dissonant : :perfect) if perfect?
   end
 
   def consonance_for_major_and_minor
-    HeadMusic::Consonance.get((third_or_compound? || sixth_or_compound?) ? :imperfect : :dissonant) if (major? || minor?)
+    HeadMusic::Consonance.get(third_or_compound? || sixth_or_compound? ? :imperfect : :dissonant) if major? || minor?
   end
 
   def dissonant_fourth?(style = :standard_practice)

data/lib/head_music/grand_staff.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
+# A grand staff is a group of staves for a single instrument, such as a piano.
 class HeadMusic::GrandStaff
   GRAND_STAVES = {
     piano: {
       instrument: :piano,
       staves: [
         { clef: :treble, instrument: :piano },
-        { clef: :bass, instrument: :piano }
-      ]
+        { clef: :bass, instrument: :piano },
+      ],
     },
     organ: {
       instrument: :organ,
       staves: [
         { clef: :treble, instrument: :organ },
         { clef: :bass, instrument: :organ },
-        { clef: :bass, instrument: :pedals }
-      ]
-    }
-  }
+        { clef: :bass, instrument: :pedals },
+      ],
+    },
+  }.freeze
 
   def self.get(name)
     @grand_staves ||= {}
@@ -36,11 +39,8 @@ class HeadMusic::GrandStaff
   end
 
   def staves
-    @staves ||= begin
-      data[:staves].map { |staff|
-        HeadMusic::Staff.new(staff[:clef], instrument: staff[:instrument] || instrument)
-      }
-    end
+    @staves ||=
+      data[:staves].map { |staff| HeadMusic::Staff.new(staff[:clef], instrument: staff[:instrument] || instrument) }
   end
 
   def brace_staves_index_first

data/lib/head_music/harmonic_interval.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# A harmonic interval is the functional interval between two notes sounding together.
 class HeadMusic::HarmonicInterval
   attr_reader :voice1, :voice2, :position
 
@@ -40,12 +43,11 @@ class HeadMusic::HarmonicInterval
   end
 
   def pitch_orientation
-    if lower_pitch < upper_pitch
-      if lower_note.voice == voice1
-        :up
-      elsif lower_note.voice == voice2
-        :down
-      end
+    return if lower_pitch == upper_pitch
+    if lower_note.voice == voice1
+      :up
+    elsif lower_note.voice == voice2
+      :down
     end
   end
 
@@ -54,6 +56,10 @@ class HeadMusic::HarmonicInterval
   end
 
   def method_missing(method_name, *args, &block)
-    functional_interval.send(method_name, *args, &block)
+    respond_to_missing?(method_name) ? functional_interval.send(method_name, *args, &block) : super
+  end
+
+  def respond_to_missing?(method_name, *_args)
+    functional_interval.respond_to?(method_name)
   end
 end

data/lib/head_music/instrument.rb

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
+
+# An instrument can be assigned to a staff.
 class HeadMusic::Instrument
   include HeadMusic::NamedRudiment
 
   INSTRUMENTS = {
     violin: {
-      name: "violin",
+      name: 'violin',
       family: :string,
-      default_clef: :treble
+      default_clef: :treble,
     },
     piano: {
-      name: "piano",
+      name: 'piano',
       family: :string,
-      default_system: [:treble, :bass]
-    }
-  }
+      default_system: %i[treble bass],
+    },
+  }.freeze
 
   def self.get(name)
     get_by_name(name)

data/lib/head_music/interval.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+# An interval is the distance between two pitches.
 class HeadMusic::Interval
   include Comparable
 
   private_class_method :new
 
-  NAMES = %w{perfect_unison minor_second major_second minor_third major_third perfect_fourth tritone perfect_fifth minor_sixth major_sixth minor_seventh major_seventh perfect_octave}
+  NAMES = %w[
+    perfect_unison minor_second major_second minor_third major_third perfect_fourth tritone perfect_fifth
+    minor_sixth major_sixth minor_seventh major_seventh perfect_octave
+  ].freeze
 
   attr_reader :semitones
 
@@ -23,7 +29,7 @@ class HeadMusic::Interval
   end
 
   def simple?
-    (0..12).include?(semitones)
+    (0..12).cover?(semitones)
   end
 
   def compound?
@@ -34,15 +40,15 @@ class HeadMusic::Interval
     semitones
   end
 
-  def +(value)
-    HeadMusic::Interval.get(to_i + value.to_i)
+  def +(other)
+    HeadMusic::Interval.get(to_i + other.to_i)
   end
 
-  def -(value)
-    HeadMusic::Interval.get((to_i - value.to_i).abs)
+  def -(other)
+    HeadMusic::Interval.get((to_i - other.to_i).abs)
   end
 
   def <=>(other)
-    self.to_i <=> other.to_i
+    to_i <=> other.to_i
   end
 end

data/lib/head_music/key_signature.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
+# Represents a key signature.
 class HeadMusic::KeySignature
   attr_reader :tonic_spelling
   attr_reader :scale_type
   attr_reader :scale
 
-  SHARPS = %w{F♯ C♯ G♯ D♯ A♯ E♯ B♯}
-  FLATS = %w{B♭ E♭ A♭ D♭ G♭ C♭ F♭}
+  SHARPS = %w[F♯ C♯ G♯ D♯ A♯ E♯ B♯].freeze
+  FLATS = %w[B♭ E♭ A♭ D♭ G♭ C♭ F♭].freeze
 
   def self.default
     @default ||= new('C', :major)
@@ -50,8 +53,8 @@ class HeadMusic::KeySignature
     flats.length
   end
 
-  def sharps_or_flats
-    flats.length > 0 ? flats : sharps
+  def signs
+    !flats.empty? ? flats : sharps
   end
 
   def name
@@ -59,6 +62,6 @@ class HeadMusic::KeySignature
   end
 
   def ==(other)
-    self.sharps_or_flats == self.class.get(other).sharps_or_flats
+    signs == self.class.get(other).signs
   end
 end