Module: Vcard

Defined in:
lib/vcard/bnf.rb,
lib/vcard.rb,
lib/vcard/field.rb,
lib/vcard/vcard.rb,
lib/vcard/errors.rb,
lib/vcard/dirinfo.rb,
lib/vcard/version.rb,
lib/vcard/attachment.rb,
lib/vcard/enumerator.rb

Overview

This library is free software; you can redistribute it and/or modify it under the same terms as the ruby language itself, see the file VPIM-LICENSE.txt for details.

Defined Under Namespace

Modules: Attachment, Bnf Classes: DirectoryInfo, Enumerator, InvalidEncodingError, Unencodeable, UnsupportedError, Vcard

Constant Summary collapse

VERSION = 
"0.2.6"

Class Method Summary collapse

Class Method Details

.array_datetime_to_time(dtarray) ⇒ Object

:nodoc:



93
94
95
96
97
98
99
 
# File 'lib/vcard.rb', line 93

def self.array_datetime_to_time(dtarray) #:nodoc:
# We get [year, month, day, hour, min, sec, usec, tz]
  tz = (dtarray.pop == "Z") ? :gm : :local
  Time.send(tz, *dtarray)
rescue ArgumentError => e
  raise ::Vcard::InvalidEncodingError, "#{tz} #{e} (#{dtarray.join(', ')})"
end

.decode(card) ⇒ Object

Unfold the lines in card, then return an array of one Field object per line.



228
229
230
 
# File 'lib/vcard.rb', line 228

def self.decode(card) #:nodoc:
  unfold(card).map { |line| DirectoryInfo::Field.decode(line) }
end

.decode_date(v) ⇒ Object

Convert a RFC 2425 date into an array of [year, month, day].

Raises:



57
58
59
60
 
# File 'lib/vcard.rb', line 57

def self.decode_date(v) # :nodoc:
  raise ::Vcard::InvalidEncodingError, "date not valid (#{v})" unless v =~ Bnf::DATE
  [$1.to_i, $2.to_i, $3.to_i]
end

.decode_date_list(v) ⇒ Object

Convert a RFC2425 date-list into an array of dates.



141
142
143
144
145
146
 
# File 'lib/vcard.rb', line 141

def self.decode_date_list(v) # :nodoc:
  decode_list(v) do |date|
    date.strip!
    decode_date(date) if date.length > 0
  end.compact
end

.decode_date_time(v) ⇒ Object

Convert a RFC 2425 date-time into an array of [year,mon,day,hour,min,sec,secfrac,timezone]

Raises:



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/vcard.rb', line 107

def self.decode_date_time(v) # :nodoc:
  raise ::Vcard::InvalidEncodingError, "date-time '#{v}' not valid" unless match = Bnf::DATE_TIME.match(v)
  year, month, day, hour, min, sec, secfrac, tz = match.to_a[1..8]

  [
    # date
    year.to_i, month.to_i, day.to_i,
    # time
    hour.to_i, min.to_i, sec.to_i, secfrac ? secfrac.to_f : 0, tz
  ]
end

.decode_date_time_list(v) ⇒ Object

Convert a RFC 2425 date-time-list into an array of date-times.



157
158
159
160
161
162
 
# File 'lib/vcard.rb', line 157

def self.decode_date_time_list(v) # :nodoc:
  decode_list(v) do |datetime|
    datetime.strip!
    decode_date_time(datetime) if datetime.length > 0
  end.compact
end

.decode_date_time_to_datetime(v) ⇒ Object

:nodoc:



119
120
121
122
123
 
# File 'lib/vcard.rb', line 119

def self.decode_date_time_to_datetime(v) #:nodoc:
  year, month, day, hour, min, sec = decode_date_time(v)
  # TODO - DateTime understands timezones, so we could decode tz and use it.
  DateTime.civil(year, month, day, hour, min, sec, 0)
end

.decode_date_to_date(v) ⇒ Object

Convert a RFC 2425 date into a Date object.



