rfilemaker 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bart Zonneveld
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,74 @@
+= rfilemaker
+
+Heavily inspired by lardawge-rfm, see http://github.com/lardawge/rfm.
+
+This library parses a Filemaker Pro FMPXMLRESULT type document, nothing more, nothing less
+
+== Installation
+
+Easy, just use:
+	
+	gem install rfilemaker
+	
+== Usage
+
+To parse a Filemaker Pro export file named 'export.xml', use:
+
+	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>
+
+gives this Ruby hash:
+
+	[{"Last Name"=>"Smith", "Department"=>"Engineering", "First Name"=>"Joe"},
+	 	{"Last Name"=>"Jones", "Department"=>"Marketing", "First Name"=>"Susan"}]
+	
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rfilemaker"
+    gem.summary = %Q{Ruby library to parse Filemaker Pro FMPXMLRESULT files}
+    gem.description = %Q{Ruby library to parse Filemaker Pro FMPXMLRESULT files}
+    gem.email = "loop@superinfinite.com"
+    gem.homepage = "http://github.com/bartzon/rfilemaker"
+    gem.authors = ["Bart Zonneveld"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "nokogiri", ">= 1.4.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rfilemaker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rfilemaker.rb

@@ -0,0 +1,13 @@
+require 'nokogiri'
+
+module RFilemaker
+  def self.parse(string)
+    doc = Nokogiri::XML.parse(string)
+    ResultSet.new(doc)
+  end
+  
+  autoload :ResultSet,  'rfilemaker/result_set'
+  autoload :Field,      'rfilemaker/field'
+  autoload :Row,        'rfilemaker/row'
+  autoload :Record,     'rfilemaker/record'
+end

data/lib/rfilemaker/field.rb

@@ -0,0 +1,35 @@
+module RFilemaker
+  class Field
+    attr_reader :name, :type
+    
+    def initialize(xml, result_set)
+      @name       = xml['NAME']
+      @type       = xml['TYPE'] ? xml['TYPE'].downcase.to_sym : :none
+      @empty_ok   = xml['EMPTYOK'] == 'YES'
+      @result_set = result_set
+    end
+    
+    def coerce(value)
+      return nil if value.nil? || value == ''
+      
+      case type
+        when :date
+          Date.strptime(value, @result_set.date_format) unless @empty_ok
+        when :time
+          DateTime.strptime("1/1/-4712 #{value}", @result_set.time_format) unless @empty_ok
+        when :timestamp
+          DateTime.strptime(value, @result_set.time_format) unless @empty_ok
+        when :number
+          if value.include?('.')
+            value.to_f
+          elsif value.include?(',')
+            value.gsub(/,/, '.').to_f
+          else
+            value.to_i
+          end
+        else
+          value.to_s
+      end
+    end
+  end
+end

data/lib/rfilemaker/record.rb

@@ -0,0 +1,22 @@
+module RFilemaker
+  class Record < Hash
+    attr_reader :record_id, :mod_id
+    
+    def initialize(row, fields)
+      @row = row
+      @record_id = @row.record_id
+      @mod_id    = @row.mod_id
+      
+      fields.each_with_index do |field, index|
+        data = row.columns[index]
+
+        if data.is_a?(Array)
+          self[field.name] = []
+          data.each { |d| self[field.name] << field.coerce(d) }
+        else
+          self[field.name] = field.coerce(data)
+        end
+      end
+    end
+  end
+end

data/lib/rfilemaker/result_set.rb

@@ -0,0 +1,37 @@
+module RFilemaker
+  class ResultSet < Array
+    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')
+    end
+
+    attr_reader :fields, :rows
+    attr_reader :date_format, :time_format
+    
+    def initialize(doc)
+      @fields = extract_fields(doc)
+      @rows   = extract_rows(doc)
+
+      d = doc.css('DATABASE')
+      @date_format = ResultSet.parse_date_format(d.attribute('DATEFORMAT').to_s)
+      @time_format = ResultSet.parse_date_format(d.attribute('TIMEFORMAT').to_s)
+            
+      @rows.each do |row|
+        self << Record.new(row, fields)
+      end
+    end
+
+    private
+      def extract_fields(doc)
+        doc.css('METADATA FIELD').collect do |xml|
+          Field.new(xml, self)
+        end
+      end
+      
+      def extract_rows(doc)
+        doc.css('RESULTSET ROW').collect do |xml|
+          Row.new(xml)
+        end
+      end
+  end
+end

data/lib/rfilemaker/row.rb

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

data/rfilemaker.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rfilemaker}
+  s.version = "0.0.1"
+
+  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.description = %q{Ruby library to parse Filemaker Pro FMPXMLRESULT files}
+  s.email = %q{loop@superinfinite.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rfilemaker.rb",
+     "lib/rfilemaker/field.rb",
+     "lib/rfilemaker/record.rb",
+     "lib/rfilemaker/result_set.rb",
+     "lib/rfilemaker/row.rb",
+     "rfilemaker.gemspec",
+     "spec/full_parse_test_spec.rb",
+     "spec/rfilemaker/field_spec.rb",
+     "spec/rfilemaker/result_set_spec.rb",
+     "spec/rfilemaker_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bartzon/rfilemaker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby library to parse Filemaker Pro FMPXMLRESULT files}
+  s.test_files = [
+    "spec/full_parse_test_spec.rb",
+     "spec/rfilemaker/field_spec.rb",
+     "spec/rfilemaker/result_set_spec.rb",
+     "spec/rfilemaker_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<nokogiri>, [">= 1.4.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.2"])
+  end
+end
+

data/spec/full_parse_test_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RFilemaker do
+  before(:each) do
+    xml = <<-eoxml
+    <?xml version="1.0" encoding="UTF-8"?>
+    <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="Name" TYPE="TEXT"/>
+    		<FIELD EMPTYOK="NO" MAXREPEAT="1" NAME="Date joined" TYPE="DATE"/>
+    	</METADATA>
+    	<RESULTSET FOUND="2">
+    		<ROW MODID="47" RECORDID="34"> 
+    			<COL>
+    				<DATA>Joe Smith</DATA>
+    			</COL>
+    			<COL>
+    				<DATA>03/02/10</DATA>
+    				<DATA>05/02/10</DATA>
+    			</COL>
+    		</ROW>
+    		<ROW MODID="89" RECORDID="78">
+    			<COL> 
+    				<DATA>Susan Jones</DATA>
+    			</COL>
+    			<COL>
+    				<DATA>04/05/09</DATA>
+    				<DATA>10/05/09</DATA>
+    			</COL>
+    		</ROW>
+    	</RESULTSET>
+    </FMPXMLRESULT>
+    eoxml
+    
+    @result = RFilemaker.parse(xml)
+  end
+  
+  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.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.mod_id.should    == 89
+      r.record_id.should == 78
+    end
+  end
+end

data/spec/rfilemaker/field_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe RFilemaker::Field do
+  describe "coercing values" do
+    before(:each) do
+      x  = Nokogiri::XML.parse('<foo/>')
+      rs = mock("Rfilemaker::ResultSet", :date_format => 'date_format', :time_format => 'time_format')
+      @f = RFilemaker::Field.new(x, rs)
+    end
+    
+    it "should coerce nil correctly" do
+      @f.coerce(nil).should be_nil
+    end
+    
+    it "should coerce '' correctly" do
+      @f.coerce('').should be_nil
+    end
+    
+    it "should coerce a string correctly" do
+      @f.stub!(:type).and_return :string
+      @f.coerce('foo').should == 'foo'
+    end
+    
+    it "should coerce a float with . correctly" do
+      @f.stub!(:type).and_return :number
+      @f.coerce('10.45').should == 10.45
+    end
+
+    it "should coerce a float with , correctly" do
+      @f.stub!(:type).and_return :number
+      @f.coerce('10,45').should == 10.45
+    end
+
+    it "should coerce an int correctly" do
+      @f.stub!(:type).and_return :number
+      @f.coerce('10').should == 10
+    end
+    
+    it "should coerce a date correctly" do
+      Date.should_receive(:strptime).with('foo', 'date_format').and_return 'd'
+      @f.stub!(:type).and_return :date
+      @f.coerce('foo').should == 'd'
+    end
+    
+    it "should coerce a time correctly" do
+      DateTime.should_receive(:strptime).with('1/1/-4712 foo', 'time_format').and_return 't'
+      @f.stub!(:type).and_return :time
+      @f.coerce('foo').should == 't'
+    end
+
+    it "should coerce a timestamp correctly" do
+      DateTime.should_receive(:strptime).with('foo', 'time_format').and_return 't'
+      @f.stub!(:type).and_return :timestamp
+      @f.coerce('foo').should == 't'
+    end
+  end
+end

data/spec/rfilemaker/result_set_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe RFilemaker::ResultSet do
+  describe "parsing" do
+    def parse(str)
+      RFilemaker::ResultSet.parse_date_format(str)
+    end
+    
+    describe "date formats" do
+      it "should parse 'mm/dd/yy' correctly" do
+        parse('mm/dd/yy').should == '%m/%d/%y'
+      end
+
+      it "should parse 'mm/dd/yyyy' correctly" do
+        parse('mm/dd/yyyy').should == '%m/%d/%y'
+      end
+
+      it "should parse 'MM/dd/yy' correctly" do
+        parse('MM/dd/yy').should == '%m/%d/%y'
+      end
+
+      it "should parse 'M/dd/yy' correctly" do
+        parse('M/dd/yy').should == '%m/%d/%y'
+      end
+
+      it "should parse 'mm/dd/yy' correctly" do
+        parse('mm/d/yy').should == '%m/%d/%y'
+      end
+      
+      it "should parse 'D-m-yyyy' correctly" do
+        parse('D-m-yyyy').should == '%d-%m-%y'
+      end
+    end
+    
+    describe "time formats" do
+      it "should parse 'hh:mm:ss' correctly" do
+        parse('hh:mm:ss').should == '%I:%m:%S'
+      end
+
+      it "should parse 'h:mm:ss' correctly" do
+        parse('h:mm:ss').should == '%I:%m:%S'
+      end
+
+      it "should parse 'hh:mm:ss a' correctly" do
+        parse('hh:mm:ss a').should == '%I:%m:%S %p'
+      end
+
+      it "should parse 'kk:mm:ss' correctly" do
+        parse('kk:mm:ss').should == '%H:%m:%S'
+      end
+
+      it "should parse 'k:mm:ss' correctly" do
+        parse('k:mm:ss').should == '%H:%m:%S'
+      end
+    end
+  end
+end

data/spec/rfilemaker_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RFilemaker do
+  before(:each) do
+    @xml = "<foo></foo>"
+    RFilemaker::ResultSet.stub!(:new).and_return 'result set'
+    Nokogiri::XML.stub!(:parse).and_return 'xml'
+  end
+  
+  def parse
+    RFilemaker.parse(@xml)
+  end
+  
+  it "should parse a string using nokogiri" do
+    Nokogiri::XML.should_receive(:parse).with(@xml)
+    parse
+  end
+  
+  it "should initialize a resultset with the parsed xml" do
+    RFilemaker::ResultSet.should_receive(:new).with('xml')
+    parse
+  end
+  
+  it "should return the resultset" do
+    parse.should == 'result set'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rfilemaker'
+require 'spec'
+require 'spec/autorun'
+
+Dir.glob(File.join(File.dirname(__FILE__), '*_spec.rb')).each { |f| require f }
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: rfilemaker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bart Zonneveld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :development
+  version_requirements: *id002
+description: Ruby library to parse Filemaker Pro FMPXMLRESULT files
+email: loop@superinfinite.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rfilemaker.rb
+- lib/rfilemaker/field.rb
+- lib/rfilemaker/record.rb
+- lib/rfilemaker/result_set.rb
+- lib/rfilemaker/row.rb
+- rfilemaker.gemspec
+- spec/full_parse_test_spec.rb
+- spec/rfilemaker/field_spec.rb
+- spec/rfilemaker/result_set_spec.rb
+- spec/rfilemaker_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bartzon/rfilemaker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby library to parse Filemaker Pro FMPXMLRESULT files
+test_files: 
+- spec/full_parse_test_spec.rb
+- spec/rfilemaker/field_spec.rb
+- spec/rfilemaker/result_set_spec.rb
+- spec/rfilemaker_spec.rb
+- spec/spec_helper.rb