orm_adapter-guacamole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 744fc399a566ee38824d9dcf341d5b26ac1664c6
+  data.tar.gz: 1b14933544229b5b891c9914320cbd31f2afd61d
+SHA512:
+  metadata.gz: b2c3ad311ca6f1748c96d0a46a1a0e0851a5e4c8bcad32c084054c0adc0435c3eebaec89c890f087f5218c87b4d8fd2dd2c4cb49bb6e046f9855433b01217f48
+  data.tar.gz: 6c6d4d56e8b6dc728d84a2389d2ae28c991fdf3b913f4f73bea9c22c82ec5a94f371df57a289d1c8f4b9ad822e449ff6494523fe059f0545e7470e5200ea3448

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in orm_adapter-guacamole.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+# _*_ encoding : utf-8 _*_
+
+guard :bundler do
+	watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'rspec' do
+	watch(%r{spec/.+\.rb})
+	watch(%r{lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+	watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Klaus Humme
+
+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,53 @@
+# OrmAdapter::Guacamole
+
+This gem provides a simple entry to [ArangoDB] via [guacamole gem]. Its further use may be e.g. to use Devise
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orm_adapter-guacamole'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orm_adapter-guacamole
+
+## Usage
+
+Detailed informations about usage are available at [Ian Whites orm_adapter page]
+
+NOTICE: Relations between models will not work until now.
+
+## Development
+
+To run the specs, you can start from the last known good set of gem dependencies in Gemfile.lock.development:
+
+    git clone http://github.com/klausinho/orm_adapter-guacamole
+    cd orm_adapter-guacamole
+    bundle install
+    bundle exec rake spec
+
+There are 4 pending specs. They are all related to model relations.
+All other tests were green and should be kept green :)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[Ian Whites orm_adapter page]: https://github.com/ianwhite/orm_adapter
+[ArangoDB]: https://www.arangodb.com/
+[guacamole gem]: https://github.com/triAGENS/guacamole
+
+## Copyright and License
+
+Copyright 2015 by Klaus Humme and Ian White. See LICENSE.txt for further license informations.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/lib/guacamole/model/orm_adapter.rb

@@ -0,0 +1,148 @@
+# -*- encoding : utf-8 -*-
+
+require 'guacamole'
+require 'orm_adapter'
+
+module Guacamole
+	module Model
+		module ClassMethods
+			include ::OrmAdapter::ToAdapter
+		end
+
+		class OrmAdapter < ::OrmAdapter::Base
+			extend Forwardable
+
+			def self.model_classes
+				Guacamole::Model.all
+			end
+
+			# creates the name of the collection from the klass name
+			def collection_name
+				"#{klass.model_name.to_s.classify.pluralize}Collection".constantize
+			end
+
+			# @see OrmAdapter::Base#get!
+			def get!(id)
+				collection_name.by_key(wrap_key(id))
+			end
+
+			# @see OrmAdapter::Base#get
+			def get(id)
+				begin
+					collection_name.by_key(wrap_key(id))
+				rescue URI::InvalidURIError, Ashikawa::Core::DocumentNotFoundException
+					return nil
+				end
+			end
+
+			# @see OrmAdapter::Base#find_first
+			def find_first(options = {})
+				collection_name.by_aql(build_aql(options)).to_a.first
+			end
+
+			# @see OrmAdapter::Base#find_all
+			def find_all(options = {})
+				collection_name.by_aql(build_aql(options)).to_a
+			end
+
+			# @see OrmAdapter::Base#create
+			def create!(attributes = {})
+				model = klass.new(attributes)
+				collection_name.create model
+			end
+
+			# @see OrmAdapter::Base#destroy
+			def destroy(object)
+				collection_name.delete(object) && true if valid_object?(object)
+			end
+
+			protected
+
+			def wrap_key(key)
+				key.is_a?(Array) ? key.first : key
+			end
+
+			def build_aql(conditions)
+				conditions, order, limit, offset = extract_conditions!(conditions)
+				conditions = conditions_to_fields(conditions)
+				unless conditions.empty?
+					aql_string = "FILTER " << conditions.map{|k, v| "user.#{k} == #{v.inspect}"}.join(" && ")
+					unless order.empty?
+						order_str =[]
+						order.each do |attr, direction|
+							order_str << "#{klass.model_name.element}.#{attr} #{direction.upcase}"
+						end
+						aql_string << " SORT #{order_str.join(', ')}"
+					end
+						aql_string << " LIMIT #{limit}" unless limit.nil?
+						# cause AQL has no single offset method, using the LIMIT 42, 2147483647 is just a workaround
+						# (42 would be the offset, 2147483647 is a just a high number for the tests )
+						aql_string << " LIMIT #{offset}, 2147483647" unless offset.nil?
+				else
+					unless order.empty?
+						aql_string = 'SORT '
+						order_str =[]
+						order.each do |attr, direction|
+							order_str << "#{klass.model_name.element}.#{attr} #{direction.upcase}"
+						end
+						aql_string << order_str.join(', ')
+						if !limit.nil? && !offset.nil?
+							aql_string << " LIMIT #{offset}, #{limit}" unless limit.nil?
+						elsif !limit.nil? && offset.nil?
+							aql_string << " LIMIT #{limit}"
+						elsif limit.nil? && !offset.nil?
+							aql_string << " LIMIT #{offset}, 2147483647"
+						end
+					else
+						if !limit.nil? && !offset.nil?
+							aql_string = " LIMIT #{offset}, #{limit}" unless limit.nil?
+						elsif !limit.nil? && offset.nil?
+							aql_string = " LIMIT #{limit}"
+						elsif limit.nil? && !offset.nil?
+							aql_string = " LIMIT #{offset}, 2147483647"
+						end
+					end
+				end
+				aql_string
+			end
+
+			# given an options hash,
+			# with optional :conditions, :order, :limit and :offset keys,
+			# returns conditions, normalized order, limit and offset
+			def extract_conditions!(options = {})
+				order = normalize_order(options.delete(:order))
+				limit = options.delete(:limit)
+				offset = options.delete(:offset)
+				conditions = options.delete(:conditions) || options
+				[conditions, order, limit, offset]
+			end
+
+			# given an order argument, returns an array of pairs, with each pair containing the attribute, and :asc or :desc
+			def normalize_order(order)
+				order = Array(order)
+				if order.length == 2 && !order[0].is_a?(Array) && [:asc, :desc].include?(order[1])
+					order = [order]
+				else
+					order = order.map {|pair| pair.is_a?(Array) ? pair : [pair, :asc] }
+				end
+				order.each do |pair|
+					pair.length == 2 or raise ArgumentError, "each order clause must be a pair (unknown clause #{pair.inspect})"
+					[:asc, :desc].include?(pair[1]) or raise ArgumentError, "order must be specified with :asc or :desc (unknown key #{pair[1].inspect})"
+				end
+				order
+			end
+
+			# converts and documents to ids
+			def conditions_to_fields(conditions)
+				conditions.inject({}) do |fields, (key, value)|
+					if key.to_s == 'id'
+						fields.merge('_key' => value)
+					else
+						fields.merge(key => value)
+					end
+				end
+			end
+
+		end
+	end
+end

data/lib/orm_adapter-guacamole.rb

@@ -0,0 +1,2 @@
+require 'orm_adapter-guacamole/version'
+require 'guacamole/model/orm_adapter'

data/lib/orm_adapter-guacamole/version.rb

@@ -0,0 +1,5 @@
+module OrmAdapter
+  module Guacamole
+    VERSION = '0.1.0'
+  end
+end

data/orm_adapter-guacamole.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orm_adapter-guacamole/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'orm_adapter-guacamole'
+  spec.version       = OrmAdapter::Guacamole::VERSION
+  spec.authors       = ['Klaus Humme']
+  spec.email         = ['klaus_21x2@twentyonetwice.com']
+
+  spec.summary       = 'ORM Adapter for guacamole, the ODM for the NoSQL database ArangoDB'
+  spec.description   = 'ORM Adapter for guacamole'
+  spec.homepage      = 'https://github.com/klausinho/orm_adapter-guacamole'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{'^(test|spec|features)/'}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'orm_adapter', '~> 0.5.0'
+  spec.add_dependency 'guacamole', '~> 0.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0', '>= 3.2.0'
+  spec.add_development_dependency 'guard', '~> 2.12.4', '>= 2.12.4'
+  spec.add_development_dependency 'guard-rspec', '~> 4.4'
+  spec.add_development_dependency 'guard-bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+
+require 'spec_helper'
+require 'example_app_shared'
+
+describe Guacamole::Model::OrmAdapter do
+
+	it_should_behave_like 'example app with orm_adapter' do
+
+		let(:user_class) { User }
+		let(:note_class) { Note }
+
+	end
+end

data/spec/collections/notes_collection.rb

@@ -0,0 +1,7 @@
+class NotesCollection
+	include Guacamole::Collection
+
+	map do
+		attribute :user, via: Authorship, inverse: true
+	end
+end

data/spec/collections/users_collection.rb

@@ -0,0 +1,7 @@
+class UsersCollection
+	include Guacamole::Collection
+
+	map do
+		attribute :notes, via: Authorship
+	end
+end

data/spec/conditions_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Guacamole::Model::OrmAdapter do
+
+	subject { Guacamole::Model::OrmAdapter.new(User) }
+
+	describe 'AQL query should return the correct aql string ' do
+		let(:conditions) { {:foo => 'bar'} }
+		let(:more_conditions) { { :foo => 'bar', :rating => 42 } }
+		let(:order) { [[:foo, :asc]] }
+		let(:limit) { 1 }
+		let(:offset) { 2 }
+
+
+		it '(<conditions>)' do
+			expect(subject.send(:extract_conditions!, conditions)).to eq [conditions, [], nil, nil]
+		end
+
+		it 'with conditions only' do
+			expect(subject.send(:build_aql, :conditions => conditions)).to eq("FILTER user.foo == \"bar\"")
+		end
+
+
+		it 'with multiple conditions only' do
+			expect(subject.send(:build_aql, :conditions => more_conditions)).to eq("FILTER user.foo == \"bar\" && user.rating == 42")
+		end
+
+		it '(:order => <order>)' do
+			expect(subject.send(:extract_conditions!, :order => order)).to eq [{}, order, nil, nil]
+		end
+
+		it 'with order clause only' do
+			expect(subject.send(:build_aql, :order => order)).to eq('SORT user.foo ASC')
+		end
+
+		it '(:limit => <limit>)' do
+			expect(subject.send(:extract_conditions!, :limit => limit)).to eq [{}, [], limit, nil]
+		end
+
+		it 'with limit only' do
+			expect(subject.send(:build_aql, :limit => limit)).to eq(' LIMIT 1')
+		end
+
+		it 'with order clause and limit' do
+			expect(subject.send(:build_aql, :limit => limit, :order => order)).to eq('SORT user.foo ASC LIMIT 1')
+		end
+
+		it '(:offset => <offset>)' do
+			expect(subject.send(:extract_conditions!, :offset => offset)).to eq [{}, [], nil, offset]
+		end
+
+		it 'with offset only' do
+			expect(subject.send(:build_aql, :offset => offset)).to eq(' LIMIT 2, 2147483647')
+		end
+
+		it 'with order clause, limit and offset' do
+			expect(subject.send(:build_aql, :limit => limit, :order => order, :offset => offset)).to eq('SORT user.foo ASC LIMIT 2, 1')
+		end
+
+		it '(:conditions => <conditions>, :order => <order>)' do
+			expect(subject.send(:extract_conditions!, :conditions => conditions, :order => order)).to eq [conditions, order, nil, nil]
+		end
+
+		it 'with conditions and order clause' do
+			expect(subject.send(:build_aql, :conditions => conditions, :order => order)).to eq("FILTER user.foo == \"bar\" SORT user.foo ASC")
+		end
+
+		it '(:conditions => <conditions>, :limit => <limit>)' do
+			expect(subject.send(:extract_conditions!, :conditions => conditions, :limit => limit)).to eq [conditions, [], limit, nil]
+		end
+
+		it 'with conditions and limit' do
+			expect(subject.send(:build_aql, :conditions => conditions, :limit => limit)).to eq("FILTER user.foo == \"bar\" LIMIT 1")
+		end
+
+		it '(:conditions => <conditions>, :offset => <offset>)' do
+			expect(subject.send(:extract_conditions!, :conditions => conditions, :offset => offset)).to eq [conditions, [], nil, offset]
+		end
+
+		it 'with conditions and offset' do
+			expect(subject.send(:build_aql, :conditions => conditions, :offset => offset)).to eq("FILTER user.foo == \"bar\" LIMIT 2, 2147483647")
+		end
+
+		describe '#valid_object?' do
+
+			it 'determines whether an object is valid for the current model class' do
+				expect(subject.send(:valid_object?, User.new)).to be_truthy
+				expect(subject.send(:valid_object?, String.new)).to be_falsey
+			end
+		end
+
+		describe '#normalize_order' do
+			specify '(nil) returns []' do
+				expect(subject.send(:normalize_order, nil)).to eq []
+			end
+			specify ':foo returns [[:foo, :asc]]' do
+				expect(subject.send(:normalize_order, :foo)).to eq [[:foo, :asc]]
+			end
+			specify '[:foo] returns [[:foo, :asc]]' do
+				expect(subject.send(:normalize_order, [:foo])).to eq [[:foo, :asc]]
+			end
+			specify '[:foo, :desc] returns [[:foo, :desc]]' do
+				expect(subject.send(:normalize_order, [:foo, :desc])).to eq [[:foo, :desc]]
+			end
+			specify '[:foo, [:bar, :asc], [:baz, :desc], :bing] returns [[:foo, :asc], [:bar, :asc], [:baz, :desc], [:bing, :asc]]' do
+				expect(subject.send(:normalize_order, [:foo, [:bar, :asc], [:baz, :desc], :bing])).to eq [[:foo, :asc], [:bar, :asc], [:baz, :desc], [:bing, :asc]]
+			end
+			specify '[[:foo, :wtf]] raises ArgumentError' do
+				expect(lambda { subject.send(:normalize_order, [[:foo, :wtf]]) }).to raise_error(ArgumentError)
+			end
+			specify '[[:foo, :asc, :desc]] raises ArgumentError' do
+				expect(lambda { subject.send(:normalize_order, [[:foo, :asc, :desc]]) }).to raise_error(ArgumentError)
+			end
+		end
+	end
+
+end

data/spec/config/guacamole.yml

@@ -0,0 +1,7 @@
+test:
+  protocol: 'http'
+  host: 'localhost'
+  port: 8529
+  password: 'klaus'
+  username: 'test_pw'
+  database: 'orm_adapter_spec'

data/spec/edges/authorship.rb

@@ -0,0 +1,6 @@
+class Authorship
+	include Guacamole::Edge
+
+	from :users
+	to   :notes
+end

data/spec/example_app_shared.rb

@@ -0,0 +1,266 @@
+# Copied from orm_adapter and fixed some Specs
+# to test your new orm_adapter, make an example app that matches the functionality
+# found in the existing specs for example, look at spec/orm_adapter/adapters/active_record_spec.rb
+#
+# Then you can execute this shared spec as follows:
+#
+# it_should_behave_like "example app with orm_adapter" do
+# let(:user_class) { User }
+# let(:note_class) { Note }
+#
+# # optionaly define the following functions if the ORM does not support
+# # this syntax - this should NOT use the orm_adapter, because we're testing that
+# def create_model(klass, attrs = {})
+# klass.create!(attrs)
+# end
+#
+# def reload_model(model)
+# model.class.find(model.id)
+# end
+# end
+#
+shared_examples_for 'example app with orm_adapter' do
+
+	def create_model(klass, attrs = {})
+		collection_name = "#{klass.model_name.to_s.classify.pluralize}Collection".constantize
+		model = klass.new(attrs)
+		collection_name.create model
+	end
+
+	def reload_model(model)
+		collection_name = "#{model.model_name.to_s.classify.pluralize}Collection".constantize
+		collection_name.by_key(model.id)
+	end
+
+	describe 'an ORM class' do
+
+		subject { note_class }
+
+		it '#to_adapter should return an adapter instance' do
+			expect(subject.to_adapter).to be_a(OrmAdapter::Base)
+		end
+
+		it '#to_adapter should return an adapter for the receiver' do
+			expect(subject.to_adapter.klass).to eq subject
+		end
+
+		it '#to_adapter should be cached' do
+			expect(subject.to_adapter.object_id).to eq subject.to_adapter.object_id
+		end
+	end
+
+	describe 'adapter instance' do
+
+		let(:note_adapter) { note_class.to_adapter }
+		let(:user_adapter) { user_class.to_adapter }
+
+		describe '#get!(id)' do
+
+			it 'should return the instance with id if it exists' do
+				user = create_model(user_class)
+				expect(user_adapter.get!(user.id)).to eq user
+			end
+
+			it 'should allow to_key like arguments' do
+				user = create_model(user_class)
+				expect(user_adapter.get!(user.to_key)).to eq user
+			end
+
+			it 'should raise an error if there is no instance with that id' do
+				expect(lambda { user_adapter.get!('nonexistent id') }).to raise_error
+			end
+
+		end
+
+		describe '#get(id)' do
+
+			it 'should return the instance with id if it exists' do
+				user = create_model(user_class)
+				expect(user_adapter.get(user.id)).to eq user
+			end
+
+			it 'should allow to_key like arguments' do
+				user = create_model(user_class)
+				expect(user_adapter.get(user.to_key)).to eq user
+			end
+
+			it 'should return nil if there is an id which leads into an InvalidURIError' do
+				expect(user_adapter.get('nonexistent id')).to be_nil
+			end
+
+			it 'should return nil if there is no instance with that id' do
+				expect(user_adapter.get('nonexistent_id')).to be_nil
+			end
+
+		end
+
+		describe '#find_first' do
+
+			describe '(conditions)' do
+
+				it 'should return first model matching conditions, if it exists' do
+					user = create_model(user_class, :name => 'Fred')
+					expect(user_adapter.find_first(:name => 'Fred')).to eq user
+				end
+
+				it 'should return nil if no conditions match' do
+					expect(user_adapter.find_first(:name => 'Betty')).to be_nil
+				end
+
+				it 'should return the first model if no conditions passed' do
+					user = create_model(user_class)
+					create_model(user_class)
+					expect(user_adapter.find_first).to eq user
+				end
+
+				xit 'when conditions contain associated object, should return first model if it exists' do
+					user = create_model(user_class)
+					user.notes = create_model(note_class, :body => 'test')
+					expect(note_adapter.find_first(:user => user)).to eq note
+				end
+
+				it 'understands :id as a primary key condition (allowing scoped finding)' do
+					create_model(user_class, :name => 'Fred')
+					user = create_model(user_class, :name => 'Fred')
+					expect(user_adapter.find_first(:id => user.id, :name => 'Fred')).to eq user
+					expect(user_adapter.find_first(:id => user.id, :name => 'Not Fred')).to be_nil
+				end
+			end
+
+			describe '(:order => <order array>)' do
+
+				it 'should return first model in specified order' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					expect(user_adapter.find_first(:order => [:name, [:rating, :desc]])).to eq user2
+				end
+			end
+
+			describe '(:conditions => <conditions hash>, :order => <order array>)' do
+
+				it 'should return first model matching conditions, in specified order' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					expect(user_adapter.find_first(:conditions => {:name => 'Fred'}, :order => [:rating, :desc])).to eq user2
+				end
+			end
+		end
+
+		describe '#find_all' do
+
+			describe '(conditions)' do
+
+				it 'should return only models matching conditions' do
+					user1 = create_model(user_class, :name => 'Fred')
+					user2 = create_model(user_class, :name => 'Fred')
+					user3 = create_model(user_class, :name => 'Betty')
+					expect(user_adapter.find_all(:name => 'Fred').to_a).to match_array [user1, user2]
+				end
+
+				it 'should return all models if no conditions passed' do
+					user1 = create_model(user_class, :name => 'Fred')
+					user2 = create_model(user_class, :name => 'Fred')
+					user3 = create_model(user_class, :name => 'Betty')
+					expect(user_adapter.find_all.to_a).to match_array [user1, user2, user3]
+				end
+
+				it 'should return empty array if no conditions match' do
+					expect(user_adapter.find_all(:name => 'Fred')).to eq []
+				end
+
+				xit 'when conditions contain associated object, should return first model if it exists' do
+					user1, user2 = create_model(user_class), create_model(user_class)
+					note1 = create_model(note_class, :owner => user1)
+					note2 = create_model(note_class, :owner => user2)
+					expect(note_adapter.find_all(:owner => user2)).to eq [note2]
+				end
+			end
+
+			describe '(:order => <order array>)' do
+
+				it 'should return all models in specified order' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					user3 = create_model(user_class, :name => 'Betty', :rating => 1)
+					expect(user_adapter.find_all(:order => [:name, [:rating, :desc]])).to eq [user3, user2, user1]
+				end
+			end
+
+			describe '(:conditions => <conditions hash>, :order => <order array>)' do
+
+				it 'should return only models matching conditions, in specified order' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					user3 = create_model(user_class, :name => 'Betty', :rating => 1)
+					expect(user_adapter.find_all(:conditions => {:name => 'Fred'}, :order => [:rating, :desc])).to eq [user2, user1]
+				end
+			end
+
+			describe '(:limit => <number of items>)' do
+
+				it 'should return a limited set of matching models' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					user3 = create_model(user_class, :name => 'Betty', :rating => 3)
+					#expect(user_adapter.find_all(:limit => 1, :order => [:rating, :asc])).to eq [user1]
+					expect(user_adapter.find_all(:limit => 2, :order => [:rating, :asc])).to eq [user1, user2]
+				end
+			end
+
+			describe '(:offset => <offset number>) with limit (as DataMapper does not allow offset on its own)' do
+
+				it 'should return an offset set of matching models' do
+					user1 = create_model(user_class, :name => 'Fred', :rating => 1)
+					user2 = create_model(user_class, :name => 'Fred', :rating => 2)
+					user3 = create_model(user_class, :name => 'Betty', :rating => 3)
+					expect(user_adapter.find_all(:limit => 3, :offset => 0, :order => [:rating, :asc])).to eq [user1, user2, user3]
+					expect(user_adapter.find_all(:limit => 3, :offset => 1, :order => [:rating, :asc])).to eq [user2, user3]
+					expect(user_adapter.find_all(:limit => 1, :offset => 1, :order => [:rating, :asc])).to eq [user2]
+				end
+			end
+		end
+
+		describe '#create!(attributes)' do
+
+			it 'should create a model with the passed attributes' do
+				user = user_adapter.create!(:name => 'Fred')
+				expect(reload_model(user).name).to eq 'Fred'
+			end
+
+			it 'should raise error when create fails' do
+				expect(lambda { user_adapter.create!(:user => create_model(some_class)) }).to raise_error
+			end
+
+			xit 'when attributes contain an associated object, should create a model with the attributes' do
+				user = create_model(user_class)
+				note = note_adapter.create!(:user => user)
+				expect(reload_model(note).user).to eq user
+			end
+
+			xit 'when attributes contain an has_many assoc, should create a model with the attributes' do
+				notes = [create_model(note_class), create_model(note_class)]
+				user = user_adapter.create!(:notes => notes)
+				expect(reload_model(user).notes).to eq notes
+			end
+		end
+
+		describe '#destroy(instance)' do
+
+			it 'should destroy the instance if it exists' do
+				user = create_model(user_class)
+				expect(!!user_adapter.destroy(user)).to be_truthy
+				expect(user_adapter.get(user.id)).to be_nil
+			end
+
+			it 'should return nil if passed with an invalid instance' do
+				expect(user_adapter.destroy('nonexistent instance')).to be_nil
+			end
+
+			it 'should not destroy the instance if it does not match the model class' do
+				user = create_model(user_class)
+				expect(note_adapter.destroy(user)).to be_nil
+				expect(user_adapter.get(user.id)).to eq user
+			end
+		end
+	end
+end

data/spec/guacamole_spec.rb

@@ -0,0 +1,37 @@
+# -*- encoding : utf-8 -*-
+
+require 'spec_helper'
+
+if !defined?(Guacamole) || !(Guacamole.configuration.database.create rescue Ashikawa::Core::ClientError)
+	puts "** require 'guacamole' and start ArangoDB to run the specs in #{__FILE__}"
+else
+
+	# Pure guacamole related specs!
+	describe 'The collections' do
+
+		let(:new_user) { User.new(name: 'Lou', rating: 99) }
+		let(:new_note) { Note.new(body: 'Mambo No. 5') }
+
+		it 'should create a user in the database' do
+			UsersCollection.save new_user
+
+			expect(UsersCollection.by_key(new_user.key)).to eq new_user
+		end
+
+		it 'should create a note in the database' do
+			NotesCollection.save new_note
+
+			expect(NotesCollection.by_key(new_note.key)).to eq new_note
+		end
+
+		it 'should create a relation between user and note' do
+			UsersCollection.save new_user
+			user = UsersCollection.by_key new_user.key
+			user.notes = new_note
+			UsersCollection.save user
+
+			expect(user.notes.first.body).to eq('Mambo No. 5')
+		end
+	end
+
+end

data/spec/models/note.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+
+class Note
+	include Guacamole::Model
+	extend ActiveSupport::Autoload
+
+	autoload :User, 'models/user'
+
+	attribute :body, String
+	attribute :user, User
+end

data/spec/models/user.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+
+class User
+	include Guacamole::Model
+	extend ActiveSupport::Autoload
+
+	autoload :Note, 'models/note'
+
+	attribute :name, String
+	attribute :rating, Integer
+	attribute :notes, Array[Note]#, coerce: false
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'guacamole'
+require 'orm_adapter'
+require 'orm_adapter-guacamole'
+require 'pry'
+require 'models/note'
+require 'models/user'
+require 'edges/authorship'
+require 'collections/notes_collection'
+require 'collections/users_collection'
+
+
+ENV['GUACAMOLE_ENV'] = 'test'
+
+Guacamole.configure do |config|
+	config.load File.join(File.dirname(__FILE__), 'config', 'guacamole.yml')
+end
+
+begin
+	Guacamole.configuration.database.create
+rescue Ashikawa::Core::ClientError
+# Database already exists, don't worry
+end
+
+RSpec.configure do |config|
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+	config.mock_with :rspec do |c|
+		c.syntax = :expect
+	end
+	config.before(:each) do
+		Guacamole.configuration.database.truncate
+	end
+	config.after(:each) do
+		Guacamole.configuration.database.truncate
+	end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter-guacamole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klaus Humme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: guacamole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: ORM Adapter for guacamole
+email:
+- klaus_21x2@twentyonetwice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/guard
+- lib/guacamole/model/orm_adapter.rb
+- lib/orm_adapter-guacamole.rb
+- lib/orm_adapter-guacamole/version.rb
+- orm_adapter-guacamole.gemspec
+- spec/adapter_spec.rb
+- spec/collections/notes_collection.rb
+- spec/collections/users_collection.rb
+- spec/conditions_spec.rb
+- spec/config/guacamole.yml
+- spec/edges/authorship.rb
+- spec/example_app_shared.rb
+- spec/guacamole_spec.rb
+- spec/models/note.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+homepage: https://github.com/klausinho/orm_adapter-guacamole
+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: ORM Adapter for guacamole, the ODM for the NoSQL database ArangoDB
+test_files: []