head_music 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4274cb71a70fcab6904e99afc282bb1db756e2a1cce0c1e1e50c601e0e848edf
-  data.tar.gz: 47566a6db5b0836686fd789cf2e0b052416a68f8f2ed67b2f6582266a141ea1a
+  metadata.gz: 3ff9ff67c1a33423b012f970f7e5ff244f44fa05c07315cd248d47d206489369
+  data.tar.gz: f94cc84e2c2805f22a1e4f4f08f09182f65c639b7052db18149c1acab3788161
 SHA512:
-  metadata.gz: b85d9dbd114b70bfea1fa9ce8cb964f6780ad9f64325a75baba02df48e416475f33e26a9dab22309740ff6e7f033fca756906a4fd5935af1f22e6fd325a775d4
-  data.tar.gz: 60a75acc692a1e1014f6042f9b167ecd7a0f6ec8eb98ca5dccb4c16a9bbcc79deff0b56481a713941caad779b7cc17b8487c89f4b4839bb31e3b453cff7558b5
+  metadata.gz: f34e8f37402764fb6b1dfe407821a4dd0e7ff3f382b0d33319c3c9c958635df312c7cf7b27fdfe35f68795eb8bfd60457d38b2168ff9910dd60f51bb29ad36df
+  data.tar.gz: 12dc1f950956cdf792beb0c530ed78a2cd9301328056d97052566902324b63c21e15cf1a23774d88620a73f7fe0ea42acb593be74ab13915aa16063dd58f6f1d

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.6.5
+      - image: circleci/ruby:2.6.7
     steps:
       - checkout
       - restore_cache:

data/.rubocop.yml

@@ -1,42 +1,32 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.5
+require:
+  - standard
+  - rubocop-rspec
 
-Layout/DotPosition:
-  EnforcedStyle: trailing
+inherit_gem:
+  standard: config/base.yml
 
-Layout/LineLength:
-  Max: 120
-
-Metrics/BlockLength:
+AllCops:
+  NewCops: enable
   Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'spec/**/*.rb'
-
-Metrics/ClassLength:
-  Max: 155
-
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-
-Style/HashEachMethods:
-  Enabled: false
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
+    - public/**/*
+    - vendor/**/*
+  TargetRubyVersion: 3.1.4
 
-Style/SymbolArray:
+RSpec:
   Enabled: true
 
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - given
+    - and
+    - for
+    - by
 
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
+RSpec/NestedGroups:
+  Max: 4
 
-Layout/EmptyLineAfterGuardClause:
+RSpec/FilePath:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.1.4

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.6.5
+  - 3.1.4
 before_install: gem install bundler

data/Gemfile

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

data/Rakefile

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(: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 -I lib -r head_music.rb'
+  sh "irb -I lib -r head_music.rb"
 end

data/bin/console

@@ -1,8 +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.
@@ -11,5 +11,5 @@ require 'head_music'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/head_music.gemspec

@@ -1,35 +1,34 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'head_music/version'
+require "head_music/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'head_music'
-  spec.version       = HeadMusic::VERSION
-  spec.authors       = ['Rob Head']
-  spec.email         = ['robert.head@gmail.com']
+  spec.name = "head_music"
+  spec.version = HeadMusic::VERSION
+  spec.authors = ["Rob Head"]
+  spec.email = ["robert.head@gmail.com"]
 
-  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.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|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = ">= 2.5"
 
-  spec.add_runtime_dependency 'activesupport', '> 5.0'
-  spec.add_runtime_dependency 'humanize', '~> 1.3'
-  spec.add_runtime_dependency 'i18n', '~> 1.8'
+  spec.add_runtime_dependency "activesupport", "> 5.0"
+  spec.add_runtime_dependency "humanize", "~> 1.3"
+  spec.add_runtime_dependency "i18n", "~> 1.8"
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
 end

data/lib/head_music/chromatic_interval.rb

@@ -16,7 +16,7 @@ class HeadMusic::ChromaticInterval
 
   def self.get(identifier)
     @intervals ||= {}
-    candidate = identifier.to_s.downcase.gsub(/\W+/, '_')
+    candidate = identifier.to_s.downcase.gsub(/\W+/, "_")
     semitones = NAMES.index(candidate) || identifier.to_i
     @intervals[semitones] ||= new(semitones.to_i)
   end
@@ -42,11 +42,11 @@ class HeadMusic::ChromaticInterval
   end
 
   def diatonic_name
-    NAMES[simple.semitones].gsub(/_/, ' ')
+    NAMES[simple.semitones].tr("_", " ")
   end
 
   # diatonic set theory
-  alias specific_interval semitones
+  alias_method :specific_interval, :semitones
 
   def +(other)
     HeadMusic::ChromaticInterval.get(to_i + other.to_i)

data/lib/head_music/circle.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'head_music/interval_cycle'
+require "head_music/interval_cycle"
 
 # A Circle of Fifths or Fourths shows relationships between pitch classes
 class HeadMusic::Circle < HeadMusic::IntervalCycle
@@ -15,15 +15,13 @@ class HeadMusic::Circle < HeadMusic::IntervalCycle
   def self.get(interval = :perfect_fifth)
     @circles ||= {}
     diatonic_interval = HeadMusic::DiatonicInterval.get(interval)
-    @circles[interval] ||= new(interval: diatonic_interval, starting_pitch: 'C4')
+    @circles[interval] ||= new(interval: diatonic_interval, starting_pitch: "C4")
   end
 
   def index(pitch_class)
     pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
   end
 
-  alias spellings_up spellings
-
   def key_signatures_up
     spellings_up.map { |spelling| HeadMusic::KeySignature.new(spelling) }
   end
@@ -32,20 +30,26 @@ class HeadMusic::Circle < HeadMusic::IntervalCycle
     spellings_down.map { |spelling| HeadMusic::KeySignature.new(spelling) }
   end
 
+  def spellings_up
+    pitches_up.map(&:pitch_class).map do |pitch_class|
+      pitch_class.smart_spelling(max_sharps_in_major_key_signature: 7)
+    end
+  end
+
   def spellings_down
-    pitches_down.map(&:spelling)
+    pitches_down.map(&:pitch_class).map do |pitch_class|
+      pitch_class.smart_spelling(max_sharps_in_major_key_signature: 4)
+    end
   end
 
   def pitches_down
-    @pitches_down ||= begin
-      [starting_pitch].tap do |list|
-        loop do
-          next_pitch = list.last - interval
-          next_pitch += octave while starting_pitch - next_pitch > 12
-          break if next_pitch.pitch_class == list.first.pitch_class
-
-          list << next_pitch
-        end
+    @pitches_down ||= [starting_pitch].tap do |list|
+      loop do
+        next_pitch = list.last - interval
+        next_pitch += octave while starting_pitch - next_pitch > 12
+        break if next_pitch.pitch_class == list.first.pitch_class
+
+        list << next_pitch
       end
     end
   end

data/lib/head_music/clef.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 # A clef assigns pitches to the lines and spaces of a staff.
 class HeadMusic::Clef
   include HeadMusic::Named
 
-  RECORDS = YAML.load_file(File.expand_path('data/clefs.yml', __dir__)).freeze
+  RECORDS = YAML.load_file(File.expand_path("data/clefs.yml", __dir__)).freeze
 
   def self.get(name)
     get_by_name(name)
@@ -97,7 +97,7 @@ class HeadMusic::Clef
 
   def initialize_musical_symbols(list)
     @musical_symbols = (list || []).map do |symbol_data|
-      HeadMusic::MusicalSymbol.new(symbol_data.slice(:ascii, :html_entity, :unicode))
+      HeadMusic::MusicalSymbol.new(**symbol_data.slice(:ascii, :html_entity, :unicode))
     end
   end
 end

data/lib/head_music/content/bar.rb

@@ -13,6 +13,6 @@ class HeadMusic::Bar
   end
 
   def to_s
-    ['Bar', key_signature, meter].compact.join(' ')
+    ["Bar", key_signature, meter].compact.join(" ")
   end
 end

data/lib/head_music/content/composition.rb

@@ -63,7 +63,7 @@ class HeadMusic::Composition
   private
 
   def ensure_attributes(name, key_signature, meter)
-    @name = name || 'Composition'
+    @name = name || "Composition"
     @key_signature = HeadMusic::KeySignature.get(key_signature) if key_signature
     @key_signature ||= HeadMusic::KeySignature.default
     @meter = meter ? HeadMusic::Meter.get(meter) : HeadMusic::Meter.default

data/lib/head_music/content/note.rb

@@ -12,7 +12,7 @@ class HeadMusic::Note
     @pitch = HeadMusic::Pitch.get(pitch)
     @rhythmic_value = HeadMusic::RhythmicValue.get(rhythmic_value)
     @voice = voice || HeadMusic::Voice.new
-    @position = position || HeadMusic::Position.new(@voice.composition, '1:1')
+    @position = position || HeadMusic::Position.new(@voice.composition, "1:1")
   end
 
   def placement

data/lib/head_music/content/placement.rb

@@ -34,7 +34,7 @@ class HeadMusic::Placement
   end
 
   def to_s
-    "#{rhythmic_value} #{pitch || 'rest'} at #{position}"
+    "#{rhythmic_value} #{pitch || "rest"} at #{position}"
   end
 
   private
@@ -60,9 +60,9 @@ class HeadMusic::Placement
 
   def ensure_position(position)
     @position = if position.is_a?(HeadMusic::Position)
-                  position
-                else
-                  HeadMusic::Position.new(composition, position)
-                end
+      position
+    else
+      HeadMusic::Position.new(composition, position)
+    end
   end
 end

data/lib/head_music/content/position.rb

@@ -22,12 +22,12 @@ class HeadMusic::Position
   end
 
   def code
-    tick_string = tick.to_s.rjust(3, '0')
-    [bar_number, count, tick_string].join(':')
+    tick_string = tick.to_s.rjust(3, "0")
+    [bar_number, count, tick_string].join(":")
   end
 
   def state
-    [composition.name, code].join(' ')
+    [composition.name, code].join(" ")
   end
 
   def values

data/lib/head_music/content/rhythmic_value.rb

@@ -14,7 +14,7 @@ class HeadMusic::RhythmicValue
     when HeadMusic::RhythmicUnit
       new(identifier)
     when Symbol, String
-      identifier = identifier.to_s.downcase.strip.gsub(/\W+/, '_')
+      identifier = identifier.to_s.downcase.strip.gsub(/\W+/, "_")
       from_words(identifier)
     end
   end
@@ -24,7 +24,7 @@ class HeadMusic::RhythmicValue
   end
 
   def self.unit_from_words(identifier)
-    identifier.gsub(/^\w*dotted_/, '')
+    identifier.gsub(/^\w*dotted_/, "")
   end
 
   def self.dots_from_words(identifier)
@@ -74,21 +74,21 @@ class HeadMusic::RhythmicValue
   def name_modifier_prefix
     case dots
     when 1
-      'dotted'
+      "dotted"
     when 2
-      'double-dotted'
+      "double-dotted"
     when 3
-      'triple-dotted'
+      "triple-dotted"
     end
   end
 
   def single_value_name
-    [name_modifier_prefix, unit_name].compact.join(' ')
+    [name_modifier_prefix, unit_name].compact.join(" ")
   end
 
   def name
     if tied_value
-      [single_value_name, tied_value.name].compact.join(' tied to ')
+      [single_value_name, tied_value.name].compact.join(" tied to ")
     else
       single_value_name
     end
@@ -99,6 +99,6 @@ class HeadMusic::RhythmicValue
   end
 
   def to_s
-    name.tr('_', '-')
+    name.tr("_", "-")
   end
 end

data/lib/head_music/content/voice.rb

@@ -84,7 +84,7 @@ class HeadMusic::Voice
   end
 
   def note_preceding(position)
-    notes.select { |note| note.position < position }.last
+    notes.reverse.find { |note| note.position < position }
   end
 
   def note_following(position)

data/lib/head_music/diatonic_interval.rb

@@ -10,34 +10,34 @@ class HeadMusic::DiatonicInterval
     ninth tenth eleventh twelfth thirteenth fourteenth fifteenth
     sixteenth seventeenth
   ].freeze
