ginjo-rfm 1.4.4 → 2.0.pre31

data/CHANGELOG.md

@@ -0,0 +1,107 @@
+# Changelog
+
+## Ginjo-Rfm 2.0.pre
+
+* Alternative XML parsers using ActiveSupport::XmlMini interface
+
+* ActiveModel compatibility allows Rails-like models
+
+* Complex queries with Layout#query method
+
+* Configuration API manages settings of multiple server/db/layout/etc setups
+
+* Full Filemaker metadata support
+
+## Ginjo-Rfm 1.4.4
+
+* Fixed bug when creating empty value list.
+
+* Additional fixes for Rfm::VERSION.
+
+* Fixed Record getter/setter issue.
+
+* Other minor fixes and cleanup.
+
+* Added tests to rspec.
+
+* Documentation cleanup.
+
+## Ginjo-Rfm 1.4.3
+
+* Fixed version management issue. Rfm::VERSION now works.
+
+## Ginjo-Rfm 1.4.2
+
+* Re-implemented:  
+  
+	Layout#field_controls
+
+	Layout#value_lists  
+  
+* Enhanced:  
+
+	ValueListItem handles both display & data items now.
+
+	Timeout feature from timting (github/timting/rfm).
+
+	Added specs for Record#save.  
+  
+* Fixed:  
+
+	[Bug] Getting & setting fields with symbol-based keys was producing error.
+
+	[Bug] Setting fields would not update main record hash.
+
+	[Bug] Record#save wasn't merging back into self.  
+
+* Partial Fix:  
+
+	server.db.all
+	db.layout.all
+	db.script.all  
+  
+	Note: the "#all" method returns object names (as keys) only. The receiver of the method maintains the full object collection.  
+
+	Example:  
+  
+	    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)
+  
+* Made nil default on fields with no value.  
+  
+	Example:
+ 
+	    Old: record.john #=> "" 
+	    New: record.john #=> nil
+   
+## Lardawge-Rfm 1.4.1.2
+
+* [Bug] Pointing out why testing is soooooo important when refactoring... Found a bug in getter/setter method in Rfm::Record (yes, added spec for it).
+
+## Lardawge-Rfm 1.4.1.1
+
+* [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.
+
+* 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.
+
+* 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})
+	    # => 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.
+
+* 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,180 +1,413 @@
 # 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. It also adds minor enhancements like server timeout and value-list alternate display. To read more about Rfm, see the info at [Sixfriedrice](http://sixfriedrice.com/wp/products/rfm/), or check out the [RDoc](http://rubydoc.info/github/ginjo/rfm/master/frames).
+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. 
+
+
+## Documentation & Links
+
+* Ginjo-rfm rubygem		<https://rubygems.org/gems/ginjo-rfm>
+* Original homepage		<http://sixfriedrice.com/wp/products/rfm/>
+* Rdoc location				<http://rubydoc.info/github/ginjo/rfm/frames>
+* Discussion					<http://groups.google.com/group/rfmcommunity>
+* Ginjo at github			<https://github.com/ginjo/rfm>
+* Lardawge at github	<https://github.com/lardawge/rfm>
+
+
+## New in version 2.0
+
+### Data modeling with ActiveModel and graceful degradation without 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 callbacks & validations. Rfm models give you basic
+data modeling with easy configuration and CRUD features.
+
+	  class User < Rfm::Base
+	    config      :layout => 'user_layout'
+	  end
+	
+	  @user = User.find 12345
+	  @user.update_attributes(:name => 'bill', :login => 'admin')
+	  @user.save!
+
+With ActiveModel loaded, you get callbacks, validations, and many other ActiveModel 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!
+	
+If you prefer, you can create models on-the-fly from any layout.
+
+	  my_layout.modelize
+	  
+	  # => MyLayoutName   (subclassed from Rfm::Base, represented by your layout's name)
+	 
+Or create models for an entire database, all at once.
+
+	  Rfm.modelize :my_db_name_or_config
+	  
+	  # => [MyLayout, AnotherLayout, ThirdLayout, AndSoOn, ...]
+	
+  
+### Choice of XML parsers
+
+Ginjo-rfm 2.0 uses ActiveSupport's XmlMini parsing interface, which has built-in support for
+LibXML, Nokogiri, and REXML. Additionally, ginjo-rfm includes a module for Hpricot parsing.
+You can specifiy which parser to use or load them all and 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
+	
+Not only do you have 4 XML backend parsers to choose from, but you also have the option of choosing from different parsing shemes - the DOM parsing scheme, or the streaming (SAX or SAX-like) scheme. This gives you six different available parsing possilities.
+
+* LibXML DOM
+* LibXML SAX
+* Nokogiri DOM
+* Nokogiri SAX
+* Hpricot DOM
+* REXML DOM
 
