ginjo-rfm 3.0.8 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a124ce5cf138e1c46547069cc547a46f4692827
-  data.tar.gz: 597d7eaa2f436d8d224340f2d3bdb4a090b8113f
+  metadata.gz: d2a03d23cf578b34173f800b1658fe22465b2736
+  data.tar.gz: 02f0520fabc22fdaf653d02b1afa1b43867e65c9
 SHA512:
-  metadata.gz: 00974925e3e0434eb7056421575f35d4bf2e567e79eb6c9a8b4d88d42d39cba3ed77514d0aaa592e148aaf541c1abdbbffbe381ab4805ab64f510c9b6371b5aa
-  data.tar.gz: 3c9fe4a727cae3c8d24fa4ccef9244ec9edb82522bb7a227c3b95c8ddbdd5654102ed197b0bf8b7cc077c729ef308810d0ff36270ab0dc1f3b1c71844faadc09
+  metadata.gz: fd1ad124d35792b2959dbb3a6f82d0534c303dee8686df59cdf963e255778e843b32cab896437b8e07082d65a2b2f43bd8a27bc4f9a825c15fad892ac0f16773
+  data.tar.gz: dd657b7d1a9fd7c4b85728da57e29fe6d480733bcf7d4ad65f32fbe34e3c6e033148d715198e8c84bb08985f30ef9a0dbce4f0bedcba9d0925b5676c56fad0e2

data/CHANGELOG.md

@@ -1,10 +1,20 @@
 # Changelog
 
+## Ginjo-Rfm 3.0.9
+
+* Fixed bug in parser that was appending each portal array recursively to itself.
+
+* Sax parser template option :template now takes a full-path string.
+
+* Compatible with dm-filemaker-adapter (for DataMapper ORM).
+
+* Config now recognizes :template option, allowing alternative parsing templates.
+
 ## Ginjo-Rfm 3.0.8
 
 * Implemented proxy option for database connections thru a proxy server.
 
-	  config :proxy=>['my.proxy.com', 8888]
+		config :proxy=>['my.proxy.com', 8888]
 	
 * Implemented erb parsing of config.yml
 	
@@ -212,8 +222,8 @@
 
 	Example:  
   
-	    server.db.all #=> ['dbname1', 'dbname2', ...]
-	    server.db     #=> a DbFactory object (descendant of Hash), containing 0 or more Database objects
+		server.db.all #=> ['dbname1', 'dbname2', ...]
+		server.db     #=> a DbFactory object (descendant of Hash), containing 0 or more Database objects
 
 ## Lardawge-Rfm 1.4.2 (unreleased)
   
@@ -221,8 +231,8 @@
   
 	Example:
  
-	    Old: record.john #=> "" 
-	    New: record.john #=> nil
+		Old: record.john #=> "" 
+		New: record.john #=> nil
    
 ## Lardawge-Rfm 1.4.1.2
 
@@ -244,11 +254,11 @@
 
 	Example:  
   
-	    result = fm_server('layout').find({:username => "==#{username}"}, {:include_portals => true})
-	    # => This will fetch all records with portal records attached.
-  
-	    result.first.portals
-	    # => would return an empty hash by default.
+		result = fm_server('layout').find({:username => "==#{username}"}, {:include_portals => true})
+		# => This will fetch all records with portal records attached.
+
+		result.first.portals
+		# => would return an empty hash by default.
     
 * Internal file restructuring. Some classes have changed but it should be nothing a developer would use API wise. Please let me know if it is.
 

data/README.md

@@ -17,7 +17,7 @@
 
 # ginjo-rfm
 
-Rfm is a Ruby-Filemaker adapter, a Ruby Gem that provides an interface between Filemaker Server and Ruby. Query your Filemaker database, browse result records as persistent objects, and create/update/delete records with a syntax similar to ActiveRecord. Ginjo-rfm picks up from the lardawge-rfm gem and continues to refine code and fix bugs. Version 3 removes the dependency on ActiveSupport and is now a completely independent Gem, able to run most of its core features without requiring any other supporting Gems. ActiveModel features can be activated by adding activemodel to your Gemfile (or requiring activemodel manually).
+Rfm is a Ruby-Filemaker adapter, a gem that provides an interface between Filemaker Server and Ruby. Query your Filemaker database, browse result records as persistent objects, and create/update/delete records with a syntax similar to ActiveRecord. Ginjo-rfm picks up from the lardawge-rfm gem and continues to refine code and fix bugs. Version 3 removes the dependency on ActiveSupport and is now a completely independent Gem, able to run most of its core features without requiring any other supporting Gems. ActiveModel features can be activated by adding activemodel to your Gemfile (or requiring activemodel manually).
 
 Ginjo-rfm version 3 has been tested successfully on Ruby 1.8.7 thru 2.1.3.
 

