ginjo-rfm 1.4.4 → 2.0.pre31

data/lib/rfm/database.rb

@@ -65,17 +65,21 @@ module Rfm
     #   myDatabase = myServer["Customers"]
     #
     # This sample code gets a database object representing the Customers database on the FileMaker server.
-    def initialize(name, server)
-      @name = name
-      @server = server
-      @account_name = server.state[:account_name] or ""
-      @password = server.state[:password] or ""
+    def initialize(name, server_obj, acnt=nil, pass=nil)
+    	raise Rfm::Error::RfmError.new(0, "New instance of Rfm::Database has no name.") if name.to_s == ''
+      @name = name.to_s
+      rfm_metaclass.instance_variable_set :@server, server_obj
+      @account_name = acnt #server.state[:account_name] or ""
+      @password = pass #server.state[:password] or ""
       @layout = Rfm::Factory::LayoutFactory.new(server, self)
       @script = Rfm::Factory::ScriptFactory.new(server, self)
     end
     
-    attr_reader :server, :name, :account_name, :password, :layout, :script
+    meta_attr_reader :server
+    #attr_reader :server
+    attr_reader :name, :account_name, :password, :layout, :script
     attr_writer :account_name, :password
+    alias_method :layouts, :layout
 
     # Access the Layout object representing a layout in this database. For example:
     #
@@ -88,9 +92,10 @@ module Rfm
     # returned is created on the fly and assumed to refer to a valid layout, but you will
     # get no error at this point if the layout you specify doesn't exist. Instead, you'll
     # receive an error when you actually try to perform some action it.
-    def [](layout_name)
-      self.layout[layout_name]
-    end
+		#     def [](layout_name)
+		#       self.layout[layout_name]
+		#     end
+    def_delegator :layout, :[]
 
   end
 end

data/lib/rfm/layout.rb

@@ -119,6 +119,8 @@ module Rfm
   #   list that is attached to any field on the layout
   
   class Layout
+		
+  	include ComplexQuery
     
     # Initialize a layout object. You never really need to do this. Instead, just do this:
     # 
@@ -133,127 +135,182 @@ module Rfm
     #
     #   myServer = Rfm::Server.new(...)
     #   myLayout = myServer["Customers"]["Details"]
-    def initialize(name, db)
-      @name = name
-      @db = db
+    def initialize(name, db_obj)
+    	raise Rfm::Error::RfmError.new(0, "New instance of Rfm::Layout has no name.") if name.to_s == ''
+      @name = name.to_s
+      rfm_metaclass.instance_variable_set :@db, db_obj
       
       @loaded = false
       @field_controls = Rfm::CaseInsensitiveHash.new
-      @value_lists = Rfm::CaseInsensitiveHash.new      
+      @value_lists = Rfm::CaseInsensitiveHash.new
+			#       @portal_meta = nil
+			#       @field_names = nil
     end
     
-    attr_reader :name, :db
+    meta_attr_reader :db
+    attr_reader :name #, :db
+    attr_writer :field_names, :portal_meta, :table
+    def_delegator :db, :server
+    alias_method :database, :db
     
-    # Returns a ResultSet object containing _every record_ in the table associated with this layout.
-    def all(options = {})
-      get_records('-findall', {}, options)
-    end
     
-    # Returns a ResultSet containing a single random record from the table associated with this layout.
-    def any(options = {})
-      get_records('-findany', {}, options)
-    end
-  
-    # Finds a record. Typically you will pass in a hash of field names and values. For example:
-    #
-    #   myLayout.find({"First Name" => "Bill"})
-    #
-    # Values in the hash work just like value in FileMaker's Find mode. You can use any special
-    # symbols (+==+, +...+, +>+, etc...).
-    #
-    # If you pass anything other than a hash as the first parameter, it is converted to a string and
-    # assumed to be FileMaker's internal id for a record (the recid).
-    def find(hash_or_recid, options = {})
-      if hash_or_recid.kind_of? Hash
-        get_records('-find', hash_or_recid, options)
-      else
-        get_records('-find', {'-recid' => hash_or_recid.to_s}, options)
-      end
-    end
-  
-    # Updates the contents of the record whose internal +recid+ is specified. Send in a hash of new
-    # data in the +values+ parameter. Returns a RecordSet containing the modified record. For example:
-    #
-    #   recid = myLayout.find({"First Name" => "Bill"})[0].record_id
-    #   myLayout.edit(recid, {"First Name" => "Steve"})
-    #
-    # The above code would find the first record with _Bill_ in the First Name field and change the 
-    # first name to _Steve_.
-    def edit(recid, values, options = {})
-      get_records('-edit', {'-recid' => recid}.merge(values), options)
-    end
+    # These methods are to be inclulded in Layout and SubLayout, so that
+    # they have their own descrete 'self' in the master class and the subclass.
+    module LayoutModule
     
-    # Creates a new record in the table associated with this layout. Pass field data as a hash in the 
-    # +values+ parameter. Returns the newly created record in a RecordSet. You can use the returned
-    # record to, ie, discover the values in auto-enter fields (like serial numbers). 
-    #
-    # For example:
-    #
-    #   result = myLayout.create({"First Name" => "Jerry", "Last Name" => "Robin"})
-    #   id = result[0]["ID"]
-    #
-    # The above code adds a new record with first name _Jerry_ and last name _Robin_. It then
-    # puts the value from the ID field (a serial number) into a ruby variable called +id+.
-    def create(values, options = {})
-      get_records('-new', values, options)
-    end
+	    # Returns a ResultSet object containing _every record_ in the table associated with this layout.
+	    def all(options = {})
+	      get_records('-findall', {}, options)
+	    end
+	    
+	    # Returns a ResultSet containing a single random record from the table associated with this layout.
+	    def any(options = {})
+	      get_records('-findany', {}, options)
+	    end
+	  
+	    # Finds a record. Typically you will pass in a hash of field names and values. For example:
+	    #
+	    #   myLayout.find({"First Name" => "Bill"})
+	    #
+	    # Values in the hash work just like value in FileMaker's Find mode. You can use any special
+	    # symbols (+==+, +...+, +>+, etc...).
+	    #
+	    # If you pass anything other than a hash as the first parameter, it is converted to a string and
+	    # assumed to be FileMaker's internal id for a record (the recid).
+	    def find(hash_or_recid, options = {})
+	      if hash_or_recid.kind_of? Hash
+	        get_records('-find', hash_or_recid, options)
+	      else
+	        get_records('-find', {'-recid' => hash_or_recid.to_s}, options)
+	      end
+	    end
+	  
+	    # Updates the contents of the record whose internal +recid+ is specified. Send in a hash of new
+	    # data in the +values+ parameter. Returns a RecordSet containing the modified record. For example:
+	    #
+	    #   recid = myLayout.find({"First Name" => "Bill"})[0].record_id
+	    #   myLayout.edit(recid, {"First Name" => "Steve"})
+	    #
+	    # The above code would find the first record with _Bill_ in the First Name field and change the 
+	    # first name to _Steve_.
+	    def edit(recid, values, options = {})
+	      get_records('-edit', {'-recid' => recid}.merge(values), options)
+	    end
+	    
+	    # Creates a new record in the table associated with this layout. Pass field data as a hash in the 
+	    # +values+ parameter. Returns the newly created record in a RecordSet. You can use the returned
+	    # record to, ie, discover the values in auto-enter fields (like serial numbers). 
+	    #
+	    # For example:
+	    #
+	    #   result = myLayout.create({"First Name" => "Jerry", "Last Name" => "Robin"})
+	    #   id = result[0]["ID"]
+	    #
+	    # The above code adds a new record with first name _Jerry_ and last name _Robin_. It then
+	    # puts the value from the ID field (a serial number) into a ruby variable called +id+.
+	    def create(values, options = {})
+	      get_records('-new', values, options)
+	    end
+	    
+	    # Deletes the record with the specified internal recid. Returns a ResultSet with the deleted record.
+	    #
+	    # For example:
+	    #
+	    #   recid = myLayout.find({"First Name" => "Bill"})[0].record_id
+	    #   myLayout.delete(recid)
+	    # 
+	    # The above code finds every record with _Bill_ in the First Name field, then deletes the first one.
+	    def delete(recid, options = {})
+	      get_records('-delete', {'-recid' => recid}, options)
+	      return nil
+	    end
+	    
+	    def get_records(action, extra_params = {}, options = {})
+	      include_portals = options[:include_portals] ? options.delete(:include_portals) : nil
+	      xml_response = db.server.connect(db.account_name, db.password, action, params.merge(extra_params), options).body
+	      Rfm::Resultset.new(db.server, xml_response, self, include_portals)
+	    end
+	    
+	    def params
+	      {"-db" => db.name, "-lay" => self.name}
+	    end
+	    
+	  end # LayoutModule
+	  include LayoutModule
     
-    # Deletes the record with the specified internal recid. Returns a ResultSet with the deleted record.
-    #
-    # For example:
-    #
-    #   recid = myLayout.find({"First Name" => "Bill"})[0].record_id
-    #   myLayout.delete(recid)
-    # 
-    # The above code finds every record with _Bill_ in the First Name field, then deletes the first one.
-    def delete(recid, options = {})
-      get_records('-delete', {'-recid' => recid}, options)
-      return nil
-    end
     
     def field_controls
       load unless @loaded
       @field_controls
     end
     
+  	def field_names
+  		load unless @field_names
+  		@field_names
+  	end
+  	
+  	def field_names_no_load
+  		@field_names
+  	end
+    
     def value_lists
       load unless @loaded
       @value_lists
     end
     
-  private
+  	def total_count
+  		any.total_count
+  	end
+  	
+  	def portal_meta
+  		@portal_meta ||= any.portal_meta
+  	end
+  	
+  	def portal_meta_no_load
+  		@portal_meta
+  	end
+  	
+  	def portal_names
+  		portal_meta.keys
+  	end
+  	
+  	def table
+  		@table ||= any.table
+  	end
+  	
+  	def table_no_load
+  		@table
+  	end
     
     def load
-    	#require 'rexml/document'
-    	require 'nokogiri'
-    	
       @loaded = true
-      fmpxmllayout = @db.server.load_layout(self)
-      doc = Nokogiri::XML(fmpxmllayout)
+      fmpxmllayout = db.server.load_layout(self)
+      doc = XmlParser.new(fmpxmllayout.body, :namespace=>false, :parser=>server.state[:parser])
       
       # check for errors
-      error = doc.xpath('//ERRORCODE').children[0].to_s.to_i
+      error = doc['FMPXMLLAYOUT']['ERRORCODE'].to_s.to_i
       raise Rfm::Error::FileMakerError.getError(error) if error != 0
       
       # process valuelists
-      if doc.xpath('//VALUELIST').size > 0
-        doc.xpath('//VALUELIST').each {|valuelist|
+      vlists = doc['FMPXMLLAYOUT']['VALUELISTS']['VALUELIST']
+      if !vlists.nil?    #root.elements['VALUELISTS'].size > 0
+        vlists.each {|valuelist|
           name = valuelist['NAME']
-          @value_lists[name] = valuelist.children.collect{|value|
-          	Rfm::Metadata::ValueListItem.new(value.children[0].to_s, value['DISPLAY'], name)
+          @value_lists[name] = valuelist['VALUE'].collect{|value|
+          	Rfm::Metadata::ValueListItem.new(value['__content__'], value['DISPLAY'], name)
           } rescue []
         }
         @value_lists.freeze
       end
 
       # process field controls
-      doc.xpath('//FIELD').each {|field|
+      doc['FMPXMLLAYOUT']['LAYOUT']['FIELD'].each {|field|
         name = field['NAME']
-        style_xml = field.children[0]
-        style = style_xml['TYPE']
-        value_list_name = style_xml['VALUELIST']
+        style = field['STYLE']
+        type = style['TYPE']
+        value_list_name = style['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)
+        field_control = Rfm::Metadata::FieldControl.new(name, type, value_list_name, value_list)
         existing = @field_controls[name]
         if existing
           if existing.kind_of?(Array)
@@ -265,17 +322,12 @@ module Rfm
           @field_controls[name] = field_control
         end
       }
-      @field_controls.freeze      
-    end
-    
-    def get_records(action, extra_params = {}, options = {})
-      include_portals = options[:include_portals] ? options.delete(:include_portals) : nil
-      xml_response = @db.server.connect(@db.account_name, @db.password, action, params.merge(extra_params), options).body
-      Rfm::Resultset.new(@db.server, xml_response, self, include_portals)
+      @field_names ||= @field_controls.collect{|k,v| v.name rescue v[0].name}
+      @field_controls.freeze
     end
     
-    def params
-      {"-db" => @db.name, "-lay" => self.name}
-    end
-  end
-end
+  	private :load, :get_records, :params
+      
+      
+  end # Layout
+end # Rfm

data/lib/rfm/metadata/field.rb

@@ -1,5 +1,6 @@
 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
@@ -56,7 +57,6 @@ module Rfm
     #
     # 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
@@ -75,7 +75,7 @@ module Rfm
       # 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?
+        return nil if (value.nil? or value.empty?)
         case self.result
         when "text"      then value
         when "number"    then BigDecimal.new(value)
@@ -88,6 +88,6 @@ module Rfm
         
       end
       
-    end
-  end
-end
+    end # Field
+  end # Metadata
+end # Rfm

data/lib/rfm/metadata/field_control.rb

@@ -1,53 +1,54 @@
 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
+	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
+	      rfm_metaclass.instance_variable_set :@value_list, value_list
+	    end
+	    
+	    attr_reader :name, :style, :value_list_name
+	    meta_attr_reader :value_list
+	  
+	  end
+	end
 end