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



133
134
135
 
# File 'lib/ice_cube/rule.rb', line 133

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

.from_hash(original_hash) ⇒ Object

Convert from a hash and create a rule



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ice_cube/rule.rb', line 71

def from_hash(original_hash)
  hash = IceCube::FlexibleHash.new original_hash

  unless hash[:rule_type] && match = hash[:rule_type].match(/\:\:(.+?)Rule/)
    raise ArgumentError, 'Invalid rule type'
  end

  interval_type = match[1].downcase.to_sym

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

  rule = IceCube::Rule.send(interval_type, hash[:interval] || 1)

  if match[1] == "Weekly"
    rule.interval(hash[:interval] || 1, TimeUtil.wday_to_sym(hash[:week_start] || 0))
  end

  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



38
39
40
 
# File 'lib/ice_cube/rule.rb', line 38

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

.from_yaml(yaml) ⇒ Object

From yaml



48
49
50
 
# File 'lib/ice_cube/rule.rb', line 48

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

.hourly(interval = 1) ⇒ Object

Hourly Rule



128
129
130
 
# File 'lib/ice_cube/rule.rb', line 128

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

.minutely(interval = 1) ⇒ Object

Minutely Rule



123
124
125
 
# File 'lib/ice_cube/rule.rb', line 123

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

.monthly(interval = 1) ⇒ Object

Monthly Rule



143
144
145
 
# File 'lib/ice_cube/rule.rb', line 143

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

.secondly(interval = 1) ⇒ Object

Secondly Rule



118
119
120
 
# File 'lib/ice_cube/rule.rb', line 118

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

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

Weekly Rule



138
139
140
 
# File 'lib/ice_cube/rule.rb', line 138

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

.yearly(interval = 1) ⇒ Object

Yearly Rule



148
149
150
 
# File 'lib/ice_cube/rule.rb', line 148

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

Instance Method Details

#==(rule) ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/ice_cube/rule.rb', line 22

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) 


64
65
66
 
# File 'lib/ice_cube/rule.rb', line 64

def full_required?
  !@count.nil?
end

#hash ⇒ Object 



29
30
31
 
# File 'lib/ice_cube/rule.rb', line 29

def hash
  to_hash.hash
end

#next_time(time, schedule, closing_time) ⇒ Object 



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

def next_time(time, schedule, closing_time)
end

#on?(time, schedule) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#reset ⇒ Object 



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

def reset
end

#terminating? ⇒ Boolean

Is this a terminating schedule?

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/ice_cube/rule.rb', line 18

def terminating?
  until_time || occurrence_count
end

#to_hash ⇒ Object

Raises:

  • (MethodNotImplemented) 


52
53
54
 
# File 'lib/ice_cube/rule.rb', line 52

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

#to_ical ⇒ Object

Raises:

  • (MethodNotImplemented) 


33
34
35
 
# File 'lib/ice_cube/rule.rb', line 33

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

#to_yaml(*args) ⇒ Object

Yaml implementation



43
44
45
 
# File 'lib/ice_cube/rule.rb', line 43

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