ork 0.0.1 → 0.1.0

data/lib/ork/model/document.rb

@@ -0,0 +1,155 @@
+require_relative '../model'
+require_relative 'finders'
+
+module Ork
+  module Document
+    attr_accessor :id
+
+    def self.included(klass)
+      klass.send(:include, Ork::Model)
+      klass.extend(Ork::Model::Finders)
+    end
+
+    # Check for equality by doing the following assertions:
+    #
+    # 1. That the passed model is of the same type.
+    # 2. That they represent the same RObject id.
+    #
+    def ==(other)
+      other.kind_of?(model) && other.id == id
+    end
+    alias :eql? :==
+
+    def new?
+      !id
+    end
+
+    def embeddable?
+      false
+    end
+
+    # Pretty print for the model
+    #
+    #  Example:
+    #
+    #    User.new(name: 'John').inspect
+    #    # => #<User:6kS5VHNbaed9h7gFLnVg5lmO4U7 {:name=>"John"}>
+    def inspect
+      "#<#{model}:#{id || 'nil'} #{attributes.inspect}>"
+    end
+
+    # Update the model attributes and call save.
+    #
+    # Example:
+    #
+    #   User[1].update(:name => "John")
+    #
+    #   # It's the same as:
+    #
+    #   u = User[1]
+    #   u.update_attributes(:name => "John")
+    #   u.save
+    #
+    def update(attributes)
+      update_attributes(attributes)
+      save
+    end
+
+    # Persist the model attributes and update indices and unique
+    # indices.
+    #
+    # Example:
+    #
+    #   class User
+    #     include Ork::Document
+    #
+    #     attribute :name
+    #   end
+    #
+    #   u = User.new(:name => "John").save
+    #   # => #<User:6kS5VHNbaed9h7gFLnVg5lmO4U7 {:name=>"John"}>
+    #
+    def save
+      __robject.content_type = 'application/json'
+      __robject.data = __persist_attributes
+
+      __check_unique_indices
+      __update_indices
+      __robject.store
+
+      @id = __robject.key
+
+      self
+    end
+
+    # Preload all the attributes of this model from Riak.
+    def reload
+      new? ? self : self.load!(@id)
+    end
+
+    # Delete the model
+    def delete
+      __robject.delete unless new?
+      freeze
+    rescue Riak::FailedRequest
+      false
+    end
+
+    protected
+
+    # Overwrite attributes with the persisted attributes in Riak.
+    #
+    def load!(id)
+      self.__robject.key = id
+      __load_robject! id, @__robject.reload(force: true)
+    end
+
+    # Transform a RObject returned by Riak into a Ork::Document.
+    #
+    def __load_robject!(id, robject)
+      @id = id
+      @__robject = robject
+      @attributes = {}
+      @embedding = {}
+      @_memo = {}
+
+      data = @__robject.data
+      embedded_data = {}
+
+      model.embedding.each do |embedded|
+        if d = data.delete(embedded.to_s)
+          embedded_data[embedded] = d
+        end
+      end
+
+      update_attributes data
+      update_embedded_attributes embedded_data
+
+      self
+    end
+
+    # Build the secondary indices of this object
+    def __update_indices
+      model.indices.values.each do |index|
+        __robject.indexes[index.riak_name] = index.value_from(attributes)
+      end
+    end
+
+    # Look up into Riak for repeated values on unique attributes
+    def __check_unique_indices
+      model.uniques.each do |uniq|
+        if value = attributes[uniq]
+          index = model.indices[uniq]
+          records = model.bucket.get_index(index.riak_name, value)
+          unless records.empty? || records == [self.id]
+            raise Ork::UniqueIndexViolation, "#{uniq} is not unique"
+          end
+        end
+      end
+    end
+
+    def __robject
+      @__robject ||= model.bucket.new
+    end
+  end
+end

data/lib/ork/model/finders.rb

@@ -7,13 +7,10 @@ module Ork::Model
     #
     #   u = User.create
     #   u == User[u.id]
-    #   # =>  true
+    #   # => true
     #
     def [](id)
-      new.send(:load!, id) if exist?(id)
-    rescue Riak::FailedRequest => e
-      raise e unless e.not_found?
-      nil
+      load_key(id) if exist?(id)
     end
 
     # Check if the ID exists.
@@ -23,22 +20,57 @@ module Ork::Model
     alias :exists? :exist?
 
     # Find all documents in the Document's bucket and return them.
