guacamole 0.0.1 → 0.1.0

data/Rakefile

@@ -5,3 +5,13 @@ require 'devtools'
 Devtools.init_rake_tasks
 
 import('./tasks/adjustments.rake')
+
+desc 'Start a REPL with guacamole loaded (not the Rails part)'
+task :console do
+  require 'bundler/setup'
+
+  require 'pry'
+  require 'guacamole'
+  ARGV.clear
+  Pry.start
+end

data/config/reek.yml

@@ -4,7 +4,8 @@ Attribute:
   exclude: []
 BooleanParameter:
   enabled: true
-  exclude: []
+  exclude:
+  - respond_to_missing?
 ClassVariable:
   enabled: true
   exclude: []
@@ -18,7 +19,10 @@ DataClump:
   min_clump_size: 2
 DuplicateMethodCall:
   enabled: true
-  exclude: []
+  exclude:
+  - Guacamole::DocumentModelMapper#document_to_model
+  - Guacamole::DocumentModelMapper#model_to_document
+  - Guacamole::Configuration#_add_missing_methods_to_database
   max_calls: 1
   allow_calls: []
 FeatureEnvy:
@@ -26,7 +30,8 @@ FeatureEnvy:
   exclude: []
 IrresponsibleModule:
   enabled: true
-  exclude: []
+  exclude:
+  - - !ruby/regexp /Generators/
 LongParameterList:
   enabled: true
   exclude: []
@@ -40,7 +45,8 @@ LongYieldList:
   max_params: 2
 NestedIterators:
   enabled: true
-  exclude: []
+  exclude:
+  - Guacamole::Configuration#_add_missing_methods_to_database
   max_allowed_nesting: 2
   ignore_iterators: []
 NilCheck:
@@ -52,7 +58,8 @@ RepeatedConditional:
   max_ifs: 2
 TooManyInstanceVariables:
   enabled: true
-  exclude: []
+  exclude:
+  - Guacamole::DocumentModelMapper
   max_instance_variables: 3
 TooManyMethods:
   enabled: true
@@ -62,6 +69,12 @@ TooManyStatements:
   enabled: true
   exclude:
   - each
+  - Guacamole::DocumentModelMapper#document_to_model
+  - 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

@@ -18,11 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'ashikawa-core', '~> 0.9.0'
-  spec.add_dependency 'virtus', '~> 1.0.0.rc2'
+  spec.add_dependency 'ashikawa-core', '~> 0.10.0'
+  spec.add_dependency 'virtus', '~> 1.0.1'
   spec.add_dependency 'activesupport', '>= 4.0.0'
   spec.add_dependency 'activemodel', '>= 4.0.0'
+  spec.add_dependency 'hamster', '~> 1.0.1.pre.rc.1'
 
   spec.add_development_dependency 'fabrication', '~> 2.8.1'
+  spec.add_development_dependency 'faker', '~> 1.2.0'
   spec.add_development_dependency 'logging', '~> 1.8.1'
+  spec.add_development_dependency 'pry', '~> 0.9.12'
 end

data/lib/guacamole.rb

@@ -7,6 +7,7 @@ require 'guacamole/configuration'
 require 'guacamole/model'
 require 'guacamole/collection'
 require 'guacamole/document_model_mapper'
+require 'guacamole/identity_map'
 
 if defined?(Rails)
   require 'guacamole/railtie'

data/lib/guacamole/collection.rb

@@ -16,7 +16,6 @@ module Guacamole
   # the collection. See the `ClassMethods` submodule for details
   module Collection
     extend ActiveSupport::Concern
-
     # The class methods added to the class via the mixin
     #
     # @!method model_to_document(model)
@@ -51,6 +50,9 @@ module Guacamole
       # You can use this method for low level communication with the collection.
       # Details can be found in the Ashikawa::Core documentation.
       #
+      # @note We're well aware that we return a Ashikawa::Core::Collection here
+      #       but naming it a connection. We think the name `connection` still
+      #       fits better in this context.
       # @see http://rubydoc.info/gems/ashikawa-core/Ashikawa/Core/Collection
       # @return [Ashikawa::Core::Collection]
       def connection
@@ -96,6 +98,31 @@ module Guacamole
         mapper.document_to_model connection.fetch(key)
       end
 
+      # Persist a model in the collection or replace it in the database, depending if it is already persisted
+      #
+      # * If {Model#persisted? model#persisted?} is `false`, the model will be saved in the collection.
+      #   Timestamps, revision and key will be set on the model.
+      # * If {Model#persisted? model#persisted?} is `true`, it replaces the currently saved version of the model with
+      #   its new version. It searches for the entry in the database
+      #   by key. This will change the updated_at timestamp and revision
+      #   of the provided model.
+      #
+      # See also {#create create} and {#replace replace} for explicit usage.
+      #
+      # @param [Model] model The model to be saved
+      # @return [Model] The provided model
+      # @example Save a podcast to the database
+      #   podcast = Podcast.new(title: 'Best Show', guest: 'Dirk Breuer')
+      #   PodcastsCollection.save(podcast)
+      #   podcast.key #=> '27214247'
+      # @example Get a podcast, update its title, replace it
+      #   podcast = PodcastsCollection.by_key('27214247')
+      #   podcast.title = 'Even better'
+      #   PodcastsCollection.save(podcast)
+      def save(model)
+        model.persisted? ? replace(model) : create(model)
+      end
+
       # Persist a model in the collection
       #
       # The model will be saved in the collection. Timestamps, revision
@@ -107,7 +134,7 @@ module Guacamole
       #   podcast = Podcast.new(title: 'Best Show', guest: 'Dirk Breuer')
       #   PodcastsCollection.save(podcast)
       #   podcast.key #=> '27214247'
-      def save(model)
+      def create(model)
         return false unless model.valid?
 
         add_timestamps_to_model(model)
@@ -125,10 +152,10 @@ module Guacamole
       #   PodcastsCollection.delete(podcast)
       def delete(model_or_key)
         key = if model_or_key.respond_to? :key
-          model_or_key.key
-        else
-          model_or_key
-        end
+                model_or_key.key
+              else
+                model_or_key
+              end
         fetch_document(key).delete
         key
       end
@@ -220,18 +247,64 @@ module Guacamole
       # Create a document from a model
       #
       # @api private
+      # @todo Currently we only save the associated models if those never have been
+      #       persisted. In future versions we should add something like `:autosave`
+      #       to always save associated models.
       def create_document_from(model)
+        create_referenced_models_of model
+
         document = connection.create_document(model_to_document(model))
 
         model.key = document.key
         model.rev = document.revision
 
+        create_referenced_by_models_of model
+
         document
       end
 
+      # Creates all not yet persisted referenced models of `model`
+      #
+      # Referenced models needs to be created before the parent model, because it needs their `key`
+      #
+      # @api private
+      # @todo This method should be considered 'work in progress'. We already know we need to change this.
+      # @return [void]
+      def create_referenced_models_of(model)
+        mapper.referenced_models.each do |ref_model_name|
+          ref_collection = mapper.collection_for(ref_model_name)
+
+          ref_model = model.send(ref_model_name)
+          next unless ref_model
+
+          ref_collection.save ref_model unless ref_model.persisted?
+        end
+      end
+
+      # Creates all not yet persisted models which are referenced by `model`
+      #
+      # Referenced by models needs to created after the parent model, because they need its `key`
+      #
+      # @api private
+      # @todo This method should be considered 'work in progress'. We already know we need to change this.
+      # @return [void]
+      def create_referenced_by_models_of(model)
+        mapper.referenced_by_models.each do |ref_model_name|
+          ref_collection = mapper.collection_for(ref_model_name)
+
+          ref_models = model.send(ref_model_name)
+
+          ref_models.each do |ref_model|
+            ref_model.send("#{model.class.name.demodulize.underscore}=", model)
+            ref_collection.save ref_model unless ref_model.persisted?
+          end
+        end
+      end
+
       # Replace a document in the database with this model
       #
       # @api private
+      # @note This will **not** update associated models (see {#create})
       def replace_document_from(model)
         document = model_to_document(model)
         response = connection.replace(model.key, document)
@@ -240,7 +313,6 @@ module Guacamole
 
         document
       end
-
     end
   end
 end

data/lib/guacamole/configuration.rb

@@ -4,11 +4,11 @@ require 'logger'
 require 'forwardable'
 require 'ashikawa-core'
 require 'active_support/core_ext'
+require 'yaml'
 
 require 'guacamole/document_model_mapper'
 
 module Guacamole
-
   class << self
     # Configure Guacamole
     #
@@ -26,6 +26,13 @@ module Guacamole
     def configuration
       @configuration ||= Configuration
     end
+
+    # Just an alias to Configuration#logger
+    #
+    # @return [Configuration#logger]
+    def logger
+      configuration.logger
+    end
   end
 
   # Current configuration
@@ -97,12 +104,16 @@ module Guacamole
       end
 
       def create_database_connection_from(config)
-        Ashikawa::Core::Database.new do |arango_config|
+        database = 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)
@@ -118,6 +129,49 @@ module Guacamole
         default_logger.level = Logger::INFO
         default_logger
       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
     end
   end
 end

data/lib/guacamole/document_model_mapper.rb

@@ -1,11 +1,16 @@
 # -*- encoding : utf-8 -*-
 
+require 'guacamole/proxies/referenced_by'
+require 'guacamole/proxies/references'
+
 module Guacamole
   # This is the default mapper class to map between Ashikawa::Core::Document and
   # Guacamole::Model instances.
   #
   # If you want to build your own mapper, you have to build at least the
   # `document_to_model` and `model_to_document` methods.
+  #
+  # @note If you plan to bring your own `DocumentModelMapper` please consider using an {Guacamole::IdentityMap}.
   class DocumentModelMapper
     # The class to map to
     #
@@ -16,6 +21,8 @@ module Guacamole
     #
     # @return [Array] An array of embedded models
     attr_reader :models_to_embed
+    attr_reader :referenced_by_models
+    attr_reader :referenced_models
 
     # Create a new instance of the mapper
     #
@@ -23,9 +30,42 @@ module Guacamole
     # The Document class is always Ashikawa::Core::Document
     #
     # @param [Class] model_class
-    def initialize(model_class)
-      @model_class = model_class
-      @models_to_embed = []
+    def initialize(model_class, identity_map = IdentityMap)
+      @model_class          = model_class
+      @identity_map         = identity_map
+      @models_to_embed      = []
+      @referenced_by_models = []
+      @referenced_models    = []
+    end
+
+    class << self
+      # construct the {collection} class for a given model name.
+      #
+      # @example
+      #   collection_class = collection_for(:user)
+      #   collection_class == userscollection # would be true
+      #
+      # @note This is an class level alias for {DocumentModelMapper#collection_for}
+      # @param [symbol, string] model_name the name of the model
+      # @return [class] the {collection} class for the given model name
+      def collection_for(model_name)
+        "#{model_name.to_s.classify.pluralize}Collection".constantize
+      end
+    end
+
+    # construct the {collection} class for a given model name.
+    #
+    # @example
+    #   collection_class = collection_for(:user)
+    #   collection_class == userscollection # would be true
+    #
+    # @todo As of now this is some kind of placeholder method. As soon as we implement
+    #       the configuration of the mapping (#12) this will change. Still the {DocumentModelMapper}
+    #       seems to be a good place for this functionality.
+    # @param [symbol, string] model_name the name of the model
+    # @return [class] the {collection} class for the given model name
+    def collection_for(model_name)
+      self.class.collection_for model_name
     end
 
     # Map a document to a model
@@ -34,14 +74,26 @@ module Guacamole
     #
     # @param [Ashikawa::Core::Document] document
     # @return [Model] the resulting model with the given Model class
+    # rubocop:disable MethodLength
     def document_to_model(document)
-      model = model_class.new(document.hash)
+      identity_map.retrieve_or_store model_class, document.key do
+        model = model_class.new(document.to_h)
+
+        referenced_by_models.each do |ref_model_name|
+          model.send("#{ref_model_name}=", Proxies::ReferencedBy.new(ref_model_name, model))
+        end
+
+        referenced_models.each do |ref_model_name|
+          model.send("#{ref_model_name}=", Proxies::References.new(ref_model_name, document))
+        end
 
-      model.key = document.key
-      model.rev = document.revision
+        model.key = document.key
+        model.rev = document.revision
 
-      model
+        model
+      end
     end
+    # rubocop:enable MethodLength
 
     # Map a model to a document
     #
@@ -49,6 +101,7 @@ module Guacamole
     #
     # @param [Model] model
     # @return [Ashikawa::Core::Document] the resulting document
+    # rubocop:disable MethodLength
     def model_to_document(model)
       document = model.attributes.dup.except(:key, :rev)
       models_to_embed.each do |attribute_name|
@@ -56,8 +109,21 @@ module Guacamole
           embedded_model.attributes.except(:key, :rev)
         end
       end
+
+      referenced_models.each do |ref_model_name|
+        ref_key = [ref_model_name.to_s, 'id'].join('_').to_sym
+        ref_model = model.send ref_model_name
+        document[ref_key] = ref_model.key if ref_model
+        document.delete(ref_model_name)
+      end
+
+      referenced_by_models.each do |ref_model_name|
+        document.delete(ref_model_name)
+      end
+
       document
     end
+    # rubocop:enable MethodLength
 
     # Declare a model to be embedded
     #
@@ -91,5 +157,19 @@ module Guacamole
     def embeds(model_name)
       @models_to_embed << model_name
     end
+
+    def referenced_by(model_name)
+      @referenced_by_models << model_name
+    end
+
+    def references(model_name)
+      @referenced_models << model_name
+    end
+
+    private
+
+    def identity_map
+      @identity_map
+    end
   end
 end