ginjo-rfm 2.1.7 → 3.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTliMjcxMTMwOTViNmIyY2JlZTY4NTNiZGU2MjU2ZmFjMjhlOTYxMA==
+  data.tar.gz: !binary |-
+    YjA0MGJhNDhiZjZiZjM2NmQzNTBmYzI3MTE4ZGM3NGZjNmVkYjIwYw==
+SHA512:
+  metadata.gz: !binary |-
+    ZGQ1N2U4ZDAyNGYxOGEyZDU2ZGVmMWRjMGM1N2NkMzU0MWYxYmYxNThhNGVh
+    ZGI1YTc2MjJjZWNkZWFlNDRlNGY4MjU5OTliNzU4YzEyMTNmZTg4MWZmMzNi
+    ODIwNGY4YmZhYzRlOGRlZjI3NDgwZTdkOTE2ODlkOTExOTI1MTQ=
+  data.tar.gz: !binary |-
+    MmEzZWU4ZWJmMTFiYTBiMGQxNDE1NTkxNjUxNzNjOGE5MTQ0ZTNiNDY1YTli
+    OGM5M2U4Y2M0MDc4NTM5YTdjZTQzNmM4YmY1YTkzODE2YmVhMzRlYzYwOGVk
+    M2EwNWYzMWEzNmQ3ZGU0MmE4ZDg1NWQyN2Q1OTMzMjcyYWI1YzI=

data/CHANGELOG.md

@@ -1,9 +1,38 @@
 # Changelog
 
-## Ginjo-Rfm 2.1.7
-
-* Added field_mapping awareness to :sort_field query option.
-* Relaxed requirement that query option keys be symbols - can now be strings.
+## Ginjo-Rfm 3.0.0
+
+* Disabled default port in Connection (was 80), as it was tripping up connections where the port wasn't specified for a :use\_ssl connection on older Rubies.
+* Enabled :ignore\_portals option.
+* Removed runtime dependency on activesupport from gemspec.
+* Added check in Field#coerce to make sure a '?' is in a string before splitting on '?'. This was breaking repeating container fields.
+* Fixed case mismatch in hash key in Factory classes. Added logging of parsing template to logging of parsing backend.
+* Fixed bug in field\_control#value\_list.
+* Added layout\_meta and resultset\_meta objects.
+* Added fmpxmlresult.xml.builder for future use.
+* Added Rfm.logger, Rfm.logger=, Config.logger, Config#logger, and config(:logger=>(...)).
+* Added logging facility.
+* Moved #state method from individual classes to Config class.
+* Fixes to Base#update\_attributes.
+* Refined multiple :use handling in Config.
+* Using rspec 2
+* Removed SubLayout.
+* Added field-mapping awareness to :sort\_field query option.
+*	Relaxed requirement that query option keys be symbols - can now be strings.
+* Record.new now automatically creats models based on layout name. Should there be an option to disable this?
+* Removed ActiveSupport requirement (of course, ActiveSupport will load if ActiveModle is used, but that is the users' choice).
+* Removed XmlMini, XmlParser, and related code & specs.
+*	Detached resultset from record, so record doesn't drag resultset around with it.
+* Disabled automatic model creation from a table-name in a new Rfm::Record when initializing.
+*	Consolidated Base.new, Base#inititalize into Rfm::Record.
+*	Fixed validation callbacks issue.
+* Fixed: Resultset will politely return [] when asked for non-existent portal\_names.
+* Mods to rakefile benchmarking/profiling.
+* Refactored Resultset metadata methods.
+* Refactored Layout metadata methods.
+* Fixed bug in Config#get\_config\_file where a single file path might not be recognized.
+* Added connection.rb and moved some methods from Server to Connection.
+* Sax parsing rewrite.
 
 ## Ginjo-Rfm 2.1.6
 
@@ -25,7 +54,7 @@
 
 ## Ginjo-Rfm 2.1.2
 
-* Fixed config.rb so that :file_path (to user-defined yml config file) can be specified as a single path string
+* Fixed config.rb so that :file\_path (to user-defined yml config file) can be specified as a single path string
 	or as an array of path strings.
 
 ## Ginjo-Rfm 2.1.1
@@ -36,9 +65,9 @@
 
 ## Ginjo-Rfm 2.1.0
 
-* Removed `:include_portals` query option in favor of `:ignore_portals`.
+* Removed `:include\_portals` query option in favor of `:ignore\_portals`.
 
-* Added `:max_portal_rows` query option.
+* Added `:max\_portal\_rows` query option.
 
 * Added field-remapping framework to allow model fields with different names than Filemaker fields.
 
@@ -55,9 +84,9 @@
 
 ## Ginjo-Rfm 2.0.2
 
-* Added configuration parameter ignore_bad_data to silence data mismatch errors when loading resultset into records.
+* 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 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.
 
@@ -101,9 +130,9 @@
 
 * Re-implemented:  
   
-	Layout#field_controls
+	Layout#field\_controls
 
-	Layout#value_lists  
+	Layout#value\_lists  
   
 * Enhanced:  
 
@@ -149,21 +178,21 @@
 
 ## Lardawge-Rfm 1.4.1.1
 
-* [Bug] Inadvertently left out an attr_reader for server from resultset effecting container urls.
+* [Bug] Inadvertently left out an attr\_reader for server from resultset effecting container urls.
 
 ## Lardawge-Rfm 1.4.1*
 
-* Changed Server#do_action to Server#connect.
+* Changed Server#do\_action to Server#connect.
 
 * XML Parsing is now done via xpath which significantly speeds up parsing.
 
-* Changes to accessor method names for Resultset#portals Resultset#fields to Resultset#portal_meta and Resultset#field_meta to better describe what you get back.
+* Changes to accessor method names for Resultset#portals Resultset#fields to Resultset#portal\_meta and Resultset#field\_meta to better describe what you get back.
 
 * Added an option to load portal records which defaults to false. This significantly speeds up load time when portals are present on the layout.
 
 	Example:  
   
-	    result = fm_server('layout').find({:username => "==#{username}"}, {:include_portals => true})
+	    result = fm\_server('layout').find({:username => "==#{username}"}, {:include\_portals => true})
 	    # => This will fetch all records with portal records attached.
   
 	    result.first.portals
@@ -171,4 +200,4 @@
     
 * 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.
 
-* Removed Layout#value_lists && Layout#field_controls. Will put back in if the demand is high. Needs a major refactor and different placement if it goes back in. Was broken so it didn't seem to be used by many devs.
+* Removed Layout#value\_lists && Layout#field\_controls. Will put back in if the demand is high. Needs a major refactor and different placement if it goes back in. Was broken so it didn't seem to be used by many devs.

data/README.md

@@ -1,6 +1,8 @@
 # ginjo-rfm
 
-Rfm is a Ruby-Filemaker adapter, a Ruby gem that allows scripts and applications to exchange commands and data with Filemaker Pro using Filemaker's XML interface. Ginjo-rfm picks up from the lardawge-rfm gem and continues to refine code and fix bugs. Version 2.0 adds some major enhancements, while remaining compatible with ginjo-rfm 1.4.x and lardawge-rfm 1.4.x. 
+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).
+
+Ginjo-rfm version 3 has been tested successfully on Ruby 1.8.7, 1.9.3, 2.0.0, and 2.1.2.
 
 
 ## Documentation & Links
@@ -12,274 +14,73 @@ Rfm is a Ruby-Filemaker adapter, a Ruby gem that allows scripts and applications
 * Original homepage   <http://sixfriedrice.com/wp/products/rfm/>
 * Lardawge at github  <https://github.com/lardawge/rfm>
 
+## New in version  3.0
 
-## New in version  2.1
+There are many changes in version 3, but most of them are under the hood. Here are some highlights.
 
-Ginjo-rfm 2.1 has 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.
+* Compatibility with Ruby 2.1.2 (and 2.0.0, 1.9.3, 1.8.7).
 
-* Portals are now included by default.
-	Removed `:include_portals` query option in favor of `:ignore_portals`.
-	Added `:max_portal_rows` query option.
-* Added field-mapping framework to allow model fields with different names than Filemaker fields.
+* 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.
 
-        class User < Rfm::Base
-          config :field_mapping => {
-            #<filemaker-field-name>  =>  <rfm-field-name>
-            'userName'               => 'login',
-            'First Name'             => 'first_name',
-            'Last Name'              => 'last_name',
-            'IDperson'               => 'person_id'     
-          }
-        end
+* Better logging capabilities.
+Added Rfm.logger, Rfm.logger=, Config.logger, Config#logger, and config(:logger=>(...)).
 
-        User.find(:login=>'bill')    # => [{'login' => 'bill', 'first_name' => 'Bill', ...}, ...]
+* Added field-mapping awareness to :sort_field query option.
 
-* 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.).
-
-        Rfm::Resultset.load_data(file_or_string).
-
-* Compatibility fixes for ruby 1.9.
-* Configuration `:use` option now works for all Rfm objects that respond to `config`.
+* Relaxed requirement that query option keys be symbols - can now be strings or symbols.
 
-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.
+* 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.
 
-## New in version 2.0
+See the changelog or the commit history for more details on changes in ginjo-rfm v3.
 
-Ginjo-rfm 2.0 brings new features to Rfm, making it easier than ever to work with Filemaker data from your Ruby scripts.
-
-* Rails-like modeling with ActiveModel
-* Support for multiple XML Parsers
-* Configuration API
-* Compound Filemaker queries with omitable requests
-* Full metadata support
-
-
-### Data Modeling with ActiveModel
-	
-If you can load ActiveModel in your project, you can have model callbacks, validations, and other ActiveModel features.
-If you can't load ActiveModel (because you're using something incompatible, like Rails 2),
-you can still use Rfm models... minus the ActiveModel-specific features like callbacks and validations. Rfm models give you basic
-data modeling with easy configuration and CRUD features.
-
-	  class User < Rfm::Base
-	    config      :layout=>'user_layout'
-	    before_save :encrypt_password
-	    validate    :valid_email_address
-	  end
-	
-	  @user = User.new :username => 'bill', :password => 'pass'
-	  @user.email = 'my@email.com'
-	  @user.save!
+## Download & Installation
 
