dm-filemaker-adapter 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTEzN2JmZDA1YjA0Yzg0ZjcxMjllNDkxZDQxM2E4NTE0NzhjYzEwZA==
+  data.tar.gz: !binary |-
+    YmI3MzhmYWEyODk0MjYwNzNlOTI0NGNhYTJhMWFiYjU1MjA4YjM4OA==
+SHA512:
+  metadata.gz: !binary |-
+    NjBiZTQxMmFiOWEzYmMxYWUwNzkxOTcyM2QzNThlMDgyMGJjMDA1OTNmYWNi
+    OGU0MmM2YTI4Yzc0Y2YxMDI2MGVmMDRiZGEwYTUyYzYzMjMwOGFiYzU2ZTAz
+    M2JhNzRmODE0ZjkwZGM4ZDBhZGIxNTM4YzIwYzNhNzEwM2VjZDk=
+  data.tar.gz: !binary |-
+    MTRjNDRhYWM3NzkxMjkzNTkwOGQ1N2M0ZmNiYzdkYWU0NGJhMDMyZTc3Njgx
+    MmQzYzNlODE2M2UzMWFlOWQ4Y2M0OTYzOTA4NWI0OGZkNTQ2YTdkZjZlMGE1
+    MDllNzgxMDBhNzMxMzc0ZTNkM2U3MTg2NjQzNmQ4Mzk0N2I5ODM=

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+todo.txt
+.DS_Store
+
+.travis.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 wbr
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# dm-filemaker-adapter
+
+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, it 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dm-filemaker-adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dm-filemaker-adapter
+
+## Usage
+
+    DB_CONFIG = {
+      adapter:            'filemaker',
+      host:               'my.server.com',
+      account_name:       'my-user-name',
+      password:           'xxxxxxxxxx',
+      database:           'db-name'   
+    }
+
+    DataMapper.setup(:default, DB_CONFIG)
+    
+    class User
+      include DataMapper::Resource
+      storage_names[:default] = 'user_xml'  # This is your filemaker layout for the user table.
+
+      # Property & field names in this list must be lowercase, regardless of what they are in Filemaker.
+
+      property :userid, String, :key=>true, :required=>false
+      property :email, String
+      property :login, String, :field=>'username'
+      property :updated, DateTime, :field=>'updated_at'
+      property :encrypted_password, BCryptPassword
+    end
+
+    DataMapper.finalize
+
+    User.get 'usr1035'
+    User.first :email => 'wbr'
+    User.all :updated.gt => 3.days.ago
+    
+    
+    
+    
+    
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.require
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "version"
+task :version do
+	require 'dm-filemaker-adapter/version'
+	p DataMapper::FilemakerAdapter::VERSION
+end

data/dm-filemaker-adapter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dm-filemaker-adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dm-filemaker-adapter"
+  spec.version       = DataMapper::FilemakerAdapter::VERSION
+  spec.authors       = ["William Richardson"]
+  spec.email         = ["https://github.com/ginjo/dm-filemaker-adapter"]
+  spec.summary       = %q{Filemaker adapter for DataMapper}
+  spec.description   = %q{Use Filemaker Server as a datastore for DataMapper ORM}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "data_mapper"
+  spec.add_dependency "ginjo-rfm"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

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

