rom-fmp 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03a589c1294de76a28b2e07762205c329356ae90
+  data.tar.gz: 754d5e2f884652cfaf214b64a638192c1c445089
+SHA512:
+  metadata.gz: d0ccd25e0f13e3e7587a0d8d76191fa37ff905321a59fe651921fb7146a3593c0e412840b3168f027a5568ab07cc4bb8875dd24e5657ed97056d372ae4d50a5c
+  data.tar.gz: f3bd10a8bdd7e7bee0391e69b0e75443f56f544d51072b7f6e5152756cc0ca79a457e86ab39e795de1e7c6f3ab062de0eeda15faf5a7a7b2c149cd219b817b18

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor
+.ruby-version
+example*.rb
+local_testing

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# rom-fmp changelog
+
+## v0.0.4 2015-09-17
+
+* Rewrite gateway, dataset, relation.
+* Basic relation support for :find, :all, :count, :create, :update, :delete.
+* Supports command composition/chaining and command currying.
+
+## v0.0.1 2015-03-30
+
+* Initial commit.
+* Basic reads using relations.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rom-fmp.gemspec
+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,60 @@
+# rom-fmp
+
+A filemaker adapter for the rom-rb data mapping & persistence gem.
+See [rom-rb](https://github.com/rom-rb) on github or [rom-rb.org](http://rom-rb.org)
+for more information about Ruby Object Mapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rom-fmp'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-fmp
+
+## Usage
+
+    require 'rom/fmp'
+
+    DB_CONFIG = {
+      adapter:            'fmp',
+      host:               'my.fm.server.com',
+      account_name:       'my_account',
+      password:           '12345',
+      database:           'MyFmpDatabase',  
+    }
+
+    ROM.use(:auto_registration)
+    ROM.setup(:fmp, DB_CONFIG)
+
+    class Users < ROM::Relation[:fmp]
+      register_as :users
+      dataset :user_xml # Filemaker layout name.
+
+      def by_login(name)
+        find(:login=>name.to_s)
+      end
+
+      def activated
+        find(:activated_at=>'>1/1/2000')
+      end
+
+    end
+
+    rom_env = ROM.finalize.env
+
+    rom_users_relation = rom_env.relation(:users)
+
+    activated_users_by_login = rom_users_relation.activated.by_login
+
+    activated_users_by_login.call('bill').to_a
+    activated_users_by_login.('bill').to_a
+    activated_users_by_login['bill'].to_a
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rom/fmp/version"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "get version"
+task :version do
+	puts ROM::FMP::VERSION
+end

data/lib/rom-fmp.rb

@@ -0,0 +1 @@
+require 'rom/fmp'

data/lib/rom/fmp.rb

@@ -0,0 +1,21 @@
+require 'rfm'
+require 'rom'
+require 'yaml'
+
+module ROM
+  module FMP
+    ConstraintError = Class.new(ROM::CommandError)
+    FMRESULTSET_TEMPLATE = {:template=>YAML.load_file(File.expand_path("../fmp/rfm/fmresultset.yml", __FILE__))}
+  end
+end
+
+require "rom/fmp/version"
+require "rom/fmp/dataset"
+require "rom/fmp/gateway"
+require "rom/fmp/relation"
+
+#require "rom/fmp/mini"
+#require "rom/fmp/micro01"
+#require "rom/fmp/micro02"
+
+ROM.register_adapter(:fmp, ROM::FMP)

data/lib/rom/fmp/commands.rb

@@ -0,0 +1,19 @@
+###  NOT USED YET  ###
+
+require 'rom/commands'
+
+module ROM
+  module FMP
+    module Commands
+      ERRORS = [
+        # Sequel::UniqueConstraintViolation,
+        # Sequel::NotNullConstraintViolation
+      ].freeze
+    end
+  end
+end
+
+require 'rom/fmp/commands/create'
+require 'rom/fmp/commands/update'
+require 'rom/fmp/commands/delete'
+#require 'rom/fmp/commands_ext/postgres'

data/lib/rom/fmp/commands/create.rb

@@ -0,0 +1,29 @@
+require 'rom/fmp/commands'
+#require 'rom/fmp/commands/transaction'
+
+module ROM
+  module FMP
+    module Commands
+      class Create < ROM::Commands::Create
+        #include Transaction
+
+        def execute(tuples)
+          insert_tuples = Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            attributes.to_h
+          end
+
+          insert(insert_tuples)
+        rescue *ERRORS => e
+          raise ConstraintError, e.message
+        end
+
+        def insert(tuples)
+          pks = tuples.map { |tuple| relation.insert(tuple) }
+          relation.where(relation.primary_key => pks)
+        end
+      end
+    end
+  end
+end

data/lib/rom/fmp/commands/delete.rb

@@ -0,0 +1,18 @@
+require 'rom/fmp/commands'
+#require 'rom/fmp/commands/transaction'
+
+module ROM
+  module FMP
+    module Commands
+      class Delete < ROM::Commands::Delete
+        # include Transaction
+
+        def execute
+          deleted = target.to_a
+          target.delete
+          deleted
+        end
+      end
+    end
+  end
+end

data/lib/rom/fmp/commands/update.rb

@@ -0,0 +1,54 @@
+require 'rom/fmp/commands'
+#require 'rom/fmp/commands/transaction'
+
+module ROM
+  module FMP
+    module Commands
+      class Update < ROM::Commands::Update
+        #include Transaction
+
+        option :original, type: Hash, reader: true
+
+        alias_method :to, :call
+
+        def execute(tuple)
+          attributes = input[tuple]
+          validator.call(attributes)
+
+          changed = diff(attributes.to_h)
+
+          if changed.any?
+            update(changed)
+          else
+            []
+          end
+        end
+
+        def change(original)
+          self.class.new(relation, options.merge(original: original))
+        end
+
+        def update(tuple)
+          pks = relation.map { |t| t[primary_key] }
+          dataset = relation.dataset
+          dataset.update(tuple)
+          dataset.unfiltered.where(primary_key => pks).to_a
+        end
+
+        def primary_key
+          relation.primary_key
+        end
+
+        private
+
+        def diff(tuple)
+          if original
+            Hash[tuple.to_a - (tuple.to_a & original.to_a)]
+          else
+            tuple
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rom/fmp/dataset.rb

@@ -0,0 +1,121 @@
+#require 'rom/support/array_dataset'
+require 'rom'
+require 'rfm'
+require 'rom/fmp/rfm/layout'
+require 'charlatan'
+
+module ROM
+  module FMP
+    
+    class Dataset
+      # This was used but is not now.
+      # include Rom::ArrayDataset
+      
+      # Used to compile compound queries from chained relations.
+      include ::Rfm::Scope
+      
+      DEFAULT_REQUEST_OPTIONS = {}
+      
+      # Dataset instance expects to hold Array of data in @data,
+      # but it will also hold a FM Layout instance.
+      # If any call to Dataset instance returns Array instance,
+      # it will be wrapped in a new Dataset instance.
+      include Charlatan.new(:data, kind: Array)
+      attr_reader :layout, :data, :queries
+
+      # Store layout, data, query in new dataset.
+      def initialize(_layout, _data=[], _queries=[])
+        @layout = _layout
+        @queries = _queries
+        #puts "DATASET NEW queries:#{@queries}"
+        super(_data)
+      end
+      
+      
+      
+      # Creates new dataset with current args and resultset. Not lazy.
+      # This may not be how rom or sql uses 'where'. Find out more.
+      def where(*args)
+        #self.class.new(layout, layout.find(*args), args)
+        get_results(:find, args)
+      end
+      
+      # Creates new dataset with existing data & queries, plus new query
+      def find(*args)
+        #self.class.new(layout, data, (queries.dup << args))
+        wrap_data(data, (queries.dup << args))
+      end
+      
+      def any(options={})
+        wrap_data(layout.any(options))
+      end
+      
+      def all(options={})
+        wrap_data(layout.all(DEFAULT_REQUEST_OPTIONS.merge(options)))
+      end
+      
+      def count(*args)
+        compiled_query = compile_query
+        compiled_query ? layout.count(*compiled_query) : layout.total_count
+      end
+      
+      def create(args={})
+        get_results(:create, [args]) unless args.empty?
+      end
+
+      def update(record_id, args={})
+        get_results(:edit, [record_id, args]) unless args.empty?
+      end
+      
+      def delete(record_id)
+        get_results(:delete, record_id)
+      end      
+
+
+
+      # Triggers actual fm action.
+      def to_a
+        (data.nil? || data.empty?) ? call.data.to_a : data.to_a
+      end
+      
+      # Triggers actual fm action.
+      def each
+        # passes block - if any - to upstream each.
+        to_a.each(&Proc.new)
+      end
+      
+      # Combines all queries, sends to FM, returns result in new dataset.
+      def call
+        compiled_query = compile_query
+        wrap_data(compiled_query ? layout.find(*compiled_query) : layout.all(DEFAULT_REQUEST_OPTIONS))
+      end
+      
+      # Mixes chained queries together into single query.
+      # Now works with multiple-request queries (using new rfm scope feature).
+      # Other ways: consider mixing multi-request queries with intersection: (result1 & result2),
+      # or with the new scope feature: query1(scope:query2(scope:query3))
+      def compile_query
+        #puts "DATASET COMPILE self #{self}"
+        #puts "DATASET COMPILE queries #{queries}"
+        
+        # Old way: works but doesn't handle fmp compound queries.
+        #query.each_with_object([{},{}]){|x,o| o[0].merge!(x[0] || {}); o[1].merge!(x[1] || {})}
+        
+        # New way: handles compound queries. Reqires ginjo-rfm 3.0.11.
+        return unless queries  # This should help introspecting dataset that results from record deletion. TODO: test this.
+        queries.inject {|new_query,scope| apply_scope(new_query, scope)} ##puts "SCOPE INJECTION scope:#{scope} new_query:#{new_query}"; 
+      end
+            
+      # Returns new dataset containing, data, layout, query.
+      def wrap_data(_data=data, _queries=queries, _layout=layout)
+        self.class.new(_layout, _data, _queries)
+      end
+      
+      # Send method & query to layout, and wrap results in new dataset.
+      def get_results(_method, query=queries, _layout=layout)
+        wrap_data(_layout.send(_method, *query), query, _layout)
+      end
+
+    end # Dataset
+  end # FMP
+end # ROM

data/lib/rom/fmp/gateway.rb

@@ -0,0 +1,28 @@
+require 'rom'
+require 'rfm'
+
+module ROM
+  module FMP
+  
+    class Gateway < ROM::Gateway
+      attr_reader :datasets, :database
+      
+      def initialize(*options)
+        @database = Rfm.database(options[0].to_h.merge(FMRESULTSET_TEMPLATE).to_h)
+        @datasets = Hash.new
+      end
+      
+      def dataset(name)
+        datasets[name.to_s] ||= Dataset.new(@database[name.to_s])
+      end
+      
+      # This is required per lint specs
+      alias_method :[], :dataset
+      
+      def dataset?(name)
+        datasets.key?(name.to_s)
+      end
+    end # Gateway
+    
+  end # FMP
+end # ROM