+Find the latest stable release at Rubygems.org.
 
-### Choice of XML Parsers
+In your Gemfile.
 
-Ginjo-rfm 2.0 uses ActiveSupport's XmlMini parsing interface, which has built-in support for
-LibXML, Nokogiri, and REXML. Additionally, ginjo-rfm includes adapters for Ox and Hpricot parsing.
-You can specifiy which parser to use or let Rfm decide.
+    gem 'ginjo-rfm', :require=>'rfm'
 
-	  Rfm.config :parser => :libxml
+Or manually.
 
-If you're not able to install one of the faster parsers, ginjo-rfm will fall back to
-ruby's built-in REXML. Want to roll your own XML adapter? Just pass it to Rfm as a module.
+    gem install 'ginjo-rfm'
 
-	  Rfm.config :parser => MyHomeGrownAdapter
+You can find the latest development release on github.
 
-Choose your preferred parser globaly, as in the above example, or set a different parser for each model.
-		
-	  class Order < Rfm::Base
-	    config :parser => :hpricot
-	  end
-	
-The current parsing options are
+    gem 'ginjo-rfm', :git=>'https://github.com/ginjo/rfm.git', :branch=>'master'
 
-	  :jdom         ->  JDOM (for JRuby)
-	  :oxsax        ->  Ox SAX
-	  :libxml       ->  LibXML Tree
-	  :libxmlsax    ->  LibXML SAX
-	  :nokogirisax  ->  Nokogiri SAX
-	  :nokogiri     ->  Nokogiri Tree
-	  :hpricot      ->  Hpricot Tree
-	  :rexml        ->  REXML Tree
-	  :rexmlsax     ->  REXML SAX
-	
-If you're wondering about performance, here are some preliminary benchmark results. Each backend parsed a fmresultset.xml and a FMPXMLLAYOUT.xml 30 times each. Results have differed across environments with different test data, so this data is by no means definitive. Also note that earlier versions of ActiveSupport did not contain all of the parsing backend options mentioned here.
+Ginjo-rfm v3 can be run without any other gems, allowing you to create models to interact with your Filemaker servers, layouts, tables, records, and data. If you want the additional features provided by ActiveModel, just add activemodel to your Gemfile (or require it manually). Ginjo-rfm v3 will use the built-in Ruby XML parser REXML by default. If you want to use one of the other supported parsers (libxml-ruby, nokogiri, ox), just add it to your Gemfile or require it manually. If you have several Ruby XML parsers installed, you can specify which one you want Rfm to use by setting the configuration option :parser with one of the supported options (:libxml, :nokogiri, :ox, :rexml).
 
-		      user     system      total        real
-		ActiveSupport::XmlMini_OxSAX
-		  0.200000   0.010000   0.210000 (  0.211842)
-		ActiveSupport::XmlMini_LibXML
-		  0.400000   0.010000   0.410000 (  0.411823)
-		ActiveSupport::XmlMini_LibXMLSAX
-		  0.400000   0.010000   0.410000 (  0.411360)
-		ActiveSupport::XmlMini_NokogiriSAX
-		  0.670000   0.010000   0.680000 (  0.682885)
-		ActiveSupport::XmlMini_Nokogiri
-		  0.970000   0.030000   1.000000 (  0.998673)
-		ActiveSupport::XmlMini_Hpricot
-		  1.950000   0.060000   2.010000 (  2.011355)
-		ActiveSupport::XmlMini_REXML
-		  8.710000   0.180000   8.890000 (  9.015836)
-		ActiveSupport::XmlMini_REXMLSAX
-		  6.320000   0.040000   6.360000 (  6.377179)
+Note that while this gem is officially named "ginjo-rfm", you require/load it into your Ruby scripts as simply "rfm". This is in keeping with the original rfm gem from Sixfriedrice and with other forks of the rfm gem.
 
 
 
-### Configuration API
+## Ginjo-rfm Basic Usage
 
-The ginjo-rfm configuration module lets you store your settings in several different ways. Store some, or all, of your project-specific settings in a rfm.yml file at the root of your project, or in your Rails config/ directory. Settings can also be put in a RFM_CONFIG constant at the top level of your project.  Configuration settings can be simple key=>values, or they can be named groups of key=>values. Configuration can also be passed to various Rfm methods during load and runtime, as individual settings or as groups.
+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.
 
 rfm.yml
 
