ginjo-rfm 1.4.3 → 1.4.4

data/README.md

@@ -1,6 +1,6 @@
 # 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://rdoc.info/projects/lardawge/rfm) courtesey of Larry Sprock.
+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 was primarily designed by Six Fried Rice co-founder Geoff Coffey.
 
@@ -9,15 +9,18 @@ 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 and switched the xml parser to a much faster Nokogiri.
+* 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.
 
-Documentation
+Documentation & Links
 
-* Homepage:       <http://sixfriedrice.com/wp/products/rfm/>
-* Rdoc location:  <http://rubydoc.info/gems/lardawge-rfm/1.4.1.2/frames>
-* Discussion:     <http://groups.google.com/group/rfmcommunity>
+* 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>
 
-An incomplete list of recent features added since rfm 1.0.0.
+Partial list of features added since rfm 1.0.0.
 
 * SSL support
 * Nokogiri xml parser
@@ -29,6 +32,7 @@ Partial roadmap to the future
 
 * ActiveModel compatibility
 * Alternative XML parsers
+* Complex Filemaker queries
 * More tests
 
 
@@ -43,22 +47,19 @@ Terminal:
 
 Once the gem is installed, you can use rfm in your ruby scripts by requiring it:
 
-    #ruby
     require 'rubygems'
     require 'rfm'
 
-### In Rails >= 3.0
+### In Rails >= 3.0, or any project using Bundler
 
 In the Gemfile:
 
-    #ruby
     gem 'ginjo-rfm'
 
 ### Edge - in an upcoming version of ginjo-rfm
 
 ActiveModel support.
     
-    #ruby
     class Account < Rfm::Base
       config :layout=>'account_xml'
       before_create :encrypt_password
@@ -71,12 +72,12 @@ ActiveModel support.
     @account.email = 'my@email.com'
     @account.save!
     
-Multiple backend xml parsers. Uses ActiveSupport::XmlMini to support Nokogiri, Libxml-ruby, or Rexml.
+Multiple backend xml parsers.
 
-		Rfm::Server.new(:backend => :nokogiri)
-    # Backend options => :libxml, :libxmlsax, :nokogiri, :nokogirisax, :rexml
+    Rfm::Server.new(:backend => :nokogiri)
+    # Backend options => :libxml, :libxmlsax, :nokogiri, :nokogirisax, :hpricot, :rexml
     
-Try it out:
+Try out these unreleased features in the edge branch.
 
     #gemfile
     gem 'ginjo-rfm', :git=>'git://github.com/ginjo/rfm.git', :branch=>'edge'
@@ -86,7 +87,6 @@ Try it out:
 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.
 
-    #ruby
     require 'rfm'
 
     my_server = Rfm::Server.new(
@@ -98,7 +98,6 @@ You connect with the Rfm::Server object. This little buddy will be your window i
 
 if your web publishing engine runs on a port other than 80, you can provide the port number as well:
 
-    #ruby
     my_server = Rfm::Server.new(
       :host           => 'myservername',
       :account_name   => 'user',
@@ -112,44 +111,36 @@ if your web publishing engine runs on a port other than 80, you can provide the
 
 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:
 
-    #ruby
     my_db = my_server.db["My Database"]
 
 As a convenience, you can do this too:
 
-    #ruby
     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:
 
-    #ruby
     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":
 
-    #ruby
     my_layout = my_db.layout["My Layout"]
 
 Again, for convenience:
 
-    #ruby
     my_layout = my_db["My Layout"]
 
 And to get them all:
 
-    #ruby
     all_layouts = my_db.layout.all
 
 Bringing it all together, you can do this to go straight from a server to a specific layout:
 
-    #ruby
     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:
 
-    #ruby
     my_layout.all   # be careful with this
 
 To get a random record:
@@ -159,12 +150,10 @@ To get a random record:
 
 To find every record with "Arizona" in the "State" field:
 
-    #ruby
     my_layout.find({"State" => "Arizona"})
 
 To add a new record with my personal info:
 
-    #ruby
     my_layout.create({
       :first_name   => "Geoff",
       :last_name    => "Coffey",
@@ -175,19 +164,16 @@ Notice that in this case I used symbols instead of strings for the hash keys. Th
 
 To edit the record whos recid (filemaker internal record id) is 200:
 
-    #ruby
     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:
 
-    #ruby
     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:
 
-    #ruby
     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.
@@ -199,19 +185,16 @@ 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:
 
-    #ruby
     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:
 
-    #ruby
     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.
 
-    #ruby
     my_result.portals.each { |table, fields|
       puts "table: #{table}"
       fields.each { |name, field| puts "\t#{name}"}
@@ -219,42 +202,35 @@ This would print out the tables each portal on the layout is associated with. Be
 
 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:
 
-    #ruby
     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:
 
-    #ruby
     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:
 
-    #ruby
     my_layout.find(:state => 'CA').collect {|rec| "#{rec.first_name} #{rec.last_name}"}.join(", ")
 
 Record objects can also be edited:
 
-    #ruby
     my_record.first_name = 'Isabel'
 
 Once you have made a series of edits, you can save them back to the database like this:
 
-    #ruby
     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:
 
-    #ruby
     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:
 
-    #ruby
     my_order = order_layout.any[0]  # the [0] is important!
     my_lines = my_order.portals["Line Items"]
 
@@ -262,13 +238,11 @@ At the end of the previous block of code, my_lines is an array of Record objects
 
 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:
 
-    #ruby
     my_lines[0]["Quantity"]
     my_lines[0]["Price"]
 
 You would NOT do this:
 
-    #ruby
     my_lines[0]["Line Items::Quantity"]
     my_lines[0]["Line Items::Quantity"]
 
@@ -276,7 +250,6 @@ My feeling is that the table name is redundant and cumbersome if it is the same
 
 Again, you can string things together with Ruby. This will calculate the total dollar amount of the order:
 
-    #ruby
     total = 0.0
     my_order.portals["Line Items"].each {|line| total += line.quantity * line.price}
 
@@ -315,7 +288,6 @@ 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:
 
-    #ruby
     my_server => Rfm::Server.new(
       :host             => 'myservername',
       :account_name     => 'user',

data/lib/rfm.rb

@@ -1,13 +1,7 @@
-# path = File.expand_path(File.dirname(__FILE__))
-# $:.unshift(path) unless $:.include?(path)
-# 
-# require path + '/rfm/utilities/case_insensitive_hash'
-# require path + '/rfm/utilities/factory'
-# require path + '/rfm/version.rb'
-
-Rfm = Module.new unless defined? Rfm
-Rfm::PATH = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.unshift(Rfm::PATH) unless $LOAD_PATH.include?(Rfm::PATH)
+module Rfm
+	PATH = File.expand_path(File.dirname(__FILE__))
+	$LOAD_PATH.unshift(PATH) unless $LOAD_PATH.include?(PATH)
+end
 
 require 'rfm/utilities/case_insensitive_hash'
 require 'rfm/utilities/factory'

data/lib/rfm/VERSION

@@ -1 +1 @@
-1.4.3
+1.4.4

data/lib/rfm/layout.rb

@@ -221,46 +221,36 @@ module Rfm
       @value_lists
     end
     
-    private
+  private
     
     def load
     	#require 'rexml/document'
     	require 'nokogiri'
     	
       @loaded = true
-      #fmpxmllayout = @db.server.load_layout(self).body
       fmpxmllayout = @db.server.load_layout(self)
-      #doc = REXML::Document.new(fmpxmllayout)
       doc = Nokogiri::XML(fmpxmllayout)
-      #root = doc.root
       
       # check for errors
-      #error = root.elements['ERRORCODE'].text.to_i
       error = doc.xpath('//ERRORCODE').children[0].to_s.to_i
       raise Rfm::Error::FileMakerError.getError(error) if error != 0
       
       # process valuelists
-      if doc.xpath('//VALUELIST').size > 0    #root.elements['VALUELISTS'].size > 0
-        #root.elements['VALUELISTS'].each_element('VALUELIST') { |valuelist|
+      if doc.xpath('//VALUELIST').size > 0
         doc.xpath('//VALUELIST').each {|valuelist|
           name = valuelist['NAME']
-          #@value_lists[name] = valuelist.elements.collect {|e| e.text}
           @value_lists[name] = valuelist.children.collect{|value|
           	Rfm::Metadata::ValueListItem.new(value.children[0].to_s, value['DISPLAY'], name)
-          }
+          } rescue []
         }
         @value_lists.freeze
       end
 
       # process field controls
-      #root.elements['LAYOUT'].each_element('FIELD') { |field|
       doc.xpath('//FIELD').each {|field|
-        #name = field.attributes['NAME']
         name = field['NAME']
         style_xml = field.children[0]
-        #style = field.elements['STYLE'].attributes['TYPE']
         style = style_xml['TYPE']
-        #value_list_name = field.elements['STYLE'].attributes['VALUELIST']
         value_list_name = style_xml['VALUELIST']
         value_list = @value_lists[value_list_name] if value_list_name != ''
         field_control = Rfm::Metadata::FieldControl.new(name, style, value_list_name, value_list)

data/lib/rfm/metadata/value_list_item.rb

@@ -1,27 +1,30 @@
 module Rfm
-module Metadata
-
-  # The ValueListItem object represents a item in a Filemaker value list. 
-  #
-  # =Attributes
-  #
-  # * *value* the value list item value
-  #
-  # * *display* is the value list item display string
-  # * * it could be the same as value, or it could be the "second field"  # * * :scrollable - an editable field with scroll bar
-  # * * if that option is checked in Filemaker
-  #
-  # * *value_list_name* is the name of the parent value list, if any
-  class ValueListItem < String
-    def initialize(value, display, value_list_name)
-      @value_list_name = value_list_name
-      @value					 = value
-      @display				 = display
-      self.replace value
-    end
-    
-    attr_reader :value, :display, :value_list_name
-  
-  end
-end
-end
+	module Metadata
+	
+	  # The ValueListItem object represents an item in a Filemaker value list.
+	  # ValueListItem is subclassed from String, so you can use it just like
+	  # a string. It does have three additional methods to help separate Filemaker *value*
+	  # vs *display* items.
+	  #
+	  # Getting values vs display items:
+	  #
+	  # * *#value* the value list item value
+	  #
+	  # * *#display* is the value list item display. It could be the same
+	  #   as +value+, or it could be the "second field", if that option is checked in Filemaker
+	  #
+	  # * *#value_list_name* is the name of the parent value list, if any
+	  class ValueListItem < String
+	    attr_reader :value, :display, :value_list_name
+	    
+	    def initialize(value, display, value_list_name)
+	      @value_list_name = value_list_name
+	      @value					 = value.to_s
+	      @display				 = display.to_s
+	      self.replace @value
+	    end
+	  
+	  end # ValueListItem
+	  
+	end # Metadata
+end # Rfm

data/lib/rfm/record.rb

@@ -167,6 +167,7 @@ module Rfm
       self.merge!(@layout.edit(self.record_id, @mods)[0]) if @mods.size > 0
       @mods.clear
     end
+    
 
     # Like Record::save, except it fails (and raises an error) if the underlying record in FileMaker was
     # modified after the record was fetched but before it was saved. In other words, prevents you from
@@ -190,7 +191,7 @@ module Rfm
     # When you do, the change is noted, but *the data is not updated in FileMaker*. You must call
     # Record::save or Record::save_if_not_modified to actually save the data.
     def []=(name, value)
-    	name = name.to_s
+    	name = name.to_s.downcase
       return super unless @loaded
       raise Rfm::ParameterError, 
         "You attempted to modify a field that does not exist in the current Filemaker layout." unless self.key?(name)
@@ -211,9 +212,9 @@ module Rfm
     private
 
       def read_attribute(key)
-      	key = key.to_s
+      	key_string = key.to_s.downcase
         raise NoMethodError, 
-          "#{key.to_s} does not exists as a field in the current Filemaker layout." unless (!@layout or self.key?(key))
+          "#{key_string} does not exists as a field in the current Filemaker layout." unless (!@layout or self.key?(key_string))   #!self.keys.grep(/#{key_string}/i).empty?
         self._old_hash_reader(key).to_s.empty? ? nil : self._old_hash_reader(key) if self._old_hash_reader(key)
       end
 
@@ -222,7 +223,6 @@ module Rfm
         return read_attribute(method) if self.key?(method)
       
         if method =~ /(=)$/ && self.key?($`)
-          #return @mods[$`] = attrs.first
           return self[$`] = attrs.first
         end
         super

data/lib/rfm/resultset.rb

@@ -8,7 +8,6 @@
 require 'nokogiri'
 require 'bigdecimal'
 require 'rfm/record'
-#require 'rfm/metadata/field'
 
 module Rfm
 

data/lib/rfm/server.rb

@@ -138,7 +138,7 @@ module Rfm
     #   ignores FileMaker's 401 error (no records found) and returns an empty record set instead; if you
     #   prefer a raised error when a find produces no errors, set this option to +true+
     #
-    #SSL Options (SSL AND CERTIFICATE VERIFICATION ARE ON BY DEFAULT):
+    # ===SSL Options (SSL AND CERTIFICATE VERIFICATION ARE ON BY DEFAULT):
     #
     # * *ssl* +false+ if you want to turn SSL (HTTPS) off when connecting to connect to FileMaker (default is +true+)
     #
@@ -154,7 +154,7 @@ module Rfm
     #
     # * *root_cert_path* path to cert file. (defaults to '/' if no path given)
     #
-    #Configuration Examples:    
+    # ===Configuration Examples:    
     #
     # Example to turn off SSL:
     # 

data/lib/rfm/version.rb

@@ -1,8 +1,6 @@
 module Rfm
-
 	VERSION_DEFAULT = 'none'
-	VERSION = File.read(PATH + '/rfm/VERSION').first.gsub(/\n|\r/,'')  rescue VERSION_DEFAULT #File.read(File.join(File.expand_path(File.dirname(File.dirname(File.dirname(__FILE__)))), 'VERSION')) rescue VERSION_DEFAULT
-  
+	VERSION = File.read(PATH + '/rfm/VERSION').lines.first.chomp  rescue VERSION_DEFAULT #File.read(File.join(File.expand_path(File.dirname(File.dirname(File.dirname(__FILE__)))), 'VERSION')) rescue VERSION_DEFAULT
   VERSION.instance_eval do
   	def components; VERSION.split('.'); end
   	def major; components[0]; end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ginjo-rfm
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: 
   segments: 
   - 1
   - 4
-  - 3
-  version: 1.4.3
+  - 4
+  version: 1.4.4
 platform: ruby
 authors: 
 - Geoff Coffey
@@ -19,7 +19,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-22 00:00:00 Z
+date: 2011-12-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -35,6 +35,78 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id006
 description: Rfm brings your FileMaker data to Ruby. Now your Ruby scripts and Rails applications can talk directly to your FileMaker server.
 email: http://groups.google.com/group/rfmcommunity
 executables: []
@@ -69,7 +141,7 @@ post_install_message:
 rdoc_options: 
 - --line-numbers
 - --main
-- README.rdoc
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement