Class: HeadMusic::Rudiment::RhythmicValue

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/head_music/rudiment/rhythmic_value.rb

Overview

A rhythmic value is a duration composed of a rhythmic unit, any number of dots, and a tied value.

Defined Under Namespace

Classes: Parser

Constant Summary collapse

RhythmicUnit = 
HeadMusic::Rudiment::RhythmicUnit

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(unit, dots: nil, tied_value: nil) ⇒ RhythmicValue

Returns a new instance of RhythmicValue.



59
60
61
62
63
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 59

def initialize(unit, dots: nil, tied_value: nil)
  @unit = HeadMusic::Rudiment::RhythmicUnit.get(unit)
  @dots = [0, 1, 2, 3].include?(dots) ? dots : 0
  @tied_value = tied_value
end

Instance Attribute Details

#dots ⇒ Object (readonly)

Returns the value of attribute dots.



10
11
12
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 10

def dots
  @dots
end

#tied_value ⇒ Object (readonly)

Returns the value of attribute tied_value.



10
11
12
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 10

def tied_value
  @tied_value
end

#unit ⇒ Object (readonly)

Returns the value of attribute unit.



10
11
12
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 10

def unit
  @unit
end

Class Method Details

.dots_from_words(identifier) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 45

def self.dots_from_words(identifier)
  return 0 unless identifier.match?(/dotted/)

  modifier, = identifier.split(/_*dotted_*/)
  case modifier
  when /tripl\w/
    3
  when /doubl\w/
    2
  else
    1
  end
end

.from_words(identifier) ⇒ Object 



37
38
39
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 37

def self.from_words(identifier)
  new(unit_from_words(identifier), dots: dots_from_words(identifier))
end

.get(identifier) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 15

def self.get(identifier)
  case identifier
  when HeadMusic::Rudiment::RhythmicValue
    identifier
  when HeadMusic::Rudiment::RhythmicUnit
    new(identifier)
  when Symbol, String
    original_identifier = identifier.to_s.strip
    # First try the new parser which handles all formats
    parsed = Parser.parse(original_identifier)
    return parsed if parsed

    # Then try the word-based approach as fallback
    identifier = original_identifier.downcase.gsub(/\W+/, "_")
    begin
      from_words(identifier)
    rescue
      nil
    end
  end
end

.unit_from_words(identifier) ⇒ Object 



41
42
43
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 41

def self.unit_from_words(identifier)
  identifier.gsub(/^\w*dotted_/, "")
end

Instance Method Details

#<=>(other) ⇒ Object 



120
121
122
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 120

def <=>(other)
  total_value <=> other.total_value
end

#==(other) ⇒ Object 



112
113
114
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 112

def ==(other)
  to_s == other.to_s
end

#multiplier ⇒ Object 



77
78
79
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 77

def multiplier
  (0..dots).reduce(0) { |sum, i| sum + 0.5**i }
end

#name ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 104

def name
  if tied_value
    [single_value_name, tied_value.name].compact.join(" tied to ")
  else
    single_value_name
  end
end

#name_modifier_prefix ⇒ Object 



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 89

def name_modifier_prefix
  case dots
  when 1
    "dotted"
  when 2
    "double-dotted"
  when 3
    "triple-dotted"
  end
end

#per_whole ⇒ Object 



85
86
87
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 85

def per_whole
  1.0 / relative_value
end

#relative_value ⇒ Object 



69
70
71
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 69

def relative_value
  unit_value * multiplier
end

#single_value_name ⇒ Object 



100
101
102
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 100

def single_value_name
  [name_modifier_prefix, unit_name].compact.join(" ")
end

#ticks ⇒ Object 



81
82
83
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 81

def ticks
  HeadMusic::Rudiment::Rhythm::PPQN * 4 * total_value
end

#to_s ⇒ Object 



116
117
118
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 116

def to_s
  name.tr("_", "-")
end

#total_value ⇒ Object 



73
74
75
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 73

def total_value
  relative_value + (tied_value ? tied_value.total_value : 0)
end

#unit_value ⇒ Object 



65
66
67
 
# File 'lib/head_music/rudiment/rhythmic_value.rb', line 65

def unit_value
  unit.relative_value
end