riak-record 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8285191a3c74c9168e390e57fad2f962d955b000
-  data.tar.gz: ee1a2c6137828311072a5d7935f8a72765951709
+  metadata.gz: 2b0421363c8c40b73b226f4df90f9e45edb430ee
+  data.tar.gz: c17740eb834798087876bfbae9002ecf047c5f82
 SHA512:
-  metadata.gz: 3e73ef5633ff909a9751fe768bdf0b5732284e1b7180c13b58f46463245d4cb6b3cb321e3e15a0a60452e5cd4f8482b954762b43b075a389350e0c5d61551b8c
-  data.tar.gz: 8b350e7afbc082ea3941ceaf1cc7b8c6be282448fa845e77519e2d1dac29cb06d81ff64ae193e1064c98dcc99b8d5e44133e7837f93d2244c2118bf97ca34e99
+  metadata.gz: c1fe0f01dd8bc344ff488db29d5ed3348b0720633517cdbad944be68cbc15f8d7912419351a9902e11f29353349f579a6559220286167a0d9bef465145f42637
+  data.tar.gz: 7057ecd22fd9bae185c3d013b37c2a3ecbb469e0765009edfb6ed9f06add77148d9ea3a721f800b74936300b6faea2998fb510cf988aee73255c4f3bfc2761bd

data/Guardfile

@@ -6,6 +6,7 @@ end
 
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/riak_record/finder/.*$}) { "spec/riak_record/finder_spec.rb"}
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -145,6 +145,15 @@ User.find(1).posts #> create RiakRecord::Finder(Post, :user_id => 1)
 User.find(1).author #> Author.find(self.author_id)
 ```
 
+## Speeding up count, pluck and count_by methods using erlang map reduce functions
+
+Compile riak_record_kv_mapreduce.erl and [install it into your riak nodes](http://docs.basho.com/riak/latest/ops/advanced/install-custom-code/).
+
+```ruby
+RiakRecord::Base.finder_class = RiakRecord::Finder::ErlangEnhanced
+```
+
+
 ## Contributing to riak-record
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.7.0

data/lib/riak_record/base.rb

@@ -108,8 +108,16 @@ module RiakRecord
       @bucket ||= client.bucket(bucket_name)
     end
 
+    def self.finder_class=(klass)
+      @@finder_class = klass
+    end
+
+    def self.finder_class
+      @@finder_class ||= RiakRecord::Finder::Basic
+    end
+
     def self.finder
-      RiakRecord::Finder.new(self, :bucket => bucket_name)
+      finder_class.new(self, :bucket => bucket_name)
     end
 
     def self.all
@@ -124,6 +132,7 @@ module RiakRecord
       finder.first(n)
     end
 
+    # TODO: this is broke
     def self.page(page_number = 1, page_size = 100)
       finder.page(page_number, page_size)
     end
@@ -173,7 +182,7 @@ module RiakRecord
     end
 
     def self.where(options)
-      RiakRecord::Finder.new(self, options)
+      RiakRecord::Finder::Basic.new(self, options)
     end
 
     def self.find(key_or_keys)

data/lib/riak_record/{finder.rb → finder/basic.rb}

@@ -1,5 +1,6 @@
 module RiakRecord
-  class Finder
+module Finder
+  class Basic
     include Enumerable
 
     def initialize(finder_class, conditions)
@@ -127,7 +128,7 @@ module RiakRecord
       Riak::MapReduce.new(@finder_class.client).
         index(@bucket, @index, @value).
         map("function(v){ return [1] }", :keep => false).
-        reduce("Riak.reduceSum", :keep => true).run.first
+        reduce(['riak_kv_mapreduce','reduce_sum'], :keep => true).run.first
     end
 
     def load_next_page(page_size = @page_size)
@@ -145,3 +146,4 @@ module RiakRecord
 
   end
 end
+end

data/lib/riak_record/finder/erlang_enhanced.rb

@@ -0,0 +1,38 @@
+module RiakRecord
+  class Finder::ErlangEnhanced < Finder::Basic
+
+  def pluck_by_map_reduce(attribute, timeout = nil)
+    map_method, map_arg = map_method_for_attribute(attribute, "map_pluck_index", "map_pluck_value")
+    mr = Riak::MapReduce.new(@finder_class.client).
+      index(@bucket, @index, @value).
+      map(['riak_record_kv_mapreduce', map_method], :keep => true, :arg => [map_arg])
+    mr.timeout = timeout if timeout.present?
+    mr.run
+  end
+
+private
+
+  def map_method_for_attribute(attribute, index_method, value_method)
+    count_by_index = @finder_class.index_names[attribute.to_sym].present?
+    map_method = count_by_index ? index_method : value_method
+    map_arg = count_by_index ? @finder_class.index_names[attribute.to_sym] : attribute
+    [map_method, map_arg]
+  end
+
+  def count_by_map_reduce(attribute)
+    map_method, map_arg = map_method_for_attribute(attribute, "map_count_by_index", "map_count_by_value")
+    Riak::MapReduce.new(@finder_class.client).
+      index(@bucket, @index, @value).
+      map(['riak_record_kv_mapreduce', map_method], :keep => false, :arg => [map_arg]).
+      reduce(['riak_record_kv_mapreduce', 'reduce_count_by'], :keep => true).run.first
+    end
+  end
+
+  def count_map_reduce
+    Riak::MapReduce.new(@finder_class.client).
+      index(@bucket, @index, @value).
+      map(['riak_record_kv_mapreduce', 'map_count_found'], :keep => false).
+      reduce(['riak_kv_mapreduce','reduce_sum'], :keep => true).run.first
+  end
+
+end

data/lib/riak_record.rb

@@ -1,6 +1,7 @@
 require 'riak_record/callbacks'
 require 'riak_record/associations'
-require 'riak_record/finder'
+require 'riak_record/finder/basic'
+require 'riak_record/finder/erlang_enhanced'
 require 'riak_record/base'
 
 module RiakRecord

data/map_reduce/riak_record_kv_mapreduce.erl

@@ -0,0 +1,63 @@
+%% @doc Riak Record's map/reduce phases
+-module(riak_record_kv_mapreduce).
+
+-export([map_count_found/3,
+         map_pluck_value/3,
+         map_pluck_index/3,
+         map_count_by_value/3,
+         map_count_by_index/3,
+         reduce_count_by/2]).
+
+
+
+%% @doc map phase function that returns the count of objects.
+map_count_found({error, notfound}, _, _) ->
+  [0];
+map_count_found(_, _, _) ->
+  [1].
+
+%% @doc map phase function plucks value specified by Arg from the
+%% JSON encoded RiakObject's value.
+map_pluck_value({error, notfound}, _, _) ->
+  [];
+map_pluck_value(RiakObject, _Props, Arg) ->
+  RiakValue = riak_object:get_value(RiakObject),
+  {struct, JsonData} = mochijson2:decode(RiakValue),
+  Value = proplists:get_value(list_to_binary(Arg), JsonData),
+  [Value].
+
+%% @doc map phase function plucks values from the indexes speicied
+%% by Arg from the RiakObject's metadata.
+map_pluck_index({error, notfound}, _, _) ->
+  [];
+map_pluck_index(RiakObject, _Props, Arg) ->
+  Meta = riak_object:get_metadata(RiakObject),
+  Indexes = dict:fetch(<<"index">>, Meta),
+  proplists:get_all_values(list_to_binary(Arg), Indexes).
+
+
+%% dry it up!
+map_count_by_value({error, notfound}, _, _) ->
+  [{struct, []}];
+map_count_by_value(RiakObject, _Props, Arg) ->
+  RiakValue = riak_object:get_value(RiakObject),
+  {struct, JsonData} = mochijson2:decode(RiakValue),
+  Value = proplists:get_value(list_to_binary(Arg), JsonData),
+  [{struct, [{Value,1}]}].
+
+map_count_by_index({error, notfound}, _, _) ->
+  [{struct, []}];
+map_count_by_index(RiakObject, _Props, Arg) ->
+  Meta = riak_object:get_metadata(RiakObject),
+  Indexes = dict:fetch(<<"index">>, Meta),
+  IndexValues = proplists:get_all_values(list_to_binary(Arg), Indexes),
+  ToTuple = fun(V) -> {V, 1} end,
+  [{struct, lists:map(ToTuple, IndexValues)}].
+
+reduce_count_by(Values, _Arg) ->
+  Sum = fun(_,V1,V2) -> V1 + V2 end,
+  Merge = fun(D1,D2) -> orddict:merge(Sum,D1,D2) end,
+  ToList = fun(X) -> {struct, L} = X, L end,
+  Lists = lists:map(ToList, Values),
+  List = lists:foldl(Merge, [], Lists),
+  [{struct, List}].

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.6.2 ruby lib
+# stub: riak-record 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.6.2"
+  s.version = "0.7.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-23"
+  s.date = "2014-10-27"
   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 = [
@@ -33,8 +33,9 @@ Gem::Specification.new do |s|
     "lib/riak_record/associations.rb",
     "lib/riak_record/base.rb",
     "lib/riak_record/callbacks.rb",
-    "lib/riak_record/finder.rb",
-    "riak-record-0.5.0.gem",
+    "lib/riak_record/finder/basic.rb",
+    "lib/riak_record/finder/erlang_enhanced.rb",
+    "map_reduce/riak_record_kv_mapreduce.erl",
     "riak-record.gemspec",
     "spec/riak_record/associations_spec.rb",
     "spec/riak_record/base_spec.rb",

data/spec/riak_record/associations_spec.rb

@@ -124,7 +124,7 @@ describe RiakRecord::Associations do
       @comment_for_other_post.save
     end
     it "should return a RiakRecord::Finder" do
-      expect(post.comments).to be_an_instance_of(RiakRecord::Finder)
+      expect(post.comments).to be_an_instance_of(RiakRecord::Finder::Basic)
     end
 
     it "should include the associated records" do

data/spec/riak_record/base_spec.rb

@@ -239,13 +239,13 @@ describe RiakRecord::Base do
 
     describe "where" do
       it "should return an instance of RiakRecord::Finder" do
-        expect( ExampleA.where(:index1 => 'hello') ).to be_an_instance_of(RiakRecord::Finder)
+        expect( ExampleA.where(:index1 => 'hello') ).to be_an_instance_of(RiakRecord::Finder::Basic)
       end
     end
 
     describe "finder" do
       it "should return a finder for the bucket" do
-        expect( ExampleB.finder ).to be_an_instance_of(RiakRecord::Finder)
+        expect( ExampleB.finder ).to be_an_instance_of(RiakRecord::Finder::Basic)
       end
 
       describe "uses of class finder" do
@@ -254,7 +254,7 @@ describe RiakRecord::Base do
 
         describe "all" do
           it "should return all the objects in the bucket" do
-            expect(ExampleB.all).to eq [record1, record2]
+            expect(ExampleB.all).to include(record1, record2)
           end
         end
 

data/spec/riak_record/finder_spec.rb

@@ -8,8 +8,10 @@ class Artist < RiakRecord::Base
   index_bin_attributes :category
 end
 
-describe RiakRecord::Finder do
+RSpec.shared_examples "riak_record_finder" do
   before :each do
+    RiakRecord::Base.finder_class = described_class
+
     @pop_artists = Array(1..155).map do |c|
       a = Artist.new(c.to_s)
       a.name = "Pop Artist #{c}"
@@ -29,8 +31,8 @@ describe RiakRecord::Finder do
     end
   end
 
-  let(:pop_finder){ RiakRecord::Finder.new(Artist, :category => 'pop') }
-  let(:country_finder){ RiakRecord::Finder.new(Artist, :category => 'country') }
+  let(:pop_finder){ described_class.new(Artist, :category => 'pop') }
+  let(:country_finder){ described_class.new(Artist, :category => 'country') }
 
   describe "all" do
 
@@ -197,3 +199,11 @@ describe RiakRecord::Finder do
   end
 
 end
+
+describe RiakRecord::Finder::Basic do
+  it_behaves_like "riak_record_finder"
+end
+
+describe RiakRecord::Finder::ErlangEnhanced do
+  it_behaves_like "riak_record_finder"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riak-record
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Robert Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -160,8 +160,9 @@ files:
 - lib/riak_record/associations.rb
 - lib/riak_record/base.rb
 - lib/riak_record/callbacks.rb
-- lib/riak_record/finder.rb
-- riak-record-0.5.0.gem
+- lib/riak_record/finder/basic.rb
+- lib/riak_record/finder/erlang_enhanced.rb
+- map_reduce/riak_record_kv_mapreduce.erl
 - riak-record.gemspec
 - spec/riak_record/associations_spec.rb
 - spec/riak_record/base_spec.rb