riak-record 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 848a3c84ab9c29295f67aeb95fadb9588644ff05
-  data.tar.gz: 9c339a757a57412bccad2a9a6efbfcd12de4ca57
+  metadata.gz: b2627d29a43209e31719b15501c12d2f272fc6d0
+  data.tar.gz: 3821d3333a91374965a04717b18e93b9b6f5d3ee
 SHA512:
-  metadata.gz: f1e8c13cdf5b5ca515ce38a26637760ed9e1840eec464d5e6b66e5d1505a613155677ee12ae0bcd399359da1419202d99570c809a276ff47090295b58effe951
-  data.tar.gz: d52c6e5cedd503f9ef692988f0ad72a4616598c4b3488e95c839fd82800359942c070a7aafa66bab3c2f46f842b681ad8aeabcffd39b7473e024d8dffadf7a10
+  metadata.gz: 4346ef7b3b5869b5ad73d24be6b6b7c15f37ea46a7fcfd8dce89f95ee4baeaf8a9aa83d23916636dccb98694a0a9131b9617d0d3ff6dcd209817020ca9b68062
+  data.tar.gz: 6ede597c3201ea403b23fff5c0d3074eecb013a3827dc188714cd2d63347eab8cfca5a741d3ca4b6f0c8d368063aa10d23e5da7dd91e1602a108388653935972

data/README.md

@@ -29,7 +29,9 @@ Post.client #> instance of Riak::Client
 Post.bucket #> instance of Riak::Bucket named "staging:posts"
 Post.all #> [] uses the special $bucket secondary index
 Post.count #> 0 also uses the special $bucket index
-records, next_page = Post.page(2, 100) #> returns records 101-200 using the $bucket index.
+
+records, continuation_token = Post.page() #> returns records 1-100 using the $bucket index.
+records2, continuation_token = Post.page(continuation_token) #> returns records 101-200
 
 Post.find(["my-first-post","a-farewell-to-blogging"]) #> Array of Posts returned
 post = Post.find("my-first-post") #> Instance of Post
@@ -63,13 +65,20 @@ RiakRecord::Finder provides find objects by indexes. Results are loaded in batch
 
 ```ruby
 finder = Post.where(:category => 'ruby') #> Instance of RiakRecord::Finder
-finder.page(1) # returns the first 100 records. Note it has to stream in previous pages
 finder.count #> 1
 finder.any? #> true
 finder.any?{|o| o.category == 'php'} #> false
 finder.none? #> false
 finder.each{|e| ... } #> supports all enumerable methods
-finder.count_by(:author_id) #> {"1" => 1}
+finder.count_by(:author_id) #> {"1" => 1}. Works with declared data attributes and indexes
+finder.pluck(:author_id) #> [1,2,3]. Works with declared data attributes and indexes
+```
+
+#### Pagination
+
+```ruby
+records, contination_token = finder.page() # returns the first 100 records.
+records2, contination_token = finder.page(contination_token, 10) # returns records 101-10
 ```
 
 ### RiakRecord::Associations

data/TODO.md

@@ -2,6 +2,8 @@
 
 * RiakRecord::Base
   * id_generator
+  * don't delegate count to map_reduce_count
+  * reload should reset associations
 * Document methods in classes
 * Validations support
   * Validate key is unique (bucket.get_or_new)

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/riak_record/finder.rb

@@ -40,12 +40,12 @@ module RiakRecord
 
     def first(n=nil)
       if n
-        until @load_complete || n <= @loaded_objects.count
-          load_next_page
+        unless @load_complete || @loaded_objects.count >= n
+          load_next_page(n-@loaded_objects.count)
         end
         @loaded_objects.first(n)
       else
-        load_next_page unless load_started?
+        load_next_page(1) unless load_started?
         @loaded_objects.first
       end
     end
@@ -65,7 +65,7 @@ module RiakRecord
       if block_given?
         !any?(&block)
       else
-        load_next_page unless load_started?
+        load_next_page(1) unless load_started?
         @loaded_objects.count.zero?
       end
     end
@@ -90,23 +90,20 @@ module RiakRecord
       results
     end
 
-    def page(page_number = 1, page_size = 100)
-      current_page = 1
-      page_number = page_number.to_i
-      page_number = 1 if page_number < 1
-
-      querier = Riak::SecondaryIndex.new(@bucket, @index, @value, :max_results => page_size)
-      while current_page < page_number
-        if querier.has_next_page?
-          querier = querier.next_page
-          current_page = current_page + 1
-        else
-          return [], false # no results, no next page
-        end
-      end
-
+    def page(continuation = nil, page_size = 100)
+      options = { :max_results => page_size }
+      options[:continuation] = continuation if continuation.present?
+      querier = Riak::SecondaryIndex.new(@bucket, @index, @value, options)
       results = querier.values.compact.map{ |robject| @finder_class.new(robject) }
-      return results, querier.has_next_page?
+      return results, querier.keys.continuation
+    end
+
+    def pluck_by_map_reduce(attribute)
+      pluck_by_index = @finder_class.index_names[attribute.to_sym].present?
+      parsed_attribute = pluck_by_index ? "v.values[0].metadata.index.#{@finder_class.index_names[attribute.to_sym]}" : "JSON.parse(v.values[0].data).#{attribute}"
+      Riak::MapReduce.new(@finder_class.client).
+        index(@bucket, @index, @value).
+        map("function(v){ return [#{parsed_attribute}] }", :keep => true).run
     end
 
   private
@@ -131,12 +128,12 @@ module RiakRecord
         reduce("Riak.reduceSum", :keep => true).run.first
     end
 
-    def load_next_page
+    def load_next_page(page_size = @page_size)
       return if @load_complete
       if @querier
         @querier = @querier.next_page
       else
-        @querier = Riak::SecondaryIndex.new(@bucket, @index, @value, :max_results => @page_size)
+        @querier = Riak::SecondaryIndex.new(@bucket, @index, @value, :max_results => page_size)
       end
       @load_complete = !@querier.has_next_page?
       new_objects = @querier.values.compact.map{ |robject| @finder_class.new(robject) }

data/riak-record.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: riak-record 0.5.1 ruby lib
+# stub: riak-record 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Robert Graff"]
-  s.date = "2014-10-16"
+  s.date = "2014-10-22"
   s.description = "RiakRecord is a thin and immature wrapper around riak-ruby-client. It creates a bucket for\n  each class, provides a simple finder, and creates attribute reader."
   s.email = "robert_graff@yahoo.com"
   s.extra_rdoc_files = [

data/spec/riak_record/finder_spec.rb

@@ -64,21 +64,23 @@ describe RiakRecord::Finder do
 
   describe "page" do
     it "should return a page of results" do
-      results, next_page = pop_finder.page(1,10)
+      results, continuation = pop_finder.page(nil,10)
       expect(results.map(&:id).sort).to eq(pop_finder.first(10).map(&:id).sort)
-      expect(next_page).to eq(true)
+      expect(continuation).to be_present
     end
 
-    it "should return an empty result when the page is to big" do
-      results, next_page = pop_finder.page(100,10)
-      expect(results).to be_empty
-      expect(next_page).to eq(false)
+    it "should return the next page with a contination" do
+      results1, continuation1 = pop_finder.page(nil,10)
+      results, continuation = pop_finder.page(continuation1,10)
+
+      expect(results.map(&:id).sort).to eq(pop_finder.to_a.slice(10,10).map(&:id).sort)
+      expect(continuation).to be_present
     end
 
     it "should return results and false on last page" do
-      results, next_page = pop_finder.page(2, 100)
+      results, continuation = pop_finder.page(nil, 500)
       expect(results).to_not be_empty
-      expect(next_page).to eq(false)
+      expect(continuation).to_not be_present
     end
 
   end
@@ -148,6 +150,16 @@ describe RiakRecord::Finder do
     end
   end
 
+  describe "pluck_by_map_reduce(attribute)" do
+    it "should just return the plucked attributes" do
+      expect(pop_finder.pluck_by_map_reduce(:name).sort).to eq(@pop_artists.map(&:name).sort)
+    end
+
+    it "should pluck indexes too" do
+      expect(pop_finder.pluck_by_map_reduce(:sales).sort).to eq(@pop_artists.map(&:sales).map(&:first).sort)
+    end
+  end
+
   describe "count_by(attribute)" do
     let(:bin_number_counts){
       { "0" => 15, "1" => 16, "2" => 16, "3" => 16, "4" => 16, "5" => 16, "6" => 15, "7" => 15, "8" => 15, "9" => 15}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riak-record
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Robert Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client