ginjo-rfm 3.0.9 → 3.0.10

data/lib/rfm/metadata/script.rb

@@ -13,10 +13,10 @@ module Rfm
         @name = name
         self.db = db_obj
       end
-      
+
       meta_attr_accessor :db
       attr_reader :name
     end # Script
-    
+
   end # Metadata
-end # Rfm
+end # Rfm

data/lib/rfm/metadata/value_list_item.rb

@@ -1,31 +1,31 @@
 module Rfm
-	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
-	  	# TODO: re-instate saving of value_list_name.
-	    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
+  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
+      # TODO: re-instate saving of value_list_name.
+      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

@@ -71,13 +71,13 @@ module Rfm
   #
   # This code iterates through the rows of the _Orders_ portal.
   #
-  #	As a convenience, you can call a specific portal as a method on your record, if the table occurrence name does
+  #  As a convenience, you can call a specific portal as a method on your record, if the table occurrence name does
   # not have any characters that are prohibited in ruby method names, just as you can call a field with a method:
-	# 	
-	#   myRecord.orders.each {|portal_row|
-	#   	puts portal_row["Order Number"]
-	#   }
-	#   
+  #   
+  #   myRecord.orders.each {|portal_row|
+  #     puts portal_row["Order Number"]
+  #   }
+  #   
   # =Field Types and Ruby Types
   #
   # RFM automatically converts data from FileMaker into a Ruby object with the most reasonable type possible. The 
@@ -107,41 +107,40 @@ module Rfm
   #   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_accessor :layout #, :resultset
     attr_reader :record_id, :mod_id, :portals
     def_delegators :layout, :db, :database, :server, :field_meta, :portal_meta, :field_names, :portal_names
-    
+
     # This is called during the parsing process, but only to allow creation of the correct type of model instance.
     # This is also called by the end-user when constructing a new empty record, but it is called from the model subclass.
-		def self.new(*args) # resultset
-			record = case
-			
-			# Get model from layout, then allocate record.
-			# This should only use model class if the class already exists,
-			# since we don't want to create classes that aren't defined by the user - they won't be persistant.
-			when args[0].is_a?(Resultset) && args[0].layout && args[0].layout.model
-				args[0].layout.modelize.allocate
+    def self.new(*args) # resultset
+      record = case
+        # Get model from layout, then allocate record.
+        # This should only use model class if the class already exists,
+        # since we don't want to create classes that aren't defined by the user - they won't be persistant.
+      when args[0].is_a?(Resultset) && args[0].layout && args[0].layout.model
+        args[0].layout.modelize.allocate
+        # Allocate instance of Rfm::Record.
+      else
+        self.allocate
+      end
 
-			# Allocate instance of Rfm::Record.	
-			else
-				self.allocate
-			end
-			record.send(:initialize, *args)
-			record
-			# rescue
-			# 	puts "Record.new bombed and is defaulting to super.new. Error: #{$!}"
-			# 	super
-		end
+      record.send(:initialize, *args)
+      record
+      # rescue
+      #   puts "Record.new bombed and is defaulting to super.new. Error: #{$!}"
+      #   super
+    end
 
     def initialize(*args) # resultset, attributes
-      @mods						||= {}
+      @mods            ||= {}
       @portals        ||= Rfm::CaseInsensitiveHash.new
-			options = args.rfm_extract_options!
-			if args[0].is_a?(Resultset)
-				@layout = args[0].layout
-			elsif self.is_a?(Base)
-				@layout = self.class.layout
+      options = args.rfm_extract_options!
+      if args[0].is_a?(Resultset)
+        @layout = args[0].layout
+      elsif self.is_a?(Base)
+        @layout = self.class.layout
         @layout.field_keys.each do |field|
           self[field] = nil
         end
@@ -150,8 +149,8 @@ module Rfm
         @loaded = true
       end
       _attach_as_instance_variables(args[1]) if args[1].is_a? Hash
-			#@loaded = true
-			self
+      #@loaded = true
+      self
     end
 
     # Saves local changes to the Record object back to Filemaker. For example:
