dm-filemaker-adapter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjdlOGM0ZWYwNzU2MzhjZGQ3Y2U3NWZkMDY4ZDdlZTQ4NGMwOTc5MA==
+    NDE2YzRlM2E5YjU3NzFjYjAyZjM2NGVhMzE4YjExM2U4MjVmOGI2NA==
   data.tar.gz: !binary |-
-    NmVhZmNlOWYxNGJmOWNhNDA2NmZjODRlNTZjMmI1MTRkYTZkYmU4OA==
+    ZTkzMmU3MmM2MmVlNmVkYmI2N2RiOTUwYzc5MDNlZWIyZTY5N2VlNg==
 SHA512:
   metadata.gz: !binary |-
-    YWI5ZGRmN2FjNWRhMmY1ZTcwMzBmNmJhYjllNjlhZWE1NDFkZWNlYmFlY2Iw
-    OGZlMDMzZjYwZmRiMTVmNjY1MTVjMjhlYzlkNjYzZTUwMGM2OWYwNDVmYmU0
-    ZmNkNDI2NWNkN2Y5MDE0MjEzMWUwMTBlNTg2OGY3NmRjYWVjMTU=
+    ZmMzZDIyNTgyZTZlYmQwZGU3M2U2YTg2MzcxMGFhMzRkODM0MzhiZDRhMjEz
+    NzZkYmExZjEzNTAwNmE2ZDk4Y2YwMzNjZWMyYTJhMzAzNjg0NTljOTM0YTYz
+    ZDgzMjczZWExYTk4NmFmNTlkYzZlMjZmMmE4MDU5NTMzZWNkYjk=
   data.tar.gz: !binary |-
-    MWYwMGEzMGZkMzQ3NmQ2NmNiYTE5YWY0ZGQ1YmEwNzJhODEyMmVjYTExZWVl
-    N2MyZmE1N2VhOTg3NjhmOTE4MDVhMWRmZDZlNmEzODkyYzA4NGYxZGI4NmYx
-    OTYyODIwNzc0NmNiMDc4YzMxZjY5MDJiYmJhMjI1NTQ3ODNlYjE=
+    MTg2MDViODIyNTU4NzRiZGUxOTkzZWRlYjFkODcxYjhlMzVlYzZjMGU4NzJk
+    N2E4NWYxYWQ2NmRiMjQ4N2ZlMjlhNmNkOWM2ZTFiNDI5NjkyN2ViZWU5OTg5
+    Y2NmY2JiODY3NWM0ZmI4NDFkYjRlMWUxMTBjM2JjM2ExYTkzNzA=

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-
-
+# Only enable this if you are testing against a local copy of ginjo-rfm.
+gem 'ginjo-rfm', :path=>'../GinjoRfm.git/'

data/README.md

@@ -2,7 +2,7 @@
 
 A Filemaker adapter for DataMapper, allowing DataMapper to use Filemaker Server as a datastore.
 
