Class: GCal4Ruby::Recurrence

Inherits:
Object
  • Object
show all
Defined in:
lib/gcal4ruby/recurrence.rb

Overview

The Recurrence class stores information on an Event’s recurrence. The class implements the RFC 2445 iCalendar recurrence description.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(vars = {}) ⇒ Recurrence

Accepts an optional attributes hash or a string containing a properly formatted ISO 8601 recurrence rule. Returns a new Recurrence object



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/gcal4ruby/recurrence.rb', line 49

def initialize(vars = {})
  if vars.is_a? Hash
    vars.each do |key, value|
      self.send("#{key}=", value)
    end
  elsif vars.is_a? String
    self.load(vars)
  end
  @all_day ||= false
end

Instance Attribute Details

#all_day ⇒ Object

True if the event is all day (i.e. no start/end time)



46
47
48
 
# File 'lib/gcal4ruby/recurrence.rb', line 46

def all_day
  @all_day
end

#end_time ⇒ Object

The event end date/time



38
39
40
 
# File 'lib/gcal4ruby/recurrence.rb', line 38

def end_time
  @end_time
end

#event ⇒ Object

the event reference



40
41
42
 
# File 'lib/gcal4ruby/recurrence.rb', line 40

def event
  @event
end

#frequency ⇒ Object

The event frequency



44
45
46
 
# File 'lib/gcal4ruby/recurrence.rb', line 44

def frequency
  @frequency
end

#repeat_until ⇒ Object

The date until which the event will be repeated



42
43
44
 
# File 'lib/gcal4ruby/recurrence.rb', line 42

def repeat_until
  @repeat_until
end

#start_time ⇒ Object

The event start date/time



36
37
38
 
# File 'lib/gcal4ruby/recurrence.rb', line 36

def start_time
  @start_time
end

Instance Method Details

#load(rec) ⇒ Object

Accepts a string containing a properly formatted ISO 8601 recurrence rule and loads it into the recurrence object.

Contributed by John Paul Narowski.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/gcal4ruby/recurrence.rb', line 62

def load(rec)
  @frequency = {}
  attrs = rec.split("\n")
  attrs.each do |val|
    key, value = val.split(":")
    if key == 'RRULE'
      value.split(";").each do |rr| 
        rr_key, rr_value = rr.split("=")
        rr_key = rr_key.downcase.to_sym
        unless @frequency.has_key?(rr_key)
          if rr_key == :until
            @repeat_until = Time.parse_complete(rr_value)
          else
            @frequency[rr_key] = rr_value 
          end
        end
      end
    elsif key == 'INTERVAL'
      @frequency[:inverval] = value.to_i
    elsif key.include?("DTSTART;TZID") or key.include?("DTSTART") or key.include?('DTSTART;VALUE=DATE-TIME')
      @start_time = Time.parse_complete(value)
    elsif key.include?('DTSTART;VALUE=DATE')
      @start_time = Time.parse(value)
      @all_day = true
    elsif key.include?("DTEND;TZID") or key.include?("DTEND") or key.include?('DTEND;VALUE=DATE-TIME')
      @end_time = Time.parse_complete(value)
    elsif key.include?('DTEND;VALUE=DATE')
      @end_time = Time.parse(value)
    end
  end
end

#to_recurrence_string ⇒ Object

Returns a string with the correctly formatted ISO 8601 recurrence rule



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/gcal4ruby/recurrence.rb', line 137

def to_recurrence_string
  output = ''
  if @all_day
    output += "DTSTART;VALUE=DATE:#{@start_time.utc.strftime("%Y%m%d")}\n"
  else
    output += "DTSTART;VALUE=DATE-TIME:#{@start_time.complete}\n"
  end
  if @all_day
    output += "DTEND;VALUE=DATE:#{@end_time.utc.strftime("%Y%m%d")}\n"
  else
    output += "DTEND;VALUE=DATE-TIME:#{@end_time.complete}\n"
  end
  output += "RRULE:"
  if @frequency
    f = 'FREQ='
    i = ''
    by = ''
    @frequency.each do |key, v|
      if v.is_a?(Array) 
        if v.size > 0
          value = v.join(",") 
        else
          value = nil
        end
      else
        value = v
      end
      f += "#{key.to_s.upcase};" if key != 'interval'
      case key.to_s.downcase
        when "secondly"
        by += "BYSECOND=#{value};"
        when "minutely"
        by += "BYMINUTE=#{value};"
        when "hourly"
        by += "BYHOUR=#{value};"
        when "weekly"
        by += "BYDAY=#{value};" if value
        when "monthly"
        by += "BYDAY=#{value};"
        when "yearly"
        by += "BYYEARDAY=#{value};"
        when 'interval'
        i += "INTERVAL=#{value};"
      end
    end
    output += f+i+by
  end      
  if @repeat_until
    output += "UNTIL=#{@repeat_until.strftime("%Y%m%d")}"
  end
  
  output += "\n"
end

#to_s ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/gcal4ruby/recurrence.rb', line 94

def to_s
  output = ''
  if @frequency
    f = ''
    i = ''
    by = ''
    @frequency.each do |key, v|
      if v.is_a?(Array) 
        if v.size > 0
          value = v.join(",") 
        else
          value = nil
        end
      else
        value = v
      end
      f += "#{key.downcase} " if key != 'interval'
      case key.downcase
        when "secondly"
        by += "every #{value} second"
        when "minutely"
        by += "every #{value} minute"
        when "hourly"
        by += "every #{value} hour"
        when "weekly"
        by += "on #{value}" if value
        when "monthly"
        by += "on #{value}"
        when "yearly"
        by += "on the #{value} day of the year"
        when 'interval'
        i += "for #{value} times"
      end
    end
    output += f+i+by
  end      
  if @repeat_until
    output += " and repeats until #{@repeat_until.strftime("%m/%d/%Y")}"
  end
  output
end