ginjo-rfm 1.4.2

data/lib/rfm/metadata/field.rb

@@ -0,0 +1,93 @@
+module Rfm
+  module Metadata
+    # The Field object represents a single FileMaker field. It *does not hold the data* in the field. Instead,
+    # it serves as a source of metadata about the field. For example, if you're script is trying to be highly
+    # dynamic about its field access, it may need to determine the data type of a field at run time. Here's
+    # how:
+    #
+    #   field_name = "Some Field Name"
+    #   case myRecord.fields[field_name].result
+    #   when "text"
+    #     # it is a text field, so handle appropriately
+    #   when "number"
+    #     # it is a number field, so handle appropriately
+    #   end
+    #
+    # =Attributes
+    #
+    # The Field object has the following attributes:
+    #
+    # * *name* is the name of the field
+    #
+    # * *result* is the data type of the field; possible values include:
+    #   * text
+    #   * number
+    #   * date
+    #   * time
+    #   * timestamp
+    #   * container
+    #
+    # * *type* any of these:
+    #   * normal (a normal data field)
+    #   * calculation
+    #   * summary
+    #
+    # * *max_repeats* is the number of repetitions (1 for a normal field, more for a repeating field)
+    #
+    # * *global* is +true+ is this is a global field, *false* otherwise
+    #
+    # Note: Field types match FileMaker's own values, but the terminology differs. The +result+ attribute
+    # tells you the data type of the field, regardless of whether it is a calculation, summary, or normal
+    # field. So a calculation field whose result type is _timestamp_ would have these attributes:
+    #
+    # * result: timestamp
+    # * type: calculation
+    #
+    # * *control& is a FieldControl object representing the sytle and value list information associated
+    #   with this field on the layout.
+    # 
+    # Note: Since a field can sometimes appear on a layout more than once, +control+ may be an Array.
+    # If you don't know ahead of time, you'll need to deal with this. One easy way is:
+    #
+    #   controls = [myField.control].flatten
+    #   controls.each {|control|
+    #     # do something with the control here
+    #   }
+    #
+    # The code above makes sure the control is always an array. Typically, though, you'll know up front
+    # if the control is an array or not, and you can code accordingly.
+    
+    class Field
+      
+      attr_reader :name, :result, :type, :max_repeats, :global
+      
+      # Initializes a field object. You'll never need to do this. Instead, get your Field objects from
+      # ResultSet::fields
+      def initialize(field)
+        @name        = field['name']
+        @result      = field['result']
+        @type        = field['type']
+        @max_repeats = field['max-repeats']
+        @global      = field['global']
+      end
+    
+      # Coerces the text value from an +fmresultset+ document into proper Ruby types based on the 
+      # type of the field. You'll never need to do this: Rfm does it automatically for you when you
+      # access field data through the Record object.
+      def coerce(value, resultset)
+        return nil if value.empty?
+        case self.result
+        when "text"      then value
+        when "number"    then BigDecimal.new(value)
+        when "date"      then Date.strptime(value, resultset.date_format)
+        when "time"      then DateTime.strptime("1/1/-4712 #{value}", "%m/%d/%Y #{resultset.time_format}")
+        when "timestamp" then DateTime.strptime(value, resultset.timestamp_format)
+        when "container" then URI.parse("#{resultset.server.scheme}://#{resultset.server.host_name}:#{resultset.server.port}#{value}")
+        else nil
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/rfm/metadata/field_control.rb

@@ -0,0 +1,53 @@
+module Rfm
+module Metadata
+
+  # The FieldControl object represents a field on a FileMaker layout. You can find out what field
+  # style the field uses, and the value list attached to it.
+  #
+  # =Attributes
+  #
+  # * *name* is the name of the field
+  #
+  # * *style* is any one of:
+  # * * :edit_box - a normal editable field
+  # * * :scrollable - an editable field with scroll bar
+  # * * :popup_menu - a pop-up menu
+  # * * :checkbox_set - a set of checkboxes
+  # * * :radio_button_set - a set of radio buttons
+  # * * :popup_list - a pop-up list
+  # * * :calendar - a pop-up calendar
+  #
+  # * *value_list_name* is the name of the attached value list, if any
+  # 
+  # * *value_list* is an array of strings representing the value list items, or nil
+  #   if this field has no attached value list
+  class FieldControl
+    def initialize(name, style, value_list_name, value_list)
+      @name = name
+      case style
+      when "EDITTEXT"
+        @style = :edit_box
+      when "POPUPMENU"
+        @style = :popup_menu
+      when "CHECKBOX"
+        @style = :checkbox_set
+      when "RADIOBUTTONS"
+        @style = :radio_button_set
+      when "POPUPLIST"
+        @style = :popup_list
+      when "CALENDAR"
+        @style = :calendar
+      when "SCROLLTEXT"
+        @style = :scrollable
+      else
+        nil
+      end
+      @value_list_name = value_list_name
+      @value_list = value_list
+    end
+    
+    attr_reader :name, :style, :value_list_name, :value_list
+  
+  end
+end
+end

data/lib/rfm/metadata/script.rb

@@ -0,0 +1,20 @@
+module Rfm
+  module Metadata
+    # The Script object represents a FileMaker script. At this point, the Script object exists only so
+    # you can enumrate all scripts in a Database (which is a rare need):
+    # 
+    #   myDatabase.script.each {|script|
+    #     puts script.name
+    #   }
+    #
+    # If you want to _run_ a script, see the Layout object instead.
+    class Script
+      def initialize(name, db)
+        @name = name
+        @db = db
+      end
+      
+      attr_reader :name
+    end
+  end
+end

data/lib/rfm/metadata/value_list_item.rb

@@ -0,0 +1,27 @@
+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

data/lib/rfm/record.rb

@@ -0,0 +1,232 @@
+module Rfm
+  
+  # The Record object represents a single FileMaker record. You typically get them from ResultSet objects.
+  # For example, you might use a Layout object to find some records:
+  #
+  #   results = myLayout.find({"First Name" => "Bill"})
+  #
+  # The +results+ variable in this example now contains a ResultSet object. ResultSets are really just arrays of
+  # Record objects (with a little extra added in). So you can get a record object just like you would access any 
+  # typical array element:
+  #
+  #   first_record = results[0]
+  #
+  # You can find out how many record were returned:
+  #
+  #   record_count = results.size
+  #
+  # And you can of course iterate:
+  # 
+  #   results.each (|record|
+  #     // you can work with the record here
+  #   )
+  #
+  # =Accessing Field Data
+  #
+  # You can access field data in the Record object in two ways. Typically, you simply treat Record like a hash
+  # (because it _is_ a hash...I love OOP). Keys are field names:
+  # 
+  #   first = myRecord["First Name"]
+  #   last = myRecord["Last Name"]
+  #
+  # If your field naming conventions mean that your field names are also valid Ruby symbol named (ie: they contain only
+  # letters, numbers, and underscores) then you can treat them like attributes of the record. For example, if your fields
+  # are called "first_name" and "last_name" you can do this:
+  #
+  #   first = myRecord.first_name
+  #   last = myRecord.last_name
+  #
+  # Note: This shortcut will fail (in a rather mysterious way) if your field name happens to match any real attribute
+  # name of a Record object. For instance, you may have a field called "server". If you try this:
+  # 
+  #   server_name = myRecord.server
+  # 
+  # you'll actually set +server_name+ to the Rfm::Server object this Record came from. This won't fail until you try
+  # to treat it as a String somewhere else in your code. It is also possible a future version of Rfm will include
+  # new attributes on the Record class which may clash with your field names. This will cause perfectly valid code
+  # today to fail later when you upgrade. If you can't stomach this kind of insanity, stick with the hash-like
+  # method of field access, which has none of these limitations. Also note that the +myRecord[]+ method is probably
+  # somewhat faster since it doesn't go through +method_missing+.
+  #
+  # =Accessing Repeating Fields
+  #
+  # If you have a repeating field, RFM simply returns an array:
+  #
+  #   val1 = myRecord["Price"][0]
+  #   val2 = myRecord["Price"][1]
+  #
+  # In the above example, the Price field is a repeating field. The code puts the first repetition in a variable called 
+  # +val1+ and the second in a variable called +val2+.
+  #
+  # =Accessing Portals
+  #
+  # If the ResultSet includes portals (because the layout it comes from has portals on it) you can access them
+  # using the Record::portals attribute. It is a hash with table occurrence names for keys, and arrays of Record
+  # objects for values. In other words, you can do this:
+  #
+  #   myRecord.portals["Orders"].each {|record|
+  #     puts record["Order Number"]
+  #   }
+  #
+  # This code iterates through the rows of the _Orders_ portal.
+  # 
+  # =Field Types and Ruby Types
+  #
+  # RFM automatically converts data from FileMaker into a Ruby object with the most reasonable type possible. The 
+  # type are mapped thusly:
+  #
+  # * *Text* fields are converted to Ruby String objects
+  # 
+  # * *Number* fields are converted to Ruby BigDecimal objects (the basic Ruby numeric types have
+  #   much less precision and range than FileMaker number fields)
+  #
+  # * *Date* fields are converted to Ruby Date objects
+  #
+  # * *Time* fields are converted to Ruby DateTime objects (you can ignore the date component)
+  #
+  # * *Timestamp* fields are converted to Ruby DateTime objects
+  #
+  # * *Container* fields are converted to Ruby URI objects
+  #
+  # =Attributes
+  #
+  # In addition to +portals+, the Record object has these useful attributes:
+  #
+  # * *record_id* is FileMaker's internal identifier for this record (_not_ any ID field you might have
+  #   in your table); you need a +record_id+ to edit or delete a record
+  #
+  # * *mod_id* is the modification identifier for the record; whenever a record is modified, its +mod_id+
+  #   changes so you can tell if the Record object you're looking at is up-to-date as compared to another
+  #   copy of the same record
+  class Record < Rfm::CaseInsensitiveHash
+    
+    attr_reader :record_id, :mod_id, :portals
+
+    def initialize(record, result, field_meta, layout, portal=nil)
+      @record_id = record['record-id']
+      @mod_id    = record['mod-id']
+      @mods      = {}
+      @layout    = layout
+      @portals ||= Rfm::CaseInsensitiveHash.new
+
+      relatedsets = !portal && result.instance_variable_get(:@include_portals) ? record.xpath('relatedset') : []
+      
+      record.xpath('field').each do |field|
+        field_name = field['name']
+        field_name.gsub!(Regexp.new(portal + '::'), '') if portal
+        datum = []
+        
+        field.xpath('data').each do |x| 
+          datum.push(field_meta[field_name].coerce(x.inner_text, result))
+        end
+      
+        if datum.length == 1
+          self[field_name] = datum[0]
+        elsif datum.length == 0
+          self[field_name] = nil
+        else
+          self[field_name] = datum
+        end
+      end
+      
+      unless relatedsets.empty?
+        relatedsets.each do |relatedset|
+          tablename, records = relatedset['table'], []
+      
+          relatedset.xpath('record').each do |record|
+            records << self.class.new(record, result, result.portal_meta[tablename], layout, tablename)
+          end
+      
+          @portals[tablename] = records
+        end
+      end
+      
+      @loaded = true
+    end
+
+    def self.build_records(records, result, field_meta, layout, portal=nil)
+      records.each do |record|
+        result << self.new(record, result, field_meta, layout, portal)
+      end
+    end
+
+    # Saves local changes to the Record object back to Filemaker. For example:
+    #
+    #   myLayout.find({"First Name" => "Bill"}).each(|record|
+    #     record["First Name"] = "Steve"
+    #     record.save
+    #   )
+    #
+    # This code finds every record with _Bill_ in the First Name field, then changes the first name to 
+    # Steve.
+    #
+    # Note: This method is smart enough to not bother saving if nothing has changed. So there's no need
+    # to optimize on your end. Just save, and if you've changed the record it will be saved. If not, no
+    # server hit is incurred.
+    def save
+      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
+    # accidentally overwriting changes someone else made to the record.
+    def save_if_not_modified
+      self.merge!(@layout.edit(@record_id, @mods, {:modification_id => @mod_id})[0]) if @mods.size > 0
+      @mods.clear
+    end
+    
+    # Gets the value of a field from the record. For example:
+    #
+    #   first = myRecord["First Name"]
+    #   last = myRecord["Last Name"]
+    #
+    # This sample puts the first and last name from the record into Ruby variables.
+    #
+    # You can also update a field:
+    #
+    #   myRecord["First Name"] = "Sophia"
+    #
+    # 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
+      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)
+      @mods[name] = value
+      self.merge! @mods
+    end
+
+    alias :_old_hash_reader :[]
+    def [](value)
+      read_attribute(value)
+    end
+
+    def respond_to?(symbol, include_private = false)
+      return true if self.include?(symbol.to_s)
+      super
+    end
+
+    private
+
+      def read_attribute(key)
+      	key = key.to_s
+        raise NoMethodError, 
+          "#{key.to_s} does not exists as a field in the current Filemaker layout." unless (!@layout or self.key?(key))
+        self._old_hash_reader(key).to_s.empty? ? nil : self._old_hash_reader(key) if self._old_hash_reader(key)
+      end
+
+      def method_missing (symbol, *attrs, &block)
+        method = symbol.to_s
+        return read_attribute(method) if self.key?(method)
+      
+        if method =~ /(=)$/ && self.key?($`)
+          #return @mods[$`] = attrs.first
+          return self[$`] = attrs.first
+        end
+        super
+      end
+    
+  end
+end

data/lib/rfm/resultset.rb

@@ -0,0 +1,137 @@
+# This module includes classes that represent FileMaker data. When you communicate with FileMaker
+# using, ie, the Layout object, you typically get back ResultSet objects. These contain Records,
+# which in turn contain Fields, Portals, and arrays of data.
+#
+# Author::    Geoff Coffey  (mailto:gwcoffey@gmail.com)
+# Copyright:: Copyright (c) 2007 Six Fried Rice, LLC and Mufaddal Khumri
+# License::   See MIT-LICENSE for details
+require 'nokogiri'
+require 'bigdecimal'
+require 'rfm/record'
+#require 'rfm/metadata/field'
+
+module Rfm
+
+  # The ResultSet object represents a set of records in FileMaker. It is, in every way, a real Ruby
+  # Array, so everything you expect to be able to do with an Array can be done with a ResultSet as well.
+  # In this case, the elements in the array are Record objects.
+  #
+  # Here's a typical example, displaying the results of a Find:
+  #
+  #   myServer = Rfm::Server.new(...)
+  #   results = myServer["Customers"]["Details"].find("First Name" => "Bill")
+  #   results.each {|record|
+  #     puts record["First Name"]
+  #     puts record["Last Name"]
+  #     puts record["Email Address"]
+  #   }
+  #
+  # =Attributes
+  #
+  # The ResultSet object has these attributes:
+  #
+  # * *field_meta* is a hash with field names for keys and Field objects for values; it provides 
+  #   info about the fields in the ResultSet
+  #
+  # * *portal_meta* is a hash with table occurrence names for keys and arrays of Field objects for values;
+  #   it provides metadata about the portals in the ResultSet and the Fields on those portals
+
+  class Resultset < Array
+    
+    attr_reader :layout, :server
+    attr_reader :field_meta, :portal_meta
+    attr_reader :date_format, :time_format, :timestamp_format
+    attr_reader :total_count, :foundset_count
+    
+    # Initializes a new ResultSet object. You will probably never do this your self (instead, use the Layout
+    # object to get various ResultSet obejects).
+    #
+    # If you feel so inclined, though, pass a Server object, and some +fmpxmlresult+ compliant XML in a String.
+    #
+    # =Attributes
+    #
+    # The ResultSet object includes several useful attributes:
+    #
+    # * *fields* is a hash (with field names for keys and Field objects for values). It includes an entry for
+    #   every field in the ResultSet. Note: You don't use Field objects to access _data_. If you're after 
+    #   data, get a Record object (ResultSet is an array of records). Field objects tell you about the fields
+    #   (their type, repetitions, and so forth) in case you find that information useful programmatically.
+    #
+    #   Note: keys in the +fields+ hash are downcased for convenience (and [] automatically downcases on 
+    #   lookup, so it should be seamless). But if you +each+ a field hash and need to know a field's real
+    #   name, with correct case, do +myField.name+ instead of relying on the key in the hash.
+    #
+    # * *portals* is a hash (with table occurrence names for keys and Field objects for values). If your
+    #   layout contains portals, you can find out what fields they contain here. Again, if it's the data you're
+    #   after, you want to look at the Record object.
+    
+    def initialize(server, xml_response, layout, portals=nil)
+      @layout           = layout
+      @server           = server
+      @field_meta     ||= Rfm::CaseInsensitiveHash.new
+      @portal_meta    ||= Rfm::CaseInsensitiveHash.new
+      @include_portals  = portals 
+      
+      doc = Nokogiri.XML(remove_namespace(xml_response))
+      
+      error = doc.xpath('/fmresultset/error').attribute('code').value.to_i
+      check_for_errors(error, server.state[:raise_on_401])
+
+      datasource        = doc.xpath('/fmresultset/datasource')
+      meta              = doc.xpath('/fmresultset/metadata')
+      resultset         = doc.xpath('/fmresultset/resultset')
+
+      @date_format      = convert_date_time_format(datasource.attribute('date-format').value)
+      @time_format      = convert_date_time_format(datasource.attribute('time-format').value)
+      @timestamp_format = convert_date_time_format(datasource.attribute('timestamp-format').value)
+
+      @foundset_count   = resultset.attribute('count').value.to_i
+      @total_count      = datasource.attribute('total-count').value.to_i
+
+      parse_fields(meta)
+      parse_portals(meta) if @include_portals
+      
+      Rfm::Record.build_records(resultset.xpath('record'), self, @field_meta, @layout)
+      
+    end
+    
+    private
+      def remove_namespace(xml)
+        xml.gsub('xmlns="http://www.filemaker.com/xml/fmresultset" version="1.0"', '')
+      end
+    
+      def check_for_errors(code, raise_401)
+        raise Rfm::Error.getError(code) if code != 0 && (code != 401 || raise_401)
+      end
+    
+      def parse_fields(meta)
+        meta.xpath('field-definition').each do |field|
+          @field_meta[field['name']] = Rfm::Metadata::Field.new(field)
+        end
+      end
+
+      def parse_portals(meta)
+        meta.xpath('relatedset-definition').each do |relatedset|
+          table, fields = relatedset.attribute('table').value, {}
+
+          relatedset.xpath('field-definition').each do |field|
+            name = field.attribute('name').value.gsub(Regexp.new(table + '::'), '')
+            fields[name] = Rfm::Metadata::Field.new(field)
+          end
+
+          @portal_meta[table] = fields
+        end
+      end
+    
+      def convert_date_time_format(fm_format)
+        fm_format.gsub!('MM', '%m')
+        fm_format.gsub!('dd', '%d')
+        fm_format.gsub!('yyyy', '%Y')
+        fm_format.gsub!('HH', '%H')
+        fm_format.gsub!('mm', '%M')
+        fm_format.gsub!('ss', '%S')
+        fm_format
+      end
+    
+  end
+end