rfilemaker 0.0.1 → 0.0.2

data/README.rdoc

@@ -7,62 +7,64 @@ This library parses a Filemaker Pro FMPXMLRESULT type document, nothing more, no
 == Installation
 
 Easy, just use:
-	
-	gem install rfilemaker
-	
+  
+  gem install rfilemaker
+  
 == Usage
 
 To parse a Filemaker Pro export file named 'export.xml', use:
 
-	RFilemaker.parse('export.xml')
-	
+  RFilemaker.parse('export.xml')
+  
 This returns an array of hashes, each of which represent a row in your Filemaker database.
 Fields are automatically converted to their ruby types. 
 
 For instance, parsing the following XML export:
 
-	<FMPXMLRESULT xmlns="http://www.filemaker.com/fmpxmlresult">
-		<ERRORCODE>0</ERRORCODE> 
-		<PRODUCT BUILD="5/23/2002" NAME="FileMaker Pro"
-		VERSION="7.0"/> 
-		<DATABASE DATEFORMAT="MM/dd/yy" LAYOUT="summary"
-		NAME="Employees.fp7" RECORDS="23" TIMEFORMAT="hh:mm:ss"/>
-		<METADATA>
-			<FIELD EMPTYOK="NO" MAXREPEAT="1" NAME="First Name" TYPE="TEXT"/>
-			<FIELD EMPTYOK="NO" MAXREPEAT="1" NAME="Last Name" TYPE="TEXT"/>
-			<FIELD EMPTYOK="YES" MAXREPEAT="1" NAME="Department" TYPE="TEXT"/>
-		</METADATA>
-		<RESULTSET FOUND="2">
-			<ROW MODID="47" RECORDID="34"> 
-				<COL>
-					<DATA>Joe</DATA>
-				</COL>
-				<COL>
-					<DATA>Smith</DATA>
-				</COL>
-				<COL>
-					<DATA>Engineering</DATA>
-				</COL>
-			</ROW>
-			<ROW MODID="89" RECORDID="78">
-				<COL> 
-					<DATA>Susan</DATA>
-				</COL>
-				<COL>
-					<DATA>Jones</DATA>
-				</COL>
-				<COL>
-					<DATA>Marketing</DATA>
-				</COL>
-			</ROW>
-		</RESULTSET>
-	</FMPXMLRESULT>
+  <FMPXMLRESULT xmlns="http://www.filemaker.com/fmpxmlresult">
+    <ERRORCODE>0</ERRORCODE> 
+    <PRODUCT BUILD="5/23/2002" NAME="FileMaker Pro"
+    VERSION="7.0"/> 
+    <DATABASE DATEFORMAT="MM/dd/yy" LAYOUT="summary"
+    NAME="Employees.fp7" RECORDS="23" TIMEFORMAT="hh:mm:ss"/>
+    <METADATA>
+      <FIELD EMPTYOK="NO" MAXREPEAT="1" NAME="First Name" TYPE="TEXT"/>
+      <FIELD EMPTYOK="NO" MAXREPEAT="1" NAME="Last Name" TYPE="TEXT"/>
+      <FIELD EMPTYOK="YES" MAXREPEAT="1" NAME="Department" TYPE="TEXT"/>
+    </METADATA>
+    <RESULTSET FOUND="2">
+      <ROW MODID="47" RECORDID="34"> 
+        <COL>
+          <DATA>Joe</DATA>
+        </COL>
+        <COL>
+          <DATA>Smith</DATA>
+        </COL>
+        <COL>
+          <DATA>Engineering</DATA>
+        </COL>
+      </ROW>
+      <ROW MODID="89" RECORDID="78">
+        <COL> 
+          <DATA>Susan</DATA>
+        </COL>
+        <COL>
+          <DATA>Jones</DATA>
+        </COL>
+        <COL>
+          <DATA>Marketing</DATA>
+        </COL>
+      </ROW>
+    </RESULTSET>
+  </FMPXMLRESULT>
 
 gives this Ruby hash:
 
-	[{"Last Name"=>"Smith", "Department"=>"Engineering", "First Name"=>"Joe"},
-	 	{"Last Name"=>"Jones", "Department"=>"Marketing", "First Name"=>"Susan"}]
-	
+  [{"last name"=>"Smith", "department"=>"Engineering", "first name"=>"Joe"},
+   {"last name"=>"Jones", "department"=>"Marketing", "first name"=>"Susan"}]
+   
+The resulting hash is case-insensitive, so keys can be looked up in any given case.
+  
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rfilemaker.rb

@@ -1,6 +1,19 @@
 require 'nokogiri'
 
 module RFilemaker
+  class SpecialHash < Hash # :nodoc: all
+    def []=(key, value)
+      super(key.downcase, value)
+    end
+    
+    def [](key)
+      super(key.to_s.downcase)
+    end
+  end
+  
+  # Parse a FMPXMLRESULT string into an Array
+  #
+  # Each element in the Array is a Hash, representing a row in the imported XML
   def self.parse(string)
     doc = Nokogiri::XML.parse(string)
     ResultSet.new(doc)

data/lib/rfilemaker/field.rb

@@ -1,6 +1,9 @@
 module RFilemaker
   class Field
-    attr_reader :name, :type
+    # Name of the field
+    attr_reader :name
+    # Type of the field as symbol
+    attr_reader :type
     
     def initialize(xml, result_set)
       @name       = xml['NAME']
@@ -8,7 +11,14 @@ module RFilemaker
       @empty_ok   = xml['EMPTYOK'] == 'YES'
       @result_set = result_set
     end
-    
+
+    # Coerce a value to the Ruby equivalent of the Filemaker Type
+    #
+    # * 'DATE' gets converted to Date
+    # * 'TIME' gets converted to DateTime
+    # * 'TIMESTAMP' gets converted to DateTime
+    # * 'NUMBER' gets converted to float or integer
+    # * everything else gets converted to a string
     def coerce(value)
       return nil if value.nil? || value == ''
       

data/lib/rfilemaker/record.rb

@@ -1,14 +1,18 @@
 module RFilemaker
-  class Record < Hash
-    attr_reader :record_id, :mod_id
+  # Represents a Row in the Filemaker database, as a plain Hash
+  class Record < SpecialHash
+    # Record id from Filemaker
+    attr_reader :record_id
+    
+    # Modification id from Filemaker
+    attr_reader :mod_id
     
     def initialize(row, fields)
-      @row = row
-      @record_id = @row.record_id
-      @mod_id    = @row.mod_id
+      @record_id = row[:record_id]
+      @mod_id    = row[:mod_id]
       
       fields.each_with_index do |field, index|
-        data = row.columns[index]
+        data = row[:columns][index]
 
         if data.is_a?(Array)
           self[field.name] = []
@@ -17,6 +21,8 @@ module RFilemaker
           self[field.name] = field.coerce(data)
         end
       end
+      
+      freeze
     end
   end
 end

data/lib/rfilemaker/result_set.rb

@@ -1,5 +1,6 @@
 module RFilemaker
   class ResultSet < Array
+    # Parse a Filemaker date format to something strptime understands
     def self.parse_date_format(string)
       string = string.gsub(/yyyy|yy/, '%y').gsub(/mm|m|MM|M/, '%m').gsub(/dd|d|DD|D/, '%d')
       string.gsub(/hh|h/, '%I').gsub(/kk|k/, '%H').gsub(/mm/, '%M').gsub(/ss/, '%S').gsub(/a/, '%p')
@@ -8,6 +9,8 @@ module RFilemaker
     attr_reader :fields, :rows
     attr_reader :date_format, :time_format
     
+    # Generates a new ResultSet (or plain Ruby Array) for the given XML document
+    # Items in the ResultSet are Hashes, representing rows in the Filemaker export
     def initialize(doc)
       @fields = extract_fields(doc)
       @rows   = extract_rows(doc)
@@ -21,7 +24,7 @@ module RFilemaker
       end
     end
 
-    private
+    private # :nodoc: all
       def extract_fields(doc)
         doc.css('METADATA FIELD').collect do |xml|
           Field.new(xml, self)

data/lib/rfilemaker/row.rb

@@ -1,18 +1,15 @@
 module RFilemaker
-  class Row
-    attr_reader :record_id, :mod_id, :columns
-    
+  class Row < Hash # :nodoc: all
     def initialize(xml)
-      @record_id = xml['RECORDID'].to_i
-      @mod_id    = xml['MODID'].to_i
-      
-      @columns = []
-      xml.css('COL').each do |col|
+      self[:record_id] = xml['RECORDID'].to_i
+      self[:mod_id]    = xml['MODID'].to_i
+
+      self[:columns] = xml.css('COL').collect do |col|
         datas = col.css('DATA')
         if datas.size > 1
-          @columns << datas.collect { |x| x.inner_text }
+          datas.collect { |x| x.inner_text }
         else
-          @columns << datas.inner_text
+          datas.inner_text
         end
       end
     end

data/rfilemaker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rfilemaker}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bart Zonneveld"]
-  s.date = %q{2010-06-01}
+  s.date = %q{2010-06-02}
   s.description = %q{Ruby library to parse Filemaker Pro FMPXMLRESULT files}
   s.email = %q{loop@superinfinite.com}
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "rfilemaker.gemspec",
      "spec/full_parse_test_spec.rb",
      "spec/rfilemaker/field_spec.rb",
+     "spec/rfilemaker/record_spec.rb",
      "spec/rfilemaker/result_set_spec.rb",
      "spec/rfilemaker_spec.rb",
      "spec/spec.opts",
@@ -44,6 +45,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/full_parse_test_spec.rb",
      "spec/rfilemaker/field_spec.rb",
+     "spec/rfilemaker/record_spec.rb",
      "spec/rfilemaker/result_set_spec.rb",
      "spec/rfilemaker_spec.rb",
      "spec/spec_helper.rb"

data/spec/full_parse_test_spec.rb

@@ -43,14 +43,14 @@ describe RFilemaker do
   describe "records" do
     it "should parse the first record correctly" do
       r = @result[0]
-      r.should == { 'Name' => 'Joe Smith', 'Date joined' => [Date.new(2010,3,2), Date.new(2010,5,2)] }
+      r.should == { 'name' => 'Joe Smith', 'date joined' => [Date.new(2010,3,2), Date.new(2010,5,2)] }
       r.mod_id.should    == 47
       r.record_id.should == 34
     end
     
     it "should parse the second record correctly" do
       r = @result[1]
-      r.should == { 'Name' => 'Susan Jones', 'Date joined' => [Date.new(2009,4,5), Date.new(2009,10,5)] }
+      r.should == { 'name' => 'Susan Jones', 'date joined' => [Date.new(2009,4,5), Date.new(2009,10,5)] }
       r.mod_id.should    == 89
       r.record_id.should == 78
     end

data/spec/rfilemaker/record_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe RFilemaker::Record do
+  before(:each) do
+    @row = { :record_id => 1, :mod_id => 2 }
+  end
+  
+  it "should be frozen" do
+    r = RFilemaker::Record.new(@row, [])
+    r.should be_frozen
+  end
+end

data/spec/rfilemaker_spec.rb

@@ -24,4 +24,19 @@ describe RFilemaker do
   it "should return the resultset" do
     parse.should == 'result set'
   end
+  
+  describe "'special' hash" do
+    before(:each) do
+      @h = RFilemaker::SpecialHash.new
+      @h['Foo BAR'] = 'baz'
+    end
+    
+    it "should lookup keys as string" do
+      @h['Foo BAR'].should == 'baz'
+    end
+    
+    it "should lookup keys as lowercase strings" do
+      @h['foo bar'].should == 'baz'
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Bart Zonneveld
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-01 00:00:00 +02:00
+date: 2010-06-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,7 @@ files:
 - rfilemaker.gemspec
 - spec/full_parse_test_spec.rb
 - spec/rfilemaker/field_spec.rb
+- spec/rfilemaker/record_spec.rb
 - spec/rfilemaker/result_set_spec.rb
 - spec/rfilemaker_spec.rb
 - spec/spec.opts
@@ -106,6 +107,7 @@ summary: Ruby library to parse Filemaker Pro FMPXMLRESULT files
 test_files: 
 - spec/full_parse_test_spec.rb
 - spec/rfilemaker/field_spec.rb
+- spec/rfilemaker/record_spec.rb
 - spec/rfilemaker/result_set_spec.rb
 - spec/rfilemaker_spec.rb
 - spec/spec_helper.rb