ginjo-rfm 2.1.0.pre02 → 2.1.0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Ginjo-Rfm 2.1.0
+
+* Removed `:include_portals` query option in favor of `:ignore_portals`.
+
+* Added `:max_portal_rows` query option.
+
+* Added field-remapping framework to allow model fields with different names than Filemaker fields.
+
+* Fix date/time/timestamp translations when writing data to Filemaker.
+
+* Detached new Server objects from Factory.servers hash, so wont reuse or stack-up servers.
+
+* Added grammar translation layer between xml parser and Rfm, allowing all supported xml grammars to be used with Rfm.
+	This will also streamline changes/additions to Filemaker's xml grammar(s).
+	
+* Added ability to manually import fmprestulset and fmpxmlresult data (from file, variable, etc.).
+
+* Fixed case statement for ruby 1.9
+ 
+* Configuration `:use` option is now works for all Rfm objects that respond to `config`.
+
 ## Ginjo-Rfm 2.0.2
 
 * Added configuration parameter ignore_bad_data to silence data mismatch errors when loading resultset into records.

data/README.md

@@ -13,6 +13,28 @@ Rfm is a Ruby-Filemaker adapter, a Ruby gem that allows scripts and applications
 * Lardawge at github  <https://github.com/lardawge/rfm>
 
 
+## New in version  2.1
+
+ginjo-rfm 2.1 is a combination of new features, bug fixes, and a lot of code refactoring.
+Most api calls remain the same, but a good deal of underlying code has been transformed
+to support, and take advantage of, the progress of technologies surrounding Ruby.
+
+* Portals are now included by default.
+	Removed `:include_portals` query option in favor of `:ignore_portals`.
+	Added `:max_portal_rows` query option.
+* Added field-remapping framework to allow model fields with different names than Filemaker fields.
+* Fixed date/time/timestamp translations when writing data to Filemaker.
+* Detached new Server objects from Factory.servers hash, so wont reuse or stack-up servers.
+* Added grammar translation layer between xml parser and Rfm, allowing all supported xml grammars to be used with Rfm.
+  This will also streamline changes/additions to Filemaker's xml grammar(s).
+* Added ability to manually import fmpresultset and fmpxmlresult data (from file, variable, etc.).
+* Compatibility fixes for ruby 1.9.
+* Configuration `:use` option now works for all Rfm objects that respond to `config`.
+
+Some issues still to be addressed (some longstanding and some more recent) are repeating field writes, some of the
+object management & introspection calls, pull requests, more coverage of Filemaker's query syntax, more error classes, more specs, and more documentation.
+
+
 ## New in version 2.0
 
 Ginjo-rfm 2.0 brings new features to Rfm, making it easier than ever to work with Filemaker data from your Ruby scripts.

data/lib/rfm/VERSION

@@ -1 +1,2 @@
-2.1.0.pre02
+2.1.0
+

data/lib/rfm/base.rb

@@ -36,9 +36,7 @@ module Rfm
 	require 'rfm/layout'
 	require 'rfm/record'
 	require 'rfm/utilities/factory'
-	require 'delegate'
-
-  
+	require 'delegate' 
   
   class Layout
 
@@ -196,6 +194,19 @@ module Rfm
       end
 		end
 		
+    def to_partial_path(object = self) #@object)
+    	return 'some/partial/path'
+    	##### DISABLED HERE - ActiveModel Lint only needs a string #####
+    	##### TODO: implement to_partial_path to return meaningful string.
+      @partial_names[object.class.name] ||= begin
+        object = object.to_model if object.respond_to?(:to_model)
+
+        object.class.model_name.partial_path.dup.tap do |partial|
+          path = @view.controller_path
+          partial.insert(0, "#{File.dirname(path)}/") if partial.include?(?/) && path.include?(?/)
+        end
+      end
+    end
 		
 		class << self
 		
@@ -225,7 +236,7 @@ module Rfm
 	  	def layout
 	  		return @layout if @layout
 	  		cnf = get_config
-	  		return unless cnf[:layout]
+	  		raise "Could not get :layout from get_config in Base.layout method" unless cnf[:layout] #return unless cnf[:layout]
 	  		@layout = Rfm::Factory.layout(cnf).sublayout
 	  		
 	  		# Added by wbr to give config heirarchy: layout -> model -> sublayout
@@ -243,6 +254,7 @@ module Rfm
 		  			
 			# Just like Layout#find, but searching by record_id will return a record, not a resultset.
 	  	def find(find_criteria, options={})
+	  		#puts "base.find-#{layout}"
 	  	  r = layout.find(find_criteria, options)
 	  	  if ![Hash,Array].include?(find_criteria.class) and r.size == 1
 	  	    r[0]

data/lib/rfm/layout.rb

@@ -154,7 +154,7 @@ module Rfm
     end
     
     meta_attr_reader :db
-    #attr_reader :name #, :db
+    attr_reader :field_mapping
     attr_writer :field_names, :portal_meta, :table
     def_delegator :db, :server
     alias_method :database, :db
@@ -209,6 +209,8 @@ module Rfm
 	    #   myLayout.find 54321
 	    #
 	    def find(find_criteria, options = {})
+	    	#puts "layout.find-#{self}"
+	    	options.merge!({:field_mapping => field_mapping}) if field_mapping
 				get_records(*Rfm::CompoundQuery.new(find_criteria, options))
 	    end
 	    
@@ -264,12 +266,21 @@ module Rfm
 	    end
 	    
 	    def get_records(action, extra_params = {}, options = {})
-	    	# The grammar stuff here won't work properly until you handle config between models/sublayouts/layout/server.
+	    	# TODO: The grammar stuff here won't work properly until you handle config between
+	    	# models/sublayouts/layout/server (Is this done now?).
 	    	grammar_option = state(options)[:grammar]
 	    	options.merge!(:grammar=>grammar_option) if grammar_option
-	      include_portals = options[:include_portals] ? options.delete(:include_portals) : nil
-	      xml_response = server.connect(state[:account_name], state[:password], action, params.merge(extra_params), options).body
-	      #Rfm::Resultset.new(db.server, xml_response, self, include_portals)
+	      #include_portals = options[:include_portals] ? options.delete(:include_portals) : nil
+	      include_portals = !options[:ignore_portals]
+	      
+	      # Apply mapping from :field_mapping, to send correct params in URL.
+	      prms = params.merge(extra_params)
+	      map = field_mapping.invert
+	      # TODO: Make this part handle string AND symbol keys.
+	      #map.each{|k,v| prms[k]=prms.delete(v) if prms[v]}
+	      prms.dup.each_key{|k| prms[map[k.to_s]]=prms.delete(k) if map[k.to_s]}
+	      
+	      xml_response = server.connect(state[:account_name], state[:password], action, prms, options).body
 	      Rfm::Resultset.new(xml_response, self, include_portals)
 	    end
 	    
@@ -399,7 +410,7 @@ module Rfm
 
       # process field controls
       doc['FMPXMLLAYOUT']['LAYOUT']['FIELD'].each {|field|
-        name = field['NAME']
+        name = field_mapping[field['NAME']] || field['NAME']
         style = field['STYLE']
         type = style['TYPE']
         value_list_name = style['VALUELIST']
@@ -420,6 +431,18 @@ module Rfm
       @field_controls.freeze
     end
     
+		def field_mapping
+			@field_mapping ||= load_field_mapping(get_config[:field_mapping])
+		end
+		
+		def load_field_mapping(mapping={})
+			mapping = (mapping || {}).to_cih
+			def mapping.invert
+				super.to_cih
+			end
+			mapping
+		end
+    
   	private :load, :get_records, :params
       
       

data/lib/rfm/metadata/field.rb

@@ -63,8 +63,8 @@ module Rfm
       
       # Initializes a field object. You'll never need to do this. Instead, get your Field objects from
       # ResultSet::fields
-      def initialize(field)
-        @name        = field.name #['name']
+      def initialize(field, options={})
+        @name        = options[:field_mapping][field.name] || field.name rescue field.name #['name']
         @result      = field.result #['result']
         @type        = field.type #['type']
         @max_repeats = field.max_repeats #['max-repeats']
@@ -78,7 +78,7 @@ module Rfm
         return nil if (value.nil? or value.empty?)
         case self.result.downcase
         when "text"      then value
-        when "number"    then BigDecimal.new(value)
+        when "number"    then BigDecimal.new(value.to_s)
         when "date"      then Date.strptime(value, resultset.date_format)
         when "time"      then DateTime.strptime("1/1/-4712 #{value}", "%m/%d/%Y #{resultset.time_format}")
         when "timestamp" then DateTime.strptime(value, resultset.timestamp_format)

data/lib/rfm/record.rb

@@ -126,7 +126,7 @@ module Rfm
       
       record.columns.each do |field|
       	next unless field
-        field_name = field.name
+        field_name = @layout.field_mapping[field.name] || field.name rescue field.name
         field_name.gsub!(Regexp.new(portal + '::'), '') if portal
         datum = []
         data = field.data #['data']; data = data.is_a?(Hash) ? [data] : data
@@ -225,7 +225,7 @@ module Rfm
     def []=(key, value)
       key_string = key.to_s.downcase
       return super unless @loaded # is this needed?
-      raise Rfm::ParameterError, "You attempted to modify a field that does not exist in the current Filemaker layout." unless self.key?(key_string)
+      raise Rfm::ParameterError, "You attempted to modify a field (#{key_string}) that does not exist in the current Filemaker layout." unless self.key?(key_string)
       # @mods[key_string] = value
       # TODO: This needs cleaning up.
       # TODO: can we get field_type from record instead?

data/lib/rfm/resultset.rb

@@ -155,7 +155,8 @@ module Rfm
       	return if doc.fields.blank?
 
         doc.fields.each do |field|
-          @field_meta[field.name] = Rfm::Metadata::Field.new(field)
+        	name = layout.field_mapping[field.name] || field.name rescue field.name
+          @field_meta[name] = Rfm::Metadata::Field.new(field)
         end
         (layout.field_names = field_names) if layout and layout.field_names_no_load.blank?
       end

data/lib/rfm/server.rb

@@ -368,6 +368,9 @@ module Rfm
         result = {}
         options.each do |key,value|
           case key
+          when :max_portal_rows
+          	result['-relatedsets.max'] = value
+          	result['-relatedsets.filter'] = 'layout'
           when :max_records
             result['-max'] = value
           when :skip_records

data/lib/rfm/utilities/compound_query.rb

@@ -8,7 +8,7 @@ module Rfm
 	# Also allow find requests to be :omit.
   class CompoundQuery < Array
   
-  	attr_accessor :original_input, :query_type, :key_values, :key_arrays, :key_map, :key_map_string, :key_counter
+  	attr_accessor :original_input, :query_type, :key_values, :key_arrays, :key_map, :key_map_string, :key_counter, :field_mapping
   	
   	def self.build_test
   		new([{:field1=>['val1a','val1b','val1c'], :field2=>'val2'},{:omit=>true, :field3=>'val3', :field4=>'val4'}, {:omit=>true, :field5=>['val5a','val5b'], :field6=>['val6a','val6b']}], {})
@@ -22,6 +22,7 @@ module Rfm
   	# Returns self as ['-fmpaction', {:hash=>'of', :key=>'values'}, {:options=>'hash'}]
   	def initialize(query, options={})
   		@options = options
+  		@field_mapping = options.delete(:field_mapping)
   		@original_input = query
 			@key_values = {}
 			@key_arrays = []
@@ -76,7 +77,7 @@ module Rfm
 				query_tag = []
 				val = val.rfm_force_array
 				val.each do |v|
-					@key_values["-q#{key_counter}"] = key
+					@key_values["-q#{key_counter}"] = field_mapping.invert[key] || key
 					@key_values["-q#{key_counter}.value"] = v
 					query_tag << "q#{key_counter}"
 					@key_counter += 1

data/lib/rfm/utilities/config.rb

@@ -25,6 +25,7 @@ module Rfm
 			use
 			parent
 			grammar
+			field_mapping
 		)
 		
 		CONFIG_DONT_STORE = %w(strings using parents symbols objects)