@@ -0,0 +1,320 @@
+# Property & field names in dm-filemaker-adapter models must be declared lowercase, regardless of what they are in FMP.
+
+module DataMapper
+  [Resource, Model, Adapters]
+  
+  # All this to tack on class and instance methods to the model/resource.
+  module Resource
+    class << self
+      alias_method :included_orig, :included
+      def included(klass)
+        included_orig(klass)
+        if klass.repository.adapter.to_s[/filemaker/i]
+          klass.instance_eval do
+            extend repository.adapter.class::ModelMethods
+            include repository.adapter.class::ResourceMethods
+          end
+        end
+      end
+    end
+  end
+  
+  module Model
+    #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
+
+
+
+  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
+    
+    
+      ###  UTILITY METHODS  ###
+    
+      # Class methods extended onto model.
+      module ModelMethods
+        def layout
+          Rfm.layout(storage_name, repository.adapter.options.symbolize_keys)
+        end
+      end
+      
+      # Instance methods included in model.
+      module ResourceMethods
+        def layout
+          model.layout
+        end
+      end
+  
+
+
+      ###  ADAPTER CORE METHODS  ###
+
+      # Persists one or many new resources
+      #
+      # @example
+      #   adapter.create(collection)  # => 1
+      #
+      # Adapters provide specific implementation of this method
+      #
+      # @param [Enumerable<Resource>] resources
+      #   The list of resources (model instances) to create
+      #
+      # @return [Integer]
+      #   The number of records that were actually saved into the data-store
+      #
+      # @api semipublic
+      def create(resources)
+        #resources[0].model.last_query = resources
+        counter = 0
+        resources.each do |resource|
+          fm_params = fmp_attributes resource.dirty_attributes
+          rslt = layout(resource.model).create(fm_params, :template=>self.class.fmresultset_template_path)
+          merge_fmp_response(resource, rslt[0])
+          counter +=1
+        end
+        counter
+      end
+
+      # Reads one or many resources from a datastore
+      #
+      # @example
+      #   adapter.read(query)  # => [ { 'name' => 'Dan Kubb' } ]
+      #
+      # Adapters provide specific implementation of this method
+      #
+      # @param [Query] query
+      #   the query to match resources in the datastore
+      #
+      # @return [Enumerable<Hash>]
+      #   an array of hashes to become resources
+      #
+      # @api semipublic
+      # def read(query)
+      #   raise NotImplementedError, "#{self.class}#read not implemented"
+      # end
+      #
+      def read(query)
+        #query.model.last_query = query
+        #y query
+        _layout = layout(query.model)
+        opts = fmp_options(query)
+        opts[:template] = self.class.fmresultset_template_path
+        prms = fmp_query(query.conditions) #.to_set.first)
+        rslt = prms.empty? ? _layout.all(opts) : _layout.find(prms, opts)
+        rslt.dup.each_with_index(){|r, i| rslt[i] = r.to_h}
+        rslt
+      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
+        #y query
+        _layout = layout(query.model)
+        opts = fmp_options(query)
+        opts[:template] = self.class.fmresultset_template_path
+        prms = fmp_query(query.conditions) #.to_set.first)
+        #[prms.empty? ? _layout.all(:max_records=>0).foundset_count : _layout.count(prms)]
+        [prms.empty? ? _layout.view.total_count : _layout.count(prms)]
+      end
+
+      # Updates one or many existing resources
+      #
+      # @example
+      #   adapter.update(attributes, collection)  # => 1
+      #
+      # Adapters provide specific implementation of this method
+      #
+      # @param [Hash(Property => Object)] attributes
+      #   hash of attribute values to set, keyed by Property
+      # @param [Collection] collection
+      #   collection of records to be updated
+      #
+      # @return [Integer]
+      #   the number of records updated
+      #
+      # @api semipublic
+      def update(attributes, collection)
+        #collection[0].model.last_query = [attributes, collection]
+        fm_params = 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)
+          merge_fmp_response(resource, rslt[0])
+          resource.persistence_state = DataMapper::Resource::PersistenceState::Clean.new resource
+          counter +=1
+        end
+        counter        
+      end
+
+      # Deletes one or many existing resources
+      #
+      # @example
+      #   adapter.delete(collection)  # => 1
+      #
+      # Adapters provide specific implementation of this method
+      #
+      # @param [Collection] collection
+      #   collection of records to be deleted
+      #
+      # @return [Integer]
+      #   the number of records deleted
+      #
+      # @api semipublic
+      def delete(collection)
+        counter = 0
+        collection.each do |resource|
+          rslt = layout(resource.model).delete(resource.record_id, :template=>self.class.fmresultset_template_path)
+          counter +=1
+        end
+        counter
+      end
+      
+
+
+      ###  ADAPTER HELPER METHODS  ###
+
+      # Create fmp layout object from model object.
+      def layout(model)
+        #Rfm.layout(model.storage_name, options.symbolize_keys)   #query.repository.adapter.options.symbolize_keys)
+        model.layout
+      end
+      
+      # Convert dm query object to fmp query params (hash)
+      def fmp_query(input)
+        #puts "CONDITIONS input #{input.class.name} (#{input})"
+        if input.class.name[/OrOperation/]
+          input.operands.collect {|o| fmp_query o}
+        elsif input.class.name[/AndOperation/]
+          h = Hash.new
+          input.operands.each do |k,v|
+            r = fmp_query(k)
+            #puts "CONDITIONS operand #{r}"
+            if r.is_a?(Hash)
+              h.merge!(r)
+            else
+              h=r
+              break
+            end
+          end
+          h
+        elsif input.class.name[/NullOperation/] || input.nil?
+          {}
+        else
+          #puts "FMP_QUERY OPERATION #{input.class}"
+          val = input.loaded_value
+
+          if val.to_s != ''
+          
+            operation = input.class.name
+            operator = case
+            when operation[/EqualTo/]; '='
+            when operation[/GreaterThan/]; '>'
+            when operation[/LessThan/]; '<'
+            when operation[/Like/]; ''
+            when operation[/Null/]; ''
+            else ''
+            end
+          
+            val = val._to_fm if val.respond_to? :_to_fm
+            {input.subject.field.to_s => "#{operator}#{val}"}
+          else
+            {}
+          end
+        end
+      end
+      
+      
+      # Convert dm attributes hash to regular hash
+      # TODO: Should the result be string or symbol keys?
+      def fmp_attributes(attributes)
+        #puts "ATTRIBUTES"
+        y attributes
+        fm_params = Hash.new
+        attributes.to_h.each do |k,v|
+          fm_params[k.field] = v.respond_to?(:_to_fm) ? v._to_fm : v
+        end
+        # fm_params = Hash.new
+        # resource.dirty_attributes.each do |a,v|
+        #   fm_params[a.field] = v.respond_to?(:_to_fm) ? v._to_fm : v
+        # end
+        fm_params
+      end
+      
+      # Get fmp options hash from query
+      def fmp_options(query)
+        fm_options = {}
+        fm_options[:skip_records] = query.offset if query.offset
+        fm_options[:max_records] = query.limit if query.limit
+        if query.order
+          fm_options[:sort_field] = query.order.collect do |ord|
+            ord.target.field
+          end
+          fm_options[:sort_order] = query.order.collect do |ord|
+            ord.operator.to_s + 'end'
+          end
+        end
+        fm_options
+      end
+            
+      def merge_fmp_response(resource, record)
+        resource.model.properties.to_a.each do |property|
+          if record.key?(property.field.to_s)
+            resource[property.name] = record[property.field.to_s]
+          end
+        end     
+      end
+      
+      # # This is supposed to convert property objects to field name. Not sure if it works.
+      # def get_field_name(field)
+      #   return field.field if field.respond_to? :field
+      #   field
+      # end
+            
+
+      protected :fmp_query, :fmp_attributes, :fmp_options, :merge_fmp_response
+
+    end # FilemakerAdapter
+  end # Adapters
+end # DataMapper
+
+class Time
+  def _to_fm
+    d = strftime('%m/%d/%Y') unless Date.today == Date.parse(self.to_s)
+    t = strftime('%T')
+    d ? "#{d} #{t}" : t
+  end
+end # Time
+
+class DateTime
+  def _to_fm
+    d = strftime('%m/%d/%Y')
+    t =strftime('%T')
+    "#{d} #{t}"
+  end
+end # Time
+
+class Timestamp
+  def _to_fm
+    d = strftime('%m/%d/%Y')
+    t =strftime('%T')
+    "#{d} #{t}"
+  end
+end # Time
+
+class Date
+  def _to_fm
+    strftime('%m/%d/%Y')
+  end
+end # Time
+

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

