Class: HeadMusic::Style::Guidelines::SingableRange

Inherits:
HeadMusic::Style::Guideline show all
Defined in:
lib/head_music/style/guidelines/singable_range.rb

Overview

A voice shouldn’t expend the range of a 10th. Configurable via the maximum_range: option (a diatonic interval number).

Constant Summary collapse

MAXIMUM_RANGE = 
10

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from HeadMusic::Style::Guideline

Class Method Details

.template_values(config) ⇒ Object

Keyed by the interval rather than assembled, because “a” or “an” is a fact about the word that follows it and no template can compute that. Each locale writes whatever its grammar needs.



16
17
18
19
 
# File 'lib/head_music/style/guidelines/singable_range.rb', line 16

def self.template_values(config)
  range = config.fetch(:maximum_range) { self::MAXIMUM_RANGE }
  {range: HeadMusic::Style::Template.render("ranges.#{range}")}
end

Instance Method Details

#extremes ⇒ Object (private) 



31
32
33
 
# File 'lib/head_music/style/guidelines/singable_range.rb', line 31

def extremes
  (highest_notes + lowest_notes).sort
end

#marks ⇒ Object 



9
10
11
 
# File 'lib/head_music/style/guidelines/singable_range.rb', line 9

def marks
  HeadMusic::Style::Mark.for_each(extremes, fitness: HeadMusic::PENALTY_FACTOR**overage) if overage.positive?
end

#maximum_range ⇒ Object (private) 



23
24
25
 
# File 'lib/head_music/style/guidelines/singable_range.rb', line 23

def maximum_range
  options.fetch(:maximum_range) { self.class::MAXIMUM_RANGE }
end

#overage ⇒ Object (private) 



27
28
29
 
# File 'lib/head_music/style/guidelines/singable_range.rb', line 27

def overage
  notes.any? ? [range.number - maximum_range, 0].max : 0
end