@@ -181,7 +180,7 @@ module Rfm
       self.replace_with_fresh_data(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"]
@@ -195,19 +194,19 @@ 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 [](key)
-  		# Added by wbr, 2013-03-31
-  		return super unless @loaded
-  		return fetch(key.to_s.downcase)
-  	rescue IndexError
-    	raise Rfm::ParameterError, "#{key} does not exists as a field in the current Filemaker layout." unless key.to_s == '' #unless (!layout or self.key?(key_string))
-  	end
+    def [](key)
+      # Added by wbr, 2013-03-31
+      return super unless @loaded
+      return fetch(key.to_s.downcase)
+    rescue IndexError
+      raise Rfm::ParameterError, "#{key} does not exists as a field in the current Filemaker layout." unless key.to_s == '' #unless (!layout or self.key?(key_string))
+    end
 
     def respond_to?(symbol, include_private = false)
       return true if self.include?(symbol.to_s)
       super
     end
-    
+
     def []=(key, val)
       key_string = key.to_s.downcase
       return super unless @loaded # is this needed?
@@ -215,45 +214,49 @@ module Rfm
       # @mods[key_string] = val
       # TODO: This needs cleaning up.
       # TODO: can we get field_type from record instead?
-			@mods[key_string] = if [Date, Time, DateTime].member?(val.class)
-				field_type = layout.field_meta[key_string.to_sym].result
-				case field_type
-					when 'time'; val.strftime(layout.time_format)
-					when 'date'; val.strftime(layout.date_format)
-					when 'timestamp'; val.strftime(layout.timestamp_format)
-				else val
-				end
-			else val
-			end
+      @mods[key_string] = if [Date, Time, DateTime].member?(val.class)
+        field_type = layout.field_meta[key_string.to_sym].result
+        case field_type
+        when 'time'
+          val.strftime(layout.time_format)
+        when 'date'
+          val.strftime(layout.date_format)
+        when 'timestamp'
+          val.strftime(layout.timestamp_format)
+        else
+          val
+        end
+      else
+        val
+      end
       super(key, val)
     end
-		  
-	  def field_names
-    	layout.field_names
+
+    def field_names
+      layout.field_names
     end
-    
+
     def replace_with_fresh_data(record)
-			self.replace record
-			[:@mod_id, :@record_id, :@portals, :@mods].each do |var|
-				self.instance_variable_set var, record.instance_variable_get(var) || {}
-			end
-			self
-		end
-		
-		
+      self.replace record
+      [:@mod_id, :@record_id, :@portals, :@mods].each do |var|
+        self.instance_variable_set var, record.instance_variable_get(var) || {}
+      end
+      self
+    end
+
 
-  private
+    private
 
-  	def method_missing (symbol, *attrs, &block)
-  	  method = symbol.to_s
-  	  return self[method] if self.key?(method)
-  	  return @portals[method] if @portals and @portals.key?(method)
+    def method_missing (symbol, *attrs, &block)
+      method = symbol.to_s
+      return self[method] if self.key?(method)
+      return @portals[method] if @portals and @portals.key?(method)
+
+      if method =~ /(=)$/
+        return self[$`] = attrs.first if self.key?($`)
+      end
+      super
+    end
 
-  	  if method =~ /(=)$/
-  	    return self[$`] = attrs.first if self.key?($`)
-  	  end
-  	  super
-		end
-  	
   end # Record
-end # Rfm
+end # Rfm

data/lib/rfm/resultset.rb

@@ -36,25 +36,23 @@ module Rfm
   #   it provides metadata about the portals in the ResultSet and the Fields on those portals
 
   class Resultset < Array
-  	include Config
-    
+    include Config
+
     attr_reader :layout, :meta, :calling_object
-#     attr_reader :layout, :database, :server, :calling_object, :doc
-#     attr_reader :field_meta, :portal_meta, :include_portals, :datasource
-#     attr_reader :date_format, :time_format, :timestamp_format
-#     attr_reader :total_count, :foundset_count, :table
+    #     attr_reader :layout, :database, :server, :calling_object, :doc
+    #     attr_reader :field_meta, :portal_meta, :include_portals, :datasource
+    #     attr_reader :date_format, :time_format, :timestamp_format
+    #     attr_reader :total_count, :foundset_count, :table
     #def_delegators :layout, :db, :database
     # alias_method :db, :database
-		def_delegators :meta, :field_meta, :portal_meta, :date_format, :time_format, :timestamp_format, :total_count, :foundset_count, :fetch_size, :table, :error, :field_names, :field_keys, :portal_names
+    def_delegators :meta, :field_meta, :portal_meta, :date_format, :time_format, :timestamp_format, :total_count, :foundset_count, :fetch_size, :table, :error, :field_names, :field_keys, :portal_names
 
-    
     class << self
-    	def load_data(data, object=self.new)
-    		Rfm::Connection
-    		Rfm::SaxParser.parse(data, :fmresultset, object)
-    	end
+      def load_data(data, object=self.new)
+        Rfm::SaxParser.parse(data, :fmresultset, object)
+      end
     end
-    
+
     # Initializes a new ResultSet object. You will probably never do this your self (instead, use the Layout
     # object to get various ResultSet obejects).
     #
@@ -77,68 +75,68 @@ module Rfm
     #   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(*args) # parent, layout
-			config *args
-			self.meta
+      config(*args)
+      self.meta
     end # initialize
 
     def config(*args)
-    	super do |params|
-    		(@layout = params[:objects][0]) if params &&
-    			params[:objects] &&
-    			params[:objects][0] &&
-    			params[:objects][0].is_a?(Rfm::Layout)
-    	end
+      super do |params|
+        (@layout = params[:objects][0]) if params &&
+          params[:objects] &&
+          params[:objects][0] &&
+          params[:objects][0].is_a?(Rfm::Layout)
+      end
     end
-    
+
     # This method was added for situations where a layout was not provided at resultset instantiation,
     # such as when loading a resultset from an xml file.
     def layout
-    	@layout ||= (Layout.new(meta.layout, self) if meta.respond_to? :layout)
+      @layout ||= (Layout.new(meta.layout, self) if meta.respond_to? :layout)
+    end
+
+    def database
+      layout.database
+    end
+
+    alias_method :db, :database
+
+    def server
+      database.server
+    end
+
+    def meta
+      # Access the meta inst var here.
+      @meta ||= Metadata::ResultsetMeta.new
+    end
+
+    # Deprecated on 7/29/2014. Stop using.
+    def handle_new_record(attributes)
+      r = Rfm::Record.new(self, attributes, {})
+      self << r
+      r
+    end
+
+    def end_datasource_element_callback(cursor)
+      %w(date_format time_format timestamp_format).each{|f| convert_date_time_format(send(f))}
+      @meta.attach_layout_object_from_cursor(cursor)
     end
-		
-		def database
-			layout.database
-		end
-		
-		alias_method :db, :database
-		
-		def server
-			database.server
-		end
-		
-		def meta
-			# Access the meta inst var here.
-			@meta ||= Metadata::ResultsetMeta.new
-		end
-
-		# Deprecated on 7/29/2014. Stop using.
-  	def handle_new_record(attributes)
-  		r = Rfm::Record.new(self, attributes, {})
-  		self << r
-  		r
-  	end
-  	
-  	def end_datasource_element_callback(cursor)
-  		%w(date_format time_format timestamp_format).each{|f| convert_date_time_format(send(f))}
-  		@meta.attach_layout_object_from_cursor(cursor)
-  	end
-    
-  private
-    
+
+    private
+
     def check_for_errors(error_code=@meta['error'].to_i, raise_401=state[:raise_401])
-    	#puts ["\nRESULTSET#check_for_errors", "meta[:error] #{@meta[:error]}", "error_code: #{error_code}", "raise_401: #{raise_401}"]
+      #puts ["\nRESULTSET#check_for_errors", "meta[:error] #{@meta[:error]}", "error_code: #{error_code}", "raise_401: #{raise_401}"]
       raise Rfm::Error.getError(error_code) if error_code != 0 && (error_code != 401 || raise_401)
     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
-    
+    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
+end