arangodb-odm 0.1.1 → 0.2.0

data/README.md

@@ -1,5 +1,13 @@
 # arangodb-odm
 
+## Installation
+
+    gem install arangodb-odm
+
+## Configuration
+
+    ArangoDb::Transport.base_uri 'http://localhost:8529'
+
 ## Example Code
 
 ### Example with dynamic attributes
@@ -31,6 +39,47 @@
 
 	all_document_handles = ExampleDocument.keys
 
+## Callbacks
+
+    class ExampleDocument < ArangoDb::Base
+      collection :examples
+
+      before_create :add_something
+      after_create :do_something_else
+
+      before_destroy :method1
+      after_destroy :method2
+
+      before_save :change_something
+      after_save :change_something_else
+
+      # Called before create/save
+      # must return true if the document is valid
+      def validate
+        not self.foo.nil?
+      end
+
+      def add_something
+        self.something = "other"
+      end
+
+      def do_something_else; end
+
+      def method1
+        puts self._id # not nil
+      end
+
+      def method2
+        puts self._id # is nil
+      end
+
+      def change_something
+        self.foo = 'bar2'
+      end
+
+      def change_something_else; end
+    end
+
 ## Copyright
 
 Copyright (c) 2012 Oliver Kiessler. See LICENSE.txt for

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/arangodb-odm.rb

@@ -52,6 +52,42 @@ module ArangoDb
         end
       end
 
+      def before_create(value)
+        self.send(:define_method, 'before_create') do
+          value
+        end
+      end
+
+      def after_create(value)
+        self.send(:define_method, 'after_create') do
+          value
+        end
+      end
+
+      def before_save(value)
+        self.send(:define_method, 'before_save') do
+          value
+        end
+      end
+
+      def after_save(value)
+        self.send(:define_method, 'after_save') do
+          value
+        end
+      end
+
+      def before_destroy(value)
+        self.send(:define_method, 'before_destroy') do
+          value
+        end
+      end
+
+      def after_destroy(value)
+        self.send(:define_method, 'after_destroy') do
+          value
+        end
+      end
+
       def db_attrs(*attrs)
         @db_attr_names ||= []
         @db_attr_names << attrs.collect {|a| a.to_s} if attrs.any?
@@ -101,28 +137,46 @@ module ArangoDb
 
     def build(attributes = {})
       attributes.each {|k, v| self.send("#{k}=".to_sym, v) unless ['_id', '_rev'].include?(k)}
-      self.target._id = attributes['_id']
-      self.target._rev = attributes['_rev']
-      self.target.location = "/_api/document/#{self.target._id}"
+      self.target._id = attributes['_id'] if attributes['_id'] 
+      self.target._rev = attributes['_rev'] if attributes['_rev']
+      self.target.location = "/_api/document/#{self.target._id}" if attributes['_id']
       self
     end
 
     def save
-      if @target.is_new?
-        res = @transport.post("/_api/document/?collection=#{@target.collection}&createCollection=true", :body => to_json)
-        if res.code == 201 || res.code == 202
-          @target.location = res.headers["location"]
-          @target._id = res.parsed_response["_id"]
-          @target._rev = res.headers["etag"]
-          return @target._id
+      if validate
+        if @target.is_new?
+          if self.respond_to?(:before_create) and self.before_create
+            self.send(self.before_create.to_sym)
+          end
+          res = @transport.post("/_api/document/?collection=#{@target.collection}&createCollection=true", :body => to_json)
+          if res.code == 201 || res.code == 202
+            @target.location = res.headers["location"]
+            @target._id = res.parsed_response["_id"]
+            @target._rev = res.headers["etag"]
+            if self.respond_to?(:after_create) and self.after_create
+              self.send(self.after_create.to_sym)
+            end
+            return @target._id
+          end
+        else
+          if self.respond_to?(:before_save) and self.before_save
+            self.send(self.before_save.to_sym)
+          end
+          res = @transport.put(@target.location, :body => to_json)
+          @target._rev = res.parsed_response['_rev']
+          if self.respond_to?(:after_save) and self.after_save
+            self.send(self.after_save.to_sym)
+          end
+          return @target._rev
         end
-      else
-        res = @transport.put(@target.location, :body => to_json)
-        return (@target._rev = res.parsed_response['_rev'])
       end
       nil
     end
-
+  
+    # Override to run your own validations.
+    def validate; true; end
+  
     def changed?
       unless @target.is_new?
         res = @transport.head(@target.location)
@@ -133,9 +187,15 @@ module ArangoDb
 
     def destroy
       unless is_new?
+        if self.respond_to?(:before_destroy) and self.before_destroy
+          self.send(self.before_destroy.to_sym)
+        end
         res = @transport.delete(@target.location)
         if res.code == 200
           @target.location = nil; @target._id = nil; @target._rev = nil
+          if self.respond_to?(:after_destroy) and self.after_destroy
+            self.send(self.after_destroy.to_sym)
+          end
           return true
         end
       end

data/test/helper.rb

@@ -14,5 +14,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'arangodb-odm'
 
+# Set your ArangoDB host...
+ArangoDb::Transport.base_uri 'http://localhost:8529'
+
 class Test::Unit::TestCase
 end

data/test/test_arangodb-odm.rb

@@ -2,12 +2,45 @@ require 'helper'
 
 class ExampleDocument < ArangoDb::Base
   collection :examples
+  
+  before_create :add_something
+  after_create :do_something_else
+  
+  before_destroy :method1
+  after_destroy :method2
+
+  def validate
+    not self.foo.nil?
+  end
+  
+  def add_something
+    self.something = "other"
+  end
+  
+  def do_something_else; end
+  
+  def method1
+    # puts self._id
+  end
+  
+  def method2
+    # puts self._id
+  end
 end
 
 # Example with predefined attributes
 class AnotherExampleDocument < ArangoDb::Base
   collection :more_examples
   db_attrs :foo, :bar
+  
+  before_save :change_something
+  after_save :change_something_else
+  
+  def change_something
+    self.foo = 'bar2'
+  end
+  
+  def change_something_else; end
 end
 
 class TestArangoDbRb < Test::Unit::TestCase
@@ -21,23 +54,23 @@ class TestArangoDbRb < Test::Unit::TestCase
     doc.foo = "bar"
     doc.test = 1
     doc.list = [1, 2, 3]
-    
+
     assert_nil doc._id
     assert_nil doc._rev
     assert_nil doc.location
- 
+
     _id = doc.save
     assert_not_nil _id
     assert_not_nil doc._id
     assert_not_nil doc._rev
     assert_not_nil doc.location
-    
+
     doc = ExampleDocument.find(_id)
     assert_equal doc._id, _id
     assert_equal doc.foo, "bar"
     assert_equal doc.test, 1
     assert_equal doc.list, [1, 2, 3]
-    
+
     doc2 = AnotherExampleDocument.new
     doc2.foo = 'bar'
     doc2.bar = 'foo'
@@ -47,10 +80,12 @@ class TestArangoDbRb < Test::Unit::TestCase
     assert_not_nil doc2._id
     assert_not_nil doc2._rev
     assert_not_nil doc2.location
+    assert_equal doc2.foo, 'bar'
+    _rev = doc2.save
     
     doc3 = AnotherExampleDocument.find(_id)
     assert_nil doc3.foo2
-    assert_equal doc3.foo, 'bar'
+    assert_equal doc3.foo, 'bar2'
     assert_equal doc3.bar, 'foo'
   end
 
@@ -64,6 +99,20 @@ class TestArangoDbRb < Test::Unit::TestCase
     assert_equal doc.list, [1, 2, 3]
   end
 
+  should "create a document and use callbacks" do
+    doc = ExampleDocument.new
+    doc.a = "b"
+    doc.foo = "bar"
+    assert_nil doc.something
+    _id = doc.save
+    assert_not_nil doc.something
+    
+    doc = ExampleDocument.find(_id)
+    assert_equal doc._id, _id
+    assert_equal doc.a, "b"
+    assert_equal doc.something, "other"
+  end
+
   should "find a document by id" do
     doc = ExampleDocument.create(:foo => "bar", :test => 1, :list => [1, 2, 3])
     assert_not_nil doc._id

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arangodb-odm
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Oliver Kiessler