data/lib/rfm/VERSION

@@ -1 +1 @@
-3.0.8
+3.0.9

data/lib/rfm/layout.rb

@@ -316,11 +316,13 @@ module Rfm
       	else
 	      	prms[new_key]=prms.delete(k) if new_key != k
       	end
+      	#puts "PRMS: #{new_key} #{prms[new_key].class} #{prms[new_key]}"
       end
 			
 			#c = Connection.new(action, prms, options, state.merge(:parent=>self))
 			c = Connection.new(action, prms, options, self)
-			rslt = c.parse(template || :fmresultset, Rfm::Resultset.new(self, self))
+			#rslt = c.parse(template || :fmresultset, Rfm::Resultset.new(self, self))
+			rslt = c.parse(template, Rfm::Resultset.new(self, self))
 			capture_resultset_meta(rslt) unless @resultset_meta
 			rslt
     end

data/lib/rfm/metadata/datum.rb

@@ -21,11 +21,11 @@ module Rfm
 			def portal_field_element_close_callback(cursor)
 				resultset = cursor.top.object
 				table, name = @attributes['name'].to_s.split('::')
-				#puts ['DATUM_portal_callback_01', table, name].join(', ')
+				#puts ['DATUM_portal_field_element_close_callback_01', table, name].join(', ')
 				name = get_mapped_name(name, resultset)
 				field = resultset.portal_meta[table.downcase][name.downcase]
 				data = @attributes['data']
-				#puts ['DATUM_portal_callback_02', resultset.class, table, name, field, data].join(', ')
+				#puts ['DATUM_portal_field_element_close_callback_02', "cursor.parent.object.class: #{cursor.parent.object.class}", "resultset.class: #{resultset.class}", "table: #{table}", "name: #{name}", "field: #{field}", "data: #{data}"]
 				#(puts resultset.portal_meta.to_yaml) unless field
 				cursor.parent.object[name.downcase] = field.coerce(data)
 			end

data/lib/rfm/utilities/config.rb

@@ -33,6 +33,7 @@ module Rfm
 			log_parser
 			use
 			parent
+			template
 			grammar
 			field_mapping
 			capture_strings_with

data/lib/rfm/utilities/connection.rb

@@ -46,6 +46,7 @@ module Rfm
         :raise_on_401 => false,
         :timeout => 60,
         :ignore_bad_data => false,
+        :template => :fmresultset,
         :grammar => 'fmresultset'
       }   #.merge(options)
 	
@@ -78,7 +79,8 @@ module Rfm
     end
     
     def parse(template=nil, initial_object=nil, parser=nil, options={})
-    	(template =  'fmresultset.yml') unless template
+    	template ||= state[:template]
+    	#(template =  'fmresultset.yml') unless template
     	#(template = File.join(File.dirname(__FILE__), '../sax/', template)) if template.is_a? String
     	Rfm::SaxParser.parse(connect.body, template, initial_object, parser, state(*options)).result
     end

data/lib/rfm/utilities/sax_parser.rb

@@ -54,11 +54,12 @@
 #
 # YAML structure defining a SAX xml parsing template.
 # Options:
-#   initialize_with:						string, symbol, or array (object, method, params...). Should return new object. See Rfm::SaxParser::Cursor#get_callback.
+#   initialize_with:	OBSOLETE?	string, symbol, or array (object, method, params...). Should return new object. See Rfm::SaxParser::Cursor#get_callback.
 #   elements:										array of element hashes [{'name'=>'element-tag'},...]
 #   attributes:									array of attribute hashes {'name'=>'attribute-name'} UC
-#   class:                      string-or-class: class name for new element
+#   class:											string-or-class: class name for new element
 #		attach:											string: shared, _shared_var_name, private, hash, array, cursor, none - how to attach this element or attribute to #object. 
+#																array: [0]string of above, [1..-1]new_element_callback options (see get_callback method).
 #		attach_elements:						string: same as 'attach' - how to attach ANY subelements to this model's object, unless they have their own 'attach' specification.
 #		attach_attributes:					string: same as 'attach' - how to attach ANY attributes to this model's object, unless they have their own 'attach' specification.
 #   before_close:								string, symbol, or array (object, method, params...). See Rfm::SaxParser::Cursor#get_callback.
