hanami-rethinkdb 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee0f2f4d4986d0e90672589655dbfd4386f60e40
+  data.tar.gz: b092fce947f9e2aeca833f7c32c5e8529b1370cf
+SHA512:
+  metadata.gz: c9580b10916a33f686c336999f85241861562c3aa50003940d928b84f83e335600c7b84b4d4a0815b3de37e842172fde70caff0d67b16651e7f1ab696d5c9478
+  data.tar.gz: 5b2e0669f484ec3c24216e325589f9f293e500978c8444c3137cb82317404df1689aab95b1920121a92b57f719aea8d8379e80d978bf7384a73ebc8d8419be94

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,20 @@
+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
+
+before_install:
+  - source /etc/lsb-release && echo "deb http://download.rethinkdb.com/apt $DISTRIB_CODENAME main" | sudo tee /etc/apt/sources.list.d/rethinkdb.list
+  - wget -qO- http://download.rethinkdb.com/apt/pubkey.gpg | sudo apt-key add -
+  - sudo apt-get update -q
+  - sudo apt-get install rethinkdb
+  - sudo cp /etc/rethinkdb/default.conf.sample /etc/rethinkdb/instances.d/instance1.conf
+  - sudo service rethinkdb restart
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'coveralls', require: false

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,73 @@
+# Hanami::Model RethinkDB Adapter
+
+This adapter implements a [Hanami::Model](https://github.com/hanami/model) persistence layer for [RethinkDB](http://rethinkdb.com).
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/hanami-rethinkdb.svg)](http://badge.fury.io/rb/hanami-rethinkdb)
+[![Build Status](https://secure.travis-ci.org/angeloashmore/hanami-rethinkdb.svg?branch=master)](http://travis-ci.org/angeloashmore/hanami-rethinkdb?branch=master)
+[![Coverage Status](https://img.shields.io/coveralls/angeloashmore/hanami-rethinkdb.svg)](https://coveralls.io/r/angeloashmore/hanami-rethinkdb)
+[![Code Climate](https://codeclimate.com/github/angeloashmore/hanami-rethinkdb/badges/gpa.svg)](https://codeclimate.com/github/angeloashmore/hanami-rethinkdb)
+[![Inline docs](http://inch-ci.org/github/angeloashmore/hanami-rethinkdb.svg?branch=master&style=flat)](http://inch-ci.org/github/angeloashmore/hanami-rethinkdb)
+
+## Links
+
+* API Doc: [http://rdoc.info/gems/hanami-rethinkdb](http://rdoc.info/gems/hanami-rethinkdb)
+* Bugs/Issues: [https://github.com/angeloashmore/hanami-rethinkdb/issues](https://github.com/angeloashmore/hanami-rethinkdb/issues)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hanami-rethinkdb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hanami-rethinkdb
+
+## Usage
+
+Please refer to the [Hanami::Model](https://github.com/hanami/model#usage) docs for any details related to Entity, Repository, Data Mapper and Adapter.
+
+### Repository methods
+
+See the [complete list](https://github.com/hanami/model#repositories) of Repository methods provided by ```Hanami::Model```.
+
+Following methods are not supported since it's incompatible with RethinkDB:
+
+* first
+* last
+
+### Query methods
+
+Generic query methods supported by the RethinkDB adapter:
+
+* [all](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#all-instance_method)
+* [where](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#where-instance_method)
+* [limit](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#limit-instance_method)
+* [order](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#order-instance_method) (alias: ```asc```)
+* [desc](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#desc-instance_method)
+* [sum](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#dum-instance_method)
+* [average](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#average-instance_method) (alias: ```avg```)
+* [max](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#max-instance_method)
+* [min](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#min-instance_method)
+* [count](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#count-instance_method)
+
+RethinkDB-specific methods:
+
+* [pluck](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#pluck-instance_method)
+* [has_fields](http://rubydoc.info/gems/hanami-rethinkdb/Hanami/Model/Adapters/Rethinkdb/Query#has_fields-instance_method)
+
+## Contributing
+
+1. Fork it ( https://github.com/angeloashmore/hanami-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/hanami-rethinkdb.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hanami/rethinkdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hanami-rethinkdb'
+  spec.version       = Hanami::Rethinkdb::VERSION
+  spec.authors       = ['Angelo Ashmore']
+  spec.email         = ['angeloashmore@gmail.com']
+  spec.summary       = 'RethinkDB adapter for Hanami::Model'
+  spec.description   = 'RethinkDB adapter for Hanami::Model'
+  spec.homepage      = 'https://github.com/angeloashmore/hanami-rethinkdb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'hanami-model',   '~> 0.5'
+  spec.add_runtime_dependency 'rethinkdb',      '~> 2.2'
+  spec.add_runtime_dependency 'activesupport',  '~> 4.2'
+
+  spec.add_development_dependency 'bundler',       '~> 1.6'
+  spec.add_development_dependency 'minitest',      '~> 5.8'
+  spec.add_development_dependency 'minitest-line', '~> 0.6.3'
+  spec.add_development_dependency 'rake',          '~> 11.1'
+end

data/lib/hanami-rethinkdb.rb

@@ -0,0 +1,2 @@
+require 'hanami/model' # rubocop:disable Style/FileName
+require 'hanami/model/adapters/rethinkdb_adapter'

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

@@ -0,0 +1,332 @@
+require 'delegate'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'rethinkdb'
+require 'hanami/utils/kernel'
+
+module Hanami
+  module Model
+    module Adapters
+      module Rethinkdb
+
+        require 'hanami/model/coercer'
+
+        class Now < Hanami::Model::Coercer
+          def self.dump(value)
+            Hanami::Utils::Kernel.Time(value)
+          end
+
+          def self.load(value)
+            value.to_datetime if value.respond_to? :to_datetime
+          end
+        end
+
+        # 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 [Hanami::Model::Mapping::Collection] a
+          #   mapped collection
+          #
+          # @return [Hanami::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 Hanami::Model::Adapters::Rethinkdb::Command#create
+          #
+          # @return the primary key of the created document
+          #
+          # @api private
+          # @since 0.1.0
+          def insert(entity)
+            serialized_entity = _serialize(entity)
+
+            response = _run do
+              super(serialized_entity)
+            end
+
+            serialized_entity[_identity] = response['generated_keys'].first
+
+            _deserialize([serialized_entity]).first
+          end
+
+          # Updates the document corresponding to the given entity.
+          #
+          # @param entity [Object] the entity to persist
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Command#update
+          #
+          # @api private
+          # @since 0.1.0
+          def update(entity)
+            serialized_entity = _serialize(entity)
+
+            response = _run do
+              super(serialized_entity)
+            end
+
+            _deserialize([serialized_entity]).first
+          end
+
+          # Deletes the current scope.
+          #
+          # @see Hanami::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 Hanami::Model::Adapters::Rethinkdb::Query#where
+          #
+          # @return [Hanami::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 Hanami::Model::Adapters::Rethinkdb::Query#pluck
+          #
+          # @return [Hanami::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 `has_fields` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#has_fields
+          #
+          # @return [Hanami::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def has_fields(*args) # rubocop:disable Style/PredicateName
+            _collection(super, @mapped_collection)
+          end
+
+          # Filters the current scope with a `limit` directive.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#limit
+          #
+          # @return [Hanami::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 Hanami::Model::Adapters::Rethinkdb::Query#order
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#desc
+          #
+          # @return [Hanami::Model::Adapters::Rethinkdb::Collection] the filtered
+          #   collection
+          #
+          # @api private
+          # @since 0.1.0
+          def order_by(*args)
+            _collection(super, @mapped_collection)
+          end
+
+          # Returns the sum of the values for the given field.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#sum
+          #
+          # @return [Numeric]
+          #
+          # @api private
+          # @since 0.1.0
+          def sum(*args)
+            _run do
+              super
+            end
+          end
+
+          # Returns the average of the values for the given column.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#avg
+          #
+          # @return [Numeric]
+          #
+          # @api private
+          # @since 0.1.0
+          def avg(*args)
+            _run do
+              super.default(nil)
+            end
+          end
+
+          # Returns the maximum value for the given field.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#max
+          #
+          # @return [Numeric]
+          #
+          # @api private
+          # @since 0.1.0
+          def max(field, *args)
+            _run do
+              super[field].default(nil)
+            end
+          end
+
+          # Returns the minimum value for the given field.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#min
+          #
+          # @return [Numeric]
+          #
+          # @api private
+          # @since 0.1.0
+          def min(field, *args)
+            _run do
+              super[field].default(nil)
+            end
+          end
+
+          # Returns a count of the documents for the current conditions.
+          #
+          # @param args [Array] the array of arguments
+          #
+          # @see Hanami::Model::Adapters::Rethinkdb::Query#count
+          #
+          # @return [Numeric]
+          #
+          # @api private
+          # @since 0.1.0
+          def count
+            _run do
+              super
+            end
+          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 Hanami::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
+
+          # Name of the identity field in database.
+          #
+          # @return [Symbol] the identity name
+          #
+          # @api private
+          # @since 0.2.1
+          def _identity
+            @mapped_collection.identity
+          end
+
+          # Returns a collection with the connection automatically included.
+          #
+          # @return [Hanami::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