riak-record 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b00a705964f29ab77910a325b38f3bebb60043bd
-  data.tar.gz: b66150ea829d5c1c5d789a1f4e44c876217f05b5
+  metadata.gz: f9fc3f21c82333d4407dafb67bbb07f7541cae9a
+  data.tar.gz: d09d48df6dd73ba14739d052554e6cbde3aab138
 SHA512:
-  metadata.gz: c8cc3bdb8ab3e991d0414311d557db8155eb5f7a990d140990cc52daab2c9af729e16dfcc06fdea157ef32846622754881c5c36cd35dc89d4855d0b151cfde7a
-  data.tar.gz: b77edf9f28a069979e5c314fe8431088badf93a2acda46d8f1272ed7df4abc6f8ed4b2eb05e26dd0d5ea84826f656ada0a16eeee98460a01f7e43e496df6f065
+  metadata.gz: 6824a1da62874f8531ae438ff5584d130352cf10ba1c66eb555868ab9b90d3aff6f0a15a3a60dffd6954a2e99bdbe7294e43b9430c8a79fbf01ca1e92c3adc16
+  data.tar.gz: 1cd486fbfeda0b2fdedd06314c0045d733218acc91de0f1be09bd98329bc8f2c62fe237e430be0154256e9a959cd2c9076d608df8e1990703af49e69d2db1b13

data/README.md

@@ -27,6 +27,9 @@ end
 
 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.
 
 Post.find(["my-first-post","a-farewell-to-blogging"]) #> Array of Posts returned
 post = Post.find("my-first-post") #> Instance of Post
@@ -60,6 +63,7 @@ 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

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/lib/riak_record/base.rb

@@ -108,6 +108,26 @@ module RiakRecord
       @bucket ||= client.bucket(bucket_name)
     end
 
+    def self.finder
+      RiakRecord::Finder.new(self, :bucket => bucket_name)
+    end
+
+    def self.all
+      finder.all
+    end
+
+    def self.count
+      finder.count
+    end
+
+    def self.first(n = 1)
+      finder.first(n)
+    end
+
+    def self.page(page_number = 1, page_size = 100)
+      finder.page(page_number, page_size)
+    end
+
     def self.data_attributes(*attributes)
       attributes.map(&:to_sym).each do |method_name|
         define_method(method_name) do
@@ -149,7 +169,7 @@ module RiakRecord
     end
 
     def self.index_names
-      @index_names ||= {}
+      @index_names ||= { :bucket => '$bucket' }
     end
 
     def self.where(options)

data/lib/riak_record/finder.rb

@@ -90,6 +90,25 @@ 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
+
+      results = querier.values.compact.map{ |robject| @finder_class.new(robject) }
+      return results, querier.has_next_page?
+    end
+
   private
 
     def load_started?
@@ -120,7 +139,7 @@ module RiakRecord
         @querier = Riak::SecondaryIndex.new(@bucket, @index, @value, :max_results => @page_size)
       end
       @load_complete = !@querier.has_next_page?
-      new_objects = @querier.values.map{ |robject| @finder_class.new(robject) }
+      new_objects = @querier.values.compact.map{ |robject| @finder_class.new(robject) }
       @loaded_objects.concat(new_objects)
       new_objects
     end

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.4.1 ruby lib
+# stub: riak-record 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.4.1"
+  s.version = "0.5.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-03"
+  s.date = "2014-10-15"
   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 = [
@@ -34,7 +34,6 @@ Gem::Specification.new do |s|
     "lib/riak_record/base.rb",
     "lib/riak_record/callbacks.rb",
     "lib/riak_record/finder.rb",
-    "riak-record-0.1.0.gem",
     "riak-record.gemspec",
     "spec/riak_record/associations_spec.rb",
     "spec/riak_record/base_spec.rb",

data/spec/riak_record/base_spec.rb

@@ -234,6 +234,30 @@ describe RiakRecord::Base do
       end
     end
 
+    describe "finder" do
+      it "should return a finder for the bucket" do
+        expect( ExampleB.finder ).to be_an_instance_of(RiakRecord::Finder)
+      end
+
+      describe "uses of class finder" do
+        let!(:record1) { ExampleB.new("1").save }
+        let!(:record2) { ExampleB.new("2").save }
+
+        describe "all" do
+          it "should return all the objects in the bucket" do
+            expect(ExampleB.all).to eq [record1, record2]
+          end
+        end
+
+        describe "count" do
+          it "should count all objects in the bucket" do
+            sleep(2) # wait for riak to collect ghosts
+            expect(ExampleB.count).to eq(2)
+          end
+        end
+      end
+    end
+
     describe "data_attributes" do
       let(:riak_object) { Riak::RObject.new("obj").tap{|r| r.data = data } }
       let(:data) { {'attribute1' => "1"} }

data/spec/riak_record/finder_spec.rb

@@ -62,6 +62,27 @@ describe RiakRecord::Finder do
     end
   end
 
+  describe "page" do
+    it "should return a page of results" do
+      results, next_page = pop_finder.page(1,10)
+      expect(results.map(&:id).sort).to eq(pop_finder.first(10).map(&:id).sort)
+      expect(next_page).to eq(true)
+    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)
+    end
+
+    it "should return results and false on last page" do
+      results, next_page = pop_finder.page(2, 100)
+      expect(results).to_not be_empty
+      expect(next_page).to eq(false)
+    end
+
+  end
+
   describe "enumberable methods" do
     it "should yield once per block" do
       expect( pop_finder.all?{|o| o.category == ['pop']} ).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riak-record
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Robert Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -161,7 +161,6 @@ files:
 - lib/riak_record/base.rb
 - lib/riak_record/callbacks.rb
 - lib/riak_record/finder.rb
-- riak-record-0.1.0.gem
 - riak-record.gemspec
 - spec/riak_record/associations_spec.rb
 - spec/riak_record/base_spec.rb