Class: Virginity::Org

Inherits:
BaseField show all
Defined in:
lib/virginity/vcard/fields.rb,
lib/virginity/api_extensions/fields_to_xml.rb

Overview

handle ORG fields.

An Org has an orgname, a unit1 and a unit2. We stick to this simple definition for now since it is widely used. The vCard specs seem to specify an unlimited amount of units

Constant Summary

Constants inherited from BaseField

BaseField::BEGIN_REGEX, BaseField::END_REGEX, BaseField::PREF, BaseField::TYPE

Constants included from FieldCleaning

FieldCleaning::BOM_BINARY, FieldCleaning::BOM_UTF8, FieldCleaning::CASE_SENSITIVE_TYPES, FieldCleaning::CHARSET, FieldCleaning::ENCODING, FieldCleaning::LIST_NAMES, FieldCleaning::QUOTED_PRINTABLE, FieldCleaning::TYPE, FieldCleaning::X_SYNTHESIS_REF

Constants inherited from ContentLine

ContentLine::COLON_CHAR, ContentLine::GROUP, ContentLine::GROUP_DELIMITER, ContentLine::NAME

Instance Attribute Summary

Attributes inherited from ContentLine

#group, #name, #params, #value

Instance Method Summary collapse

Methods inherited from BaseField

#<=>, #==, [], #extra_fields_to_xml, #field_as_json, field_register, #group_and_params_as_json, merger, named, #params_to_xml, #params_to_xml!, parse, #pref?, #raw_value=, register_field, register_for, registered?, types, unregister, #value, #value=, #value_to_xml

Methods included from FieldCleaning

#clean!, #clean_base64!, #clean_binary_data!, #clean_charsets!, #clean_quoted_printable_encoding!, #clean_types!, #guess_latin!, #remove_bom!, #remove_encoding_8bit!, #remove_x_synthesis_ref_params!, #uniq_params!

Methods included from Vcard21::Writer

#encode21, #vcard21line

Methods inherited from ContentLine

#<=>, #==, #api_id, #encode, #eql?, #has_name?, #hash, #initialize, line_parts, #merge_with!, merger, #param_values, #params_to_s, parse, #pretty_print, #to_field

Methods included from Encodings

#binary?, #to_ascii, #to_binary, #to_default, #to_default!, #verify_utf8ness

Constructor Details

This class inherits a constructor from Virginity::ContentLine

Instance Method Details

#shortened ⇒ Object 



136
137
138
 
# File 'lib/virginity/vcard/fields.rb', line 136

def shortened
  [orgname, unit1, unit2].join(" ").strip
end

#to_xml(options = {}) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/virginity/api_extensions/fields_to_xml.rb', line 109

def to_xml(options = {})
  xml = options[:builder] || Builder::XmlMarkup.new(options)
  xml.organisation :index => api_id do
    xml.id api_id, :type => "string"
    xml.name orgname
    xml.unit1 unit1
    xml.unit2 unit2
    extra_fields_to_xml(options[:include], xml)
  end
  xml.target!
end