guacamole 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f6f1c73821edaf59fae8fea0554389f9426a9c
-  data.tar.gz: 4eb7f2737b833d830680804d0681b39612e4e27d
+  metadata.gz: 2522fab030888fc0ee9601790aabd2134c6f32dc
+  data.tar.gz: 400562752f398045f858bbe9edf3c40d621fcc4c
 SHA512:
-  metadata.gz: 3d73b44a1c7111fe19d662f3ede415f2b574d1502b90644050e029ae330869ceec50b32d621d8863c8b45f0ded991997a6753701cfeb4ef976774f94ab9ea63d
-  data.tar.gz: 95bed05003e2f5a2796b7e53b03a9c7620e2a325b3b47697be15e451c8be813ecd1c45eaffb0c4c1113fa0777e2d1d2146dded64698bdb7638252e0db265f298
+  metadata.gz: 8c1b397cab789fee57a5a98eb76e46f9c422b466747cd9be272591cc66aee47829253c484ffd500e9fe0755fc255d43df55742546404ecf618a536f27538ab18
+  data.tar.gz: 19f830e89f65c7c4c8404a4ce49559920a6a3eac6e0bbe0eab34671f944a49bc0412d530aaad984fb0fd5cba7bd77ffbbd5c6dc8d1bc3e1248a5605972e0e8c3

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p353
+ruby-2.1.2

data/.travis.yml

@@ -5,12 +5,13 @@ before_script:
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.2
   - jruby-19mode
   - jruby-head
   - rbx-19mode
   - ruby-head
 env:
-  - ARANGODB_DISABLE_AUTHENTIFICATION=true VERSION=1.4.0-beta2
+  - ARANGODB_DISABLE_AUTHENTIFICATION=true VERSION=2.0
 matrix:
   allow_failures:
     - rvm: jruby-19mode

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+## Version 0.2.0
+
+**Codename: Into the Storm**
+
+This is a quick follow up release to fix some bugs and to introduce some experimental AQL support to get people better started with Guacamole and ArangoDB.
+
+Notable changes are:
+
+ * Improvements to the README (thanks to @janpieper, @tisba, @ujjwalt)
+ * Fix the loading of ActiveSupport (#57, #59)
+ * Updated to Ashikawa::Core 0.11.0 (#60)
+ * Automatically add `app/collections` to the autoload path (#52)
+ * Build against Ruby 2.1.2 (#56)
+ * Add an experimental support for AQL (#51)
+
+**Note**: As of today release name will be taken from Blind Guardian song titles \m/
+
+
+## Version 0.1.0
+
+**Codename: The Dawn**
+
+This is the very first release of Guacamole. Please be aware that is alpha software and we don't recommend it to be used in production systems. It is meant to be used in prototypes to help people getting started with ArangoDB in the context of a Rails application. We love to hear about your feedback and impressions on this project.
+
+The main features we added in this release:
+
+ * Added an Identity Map
+ * Added lazy associations
+ * Fixed hamster dependency
+ * Added database related rake tasks
+ * Added basic Rails generators
+ * Significant improvements to the README, including a getting started guide
+ * Using the latest Ashikawa::Core version
+ * Some internal improvement to optimize the development process
+
+
+## Version 0.0.1
+
+Merely a release but a proof of concept.

data/README.md

@@ -11,7 +11,7 @@ Guacamole is an Object Document Mapper (ODM) for the multi-model NoSQL database
   * Reflect the nature of NoSQL in general and ArangoDB in particular
   * Focus on long-term maintainability of your application
 
-While the first two points don't need any further explanation we want to lay out the motivation behind the last point: 'Ease of use' is very important to us, but we made some fundamental decisions which will cause a stepper learning curve than other libraries, notably ActiveRecord. If you have a traditional Rails background you will find some things quite different. We decided to go this direction, because we think it better suites the features of ArangoDB. Applying the semantics of a different environment maybe helps with the first steps but will become problematic if you further advance in your understanding of the possibilities.
+While the first two points don't need any further explanation we want to lay out the motivation behind the last point: 'Ease of use' is very important to us, but we made some fundamental decisions which will cause a steeper learning curve than other libraries, notably ActiveRecord. If you have a traditional Rails background you will find some things quite different. We decided to go this direction, because we think it better suites the features of ArangoDB. Applying the semantics of a different environment may help with the first steps but will become problematic if you further advance in your understanding of the possibilities.
 
 That said we still think we provide a sufficient API that is quite easy to get hold of. It is just a bit different from what you were doing with ActiveRecord.
 
@@ -19,7 +19,7 @@ For a high-level introduction you can also refer to [this presentation](https://
 
 ## Getting started (with a fresh Rails application)
 
-Since Guacamole is in an alpha state we suggest you create a new Rails application to play around with it. We don't recommend adding it to a production application.
+Since Guacamole is in an alpha state we suggest you to create a new Rails application to play around with it. We don't recommend adding it to a production application.
 
 First of all create your shiny new application, without ActiveRecord of course:
 
@@ -71,11 +71,11 @@ Now where everything is set up we can go ahead and create our application's logi
 
 ## Usage
 
-One of the key features of Guacamole is the implementation of the [Data Mapper Patter](http://martinfowler.com/eaaCatalog/dataMapper.html). This brings a lot of good things along, like
+One of the key features of Guacamole is the implementation of the [Data Mapper Pattern](http://martinfowler.com/eaaCatalog/dataMapper.html). This brings a lot of good things along, like
 
-  * Improved testability
-  * Separation of Concern and
-  * Easier to support database
features like embedded objects
+  * improved testability
+  * separation of concerns and
+  * easier to support database
 features like embedded objects
 
 The gist of the pattern is you have two classes where you would have one when you use ActiveRecord: A `Collection` and a `Model`. The `Collection` is responsible for getting data from and writing data to the database. The `Model` represents the domain logic (i.e. attributes) and has no idea what a database is. Due to this you could far easier test the domain logic without a database dependency. But you have always two (or more) classes around. The following will introduce you to both those classes.
 
@@ -99,7 +99,7 @@ class Pony
 end
 ```
 
-Since the database doesn't know anything about a schema we must define the attributes in the model class itself. At the same time this has the advantage to open the model class and see what attributes it has. An attribute is defined with the `attribute` class method. We use [Virtus](https://github.com/solnic/virtus) for this purpose. Basically you add give the attribute a name and a type. The type have to be the actual class and **not** a string representation of the class. You could even define collection classes:
+Since the database doesn't know anything about a schema we must define the attributes in the model class itself. At the same time this has the advantage to open the model class and see what attributes it has. An attribute is defined with the `attribute` class method. We use [Virtus](https://github.com/solnic/virtus) for this purpose. Basically you give the attribute a name and a type. The type have to be the actual class and **not** a string representation of the class. You could even define collection classes:
 
 ```ruby
 class Pony
@@ -109,7 +109,7 @@ class Pony
 end
 ```
 
-For further reference what is possible please refer to the [Virtus documentation](http://rubydoc.info/gems/virtus/1.0.2/frames). One thing to add here, whenever you assign a value to an attribute Virtus will perform a type coercion:
+For further reference what is possible please refer to the [Virtus documentation](http://rubydoc.info/gems/virtus/1.0.2/frames). One thing to note here: Whenever you assign a value to an attribute Virtus will perform a type coercion:
 
 ```ruby
 pinkie_pie = Pony.new
@@ -121,11 +121,11 @@ pinkie_pie.type  = "Earthpony"
 
 #### Timestamps
 
-We will automatically add time stamp columns to all models when you include `Guacamole::Model`. We eventually will make this configurable, but for now it is not.
+We will automatically add both a `created_at` and an `updated_at` attribute to all your models. Both will hold a `DateTime` and will be populated on creating or updating the model in the database.
 
 #### The ID of a model
 
-In ArangoDB a document has three internal fields: `_id`, `_key` and `_rev`. For a detailed explanation how these three work together please refer to the [ArangoDB documentation](https://www.arangodb.org/manuals/2/HandlingDocuments.html#HandlingDocumentsIntro). Within Guacamole we will always you the `_key` because it is enough the identify any document within a collection. Both the `_key` and `_rev` attribute are available through the `Guacamole::Model#key` and `Guacamole::Model#rev` attribute. You don't have to do anything for this, we will take care of this for you.
+In ArangoDB a document has three internal fields: `_id`, `_key` and `_rev`. For a detailed explanation how these three work together please refer to the [ArangoDB documentation](https://www.arangodb.org/manuals/2/HandlingDocuments.html#HandlingDocumentsIntro). Within Guacamole we will always use the `_key` because it is enough the identify any document within a collection. Both the `_key` and `_rev` attribute are available through the `Guacamole::Model#key` and `Guacamole::Model#rev` attribute. You don't have to do anything for this, we will take care of this for you.
 
 Additionally you will find an `id` method on you models. This is just an alias for `key`. This was added for `ActiveModel::Conversion` compliance. You **should always** use `key`.
 
@@ -175,7 +175,7 @@ Currently your options what you can do with a collection are quire limited. We w
   * Mapping embedded models
   * Realizing basic associations
 
-For all the mapping related parts you don't have any configuration options yet, but have to stick with the conventions. Obviously this will change in the future but for now there more important parts to work on. Before we dig deeper into the mapping of embedded or associated models let us look at the CRUD functionality.
+For all the mapping related parts you don't have any configuration options yet, but have to stick with the conventions. Obviously this will change in the future but for now there are more important parts to work on. Before we dig deeper into the mapping of embedded or associated models let us look at the CRUD functionality.
 
 #### Create models
 
@@ -235,7 +235,7 @@ We're well aware this is not sufficient for building sophisticated applications.
 
 ### Mapping
 
-As the name "Data Mapper" suggests there is some sort of mapping going on behind the scenes. The mapping relates to the process of _mapping_ documents from the database to the domain models. 
+As the name "Data Mapper" suggests there is some sort of mapping going on behind the scenes. The mapping relates to the process of _mapping_ documents from the database to the domain models.
 
 The `Collection` class will lookup the appropriate `Model` class based on its own name (i.e.: the `PoniesCollection` will look for a `Pony` class). Currently there is no option to configure this so you're stuck with our conventions (for now):
 
@@ -254,15 +254,24 @@ Without any configuration we will just map the attributes present in your domain
 }
 ```
 
-When we receive this document and map it against the above mentioned model there will be no `occupation` attribute be present:
+When we receive this document and map it against the `Pony` model there won't be a `occupation` attribute:
 
 ```ruby
+class Pony
+  include Guacamole::Model
+
+  attribute :name, String
+  attribute :color, String
+end
+
 pony = PoniesCollection.by_key "303"
+pony.color
+# => 'green'
 pony.occupation
 # => NoMethodError: undefined method `occupation' for #<Pony:0x00000105fc77f8>
 ```
 
-Currently there is not option to change the mapping of attributes. If you want to map more or less attributes you should create another model for that purpose.
+Currently there is no option to change the mapping of attributes. If you want to map more or less attributes you should create another model for that purpose.
 
 #### Associations
 
@@ -393,7 +402,7 @@ Guacamole is a very young project. A lot of stuff is missing but still, if you w
 
 Currently we're not providing any testing helper, thus you need to make sure to cleanup the database yourself before each run. You can look at the [`spec/acceptance/spec_helper.rb`](https://github.com/triAGENS/guacamole/blob/master/spec/acceptance/spec_helper.rb) of Guacamole for inspiration of how to do that.
 
-For test data generation we're using the awesome [Fabrication gem](http://www.fabricationgem.org/). Again you find some usage examples in under Guacamole's own acceptance tests. We didn't tested Factory Girl yet, but it eventually will work, too.
+For test data generation we're using the awesome [Fabrication gem](http://www.fabricationgem.org/). Again you find some usage examples in Guacamole's own acceptance tests. We didn't tested Factory Girl yet, but it eventually will work, too.
 
 ### Authentication
 
@@ -415,6 +424,26 @@ While there are a lot of open issues we would like to present you a high level o
   * An example Rails application to be used as both an acceptance test suite and a head start for Guacamole and ArangoDB
   * An AQL query builder
 
+### Experimental AQL Support
+
+As mentioned before we're working on [something more sophisticated to support AQL](https://github.com/moonglum/brazil/issues/8). But this will not be finished any time soon. Meanwhile you could play with the experimental AQL support:
+
+```ruby
+config.guacamole.experimental_features = [:aql_support]
+```
+
+After that you can perform very basic queries like this one:
+
+```ruby
+PoniesCollection.by_aql('FILTER pony.name == @name', name: 'Rainbow Dash')
+```
+
+The result of this will a correctly mapped Array of `Pony` models.
+
+**Note**: Please use only this form to pass parameters into a query. Using string interpolation will leave you vulnerable to AQL-injections.
+
+For more information about usage please refer to the RDoc and the code.
+
 ## Issues or Questions
 
 If you find a bug in this gem, please report it on [our tracker](https://github.com/triAGENS/guacamole/issues). We use [Waffle.io](https://waffle.io/triagens/guacamole) to manage the tickets – go there to see the current status of the ticket. If you have a question, just contact us via the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/ashikawa) – we are happy to help you :smile:

data/config/reek.yml

@@ -22,7 +22,6 @@ DuplicateMethodCall:
   exclude:
   - Guacamole::DocumentModelMapper#document_to_model
   - Guacamole::DocumentModelMapper#model_to_document
-  - Guacamole::Configuration#_add_missing_methods_to_database
   max_calls: 1
   allow_calls: []
 FeatureEnvy:
@@ -34,7 +33,8 @@ IrresponsibleModule:
   - - !ruby/regexp /Generators/
 LongParameterList:
   enabled: true
-  exclude: []
+  exclude:
+  - Guacamole::Collection::ClassMethods#by_aql
   max_params: 2
   overrides:
     initialize:
@@ -45,8 +45,7 @@ LongYieldList:
   max_params: 2
 NestedIterators:
   enabled: true
-  exclude:
-  - Guacamole::Configuration#_add_missing_methods_to_database
+  exclude: []
   max_allowed_nesting: 2
   ignore_iterators: []
 NilCheck:
@@ -64,7 +63,7 @@ TooManyInstanceVariables:
 TooManyMethods:
   enabled: true
   exclude: []
-  max_methods: 10
+  max_methods: 20
 TooManyStatements:
   enabled: true
   exclude:
@@ -73,8 +72,6 @@ TooManyStatements:
   - Guacamole::DocumentModelMapper#model_to_document
   - Guacamole::Collection::ClassMethods#create_document_from
   - Guacamole::Collection::ClassMethods#create_referenced_by_models_of
-  - Guacamole::Configuration#_add_missing_methods_to_database
-  - Guacamole::Configuration#create_database_connection_from
   max_statements: 5
 UncommunicativeMethodName:
   enabled: true

data/guacamole.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['moonglum@moonbeamlabs.com', 'dirk.breuer@gmail.com']
   spec.description   = %q{ODM for ArangoDB}
   spec.summary       = %q{An ODM for ArangoDB that uses the DataMapper pattern.}
-  spec.homepage      = 'https://github.com/triAGENS/guacamole'
+  spec.homepage      = 'http://guacamolegem.org'
   spec.license       = 'Apache License 2.0'
 
   spec.files         = `git ls-files`.split($/)
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'ashikawa-core', '~> 0.10.0'
+  spec.add_dependency 'ashikawa-core', '~> 0.11.0'
   spec.add_dependency 'virtus', '~> 1.0.1'
   spec.add_dependency 'activesupport', '>= 4.0.0'
   spec.add_dependency 'activemodel', '>= 4.0.0'

data/lib/guacamole.rb

@@ -1,8 +1,7 @@
 # -*- encoding : utf-8 -*-
 
-require 'active_support/core_ext'
-
 require 'guacamole/version'
+require 'guacamole/exceptions'
 require 'guacamole/configuration'
 require 'guacamole/model'
 require 'guacamole/collection'

data/lib/guacamole/aql_query.rb

@@ -0,0 +1,101 @@
+# -*- encoding : utf-8 -*-
+
+module Guacamole
+  # Build an AQL query for ArangoDB
+  class AqlQuery < Query
+    # The AQL fragment to be added into the complete query
+    attr_accessor :aql_fragment
+
+    # The associated collection
+    attr_reader :collection
+
+    # The additional options
+    attr_reader :options
+
+    # Create a new AqlQuery
+    #
+    # @param [Guacamole::Collection] collection The collection class to be used
+    # @param [Class] mapper The class of the mapper to use
+    # @param [Hash] options Additional options for query execution
+    # @option options [String] :return_as ('RETURN #{model_name}') A custom `RETURN` statement
+    # @option options [Boolean] :mapping (true) Should the mapping be performed?
+    def initialize(collection, mapper, options = {})
+      @collection = collection
+      super(collection.connection.query, mapper)
+      @options = default_options.merge(options)
+    end
+
+    # Set the bind parameters
+    #
+    # @param [Hash] bind_parameters All the bind parameters
+    def bind_parameters=(bind_parameters)
+      @options[:bind_vars] = bind_parameters
+    end
+
+    # Get the bind parameters
+    #
+    # @return [Hash] All the bind parameters
+    def bind_parameters
+      @options[:bind_vars]
+    end
+
+    # Creates an AQL string based on the `aql_fragment`,
+    # the collection and model information.
+    #
+    # @return [String] An AQL string ready to be send to Arango
+    def aql_string
+      aql_string = "FOR #{model_name} IN #{collection_name} #{aql_fragment} #{return_as}"
+      Guacamole.logger.debug "[AQL] #{aql_string} | bind_parameters: #{bind_parameters}"
+      aql_string
+    end
+
+    # The RETURN part of the query
+    #
+    # @return [String] Either the default `RETURN model_name` or a custom string
+    def return_as
+      options[:return_as]
+    end
+
+    # Should the mapping step be perfomed? If set to false we will return the raw document.
+    #
+    # @return [Boolean] Either if the mapping should be perfomed or not
+    def perform_mapping?
+      options[:mapping]
+    end
+
+    # The default options to be set for the query
+    #
+    # @return [Hash] The default options
+    def default_options
+      {
+        return_as: "RETURN #{model_name}",
+        mapping:   true
+      }
+    end
+
+    private
+
+    # The name of the model to be used in the query
+    def model_name
+      mapper.model_class.model_name.element
+    end
+
+    # The name of the collection to be used in the query
+    def collection_name
+      collection.collection_name
+    end
+
+    # Executes an AQL query with bind parameters
+    #
+    # @see Query#perfom_query
+    def perfom_query(iterator_with_mapping, &block)
+      iterator = perform_mapping? ? iterator_with_mapping : iterator_without_mapping(&block)
+      connection.execute(aql_string, options).each(&iterator)
+    end
+
+    # An iterator to be used if no mapping should be performed
+    def iterator_without_mapping(&block)
+      ->(document) { block.call document }
+    end
+  end
+end

data/lib/guacamole/collection.rb

@@ -1,8 +1,10 @@
 # -*- encoding : utf-8 -*-
 
 require 'guacamole/query'
+require 'guacamole/aql_query'
 
 require 'ashikawa-core'
+require 'active_support'
 require 'active_support/concern'
 require 'active_support/core_ext/string/inflections'
 
@@ -207,6 +209,38 @@ module Guacamole
         query
       end
 
+      # Find models with simple AQL queries
+      #
+      # Since Simple Queries are quite limited in their possibilities you will need to
+      # use AQL for more advanced data retrieval. Currently there is only a very basic
+      # and experimental support for AQL. Eventually we will replace it with an advanced
+      # query builder DSL. Due to this, we deactivated this feature per default. You
+      # need to activate it with {Configuration#aql_support}:
+      #
+      #   Guacamole::Configuration.aql_support = :experimental
+      #
+      # If not activated it we will raise an error.
+      #
+      # @param [String] aql_fragment An AQL string that will will be put between the
+      #                 `FOR x IN coll` and the `RETURN x` part.
+      # @param [Hash<Symbol, String>] bind_parameters The parameters to be passed into the query
+      # @param [Hash] options Additional options for the query execution
+      # @option options [String] :return_as ('RETURN #{model_name}') A custom `RETURN` statement
+      # @option options [Boolean] :mapping (true) Should the mapping be performed?
+      # @return [Query]
+      # @raise [AQLNotSupportedError] If `aql_support` was not activated
+      # @note Please use always bind parameters since they provide at least some form
+      #       of protection from AQL injection.
+      # @see https://www.arangodb.org/manuals/2/Aql.html AQL Documentation
+      def by_aql(aql_fragment, bind_parameters = {}, options = {})
+        raise AQLNotSupportedError unless Guacamole.configuration.experimental_features.include?(:aql_support)
+
+        query                 = AqlQuery.new(self, mapper, options)
+        query.aql_fragment    = aql_fragment
+        query.bind_parameters = bind_parameters
+        query
+      end
+
       # Get all Models stored in the collection
       #
       # The result can be limited (and should be for most datasets)

data/lib/guacamole/configuration.rb

@@ -1,9 +1,10 @@
 # -*- encoding : utf-8 -*-
 
+require 'active_support'
+require 'active_support/core_ext'
 require 'logger'
 require 'forwardable'
 require 'ashikawa-core'
-require 'active_support/core_ext'
 require 'yaml'
 
 require 'guacamole/document_model_mapper'
@@ -70,10 +71,18 @@ module Guacamole
     # @!visibility protected
     attr_accessor :database, :default_mapper, :logger
 
+    AVAILABLE_EXPERIMENTAL_FEATURES = [
+      :aql_support
+    ]
+
     class << self
       extend Forwardable
 
-      def_delegators :configuration, :database, :database=, :default_mapper=, :logger=
+      def_delegators :configuration,
+                     :database, :database=,
+                     :default_mapper=,
+                     :logger=,
+                     :experimental_features=, :experimental_features
 
       def default_mapper
         configuration.default_mapper || (self.default_mapper = Guacamole::DocumentModelMapper)
@@ -104,16 +113,12 @@ module Guacamole
       end
 
       def create_database_connection_from(config)
-        database = Ashikawa::Core::Database.new do |arango_config|
+        Ashikawa::Core::Database.new do |arango_config|
           arango_config.url      = db_url_from(config)
           arango_config.username = config['username']
           arango_config.password = config['password']
           arango_config.logger   = logger
         end
-
-        _add_missing_methods_to_database(database)
-
-        database
       end
 
       def db_url_from(config)
@@ -129,49 +134,21 @@ module Guacamole
         default_logger.level = Logger::INFO
         default_logger
       end
+    end
 
-      # FIXME: This is not here to stay! Kill it with fire!
-      #
-      # As soon Ashikawa::Core provides those features
-      # (https://github.com/triAGENS/ashikawa-core/issues/83) immediately
-      # remove this hack. But while this is ugly as hell it ensures we don't
-      # need to change any other related code. Just remove this and we're good.
-      def _add_missing_methods_to_database(database)
-        database.singleton_class.instance_eval do
-          # The raw Faraday connection
-          define_method(:raw_connection) do
-            @connection.connection
-          end
-
-          # The base URI to the ArangoDB server
-          define_method(:arangodb_uri) do |additional_path = ''|
-            uri = raw_connection.url_prefix
-            base_uri = [uri.scheme, '://', uri.host, ':', uri.port].join
-            URI.join(base_uri, additional_path)
-          end
-
-          # Database name query method
-          define_method(:name) do
-            database_regexp = %r{_db/(?<db_name>\w+)/_api}
-            raw_connection.url_prefix.to_s.match(database_regexp)['db_name']
-          end
-
-          # Creates the database
-          define_method(:create) do
-            raw_connection.post(arangodb_uri('/_api/database'), name: name)
-          end
-
-          # Drops the database
-          define_method(:drop) do
-            raw_connection.delete(arangodb_uri("/_api/database/#{name}"))
-          end
-
-          # Truncate the database
-          define_method(:truncate) do
-            collections.each { |collection| collection.truncate! }
-          end
-        end
-      end
+    # A list of active experimental features. Refer to `AVAILABLE_EXPERIMENTAL_FEATURES` to see
+    # what can be activated.
+    #
+    # @return [Array<Symbol>] The activated experimental features. Defaults to `[]`
+    def experimental_features
+      @experimental_features || []
+    end
+
+    # Experimental features to activate
+    #
+    # @param [Array<Symbol>] features A list of experimental features to activate
+    def experimental_features=(features)
+      @experimental_features = features
     end
   end
 end

data/lib/guacamole/exceptions.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+
+module Guacamole
+  class GenericError < StandardError; end
+  class AQLNotSupportedError < GenericError
+    def initialize(msg = 'AQL is an experimental feature. Please activate it in the config: https://github.com/triAGENS/guacamole#experimental-aql-support')
+      super
+    end
+  end
+end

data/lib/guacamole/model.rb

@@ -1,7 +1,8 @@
 # -*- encoding : utf-8 -*-
+
+require 'active_support'
 require 'active_support/concern'
-# Cherry Pick not possible
-require 'active_model'
+require 'active_model' # Cherry Pick not possible
 require 'virtus'
 
 module Guacamole

data/lib/guacamole/query.rb

@@ -4,7 +4,6 @@ module Guacamole
   # Build a query for ArangoDB
   class Query
     include Enumerable
-
     # Connection to the database
     #
     # @return [Ashikawa::Core::Collection]
@@ -39,16 +38,10 @@ module Guacamole
     # Iterate over the result of the query
     #
     # This will execute the query you have build
-    def each
+    def each(&block)
       return to_enum(__callee__) unless block_given?
 
-      iterator = ->(document) { yield mapper.document_to_model(document) }
-
-      if example
-        connection.by_example(example, options).each(&iterator)
-      else
-        connection.all(options).each(&iterator)
-      end
+      perfom_query ->(document) { block.call mapper.document_to_model(document) }, &block
     end
 
     # Limit the results of the query
@@ -79,5 +72,22 @@ module Guacamole
         example == other.example
     end
     alias_method :eql?, :==
+
+    private
+
+    # Performs the query against the database connection.
+    #
+    # This can be changed by subclasses to implement other types
+    # of queries, such as AQL queries.
+    #
+    # @param [Lambda] iterator To be called on each document returned from
+    #                 the database
+    def perfom_query(iterator, &block)
+      if example
+        connection.by_example(example, options).each(&iterator)
+      else
+        connection.all(options).each(&iterator)
+      end
+    end
   end
 end

data/lib/guacamole/railtie.rb

@@ -15,6 +15,11 @@ module Guacamole
 
     config.guacamole = ::Guacamole::Configuration
 
+    # Add app/collections to autoload_paths
+    initializer 'guacamole.setup_autoload_paths', before: :set_autoload_paths do |app|
+      app.config.autoload_paths += %W(#{app.config.root}/app/collections)
+    end
+
     # We're not doing migrations (yet)
     config.send(:app_generators).orm :guacamole, migration: false
 

data/lib/guacamole/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Guacamole
   # Current version of the gem
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/acceptance/aql_spec.rb

@@ -0,0 +1,70 @@
+# -*- encoding : utf-8 -*-
+
+require 'guacamole'
+require 'acceptance/spec_helper'
+
+class Pony
+  include Guacamole::Model
+
+  attribute :name, String
+  attribute :color, String
+  attribute :type, Array[String]
+end
+
+class PoniesCollection
+  include Guacamole::Collection
+end
+
+describe 'BasicAQLSupport' do
+  subject { PoniesCollection }
+
+  let(:pegasus_pony) { Fabricate(:pony, type: ['Pegasus']) }
+  let(:earth_pony) { Fabricate(:pony, type: ['Earthpony'], name: 'Candy Mane') }
+  let(:unicorn_pegasus_pony) { Fabricate(:pony, type: ['Pegasus', 'Unicorn']) }
+
+  context 'with experimental AQL support enabled' do
+    before do
+      Guacamole.configuration.experimental_features = [:aql_support]
+
+      [pegasus_pony, earth_pony, unicorn_pegasus_pony]
+    end
+
+    it 'should retrieve models by simple AQL queries' do
+      pony_by_name = PoniesCollection.by_aql('FILTER pony.name == @name', name: 'Candy Mane').first
+      expect(pony_by_name).to eq earth_pony
+    end
+
+    it 'should retrieve models by more complex AQL queries' do
+      ponies_by_type = PoniesCollection.by_aql('FILTER POSITION(pony.type, @pony_type, false) == true',
+                                               pony_type: 'Pegasus')
+      expect(ponies_by_type).to include unicorn_pegasus_pony
+      expect(ponies_by_type).to include pegasus_pony
+    end
+
+    it 'should allow a custom RETURN statement' do
+      custom_color = 'fancy white pink with sparkles'
+      pony_by_name = PoniesCollection.by_aql('FILTER pony.name == @name',
+                                             { name: 'Candy Mane' },
+                                             return_as: %Q{RETURN MERGE(pony, {"color": "#{custom_color}"})}).first
+      expect(pony_by_name.color).to eq custom_color
+    end
+
+    it 'should allow to disable the mapping' do
+      pony_hash = PoniesCollection.by_aql('FILTER pony.name == @name',
+                                          { name: 'Candy Mane' },
+                                          mapping: false ).first
+      expect(pony_hash).to be_an(Ashikawa::Core::Document)
+    end
+  end
+
+  context 'without experimental AQL support enabled' do
+    before do
+      Guacamole.configuration.experimental_features = []
+    end
+
+    it 'should raise an error accessing the AQL feature' do
+      expect { PoniesCollection.by_aql("random AQL fragment") }.to raise_error(Guacamole::AQLNotSupportedError)
+    end
+  end
+
+end

data/spec/acceptance/spec_helper.rb

@@ -3,6 +3,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'active_support'
 require 'fabrication'
 require 'faker'
 require 'logging'
@@ -59,6 +60,6 @@ RSpec.configure do |config|
   end
 
   config.before(:each) do
-    Guacamole.configuration.database.collections.each { |collection| collection.truncate! }
+    Guacamole.configuration.database.truncate
   end
 end

data/spec/fabricators/book.rb

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 class Book
-  include Guacamole::Model
+  extend ActiveSupport::Autoload
   include Guacamole::Model
 
   autoload :Author, 'fabricators/author'

data/spec/fabricators/pony.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+Fabricator(:pony) do
+  name  { Faker::Name.name }
+  color { %w(purple pink blue yellow green white).sample }
+  type  { %w(Pegasus Earthpony Unicorn).sample }
+end

data/spec/setup/arangodb.sh

@@ -3,15 +3,15 @@
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 cd $DIR
 
-# VERSION=1.4.devel
 NAME=ArangoDB-$VERSION
 
 if [ ! -d "$DIR/$NAME" ]; then
   # download ArangoDB
-  echo "wget http://www.arangodb.org/travisCI/$NAME.tar.gz"
-  wget http://www.arangodb.org/travisCI/$NAME.tar.gz
+  echo "wget http://www.arangodb.org/repositories/travisCI/$NAME.tar.gz"
+  wget http://www.arangodb.org/repositories/travisCI/$NAME.tar.gz
   echo "tar zxf $NAME.tar.gz"
   tar zvxf $NAME.tar.gz
+  mv `find . -type d -name "ArangoDB-*"` $NAME
 fi
 
 ARCH=$(arch)
@@ -19,30 +19,24 @@ PID=$(echo $PPID)
 TMP_DIR="/tmp/arangodb.$PID"
 PID_FILE="/tmp/arangodb.$PID.pid"
 ARANGODB_DIR="$DIR/$NAME"
-
-ARANGOD="${ARANGODB_DIR}/bin/arangod"
-if [ "$ARCH" == "x86_64" ]; then
-  ARANGOD="${ARANGOD}_x86_64"
-fi
+ARANGOD="${ARANGODB_DIR}/bin/arangod_x86_64"
 
 # create database directory
 mkdir ${TMP_DIR}
 
-echo "Starting arangodb '${ARANGOD}'"
+echo "Starting ArangoDB '${ARANGOD}'"
 
 ${ARANGOD} \
-  --database.directory ${TMP_DIR}  \
-  --configuration none  \
+  --database.directory ${TMP_DIR} \
+  --configuration none \
   --server.endpoint tcp://127.0.0.1:8529 \
+  --javascript.app-path ${ARANGODB_DIR}/js/apps \
   --javascript.startup-directory ${ARANGODB_DIR}/js \
-  --server.admin-directory ${ARANGODB_DIR}/html/admin \
   --javascript.modules-path ${ARANGODB_DIR}/js/server/modules:${ARANGODB_DIR}/js/common/modules:${ARANGODB_DIR}/js/node \
   --javascript.package-path ${ARANGODB_DIR}/js/npm:${ARANGODB_DIR}/js/common/test-data/modules \
-  --javascript.action-directory ${ARANGODB_DIR}/js/actions  \
-  --javascript.app-path ${ARANGODB_DIR}/js/apps  \
-  --database.maximal-journal-size 1048576  \
-  --server.disable-admin-interface ${ARANGODB_DISABLE_AUTHENTIFICATION} \
-  --server.disable-authentication true \
+  --javascript.action-directory ${ARANGODB_DIR}/js/actions \
+  --database.maximal-journal-size 1048576 \
+  --server.disable-authentication ${ARANGODB_DISABLE_AUTHENTIFICATION} \
   --javascript.gc-interval 1 &
 
 sleep 2
@@ -57,7 +51,7 @@ if [ "x$process" == "x" ]; then
 fi
 
 echo "Waiting until ArangoDB is ready on port 8529"
-while [[ -z `curl -s 'http://127.0.0.1:8529/_api/version' ` ]] ; do
+while [[ -z `curl --basic --user 'root:' -s 'http://127.0.0.1:8529/_api/version' ` ]] ; do
   echo -n "."
   sleep 2s
 done

data/spec/unit/configuration_spec.rb

@@ -126,4 +126,21 @@ describe Guacamole::Configuration do
       subject.load 'config_file.yml'
     end
   end
+
+  describe 'experimental_features' do
+    let(:fresh_config) { Guacamole::Configuration.new }
+
+    after do
+      subject.experimental_features = []
+    end
+
+    it 'should default to none' do
+      expect(fresh_config.experimental_features).to be_empty
+    end
+
+    it 'should accept a list of features to activate' do
+      subject.experimental_features = [:aql_support]
+      expect(subject.experimental_features).to include :aql_support
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guacamole
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Dohmen
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ashikawa-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: hamster
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1.pre.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1.pre.rc.1
 - !ruby/object:Gem::Dependency
   name: fabrication
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12
 description: ODM for ArangoDB
@@ -145,12 +145,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .hound.yml
-- .rspec
-- .ruby-version
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.devtools
@@ -166,9 +167,11 @@ files:
 - config/yardstick.yml
 - guacamole.gemspec
 - lib/guacamole.rb
+- lib/guacamole/aql_query.rb
 - lib/guacamole/collection.rb
 - lib/guacamole/configuration.rb
 - lib/guacamole/document_model_mapper.rb
+- lib/guacamole/exceptions.rb
 - lib/guacamole/identity_map.rb
 - lib/guacamole/model.rb
 - lib/guacamole/proxies/proxy.rb
@@ -191,6 +194,7 @@ files:
 - lib/rails/generators/rspec/collection/templates/collection_spec.rb.tt
 - log/.gitkeep
 - spec/acceptance/.gitkeep
+- spec/acceptance/aql_spec.rb
 - spec/acceptance/association_spec.rb
 - spec/acceptance/basic_spec.rb
 - spec/acceptance/config/guacamole.yml
@@ -201,6 +205,7 @@ files:
 - spec/fabricators/book.rb
 - spec/fabricators/book_fabricator.rb
 - spec/fabricators/comment_fabricator.rb
+- spec/fabricators/pony.rb
 - spec/setup/arangodb.sh
 - spec/spec_helper.rb
 - spec/unit/.gitkeep
@@ -212,7 +217,7 @@ files:
 - spec/unit/model_spec.rb
 - spec/unit/query_spec.rb
 - tasks/adjustments.rake
-homepage: https://github.com/triAGENS/guacamole
+homepage: http://guacamolegem.org
 licenses:
 - Apache License 2.0
 metadata: {}
@@ -222,22 +227,23 @@ 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.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An ODM for ArangoDB that uses the DataMapper pattern.
 test_files:
 - spec/acceptance/.gitkeep
+- spec/acceptance/aql_spec.rb
 - spec/acceptance/association_spec.rb
 - spec/acceptance/basic_spec.rb
 - spec/acceptance/config/guacamole.yml
@@ -248,6 +254,7 @@ test_files:
 - spec/fabricators/book.rb
 - spec/fabricators/book_fabricator.rb
 - spec/fabricators/comment_fabricator.rb
+- spec/fabricators/pony.rb
 - spec/setup/arangodb.sh
 - spec/spec_helper.rb
 - spec/unit/.gitkeep