arangodb-odm 0.3.0 → 0.3.1

data/Gemfile

@@ -6,6 +6,9 @@ group :development do
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
   gem "rdoc", "~> 2.4.2"
 end
+
+group :test do
+  gem 'simplecov', :require => false
+end

data/Gemfile.lock

@@ -25,7 +25,6 @@ GEM
     multi_json (1.4.0)
     multi_xml (0.5.1)
     rake (10.0.2)
-    rcov (1.0.0)
     rdoc (2.4.3)
       hoe (>= 1.12.1)
       minitest (~> 1.3)
@@ -36,6 +35,10 @@ GEM
     shoulda-matchers (1.4.2)
       activesupport (>= 3.0.0)
       bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
@@ -45,6 +48,6 @@ DEPENDENCIES
   httparty
   jeweler (~> 1.6.4)
   json
-  rcov
   rdoc (~> 2.4.2)
   shoulda
+  simplecov

data/README.md

@@ -57,6 +57,12 @@
 #### First by example
     
     ExampleDocument.where('foo' => 'bar', 'a' => 'b').first
+    
+#### Range
+
+    # Make sure you've setup a skip-list index on the attribute
+    ExampleDocument.attribute('test').left(0).right(100).all
+    ExampleDocument.attribute('test').left(0).right(100).closed(true).skip(10).limit(10).all
 
 ## Callbacks
 
@@ -98,6 +104,20 @@
 
       def change_something_else; end
     end
+    
+## Indices
+
+### Skip List Index Definition
+
+    class ExampleDocument < ArangoDb::Base
+      collection :examples
+      skiplist :test, :something_else
+    end
+
+### Creating indices
+
+    # Creates all indices defined in the document. Run it once when you setup your document model...
+    ExampleDocument.ensure_indices
 
 ## Copyright
 

data/Rakefile

@@ -33,13 +33,7 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
+# TODO simplecov
 
 task :default => :test
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/arangodb-odm.rb

@@ -1,7 +1,10 @@
 require "rubygems"
 require "httparty"
 require "json"
+
+require "collections"
 require "queries"
+require "indices"
 
 module ArangoDb
   class Transport
@@ -29,60 +32,83 @@ module ArangoDb
     end
   end
 
+  class Index
+    attr_accessor :indices
+
+    def initialize(indices)
+      @indices = indices
+    end
+  end
+
   module Properties
     def self.included(klass)  
       klass.extend ClassMethods  
     end
 
     module ClassMethods
+      # The collection to use for this document.
       def collection(value)
         (class << self; self; end).send(:define_method, 'collection') do
           value.to_s
         end
       end
 
+      def skiplist(*fields)
+        (class << self; self; end).send(:define_method, 'skiplist') do
+          fields.to_a
+        end
+      end
+      
+      # Sets the transport class to use. Defaults to httparty.
       def transport(value)
         (class << self; self; end).send(:define_method, 'transport') do
           value
         end
       end
 
+      # Sets the document value proxy to use.
       def target(value)
         (class << self; self; end).send(:define_method, 'target') do
           value
         end
       end
 
+      # Callback that is being invoked before a document is first created.
       def before_create(value)
         self.send(:define_method, 'before_create') do
           value
         end
       end
 
+      # Callback that is being invoked after a document is first created.
       def after_create(value)
         self.send(:define_method, 'after_create') do
           value
         end
       end
 
+      # Callback that is being invoked before a document is updated.
       def before_save(value)
         self.send(:define_method, 'before_save') do
           value
         end
       end
 
+      # Callback that is being invoked after a document was updated.
       def after_save(value)
         self.send(:define_method, 'after_save') do
           value
         end
       end
 
+      # Callback that is being invoked before a document is destroyed.
       def before_destroy(value)
         self.send(:define_method, 'before_destroy') do
           value
         end
       end
 
+      # Callback that is being invoked after a document was destroyed.
       def after_destroy(value)
         self.send(:define_method, 'after_destroy') do
           value
@@ -106,18 +132,24 @@ module ArangoDb
   #
   # class ExampleDocument < ArangoDb::Base
   #  collection :examples
+  #  skiplist [:a, :b]
   # end
   class Base
     include ArangoDb::Properties
+    extend ArangoDb::Collections::ClassMethods
     extend ArangoDb::Queries::ClassMethods
+    extend ArangoDb::Indices::ClassMethods
     transport ArangoDb::Transport
     target ArangoDb::Document
     db_attrs []
-    attr_reader :target
+    attr_reader :target, :index
 
     def initialize
       @transport = self.class.transport
       @target = self.class.target.new(self.class.collection, self.class.db_attributes)
+      if self.class.respond_to?(:skiplist) and self.class.skiplist
+        @index = ArangoDb::Index.new(:skiplist => self.class.skiplist)
+      end
     end
 
     def self.find(document_handle)

data/lib/collections.rb

@@ -0,0 +1,24 @@
+module ArangoDb
+  module Collections
+    module ClassMethods
+      # POST /_api/collection
+      # Creates an new collection with a given name. The request must contain an object with the following attributes.
+      # name: The name of the collection.
+      # waitForSync (optional, default: false): If true then the data is synchronised to disk before returning from a create or update of an document.
+      # journalSize (optional, default is a configuration parameter): The maximal size of a journal or datafile. Note that this also limits the maximal 
+      # size of a single object. Must be at least 1MB.
+      # isSystem (optional, default is false): If true, create a system collection. In this case collection-name should start with an underscore. 
+      # End users should normally create non-system collections only. 
+      # API implementors may be required to create system collections in very special occasions, but normally a regular collection will do.
+      # type (optional, default is 2): the type of the collection to create. The following values for type are valid:
+      # 2: document collections
+      # 3: edge collection
+      def create_collection(options = {})
+        res = transport.post("/_api/collection", :body => options.merge('name' => collection).to_json)
+        if res.parsed_response and not res.parsed_response["code"] == 200
+          res.parsed_response["id"]
+        end
+      end
+    end
+  end
+end

data/lib/indices.rb

@@ -0,0 +1,26 @@
+module ArangoDb
+  module Indices
+    module ClassMethods
+      
+      # POST /_api/index?collection=collection-identifier
+      # Creates a skip-list index for the collection collection-identifier, if it does not already exist. The call expects an object 
+      # containing the index details.
+      # type: must be equal to "skiplist".
+      # fields: A list of attribute paths.
+      # unique: If true, then create a unique index.
+      def create_skiplist(fields)
+        query_parameters = { "type" => "skiplist", "unique" => false, "fields" => fields }
+        endpoint = "/_api/index?collection=#{collection}"
+        res = transport.post(endpoint, :body => query_parameters.to_json)
+        if res.parsed_response and not (res.parsed_response["code"] == 200 or res.parsed_response["code"] == 201)
+          raise "Couldn't create skip list index: #{res.parsed_response["code"]}"
+        end
+      end
+
+      def ensure_indices
+        create_skiplist(skiplist) if skiplist
+        true
+      end
+    end
+  end
+end

data/lib/queries.rb

@@ -1,6 +1,7 @@
 module ArangoDb
   module Queries
     class QueryResult < Array
+      # TODO
     end
 
     class Query
@@ -24,6 +25,26 @@ module ArangoDb
         self
       end
 
+      def attribute(attr_name)
+        @attribute = attr_name
+        self
+      end
+
+      def left(number)
+        @left = number
+        self
+      end
+      
+      def right(number)
+        @right = number
+        self
+      end
+
+      def closed(boolean)
+        @closed = boolean
+        self
+      end
+
       def first
         @model.first(query_parameters)
       end
@@ -31,13 +52,17 @@ module ArangoDb
       def all
         @model.all(query_parameters)
       end
-      
+
       private
       def query_parameters
         options = {}
         options['limit'] = @limit if @limit
         options['skip'] = @skip if @skip
         options['example'] = @where if @where
+        options['left'] = @left if @left
+        options['right'] = @right if @right
+        options['attribute'] = @attribute if @attribute
+        options['closed'] = @closed if @closed
         options
       end
     end
@@ -56,9 +81,24 @@ module ArangoDb
       # example: The example.
       # skip: The documents to skip in the query. (optional)
       # limit: The maximal amount of documents to return. (optional)
+      #
+      # PUT /_api/simple/range
+      # This will find all documents within a given range. You must declare a skip-list index on the attribute in order 
+      # to be able to use a range query.The call expects a JSON hash array as body with the following attributes:
+      # collection: The identifier or name of the collection to query.
+      # attribute: The attribute path to check.
+      # left: The lower bound.
+      # right: The upper bound.
+      # closed: If true, use interval including left and right, otherwise exclude right, but include left.
+      # skip: The documents to skip in the query. (optional)
+      # limit: The maximal amount of documents to return. (optional)
       def all(options = {})
         query_parameters = {'collection' => collection}; endpoint = '/_api/simple/all'
-        endpoint = '/_api/simple/by-example' if options and options['example'] and options['example'].any?
+        if options and options['example'] and options['example'].any?
+          endpoint = '/_api/simple/by-example'
+        elsif options and options['left'] and options['right'] and options['attribute']
+          endpoint = '/_api/simple/range'
+        end
         res = transport.put(endpoint, :body => query_parameters.merge(options).to_json)
         if res.code == 201 and res.parsed_response and res.parsed_response["result"]
           query_result = QueryResult.new
@@ -91,6 +131,22 @@ module ArangoDb
       def skip(number)
         Query.new(self).skip(number)
       end
+      
+      def attribute(attr_name)
+        Query.new(self).attribute(attr_name)
+      end
+
+      def left(number)
+        Query.new(self).left(number)
+      end
+      
+      def right(number)
+        Query.new(self).right(number)
+      end
+      
+      def closed(boolean)
+        Query.new(self).closed(boolean)
+      end
     end
   end
 end

data/test/example_document.rb

@@ -1,6 +1,7 @@
 class ExampleDocument < ArangoDb::Base
   collection :examples
-  
+  skiplist :test
+
   before_create :add_something
   after_create :do_something_else
   

data/test/helper.rb

@@ -19,5 +19,10 @@ require 'another_example_document.rb'
 # Set your ArangoDB host...
 ArangoDb::Transport.base_uri 'http://localhost:8529'
 
+# Initial setup
+ExampleDocument.create_collection # only needed to be able to create indices on the initial test run
+ExampleDocument.ensure_indices
+# AnotherExampleDocument.create_collection
+
 class Test::Unit::TestCase
 end

data/test/test_collections.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+class TestArangoDbCollections < Test::Unit::TestCase
+  should "create a collection" do
+    assert true
+    # TODO
+  end
+end

data/test/test_indices.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestArangoDbIndices < Test::Unit::TestCase
+  should "create skiplist" do
+    assert ExampleDocument.ensure_indices
+  end
+end

data/test/test_queries.rb

@@ -29,4 +29,24 @@ class TestArangoDbQueries < Test::Unit::TestCase
     example_document = ExampleDocument.where(:something => 'not existant').first
     assert_nil example_document
   end
+  
+  should "get documents in a given range" do
+    ts = Time.now.to_i + rand(1000); count = 10
+    count.times {|i| ExampleDocument.create(:foo => "1", :test => ts + i)}
+    
+    example_documents = ExampleDocument.attribute(:test).left(ts + 6).right(ts + 9).all
+    assert_not_nil example_documents
+    assert_equal example_documents.size, 3
+    assert_equal example_documents[0].test, ts + 6
+    assert_equal example_documents[1].test, ts + 7
+    assert_equal example_documents[2].test, ts + 8
+    
+    example_documents = ExampleDocument.attribute(:test).left(ts + 6).right(ts + 9).closed(true).all
+    assert_not_nil example_documents
+    assert_equal example_documents.size, 4
+    assert_equal example_documents[0].test, ts + 6
+    assert_equal example_documents[1].test, ts + 7
+    assert_equal example_documents[2].test, ts + 8
+    assert_equal example_documents[3].test, ts + 9
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: arangodb-odm
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Oliver Kiessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-03 00:00:00 Z
+date: 2012-12-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -93,20 +93,6 @@ dependencies:
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
-  name: rcov
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -117,12 +103,12 @@ dependencies:
         - 4
         - 2
         version: 2.4.2
-  version_requirements: *id007
+  version_requirements: *id006
   name: rdoc
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -131,12 +117,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id008
+  version_requirements: *id007
   name: httparty
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -145,7 +131,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id009
+  version_requirements: *id008
   name: json
   prerelease: false
   type: :runtime
@@ -167,11 +153,15 @@ files:
 - Rakefile
 - VERSION
 - lib/arangodb-odm.rb
+- lib/collections.rb
+- lib/indices.rb
 - lib/queries.rb
 - test/another_example_document.rb
 - test/example_document.rb
 - test/helper.rb
 - test/test_arangodb-odm.rb
+- test/test_collections.rb
+- test/test_indices.rb
 - test/test_queries.rb
 homepage: http://github.com/okiess/arangodb-odm
 licenses: