riak-client 2.0.0 → 2.1.0

data/lib/riak/errors/backend_creation.rb

@@ -0,0 +1,9 @@
+require 'riak/errors/base'
+
+module Riak
+  class BackendCreationError < Error
+    def initialize(backend)
+      super t('protobuffs_configuration', backend: backend)
+    end
+  end
+end

data/lib/riak/instrumentation.rb

@@ -0,0 +1,6 @@
+begin
+  require 'instrumentable'
+  require 'riak/client/instrumentation'
+rescue LoadError => e
+  # Go quietly into the night...(?)
+end

data/lib/riak/version.rb

@@ -1,3 +1,3 @@
 module Riak
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/riak-client.gemspec

@@ -15,12 +15,13 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   # Deps
-  gem.add_development_dependency "rspec", "~> 3.0.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
   gem.add_development_dependency 'rake', '~> 10.1.1'
   gem.add_development_dependency 'yard', '~> 0.8.7'
   gem.add_development_dependency 'kramdown', '~> 1.4'
   gem.add_development_dependency 'simplecov', '~> 0.8.2'
-  
+  gem.add_development_dependency "instrumentable", "~> 1.1.0"
+
   gem.add_runtime_dependency "i18n", ">=0.4.0"
   gem.add_runtime_dependency "beefcake", "~> 1.0"
   gem.add_runtime_dependency "multi_json", "~>1.0"

data/spec/integration/riak/counters_spec.rb

@@ -9,7 +9,7 @@ describe Riak::Counter, test_client: true, integration: true do
     @counter = Riak::Counter.new @bucket, 'counter_spec'
   end
 
-  it 'should read and update' do
+  it 'reads and updates' do
     initial = @counter.value
 
     @counter.increment

data/spec/integration/riak/crdt_spec.rb

@@ -5,17 +5,17 @@ describe "CRDTs", integration: true, test_client: true do
   let(:bucket) { random_bucket }
 
   describe 'configuration' do
-    it "should allow default bucket-types to be configured for each data type" do
+    it "allows default bucket-types to be configured for each data type" do
       expect(Riak::Crdt::Set.new(bucket, 'set').bucket_type).to eq 'sets'
-      
+
       Riak::Crdt::DEFAULT_BUCKET_TYPES[:set] = 'new_set_default'
       expect(Riak::Crdt::Set.new(bucket, 'set').bucket_type).to eq 'new_set_default'
 
       Riak::Crdt::DEFAULT_BUCKET_TYPES[:set] = 'sets'
       expect(Riak::Crdt::Set.new(bucket, 'set').bucket_type).to eq 'sets'
     end
-    
-    it "should allow override bucket-types for instances" do
+
+    it "allows override bucket-types for instances" do
       expect(Riak::Crdt::Set.new(bucket, 'set', 'other_bucket_type').bucket_type).to eq 'other_bucket_type'
     end
   end
@@ -48,10 +48,10 @@ describe "CRDTs", integration: true, test_client: true do
       end
     end
   end
-  
+
   describe 'counters' do
     subject { Riak::Crdt::Counter.new bucket, random_key }
-    it 'should allow straightforward counter ops' do
+    it 'allows straightforward counter ops' do
       start = subject.value
       subject.increment
       expect(subject.value).to eq(start + 1)
@@ -62,8 +62,8 @@ describe "CRDTs", integration: true, test_client: true do
       subject.decrement
       expect(subject.value).to eq(start)
     end
-    
-    it 'should allow batched counter ops' do
+
+    it 'allows batched counter ops' do
       start = subject.value
       subject.batch do |s|
         s.increment
@@ -73,12 +73,27 @@ describe "CRDTs", integration: true, test_client: true do
       end
       expect(subject.value).to eq(start + 5)
     end
+
+    it 'asks for and accepts a returned body by default' do
+      other = Riak::Crdt::Counter.new subject.bucket, subject.key
+
+      start = subject.value
+
+      expect(subject.value).to eq start
+
+      other.increment 10
+
+      subject.increment 1
+
+      expect(subject.dirty?).to_not be
+      expect(subject.value).to eq(start + 10 + 1)
+    end
   end
   describe 'sets' do
 
     subject { Riak::Crdt::Set.new bucket, random_key }
-    
-    it 'should allow straightforward set ops' do
+
+    it 'allows straightforward set ops' do
       start = subject.members
       addition = random_key
 
@@ -91,7 +106,7 @@ describe "CRDTs", integration: true, test_client: true do
       expect(subject.members).to_not include(addition)
       expect(subject.members).to eq(start)
     end
-    
+
     it 'lets Riak silently accept removals after reload' do
       addition = random_key
       subject.add addition
@@ -104,10 +119,10 @@ describe "CRDTs", integration: true, test_client: true do
       expect{ other.remove 'an element not in the set' }.to_not raise_error
     end
 
-    it 'should allow batched set ops' do
+    it 'allows batched set ops' do
       subject.add 'zero'
       subject.reload
-      
+
       subject.batch do |s|
         s.add 'first'
         s.remove 'zero'
@@ -115,11 +130,26 @@ describe "CRDTs", integration: true, test_client: true do
 
       expect(subject.members.to_a).to eq %w{first}
     end
+
+    it 'asks for and accepts a returned body by default' do
+      other = Riak::Crdt::Set.new subject.bucket, subject.key
+
+      expect(subject.include? 'coffee').to_not be
+      expect(other.include? 'coffee').to_not be
+
+      other.add 'coffee'
+      subject.add 'tea'
+
+      expect(subject.dirty?).to_not be
+
+      expect(other.include? 'coffee').to be
+      expect(subject.include? 'coffee').to be
+    end
   end
   describe 'maps' do
     subject { Riak::Crdt::Map.new bucket, random_key }
-    
-    it 'should allow straightforward map ops' do
+
+    it 'allows straightforward map ops' do
       subject.registers['first'] = 'hello'
       expect(subject.registers['first']).to eq('hello')
 
@@ -150,8 +180,8 @@ describe "CRDTs", integration: true, test_client: true do
         subject.flags.delete 'yes'
       end.to_not raise_error
     end
-    
-    it 'should allow batched map ops' do
+
+    it 'allows batched map ops' do
       subject.batch do |s|
         s.registers['condiment'] = 'ketchup'
         s.counters['banana'].increment
@@ -160,9 +190,24 @@ describe "CRDTs", integration: true, test_client: true do
       expect(subject.registers['condiment']).to eq 'ketchup'
       expect(subject.counters['banana'].value).to eq 1
     end
-    
+
+    it 'asks for and accepts a returned body by default' do
+      other = Riak::Crdt::Map.new subject.bucket, subject.key
+
+      expect(subject.sets['bees'].include? 'honey').to_not be
+      expect(other.sets['bees'].include? 'honey').to_not be
+
+      other.sets['bees'].add 'honey'
+      subject.counters['stings'].increment
+
+      expect(subject.dirty?).to_not be
+
+      expect(other.sets['bees'].include? 'honey').to be
+      expect(subject.sets['bees'].include? 'honey').to be
+    end
+
     describe 'containing a map' do
-      it 'should bubble straightforward map ops up' do
+      it 'bubbles straightforward map ops up' do
         street_map = subject.maps['street']
 
         street_map.registers['bird'] = 'avenue'
@@ -170,8 +215,8 @@ describe "CRDTs", integration: true, test_client: true do
 
         expect(subject.maps['street'])
       end
-      
-      it 'should include inner-map ops in the outer-map batch' do
+
+      it 'includes inner-map ops in the outer-map batch' do
         subject.batch do |m|
           m.maps['road'].counters['speedbumps'].increment 4
           m.maps['road'].sets['signs'].add 'yield'
@@ -183,7 +228,7 @@ describe "CRDTs", integration: true, test_client: true do
     end
 
     describe 'containing a register' do
-      it 'should bubble straightforward register ops up' do
+      it 'bubbles straightforward register ops up' do
         subject.registers['hkey_local_machine'] = 'registry'
 
         expect(subject.registers['hkey_local_machine']).to eq 'registry'
@@ -191,7 +236,7 @@ describe "CRDTs", integration: true, test_client: true do
     end
 
     describe 'containing a flag' do
-      it 'should bubble straightforward flag ops up' do
+      it 'bubbles straightforward flag ops up' do
         subject.flags['enable_magic'] = true
 
         expect(subject.flags['enable_magic']).to be

data/spec/integration/riak/protobuffs_backends_spec.rb

@@ -19,7 +19,7 @@ describe "Protocol Buffers", test_client: true do
         describe "searching yokozuna" do
           include_context "search corpus setup"
 
-          it 'should return documents with UTF-8 fields (GH #75)' do
+          it 'returns documents with UTF-8 fields (GH #75)' do
             utf8 = Encoding.find('UTF-8')
             results = @backend.search @search_bucket.name, 'fearless elephant rushed', df: 'text'
             results['docs'].each do |d|

data/spec/integration/riak/threading_spec.rb

@@ -62,7 +62,7 @@ describe "Multithreaded client", :test_client => true do
         @bucket = random_bucket 'threading'
       end
 