63
64
65
 
# File 'lib/vcard.rb', line 63

def self.decode_date_to_date(v)
  Date.new(*decode_date(v))
end

.decode_integer(v) ⇒ Object

Convert an RFC2425 INTEGER value into an Integer

Raises:



132
133
134
135
 
# File 'lib/vcard.rb', line 132

def self.decode_integer(v) # :nodoc:
  raise ::Vcard::InvalidEncodingError, "integer not valid (#{v})" unless v =~ Bnf::INTEGER
  v.to_i
end

.decode_list(value, sep = ",") ⇒ Object

Convert a sep-seperated list of values into an array of values.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vcard.rb', line 45

def self.decode_list(value, sep = ",") # :nodoc:
  list = []

  value.split(sep).each do |item|
    item.chomp!(sep)
    list << yield(item)
  end

  list
end

.decode_text(v) ⇒ Object

Convert RFC 2425 text into a String. \ -> \ n -> NL N -> NL , -> , ; -> ;

I’ve seen double-quote escaped by iCal.app. Hmm. Ok, if you aren’t supposed to escape anything but the above, everything else is ambiguous, so I’ll just support it.



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/vcard.rb', line 174

def self.decode_text(v) # :nodoc:
  # FIXME - I think this should trim leading and trailing space
  v.gsub(/\\(.)/) do
    case $1
    when "n", "N"
      "\n"
    else
      $1
    end
  end
end

.decode_text_list(value, sep = ",") ⇒ Object

Convert a sep-seperated list of TEXT values into an array of values.



198
199
200
201
202
203
 
# File 'lib/vcard.rb', line 198

