ork 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 057b1b4f7eb4e0328a9998738e477947bacdacc3
-  data.tar.gz: d6522930cdaf1e25e16b19988be2901db7968e9b
+  metadata.gz: 751f05a6aa58853ff594139a6f305dbbffd7ada2
+  data.tar.gz: 6350a3beb54c4dfebbe2494f9591cc1356881074
 SHA512:
-  metadata.gz: cbbc733bd2cc6dc9954827ed1d170fe2a27f95847e114bbaa000666a823be271e6a9ef018da6afb7d2e8c3f093364ad039d3f81ede44d3755adde4b1ab58adb2
-  data.tar.gz: e4ac8f95ace5511046f100a33f7005a56eb17cdeb3589d2d11174848067dfd23d697ae36671c13f3d0545f7f929ca90df99864c4c9671cfc45b2c0eed96e10ae
+  metadata.gz: 843c02219e04d26548a4e329e79b0e9e032a81760f19945269e10809808a99c4254a8e9c0aa9c64ba94d349ac95008dd078542ef060310ab1764068115de5f0b
+  data.tar.gz: 339e08edc7416c6b8040d827ce4a588c2bc46fa1be1a4459877e6309a7afcd2c903c80836538a309ef5b76f170c3d28233e630eee10ace712a8b83d0e9cd5cb0

data/README.md

@@ -7,6 +7,8 @@
 
 Ork is a small Ruby modeling layer for **Riak** database, inspired by [Ohm](http://ohm.keyvalue.org).
 
+![Ork](http://f.cl.ly/items/2x2O0s3U0v2U0B3N313F/Ork.png)
+
 ## Dependencies
 
 `ork` requires Ruby 1.9 or later and the `riak-client` gem to connect to **Riak**.
@@ -40,11 +42,11 @@ Take a look at the example below:
 class Post
   include Ork::Document
 
-  attribute :name
-  attribute :age, default: 18
+  attribute :title
+  attribute :rating, default: 4
 
-  index :age
-  unique :name
+  index :rating
+  unique :title
 end
 
 class Comment
@@ -62,11 +64,11 @@ It also gives you some helpful **class methods**:
 |:-------------|:-------------------------------------------------|:-------------------------|
 | bucket       | `Riak::Bucket` The bucket assigned to this class | `#<Riak::Bucket {post}>` |
 | bucket_name  | `String` The bucket name                         | `"post"`                 |
-| attributes   | `Array` Attributes declared                      | `[:name, :age]`          |
-| indices      | `Array` Indices declared                         | `[:age]`                 |
-| uniques      | `Array` Unique indices declared                  | `[:name]`                |
+| attributes   | `Array` Attributes declared                      | `[:title, :rating]`      |
+| indices      | `Array` Indices declared                         | `[:rating]`              |
+| uniques      | `Array` Unique indices declared                  | `[:title]`               |
 | embedding    | `Array` Embedded attributes declared             | `[:post]`                |
-| defaults     | `Hash` Defaults for attributes                   | `{:age=>18}`             |
+| defaults     | `Hash` Defaults for attributes                   | `{:rating=>4}`           |
 
 
 And for **instance methods** it defines:
@@ -96,7 +98,7 @@ Core behaviour of `Ork::Model`.
 An `attribute` is just any value that can be stored. It is composed of a `:name` and an optional `hash`.
 
 ```ruby
-attribute :age, default: 18
+attribute :rating, default: 4
 ```
 
 #### Options
@@ -120,6 +122,7 @@ containing the foreign key to another model.
 reference :user, :User
 ```
 
+
 ## referenced
 
 Provides an accessor to search for _one_ model that `reference` the current model.
@@ -128,14 +131,23 @@ Provides an accessor to search for _one_ model that `reference` the current mode
 referenced :comment, :Comment
 ```
 
+
 ## collection
 
-Provides an accessor to search for _all_ models that `reference` the current model.
+It's a special kind of attribute that references another models.
+Internally, Ork will keep a an array of ids to the models, but you get
+accessors that give you real instances.
+
+It won't make a query to retrieve _all_ models taht `reference` the current model.
+This is something that works well on _relational databases_ but is not recomended
+for _document oriented databases_ like **Riak**.
+
 
 ```ruby
 collection :comments, :Comment
 ```
 
+
 ## embed
 > Only accepts embeddable objects.
 
@@ -147,6 +159,7 @@ accessors that give you real instances.
 embed :comment, :Comment
 ```
 
+
 ## embed_collection
 > Only accepts embeddable objects.
 
@@ -172,6 +185,24 @@ Provides an accessor to the object that `embeds` the current model.
 embedded :post, :Post
 ```
 
+
+## index
+
+Create an index for the previously defined `attribute`.
+
+```ruby
+index :rating
+```
+
+## unique
+
+Create a unique index for the previously defined `attribute`.
+
+```ruby
+unique :title
+```
+
+
 ## Pagination
 
 Pagination is a key feature introduced in _Riak 1.4_ and it is supported as well!

data/lib/ork/errors.rb

@@ -3,8 +3,13 @@ module Ork
   class IndexNotFound < RuntimeError; end
   class UniqueIndexViolation < RuntimeError; end
 
+  # Document
+  class InvalidClass < RuntimeError; end
+
+  # Embedded
   class NotAnEmbeddableObject < RuntimeError; end
   class ParentMissing < RuntimeError; end
 
+
   class NoNextPage < Error; end
 end

data/lib/ork/model/associations.rb

@@ -38,20 +38,18 @@ module Ork::Model
       reader = :"#{name}_id"
       writer = :"#{name}_id="
 
+      attribute reader, accessors: :reader
       index reader
 
-      define_method(reader) do
-        @attributes[reader]
-      end
-
       define_method(writer) do |value|
         @_memo.delete(name)
         @attributes[reader] = value
       end
 
-      define_method(:"#{name}=") do |value|
-        send(writer, value ? value.id : nil)
-        @_memo[name] = value
+      define_method(:"#{name}=") do |object|
+        raise Ork::InvalidClass.new(object) if object.class.name != model.to_s
+        send(writer, object ? object.id : nil)
+        @_memo[name] = object
       end
 
       define_method(name) do
@@ -117,19 +115,42 @@ module Ork::Model
     #   class User
     #     include Ork::Document
     #
+    #     attribute posts_ids
+    #
     #     def posts
-    #       Post.find(:user_id => self.id)
+    #       Post.all(self.posts_ids)
+    #     end
+    #
+    #     def posts_add(post)
+    #       self.posts_ids << post.id
     #     end
     #   end
     #
     def collection(name, model, reference = to_reference)
-      define_method name do
+      reader = :"#{name}_ids"
+
+      attribute reader, accessors: :reader
+
+      define_method(:"#{name}_ids=") do |value|
+        @_memo.delete(name)
+        @attributes[reader] = value
+      end
+
+      define_method(name) do
         return [] if self.id.nil?
         @_memo[name] ||= begin
                            model = Ork::Utils.const(self.class, model)
-                           model.find(:"#{reference}_id", self.id)
+                           model.all(@attributes[reader].to_a)
                          end
       end
+
+      define_method(:"#{name}_add") do |object|
+        raise Ork::InvalidClass.new(object) if object.class.name != model.to_s
+
+        @attributes[reader] = Array(@attributes[reader]) << object.id
+        @_memo[name] << object unless @_memo[name].nil?
+      end
+
     end
 
     # A macro for defining an attribute, and the accessors
@@ -165,7 +186,7 @@ module Ork::Model
         return nil unless @embedding.has_key? name
         @_memo[name] ||= begin
                            model = Ork::Utils.const(self.class, model)
-                           model.new(@embedding[name])
+                           new_embedded model, @embedding[name]
                          end
       end
 
@@ -201,7 +222,7 @@ module Ork::Model
     #       # An array of authors
     #     end
     #
-    #     def add_author(author)
+    #     def authors_add(author)
     #       # Add an author to the embed collection
     #     end
     #   end
@@ -214,11 +235,13 @@ module Ork::Model
 
         @_memo[name] ||= begin
                            model = Ork::Utils.const(self.class, model)
-                           @embedding[name].map{|atts| model.new atts}
+                           @embedding[name].map do |atts|
+                             new_embedded model, atts
+                           end
                          end
       end
 
-      define_method(:"add_#{name}") do |object|
+      define_method(:"#{name}_add") do |object|
         raise Ork::NotAnEmbeddableObject.new(object) unless object.embeddable?
 
         object.__parent = self

data/lib/ork/model/finders.rb

@@ -21,14 +21,16 @@ module Ork::Model
     end
     alias :exists? :exist?
 
-    # Find all documents in the Document's bucket and return them.
+    # Find all documents of specified keys and return them
+    #
+    # When nil, find all documents in the Document's bucket and return them.
     #   @return Ork::ResultSet<Document> all found documents in the bucket
     #
-    # @Note: This operation is incredibly expensive and should not
+    # @Note: This operation can be incredibly expensive and should not
     #   be used in production applications.
     #
-    def all
-      Ork::ResultSet.all(self)
+    def all(keys = nil)
+      Ork::ResultSet.all(self, keys)
     end
     alias :list :all
 

data/lib/ork/model.rb

@@ -34,15 +34,7 @@ module Ork
     #
     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
+        @embedding[att] = val
       end
     end
 
@@ -69,5 +61,12 @@ module Ork
     def model
       self.class
     end
+
+    def new_embedded(model, attributes)
+      attributes[model.__parent_key] = self
+      attributes.delete '_type'
+
+      model.new attributes
+    end
   end
 end

data/lib/ork/result_set.rb

@@ -16,12 +16,12 @@ module Ork
     # Find all documents in the Document's bucket and return them.
     #   @return Ork::ResultSet<Document> all the documents in the bucket
     #
-    # @Note: This operation is incredibly expensive and should not
+    # @Note: This operation can be incredibly expensive and should not
     #   be used in production applications.
     #
-    def self.all(model)
+    def self.all(model, keys = nil)
       new(model, nil, nil).tap do |r|
-        r.instance_variable_set(:@keys, model.bucket.keys)
+        r.instance_variable_set(:@keys, keys || model.bucket.keys)
       end
     end
 

data/ork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ork'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   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.'
@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   ]
   s.test_files = Dir['test/*.*']
 
-  s.add_dependency 'riak-client'
-  s.add_development_dependency 'protest'
-  s.add_development_dependency 'mocha'
+  s.add_runtime_dependency 'riak-client', '~> 1.4'
+  s.add_development_dependency 'protest', '~> 0'
+  s.add_development_dependency 'mocha', '~> 0'
 end
 

data/test/helper.rb

@@ -14,6 +14,7 @@ require "rubygems"
 require "protest"
 require "ork"
 
+I18n.enforce_available_locales = false
 Riak.disable_list_keys_warnings = true
 Protest.report_with(:progress)
 

data/test/result_set_test.rb

@@ -31,6 +31,7 @@ Protest.describe 'ResultSet' do
 
     test 'it has the keys set but not the loaded objects' do
       key1, key2 = Post.bucket.keys
+
       assert @all.instance_variable_get(:@keys).include? key1
       assert @all.instance_variable_get(:@keys).include? key2
       assert_equal nil, @all.instance_variable_get(:@all)
@@ -45,6 +46,13 @@ Protest.describe 'ResultSet' do
       assert @all.include? @post1
       assert @all.include? @post2
     end
+
+    test 'it returns all the listed objects in a keys array' do
+      @all = Post.all([@post1.id])
+
+      assert_equal 1, @all.size
+      assert @all.include? @post1
+    end
   end
 
   test 'it raises an exception when call next_page if does not have next page' do

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ork
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Emiliano Mancuso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-16 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: protest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Ork is a small Ruby modeling layer for Riak, inspired by Ohm.
@@ -60,20 +60,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- rakefile
+- lib/ork.rb
 - lib/ork/connection.rb
 - lib/ork/errors.rb
+- lib/ork/model.rb
 - lib/ork/model/associations.rb
 - lib/ork/model/class_methods.rb
 - lib/ork/model/document.rb
 - lib/ork/model/embedded.rb
 - lib/ork/model/finders.rb
 - lib/ork/model/index.rb
-- lib/ork/model.rb
 - lib/ork/result_set.rb
 - lib/ork/utils.rb
-- lib/ork.rb
 - ork.gemspec
+- rakefile
 - test/helper.rb
 - test/result_set_test.rb
 homepage: http://github.com/emancu/ork
@@ -86,17 +86,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby modeling layer for Riak.