-Rfm was primarily designed by Six Fried Rice co-founder Geoff Coffey.
+### Configuration API
 
-Other lead contributors:
+The ginjo-rfm configuration module is a heirarchical system that allows you to configure settings at a global level
+and then recall just the settings you need, where you need them. Configuration settings can be simple
+values, or they can be named groups of values.
 
-* 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 refactored the code to pave way for future development.
+For simple applications, put all of your configuration in a top-level hash, RFM_CONFIG,
+and let Rfm do the rest. For more complicated setups, use configuration subgroups,
+and/or set configuration on-the-fly when you create Server, Database, Layout, or Base objects.
 
-Documentation & Links
+Use RFM_CONFIG
 
-* Ginjo-rfm homepage: <https://rubygems.org/gems/ginjo-rfm>
-* Original homepage:  <http://sixfriedrice.com/wp/products/rfm/>
-* Rdoc location:      <http://rubydoc.info/github/ginjo/rfm/frames>
-* Discussion:         <http://groups.google.com/group/rfmcommunity>
-* Ginjo-rfm           <https://github.com/ginjo/rfm>
-* Lardawge-rfm        <https://github.com/lardawge/rfm>
+	   RFM_CONFIG = {
+	     :host          => 'main_host',
+	     :database      => 'main_database',
+	     :account_name  => 'myname',
+	     :password      => 'somepass',
+	     :second_server => {
+	       :host        => 'second_host',
+	       :database    => 'second_database'
+	     }
 
-Partial list of features added since rfm 1.0.0.
+Or set global configuration with the 'config' method
 
-* SSL support
-* Nokogiri xml parser
-* Display-vs-data value lists
-* Connection timeout
-* Metadata support re-introduced
+	  Rfm.config :host => 'main_host',
+	    :database      => 'main_database',
+	    :account_name  => 'myname',
+	    :password      => 'somepass',
+	    :second_server => {
+	      :host        => 'second_host',
+	      :database    => 'second_database'
+	    }
+	
+Set configuration of RFM::Base
 
-Partial roadmap to the future
+	   Rfm::Base.config :ssl => true
 
-* ActiveModel compatibility
-* Alternative XML parsers
-* Complex Filemaker queries
-* More tests
+Set a model's configuration
+	
+	   class MyClass < Rfm::Base
+	     config :second_server, :layout => 'mylayout'
+	   end
+	
+View	model-specific configuration
+   
+	   MyClass.config
+	
+	   # =>  {:host => 'second_host', :database => 'second_database'}
 
+View the merged configurations of all relevent levels in the configuration chain.
 
-## Installation
+	   MyClass.get_config
+	   
+	   # => {:host => 'second_host', :database => 'second_database', :account_name => 'myname', :password => 'somepass', :ssl => true}
 
-Rfm depends on Nokogiri gem, which installs executables requiring C compilation. Make sure you have a C compiler installed, ruby development headers, and Nokogiri's pre-requisite libxml2 & libxslt (or Xcode on OS X). For help installing [Nokogiri](http://nokogiri.org/), see their helpful [tutorial](http://nokogiri.org/tutorials/installing_nokogiri.html). Future versions of ginjo-rfm will offer alternative XML parsing options, hopefully making it easier to get up and running.
 
-Terminal:
+Calling the get_config method will show you what compilation of config settings are seen at any given point in Rfm and/or in your application. The current heirarchy of configurable objects in Rfm, starting at the top:
 
-    #bash
-    gem install ginjo-rfm
+* RFM_CONFIG   # a user-defined hash
+* Rfm::Config  # top-level config module
+* Rfm::Factory # where server, database, and layout objects are managed
+* Rfm::Base    # master modeling class
+* MyModel      # custom modeling class
 
-Once the gem is installed, you can use rfm in your ruby scripts by requiring it:
 
-    require 'rubygems'
-    require 'rfm'
 
-### In Rails >= 3.0, or any project using Bundler
+
+### Complex Queries
+
+Create queries with mixed boolean logic, mimicing Filemaker's multiple-request find.
+
+	   layout.query :fieldOne => ['=val1','>=val2','<val3'], :fieldTwo =>'someValue'
+   
+This will create 3 "find requests" (in a single call to FM Server), one for each value in the fieldOne array, AND'd with the fieldTwo value.
+
+
+### Full Metadata Support
+	
+* Server databases
+* Database layouts
+* Database scripts
+* Layout fields
+* Layout portals
+* Resultset meta
+* Field meta
+* Portal meta
+
+From ginjo-rfm 1.4.x, the following enhancements are also included.
+
+* Connection timeout settings
+
+* Value-list alternate display
+
+There are also many enhancements to make it easier than ever 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-occurence names) on the current layout
+
+	  MyModel.portal_names
+
+Get the names of fields on the current layout
+
+	  my_record.field_names
+
+### 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, in orer to pave the way for data modeling and flexible XML adapters. 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.
+
+
+## Installation
+
+Ginjo-rfm requires ActiveSupport for several features, including XML parsing. Rfm has been tested and works with ActiveSupport 2.3.5 thru 3.1.3. 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 model functionality and Filemaker interaction will continue to work, unaffected by the presence or absence of ActiveModel.
+
+To get the best performance, it is recommended that you use the LibXML or Nokogiri 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. 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.
+
+### Using Bundler and/or Rails >= 3.0
 
 In the Gemfile:
 
-    gem 'ginjo-rfm'
+	   gem 'ginjo-rfm'
+	   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 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'
+
+
 
 ### Edge - in an upcoming version of ginjo-rfm
 
-ActiveModel support.
-    
-    class Account < Rfm::Base
-      config :layout=>'account_xml'
-      before_create :encrypt_password
-      validates :email, :presence => true
-      validates :username, :presence => true
-      attr_accessor :password
-    end
-    
-    @account = Account.new(:username=>'bill', :password=>'pass')
-    @account.email = 'my@email.com'
-    @account.save!
-    
-Multiple backend xml parsers.
-
-    Rfm::Server.new(:backend => :nokogiri)
-    # Backend options => :libxml, :libxmlsax, :nokogiri, :nokogirisax, :hpricot, :rexml
-    
-Try out these unreleased features in the edge branch.
-
-    #gemfile
-    gem 'ginjo-rfm', :git=>'git://github.com/ginjo/rfm.git', :branch=>'edge'
-    
+Try out unreleased features of ginjo-rfm in the edge branch.
+
+	   #gemfile
+	   gem 'ginjo-rfm', :git=>'git://github.com/ginjo/rfm.git', :branch=>'edge'
+   
+   
+
+## Basic usage
+
+Put your configuration settings in a hash represented by RFM_CONFIG. This will make it easier to get and use objects in Rfm.
+
+	   RFM_CONFIG = {
+	     :host          => 'main_host',
+	     :database      => 'main_database',
+	     :account_name  => 'myname',
+	     :password      => 'somepass',
+	     :ssl           => false,
+	     :second_server => {
+	       :host        => 'second_host',
+	       :database    => 'second_database'
+	     }
+
+Then you have two easy ways to access your layouts - and your data.
+
+
+### With models
+
+Rfm models provide easy access to the record-finder functions of Rfm layouts, and they give us a way to easily persist objects to the database.
+
+	   class User < Rfm::Base
+	     config :layout => 'my_layout_name'
+	   end
+	
+	   @user = User.new(:login => 'bill', :password => 'xxxxxxxx', :email => 'my@email.com')
+	   @user.save!
+	
+	   @user.login
+	   # => 'bill'
+
+	   @user.field_names
+	   # => ['login', 'encryptedPassword', 'email', 'groups', 'lastLogin' ]
+	
+	   User.field_names
+	   # => ['login', 'encryptedPassword', 'email', 'groups', 'lastLogin' ]
+
+### Manually
+
+Create a layout object using default configuration settings.
+
+	   my_layout = Rfm.layout 'layout_name'
+	
+Create a layout object using a subgroup of configuration settings.
+
+	   my_layout = Rfm.layout :subgroup_name
+	
+Create a layout object passing in a layout name, multiple config subgroups to merge, and specific settings.
+
+	   my_layout = Rfm.layout 'layout_name', :second_server, :log_actions => true
+
+
+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 documentation for Rfm::Layout, Rfm::Record, and Rfm::Base.
+
+
+# Working with "classic" Rfm features
+
+All of Rfm's original features and functions are available as they were before, though some low-level functionality has changed slightly.
+
+
 ## Connecting
 
 IMPORTANT:SSL and Certificate verification are on by default. Please see Server#new in rdocs for explanation and setup.
 You connect with the Rfm::Server object. This little buddy will be your window into FileMaker data.
 
-    require 'rfm'
+	   require 'rfm'
 
-    my_server = Rfm::Server.new(
-      :host           => 'myservername',
-      :account_name   => 'user',
-      :password       => 'pw',
-      :ssl            => false
-    )
+	   my_server = Rfm::Server.new(
+	     :host           => 'myservername',
+	     :account_name   => 'user',
+	     :password       => 'pw',
+	     :ssl            => false
+	   )
 
 if your web publishing engine runs on a port other than 80, you can provide the port number as well:
 
-    my_server = Rfm::Server.new(
-      :host           => 'myservername',
-      :account_name   => 'user',
-      :password       => 'pw',
-      :port           => 8080, 
-      :ssl            => false,
-      :root_cert      => false
-    )
+	   my_server = Rfm::Server.new(
+	     :host           => 'myservername',
+	     :account_name   => 'user',
+	     :password       => 'pw',
+	     :port           => 8080, 
+	     :ssl            => false,
+	     :root_cert      => false
+	   )
 
 ## Databases and Layouts
 
 All access to data in FileMaker's XML interface is done through layouts, and layouts live in databases. The Rfm::Server object has a collection of databases called 'db'. So to get ahold of a database called "My Database", you can do this:
 
-    my_db = my_server.db["My Database"]
+	   my_db = my_server.db["My Database"]
 
 As a convenience, you can do this too:
 
-    my_db = my_server["My Database"]
+	   my_db = my_server["My Database"]
 
 Finally, if you want to introspect the server and find out what databases are available, you can do this:
 
-    all_dbs = my_server.db.all
+	   all_dbs = my_server.db.all
 
 In any case, you get back Rfm::Database objects. A database object in turn has a property called "layout":
 
-    my_layout = my_db.layout["My Layout"]
+	   my_layout = my_db.layout["My Layout"]
 
 Again, for convenience:
 
-    my_layout = my_db["My Layout"]
+	   my_layout = my_db["My Layout"]
 
 And to get them all:
 
-    all_layouts = my_db.layout.all
+	   all_layouts = my_db.layout.all
 
 Bringing it all together, you can do this to go straight from a server to a specific layout:
 
-    my_layout = my_server["My Database"]["My Layout"]
+	   my_layout = my_server["My Database"]["My Layout"]
 
 ## Working with Layouts
 
 Once you have a layout object, you can start doing some real work. To get every record from the layout:
 
-    my_layout.all   # be careful with this
+	   my_layout.all   # be careful with this
 
 To get a random record:
 
-    ruby
-    my_layout.any
+	   my_layout.any
 
 To find every record with "Arizona" in the "State" field:
 
-    my_layout.find({"State" => "Arizona"})
+	   my_layout.find({"State" => "Arizona"})
 
 To add a new record with my personal info:
 
-    my_layout.create({
-      :first_name   => "Geoff",
-      :last_name    => "Coffey",
-      :email        => "gwcoffey@gmail.com"}
-    )
+	   my_layout.create({
+	     :first_name   => "Geoff",
+	     :last_name    => "Coffey",
+	     :email        => "gwcoffey@gmail.com"}
+	   )
 
 Notice that in this case I used symbols instead of strings for the hash keys. The API will accept either form, so if your field names don't have whitespace or punctuation, you might prefer the symbol notation.
 
-To edit the record whos recid (filemaker internal record id) is 200:
+To edit the record whose recid (filemaker internal record id) is 200:
 
-    my_layout.edit(200, {:first_name => 'Mamie'})
+	   my_layout.edit(200, {:first_name => 'Mamie'})
 
 Note: See the "Record Objects" section below for more on editing records.
 
 To delete the record whose recid is 200:
 
-    my_layout.delete(200)
+	   my_layout.delete(200)
 
 All of these methods return an Rfm::Result::ResultSet object (see below), and every one of them takes an optional parameter (the very last one) with additional options. For example, to find just a page full of records, you can do this:
 
-    my_layout.find({:state => "AZ"}, {:max_records => 10, :skip_records => 100})
+	   my_layout.find({:state => "AZ"}, {:max_records => 10, :skip_records => 100})
 
 For a complete list of the available options, see the "expand_options" method in the Rfm::Server object in the file named rfm_command.rb.
 
@@ -185,84 +418,84 @@ Finally, if filemaker returns an error when executing any of these methods, an e
 
 Any method on the Layout object that returns data will return a ResultSet object. Rfm::Result::ResultSet is a subclass of Array, so first and foremost, you can use it like any other array:
 
-    my_result = my_layout.any
-    my_result.size  # returns '1'
-    my_result[0]    # returns the first record (an Rfm::Result::Record object)
+	   my_result = my_layout.any
+	   my_result.size  # returns '1'
+	   my_result[0]    # returns the first record (an Rfm::Result::Record object)
 
 The ResultSet object also tells you information about the fields and portals in the result. ResultSet#fields and ResultSet#portals are both standard ruby hashes, with strings for keys. The fields hash has Rfm::Result::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.fields.each { |name, field| puts name }
+	   my_result.fields.each { |name, field| puts name }
 
 This would print out the tables each portal on the layout is associated with. Below each table name, and indented, it will print the names of all the fields on each portal.
 
-    my_result.portals.each { |table, fields|
-      puts "table: #{table}"
-      fields.each { |name, field| puts "\t#{name}"}
-    }
+	   my_result.portals.each { |table, fields|
+	     puts "table: #{table}"
+	     fields.each { |name, field| puts "\t#{name}"}
+	   }
 
 But most importantly, the ResultSet contains record objects. Rfm::Result::Record is a subclass of Hash, so it can be used in many standard ways. This code would print the value in the 'first_name' field in the first record of the ResultSet:
 
-    my_record = my_result[0]
-    puts my_record["first_name"]
+	   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:
 
-    puts my_record.first_name
+	   puts my_record.first_name
 
 Since ResultSets are arrays and Records are hashes, you can take advantage of Ruby's wonderful expressiveness. For example, to get a comma-separated list of the full names of all the people in California, you could do this:
 
-    my_layout.find(:state => 'CA').collect {|rec| "#{rec.first_name} #{rec.last_name}"}.join(", ")
+	   my_layout.find(:state => 'CA').collect {|rec| "#{rec.first_name} #{rec.last_name}"}.join(", ")
 
 Record objects can also be edited:
 
-    my_record.first_name = 'Isabel'
+	   my_record.first_name = 'Isabel'
 
 Once you have made a series of edits, you can save them back to the database like this:
 
-    my_record.save
+	   my_record.save
 
 The save operation causes the record to be reloaded from the database, so any changes that have been made outside your script will also be picked up after the save.
 
 If you want to detect concurrent modification, you can do this instead:
 
-    my_record.save_if_not_modified
+	   my_record.save_if_not_modified
 
 This version will refuse to update the database and raise an error if the record was modified after it was loaded but before it was saved.
 
 Record objects also have portals. While the portals in a ResultSet tell you about the tables and fields the portals show, the portals in a Record have the actual data. For example, if an Order record has Line Item records, you could do this:
 
-    my_order = order_layout.any[0]  # the [0] is important!
-    my_lines = my_order.portals["Line Items"]
+	   my_order = order_layout.any[0]  # the [0] is important!
+	   my_lines = my_order.portals["Line Items"]
 
 At the end of the previous block of code, my_lines is an array of Record objects. In this case, they are the records in the "Line Items" portal for the particular order record. You can then operate on them as you would any other record. 
 
 NOTE: Fields on a portal have the table name and the "::" stripped off of their names if they belong to the table the portal is tied to. In other words, if our "Line Items" portal includes a quantity field and a price field, you would do this:
 
-    my_lines[0]["Quantity"]
-    my_lines[0]["Price"]
+	   my_lines[0]["Quantity"]
+	   my_lines[0]["Price"]
 
 You would NOT do this:
 
-    my_lines[0]["Line Items::Quantity"]
-    my_lines[0]["Line Items::Quantity"]
+	   my_lines[0]["Line Items::Quantity"]
+	   my_lines[0]["Line Items::Quantity"]
 
 My feeling is that the table name is redundant and cumbersome if it is the same as the portal's table. This is also up for debate.
 
 Again, you can string things together with Ruby. This will calculate the total dollar amount of the order:
 
-    total = 0.0
-    my_order.portals["Line Items"].each {|line| total += line.quantity * line.price}
+	   total = 0.0
+	   my_order.portals["Line Items"].each {|line| total += line.quantity * line.price}
 
 ## Data Types
 
 FileMaker's field types are coerced to Ruby types thusly:
 
-    Text Field       -> String object  
-    Number Field     -> BigDecimal object  # see below  
-    Date Field       -> Date object  
-    Time Field       -> DateTime object # see below  
-    TimeStamp Field  -> DateTime object  
-    Container Field  -> URI object  
+	   Text Field       -> String object  
+	   Number Field     -> BigDecimal object  # see below  
+	   Date Field       -> Date object  
+	   Time Field       -> DateTime object # see below  
+	   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.
 
@@ -270,9 +503,9 @@ Also, Ruby doesn't have a Time type that stores just a normal time (with no date
 
 Finally, container fields will come back as URI objects. You can:
 
-  - use Net::HTTP to download the contents of the container field using this URI
-  - to_s the URI and use it as the src attribute of an HTML image tag
-  - etc...
+	- use Net::HTTP to download the contents of the container field using this URI
+	- to_s the URI and use it as the src attribute of an HTML image tag
+	- etc...
 
 Specifically, the URI refers to the _contents_ of the container field. When accessed, the file, picture, or movie in the field will be downloaded.
 
@@ -288,13 +521,25 @@ When this is 'true' your script will dump the actual response it got from FileMa
 
 So, for an annoying, but detailed load of output, make a connection like this:
 
-    my_server => Rfm::Server.new(
-      :host             => 'myservername',
-      :account_name     => 'user',
-      :password         => 'pw',
-      :log_actions      => true,
-      :log_responses    => true
-    )
+	   my_server => Rfm::Server.new(
+	     :host             => 'myservername',
+	     :account_name     => 'user',
+	     :password         => 'pw',
+	     :log_actions      => true,
+	     :log_responses    => true
+	   )
+
+
+## Credits
+
+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.
+* 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.
 
 ## Copyright