def self.decode_text_list(value, sep = ",") # :nodoc:
  # Need to do in two stages, as best I can find.
  list = value.scan(/([^#{sep}\\]*(?:\\.[^#{sep}\\]*)*)#{sep}/).map { |v| decode_text(v.first) }
  list << $1 if value.match(/([^#{sep}\\]*(?:\\.[^#{sep}\\]*)*)$/)
  list
end

.decode_time(v) ⇒ Object

Convert a RFC 2425 time into an array of [hour,min,sec,secfrac,timezone]

Raises:



86
87
88
89
90
91
 
# File 'lib/vcard.rb', line 86

def self.decode_time(v) # :nodoc:
  raise ::Vcard::InvalidEncodingError, "time '#{v}' not valid" unless match = Bnf::TIME.match(v)
  hour, min, sec, secfrac, tz = match.to_a[1..5]

  [hour.to_i, min.to_i, sec.to_i, secfrac ? secfrac.to_f : 0, tz]
end

.decode_time_list(v) ⇒ Object

Convert a RFC 2425 time-list into an array of times.



149
150
151
152
153
154
 
# File 'lib/vcard.rb', line 149

def self.decode_time_list(v) # :nodoc:
  decode_list(v) do |time|
    time.strip!
    decode_time(time) if time.length > 0
  end.compact
end

.decode_time_to_time(v) ⇒ Object

Convert a RFC 2425 time into an array of Time objects.



102
103
104
 
# File 'lib/vcard.rb', line 102

def self.decode_time_to_time(v) # :nodoc:
  array_datetime_to_time(decode_date_time(v))
end

.encode_date(d) ⇒ Object

Encode a Date object as “yyyymmdd”.



71
72
73
 
# File 'lib/vcard.rb', line 71

def self.encode_date(d) # :nodoc:
   "%0.4d%0.2d%0.2d" % [d.year, d.mon, d.day]
end

.encode_date_time(d) ⇒ Object

Encode a Time or DateTime object as “yyyymmddThhmmss”



81
82
83
 
# File 'lib/vcard.rb', line 81

def self.encode_date_time(d) # :nodoc:
   "%0.4d%0.2d%0.2dT%0.2d%0.2d%0.2d" % [d.year, d.mon, d.day, d.hour, d.min, d.sec]
end

.encode_paramtext(value) ⇒ Object

param-value = paramtext / quoted-string paramtext = *SAFE-CHAR quoted-string = DQUOTE *QSAFE-CHAR DQUOTE



208
209
210
211
212
213
214
 
# File 'lib/vcard.rb', line 208

def self.encode_paramtext(value)
  if value =~ Bnf::ALL_SAFECHARS
    value
  else
    raise ::Vcard::Unencodable, "paramtext #{value.inspect}"
  end
end

.encode_paramvalue(value) ⇒ Object 



216
217
218
219
220
221
222
223
224
 
# File 'lib/vcard.rb', line 216

def self.encode_paramvalue(value)
  if value =~ Bnf::ALL_SAFECHARS
    value
  elsif value =~ Bnf::ALL_QSAFECHARS
    %Q{"#{value}"}
  else
    raise ::Vcard::Unencodable, "param-value #{value.inspect}"
  end
end

.encode_text(v) ⇒ Object

:nodoc:



186
187
188
 
# File 'lib/vcard.rb', line 186

def self.encode_text(v) #:nodoc:
  v.to_str.gsub(/[\\,;]/, '\\\\\0').gsub(/\r?\n/, "\\n")
end

.encode_text_list(v, sep = ",") ⇒ Object

v is an Array of String, or just a single String



191
192
193
194
195
 
# File 'lib/vcard.rb', line 191

def self.encode_text_list(v, sep = ",") #:nodoc:
  v.to_ary.map { |t| encode_text(t) }.join(sep)
rescue
  encode_text(v)
end

.encode_time(d) ⇒ Object

Encode a Date object as “yyyymmdd”.



76
77
78
 
# File 'lib/vcard.rb', line 76

def self.encode_time(d) # :nodoc:
   "%0.4d%0.2d%0.2d" % [d.year, d.mon, d.day]
end

.expand(src) ⇒ Object

Expand an array of fields into its syntactic entities. Each entity is a sequence of fields where the sequences is delimited by a BEGIN/END field. Since BEGIN/END delimited entities can be nested, we build a tree. Each entry in the array is either a Field or an array of entries (where each entry is either a Field, or an array of entries…).



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/vcard.rb', line 238

def self.expand(src) #:nodoc:
  # output array to expand the src to
  dst = []
  # stack used to track our nesting level, as we see begin/end we start a
  # new/finish the current entity, and push/pop that entity from the stack
  current = [dst]

  for f in src
    if f.name? "BEGIN"
      e = [f]

      current.last.push(e)
      current.push(e)
    elsif f.name? "END"
      current.last.push(f)

      unless current.last.first.value? current.last.last.value
        raise "BEGIN/END mismatch (#{current.last.first.value} != #{current.last.last.value})"
      end

      current.pop
    else
      current.last.push(f)
    end
  end

  dst
end

.outer_inner(fields) ⇒ Object

Split an array into an array of all the fields at the outer level, and an array of all the inner arrays of fields. Return the array [outer, inner].



270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/vcard.rb', line 270

def self.outer_inner(fields) #:nodoc:
  # TODO - use Enumerable#partition
  # seperate into the outer-level fields, and the arrays of component
  # fields
  outer = []
  inner = []
  fields.each do |line|
    case line
    when Array then inner << line
    else outer << line
    end
  end
  return outer, inner
end

.unfold(card) ⇒ Object

Split on rn or n to get the lines, unfold continued lines (they start with “ ” or t), and return the array of unfolded lines.

This also supports the (invalid) encoding convention of allowing empty lines to be inserted for readability - it does this by dropping zero-length lines.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/vcard.rb', line 26

def self.unfold(card) #:nodoc:
    unfolded = []

    card.lines do |line|
      line.chomp!
      # If it's a continuation line, add it to the last.
      # If it's an empty line, drop it from the input.
      if line =~ /^[ \t]/
        unfolded[-1] << line[1, line.size-1]
      elsif line =~ /^$/
      else
        unfolded << line
      end
    end

    unfolded
end