Class: SOF::Cycles::VolumeOnly

Inherits:
SOF::Cycle show all
Defined in:
lib/sof/cycles/volume_only.rb

Constant Summary

Constants inherited from SOF::Cycle

SOF::Cycle::VERSION

Instance Attribute Summary

Attributes inherited from SOF::Cycle

#parser

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SOF::Cycle

#==, #as_json, class_for_kind, class_for_notation_id, #considered_dates, dormant_capable?, #dormant_capable?, dump, #expiration_of, #extend_period, #final_date, for, #from_data, handles, #humanized_span, #initialize, #kind_inquiry, #last_completed, legend, load, notation, #notation, #range, register, registry, #reset_by, #satisfied_by?, #to_h, unregister, #validate_period, volume_only?, #volume_to_delay_expiration

Constructor Details

This class inherits a constructor from SOF::Cycle

Class Method Details

.handles?(sym) ⇒ Boolean

Returns:

  • (Boolean) 


9
 
# File 'lib/sof/cycles/volume_only.rb', line 9

def handles?(sym) = sym.nil? || sym.to_s == "volume_only"

.recurring? ⇒ Boolean

Returns:

  • (Boolean) 


19
 
# File 'lib/sof/cycles/volume_only.rb', line 19

def self.recurring? = false

.validate_period(period) ⇒ Object

Raises:



11
12
13
14
15
16
 
# File 'lib/sof/cycles/volume_only.rb', line 11

def validate_period(period)
  raise Cycle::InvalidPeriod, <<~ERR.squish unless period.nil?
    Invalid period value of '#{period}' provided. Valid periods are:
    #{valid_periods.join(", ")}
  ERR
end

Instance Method Details

#cover? ⇒ Boolean

Returns:

  • (Boolean) 


25
 
# File 'lib/sof/cycles/volume_only.rb', line 25

def cover?(...) = true

#covered_dates(dates) ⇒ Object 



23
 
# File 'lib/sof/cycles/volume_only.rb', line 23

def covered_dates(dates, ...) = dates

#to_s ⇒ Object 



21
 
# File 'lib/sof/cycles/volume_only.rb', line 21

def to_s = "#{volume}x total"