@@ -66,7 +67,7 @@
 #   delimiter:									string: attribute/hash key to delineate objects with identical tags
 #		create_accessors:   				string or array: all, private, shared, hash, none
 #		accessor:   								string: all, private, shared, hash, none
-#		element_handler:						string, symbol, or array (object, method, params...). Should return new object. See Rfm::SaxParser::Cursor#get_callback.
+#		element_handler:	NOT-USED?	string, symbol, or array (object, method, params...). Should return new object. See Rfm::SaxParser::Cursor#get_callback.
 # 															Default attach prefs are 'cursor'.
 #																Use this when all new-element operations should be offloaded to custom class or module.
 #																Should return an instance of new object.
@@ -216,7 +217,7 @@ module Rfm
 			  end
 			  
 		    def receive_start_element(_tag, _attributes)
-			    #puts ["\nRECEIVE_START '#{_tag}'", "current_object: #{@object.class}", "current_model: #{@model}"]
+			    #puts ["\nRECEIVE_START '#{_tag}'", "current_object: #{@object.class}", "current_model: #{@model['name']}", "attributes #{_attributes}"]
 					new_cursor = Cursor.new(_tag, @handler, self, _attributes) #, binding)
 					new_cursor.process_new_element(binding)
 
@@ -262,11 +263,15 @@ module Rfm
 						@object = new_element || DEFAULT_CLASS.allocate
 			      
 						if @initial_attributes && @initial_attributes.any? #&& @attribute_attachment_prefs != 'none'
+							#puts "PROCESS_NEW_ELEMENT calling assign_attributes with ATTRIBUTES #{@initial_attributes}"
 			    	  assign_attributes(@initial_attributes) #, @object, @model, @local_model) 
 			    	end
 			      
+			      # If @local_model has a delimiter, defer attach_new_element until later.
+			      #puts "PROCESS_NEW_ELEMENT delimiter of @local_model #{delimiter?(@local_model)}"
 						if !delimiter?(@local_model) 
   						#attach_new_object(@parent.object, @object, @tag, @parent.model, @local_model, 'element')
+  						#puts "PROCESS_NEW_ELEMENT calling attach_new_element with TAG #{@tag} and OBJECT #{@object}"
   						attach_new_element(@tag, @object)
   					end  		
 		    	end
@@ -289,6 +294,7 @@ module Rfm
 						
 	      		if (delimiter = delimiter?(@local_model); delimiter && !['none','cursor'].include?(@element_attachment_prefs.to_s))
   						#attach_new_object(@parent.object, @object, @tag, @parent.model, @local_model, 'element')
+  						#puts "RECEIVE_END_ELEMENT attaching new element TAG (#{@tag}) OBJECT (#{@object.class}) #{@object.to_yaml} WITH LOCAL MODEL #{@local_model.to_yaml} TO PARENT (#{@parent.object.class}) #{@parent.object.to_yaml} PARENT MODEL #{@parent.model.to_yaml}"
   						attach_new_element(@tag, @object)
   					end  		
 
@@ -316,21 +322,22 @@ module Rfm
 		    end
 		    
 		    ###  Parse callback instructions, compile & send callback method  ###
+		    ###  TODO: This is way too convoluted. Document it better, or refactor!!!
 		    # This method will send a method to an object, with parameters, and return a new object.
-		    # Input: string, symbol, or array of strings
+		    # Input (first param): string, symbol, or array of strings
 		    # Returns: object
 		    # Default options:
 		    #   :object=>object
 		    #   :method=>'a method name string or symbol'
 		    #   :params=>"params string to be eval'd in context of cursor"
 		    # Usage:
-		    #   callback: send a method (or eval string) to an object with parameters.
-		    #   string: a string to be eval'd in context of current object.
-		    #   symbol: method to be called on current object.
-		    #   array: object, method, params.
-		    #     object: <object or string>
-		    #     method: <string or symbol>
-		    #     params: <string>
+		    #   callback: send a method (or eval string) to an object with parameters, consisting of...
+				# 	  string: a string to be eval'd in context of current object.
+				# 	  or symbol: method to be called on current object.
+				# 	  or array: object, method, params.
+				# 	    object: <object or string>
+				# 	    method: <string or symbol>
+				# 	    params: <string>
 		    #
 		    # TODO-MAYBE: Change param order to (method, object, params),
 		    #             might help confusion with param complexities.
@@ -460,7 +467,7 @@ module Rfm
 				#     # end
 				# 	end
 				
-				def attach_new_element(name, new_object)   #(base_object, new_object, name, base_model, new_model, type)
+				def attach_new_element(name, new_object)   #old params (base_object, new_object, name, base_model, new_model, type)
 					label = label_or_tag(name, @local_model)
 					
 					# Was this, which works fine, but not as efficient:
@@ -481,9 +488,8 @@ module Rfm
           # end
 					
 					
-					#puts ["\nATTACH_NEW_ELEMENT 1", "type: #{type}", "label: #{label}", "base_object: #{base_object.class}", "new_object: #{new_object.class}", "delimiter: #{delimiter?(new_model)}", "prefs: #{prefs}", "shared_var_name: #{shared_var_name}", "create_accessors: #{create_accessors}"]
+					#puts ["\nATTACH_NEW_ELEMENT 1", "new_object: #{new_object}", "parent_object: #{@parent.object}", "label: #{label}", "delimiter: #{delimiter?(@local_model)}", "prefs: #{prefs}", "shared_var_name: #{shared_var_name}", "create_accessors: #{create_accessors}"]
 					@parent.object._attach_object!(new_object, label, delimiter?(@local_model), prefs, 'element', :default_class=>DEFAULT_CLASS, :shared_variable_name=>shared_var_name, :create_accessors=>create_accessors)
-					#puts ["\nATTACH_NEW_ELEMENT 2: #{base_object.class} with ", label, delimiter?(new_model), prefs, type, :shared_variable_name=>shared_var_name, :create_accessors=>create_accessors]
           # if type == 'attribute'
           #   puts ["\nATTACH_ATTR", "name: #{name}", "label: #{label}", "new_object: #{new_object.class rescue ''}", "base_object: #{base_object.class rescue ''}", "base_model: #{base_model['name'] rescue ''}", "new_model: #{new_model['name'] rescue ''}", "prefs: #{prefs}"]
           # end
@@ -685,10 +691,12 @@ module Rfm
 			
 			# Does the heavy-lifting of template retrieval.
 			def load_template(dat)
+				#puts "DAT: #{dat}, class #{dat.class}"
 				prefix = defined?(TEMPLATE_PREFIX) ? TEMPLATE_PREFIX : ''
 				#puts "SaxParser::Handler#load_template... 'prefix' is #{prefix}"
 		  	rslt = case
 		  		when dat.is_a?(Hash); dat
+		  		when (dat.is_a?(String) && dat[/^\//]); YAML.load_file dat
 		  		when dat.to_s[/\.y.?ml$/i]; (YAML.load_file(File.join(*[prefix, dat].compact)))
 		  		# This line might cause an infinite loop.
 		  		when dat.to_s[/\.xml$/i]; self.class.build(File.join(*[prefix, dat].compact), nil, {'compact'=>true})
@@ -696,6 +704,8 @@ module Rfm
 		  		when dat.is_a?(String); YAML.load dat
 		  		else DEFAULT_CLASS.new
 		  	end
+		  	#puts rslt
+		  	rslt
 			end
 		  
 		  def result
@@ -892,7 +902,7 @@ class Object
 
 	# Master method to attach any object to this object.
 	def _attach_object!(obj, *args) # name/label, collision-delimiter, attachment-prefs, type, *options: <options>
-		#puts ["\nATTACH_OBJECT._attach_object", self.class, obj.class, obj.to_s, args].to_yaml
+		#puts ["\nATTACH_OBJECT._attach_object", "self.class: #{self.class}", "obj.class: #{obj.class}", "obj.to_s: #{obj.to_s}", "args: #{args}"]
 		options = ATTACH_OBJECT_DEFAULT_OPTIONS.merge(args.last.is_a?(Hash) ? args.pop : {}){|key, old, new| new || old}
 		# 	name = (args[0] || options[:name])
 		# 	delimiter = (args[1] || options[:delimiter])
@@ -915,6 +925,8 @@ class Object
 	# 		else
 	# 			self._merge_object!(obj, 'unknown_name', delimiter, prefs, type, options)
 	# 		end
+	#puts ["\nATTACH_OBJECT RESULT", self.to_yaml]
+	#puts ["\nATTACH_OBJECT RESULT PORTALS", (self.portals.to_yaml rescue 'no portals')]
 	end
 	
 	# Master method to merge any object with this object
@@ -939,7 +951,7 @@ class Object
 	
 	# Merge a named object with the specified instance variable of self.
 	def _merge_instance!(obj, name, delimiter, prefs, type, options={})
-		#puts ["\n_merge_instance!", self.class, obj.class, name, delimiter, prefs, type, options.keys, '_end_merge_instance!'].join(', ')
+		#puts ["\nOBJECT._merge_instance!", "self.class: #{self.class}", "obj.class: #{obj.class}", "name: #{name}", "delimiter: #{delimiter}", "prefs: #{prefs}", "type: #{type}", "options.keys: #{options.keys}", '_end_merge_instance!']  #.join(', ')
 		rslt = if instance_variable_get("@#{name}") || delimiter
 			if delimiter
 				delimit_name = obj._get_attribute(delimiter, options[:shared_variable_name]).to_s.downcase
@@ -947,7 +959,13 @@ class Object
 				#instance_variable_set("@#{name}", instance_variable_get("@#{name}") || options[:default_class].new)[delimit_name]=obj
 				# This line is more efficient than the above line.
 				instance_variable_set("@#{name}", options[:default_class].new) unless instance_variable_get("@#{name}")
-				instance_variable_get("@#{name}")[delimit_name]=obj
+				
+				# This line was active in 3.0.9.pre01, but it was inserting each portal array as an element in the array,
+				# after all the Rfm::Record instances had been added. This was causing an potential infinite recursion situation.
+				# I don't think this line was supposed to be here - was probably an older piece of code.
+				#instance_variable_get("@#{name}")[delimit_name]=obj
+				
+				#instance_variable_get("@#{name}")._merge_object!(obj, delimit_name, nil, nil, nil)
 				# Trying to handle multiple portals with same table-occurance on same layout.
 				# In parsing terms, this is trying to handle multiple elements who's delimiter field contains the SAME delimiter data.
 				instance_variable_get("@#{name}")._merge_delimited_object!(obj, delimit_name)
@@ -971,6 +989,8 @@ class Object
 	end
 	
 	def _merge_delimited_object!(obj, delimit_name)
+		#puts "MERGING DELIMITED OBJECT self #{self.class} obj #{obj.class} delimit_name #{delimit_name}"
+
 		case
 		when self[delimit_name].nil?; self[delimit_name] = obj
 		when self[delimit_name].is_a?(Hash); self[delimit_name].merge!(obj)
@@ -1053,7 +1073,7 @@ class Hash
 	
 	def _merge_object!(obj, name, delimiter, prefs, type, options={})
 		#puts ["\n*****HASH._merge_object", "type: #{type}", "name: #{name}", "self.class: #{self.class}", "new_obj: #{(obj.to_s rescue obj.class)}", "delimiter: #{delimiter}", "prefs: #{prefs}", "options: #{options}"]
-		case
+		output = case
 		when prefs=='shared'
 			_merge_shared!(obj, name, delimiter, prefs, type, options)
 		when prefs=='private'
@@ -1063,6 +1083,7 @@ class Hash
 				delimit_name =  obj._get_attribute(delimiter, options[:shared_variable_name]).to_s.downcase
 				#puts "MERGING delimited object with hash: self '#{self.class}' obj '#{obj.class}' name '#{name}' delim '#{delimiter}' delim_name '#{delimit_name}' options '#{options}'"
 				self[name] ||= options[:default_class].new
+				
 				#self[name][delimit_name]=obj
 				# This is supposed to handle multiple elements who's delimiter value is the SAME.
 				self[name]._merge_delimited_object!(obj, delimit_name)
@@ -1080,9 +1101,11 @@ class Hash
 		else
 			rslt = self[name] = obj
 			_create_accessor(name) if (options[:create_accessors] & ['all','shared','hash']).any?
-			#puts ["\nRESULT", self.to_yaml]
 			rslt
 		end
+		#puts ["\n*****HASH._merge_object! RESULT", self.to_yaml]
+		#puts ["\n*****HASH._merge_object! RESULT PORTALS", (self.portals.to_yaml rescue 'no portals')]
+		output
 	end
 	
 	# 	def _create_accessors options=[]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ginjo-rfm
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.0.9
 platform: ruby
 authors:
 - Geoff Coffey
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel