head_music 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072224f0fd9e0fff2051143e6a786daf70a975e4
-  data.tar.gz: a5c8934d86c94c68c26607a88e324f6670ceb97b
+  metadata.gz: 63d427018297be00f798c809a49236ad36556096
+  data.tar.gz: 8fcbff20bc04bee42a900b5d9bef1dabb9b9bf1f
 SHA512:
-  metadata.gz: d68c00dbf07773b7001c6d245dfc11957a111f979d4f919f98b7f9c336108017024ba86ad4a6b9353b054dbef7432230e72d10c9b9beaa49d0040c9572be4ef3
-  data.tar.gz: d722a4f6569009c22db17dac114f2a61a9e9efdbbca1e8a71a727ac2dfdd238d06e551e78716537a8520c2dbe691b3f14942833be2e68bbc2a7ef0b8c0373f01
+  metadata.gz: 5eec89666c474d7cbe5114ca4504f57bdddfc3eb9899b1fe666946cb9b4c8fd8dc4ac144a95512bb9dd0f86a7060fd6e1a201fd78daa94f701095bf8456ecdca
+  data.tar.gz: 692a3fc51fdbe388e498d873a45d4f50776dcf9b5669b65bf4694986aa94b8be8a7b4208a6243487c21ba00dbab86f4be82aeeb45470c358f1fed40d730e1f62

data/head_music.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   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"

data/lib/head_music/functional_interval.rb

@@ -1,9 +1,90 @@
 class HeadMusic::FunctionalInterval
-  def self.between(pitch1, pitch2)
-    new
+  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' })
+
+  QUALITY = {
+    unison: {perfect: 0},
+    second: {major: 2},
+    third: {major: 4},
+    fourth: {perfect: 5},
+    fifth: {perfect: 7},
+    sixth: {major: 9},
+    seventh: {major: 11},
+  }
+
+  attr_reader :lower_pitch, :higher_pitch
+
+  def initialize(pitch1, pitch2)
+    @lower_pitch, @higher_pitch = [HeadMusic::Pitch.get(pitch1), HeadMusic::Pitch.get(pitch2)].sort
+  end
+
+  def number
+    simple_number + octaves * 7
+  end
+
+  def simple_number
+    @simple_number ||= @lower_pitch.letter.steps_to(@higher_pitch.letter) + 1
+  end
+
+  def simple_semitones
+    semitones % 12
+  end
+
+  def semitones
+    (@higher_pitch - @lower_pitch).to_i
+  end
+
+  def octaves
+    (higher_pitch.number - lower_pitch.number) / 12
+  end
+
+  def compound?
+    !simple?
+  end
+
+  def simple?
+    octaves == 0
+  end
+
+  def simple_name
+    [quality_name, simple_number_name].join(' ')
   end
 
   def name
-    'perfect fifth'
+    if number < NUMBER_NAMES.length
+      [quality_name, number_name].join(' ')
+    elsif simple_name == 'perfect unison'
+      string = "#{octaves.humanize} octaves"
+    else
+      "#{octaves.humanize} octaves and #{quality.article} #{simple_name}"
+    end
+  end
+
+  def shorthand
+    [quality.shorthand, number].join
+  end
+
+  def quality
+    HeadMusic::Quality.get(quality_name)
+  end
+
+  def quality_name
+    starting_quality = QUALITY[simple_number_name.to_sym].keys.first
+    delta = simple_semitones - QUALITY[simple_number_name.to_sym][starting_quality]
+    if starting_quality == :perfect
+      HeadMusic::Quality::PERFECT_INTERVAL_MODIFICATION[delta]
+    elsif starting_quality == :major
+      HeadMusic::Quality::MAJOR_INTERVAL_MODIFICATION[delta]
+    end
+  end
+
+  def simple_number_name
+    NUMBER_NAMES[simple_number - 1]
+  end
+
+  def number_name
+    NUMBER_NAMES[number - 1] || begin
+      number.to_s + NAME_SUFFIXES[number % 10]
+    end
   end
 end

data/lib/head_music/interval.rb

@@ -21,7 +21,7 @@ class HeadMusic::Interval
     @semitones = semitones
   end
 
-  def simplified
+  def simple
     HeadMusic::Interval.get(semitones % 12)
   end
 

data/lib/head_music/letter.rb

@@ -54,6 +54,22 @@ class HeadMusic::Letter
     to_s == value.to_s
   end
 
+  def position
+    NAMES.index(self.to_s) + 1
+  end
+
+  def steps_to(other, direction = :ascending)
+    other = Letter.get(other)
+    other_position = other.position
+    if direction == :descending
+      other_position -= NAMES.length if other_position > position
+      position - other_position
+    else
+      other_position += NAMES.length if other_position < position
+      other_position - position
+    end
+  end
+
   def cycle
     cycle = NAMES
     while cycle.first != self.to_s

data/lib/head_music/pitch.rb

@@ -78,7 +78,13 @@ class HeadMusic::Pitch
   end
 
   def -(value)
-    Pitch.get(self.to_i - value.to_i)
+    if value.is_a?(HeadMusic::Pitch)
+      # return an interval
+      HeadMusic::Interval.get(self.to_i - value.to_i)
+    else
+      # assume value represents an interval in semitones and return another pitch
+      HeadMusic::Pitch.get(self.to_i - value.to_i)
+    end
   end
 
   def ==(value)

data/lib/head_music/quality.rb

@@ -1,10 +1,35 @@
 class HeadMusic::Quality
-  QUALITY_NAMES = %w[perfect major minor diminished augmented].map(&:to_sym)
+  SHORTHAND = {
+    perfect: 'P',
+    major: 'M',
+    minor: 'm',
+    diminished: 'd',
+    augmented: 'A',
+    doubly_diminished: 'dd',
+    doubly_augmented: 'AA',
+  }
+  NAMES = SHORTHAND.keys
+
+  PERFECT_INTERVAL_MODIFICATION = {
+    -2 => :doubly_diminished,
+    -1 => :diminished,
+    0 => :perfect,
+    1 => :augmented,
+    2 => :doubly_augmented
+  }
+
+  MAJOR_INTERVAL_MODIFICATION = {
+    -2 => :diminished,
+    -1 => :minor,
+    0 => :major,
+    1 => :augmented,
+    2 => :doubly_augmented
+  }
 
   def self.get(identifier)
     @qualities ||= {}
     identifier = identifier.to_s.to_sym
-    @qualities[identifier] ||= new(identifier) if QUALITY_NAMES.include?(identifier)
+    @qualities[identifier] ||= new(identifier) if NAMES.include?(identifier)
   end
 
   attr_reader :name
@@ -18,5 +43,13 @@ class HeadMusic::Quality
     self.to_s == other.to_s
   end
 
+  def shorthand
+    SHORTHAND[name]
+  end
+
+  def article
+    %w[a e i o u h].include?(name.to_s.first) ? 'an' : 'a'
+  end
+
   private_class_method :new
 end

data/lib/head_music/version.rb

@@ -1,3 +1,3 @@
 module HeadMusic
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/head_music.rb

@@ -2,6 +2,7 @@ require "head_music/version"
 
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/string/access"
+require "humanize"
 
 require "head_music/accidental"
 require "head_music/circle"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rob Head
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: humanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement