ork 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47e2643acef3adcb2aeac374845b5361247ba439
-  data.tar.gz: 28fe5d544ea0c7fbb31d8630429a207d73cae3be
+  metadata.gz: 057b1b4f7eb4e0328a9998738e477947bacdacc3
+  data.tar.gz: d6522930cdaf1e25e16b19988be2901db7968e9b
 SHA512:
-  metadata.gz: f25201cb3a85190b9f9b1fdcb07ea09b0c7aec3c820304547b90c3e66129e2fa6c15900d531493f817ad53c2f28af4b06630c9cb91b9102ba53c61dc7ccb2a1c
-  data.tar.gz: 3beec74ee51de51612f07191eb1421dd5c558404048ad18e6d8e3d15a4560387efcc1dfc30f0bbd2240abcfa72d319a41a24c5d20f71060536af61ff0be2496d
+  metadata.gz: cbbc733bd2cc6dc9954827ed1d170fe2a27f95847e114bbaa000666a823be271e6a9ef018da6afb7d2e8c3f093364ad039d3f81ede44d3755adde4b1ab58adb2
+  data.tar.gz: e4ac8f95ace5511046f100a33f7005a56eb17cdeb3589d2d11174848067dfd23d697ae36671c13f3d0545f7f929ca90df99864c4c9671cfc45b2c0eed96e10ae

data/README.md

@@ -172,11 +172,61 @@ Provides an accessor to the object that `embeds` the current model.
 embedded :post, :Post
 ```
 
+## Pagination
+
+Pagination is a key feature introduced in _Riak 1.4_ and it is supported as well!
+
+`Ork` will return the _enumerable_ `Ork::ResultSet` object which stores the keys and also the resulting objects.
+The __keys__ are immediately loaded, but the __objects__ will be lazy loaded.
+
+Given it uses the same API than `riak_client` let's jump into the examples.
+
+```ruby
+
+resultset = Post.find(:age, 19, max_results: 3)
+# => #<Ork::ResultSet:{:max_results=>3} ['object_key_1', 'object_key_2', 'object_key_3']>
+
+resultset.keys
+# => ['object_key_1', 'object_key_2', 'object_key_3']
+
+resultset.all
+# => [#<Post:1 ...>, #<Post:2 ...>, #<Post:3 ...>]
+
+##
+# Advance to next page
+##
+
+resultset.has_next_page?
+# => true
+
+next_resultset = resultset.next_page
+# => #<Ork::ResultSet:{:max_results=>3, :continuation=>'a_continuation_string'}
+#    ['object_key_4', 'object_key_5']>
+
+next_resultset.has_next_page?
+# => false
+
+next_resultset.next_page
+# => raises Ork::NoNextPage: There is no next page
+
+##
+# Skip pages and start from a continuation
+##
+
+resultset2 = Post.find(:age, 19, max_results: 3, continuation: 'a_continuation_string')
+# => #<Ork::ResultSet:{:max_results=>3, :continuation=>'a_continuation_string'}
+#    ['object_key_4', 'object_key_5']>
+
+resultset2 == resultset.next_page
+# => true
+
+```
+
 ## Validations
 
 As you can see, there is no reference to validations in this document and I'm aware of that!
 The validation logic for _nested embedded objects_ makes the code more complex than I want.
-Given that I want to keep this gem as simple as I can, I decided to avoid _object validation_ logic here and promote the use of other gems. 
+Given that I want to keep this gem as simple as I can, I decided to avoid _object validation_ logic here and promote the use of other gems.
 
 There are good implementations for object validation like [hatch](https://github.com/tonchis/hatch) or [scrivener](https://github.com/soveran/scrivener) which they do a great job!
 If you don't know them, you should take a look, but remember that you are free to use your prefered _gem_ or even your own method!

data/lib/ork/errors.rb

@@ -5,4 +5,6 @@ module Ork
 
   class NotAnEmbeddableObject < RuntimeError; end
   class ParentMissing < RuntimeError; end
+
+  class NoNextPage < Error; end
 end

data/lib/ork/model/class_methods.rb

@@ -42,6 +42,13 @@ module Ork::Model
     # When the parameter is nil, it will return the content_type.
     # It also sets as default the standard content_type.
     #
+    # Example:
+    #   class User
+    #     include Ork:Document
+    #
+    #     content_type 'text/plain'
+    #   end
+    #
     def content_type(type = nil)
       @content_type = type unless type.nil?
       @content_type ||= 'application/json'

data/lib/ork/{embedded.rb → model/embedded.rb}

@@ -1,4 +1,4 @@
-require_relative 'model'
+require_relative '../model'
 
 module Ork
   module Embeddable

data/lib/ork/model/finders.rb

@@ -1,3 +1,5 @@
+require_relative '../result_set'
+
 module Ork::Model
   module Finders
 
@@ -20,17 +22,22 @@ module Ork::Model
     alias :exists? :exist?
 
     # Find all documents in the Document's bucket and return them.
-    #   @return [Array<Document>] all found documents in the bucket
+    #   @return Ork::ResultSet<Document> all found documents in the bucket
     #
     # @Note: This operation is incredibly expensive and should not
     #   be used in production applications.
     #
     def all
-      load_robjects bucket.get_many(bucket.keys)
+      Ork::ResultSet.all(self)
     end
     alias :list :all
 
     # Find values in indexed fields.
+    #   @return Ork::ResultSet<Document> found documents in the bucket
+    #
+    # options - Hash configs for pagination.
+    #   :max_results  - Number
+    #   :continuation - String
     #
     # Example:
     #
@@ -42,20 +49,20 @@ module Ork::Model
     #   end
     #
     #   u = User.create(name: 'John')
-    #   User.find(name: 'John').include?(u)
+    #   User.find(:name, 'John', max_results: 5).include?(u)
     #   # => true
     #
-    #   User.find(name: 'Mike').include?(u)
+    #   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)
+    def find(by_index, value, options = {})
       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))
+      Ork::ResultSet.new(self, index, value, options)
     end
 
     private
@@ -66,11 +73,5 @@ module Ork::Model
       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/result_set.rb

@@ -0,0 +1,79 @@
+require 'forwardable'
+
+module Ork
+  class ResultSet
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :keys, :size, :count, :length, :empty?
+    def_delegators :all, :each, :first, :last
+
+    def initialize(model, index, query, options={})
+      @model, @index, @query, @options = model, index, query, options
+      @bucket = @model.bucket
+    end
+
+    # 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
+    #   be used in production applications.
+    #
+    def self.all(model)
+      new(model, nil, nil).tap do |r|
+        r.instance_variable_set(:@keys, model.bucket.keys)
+      end
+    end
+
+    # Pretty print for the ResultSet
+    # It uses keys when the objects are not present.
+    #
+    def inspect
+      string = "#<#{self.class}:#{@options} %s>"
+
+      string % (@all || self.keys).inspect
+    end
+
+    # Get the array of matched keys
+    #
+    def keys(&block)
+      @keys ||=
+        @bucket.client.backend do |b|
+          b.get_index @bucket, @index.riak_name, @query, @options, &block
+        end
+    end
+
+    # Get the array of objects
+    #
+    def all
+      return if self.keys.nil?
+      @all ||= load_robjects @bucket.get_many(@keys)
+    end
+
+    # Get a new ResultSet fetch for the next page
+    #
+    def next_page
+      raise Ork::NoNextPage.new 'There is no next page' unless has_next_page?
+
+      self.class.new(@model,
+                     @index,
+                     @query,
+                     @options.merge(continuation: keys.continuation))
+    end
+
+    # Determine whether a SecondaryIndex fetch has a next page available
+    #
+    def has_next_page?
+      keys.respond_to?(:continuation) && !!keys.continuation
+    end
+
+    private
+
+    def load_robjects(robjects)
+      robjects.map do |id, robject|
+        @model.new.send(:__load_robject!, id, robject)
+      end
+    end
+
+  end
+end

data/lib/ork.rb

@@ -1,12 +1,13 @@
 require 'ork/connection'
 require 'ork/model'
 require 'ork/model/document'
-require 'ork/embedded'
+require 'ork/model/embedded'
 require 'ork/utils'
 require 'ork/errors'
 require "riak"
 
 module Ork
+  VERSION = "0.1.2"
 
   def self.conn
     @conn ||= Ork::Connection.new

data/ork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ork'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   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.'
@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'riak-client'
   s.add_development_dependency 'protest'
-  s.add_development_dependency 'toml-rb'
+  s.add_development_dependency 'mocha'
 end
 

data/test/result_set_test.rb

@@ -0,0 +1,171 @@
+require_relative 'helper'
+
+Protest.describe 'ResultSet' do
+  class Post
+    include Ork::Document
+    attribute :name
+
+    index :name
+  end
+
+  setup do
+    randomize_bucket_name Post
+    @post1 = Post.create name: 'Post 1'
+    @post2 = Post.create name: 'Post 2'
+  end
+
+  context '*all*' do
+    setup do
+      @all = Ork::ResultSet.all(Post)
+    end
+
+    test 'index and query are nil' do
+      assert_equal nil, @all.instance_variable_get(:@index)
+      assert_equal nil, @all.instance_variable_get(:@query)
+    end
+
+    test 'model, bucket are not nil' do
+      assert_equal Post, @all.instance_variable_get(:@model)
+      assert_equal Post.bucket, @all.instance_variable_get(:@bucket)
+    end
+
+    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)
+    end
+
+    test 'it is not paginated' do
+      deny @all.has_next_page?
+    end
+
+    test 'it returns all the objects' do
+      assert_equal 2, @all.size
+      assert @all.include? @post1
+      assert @all.include? @post2
+    end
+  end
+
+  test 'it raises an exception when call next_page if does not have next page' do
+    resultset = Ork::ResultSet.all(Post)
+
+    deny resultset.has_next_page?
+    assert_raise Ork::NoNextPage do
+      resultset.next_page
+    end
+  end
+
+  context '*new*' do
+    setup do
+      @post3 = Post.create name: 'Post 1'
+
+      @index = Post.indices[:name]
+      @resultset = Ork::ResultSet.new(Post, @index, 'Post 1')
+    end
+
+    test 'the keys are not loaded' do
+      assert_equal nil, @resultset.instance_variable_get(:@keys)
+      assert_equal nil, @resultset.instance_variable_get(:@all)
+    end
+
+    test ':size, :count :length will not load the robjects' do
+      assert_equal 2, @resultset.size
+      assert_equal 2, @resultset.length
+      assert_equal 2, @resultset.count
+
+      assert @resultset.instance_variable_get(:@keys).include? @post1.id
+      assert @resultset.instance_variable_get(:@keys).include? @post3.id
+      assert_equal nil, @resultset.instance_variable_get(:@all)
+    end
+
+    test 'can be iterable and iterates over the objects' do
+      assert @resultset.respond_to?(:each)
+
+      @resultset.each{|post| assert_equal Post, post.class}
+    end
+
+    test 'it acts like an array' do
+      deny @resultset.empty?
+      assert_equal Post, @resultset.first.class
+      assert_equal Post, @resultset.last.class
+      assert @resultset.include? @post1
+      assert @resultset.include? @post3
+    end
+
+    test 'it shows the options and keys when objects are not loaded' do
+      @resultset = Ork::ResultSet.new(Post, @index, 'Post 2', max_results: 5)
+      expected = "#<Ork::ResultSet:{:max_results=>5} [\"#{@post2.id}\"]>"
+
+      assert_equal expected, @resultset.inspect
+    end
+
+    test 'it shows the options and objects when are loaded' do
+      @resultset = Ork::ResultSet.new(Post, @index, 'Post 2', max_results: 5)
+      expected = "#<Ork::ResultSet:{:max_results=>5} [#{@post2.inspect}]>"
+      @resultset.all
+
+      assert_equal expected, @resultset.inspect
+    end
+  end
+
+  context "*options*" do
+    setup do
+      @post3 = Post.create name: 'Post 1'
+      @index = Post.indices[:name]
+    end
+
+    context ':max_results' do
+      test 'it behaves like nil when its invalid' do
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 1', max_results: -5)
+
+        assert_equal nil, resultset.keys
+        assert_equal nil, resultset.all
+      end
+
+      test 'it returns an empty array when did not find any object' do
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 9', max_results: 5)
+
+        assert_equal [], resultset.keys
+        assert_equal [], resultset.all
+      end
+
+      test 'return no more than specified objects' do
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 1', max_results: 1)
+
+        assert_equal 3, Post.all.size
+        assert_equal 1, resultset.size
+        assert resultset.has_next_page?
+      end
+
+      test 'fetch the next page and return a new resultset' do
+        post4 = Post.create name: 'Post 1'
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 1', max_results: 2)
+        next_page = resultset.next_page
+
+        assert_equal 2, resultset.size
+        assert_equal 1, next_page.size
+        deny next_page.has_next_page?
+      end
+    end
+
+    context ':continuation' do
+      test 'it behaves like nil when its invalid' do
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 1', continuation: 'not_a_continuation')
+
+        assert_equal nil, resultset.keys
+        assert_equal nil, resultset.all
+      end
+
+      test 'get a specific page' do
+        post4 = Post.create name: 'Post 1'
+        resultset = Ork::ResultSet.new(Post, @index, 'Post 1', max_results: 2)
+        continuation = resultset.keys.continuation
+
+        last_page = Ork::ResultSet.new(Post, @index, 'Post 1', continuation: continuation)
+
+        assert_equal resultset.next_page.keys, last_page.keys
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ork
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Emiliano Mancuso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: toml-rb
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -62,19 +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/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/version.rb
 - lib/ork.rb
 - ork.gemspec
 - test/helper.rb
+- test/result_set_test.rb
 homepage: http://github.com/emancu/ork
 licenses:
 - MIT
@@ -95,9 +96,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Ruby modeling layer for Riak.
 test_files:
 - test/helper.rb
+- test/result_set_test.rb

data/lib/ork/version.rb

@@ -1,3 +0,0 @@
-class Ork
-  VERSION = "0.0.1"
-end