@@ -0,0 +1,86 @@
+#!/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.
+---
+attach_elements: _meta
+attach_attributes: _meta
+create_accessors: all
+elements:
+- name: doctype
+  attach: none
+  attributes:
+  - name: value
+    as_name: doctype
+- name: fmresultset
+  attach: none
+- name: product
+- name: error
+  attach: none
+  before_close: :check_for_errors
+  attributes:
+  - name: code
+    as_name: error
+- name: datasource
+  attach: none
+  before_close: [object, end_datasource_element_callback, self]
+  attributes:
+  - name: total_count
+    accessor: none
+- 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
+  before_close: [object, field_definition_element_close_callback, self]
+- name: relatedset_definition
+  delimiter: table
+  as_name: portal_meta
+  attach_attributes: private
+  elements:
+  - name: field_definition
+    attach: [cursor, 'Rfm::Metadata::Field', ':allocate']
+    delimiter: name
+    as_name: field_meta
+    attach_attributes: private
+    before_close:  [object, relatedset_field_definition_element_close_callback, self]
+- name: resultset
+  attach: none
+  attributes:
+  - name: count
+    accessor: none
+  - 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'
+  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']
+    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'
+      elements:
+      - name: field
+        compact: true
+        attach: [cursor, 'Rfm::Metadata::Datum', ':allocate']
+        before_close: [object, portal_field_element_close_callback, self]
+

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

@@ -0,0 +1,5 @@
+module DataMapper
+	module FilemakerAdapter
+	  VERSION = "0.0.1"
+	end
+end

data/lib/dm-filemaker-adapter.rb

@@ -0,0 +1,7 @@
+require 'dm-core'
+require 'dm-core/adapters/abstract_adapter'
+require "dm-filemaker-adapter/version"
+require 'dm-filemaker-adapter/adapter'
+require 'rfm'
+
+

data/spec/dm-filemaker-adapter/adapter_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe DataMapper::Adapters::FilemakerAdapter do
+  it 'has a version number' do
+    expect(DataMapper::Adapters::FilemakerAdapter::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(true).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'dm-filemaker-adapter'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dm-filemaker-adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ginjo-rfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Filemaker Server as a datastore for DataMapper ORM
+email:
+- https://github.com/ginjo/dm-filemaker-adapter
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-filemaker-adapter.gemspec
+- lib/dm-filemaker-adapter.rb
+- lib/dm-filemaker-adapter/adapter.rb
+- lib/dm-filemaker-adapter/dm-fmresultset.yml
+- lib/dm-filemaker-adapter/version.rb
+- spec/dm-filemaker-adapter/adapter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Filemaker adapter for DataMapper
+test_files:
+- spec/dm-filemaker-adapter/adapter_spec.rb
+- spec/spec_helper.rb