ginjo-rfm 2.0.1 → 2.0.2

data/CHANGELOG.md

@@ -1,22 +1,30 @@
 # Changelog
 
+## Ginjo-Rfm 2.0.2
+
+* Added configuration parameter ignore_bad_data to silence data mismatch errors when loading resultset into records.
+
+* Added method to load a resultset from file or string. Rfm::Resultset.load_data(file_or_string).
+
+* Added more specs for the above features and for the XmlParser module.
+
 ## Ginjo-Rfm 2.0.1
 
-* Fixed bug in Base.find where options weren't being passed to Layout#find correctly
+* Fixed bug in Base.find where options weren't being passed to Layout#find correctly.
 
 * Fixed bug in rfm.rb when calling #models or #modelize.
 
 ## Ginjo-Rfm 2.0.0
 
-* ActiveModel compatibility allows Rails ActiveRecord-style models
+* ActiveModel compatibility allows Rails ActiveRecord-style models.
 
-* Alternative XML parsers using ActiveSupport::XmlMini interface
+* Alternative XML parsers using ActiveSupport::XmlMini interface.
 
-* Compound queries with multiple omitable find-requests
+* Compound queries with multiple omitable find-requests.
 
-* Configuration API manages settings of multiple server/db/layout/etc setups
+* Configuration API manages settings of multiple server/db/layout/etc setups.
 
-* Full Filemaker metadata support
+* Full Filemaker metadata support.
 
 ## Ginjo-Rfm 1.4.4
 

data/README.md

@@ -372,6 +372,7 @@ Following are all of the recognized configuration options, including defaults if
 	   :file_name        => 'rfm.yml                      # name of configuration file to load yaml from
 	   :file_path        => ['', 'config/']               # array of additional file paths to look for configuration file
 	   :parser           => ActiveSupport::XmlMini_REXML  # XmlParser to use if no other is specified or can be found
+	   :ignore_bad_data  => nil                           # Instruct Rfm to ignore data mismatch errors when loading a resultset
 	
 
 ### Using Models
@@ -515,26 +516,31 @@ See the API documentation for the lowdown on new methods in Rfm Server, Database
 
 All Rfm methods that take a configuration hash have two possible shortcuts.
 
-If you pass a symbol before the hash, it is interpreted as subgroup specification or subgroup filter
+(1) If you pass a symbol before the hash, it is interpreted as subgroup specification or subgroup filter
 
 	   config :mygroup, :layout => 'mylayout'
+	   # This will add the following configuration options to the object you called 'config' on.
 	   # :use => :mygroup, :layout => 'mylayout'
 	
 	   get_config :othergroup
+	   # This will return global configuration options merged with configuration options from :othergroup.
 	   # :use => [:mygroup, :othergroup], :layout => 'mylayout'
 
-If you pass a string before any symbols or hashes, it is interepreted as one of several possible configuration settings - usually a layout name, a database name, or a server hostname. The interpretation is dependent on the method being called. Not all methods will make use of a string parameter.
+(2) If you pass a string before any symbols or hashes, it is interpreted as one of several possible configuration settings - usually a layout name, a database name, or a server hostname. The interpretation is dependent on the method being called. Not all methods will make use of a string parameter.
 
 	   class MyModel < Rfm::Base
 	     config 'MyLayoutName'
-	     # :layout => 'MyLayoutName'
+	     # In this context, this is the same as
+	     # config :layout => 'MyLayoutName'
 	   end
 	
 	   Rfm.database 'MyDatabaseName'
-	   # :database => 'MyDatabaseName'
+	   # In this context, this is the same as
+	   # Rfm.database :database => 'MyDatabaseName'
 	
 	   Rfm.modelize 'MyDatabaseName', :group1
-	   # :database => 'MyDatabaseName', :use => :group1
+	   # In this context, this is the same as
+	   # Rfm.modelize :database => 'MyDatabaseName', :use => :group1
 
 Just about anything you can do with a Rfm layout, you can also do with a Rfm model.
 
@@ -544,11 +550,28 @@ Just about anything you can do with a Rfm layout, you can also do with a Rfm mod
 	
 There are a number of methods within Rfm that have been made accessible from the top-level Rfm module. Note that the server/database/layout methods are new to Rfm and are not the same as Rfm::Server, Rfm::Database, and Rfm::Layout. See the above section on "Getting Rfm Server, Database, and Layout Objects Manually" for an overview of how to use the new server/database/layout methods.
 
-	   # Any of these methods can be assed via Rfm.<method_name>
+	   # Any of these methods can be accessed via Rfm.<method_name>
 	   
 	   Rfm::Factory    :servers, :server, :db, :database, :layout, :models, :modelize
 	   Rfm::XmlParser  :backend, :backend=
 	   Rfm::Config     :config, :get_config, :config_clear
+	   Rfm::Resultset  :ignore_bad_data
+	
+If you are working with a Filemaker database that returns codes like '?' for a missing value in a date field, Rfm will throw an error. Set your main configuration, your server, or your layout to `ignore_bad_data true`, if you want Rfm to silently ignore data mismatch errors when loading resultset data. If ActiveRecord is loaded, and your resultset is loaded into a Rfm model, your model records will log these errors in the @errors attribute.
+
+	   Rfm.config :ignore_bad_data => true
+	   
+	   class MyModel < Rfm::Base
+	     config 'my_layout'
+	   end
+	   
+	   result = MyModel.find(:name => 'mike')
+	   # Assuming the Filemaker field 'some_date_field' contains a bad date value '?'
+	   result[0].errors.full_messages
+	   # ['some_date_field invalid date']
+	
+	   # To be more specific about what objects you want to ignore data errors
+	   MyModel.layout.ignore_bad_data true
 
 ## Working with "Classic" Rfm Features
 

data/lib/rfm.rb

@@ -61,6 +61,7 @@ module Rfm
 	def_delegators 'Rfm::Factory', :servers, :server, :db, :database, :layout
 	def_delegators 'Rfm::XmlParser', :backend, :backend=
 	def_delegators 'Rfm::Config', :config, :get_config, :config_clear
+	def_delegators 'Rfm::Resultset', :load_data
 	
 	def models(*args)
 		Rfm::Base

data/lib/rfm/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.2

data/lib/rfm/base.rb

@@ -194,7 +194,7 @@ module Rfm
 		
 	    # Access layout functions from base model
 	  	def_delegators :layout, :db, :server, :field_controls, :field_names, :value_lists, :total_count,
-	  									:query, :all, :delete, :portal_meta, :portal_names, :database, :table, :count
+	  									:query, :all, :delete, :portal_meta, :portal_names, :database, :table, :count, :ignore_bad_data
 
 			def inherited(model)
 				(Rfm::Factory.models << model).uniq unless Rfm::Factory.models.include? model

data/lib/rfm/layout.rb

@@ -143,6 +143,7 @@ module Rfm
       @value_lists = Rfm::CaseInsensitiveHash.new
 			#       @portal_meta = nil
 			#       @field_names = nil
+			@ignore_bad_data = (db_obj.server.state[:ignore_bad_data] rescue nil)
     end
     
     meta_attr_reader :db
@@ -376,6 +377,11 @@ module Rfm
       @field_controls.freeze
     end
     
+    def ignore_bad_data(val = nil)
+    	(@ignore_bad_data = val) unless val.nil?
+    	@ignore_bad_data
+    end
+    
   	private :load, :get_records, :params
       
       

data/lib/rfm/record.rb

@@ -133,7 +133,12 @@ module Rfm
         data = field['data']; data = data.is_a?(Hash) ? [data] : data
         data.each do |x|
         	next unless field_meta[field_name]
-          datum.push(field_meta[field_name].coerce(x['__content__'], resultset_obj))
+        	begin
+	          datum.push(field_meta[field_name].coerce(x['__content__'], resultset_obj))
+        	rescue StandardError => error
+        		self.errors.add(field_name, error) if self.respond_to? :errors
+        		raise error unless @layout.ignore_bad_data
+        	end
         end if data
       
         if datum.length == 1

data/lib/rfm/resultset.rb

@@ -72,22 +72,22 @@ module Rfm
       @portal_meta    ||= Rfm::CaseInsensitiveHash.new
       @include_portals  = portals 
       
-      doc = XmlParser.new(xml_response, :namespace=>false, :parser=>server.state[:parser])
+      doc = XmlParser.new(xml_response, :namespace=>false, :parser=>(server.state[:parser] rescue nil))
       
       error = doc['fmresultset']['error']['code'].to_i
-      check_for_errors(error, server.state[:raise_on_401])
+      check_for_errors(error, (server.state[:raise_on_401] rescue nil))
 
-      datasource        = doc['fmresultset']['datasource']
+      @datasource       = doc['fmresultset']['datasource']
       meta              = doc['fmresultset']['metadata']
       resultset         = doc['fmresultset']['resultset']
 
-      @date_format      = convert_date_time_format(datasource['date-format'].to_s)
-      @time_format      = convert_date_time_format(datasource['time-format'].to_s)
-      @timestamp_format = convert_date_time_format(datasource['timestamp-format'].to_s)
+      @date_format      = convert_date_time_format(@datasource['date-format'].to_s)
+      @time_format      = convert_date_time_format(@datasource['time-format'].to_s)
+      @timestamp_format = convert_date_time_format(@datasource['timestamp-format'].to_s)
 
       @foundset_count   = resultset['count'].to_s.to_i
-      @total_count      = datasource['total-count'].to_s.to_i
-      @table            = datasource['table']
+      @total_count      = @datasource['total-count'].to_s.to_i
+      @table            = @datasource['table']
       
       (layout.table = @table) if layout and layout.table_no_load.blank?
       
@@ -97,6 +97,17 @@ module Rfm
       # See Record for control of portal data loading.
       parse_portals(meta)
       
+      # These were added for loading resultset from file
+      unless @layout
+      	@layout = @datasource['layout']
+      	@layout.instance_variable_set '@database', @datasource['database']
+      	@layout.instance_eval do
+      		def database
+      			@database
+      		end
+      	end
+      end			
+      
       return if resultset['record'].nil?
       Rfm::Record.build_records(resultset['record'].rfm_force_array, self, @field_meta, @layout)
     end
@@ -109,6 +120,10 @@ module Rfm
   		portal_meta.keys
   	end
     
+    # Load Resultset data from file-spec or string
+    def self.load_data(file_or_string)
+    	self.new(nil, file_or_string, nil)
+    end
     
     private
     

data/lib/rfm/server.rb

@@ -209,7 +209,8 @@ module Rfm
         :log_parser => false,
         :warn_on_redirect => true,
         :raise_on_401 => false,
-        :timeout => 60
+        :timeout => 60,
+        :ignore_bad_data => false
       }.merge(options)
     
       @state.freeze

data/lib/rfm/utilities/config.rb

@@ -18,6 +18,7 @@ module Rfm
 			password
 			database
 			layout
+			ignore_bad_data
 			ssl
 			root_cert
 			root_cert_name

data/lib/rfm/utilities/xml_parser.rb

@@ -6,7 +6,7 @@ module Rfm
 		
 		extend self
 		
-		# Backend configurations
+		# Backend definitions & configurations
 		BACKENDS = ActiveSupport::OrderedHash.new
 		
 		BACKENDS[:jdom]					= {:require=>'jdom',			:class =>	'JDOM'}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ginjo-rfm
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 2
   - 0
-  - 1
-  version: 2.0.1
+  - 2
+  version: 2.0.2
 platform: ruby
 authors: 
 - Geoff Coffey
@@ -19,7 +19,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-19 00:00:00 Z
+date: 2012-04-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport