ginjo-rfm 3.0.5 → 3.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWQ1ODlhYTI5ZDM2OTkxNDc3MGE5MGEyZjM4YWI2YTA0MzIyMTM1OA==
+    MmNhZWFmOTQwYTY4NmFmN2ZhMmQzZDk0YWNmOWQ5YzFlMWY2MWMwZg==
   data.tar.gz: !binary |-
-    NzgwMmY2OTA3OTZkMzYxZTQ2ZmE2NzY1YmFkYmJhMzUxOGEwMGNlYw==
+    YjIxYzQzZTViMjQ3ZTFlMzRlOTlkNGI0ZTNjOTliMTAyMWJkOTRjYQ==
 SHA512:
   metadata.gz: !binary |-
-    NzVmNWUwZmNlNTAxNmIwNzNlNDkxMDU4NTE3YWY1YzU1ZDg0MDIzZjFhNWVj
-    MTNkZmJhN2QxNDBmOTY4NzE1MzRhMjU4MjIzNGZlODNlZjVhYmVlNTUwMWRk
-    YzU0ZDBkNDRhNjk3MjFhNDBjNzRmNjBjODU5NmY4MmQ1MjgwZjE=
+    NDE4Mjk4MDVkODMzZGIyYjhmN2VjM2NlYzdmZjY3NWUzNzgyMTUzMjgzNjFj
+    MmNmZTYxOTYwMzA0YzcxZWM2MWYyMzY4YzgxZDQxZmFlZjhhNzUyZDYwYzE0
+    NWE3YzczMmRjNTYxOTY5NTcwNjFkZWUwNGY5MjJlY2NkMmQ3NDc=
   data.tar.gz: !binary |-
-    ODZlYmU4ZTAwMmI3M2FjZDA0ZjE5MDk0NzNhNmNkODJmOTc5NmUxZmI0YzU5
-    OTUxNTM4OTUxZjA5NTdkOTE0ZTZlNjAxMGI3NWMxY2FiOTJmNTJhODQxNDhh
-    N2IxN2VjOWQ0ZDlhMTU0NzNjYjU3NGI3ZTJhOTk0NDM3MGQ1NDM=
+    NjExN2ZkNGVlY2RjMGEyZDIwYTgzMzk3NzA1OGVkODUwOGZjZWUwNmU4OTQ2
+    MzU2NWE2NTExODEzZThhZTY5ZDYxMWFkYjE2MjVhYjI1ZTFmZWEyNDE3OThm
+    MmM5ZTY1NDhiNDcxODZjZDg3ZDA0Y2E4YzE2Mzg2MDljYTBiZTY=

data/README.md

@@ -1,3 +1,20 @@
+<!--
+	See YARD documentation - https://github.com/lsegal/yard/wiki/GettingStarted
+	
+	Yard is not the same as markdown - Yard is for ruby and can use any markup language,
+	whereas Markdown is just another markup language.
+	
+	Rubydoc.info uses yard and can use markdown and other markup languages.
+	To update ginjo-rfm's yard documentation from github's master branch,
+	first find 'rfm' on rubydoc.info, then in list-view click the update button
+	on the right of the screen.
+	To preview this file in yard, run 'rake yard'
+	
+	Github uses markdown or rdoc (maybe others?).
+	To preview this file in plain markdown, edit in TextMate and
+	choose Bundles/Markdown/Preview menu option.
+-->
+
 # 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).
@@ -14,27 +31,18 @@ Ginjo-rfm version 3 has been tested successfully on Ruby 1.8.7, 1.9.3, 2.0.0, an
 * Original homepage   <http://sixfriedrice.com/wp/products/rfm/>
 * Lardawge at github  <https://github.com/lardawge/rfm>
 
-## New in version  3.0
-
-There are many changes in version 3, but most of them are under the hood. Here are some highlights.
-
-* Compatibility with Ruby 2.1.2 (and 2.0.0, 1.9.3, 1.8.7).
-
-* XML parsing rewrite.
-The entire XML parsing engine of Rfm has been rewritten to use only the sax/stream parsing schemes of the supported Ruby XML parsers (libxml-ruby, nokogiri, ox, rexml). There were two main goals in this rewrite: 1, to separate the xml parsing code from the Rfm/Filemaker objects, and 2, to remove the hard dependency on ActiveSupport. See below for parsing configuration options.
-
-* Better logging capabilities.
-Added Rfm.logger, Rfm.logger=, Config.logger, Config#logger, and config(:logger=>(...)).
+## Requirements
 
-* Added field-mapping awareness to :sort_field query option.
+Ginjo-rfm should run on any machine with a standard ruby installation. Ginjo-rfm's primary function is to interact with Filemaker Server,
+however ginjo-rfm does not have to be installed on your Filemaker server - it can be installed on any machine that has network/internet access
+to your Filemaker server.
 
-* Relaxed requirement that query option keys be symbols - can now be strings or symbols.
+Ginjo-rfm will work with any Filemaker server that supports the fmresultset.xml grammar over the http protocol.
+Since Filemaker Pro client does not support this, Filemaker server is required. Follow Filemaker Server's instructions
+for setting up "Custom Web Publishing".
 
-* Detached resultset from record, so record doesn't drag resultset around with it.
-
-* Bug fixes and refinements in modeling, configuration, metadata access, and Rfm object instantiation.
-
-See the changelog or the commit history for more details on changes in ginjo-rfm v3.
+Ginjo-rfm works great with Rails, but it does not require Rails.
+You can write simple and powerful stand-alone ruby scripts that use ginjo-rfm to talk to a Filemaker server.
 
 ## Download & Installation
 
@@ -60,9 +68,9 @@ Note that while this gem is officially named "ginjo-rfm", you require/load it in
 
 ## Ginjo-rfm Basic Usage
 
-The first step in getting connected to your Filemaker databases with Rfm is to store your configuration settings in a yaml file or in the RFM_CONFIG hash. The second step is creating a Ruby class (often referred to as a "model" in this documentation) that represent a layout in your Filemaker database. Create as many models as you wish, each pointing to a layout/table-occurrence that you want to work with. The third step is using your new models to query, create, update, and delete records in your Filemaker database. Here's an example setup for a simple order-item table.
+The first step in getting connected to your Filemaker databases with Rfm (assuming your Filemaker Server is properly set up - see the Filemaker Server instructions for "Custom Web Publishing") is to store your configuration settings in a yaml file or in the RFM_CONFIG hash. The second step is creating a Ruby class (often referred to as a "model" in this documentation) that represent a layout in your Filemaker database. Create as many models as you wish, each pointing to a layout/table-occurrence that you want to work with. The third step is using your new models to query, create, update, and delete records in your Filemaker database. Here's an example setup for a simple order-item table.
 
-rfm.yml
+config/rfm.yml
 
 		:host: my.host.com
 		:account_name: myname
@@ -215,7 +223,7 @@ See `Rfm::Config::CONFIG_KEYS` for a list of currently allowed configuration opt
 
 ### Using Models
 
-Rfm models provide easy access, modeling, and persistence of your Filemaker data.
+Rfm models provide easy access, modeling, and persistence of your Filemaker data. A ginjo-rfm model is basically an alias to a specific layout in your Filemaker database and provides all of the query options found in a classic rfm layout object. The model and/or the layout object is where you do most of your work with rfm. For more details about what methods and options are available to a model or layout object, see the documentation for the {Rfm::Layout} and {Rfm::Base} classes.
 
 	   class User < Rfm::Base
 	     config :layout => 'my_user_layout'
@@ -637,7 +645,29 @@ Repeating field compatibility, more coverage of Filemaker's query syntax, more e
 
 
 
-## Previous Version Highlights
+## Version Highlights
+
+### Version  3.0
+
+There are many changes in version 3, but most of them are under the hood. Here are some highlights.
+
+* Compatibility with Ruby 2.1.2 (and 2.0.0, 1.9.3, 1.8.7).
+
+* XML parsing rewrite.
+The entire XML parsing engine of Rfm has been rewritten to use only the sax/stream parsing schemes of the supported Ruby XML parsers (libxml-ruby, nokogiri, ox, rexml). There were two main goals in this rewrite: 1, to separate the xml parsing code from the Rfm/Filemaker objects, and 2, to remove the hard dependency on ActiveSupport. See below for parsing configuration options.
+
+* Better logging capabilities.
+Added Rfm.logger, Rfm.logger=, Config.logger, Config#logger, and config(:logger=>(...)).
+
+* Added field-mapping awareness to :sort_field query option.
+
+* Relaxed requirement that query option keys be symbols - can now be strings or symbols.
+
+* Detached resultset from record, so record doesn't drag resultset around with it.
+
+* Bug fixes and refinements in modeling, configuration, metadata access, and Rfm object instantiation.
+
+See the changelog or the commit history for more details on changes in ginjo-rfm v3.
 
 ### Version 2.1
 

data/lib/rfm/VERSION

@@ -1 +1 @@
-3.0.5
+3.0.6

data/lib/rfm/metadata/datum.rb

@@ -26,7 +26,7 @@ module Rfm
 				field = resultset.portal_meta[table.downcase][name.downcase]
 				data = @attributes['data']
 				#puts ['DATUM_portal_callback_02', resultset.class, table, name, field, data].join(', ')
-				#(y resultset.portal_meta) unless field
+				#(puts resultset.portal_meta.to_yaml) unless field
 				cursor.parent.object[name.downcase] = field.coerce(data)
 			end
       

data/lib/rfm/utilities/sax_parser.rb

@@ -950,7 +950,7 @@ class Object
 				instance_variable_get("@#{name}")[delimit_name]=obj
 				# 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_object!(obj, delimit_name, nil, nil, nil)
+				instance_variable_get("@#{name}")._merge_delimited_object!(obj, delimit_name)
 			else
 				#puts ["\_setting_existing_instance_var", name]
 				if name == options[:text_label]
@@ -970,6 +970,15 @@ class Object
 		rslt
 	end
 	
+	def _merge_delimited_object!(obj, delimit_name)
+		case
+		when self[delimit_name].nil?; self[delimit_name] = obj
+		when self[delimit_name].is_a?(Hash); self[delimit_name].merge!(obj)
+		when self[delimit_name].is_a?(Array); self[delimit_name] << obj
+		else self[delimit_name] = [self[delimit_name], obj]
+		end
+	end
+	
 	# Get an instance variable, a member of a shared instance variable, or a hash value of self.
   def _get_attribute(name, shared_var_name=nil, options={})
   	return unless name
@@ -1041,6 +1050,7 @@ class Array
 end # Array
 
 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
@@ -1053,10 +1063,9 @@ 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
+				#self[name][delimit_name]=obj
 				# This is supposed to handle multiple elements who's delimiter value is the SAME.
-				#obj.instance_variable_set(:@_index_, 0)
-				#self[name]._merge_object!(obj, delimit_name, nil, nil, nil)
+				self[name]._merge_delimited_object!(obj, delimit_name)
 			else
 				if name == options[:text_label]
 					self[name] << obj.to_s
@@ -1065,7 +1074,7 @@ class Hash
 					self[name] << obj
 				end
 			end
-			_create_accessor(name) if (options[:create_accessors] & ['all','shared','hash']).any?
+			_create_accessor(name) if (options[:create_accessors].to_a & ['all','shared','hash']).any?
 			
 			rslt
 		else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ginjo-rfm
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Geoff Coffey
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel