lotus-rethinkdb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 737a2817a5f539d7027d688b4bc510037206d0c5
+  data.tar.gz: a118133ad334d38dd49b3cb505aa596e92af4ded
+SHA512:
+  metadata.gz: eaebeddd187f711f8ac12cdfd88637543978e0297590bc2e90b343f8bddb3acdd2f5ced130911ba16b6e7ae45af5caf79bf9f986e6a9cdd43ceb3b4224d08b95
+  data.tar.gz: 5c235fe25c5c2a977f200e2877e3607caa2ad8585be679f669a5f187bd97404aa6fa35d0445dce415e42796b74e8a73a3b3d2e159e00c7e2e8691143c16209c6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0
+
+services: rethinkdb
+
+before_script:
+  - sudo add-apt-repository ppa:rethinkdb/ppa && sudo apt-get update && sudo apt-get install rethinkdb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Angelo Ashmore
+
+MIT License
+
+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,31 @@
+# Lotus::Model RethinkDB Adapter
+
+This adapter implements persistence layer for RethinkDB. Under development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lotus-rethinkdb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lotus-rethinkdb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/angeloashmore/lotus-rethinkdb/fork )
+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

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task default: :test

data/lib/lotus/model/adapters/rethinkdb/collection.rb

@@ -0,0 +1,205 @@
+require 'delegate'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'rethinkdb'
+
+module Lotus
+  module Model
+    module Adapters
+      module Rethinkdb
+        # Maps a RethinkDB database table and perfoms manipulations on it.
+        #
+        # @api private
+        # @since 0.1.0
+        class Collection < SimpleDelegator
+          include RethinkDB::Shortcuts
+
+          # Initialize a collection
+          #
+          # @param connection [RethinkDB::Connection] the connection to the
+          #   database
+          # @param dataset [RethinkDB::RQL] the dataset that maps a table or a
+          #   subset of it
+          # @param mapped_collection [Lotus::Model::Mapping::Collection] a
+          #   mapped collection
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection]
+          #
+          # @api private
+          # @since 0.1.0
+          def initialize(connection, dataset, mapped_collection)
+            super(dataset)
+            @connection, @mapped_collection = connection, mapped_collection
+          end
+
+          # Creates a document for the given entity and assigns an id.
+          #
+          # @param entity [Object] the entity to persist
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Command#create
+          #
+          # @return the primary key of the created document
+          #
+          # @api private
+          # @since 0.1.0
+          def insert(entity)
+            response = _run do
+              super(_serialize(entity))
+            end
+
+            response['generated_keys'].first
+          end
+
+          # Updates the document corresponding to the given entity.
+          #
+          # @param entity [Object] the entity to persist
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Command#update
+          #
+          # @api private
+          # @since 0.1.0
+          def update(entity)
+            _run do
+              super(_serialize(entity))
+            end
+          end
+
+          # Deletes the current scope.
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Command#delete
+          #
+          # @api private
+          # @since 0.1.0
+          def delete
+            _run do
+              super
+            end
+          end
+
+          # Filters the current scope with a `filter` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Query#where
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def filter(*args)
+            _collection(super, @mapped_collection)
+          end
+
+          # Filters the current scope with a `pluck` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Query#pluck
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def pluck(*args)
+            _collection(super, @mapped_collection)
+          end
+
+          # Filters the current scope with a `limit` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Query#limit
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def limit(*args)
+            _collection(super, @mapped_collection)
+          end
+
+          # Filters the current scope with an `order_by` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Query#order
+          # @see Lotus::Model::Adapters::Rethinkdb::Query#desc
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def order_by(*args)
+            _collection(super, @mapped_collection)
+          end
+
+          # Resolves self by fetching the documents from the database and
+          # translating them into entities.
+          #
+          # @return [Array] the result of the query
+          #
+          # @api private
+          # @since 0.1.0
+          def to_a
+            _deserialize(
+              _run do
+                self
+              end
+            )
+          end
+
+          alias_method :execute, :to_a
+
+          private
+
+          # Serialize the given entity before to persist in the database.
+          #
+          # @return [Hash] the serialized entity
+          #
+          # @api private
+          # @since 0.1.0
+          def _serialize(entity)
+            @mapped_collection.serialize(entity)
+          end
+
+          # Deserialize a set of documents fetched from the database.
+          #
+          # @note ActiveSupport's HashWithIndifferentAccess is used to solve an
+          #   incompatibility between Lotus::Model's use of symbols and
+          #   RethinkDB's use of strings.
+          #
+          # @param documents [Array] a set of raw documents
+          #
+          # @api private
+          # @since 0.1.0
+          def _deserialize(documents)
+            @mapped_collection.deserialize(
+              documents.map(&:with_indifferent_access)
+            )
+          end
+
+          # Returns a collection with the connection automatically included.
+          #
+          # @return [Lotus::Model::Adapters::Rethinkdb::Collection]
+          #
+          # @api private
+          # @since 0.1.0
+          def _collection(*args)
+            Collection.new(@connection, *args)
+          end
+
+          # Run the enclosed block on the database.
+          #
+          # @api private
+          # @since 0.1.0
+          def _run
+            yield.run(@connection)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/model/adapters/rethinkdb/command.rb

@@ -0,0 +1,66 @@
+module Lotus
+  module Model
+    module Adapters
+      module Rethinkdb
+        # Execute a command for the given query.
+        #
+        # @see Lotus::Model::Adapters::Rethinkdb::Query
+        #
+        # @api private
+        # @since 0.1.0
+        class Command
+          # Initialize a command
+          #
+          # @param query [Lotus::Model::Adapters::Rethinkdb::Query]
+          #
+          # @api private
+          # @since 0.1.0
+          def initialize(query)
+            @collection = query.scoped
+          end
+
+          # Creates a document for the given entity.
+          #
+          # @param entity [Object] the entity to persist
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Collection#insert
+          #
+          # @return the primary key of the just created document.
+          #
+          # @api private
+          # @since 0.1.0
+          def create(entity)
+            @collection.insert(entity)
+          end
+
+          # Updates the corresponding document for the given entity.
+          #
+          # @param entity [Object] the entity to persist
+          #
+          # @see Lotus::Model::Adapters::Rethinkdb::Collection#update
+          #
+          # @api private
+          # @since 0.1.0
+          def update(entity)
+            @collection.update(entity)
+          end
+
+          # Deletes all the documents for the current query.
+          #
+          # It's used to delete a single document or an entire database table.
+          #
+          # @see Lotus::Model::Adapters::RethinkdbAdapter#delete
+          # @see Lotus::Model::Adapters::RethinkdbAdapter#clear
+          #
+          # @api private
+          # @since 0.1.0
+          def delete
+            @collection.delete
+          end
+
+          alias_method :clear, :delete
+        end
+      end
+    end
+  end
+end