-	   :ssl: true
-	   :root_cert: false
-	   :timeout: 10
-	   :port: 443
-	   :host: live.mydomain.com
-	   :account_name: admin
-	   :password: pass
-	   :database: MyFmDb
-
-Set a model's configuration.
+		:host: my.host.com
+		:account_name: myname
+		:password: somepass
+		:database: MyFmDb
 	
-	   class MyModel < Rfm::Base
-	     config :layout => 'mylayout'
-	   end
+app/models/order\_item.rb
 
+		class OrderItem < Rfm::Base
+		  config :layout => 'order_item_layout'
+		end
+			
+app/controllers/order\_item\_controller.rb
 
-### Compound Filemaker Queries, with Omitable FMP Find Requests
+		def show
+			@record = OrderItem.find params[:id]
+		end
 
-Create a Filemaker 'omit' request by including an :omit key with a value of true.
-
-	   my_layout.find :field1 => 'val1', :field2 => 'val2', :omit => true
-
-Create multiple Filemaker find requests by passing an array of hashes to the #find method.
-
-	   my_layout.find [{:field1 => 'bill', :field2 => 'admin'}, {:field2 => 'staff', :field3 => 'inactive', :omit => true}, ...]
-
-If the value of a field in a find request is an array of strings, the string values will be logically OR'd in the query.
-
-	   my_layout.find :fieldOne => ['bill','mike','bob'], :fieldTwo =>'staff'
-
-
-### Full Metadata Support
-	
-* Server databases
-* Database layouts
-* Database scripts
-* Layout fields
-* Layout portals
-* Resultset meta
-* Field definition meta
-* Portal definition meta
-
-There are also many enhancements to make it easier to get the objects or data you want. Some examples:
-
-Get a database object using default config
-
-	  Rfm.db 'my_db'
-
-Get a layout object using config grouping :my_group
-	
-	  Rfm.layout :my_group
-
-Get the total count of all records in the table
-
-	  MyModel.total_count
-
-Get the portal names (table-occurrence names) on the current layout
-
-	  MyModel.portal_names
-
-Get the names of fields on the current layout
-
-	  my_record.field_names
-	
-### From ginjo-rfm 1.4.x
-
-From ginjo-rfm 1.4.x, the following features are also included.
-
-Connection timeout settings
-
-	  Rfm.config :timeout => 10
-
-Value-list alternate display
-
-	   i = array_of_value_list_items[3]  # => '8765'
-	   i.value                           # => '8765'
-	   i.display                         # => '8765 Amy'
-
-
-### Compatibility
-
-Ginjo-rfm 2.0 is compatible with previous versions of Rfm - Ginjo, Lardawge, and SFR. However, much has been changed in the low-level workings of the code. If you have scripts that reach deep into the guts of Rfm 1.0 thru 1.4.x, you may find that some things are slightly different in 2.0. Additionally, some long-standing bugs have been fixed that may have been so de rigeur, that the "correct behavior" in Rfm 2.0 may break scripts that relied on the previously buggy functions. These low level changes, and the addition of major new functionality, led the decision to release this version of Rfm as 2.0, instead of 1.5.
-
-
-## Download & Installation
-
-There are at least 4 ways to download ginjo-rfm.
-
-* With Bundler: gem 'ginjo-rfm'
-* With the command line: gem install ginjo-rfm
-* From https://rubygems.org/gems/ginjo-rfm
-* From https://github.com/ginjo/rfm
-
-Ginjo-rfm requires the ActiveSupport gem for several features, including XML parsing. Rfm has been tested and works with ActiveSupport 2.3.5 thru 3.1.3, on both ruby 1.8.7 and ruby 1.9.2. ActiveModel requires ActiveSupport 3+ and is not compatible with ActiveSupport 2.3.x. So while you CAN use ginjo-rfm with Rails 2.3, you will not have ActiveModel features like callbacks and validations. Basic modeling functionality and Filemaker interaction will continue to work, unaffected by the presence or absence of ActiveModel.
-
-For the best performance, it is recommended that you use the Ox, Libxml-ruby, Nokogiri, or Hpricot parser. Ginjo-rfm does not require these gems by dependency, so you will have to make sure they are installed on your machine and/or specified in your Gemfile, if you wish to use them. If you don't want to install any of these parsers, Rfm will use the REXML parser included with the Ruby standard library. Similarly, ginjo-rfm does not require ActiveModel by dependency, so also make sure that is installed and/or specified in your Gemfile if you wish to use ActiveModel features.
-
-Note that the installation of Ox, Libxml-ruby, Nokogiri, or Hpricot gems will require further dependencies. Please see the install instructions for each parser to get them installed and running on your system.
-
-
-### Using Bundler and/or Rails >= 3.0
-
-In your Gemfile:
-
-	   gem 'ginjo-rfm'
-	   gem 'ox'          # optional
-	   gem 'libxml-ruby' # optional
-	   gem 'nokogiri'    # optional
-	   gem 'hpricot'     # optional
-	   gem 'activemodel' # optional
-
-In your shell:
-
-	   bundle install
-
-In your project, you may or may not have to require 'rfm', depending on Bundler's configuration:
-
-	   require 'rfm'
-
-### Without Bundler
-
-If you are not using Bundler, Rfm will pick up the XML parsers and ActiveModel as long as they are available in your current rubygems installation.
-
-In your shell:
-
-	   gem install ginjo-rfm
-	   gem install ox           # optional
-	   gem install nokogiri     # optional
-	   gem install libxml-ruby  # optional
-	   gem install hpricot      # optional
-	   gem install activemodel  # optional
-
-Once the gem is installed, you can use rfm in your ruby scripts by requiring it:
-
-	   require 'rubygems'
-	   require 'rfm'
-
-
-## 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 model that represents a layout from one of your Filemaker databases. 
 
 ### Configuration
 
@@ -288,7 +89,6 @@ In previous versions of Rfm, you may have stored your configuration settings in
 rfm.yml
 
 	   :ssl: true
-	   :root_cert: false
 	   :timeout: 10
 	   :port: 443
 	   :host: my.host.com
@@ -304,12 +104,11 @@ Or put your configuration settings in a hash called RFM_CONFIG. Rfm will pick th
 	     :account_name  => 'myname',
 	     :password      => 'somepass',
 	     :ssl           => true,
-	     :root_cert     => false,
 	     :port          => 443,
 	     :timeout       => 10
 	     }
 
-You can use configuration subgroups to seperate global settings from environment-specific settings.
+You can use configuration subgroups to separate global settings from environment-specific settings.
 
 	   :ssl: true
 	   :root_cert: false
@@ -326,7 +125,7 @@ You can use configuration subgroups to seperate global settings from environment
 	     :password: pass
 	     :database: LiveFmDb
 
-Then in your environment files (or wherever you put environment-specific configuration in your ruby project),
+Then in your environment files (or wherever you put environment-specific configuration in your Ruby project),
 specifiy which subgroup to use.
 
      RFM_CONFIG = {:use => :development}
@@ -348,13 +147,13 @@ You can use configuration subgroups to contain any arbitrary groups of settings.
 	     :password: pass
 	     :database: custTwoFmDb
 
-Use the configuration setting method `config` to set configuration for specific objects, like Rfm models. When you pass a `:use => :subgroup` to the `config` method, you're saying use that subgroup of settings.
+Use the configuration setting method `config` to set configuration for specific objects, like Rfm models. When you pass a `:use => :subgroup` to the `config` method, you're saying use that subgroup of settings (on top of any existing upstream configuration).
 
 	   class MyModel < Rfm::Base
 	     config :use => :customer1, :layout => 'some_layout'
 	   end
 	
-The current heirarchy of configurable objects in Rfm, starting at the top, is:
+The current hierarchy of configurable objects in Rfm, starting at the top, is:
 
 * rfm.yml      # file of settings in yaml format
 * RFM_CONFIG   # user-defined hash
@@ -385,12 +184,13 @@ Use `get_config` to view the compiled configuration settings for any object. Con
 	          :account_name => 'name', :password => 'pass'
 	         }
 	
-**Possible Configuration Options**
+#### Configuration Options
 
 Following are all of the recognized configuration options, including defaults if applicable.
+See `Rfm::Config::CONFIG_KEYS` for a list of currently allowed configuration options.
 
 	   :host             => 'localhost'
-	   :port             => 80
+	   :port             
 	   :ssl              => true
 	   :root_cert        => true
 	   :root_cert_name   => ''
@@ -409,13 +209,13 @@ Following are all of the recognized configuration options, including defaults if
 	   :parent           => 'Rfm::Config'                 # the parent configuration object of the current configuration object, as string
 	   :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
+	   :parser                                            # Prefferred XML parser (you must also require the parsing gem or specify it in your gemfile, if not using the built-in Ruby XML parser REXML). Can be :libxml, :nokogiri, :ox, :rexml.
 	   :ignore_bad_data  => nil                           # Instruct Rfm to ignore data mismatch errors when loading a resultset
 	
 
 ### Using Models
 
-Rfm models provide easy access, modeling, and persistence of your Filemaker data.h
+Rfm models provide easy access, modeling, and persistence of your Filemaker data.
 
 	   class User < Rfm::Base
 	     config :layout => 'my_user_layout'
@@ -439,24 +239,13 @@ Rfm models provide easy access, modeling, and persistence of your Filemaker data
 	   @user.update_attributes(:login => 'william', :email => 'myother@email.com')
 	   @user.save!
 	
-Put your model code anywhere at the top level of your script/application. In Rails, this could be your initialization file(s), your environment file(s), or in a file in your Models directory called something like `rfm_models.rb`. Then require 'rfm_models' in your initialization or environment.  
+If using Rails, put your model code in files within your models/ directory.
 
-rfm_models.rb
+app/models/user.rb
 
-	   require 'rfm'
-	   
 	   class User < Rfm::Base
 	     config :layout => 'user_layout'
 	   end
-	
-	   class Order < Rfm::Base
-	     config :layout => 'order_layout'
-	   end
-	
-main_initializer.rb
-
-	   require 'rfm_models'
-
 
 If you prefer, you can create models on-the-fly from any layout.
 
@@ -470,9 +259,9 @@ Or create models for an entire database, all at once.
 
 	   # => [MyLayoutXml, AnotherLayoutXml, ThirdLayoutXml, AndSoOnXml, ...]
 	   # The regex in the first parameter is optional and filters the layout names in the specified database.
-	   # Omit the regex parameter to modelize all possible layouts in the specified database.
+	   # Omit the regex parameter to modelize all possible layouts in the specified database (careful with this one!).
 
-With ActiveModel loaded, you get callbacks, validations, errors, serialization, and a handful of other features extracted from Rails ActiveRecord.
+With ActiveModel loaded, you get callbacks, validations, errors, serialization, and a handful of other features extracted from Rails ActiveRecord. Not all ActiveModel features are supported (yet) in ginjo-rfm, but adapters can be hand-rolled in the meantime.
 
 In your Gemfile
 
@@ -503,9 +292,9 @@ To learn more about ActiveModel, see the ActiveModel or RubyOnRails documentatio
 
 Once you have an Rfm model or layout, you can use any of the standard Rfm commands to create, search, edit, and delete records. To learn more about these commands, see below for Databases, Layouts, Resultsets, and Records. Or checkout the API documentation for Rfm::Server, Rfm::Database, Rfm::Layout, Rfm::Record, and Rfm::Base.
 
-**Two Small Changes in Rfm Return Values**
+#### Two Small Changes in Rfm Return Values
 
-When using Models to retrieve records using the `any` method or the `find(record_id)` method, the return values will be single Rfm::Record objects. This differs from the traditional Rfm behavior of these methods when accessed directly from the the Rfm::Layout instance, where the return value is always a Rfm::Resultset.
+(From Rfm v2 onward) When using Models to retrieve records using the `any` method or the `find(record_id)` method, the return values will be single Rfm::Record objects. This differs from the original Rfm behavior of these methods when accessed directly from the the Rfm::Layout instance, where the return value is always a Rfm::Resultset.
 
 	   MyModel.find(record_id)  ==  my_layout.find(record_id)[0]
 	   MyModel.any              ==  my_layout.any[0]
@@ -513,7 +302,7 @@ When using Models to retrieve records using the `any` method or the `find(record
 
 ### Getting Rfm Server, Database, and Layout Objects Manually
 
-Well... not entirely manually. To get server, db, and layout objects as in previous versions of Rfm, see the section "Working with classic Rfm features". Ginjo-rfm 2.0 has some new methods to create/locate Filemaker objects and meta data. Many of these new methods are configuration-aware.
+Well... not entirely manually. To get server, db, and layout objects as in previous versions of Rfm, see the section "Working with classic Rfm features". Newer versions of ginjo-rfm can use the configuration options to build these objects.
 
 Create a layout object using default configuration settings.
 
@@ -591,9 +380,9 @@ There are a number of methods within Rfm that have been made accessible from the
 	   # 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
+	   Rfm::SaxParser  :backend
 	
 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.
 
@@ -711,7 +500,7 @@ All of these methods return an Rfm::Resultset object (see below), and every one
 
 For a complete list of the available options, see the "expand_options" method in the Rfm::Server object in the file named server.rb.
 
-Finally, if filemaker returns an error when executing any of these methods, an error will be raised in your ruby script. There is one exception to this, though. If a find results in no records being found (FileMaker error # 401) I just ignore it and return you a Resultset with zero records in it. If you prefer an error in this case, add :raise_on_401 => true to the options you pass the Rfm::Server when you create it.
+Finally, if filemaker returns an error when executing any of these methods, an error will be raised in your Ruby script. There is one exception to this, though. If a find results in no records being found (FileMaker error # 401) I just ignore it and return you a Resultset with zero records in it. If you prefer an error in this case, add :raise_on_401 => true to the options you pass the Rfm::Server when you create it.
 
 
 ### Resultset and Record Objects
@@ -722,7 +511,7 @@ Any method on the Layout object that returns data will return a Resultset object
 	   my_result.size  # returns '1'
 	   my_result[0]    # returns the first record (an Rfm::Record object)
 
-The Resultset object also tells you information about the fields and portals in the result. Resultset#field\_meta and Resultset#portal\_meta are both standard ruby hashes, with strings for keys. The fields hash has Rfm::Metadata::Field objects for values. The portals hash has another hash for its values. This nested hash is the fields on the portal. This would print out all the field names:
+The Resultset object also tells you information about the fields and portals in the result. Resultset#field\_meta and Resultset#portal\_meta are both standard Ruby hashes, with strings for keys. The fields hash has Rfm::Metadata::Field objects for values. The portals hash has another hash for its values. This nested hash is the fields on the portal. This would print out all the field names:
 
 	   my_result.field_meta.each { |name, field| puts name }
 	
@@ -746,7 +535,7 @@ But most importantly, the Resultset contains record objects. Rfm::Record is a su
 	   my_record = my_result[0]
 	   puts my_record["first_name"]
 
-As a convenience, if your field names are valid ruby method names (ie, they don't have spaces or odd punctuation in them), you can do this instead:
+As a convenience, if your field names are valid Ruby method names (ie, they don't have spaces or odd punctuation in them), you can do this instead:
 
 	   puts my_record.first_name
 
@@ -805,9 +594,9 @@ FileMaker's field types are coerced to Ruby types thusly:
 	   TimeStamp Field  -> DateTime object  
 	   Container Field  -> URI object  
 
-FileMaker's number field is insanely robust. The only data type in ruby that can handle the same magnitude and precision of a FileMaker number is Ruby's BigDecimal. (This is an extension class, so you have to require 'bigdecimal' to use it yourself). Unfortuantely, BigDecimal is not a "normal" ruby numeric class, so it might be really annoying that your tiny filemaker numbers have to go this route. This is a great topic for debate.
+FileMaker's number field is insanely robust. The only data type in Ruby that can handle the same magnitude and precision of a FileMaker number is Ruby's BigDecimal. (This is an extension class, so you have to require 'bigdecimal' to use it yourself). Unfortuantely, BigDecimal is not a "normal" Ruby numeric class, so it might be really annoying that your tiny filemaker numbers have to go this route. This is a great topic for debate.
 
-Also, Ruby doesn't have a Time type that stores just a normal time (with no date attached). The Time class in ruby is a lot like DateTime, or a Timestamp in FileMaker. When I get a Time field from FileMaker, I turn it into a DateTime object, and set its date to the oldest date Ruby supports. You can still compare these in all the normal ways, so this should be fine, but it will look weird if you, ie, to_s one and see an odd date attached to your time.
+Also, Ruby doesn't have a Time type that stores just a normal time (with no date attached). The Time class in Ruby is a lot like DateTime, or a Timestamp in FileMaker. When I get a Time field from FileMaker, I turn it into a DateTime object, and set its date to the oldest date Ruby supports. You can still compare these in all the normal ways, so this should be fine, but it will look weird if you, ie, to_s one and see an odd date attached to your time.
 
 Finally, container fields will come back as URI objects. You can:
 
@@ -841,6 +630,193 @@ So, for an annoying, but detailed load of output, make a connection like this:
 
 If you were tracking ginjo-rfm on github before the switch to version 2.0.0, please accept my humblest apologies for making a mess of the branching. The pre 2.0.0 edge branch has become master, and the pre 2.0.0 master branch has become ginjo-1-4-stable. I don't intend to make that kind of hard reset again, at least not on public branches. Master will be the branch to find the latest-greatest public source, and 'stable' branches will emerge as necessary to preserve historical releases.
 
+### Still To Do
+
+Repeating field compatibility, more coverage of Filemaker's query syntax, more error classes, more specs, and more documentation.
+
+
+
+
+## Previous Version Highlights
+
+### Version 2.1
+
+* 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.
+
+        class User < Rfm::Base
+          config :field_mapping => {
+            #<filemaker-field-name>  =>  <rfm-field-name>
+            'userName'               => 'login',
+            'First Name'             => 'first_name',
+            'Last Name'              => 'last_name',
+            'IDperson'               => 'person_id'     
+          }
+        end
+
+        User.find(:login=>'bill')    # => [{'login' => 'bill', 'first_name' => 'Bill', ...}, ...]
+
+* 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.).
+
+        Rfm::Resultset.load_data(file_or_string).
+
+* Compatibility fixes for Ruby 1.9.
+* Configuration `:use` option now works for all Rfm objects that respond to `config`.
+
+
+### Version 2.0
+
+* Rails-like modeling with ActiveModel
+* Support for multiple XML Parsers
+* Configuration API
+* Compound Filemaker queries with omitable requests
+* Full metadata support
+
+
+#### Data Modeling with ActiveModel
+	
+If you can load ActiveModel in your project, you can have model callbacks, validations, and other ActiveModel features.
+If you can't load ActiveModel (because you're using something incompatible, like Rails 2),
+you can still use Rfm models... minus the ActiveModel-specific features like callbacks and validations. Rfm models give you basic
+data modeling with easy configuration and CRUD features.
+
+	  class User < Rfm::Base
+	    config      :layout=>'user_layout'
+	    before_save :encrypt_password
+	    validate    :valid_email_address
+	  end
+	
+	  @user = User.new :username => 'bill', :password => 'pass'
+	  @user.email = 'my@email.com'
+	  @user.save!
+
+
+#### Choice of XML Parsers
+
+Note that this section only applies to ginjo-rfm v2. See notes for ginjo-rfm v3 for v3 parsing options. 
+
+Ginjo-rfm 2.0 uses ActiveSupport's XmlMini parsing interface, which has built-in support for
+LibXML, Nokogiri, and REXML. Additionally, ginjo-rfm includes adapters for Ox and Hpricot parsing.
+You can specifiy which parser to use or let Rfm decide.
+
+	  Rfm.config :parser => :libxml
+
+If you're not able to install one of the faster parsers, ginjo-rfm will fall back to
+Ruby's built-in REXML. Want to roll your own XML adapter? Just pass it to Rfm as a module.
+
+	  Rfm.config :parser => MyHomeGrownAdapter
+
+Choose your preferred parser globaly, as in the above example, or set a different parser for each model.
+		
+	  class Order < Rfm::Base
+	    config :parser => :hpricot
+	  end
+	
+The current parsing options are
+
+	  :jdom         ->  JDOM (for JRuby)
+	  :oxsax        ->  Ox SAX
+	  :libxml       ->  LibXML Tree
+	  :libxmlsax    ->  LibXML SAX
+	  :nokogirisax  ->  Nokogiri SAX
+	  :nokogiri     ->  Nokogiri Tree
+	  :hpricot      ->  Hpricot Tree
+	  :rexml        ->  REXML Tree
+	  :rexmlsax     ->  REXML SAX
+	
+
+#### Configuration API
+
+The ginjo-rfm configuration module lets you store your settings in several different ways. Store some, or all, of your project-specific settings in a rfm.yml file at the root of your project, or in your Rails config/ directory. Settings can also be put in a RFM_CONFIG constant at the top level of your project.  Configuration settings can be simple key=>values, or they can be named groups of key=>values. Configuration can also be passed to various Rfm methods during load and runtime, as individual settings or as groups.
+
+rfm.yml
+
+	   :ssl: true
+	   :root_cert: false
+	   :timeout: 10
+	   :port: 443
+	   :host: live.mydomain.com
+	   :account_name: admin
+	   :password: pass
+	   :database: MyFmDb
+
+Set a model's configuration.
+	
+	   class MyModel < Rfm::Base
+	     config :layout => 'mylayout'
+	   end
+
+
+#### Compound Filemaker Queries, with Omitable FMP Find Requests
+
+Create a Filemaker 'omit' request by including an :omit key with a value of true.
+
+	   my_layout.find :field1 => 'val1', :field2 => 'val2', :omit => true
+
+Create multiple Filemaker find requests by passing an array of hashes to the #find method.
+
+	   my_layout.find [{:field1 => 'bill', :field2 => 'admin'}, {:field2 => 'staff', :field3 => 'inactive', :omit => true}, ...]
+
+If the value of a field in a find request is an array of strings, the string values will be logically OR'd in the query.
+
+	   my_layout.find :fieldOne => ['bill','mike','bob'], :fieldTwo =>'staff'
+
+
+#### Full Metadata Support
+	
+* Server databases
+* Database layouts
+* Database scripts
+* Layout fields
+* Layout portals
+* Resultset meta
+* Field definition meta
+* Portal definition meta
+
+There are also many enhancements to make it easier to get the objects or data you want. Some examples:
+
+Get a database object using default config
+
+	  Rfm.db 'my_db'
+
+Get a layout object using config grouping :my_group
+	
+	  Rfm.layout :my_group
+
+Get the total count of all records in the table
+
+	  MyModel.total_count
+
+Get the portal names (table-occurrence names) on the current layout
+
+	  MyModel.portal_names
+
+Get the names of fields on the current layout
+
+	  my_record.field_names
+	
+	
+### From Version 1.4.x
+
+From ginjo-rfm 1.4.x, the following features are also included.
+
+Connection timeout settings
+
+	  Rfm.config :timeout => 10
+
+Value-list alternate display
+
+	   i = array_of_value_list_items[3]  # => '8765'
+	   i.value                           # => '8765'
+	   i.display                         # => '8765 Amy'
+
+
 
 ## Credits
 
@@ -848,9 +824,10 @@ Rfm was primarily designed by Six Fried Rice co-founder Geoff Coffey.
 
 Other lead contributors:
 
-* Mufaddal Khumri helped architect Rfm in the most ruby-like way possible. He also contributed the outstanding error handling code and a comprehensive hierarchy of error classes.
+* Mufaddal Khumri helped architect Rfm in the most Ruby-like way possible. He also contributed the outstanding error handling code and a comprehensive hierarchy of error classes.
 * Atsushi Matsuo was an early Rfm tester, and provided outstanding feedback, critical code fixes, and a lot of web exposure.
 * Jesse Antunes helped ensure that Rfm is stable and functional.
 * Larry Sprock added ssl support, switched the xml parser to a much faster Nokogiri, added the rspec testing framework, and refined code architecture.
+* William Richardson is the current maintainer of the ginjo-rfm fork and added support for multiple xml parsers, ActiveModel integration, field mapping, compound queries, logging, and a configuration framework.