-      it 'should get in parallel' do
+      it 'gets in parallel' do
         data = "the gun is good"
         ro = @bucket.new('test')
         ro.content_type = "application/json"
@@ -76,7 +76,7 @@ describe "Multithreaded client", :test_client => true do
         end
       end
 
-      it 'should put in parallel' do
+      it 'puts in parallel' do
         data = "the tabernacle is indestructible and everlasting"
 
         n = 10
@@ -97,7 +97,7 @@ describe "Multithreaded client", :test_client => true do
       # This is a 1.0+ spec because putting with the same client ID
       # will not create siblings on 0.14 in the same way. This will
       # also likely fail for nodes with vnode_vclocks = false.
-      it 'should put conflicts in parallel' do
+      it 'puts conflicts in parallel' do
         @bucket.allow_mult = true
         expect(@bucket.allow_mult).to eq(true)
 
@@ -123,7 +123,7 @@ describe "Multithreaded client", :test_client => true do
         end.to_set).to eq((0...n).to_set)
       end
 
-      it 'should list-keys and get in parallel', :slow => true do
+      it 'lists-keys and gets in parallel', :slow => true do
         count = 100
         threads = 2
 

data/spec/integration/yokozuna/index_spec.rb

@@ -10,7 +10,7 @@ describe "Yokozuna", test_client: true, integration: true do
   end
 
   context "without any indexes" do
-    it "should allow index creation" do
+    it "allows index creation" do
       expect(@client.create_search_index(@index, "_yz_default", 3)).to eq(true)
     end
   end
@@ -21,16 +21,16 @@ describe "Yokozuna", test_client: true, integration: true do
       wait_until{ !@client.get_search_index(@index).nil? }
     end
 
-    it "should allow index inspection" do
+    it "allows index inspection" do
       expect(@client.get_search_index(@index).name).to eq(@index)
       expect{ @client.get_search_index("herp_derp") }.to raise_error(Riak::ProtobuffsFailedRequest)
     end
 
-    it "should have an index list" do
+    it "has an index list" do
       expect(@client.list_search_indexes.size).to be >= 1
     end
 
-    it "should associate a bucket with an index" do
+    it "associates a bucket with an index" do
       @bucket = Riak::Bucket.new(@client, @index)
       @bucket.props = {'search_index' => @index}
       @bucket = @client.bucket(@index)
@@ -45,7 +45,7 @@ describe "Yokozuna", test_client: true, integration: true do
         expect(@bucket.props).to include('search_index' => @index)
       end
 
-      it "should index on object writes" do
+      it "indexes on object writes" do
         object = @bucket.get_or_new("cat")
         object.raw_data = {"cat_s"=>"Lela"}.to_json
         object.content_type = 'application/json'

data/spec/integration/yokozuna/queries_spec.rb

@@ -31,72 +31,71 @@ describe "Yokozuna queries", test_client: true, integration: true do
       wait_until { @client.search(@index, "username_s:Z")['docs'].length > 0 }
     end
 
-    it "should produce results on single term queries" do
+    it "produces results on single term queries" do
       resp = @client.search(@index, "username_s:Z")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(1)
     end
 
-    it "should produce results on multiple term queries" do
+    it "produces results on multiple term queries" do
       resp = @client.search(@index, "username_s:(F OR H)")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(2)
     end
 
-    it "should produce results on queries with boolean logic" do
+    it "produces results on queries with boolean logic" do
       resp = @client.search(@index, "username_s:Z AND name_s:ryan")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(1)
     end
 
-    it "should produce results on range queries" do
+    it "produces results on range queries" do
       resp = @client.search(@index, "age_i:[30 TO 33]")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(2)
     end
 
-    it "should produce results on phrase queries" do
+    it "produces results on phrase queries" do
       resp = @client.search(@index, 'name_s:"bryan fink"')
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(1)
     end
 
-    it "should produce results on wildcard queries" do
+    it "produces results on wildcard queries" do
       resp = @client.search(@index, "name_s:*ryan*")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(2)
     end
 
-    it "should produce results on regexp queries" do
+    it "produces results on regexp queries" do
       resp = @client.search(@index, "name_s:/br.*/")
       expect(resp).to include('docs')
       expect(resp['docs'].size).to eq(2)
     end
 
-    # TODO: run this when pb utf8 works
-    it "should support utf8" do
+    it "supports utf8" do
       build_json_obj(@bucket, "ja", {"text_ja"=>"私はハイビスカスを食べるのが 大好き"})
-      # sleep 1.1  # pause for index commit to trigger
-      # resp = @client.search(@index, "text_ja:大好き")
-      # resp.should include('docs')
-      # resp['docs'].size.should == 1
+      sleep 1.1  # pause for index commit to trigger
+      resp = @client.search(@index, "text_ja:大好き")
+      expect(resp).to include('docs')
+      expect(resp['docs'].size).to eq 1
     end
 
     context "using parameters" do
-      it "should search one row" do
+      it "searches one row" do
         resp = @client.search(@index, "*:*", {:rows => 1})
         expect(resp).to include('docs')
         expect(resp['docs'].size).to eq(1)
       end
 
-      it "should search with df" do
+      it "searches with df" do
         resp = @client.search(@index, "Olive", {:rows => 1, :df => 'dog_ss'})
         expect(resp).to include('docs')
         expect(resp['docs'].size).to eq(1)
         resp['docs'].first['dog_ss']
       end
 
-      it "should produce top result on sort" do
+      it "produces top result on sort" do
         resp = @client.search(@index, "username_s:*", {:sort => "age_i asc"})
         expect(resp).to include('docs')
         expect(resp['docs'].first['age_i'].to_i).to eq(14)

data/spec/integration/yokozuna/schema_spec.rb

@@ -10,14 +10,14 @@ describe "Yokozuna", test_client: true, integration: true do
   end
 
   context 'with no schema' do
-    it 'should allow schema creation' do
+    it 'allows schema creation' do
       @client.create_search_schema(@schema, SCHEMA_CONTENT)
       wait_until{ !@client.get_search_schema(@schema).nil? }
       expect(@client.get_search_schema(@schema)).not_to be_nil
     end
   end
   context 'with a schema' do
-    it 'should have a readable schema' do
+    it 'has a readable schema' do
       @client.create_search_schema(@schema, SCHEMA_CONTENT)
       wait_until{ !@client.get_search_schema(@schema).nil? }
       schema_resp = @client.get_search_schema(@schema)

data/spec/riak/beefcake_protobuffs_backend/crdt_operator_spec.rb

@@ -17,7 +17,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       end
     end
     
-    it 'should serialize a counter operation into protobuffs' do
+    it 'serializes a counter operation into protobuffs' do
       result = subject.serialize operation
       
       expect(result).to be_a backend_class::DtOp
@@ -25,7 +25,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       expect(result.counter_op.increment).to eq increment
     end
 
-    it 'should serialize multiple counter operations into protobuffs' do
+    it 'serializes multiple counter operations into protobuffs' do
       result = subject.serialize [operation, operation]
 
       expect{result.encode}.to_not raise_error
@@ -49,7 +49,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       end
     end
 
-    it 'should serialize a set operation into protobuffs' do
+    it 'serializes a set operation into protobuffs' do
       result = subject.serialize operation
 
       expect{result.encode}.to_not raise_error
@@ -62,7 +62,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
   end
 
   describe 'operating on a map' do
-    it 'should serialize inner counter operations' do
+    it 'serializes inner counter operations' do
       counter_op = Riak::Crdt::Operation::Update.new.tap do |op|
         op.name = 'inner_counter'
         op.type = :counter
@@ -85,7 +85,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       expect(map_update.counter_op.increment).to eq 12345
     end
     
-    it 'should serialize inner flag operations' do
+    it 'serializes inner flag operations' do
       flag_op = Riak::Crdt::Operation::Update.new.tap do |op|
         op.name = 'inner_flag'
         op.type = :flag
@@ -127,7 +127,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       expect(map_update.flag_op).to eq backend_class::MapUpdate::FlagOp::DISABLE
     end
 
-    it 'should serialize inner register operations' do
+    it 'serializes inner register operations' do
       register_op = Riak::Crdt::Operation::Update.new.tap do |op|
         op.name = 'inner_register'
         op.type = :register
@@ -169,7 +169,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       expect(map_delete.type).to eq backend_class::MapField::MapFieldType::REGISTER
     end
     
-    it 'should serialize inner set operations' do
+    it 'serializes inner set operations' do
       set_op = Riak::Crdt::Operation::Update.new.tap do |op|
         op.name = 'inner_set'
         op.type = :set
@@ -191,7 +191,7 @@ describe Riak::Client::BeefcakeProtobuffsBackend::CrdtOperator do
       expect(map_update.set_op.adds).to eq 'added_member'
     end
     
-    it 'should serialize inner map operations' do
+    it 'serializes inner map operations' do
       register_op = Riak::Crdt::Operation::Update.new.tap do |op|
         op.name = 'inner_inner_register'
         op.type = :register