rethinker 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21309e2b80eb709a611c6117dc846129f8fce756
+  data.tar.gz: 6d5eb8dde92819643dff92eb4987e6144911e40e
+SHA512:
+  metadata.gz: 42c8cf1bdce21900141fb02385004c61ac86ea58901c0187838d6a33bb2b6c287544a50f1f2507734f5c64e04cc90aa067deafb525a340092867684e678c2fbd
+  data.tar.gz: 08c4d9949d1d9177adf52096068e009e39361eebb15df9f63ce612aee70306e80e34a0fb5c0175cae72aaed20bdcc160963251baf37f919ab2842f5d2a75faa3

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright © 2013 Databasify
+
+Rethinker is a fork of NoBrainer
+Copyright © 2012 Nicolas Viennot
+
+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,49 @@
+Rethinker
+===========
+
+Rethinker is a Ruby ORM for [RethinkDB](http://www.rethinkdb.com/).
+
+Installation
+-------------
+
+```ruby
+gem 'rethinker'
+```
+
+Usage
+------
+
+[See documentation](http://databasify.github.io/rethinker)
+
+Features
+---------
+
+* Compatible with Rails 3 and Rails 4
+* Autogeneration of ID, MongoDB style
+* Creation of database and tables on demand
+* Attributes accessors (`attr_accessor`)
+* Dynamic attributes
+* Validation support, expected behavior with `save!`, `save`, etc. (uniqueness validation still in development)
+* Validatation with create, update, save, and destroy callbacks.
+* `find`, `create`, `save`, `update_attributes`, `destroy` (`*.find` vs. `find!`).
+* `where`, `order_by`, `skip`, `limit`, `each`
+* `update`, `inc`, `dec`
+* `belongs_to`, `has_many`
+* `to_json`, `to_xml`
+* `attr_protected`
+* Scopes
+* Thread-safe
+* Polymorphism
+
+Contributors
+------------
+- Andy Selvig (@ajselvig)
+
+License
+--------
+
+Copyright © 2013 Databasify
+
+Rethinker is a fork of NoBrainer, copyright © 2012 Nicolas Viennot
+
+See [`LICENSE.md`](https://github.com/databasify/rethinker/blob/master/LICENSE.md).

data/USAGE.rb.md

@@ -0,0 +1,99 @@
+# Rethinker
+## A Ruby ORM for RethinkDB
+
+**Source:** [github.com/databasify/rethinker](https://github.com/databasify/rethinker)
+
+<small>Based on [NoBrainer](https://github.com/nviennot/nobrainer)</small>
+
+    .
+
+Connect to RethinkDB.  
+Connection string takes the form `rethinkdb://<hostname>/<database>`.  
+Currently, Rethinker only supports a single database.  
+In a Rails project, `config/initializers/rethinker.rb` would be a good place for this.
+
+    Rethinker.connect 'rethinkdb://localhost/blog'
+
+
+
+
+
+
+
+
+    class Post
+To use Rethinker with a model, include `Rethinker::Document`.
+      include Rethinker::Document
+
+Specify field names, optionally providing a default value.
+
+      field :title, default: "Untitled"
+      field :body
+      field :slug
+
+Rethinker currently supports only `has_many`/`belongs_to` relationships.
+
+      has_many :comments
+
+Rethinker supports all of the [validations from Active Model](http://api.rubyonrails.org/classes/ActiveModel/Validations.html).
+      validates :body, presence: true
+      validates :title, presence: true, length: {minimum: 5, maximum: 250}
+      validates :slug, uniqueness: true
+    end
+
+    class Comment
+      include Rethinker::Document
+You can enable the persistence of dynamic attributes by also including `Rethinker::Document::DynamicAttributes`. See below for an example.
+      include Rethinker::Document::DynamicAttributes
+
+      field :author
+      field :body
+
+      belongs_to :post
+
+      validates :author, :body, :post, :presence => true
+
+When using a `uniqueness` validation with one or more scopes, and referencing an association, use the association's foreign key, e.g. `post_id`, and not the association name, e.g. `post`
+      validates :body, uniqueness: {scope: :post_id}
+
+      after_create do
+        puts "#{author} commented on #{post.title}"
+      end
+    end
+        
+
+
+You can clear all data in the database by truncating all tables...
+
+
+    
+    Rethinker.purge!
+
+... or optionally dropping the whole database.
+    Rethinker.purge!(drop: true)
+
+Prefer `Model.create!` to `Model.create`, because `create!` will raise an exception if validations fail, whereas `create` will simply return an unsaved model object.
+    post = Post.create!(:title => 'ohai', :body  => 'yummy')
+
+    puts post.comments.create(:author => 'dude').
+      errors.full_messages == ["Body can't be blank"]
+
+    post.comments.create(:author => 'dude', :body => 'burp')
+    post.comments.create(:author => 'dude', :body => 'wut')
+    post.comments.create(:author => 'joe',  :body => 'sir')
+    Comment.all.each { |comment| puts comment.body }
+
+    post.comments.where(:author => 'dude').destroy
+    puts post.comments.count == 1
+
+Because we included `Rethinker::Document::DynamicAttributes` in the `Comment` class, we can access and update fields not defined using `field`.
+
+Note that setters and getters are *not* created, so you need to access dynamic fields through `object['fieldname']`.
+
+    comment = post.comments.first
+    comment['author_status'] = 'Space Cadet'
+    comment.save
+
+    post.comments.first['author_status']
+     => 'Space Cadet'
+

data/lib/rethinker.rb

@@ -0,0 +1,38 @@
+require 'rethinkdb'
+require 'active_model'
+require 'active_support/core_ext'
+
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9')
+  raise 'Please use Ruby 1.9 or later'
+end
+
+module Rethinker
+  require 'rethinker/railtie' if defined?(Rails)
+  require 'rethinker/autoload'
+  extend Rethinker::Autoload
+
+  autoload :Document, :Connection, :Database, :Error, :QueryRunner, :Selection, :Relation, :Criterion
+  require 'rethinker/document/dynamic_attributes'
+
+  class << self
+    # Note: we always access the connection explicitly, so that in the future,
+    # we can refactor to return a connection depending on the context.
+    # Note that a connection is tied to a database in Rethinker.
+    attr_accessor :connection
+
+    def connect(uri)
+      self.connection = Connection.new(uri).tap { |c| c.connect }
+    end
+
+    delegate :db_create, :db_drop, :db_list, :database, :to => :connection
+    delegate :table_create, :table_drop, :table_list,
+             :purge!, :to => :database
+    delegate :run, :to => QueryRunner
+
+    def rails3?
+      return @rails3 unless @rails3.nil?
+      @rails3 = Gem.loaded_specs['activemodel'].version >= Gem::Version.new('3') &&
+                Gem.loaded_specs['activemodel'].version <  Gem::Version.new('4')
+    end
+  end
+end

data/lib/rethinker/autoload.rb

@@ -0,0 +1,14 @@
+module Rethinker::Autoload
+  include ActiveSupport::Autoload
+
+  def autoload(*args)
+    args.each { |mod| super mod }
+  end
+
+  def autoload_and_include(*mods)
+    mods.each do |mod|
+      autoload mod
+      include const_get mod
+    end
+  end
+end

data/lib/rethinker/connection.rb

@@ -0,0 +1,49 @@
+class Rethinker::Connection
+  # A connection is bound to a specific database.
+
+  attr_accessor :uri, :host, :port, :database_name
+
+  def initialize(uri)
+    self.uri = uri
+    parse_uri
+  end
+
+  def raw
+    @raw ||= RethinkDB::Connection.new(:host => host, :port => port, :db => database_name)
+  end
+
+  alias_method :connect, :raw
+  delegate :reconnect, :close, :run, :to => :raw
+
+  [:db_create, :db_drop, :db_list].each do |cmd|
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{cmd}(*args)
+        Rethinker.run { RethinkDB::RQL.new.#{cmd}(*args) }
+      end
+    RUBY
+  end
+
+  def database
+    @database ||= Rethinker::Database.new(self)
+  end
+
+  private
+
+  def parse_uri
+    require 'uri'
+    parsed_uri = URI.parse(uri)
+
+    if parsed_uri.scheme != 'rethinkdb'
+      raise Rethinker::Error::Connection,
+        "Invalid URI. Expecting something like rethinkdb://host:port/database. Got #{uri}"
+    end
+
+    apply_connection_settings!(parsed_uri)
+  end
+
+  def apply_connection_settings!(uri)
+    self.host = uri.host
+    self.port = uri.port || 28015
+    self.database_name = uri.path.gsub(/^\//, '')
+  end
+end

data/lib/rethinker/criterion.rb

@@ -0,0 +1,32 @@
+class Rethinker::Criterion
+
+  attr_accessor :method, :args, :block
+
+  def initialize(method, *args, &block)
+    self.method = method
+    self.args = args.flatten
+    self.block = block
+  end
+
+  def execute(query = nil, context)
+    return RethinkDB::RQL.new.send(self.method, self.args.first) if query.nil?
+    if !args.flatten.blank? && block
+      query.send self.method, *process_args(self.args, context), block
+    elsif !args.flatten.blank?
+      query.send self.method, *process_args(self.args, context)
+    elsif block
+      query.send self.method, block
+    else
+      query.send self.method
+    end
+  end
+
+  def process_args(args, context)
+    if args && args.first.respond_to?(:to_rql)
+      args.first.to_rql(context)
+    else
+      args
+    end
+  end
+
+end

data/lib/rethinker/database.rb

@@ -0,0 +1,38 @@
+class Rethinker::Database
+  attr_accessor :connection
+
+  delegate :database_name, :to => :connection
+
+  def initialize(connection)
+    self.connection = connection
+  end
+
+  def raw
+    @raw ||= RethinkDB::RQL.new.db(database_name)
+  end
+
+  def purge!(options={})
+    if options[:drop]
+      connection.db_drop(database_name)
+    else
+      # truncating each table is much faster
+      table_list.each do |table_name|
+        self.class.truncate_table!(table_name)
+      end
+    end
+  rescue RuntimeError => e
+    raise e unless e.message =~ /No entry with that name/
+  end
+
+  [:table_create, :table_drop, :table_list].each do |cmd|
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{cmd}(*args)
+        Rethinker.run { raw.#{cmd}(*args) }
+      end
+    RUBY
+  end
+
+  def self.truncate_table!(table_name)
+    Rethinker.run { RethinkDB::RQL.new.table(table_name).delete }
+  end
+end

data/lib/rethinker/document.rb

@@ -0,0 +1,8 @@
+module Rethinker::Document
+  extend ActiveSupport::Concern
+  extend Rethinker::Autoload
+
+  autoload_and_include :Core, :InjectionLayer, :Attributes, :Id, :Relation,
+                       :Persistence, :Serialization, :Selection, :Validation, :Polymorphic,
+                       :Timestamps
+end

data/lib/rethinker/document/attributes.rb

@@ -0,0 +1,117 @@
+module Rethinker::Document::Attributes
+  extend ActiveSupport::Concern
+
+  included do
+    if Rethinker.rails3?
+      include ActiveModel::MassAssignmentSecurity
+    end
+    attr_accessor :attributes
+
+    # Not using class_attribute because we want to
+    # use our custom logic
+    class << self; attr_accessor :fields; end
+    self.fields = {}
+  end
+
+  def initialize(attrs={}, options={})
+    super
+    assign_attributes(attrs, options.reverse_merge(:pristine => true))
+  end
+
+  def [](name)
+    __send__("#{name}")
+  end
+
+  def []=(name, value)
+    __send__("#{name}=", value)
+  end
+
+  def reset_attributes
+    # XXX Performance optimization: we don't save field that are not
+    # explicitly set. The row will therefore not contain nil for
+    # unset attributes. This has some implication when using where()
+    # see lib/rethinker/selection/where.rb
+    self.attributes = {}
+
+    # assign default attributes based on the field definitions
+    self.class.fields.each do |name, options|
+      self.__send__("#{name}=", options[:default]) if options.has_key?(:default)
+    end
+  end
+
+  def assign_attributes(attrs, options={})
+    reset_attributes if options[:pristine]
+
+    # TODO Should we reject undeclared fields ?
+    if options[:from_db]
+      attributes.merge! attrs
+    else
+      if Rethinker.rails3?
+        unless options[:without_protection]
+          attrs = sanitize_for_mass_assignment(attrs, options[:as])
+        end
+      end
+      attrs.each do |k,v| 
+        if respond_to?("#{k}=")
+          __send__("#{k}=", v)
+        else 
+          attributes[k.to_s] = v
+        end
+      end
+    end
+  end
+  alias_method :attributes=, :assign_attributes
+
+  # TODO test that thing
+  def inspect
+    attrs = self.class.fields.keys.map { |f| "#{f}: #{attributes[f.to_s].inspect}" }
+    "#<#{self.class} #{attrs.join(', ')}>"
+  end
+
+  module ClassMethods
+    def new_from_db(attrs, options={})
+      klass_from_attrs(attrs).new(attrs, options.reverse_merge(:from_db => true)) if attrs
+    end
+
+    def inherited(subclass)
+      super
+      subclass.fields = self.fields.dup
+    end
+
+    def field(name, options={})
+      name = name.to_sym
+
+      # Using a hash because:
+      # - at some point, we want to associate informations with a field (like the type)
+      # - it gives us a set for free
+      ([self] + descendants).each do |klass|
+        klass.fields[name] ||= {}
+        klass.fields[name].merge!(options)
+      end
+
+      # Using a layer so the user can use super when overriding these methods
+      inject_in_layer :attributes, <<-RUBY, __FILE__, __LINE__ + 1
+        def #{name}=(value)
+          attributes['#{name}'] = value
+        end
+
+        def #{name}
+          attributes['#{name}']
+        end
+      RUBY
+    end
+
+    def remove_field(name)
+      name = name.to_sym
+
+      ([self] + descendants).each do |klass|
+        klass.fields.delete(name)
+      end
+
+      inject_in_layer :attributes, <<-RUBY, __FILE__, __LINE__ + 1
+        undef #{name}=
+        undef #{name}
+      RUBY
+    end
+  end
+end