Class: IceCube::Rule

Inherits:
Object
  • Object
show all
Defined in:
lib/ice_cube/rule.rb

Direct Known Subclasses

SingleOccurrenceRule, ValidatedRule

Constant Summary collapse

INTERVAL_TYPES = 
[
  :secondly, :minutely, :hourly,
  :daily, :weekly, :monthly, :yearly
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#uses ⇒ Object (readonly)

Returns the value of attribute uses.



12
13
14
 
# File 'lib/ice_cube/rule.rb', line 12

def uses
  @uses
end

Class Method Details

.daily(interval = 1) ⇒ Object

Daily Rule



120
121
122
 
# File 'lib/ice_cube/rule.rb', line 120

def daily(interval = 1)
  DailyRule.new(interval)
end

.from_hash(original_hash) ⇒ Object

Convert from a hash and create a rule

Raises:

  • (ArgumentError) 


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ice_cube/rule.rb', line 74

def from_hash(original_hash)
  hash = IceCube::FlexibleHash.new original_hash
  return nil unless match = hash[:rule_type].match(/\:\:(.+?)Rule/)

  interval_type = match[1].downcase.to_sym
  raise ArgumentError, "Invalid rule frequency type: #{match[1]}" unless INTERVAL_TYPES.include?(interval_type)

  rule = IceCube::Rule.send(interval_type, hash[:interval] || 1)
  rule.interval(hash[:interval] || 1, TimeUtil.wday_to_sym(hash[:week_start] || 0)) if match[1] == "Weekly"
  rule.until(TimeUtil.deserialize_time(hash[:until])) if hash[:until]
  rule.count(hash[:count]) if hash[:count]
  hash[:validations] && hash[:validations].each do |name, args|
    apply_validation(rule, name, args)
  end
  rule
end

.from_ical(ical) ⇒ Object

Convert from ical string and create a rule



36
37
38
 
# File 'lib/ice_cube/rule.rb', line 36

def self.from_ical(ical)
  IceCube::IcalParser.rule_from_ical(ical)
end

.from_yaml(yaml) ⇒ Object

From yaml



46
47
48
 
# File 'lib/ice_cube/rule.rb', line 46

def self.from_yaml(yaml)
  from_hash YAML::load(yaml)
end

.hourly(interval = 1) ⇒ Object

Hourly Rule



115
116
117
 
# File 'lib/ice_cube/rule.rb', line 115

def hourly(interval = 1)
  HourlyRule.new(interval)
end

.minutely(interval = 1) ⇒ Object

Minutely Rule



110
111
112
 
# File 'lib/ice_cube/rule.rb', line 110

def minutely(interval = 1)
  MinutelyRule.new(interval)
end

.monthly(interval = 1) ⇒ Object

Monthly Rule



130
131
132
 
# File 'lib/ice_cube/rule.rb', line 130

def monthly(interval = 1)
  MonthlyRule.new(interval)
end

.secondly(interval = 1) ⇒ Object

Secondly Rule



105
106
107
 
# File 'lib/ice_cube/rule.rb', line 105

def secondly(interval = 1)
  SecondlyRule.new(interval)
end

.weekly(interval = 1, week_start = :sunday) ⇒ Object

Weekly Rule



125
126
127
 
# File 'lib/ice_cube/rule.rb', line 125

def weekly(interval = 1, week_start = :sunday)
  WeeklyRule.new(interval, week_start)
end

.yearly(interval = 1) ⇒ Object

Yearly Rule



135
136
137
 
# File 'lib/ice_cube/rule.rb', line 135

def yearly(interval = 1)
  YearlyRule.new(interval)
end

Instance Method Details

#==(rule) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/ice_cube/rule.rb', line 19

def ==(rule)
  if rule.is_a? Rule
    hash = to_hash
    hash && hash == rule.to_hash
  end
end

#full_required? ⇒ Boolean

Whether this rule requires a full run

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/ice_cube/rule.rb', line 67

def full_required?
  !@count.nil?
end

#hash ⇒ Object 



26
27
28
29
 
# File 'lib/ice_cube/rule.rb', line 26

def hash
  h = to_hash
  h.nil? ? super : h.hash
end

#next_time(time, schedule, closing_time) ⇒ Object 



59
60
 
# File 'lib/ice_cube/rule.rb', line 59

def next_time(time, schedule, closing_time)
end

#on?(time, schedule) ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/ice_cube/rule.rb', line 62

def on?(time, schedule)
  next_time(time, schedule, time).to_i == time.to_i
end

#reset ⇒ Object

Reset the uses on the rule to 0



55
56
57
 
# File 'lib/ice_cube/rule.rb', line 55

def reset
  @uses = 0
end

#terminating? ⇒ Boolean

Is this a terminating schedule?

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/ice_cube/rule.rb', line 15

def terminating?
  until_time || occurrence_count
end

#to_hash ⇒ Object

Raises:

  • (MethodNotImplemented) 


50
51
52
 
# File 'lib/ice_cube/rule.rb', line 50

def to_hash
  raise MethodNotImplemented, "Expected to be overridden by subclasses"
end

#to_ical ⇒ Object

Raises:

  • (MethodNotImplemented) 


31
32
33
 
# File 'lib/ice_cube/rule.rb', line 31

def to_ical
  raise MethodNotImplemented, "Expected to be overrridden by subclasses"
end

#to_yaml(*args) ⇒ Object

Yaml implementation



41
42
43
 
# File 'lib/ice_cube/rule.rb', line 41

def to_yaml(*args)
  YAML::dump(to_hash, *args)
end