-dm-filemaker-adapter uses the ginjo-rfm gem as the backend command and xml parser. Ginjo-rfm is a full featured filemaker-ruby adapter that exposes most of Filemaker's xml interface functionality in ruby. dm-filemaker-adapter doesn't tap into all of rfm's features, but rather, dm-filemaker-adapter provides DataMapper the ability to use Filemaker Server as a backend datastore. All of the basic functionality of DataMapper's CRUD interface is supported, including compound queries and 'or' queries (using Filemaker's -findquery command), query operators like :field.gt=>..., lazy-loading where possible, first & last record, aggregate queries, ranges, field mapping, and more.
+dm-filemaker-adapter uses the ginjo-rfm gem as the backend command and xml parser. Ginjo-rfm is a full featured filemaker-ruby adapter that exposes most of Filemaker's xml interface functionality in ruby. dm-filemaker-adapter doesn't tap into all of rfm's features, but rather, it provides DataMapper the ability to use Filemaker Server as a backend datastore. Most of the basic functionality of DataMapper's interface is supported, including compound queries and 'or' queries (using Filemaker's -findquery command), validations, associations, query operators like ```:field.gt=>something```, lazy-loading where possible, first & last record, aggregate queries, ranges, field mapping, and more.
 
 ## Installation
 
@@ -34,24 +34,41 @@ Or install it yourself as:
     
     class User
       include DataMapper::Resource
-      storage_names[:default] = 'user_xml'  # This is the name of a filemaker layout representing the table you're modeling.
 
-      # Property & field names in this list must be lowercase, regardless of what they are in Filemaker.
+      # Name the filemaker layout representing the table you're modeling.
+      storage_names[:default] = 'user_xml'  
 
+      # Property & field names are case-sensitive.
       property :id, Serial
       property :username, String, :length => 128, :unique => true, :required => true,
         :default => lambda {|r,v| r.instance_variable_get :@email}
       property :email, String, :length => 128, :unique => true, :required => true, :format=>:email_address
-      property :updated_at, DateTime, :field=>'modification_timestamp'
+      property :updated_at, DateTime, :field=>'ModifiedAtTimestamp'
       property :encrypted_password, BCryptPassword
+
+      has n, :orders
+    end
+
+    class Order
+      include DataMapper::Resource
+      storage_names[:default] = 'order_xml'
+      
+      property :id, Serial
+      property :user_id, Integer
+      property :status, String
+      
+      belongs_to :user
     end
 
     DataMapper.finalize
 
 
 
-    # create records
-      User.create(:email => 'abc@company.com', :username => 'abc')
+    # create record
+      user = User.create(:email => 'abc@company.com', :username => 'abc')
+
+    # create associated record
+      user.orders.new(:status=>'draft')
 
     # get a specific user id
       User.get '1035'
@@ -65,15 +82,18 @@ Or install it yourself as:
     # records 10 thru 20, ordered by :id (the range is resolved by filemaker, before records are returned!)
       User.all(:order => :id)[10..20]
 
+    # filter associated records
+      user.orders.all(:status=>'closed')
+
     # use the union operator to create 2 find requests in a filemaker 'OR' operation
       User.all(:email => 'abc@company.com', :activated_at.gt => '1/1/1980') | \
       User.all(:username => 'abc', :activated_at.gt => '1/1/1980')
 
     # which gets translated to the filemaker query
-      User.find [
-        {:email => 'abc@company.com', :activated_at => '>1/1/1980'},
-        {:username => 'abc', :activated_at.gt => '>1/1/1980'}
-      ]
+        User.find [
+          {:email => 'abc@company.com', :activated_at => '>1/1/1980'},
+          {:username => 'abc', :activated_at.gt => '>1/1/1980'}
+        ]
 
     # use the intersection operator to combine multiple search criteria in a filemaker 'AND' operation
       User.all(:email => 'abc@company.com', :activated_at.gt => '1/1/2015') & \
@@ -83,7 +103,7 @@ Or install it yourself as:
       User.all(:email => 'abc@company.com', :activated_at.gt => '1/1/2015', :activated_at.lt => '5/1/2015')
     
     # both of the above get translated to the filemaker query
-      User.find(:email => 'abc@company.com', :activated_at => '>1/1/2015 <5/1/2015')
+        User.find(:email => 'abc@company.com', :activated_at => '>1/1/2015 <5/1/2015')
 
 
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler'
 Bundler.require
-
 require "bundler/gem_tasks"
+
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/dm-filemaker-adapter/adapter.rb

@@ -5,9 +5,8 @@ module DataMapper
   module Adapters
   
     class FilemakerAdapter < AbstractAdapter
-      @fmresultset_template_path = File.expand_path('../dm-fmresultset.yml', __FILE__).to_s
-      class << self; attr_accessor :fmresultset_template_path; end
       VERSION = DataMapper::FilemakerAdapter::VERSION
+      FMRESULTSET_TEMPLATE = {:template => File.expand_path('../dm-fmresultset.yml', __FILE__)}
 
 
       ###  ADAPTER CORE METHODS  ###
@@ -27,11 +26,11 @@ module DataMapper
       #
       # @api semipublic
       def create(resources)
-        resources[0].model.last_query = resources
+        #resources[0].model.last_query = resources
         counter = 0
         resources.each do |resource|
           fm_params = prepare_fmp_attributes(resource.dirty_attributes)
-          rslt = layout(resource.model).create(fm_params, :template=>self.class.fmresultset_template_path)
+          rslt = layout(resource.model).create(fm_params)
           merge_fmp_response(resource, rslt[0])
           counter +=1
         end
@@ -57,27 +56,29 @@ module DataMapper
       # end
       #
       def read(query)
-        query.model.last_query = query
-        #y query
+        #query.model.last_query = query
+        #puts query.to_yaml
         _layout = layout(query.model)
         opts = query.fmp_options
-        #puts "FMP OPTIONS #{opts.inspect}"
-        opts[:template] = self.class.fmresultset_template_path
+        #puts "ADAPTER#READ fmp options: #{opts.inspect}"
+        #opts[:template] = self.class.fmresultset_template_path
         prms = query.to_fmp_query
-        #puts "ADAPTER#read fmp_query built: #{prms.inspect}"
+        #puts "ADAPTER#READ fmpquery: #{prms.inspect}"
+        #puts "ADAPTER#READ layout config: #{_layout.get_config.inspect}"
         rslt = prms.empty? ? _layout.all(opts) : _layout.find(prms, opts)
-        rslt.dup.each_with_index(){|r, i| rslt[i] = r.to_h}
-        rslt
+        # This was here to make rfm records loadable by dm, but no longer needed with Rfm#record @loaded disabled in parsing template.
+        #rslt.collect{|r| Hash.new.merge(r) }
+        #rslt.to_a
       end
       
       # Takes a query and returns number of matched records.
       # An empty query will return the total record count
       def aggregate(query)
-        query.model.last_query = query
+        #query.model.last_query = query
         #y query
         _layout = layout(query.model)
         opts = query.fmp_options
-        opts[:template] = self.class.fmresultset_template_path
+        #opts[:template] = self.class.fmresultset_template_path
         prms = query.to_fmp_query
         #[prms.empty? ? _layout.all(:max_records=>0).foundset_count : _layout.count(prms)]
         [prms.empty? ? _layout.view.total_count : _layout.count(prms)]
@@ -100,11 +101,11 @@ module DataMapper
       #
       # @api semipublic
       def update(attributes, collection)
-        collection[0].model.last_query = [attributes, collection]
+        #collection[0].model.last_query = [attributes, collection]
         fm_params = prepare_fmp_attributes(attributes)
         counter = 0
         collection.each do |resource|
-          rslt = layout(resource.model).edit(resource.record_id, fm_params, :template=>self.class.fmresultset_template_path)
+          rslt = layout(resource.model).edit(resource.instance_variable_get(:@_record_id), fm_params)
           merge_fmp_response(resource, rslt[0])
           resource.persistence_state = DataMapper::Resource::PersistenceState::Clean.new resource
           counter +=1
@@ -129,7 +130,7 @@ module DataMapper
       def delete(collection)
         counter = 0
         collection.each do |resource|
-          rslt = layout(resource.model).delete(resource.record_id, :template=>self.class.fmresultset_template_path)
+          rslt = layout(resource.model).delete(resource.instance_variable_get(:@_record_id))
           counter +=1
         end
         counter
@@ -150,11 +151,19 @@ module DataMapper
       	prepend, append = options[:prepend], options[:append]
       	fm_attributes = {}
       	#puts "PREPARE FMP ATTRIBUTES"
-      	#DmProduct.last_query = attributes
-      	#y attributes.operands
+      	#puts attributes.to_yaml
       	
       	
+      	# Handles attributes that are relationships.
       	attributes.dup.each do |key, val|
+      		# If an attribute is a relationship,
+      		# convert it to a key=>val that can be passed to Rfm.
+      		# Note that DM will eager-load related records of a collection all at once,
+      		# instead of one-at-a-time as you loop thru parent records.
+      		# In this case, the val of a relationship attribute will be a collection of parent records,
+      		# instead of just one parent record.
+      		# Example: "product_type.each {|type| puts type.products.size}"
+      		# Note that this variation will create n+1 queries "product_type.each {|type| puts type.products.count}"
       		if key.class.name[/Relationship/]
       			parent_keys = key.parent_key.to_a   #.collect(){|p| p.name}
       			child_keys = key.child_key.to_a     #.collect(){|p| p.name}
@@ -162,18 +171,13 @@ module DataMapper
       			#puts "RELATIONSHIP CHILD #{key.child_model_name} #{child_keys.inspect}"
       			#puts "RELATIONSHIP CRITERIA #{val.inspect}"
       			child_keys.each_with_index do |k, i|
-      				attributes[k] = val[parent_keys[i].name]
+      				# The value dup is necessary, else the original data of parent resource will be modified.
+      				attributes[k] = Array(val).collect{|v| v[parent_keys[i].name].tap{|x| x.dup rescue x} }
       				attributes.delete key
       			end
       		end
       	end
       	
-      	# TODO: Handle attributes that have relationship components (major PITA!)
-      	# q.conditions.operands.to_a[0].subject   .parent_key.collect {|p| p.name}
-      	# q.conditions.operands.to_a[0].subject   .child_key.collect {|p| p.name}
-      	# q.conditions.operands.to_a[0].loaded_value[child-key-name]
-      	# new_attributes[child-key-name] = parent-key-value
-      	
       	#puts "ATTRIBUTES BEFORE attributes_as_fields"
       	#y attributes
       	attributes_as_fields(attributes).each do |key, val|
@@ -222,7 +226,7 @@ module DataMapper
       # Class methods extended onto model subclass.
       module ModelMethods
         def layout
-          @layout ||= Rfm.layout(storage_name, repository.adapter.options.symbolize_keys)
+          @layout ||= Rfm.layout(storage_name, repository.adapter.options.merge(FMRESULTSET_TEMPLATE).symbolize_keys)
         end
         
         # Not how to do this. Doesn't work anywhere I've tried it:

data/lib/dm-filemaker-adapter/core_patches.rb

@@ -49,14 +49,9 @@ module DataMapper
   end
   
   module Model
+  	# For testing adapter methods.
     attr_accessor :last_query
-    alias_method :finalize_orig, :finalize
-    def finalize(*args)
-      property :record_id, Integer, :lazy=>false
-      property :mod_id, Integer, :lazy=>false
-      finalize_orig
-    end
-  end
+  end # Model
   
   class Query
 		# Convert dm query conditions to fmp query params (hash)
@@ -141,4 +136,51 @@ module DataMapper
     end	  
     
   end # Query
-end # DataMapper
+end # DataMapper
+
+module Rfm
+	class Resultset
+	  
+	  # Does custom processing during each record-to-resource translation done in DataMapper::Model#load
+	  # Doing this here means we don't have to mess with DataMapper::Model#load.
+	  def map
+	    super do |record|
+	      resource = yield(record)
+	      #puts "DM INPUT RECORD: #{record.class} #{record.instance_variable_get(:@record_id)}"
+
+				if resource.kind_of?(DataMapper::Resource)
+					#puts "MODEL#LOAD custom processing RECORD #{record.class} RESOURCE #{resource.class}"
+					#puts record.inspect
+	        # For Testing:
+	        #resource.instance_variable_set(:@record, record)
+	        # WBR - Loads portal data into DM model attached to this resource.
+	        portals = record.instance_variable_get(:@portals)
+	        #puts "MODEL#LOAD record #{record.class} portals #{portals.keys rescue 'no portals'}"
+	        #if record.respond_to?(:portals) && record.portals.kind_of?(Hash) && record.portals.any?
+	        model = resource.class
+	        if portals.kind_of?(Hash) && portals.any?
+	          begin
+	          #puts record.portals.to_yaml
+	          portal_keys = portals.keys
+	          #puts "PORTALS: #{portal_keys}"
+	          portal_keys.each do |portal_key|
+	          	#relat = model.relationships.to_a.find{|r| storage_name = r.child_model.storage_names[:default]; portal_key.to_s == storage_name }
+	          	relat = model.relationships.to_a.find{|r| storage_name = r.child_model.storage_name; portal_key.to_s == storage_name }
+	          	if relat
+		          	#puts "BUILDING RELATIONSHIP FROM PORTAL: #{relat.name} #{relat.child_model.name}"
+		          	resource.instance_variable_set(relat.instance_variable_name, relat.child_model.load(record.instance_variable_get(:@portals)[portal_key], relat.child_model.query) )
+	          	end
+	          end
+	          rescue
+	            puts "ERROR LOADING PORTALS #{$!}"
+	          end
+	        end
+					resource.instance_variable_set(:@_record_id, record.instance_variable_get(:@record_id))
+					resource.instance_variable_set(:@_mod_id, record.instance_variable_get(:@mod_id))
+				end
+
+				resource
+	    end
+	  end
+	end
+end

data/lib/dm-filemaker-adapter/dm-fmresultset.yml

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # YAML structure defining a SAX parsing scheme for fmresultset xml.
 # The initial object of this parse should be a new instance of Rfm::Resultset.
+# This template is intended for use with dm-filemaker-adapter, and not as
+# a general Rfm::Resultset template.
 ---
 attach_elements: _meta
 attach_attributes: _meta
@@ -29,10 +31,6 @@ elements:
 - name:  metadata
   attach: none
 - name: field_definition
-  # These two steps can be used to create the attachment to resultset-meta automatically,
-  # but the field-mapping translation won't happen.
-  # attach: [_meta, 'Rfm::Metadata::Field', allocate]
-  # as_name: field_meta
   attach: [cursor, 'Rfm::Metadata::Field', ':allocate']
   delimiter: name
   attach_attributes: private
@@ -56,28 +54,27 @@ elements:
   - name: fetch_size
     accessor: none
 - name: record
-  #attach: [cursor, object, handle_new_record, _attributes]
-  #attach_attributes: none
-  attach: [array, 'Rfm::Record', new, object]
-  attach_attributes: hash
-  before_close: '@loaded=true'
+  #attach: [array, 'Rfm::Record', new, object]
+  attach: [array, 'Hash', new]
+  attach_attributes: private
+  compact: true
+  #before_close: '@loaded=true'
   elements:
   - name: field
     attach: [cursor, 'Rfm::Metadata::Datum', ':allocate']
     compact: false
     before_close: [object, field_element_close_callback, self]
   - name: relatedset
-    attach: [private, Array, ':allocate']
+    attach: [private, 'Rfm::Resultset', ':allocate']
     as_name: portals
     attach_attributes: private
     create_accessors: all
     delimiter: table
     elements:
     - name: record
-      #class: Rfm::Record
-      attach: [default, 'Rfm::Record', ':allocate']
-      attach_attributes: hash
-      before_close: '@loaded=true'
+      attach: [default, 'Hash', ':allocate']
+      attach_attributes: private
+      #before_close: '@loaded=true'
       elements:
       - name: field
         compact: true

data/lib/dm-filemaker-adapter/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
 	module FilemakerAdapter
-	  VERSION = "0.0.3"
+	  VERSION = "0.0.4"
 	end
 end