data/lib/rfm/utilities/core_ext.rb

@@ -118,16 +118,23 @@ end # Array
 class Hash
 	# TODO: Possibly deprecated, delete if not used.
 	def rfm_only(*keepers)
-		self.each_key {|k| self.delete(k) if !keepers.include?(k)}
+		self.dup.each_key {|k| self.delete(k) if !keepers.include?(k)}
 	end
 	
 	def rfm_filter(*args)
 		options = args.rfm_extract_options!
 		delete = options[:delete]
-		self.each_key do |k|
+		self.dup.each_key do |k|
 			self.delete(k) if (delete ? args.include?(k) : !args.include?(k))
 		end
 	end
+	
+	# Convert hash to Rfm::CaseInsensitiveHash
+	def to_cih
+		new = Rfm::CaseInsensitiveHash.new
+		self.each{|k,v| new[k] = v}
+		new
+	end
 end # Hash
 
 # Allows access to superclass object

metadata

@@ -1,17 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ginjo-rfm
-version: !ruby/object:Gem::Version 
-  hash: 1923832061
-  prerelease: 6
-  segments: 
-  - 2
-  - 1
-  - 0
-  - pre
-  - 2
-  version: 2.1.0.pre02
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Geoff Coffey
 - Mufaddal Khumri
 - Atsushi Matsuo
@@ -20,179 +13,212 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 3
-        - 5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.5
-  requirement: *id001
-  name: activesupport
   type: :runtime
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
   name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.3.0
-  requirement: *id005
-  name: rspec
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id006
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
   name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id007
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id008
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id009
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id010
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id011
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: ox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-description: Rfm lets your Ruby scripts and Rails applications talk directly to your Filemaker server. Ginjo-rfm includes ActiveModel compatibility, multiple XML parsers, compound Filemaker find requests, and a configuration API.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rfm lets your Ruby scripts and Rails applications talk directly to your
+  Filemaker server. Ginjo-rfm includes ActiveModel compatibility, multiple XML parsers,
+  compound Filemaker find requests, and a configuration API.
 email: http://groups.google.com/group/rfmcommunity
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
 - CHANGELOG.md
 - lib/rfm/VERSION
-files: 
+files:
 - lib/rfm/base.rb
 - lib/rfm/database.rb
 - lib/rfm/error.rb
@@ -224,41 +250,33 @@ files:
 - CHANGELOG.md
 homepage: https://rubygems.org/gems/ginjo-rfm
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1763595399021498150
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby to Filemaker adapter
 test_files: []
-
 has_rdoc: