Class: Vpim::DirectoryInfo::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/vpim/field.rb

Overview

A field in a directory info object.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(line) ⇒ Field

:nodoc:



173
174
175
176
177
178
179
180
181
 
# File 'lib/vpim/field.rb', line 173

def initialize(line) # :nodoc:
  @line = line.to_str
  @group, @name, @params, @value = Field.decode0(@line)

  @params.each do |pname,pvalues|
    pvalues.freeze
  end
  self
end

Class Method Details

.create(name, value = "", params = {}) ⇒ Object

Create a field with name name (a String), value value (see below), and optional parameters, params. params is a hash of the parameter name (a String) to either a single string or symbol, or an array of strings and symbols (parameters can be multi-valued).

If ‘ENCODING’ => :b64 is specified as a parameter, the value will be base-64 encoded. If it’s already base-64 encoded, then use String values (‘ENCODING’ => ‘B’), and no further encoding will be done by this routine.

Currently handled value types are:

  • Time, encoded as a date-time value

  • Date, encoded as a date value

  • String, encoded directly

  • Array of String, concatentated with ‘;’ between them.

TODO - need a way to encode String values as TEXT, at least optionally, so as to escape special chars, etc.



207
208
209
210
211
212
213
214
215
 
# File 'lib/vpim/field.rb', line 207

def Field.create(name, value="", params={})
  line = Field.encode0(nil, name, params, value)

  begin
    new(line)
  rescue Vpim::InvalidEncodingError => e
    raise ArgumentError, e.to_s
  end
end

.create_array(fields) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/vpim/field.rb', line 32

def Field.create_array(fields)
  case fields
    when Hash
      fields.map do |name,value|
        DirectoryInfo::Field.create( name, value )
      end
    else
      fields.to_ary
  end
end

.decode(line) ⇒ Object

Create a field by decoding line, a String which must already be unfolded. Decoded fields are frozen, but see #copy().



185
186
187
 
# File 'lib/vpim/field.rb', line 185

def Field.decode(line)
  new(line).freeze
end

.decode0(atline) ⇒ Object

Decode a field.



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
135
136
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
 
# File 'lib/vpim/field.rb', line 107

def Field.decode0(atline) # :nodoc:
  unless atline =~ %r{#{Bnf::LINE}}i
    raise Vpim::InvalidEncodingError, atline
  end

  atgroup = $1.upcase
  atname = $2.upcase
  paramslist = $3
  atvalue = $~[-1]

  # I've seen space that shouldn't be there, as in "BEGIN:VCARD ", so
  # strip it. I'm not absolutely sure this is allowed... it certainly
  # breaks round-trip encoding.
  atvalue.strip!

  if atgroup.length > 0
    atgroup.chomp!('.')
  else
    atgroup = nil
  end

  atparams = {}

  # Collect the params, if any.
  if paramslist.size > 1

    # v3.0 and v2.1 params
    paramslist.scan( %r{#{Bnf::PARAM}}i ) do

      # param names are case-insensitive, and multi-valued
      name = $1.upcase
      params = $3

      # v2.1 params have no '=' sign, figure out what kind of param it
      # is (either its a known encoding, or we treat it as a 'TYPE'
      # param).
     
      if $2 == ""
        params = $1
        case $1
          when /quoted-printable/i
            name = 'ENCODING'

          when /base64/i
            name = 'ENCODING'

          else
            name = 'TYPE'
        end
      end

      # TODO - In ruby1.8 I can give an initial value to the atparams
      # hash values instead of this.
      unless atparams.key? name
        atparams[name] = []
      end

      params.scan( %r{#{Bnf::PVALUE}} ) do
        atparams[name] << ($1 || $2)
      end
    end
  end

  [ atgroup, atname, atparams, atvalue ]
end

.encode0(group, name, params = {}, value = '') ⇒ Object

Encode a field.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/vpim/field.rb', line 44

def Field.encode0(group, name, params={}, value='') # :nodoc:
  line = ""

  # A reminder of the line format:
  #   [<group>.]<name>;<pname>=<pvalue>,<pvalue>:<value>

  if group
    line << group << '.'
  end
  
  line << name

  params.each do |pname, pvalues|

    unless pvalues.respond_to? :to_ary
      pvalues = [ pvalues ]
    end

    line << ';' << pname << '='

    sep = "" # set to ',' after one pvalue has been appended

    pvalues.each do |pvalue|
      # check if we need to do any encoding
      if Vpim::Methods.casecmp?(pname, 'ENCODING') && pvalue == :b64
        pvalue = 'B' # the RFC definition of the base64 param value
        value = [ value.to_str ].pack('m').gsub("\n", '')
      end

      line << sep << pvalue
      sep =",";
    end
  end

  line << ':'

  line << Field.value_str(value)

  line
end

.value_str(value) ⇒ Object

:nodoc:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/vpim/field.rb', line 85

def Field.value_str(value) # :nodoc:
  line = ''
  case value
    when Date
      line << Vpim.encode_date(value)

    when Time #, DateTime
      line << Vpim.encode_date_time(value)

    when Array
      line << value.map { |v| Field.value_str(v) }.join(';')

    when Symbol
      line << value

    else
      line << value.to_str
  end
  line
end

Instance Method Details

#[]=(pname, pvalue) ⇒ Object

Set a the param pname‘s value to pvalue, replacing any value it currently has. See Field.create() for a description of pvalue.

Example:

if field['TYPE']
  field['TYPE'] << 'HOME'
else
  field['TYPE'] = [ 'HOME' ]
end

TODO - this could be an alias to #pvalue_set



529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/vpim/field.rb', line 529

def []=(pname,pvalue)
  unless pvalue.respond_to?(:to_ary)
    pvalue = [ pvalue ]
  end

  h = @params.dup

  h[pname.upcase] = pvalue

  mutate(@group, @name, h, @value)
  pvalue
end

#copy ⇒ Object

Create a copy of Field. If the original Field was frozen, this one won’t be.



219
220
221
 
# File 'lib/vpim/field.rb', line 219

def copy
  Marshal.load(Marshal.dump(self))
end

#each_param(&block) ⇒ Object

Yield once for each param, name is the parameter name, value is an array of the parameter values.



292
293
294
295
296
 
# File 'lib/vpim/field.rb', line 292

def each_param(&block) #:yield: name, value
  if @params
    @params.each(&block)
  end
end

#encode(width = nil) ⇒ Object Also known as: to_s

The String encoding of the Field. The String will be wrapped to a maximum line width of width, where 0 means no wrapping, and nil is to accept the default wrapping (75, recommended by RFC2425).

Note: AddressBook.app 3.0.3 neither understands to unwrap lines when it imports vCards (it treats them as raw new-line characters), nor wraps long lines on export. This is mostly a cosmetic problem, but wrapping can be disabled by setting width to 0, if desired.

FIXME - breaks round-trip encoding, need to change this to not wrap fields that are already wrapped.



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/vpim/field.rb', line 234

def encode(width=nil)
  width = 75 unless width
  l = @line
  # Wrap to width, unless width is zero.
  if width > 0
    l = l.gsub(/.{#{width},#{width}}/) { |m| m + "\n " }
  end
  # Make sure it's terminated with no more than a single NL.
  l.gsub(/\s*\z/, '') + "\n"
end

#encoding ⇒ Object

The value of the ENCODING parameter, if present, or nil if not present.



397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/vpim/field.rb', line 397

def encoding
  e = param('ENCODING')

  if e
    if e.length > 1
      raise Vpim::InvalidEncodingError, "multi-valued param 'ENCODING' (#{e})"
    end
    e = e.first.upcase
  end
  e
end

#group ⇒ Object

The group, if present, or nil if not present.



253
254
255
 
# File 'lib/vpim/field.rb', line 253

def group
  @group
end

#group=(group) ⇒ Object

Set the group of this field to group.



500
501
502
503
 
# File 'lib/vpim/field.rb', line 500

def group=(group)
  mutate(group, @name, @params, @value)
  group
end

#group?(group) ⇒ Boolean

Is the #group of this field group? Group names are case insensitive. A group of nil matches if the field has no group.

Returns:

  • (Boolean) 


333
334
335
 
# File 'lib/vpim/field.rb', line 333

def group?(group)
  Vpim::Methods.casecmp?(@group, group)
end

#kind ⇒ Object

The type of the value, as specified by the VALUE parameter, nil if unspecified.



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/vpim/field.rb', line 411

def kind
  v = param('VALUE')
  if v
    if v.size > 1
      raise InvalidEncodingError, "multi-valued param 'VALUE' (#{values})"
    end
    v = v.first.downcase
  end
  v
end

#kind?(kind) ⇒ Boolean

Is the value of this field of type kind? RFC2425 allows the type of a fields value to be encoded in the VALUE parameter. Don’t rely on its presence, they aren’t required, and usually aren’t bothered with. In cases where the kind of value might vary (an iCalendar DTSTART can be either a date or a date-time, for example), you are more likely to see the kind of value specified explicitly.

The value types defined by RFC 2425 are:

  • uri:

  • text:

  • date: a list of 1 or more dates

  • time: a list of 1 or more times

  • date-time: a list of 1 or more date-times

  • integer:

  • boolean:

  • float:

Returns:

  • (Boolean) 


353
354
355
 
# File 'lib/vpim/field.rb', line 353

def kind?(kind)
  Vpim::Methods.casecmp?(self.kind == kind)
end

#name ⇒ Object

The name.



248
249
250
 
# File 'lib/vpim/field.rb', line 248

def name
  @name
end

#name?(name) ⇒ Boolean

Is the #name of this Field name? Names are case insensitive.

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/vpim/field.rb', line 327

def name?(name)
  Vpim::Methods.casecmp?(@name, name)
end

#pnames ⇒ Object Also known as: params

An Array of all the param names.



258
259
260
 
# File 'lib/vpim/field.rb', line 258

def pnames
  @params.keys
end

#pref=(ispref) ⇒ Object

Set whether a field is marked as preferred. See #pref?



381
382
383
384
385
386
387
 
# File 'lib/vpim/field.rb', line 381

def pref=(ispref)
  if ispref
    pvalue_iadd('TYPE', 'PREF')
  else
    pvalue_idel('TYPE', 'PREF')
  end
end

#pref? ⇒ Boolean

Is this field marked as preferred? A vCard field is preferred if #type?(‘PREF’). This method is not necessarily meaningful for non-vCard profiles.

Returns:

  • (Boolean) 


376
377
378
 
# File 'lib/vpim/field.rb', line 376

def pref?
  type? 'PREF'
end

#pvalue(name) ⇒ Object

The first value of the param name, nil if there is no such param, the param has no value, or the first param value is zero-length.



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/vpim/field.rb', line 267

def pvalue(name)
  v = pvalues( name )
  if v
    v = v.first
  end
  if v
    v = nil unless v.length > 0
  end
  v
end

#pvalue_iadd(pname, pvalue) ⇒ Object

Add pvalue to the param pname‘s value. The values are treated as a set so duplicate values won’t occur, and String values are case insensitive. See Field.create() for a description of pvalue.



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/vpim/field.rb', line 545

def pvalue_iadd(pname, pvalue)
  pname = pname.upcase

  # Get a uniq set, where strings are compared case-insensitively.
  values = [ pvalue, @params[pname] ].flatten.compact
  values = values.collect do |v|
    if v.respond_to? :to_str
      v = v.to_str.upcase
    end
    v
  end
  values.uniq!

  h = @params.dup

  h[pname] = values

  mutate(@group, @name, h, @value)
  values
end

#pvalue_idel(pname, pvalue) ⇒ Object

Delete pvalue from the param pname‘s value. The values are treated as a set so duplicate values won’t occur, and String values are case insensitive. pvalue must be a single String or Symbol.



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/vpim/field.rb', line 569

def pvalue_idel(pname, pvalue)
  pname = pname.upcase
  if pvalue.respond_to? :to_str
    pvalue = pvalue.to_str.downcase
  end

  # Get a uniq set, where strings are compared case-insensitively.
  values = [ nil, @params[pname] ].flatten.compact
  values = values.collect do |v|
    if v.respond_to? :to_str
      v = v.to_str.downcase
    end
    v
  end
  values.uniq!
  values.delete pvalue

  h = @params.dup

  h[pname] = values

  mutate(@group, @name, h, @value)
  values
end

#pvalues(name) ⇒ Object Also known as: param, []

The Array of all values of the param name, nil if there is no such param, [] if the param has no values. If the Field isn’t frozen, the Array is mutable.



281
282
283
 
# File 'lib/vpim/field.rb', line 281

def pvalues(name)
  @params[name.upcase]
end

#text=(text) ⇒ Object

Convert value to text, then assign.

TODO - unimplemented



515
516
 
# File 'lib/vpim/field.rb', line 515

def text=(text)
end

#to_date ⇒ Object

The value as an array of Date objects (all times and dates in RFC2425 are lists, even where it might not make sense, such as a birthday).

The field value may be a list of either DATE or DATE-TIME values, decoding is tried first as a DATE-TIME, then as a DATE, if neither works an InvalidEncodingError will be raised.



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/vpim/field.rb', line 467

def to_date
  begin
    Vpim.decode_date_time_list(value).collect do |d|
      # We get [ year, month, day, hour, min, sec, usec, tz ]
      Date.new(d[0], d[1], d[2])
    end
  rescue Vpim::InvalidEncodingError
    Vpim.decode_date_list(value).collect do |d|
      # We get [ year, month, day ]
      Date.new(*d)
    end
  end
end

#to_text ⇒ Object

The value as text. Text can have escaped newlines, commas, and escape characters, this method will strip them, if present.

In theory, #value could also do this, but it would need to know that the value is of type ‘TEXT’, and often for text values the ‘VALUE’ parameter is not present, so knowledge of the expected type of the field is required from the decoder.



488
489
490
 
# File 'lib/vpim/field.rb', line 488

def to_text
  Vpim.decode_text(value)
end

#to_time ⇒ Object

The value as an array of Time objects (all times and dates in RFC2425 are lists, even where it might not make sense, such as a birthday). The time will be UTC if marked as so (with a timezone of “Z”), and in localtime otherwise.

TODO - support timezone offsets

TODO - if year is before 1970, this won’t work… but some people are generating calendars saying Canada Day started in 1753! That’s just wrong! So, what to do? I add a message saying what the year is that breaks, so they at least know that its ridiculous! I think I need my own DateTime variant.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/vpim/field.rb', line 434

def to_time
  begin
    Vpim.decode_date_time_list(value).collect do |d|
      # We get [ year, month, day, hour, min, sec, usec, tz ]
      begin
        if(d.pop == "Z")
          Time.gm(*d)
        else
          Time.local(*d)
        end
      rescue ArgumentError => e
        raise Vpim::InvalidEncodingError, "Time.gm(#{d.join(', ')}) failed with #{e.message}"
      end
    end
  rescue Vpim::InvalidEncodingError
    Vpim.decode_date_list(value).collect do |d|
      # We get [ year, month, day ]
      begin
        Time.gm(*d)
      rescue ArgumentError => e
        raise Vpim::InvalidEncodingError, "Time.gm(#{d.join(', ')}) failed with #{e.message}"
      end
    end
  end
end

#type?(type) ⇒ Boolean

Is one of the values of the TYPE parameter of this field type? The type parameter values are case insensitive. False if there is no TYPE parameter.

TYPE parameters are used for general categories, such as distinguishing between an email address used at home or at work.

Returns:

  • (Boolean) 


363
364
365
366
367
368
369
370
371
 
# File 'lib/vpim/field.rb', line 363

def type?(type)
  type = type.to_str

  types = param('TYPE')

  if types
    types = types.detect { |t| Vpim::Methods.casecmp?(t, type) }
  end
end

#value ⇒ Object

The decoded value.

The encoding specified by the #encoding, if any, is stripped.

Note: Both the RFC 2425 encoding param (“b”, meaning base-64) and the vCard 2.1 encoding params (“base64”, “quoted-printable”, “8bit”, and “7bit”) are supported.

FIXME:

  • should use the VALUE parameter

  • should also take a default value type, so it can be converted if VALUE parameter is not present.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/vpim/field.rb', line 310

def value
  case encoding
    when nil, '8BIT', '7BIT' then @value

    # Hack - if the base64 lines started with 2 SPC chars, which is invalid,
    # there will be extra spaces in @value. Since no SPC chars show up in
    # b64 encodings, they can be safely stripped out before unpacking.
    when 'B', 'BASE64'       then @value.gsub(' ', '').unpack('m*').first

    when 'QUOTED-PRINTABLE'  then @value.unpack('M*').first

    else
      raise Vpim::InvalidEncodingError, "unrecognized encoding (#{encoding})"
  end
end

#value=(value) ⇒ Object

Set the value of this field to value. Valid values are as in Field.create().



507
508
509
510
 
# File 'lib/vpim/field.rb', line 507

def value=(value)
  mutate(@group, @name, @params, value)
  value
end

#value?(value) ⇒ Boolean

Is the value of this field value? The check is case insensitive. FIXME - it shouldn’t be insensitive, make a #casevalue? method.

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/vpim/field.rb', line 391

def value?(value)
   Vpim::Methods.casecmp?(@value, value.to_str)
end

#value_raw ⇒ Object

The undecoded value, see value.



493
494
495
 
# File 'lib/vpim/field.rb', line 493

def value_raw
  @value
end