-    # @overload list()
-    #   Get all documents and return them in an array.
-    #   @param [Hash] options options to be passed to the
-    #     underlying {Bucket#keys} method.
     #   @return [Array<Document>] all found documents in the bucket
     #
     # @Note: This operation is incredibly expensive and should not
     #   be used in production applications.
     #
     def all
-      bucket.keys.inject([]) do |acc, k|
-        obj = self[k]
-        obj ? acc << obj : acc
-      end
+      load_robjects bucket.get_many(bucket.keys)
     end
     alias :list :all
 
+    # Find values in indexed fields.
+    #
+    # Example:
+    #
+    #   class User
+    #     include Ork::Document
+    #
+    #     attribute :name
+    #     index :name
+    #   end
+    #
+    #   u = User.create(name: 'John')
+    #   User.find(name: 'John').include?(u)
+    #   # => true
+    #
+    #   User.find(name: 'Mike').include?(u)
+    #   # => false
+    #
+    # Note: If the key was not defined, an
+    # `Ork::IndexNotFound` exception is raised.
+    #
+    def find(by_index, value)
+      raise Ork::IndexNotFound unless indices.has_key? by_index
+
+      index = indices[by_index]
+      load_robjects bucket.get_many(bucket.get_index(index.riak_name, value))
+    end
+
+    private
+
+    def load_key(id)
+      new.send(:load!, id)
+    rescue Riak::FailedRequest => e
+      raise e unless e.not_found?
+    end
+
+    def load_robjects(robjects)
+      robjects.map do |id, robject|
+        new.send(:__load_robject!, id, robject)
+      end
+    end
+
   end
 end

data/lib/ork/model/index.rb

@@ -0,0 +1,20 @@
+module Ork::Model
+  class Index
+
+    def initialize(name, type = 'bin')
+      @name, @type = name, type
+    end
+
+    # Index name in riak format
+    def riak_name
+      "#@name\_#@type"
+    end
+
+    # Take the attributes needed by the index.
+    # It's best to normalize or encode any
+    # user-supplied data before using it as an index
+    def value_from(attributes)
+      Set[attributes[@name]]
+    end
+  end
+end

data/lib/ork/model.rb

@@ -1,16 +1,13 @@
 require_relative 'model/class_methods'
 require_relative 'model/associations'
-require_relative 'model/finders'
 
 module Ork
   module Model
-    attr_reader :attributes, :id
-    attr_writer :id
+    attr_reader :attributes, :embedding
 
     def self.included(klass)
       klass.extend(Ork::Model::ClassMethods)
       klass.extend(Ork::Model::Associations)
-      klass.extend(Ork::Model::Finders)
     end
 
     # Initialize a model using a dictionary of attributes.
@@ -21,50 +18,9 @@ module Ork
     #
     def initialize(atts = {})
       @attributes = {}
+      @embedding = {}
       @_memo = {}
-      update_attributes(atts)
-    end
-
-    # Check for equality by doing the following assertions:
-    #
-    # 1. That the passed model is of the same type.
-    # 2. That they represent the same RObject id.
-    #
-    def ==(other)
-      other.kind_of?(model) && other.id == id
-    end
-
-    alias :eql? :==
-
-    def new?
-      !id
-    end
-
-    # Pretty print for the model
-    #
-    #  Example:
-    #
-    #    User.new(name: 'John').inspect
-    #    # => #<User:6kS5VHNbaed9h7gFLnVg5lmO4U7 {:name=>"John"}>
-    def inspect
-      "#<#{model}:#{id || 'nil'} #{attributes.inspect}>"
-    end
-
-    # Update the model attributes and call save.
-    #
-    # Example:
-    #
-    #   User[1].update(:name => "John")
-    #
-    #   # It's the same as:
-    #
-    #   u = User[1]
-    #   u.update_attributes(:name => "John")
-    #   u.save
-    #
-    def update(attributes)
-      update_attributes(attributes)
-      save
+      update_attributes(model.defaults.merge(atts))
     end
 
     # Write the dictionary of key-value pairs to the model.
@@ -74,77 +30,40 @@ module Ork
       atts.each { |att, val| send(:"#{att}=", val) }
     end
 
-    # Delete the model
-    def delete
-      __robject.delete unless new?
-      freeze
-    rescue Riak::FailedRequest
-      false
-    end
-
-    # Persist the model attributes and update indices and unique
-    # indices.
-    #
-    # If the model is not valid, nil is returned. Otherwise, the
-    # persisted model is returned.
-    #
-    # Example:
-    #
-    #   class User
-    #     include Ork::Model
-    #
-    #     attribute :name
-    #
-    #     def validate
-    #       assert_present :name
-    #     end
-    #   end
-    #
-    #   User.new(:name => nil).save
-    #   # => nil
-    #
-    #   u = User.new(:name => "John").save
-    #   # => #<User:6kS5VHNbaed9h7gFLnVg5lmO4U7 {:name=>"John"}>
-    #
-    def save
-      # FIXME: Work with validations, scrivener or hatch?
-      # save! if valid?
-      save!
-    end
-
-    # Saves the model without checking for validity. Refer to
-    # `Model#save` for more details.
-    def save!
-      __save__
-    end
-
-    # Preload all the attributes of this model from Riak.
-    def reload
-      new? ? self : self.load!(@id)
+    # Writhe the dictionary of key-value pairs of embedded objects.
+    #
+    def update_embedded_attributes(atts)
+      atts.each do |att, val|
+        if val.is_a? Array
+          val.each do |object_atts|
+            model = Ork::Utils.const(self.class, object_atts.delete('_type'))
+            send(:"add_#{att}", model.new(object_atts))
+          end
+        else
+          model = Ork::Utils.const(self.class, val.delete('_type'))
+          send(:"#{att}=", model.new(val))
+        end
+      end
     end
 
     protected
 
-    def load!(id)
-      @id = self.__robject.key = id
-      @__robject = @__robject.reload(force: true)
-      update_attributes(@__robject.data)
-
-      self
-    end
-
-    # Persist the object in Riak database
-    def __save__
-      __robject.content_type = 'application/json'
-      __robject.data = @attributes.merge('_type' => model.name)
-      __robject.store
-      @id = __robject.key
-
-      self
-    end
-
-    def __robject
-      @__robject ||= model.bucket.new
+    def __persist_attributes
+      attributes = @attributes.merge('_type' => model.name)
+      attributes.delete(model.__parent_key) if model.respond_to? :__parent_key
+
+      model.embedding.each do |embedded|
+        object = self.send(embedded)
+        unless object.nil?
+          attributes[embedded] = if object.is_a? Array
+                                   object.map{|o| o.send :__persist_attributes}
+                                 else
+                                   object.__persist_attributes
+                                 end
+        end
+      end
+
+      attributes
     end
 
     def model

data/lib/ork/utils.rb

@@ -11,7 +11,7 @@ module Ork
     # Example:
     #
     #   class Comment
-    #     include Ork::Model
+    #     include Ork::Document
     #
     #     reference :user, User # NameError undefined constant User.
     #   end
@@ -20,7 +20,7 @@ module Ork
     #   simply use a Symbol.
     #
     #   class Comment
-    #     include Ork::Model
+    #     include Ork::Document
     #
     #     reference :user, :User
     #   end
@@ -28,6 +28,7 @@ module Ork
     def self.const(context, name)
       case name
       when Symbol then context.const_get(name)
+      when String then context.const_get(name.to_sym)
       else name
       end
     end

data/lib/ork.rb

@@ -1,10 +1,12 @@
 require 'ork/connection'
 require 'ork/model'
+require 'ork/model/document'
+require 'ork/embedded'
 require 'ork/utils'
+require 'ork/errors'
 require "riak"
 
 module Ork
-  class Error < StandardError; end
 
   def self.conn
     @conn ||= Ork::Connection.new

data/ork.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = 'ork'
-  s.version     = '0.0.1'
+  s.version     = '0.1.0'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.summary     = 'Ruby modeling layer for Riak.'
   s.description = 'Ork is a small Ruby modeling layer for Riak, inspired by Ohm.'
   s.authors     = ['Emiliano Mancuso']
   s.email       = ['emiliano.mancuso@gmail.com']
