treecard 0.0.2

data/README.md

@@ -0,0 +1 @@
+At some point this will be documented. But not today.

data/lib/treecard/attribute.rb

@@ -0,0 +1,20 @@
+# A line in the VCard file.
+#
+#   * +name+ is the name of the attribute, like 'fn', 'adr', etc.
+#   * +param+ is a list of +TreeCard::Param+ objects, representing each
+#     parameter associated with this attribute
+#   * +value+ is the raw text of the attribute's value. It is up to
+#     the caller to parse, if necessary.
+class TreeCard::Attribute
+
+  attr_reader :name, :params, :value
+  
+  def initialize(name, params, value)
+    @name = name
+    @params = {}
+    params.each do |param|
+      @params[param.name.downcase] = param
+    end
+    @value = value
+  end
+end

data/lib/treecard/nodes/content_line_node.rb

@@ -0,0 +1,16 @@
+class TreeCard::ContentLineNode < Treetop::Runtime::SyntaxNode
+
+  # Returns the TreeCard::Attribute representing this node.
+  def attribute
+    TreeCard::Attribute.new(name.text_value, param_objects, value.text_value)
+  end
+
+  private
+
+  def param_objects
+    param_list.elements.map do |semicolon_and_param|
+      semicolon_and_param.param.param_object
+    end
+  end
+
+end

data/lib/treecard/nodes/param_node.rb

@@ -0,0 +1,11 @@
+class TreeCard::ParamNode < Treetop::Runtime::SyntaxNode
+
+  # Returns the TreeCard::Param object representing this node. 
+  def param_object
+    param_values = []
+    if self.respond_to?(:param_value)
+      param_values = [param_value.text_value] + extra_params.elements.map { |extra_param| extra_param.param_value.text_value }
+    end
+    TreeCard::Param.new(param_name.text_value, param_values)
+  end
+end

data/lib/treecard/param.rb

@@ -0,0 +1,9 @@
+# A VCard attribute's parameter. Just contains a key, called +name+,
+# and a list of values.
+class TreeCard::Param
+  attr_reader :name, :values
+  def initialize(name, values)
+    @name = name.downcase
+    @values = values
+  end
+end

data/lib/treecard.rb

@@ -0,0 +1,109 @@
+require 'treetop'
+require 'grammar/vcard' # implements the vcard spec, found at http://tools.ietf.org/html/rfc2425
+
+class TreeCard; end
+
+require 'treecard/nodes/content_line_node'
+require 'treecard/nodes/param_node'
+require 'treecard/attribute'
+require 'treecard/param'
+
+class TreeCard
+
+  attr_reader :raw_data
+  attr_reader :attributes
+
+  def initialize(data)
+    @attributes = Hash.new {|h, k| h[k] = []}
+    @raw_data = self.class.unfold_lines(data)
+    @parser = VCardGrammarParser.new
+    ast = @parser.parse(@raw_data)
+    if ast
+      parse(ast)
+    else
+      raise TreeCard::ParseError, @parser.failure_reason
+    end
+  end
+
+  def name
+    attr = attributes['fn']
+    attr &&= attr.first
+    attr.value if attr
+  end
+
+  def emails
+    attr = attributes['email']
+    attr.map {|email| email.value} if attr
+  end
+
+  def phone
+    attr = attribute_with_param('tel', 'voice')
+    attr.value if attr
+  end
+
+  def fax
+    attr = attribute_with_param('tel', 'fax')
+    attr.value if attr
+  end
+
+  def photo
+    attr = attributes['photo']
+    attr &&= attr.first
+    attr.value if attr
+  end
+
+  def address
+    attr = attributes['adr']
+    attr &&= attr.first
+    attr.value.split(';').join("\n").strip if attr
+  end
+
+  def company
+    attr = attributes['org']
+    attr &&= attr.first
+    attr.value if attr
+  end
+  
+  # VCards automatically wrap lines longer than 75 characters. Wrapped
+  # lines are signified by leading whitespace.
+  def self.unfold_lines(data)
+    unfolded_data = ""
+    current_line = ""
+    data.lines.each do |line|
+      if line =~ /^\s\S+/
+        current_line << line[1..-1].chomp
+      else
+        if current_line != ""
+          if current_line =~ /=0D=0A=$/ #weird quoted printable thing
+            unfolded_data << current_line.chomp
+          else
+            unfolded_data << current_line + "\n"
+          end
+        end
+        current_line = line.chomp
+      end
+    end
+    unfolded_data << current_line + "\n"
+    unfolded_data
+  end
+
+  # Returns the first attribute with +attr_name+ where +param_name+ is
+  # set.
+  def attribute_with_param(attr_name, param_name)
+    attributes = self.attributes[attr_name.downcase]
+    found_attributes = attributes.select { |attribute| attribute.params[param_name.downcase] }
+    found_attributes.first
+  end
+
+  private
+
+  def parse(root)
+    root.elements.each do |contentline|
+      parse_contentline(contentline)
+    end
+  end
+
+  def parse_contentline(node)
+    attributes[node.name.text_value.downcase] << node.attribute
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'shoulda'
+require 'treecard'
+require 'pathname'
+
+class Test::Unit::TestCase
+
+  @@my_path = Pathname.new(File.expand_path(File.dirname(__FILE__)))
+  
+  def vcard_data(vcard_file_name)
+    File.read(@@my_path + 'data' + vcard_file_name)
+  end
+end

data/test/unit/treecard_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class TreeCardTest < Test::Unit::TestCase
+
+  context "A new TreeCard populated with data" do
+    setup do 
+      @vcard = TreeCard.new(vcard_data('Mark_Ericsson.vcf'))
+    end
+
+    should "unfold its lines" do
+      assert_equal "REV:20090729T163338Z", @vcard.raw_data.split("\n")[15]
+    end
+
+    should "parse its data" do
+      assert_equal "Mark S. Ericsson", @vcard.name
+      assert_equal ["mericsson@example.com"], @vcard.emails
+      assert_equal "(925) 930-6000", @vcard.phone
+      assert_equal "(925) 934-5377", @vcard.fax
+      assert_equal "Youngman, Ericsson & Low, LLP", @vcard.company
+      assert_equal "1981 N. Broadway, Suite 300\nWalnut Creek\nCA\n94596-3841\nUnited States of America", @vcard.address
+    end
+  end
+
+  context "TreeCard#unfold_lines" do
+    should "unfold lines that begin with a single whitespace character" do
+      data = "This is the first line\nThis is a long descrip\n tion that exists o\n\tn a long line"
+      assert_equal "This is the first line\nThis is a long description that exists on a long line\n", TreeCard.unfold_lines(data)
+    end
+
+    should "not unfold if there is no real data on a line" do
+      data = "This is another line\n \n"
+      assert_equal "This is another line\n \n", TreeCard.unfold_lines(data)
+    end
+
+    should "not unfold more than one whitespace character" do
+      data = "This is a line\n  test text"
+      assert_equal "This is a line\n  test text\n", TreeCard.unfold_lines(data)
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: treecard
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Justin Weiss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 4
+        - 8
+        version: 1.4.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id002
+description: 
+email: jweiss@avvo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/treecard/attribute.rb
+- lib/treecard/nodes/content_line_node.rb
+- lib/treecard/nodes/param_node.rb
+- lib/treecard/param.rb
+- lib/treecard.rb
+- test/test_helper.rb
+- test/unit/treecard_test.rb
+- README.md
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple vcard parser using Treetop
+test_files: []
+