-  NAME_SUFFIXES = Hash.new('th').merge(1 => 'st', 2 => 'nd', 3 => 'rd').freeze
+  NAME_SUFFIXES = Hash.new("th").merge(1 => "st", 2 => "nd", 3 => "rd").freeze
 
   QUALITY_SEMITONES = {
-    unison: { perfect: 0 },
-    second: { major: 2 },
-    third: { major: 4 },
-    fourth: { perfect: 5 },
-    fifth: { perfect: 7 },
-    sixth: { major: 9 },
-    seventh: { major: 11 },
-    octave: { perfect: 12 },
-    ninth: { major: 14 },
-    tenth: { major: 16 },
-    eleventh: { perfect: 17 },
-    twelfth: { perfect: 19 },
-    thirteenth: { major: 21 },
-    fourteenth: { major: 23 },
-    fifteenth: { perfect: 24 },
-    sixteenth: { major: 26 },
-    seventeenth: { major: 28 },
+    unison: {perfect: 0},
+    second: {major: 2},
+    third: {major: 4},
+    fourth: {perfect: 5},
+    fifth: {perfect: 7},
+    sixth: {major: 9},
+    seventh: {major: 11},
+    octave: {perfect: 12},
+    ninth: {major: 14},
+    tenth: {major: 16},
+    eleventh: {perfect: 17},
+    twelfth: {perfect: 19},
+    thirteenth: {major: 21},
+    fourteenth: {major: 23},
+    fifteenth: {perfect: 24},
+    sixteenth: {major: 26},
+    seventeenth: {major: 28}
   }.freeze
 
   QUALITY_ABBREVIATIONS = {
-    P: 'perfect',
-    M: 'major',
-    m: 'minor',
-    d: 'diminished',
-    A: 'augmented',
+    P: "perfect",
+    M: "major",
+    m: "minor",
+    d: "diminished",
+    A: "augmented"
   }.freeze
 
   attr_reader :lower_pitch, :higher_pitch
@@ -58,7 +58,7 @@ class HeadMusic::DiatonicInterval
     end
 
     def quality_name
-      words[0..-2].join(' ').to_sym
+      words[0..-2].join(" ").to_sym
     end
 
     def degree_name
@@ -75,8 +75,8 @@ class HeadMusic::DiatonicInterval
 
     def expand(identifier)
       if /[A-Z]\d{1,2}/i.match?(identifier)
-        number = NUMBER_NAMES[identifier.gsub(/[A-Z]/i, '').to_i - 1]
-        return [quality_for(identifier[0]), number].join('_').to_sym
+        number = NUMBER_NAMES[identifier.gsub(/[A-Z]/i, "").to_i - 1]
+        return [quality_for(identifier[0]), number].join("_").to_sym
       end
       identifier
     end
@@ -97,13 +97,11 @@ class HeadMusic::DiatonicInterval
     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
+      @degree_quality_semitones ||= {}.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
@@ -219,7 +217,7 @@ class HeadMusic::DiatonicInterval
     end
 
     def simple_name
-      [quality_name, simple_number_name].join(' ')
+      [quality_name, simple_number_name].join(" ")
     end
 
     def quality_name
@@ -239,8 +237,8 @@ class HeadMusic::DiatonicInterval
 
     def name
       if named_number?
-        [quality_name, number_name].join(' ')
-      elsif simple_name == 'perfect octave'
+        [quality_name, number_name].join(" ")
+      elsif simple_name == "perfect octave"
         "#{octaves.humanize} octaves"
       else
         "#{octaves.humanize} octaves and #{quality.article} #{simple_name}"
@@ -248,7 +246,7 @@ class HeadMusic::DiatonicInterval
     end
 
     def shorthand
-      step_shorthand = number == 1 ? 'U' : number
+      step_shorthand = (number == 1) ? "U" : number
       [quality.shorthand, step_shorthand].join
     end
 
@@ -281,7 +279,7 @@ class HeadMusic::DiatonicInterval
     to: :naming
   )
 
-  alias to_i semitones
+  alias_method :to_i, :semitones
 
   # Accepts a name and returns the interval with middle c on the bottom
   def self.get(identifier)
@@ -308,7 +306,7 @@ class HeadMusic::DiatonicInterval
     end
     HeadMusic::DiatonicInterval.new(higher_pitch, inverted_low_pitch)
   end
-  alias invert inversion
+  alias_method :invert, :inversion
 
   def consonance(style = :standard_practice)
     consonance_for_perfect(style) ||
@@ -319,7 +317,7 @@ class HeadMusic::DiatonicInterval
   def consonance?(style = :standard_practice)
     consonance(style).perfect? || consonance(style).imperfect?
   end
-  alias consonant? consonance?
+  alias_method :consonant?, :consonance?
 
   def perfect_consonance?(style = :standard_practice)
     consonance(style).perfect?
@@ -352,8 +350,8 @@ class HeadMusic::DiatonicInterval
   end
 
   # diatonic set theory
-  alias specific_interval simple_semitones
-  alias diatonic_generic_interval simple_steps
+  alias_method :specific_interval, :simple_semitones
+  alias_method :diatonic_generic_interval, :simple_steps
 
   def <=>(other)
     other = self.class.get(other) unless other.is_a?(HeadMusic::DiatonicInterval)
@@ -391,7 +389,7 @@ class HeadMusic::DiatonicInterval
   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

@@ -6,18 +6,18 @@ class HeadMusic::GrandStaff
     piano: {
       instrument: :piano,
       staves: [
-        { clef: :treble_clef, for: :right_hand },
-        { clef: :bass_clef, for: :left_hand },
-      ],
+        {clef: :treble_clef, for: :right_hand},
+        {clef: :bass_clef, for: :left_hand}
+      ]
     },
     organ: {
       instrument: :organ,
       staves: [
-        { clef: :treble_clef, for: :right_hand },
-        { clef: :bass_clef, for: :left_hand },
-        { clef: :bass_clef, for: :pedals },
-      ],
-    },
+        {clef: :treble_clef, for: :right_hand},
+        {clef: :bass_clef, for: :left_hand},
+        {clef: :bass_clef, for: :pedals}
+      ]
+    }
   }.freeze
 
   def self.get(name)