-  s.homepage    = 'http://github.com/eMancu/ork'
+  s.homepage    = 'http://github.com/emancu/ork'
   s.license     = 'MIT'
 
   s.files = Dir[

data/rakefile

@@ -1,31 +1,8 @@
-require "rake/testtask"
-
 task :default => :test
 
-desc 'Start riak test server'
-task :start do
-  require File.expand_path("./test/helper", File.dirname(__FILE__))
-  puts '..:: Starting riak test server ::..'
-  test_server.start
-end
-
 desc 'Run tests'
-task :test => [:start] do
-  Dir["test/*.rb"].each { |file| load file unless file =~ /helper.rb/ }
-end
-
-desc 'Stop riak test server'
-task :stop => [:start] do
-  puts '..:: Stop riak test server ::..'
-
-  flush_db!
-  test_server.stop
-end
-
-at_exit do
-  puts '..:: Stop riak test server ::..'
-  sleep 1
+task :test do
+  require File.expand_path("./test/helper", File.dirname(__FILE__))
 
-  flush_db!
-  test_server.stop
+  Dir["test/**/*_test.rb"].each { |file| load file }
 end

data/test/helper.rb

@@ -1,41 +1,31 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.start do
+  project_name "Ork"
+  command_name "Protest"
+
+  add_filter "/test/"
+end
+
 require "rubygems"
 require "protest"
 require "ork"
 
-# require 'coveralls'
-# Coveralls.wear!
-
 Riak.disable_list_keys_warnings = true
-
-require 'riak/test_server'
-
-def test_server
-  $test_server ||= begin
-     require 'toml'
-     path = File.expand_path("../test_riak_server.toml", __FILE__)
-     config = TOML.load_file(path, symbolize_keys: true)
-
-
-     server = Riak::TestServer.create(root: config[:root],
-                                      source: config[:source],
-                                      min_port: config[:min_port])
-
-
-     Ork.connect(:test, {
-      http_port: server.http_port,
-      pb_port:   server.pb_port
-     })
-
-     server
-   rescue => e
-     puts ("Can't run Ork tests without the test server.\n" +
-             "Specify the location of your Riak installation in test/test_riak_server.toml\n" +
-             e.inspect)
-   end
+Protest.report_with(:progress)
+
+def randomize_bucket_name(klass)
+  klass.bucket_name= [
+    'test',
+    klass.to_s,
+    Time.now.to_i,
+    rand(36**10).to_s(36)
+  ].join('-')
 end
 
-def flush_db!
-  test_server.drop
+def deny(condition, message="Expected condition to be unsatisfied")
+  assert !condition, message
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ork
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Emiliano Mancuso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -62,21 +62,20 @@ files:
 - README.md
 - rakefile
 - lib/ork/connection.rb
+- lib/ork/embedded.rb
+- lib/ork/errors.rb
 - lib/ork/model/associations.rb
 - lib/ork/model/class_methods.rb
+- lib/ork/model/document.rb
 - lib/ork/model/finders.rb
+- lib/ork/model/index.rb
 - lib/ork/model.rb
 - lib/ork/utils.rb
 - lib/ork/version.rb
 - lib/ork.rb
 - ork.gemspec
-- test/finders.rb
 - test/helper.rb
-- test/model.rb
-- test/reference.rb
-- test/test_riak_server.toml
-- test/test_riak_server.toml.example
-homepage: http://github.com/eMancu/ork
+homepage: http://github.com/emancu/ork
 licenses:
 - MIT
 metadata: {}
@@ -101,9 +100,4 @@ signing_key:
 specification_version: 4
 summary: Ruby modeling layer for Riak.
 test_files:
-- test/finders.rb
 - test/helper.rb
-- test/model.rb
-- test/reference.rb
-- test/test_riak_server.toml
-- test/test_riak_server.toml.example

data/test/finders.rb

@@ -1,43 +0,0 @@
-require_relative 'helper'
-
-class Human
-  include Ork::Model
-
-  attribute :name
-  attribute :last_name
-
-  unique :name
-  index :last_name
-end
-
-Protest.describe 'Finders' do
-  setup do
-    @human1 = Human.create(name: 'Tony',  last_name: 'Montana')
-    @human2 = Human.create(name: 'Cacho', last_name: 'Castaña')
-  end
-
-  teardown do
-    flush_db!
-  end
-
-  test 'retrieve an object by id' do
-    assert_equal @human1, Human[@human1.id]
-  end
-
-  test 'return nil when the id does not belong to an object of this bucket' do
-    assert_equal nil, Human['not_an_id']
-  end
-
-  test 'if exist an object with the id' do
-    assert !Human.exist?(nil)
-    assert !Human.exist?('not_an_id')
-    assert Human.exist?(@human1.id)
-  end
-
-  test 'list all the objects' do
-    assert_equal 2, Human.list.size
-    assert Human.list.include?(@human1)
-    assert Human.list.include?(@human2)
-  end
-
-end