riagent 0.0.2 → 0.0.3

data/test/integration/persistence_riak_dt_set_integration_test.rb

@@ -0,0 +1,44 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+require 'test_helper'
+
+describe "RiakDTSetStrategy persistence" do  
+  it "can add keys to its collection key list" do
+    assert Category.all.empty?
+    Category.persistence.add_key('new_key123')
+    Category.persistence.all_keys.must_equal ['new_key123']
+    Category.persistence.delete_key_list
+  end
+  
+  it "adding a document adds the key to the key list" do
+    assert Category.all.empty?
+    new_category = Category.new name: 'Test Category'
+    new_category.key = 'category123'
+    new_category.save
+    
+    collection_keys = Category.persistence.all_keys
+    collection_keys.must_include 'category123'
+    
+    new_category.destroy
+    collection_keys = Category.persistence.all_keys
+    collection_keys.must_be_empty
+  end
+end

data/test/integration/{persistence_riak_no_index_integration_test.rb → persistence_riak_kv_integration_test.rb}

@@ -28,11 +28,7 @@ describe "RiakNoIndexStrategy persistence" do
     generated_key.wont_be_empty
     assert user_pref.persisted?
     user_pref.source_object.must_be_kind_of Riak::RObject
-    
-    # Test all() / List Keys operation. (Obviously not recommended in production)
-    all_docs = UserPreference.all()
-    all_docs[0].must_be_kind_of UserPreference
-    
+
     # Now read the object back
     fetched_pref = UserPreference.find(generated_key)
     fetched_pref.must_be_kind_of UserPreference

data/test/seeds.rb

@@ -27,4 +27,10 @@ Riagent.load_config_file('test/config/riak.yml')
 Riagent.init_clients(:test)  # Set up the client for the test environment
 
 # Store the Solr indexing schema for the User model
-User.save_solr_schema()
+User.save_solr_schema()
+
+# Run these commands in the shell, in the riak/bin path:
+
+# Create a 'sets' bucket type. (The RiakDTSetStrategy uses it to store key lists, etc)
+# > riak-admin bucket-type create sets '{"props":{"datatype":"set"}}'
+# > riak-admin bucket-type activate sets

data/test/test_helper.rb

@@ -22,6 +22,7 @@ require 'minitest/autorun'
 require 'minitest-spec-context'
 require 'riagent'
 require 'examples/models/address_book'
+require 'examples/models/category'
 require 'examples/models/contact'
 require 'examples/models/user'
 require 'examples/models/user_preference'

data/test/unit/config_test.rb

@@ -40,6 +40,5 @@ describe "Riagent" do
   it "initializes a Riak ruby client" do
     # This should have been initialized from config file in test_helper.rb
     Riagent.riak_client.must_be_kind_of Riak::Client
-    Riagent.riak_client.protocol.must_equal 'pbc'
   end
 end

data/test/unit/persistence_riak_dt_set_test.rb

@@ -0,0 +1,78 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+require 'test_helper'
+
+describe "a Riagent::ActiveDocument that persists via RiakDTSetStrategy" do
+  it "#model persistence instance methods" do
+    category = Category.new
+    
+    category.must_respond_to :save
+    category.must_respond_to :save!
+    category.must_respond_to :update
+    category.must_respond_to :update_attributes  # alias for update()
+    category.must_respond_to :update!
+    category.must_respond_to :destroy
+  end
+  
+  it "#model persistence class methods" do
+    Category.persistence.must_respond_to :all
+    Category.persistence.must_respond_to :find
+  end
+  
+  it "keeps collection key lists in a Set type bucket" do
+    Category.persistence.key_lists_bucket.must_be_kind_of Riak::Bucket
+    
+    Category.persistence.key_list_set.must_be_kind_of Riak::Crdt::Set
+    Category.persistence.key_list_set.key.must_equal '_rg_keys_categories'
+  end
+  
+  it "keeps a list of keys in a Crdt::Set object" do
+    Category.persistence.key_list_set = MiniTest::Mock.new
+    # Collection retrieves a list of all keys as a contents (members()) of a set object
+    Category.persistence.key_list_set.expect :members, []
+    Category.persistence.all_keys
+    Category.persistence.key_list_set.verify
+    
+    Category.persistence.key_list_set = nil  # reset
+  end
+  
+  it "uses a multi-get (get_many()) to fetch all documents in a collection" do
+    # Mock the key list operation
+    mock_key_list = ['123']
+    Category.persistence.key_list_set = MiniTest::Mock.new
+    Category.persistence.key_list_set.expect :members, mock_key_list  # return mock key list
+    
+    # Now mock and verify the 'get all documents' operation
+    mock_document = Category.new
+    mock_document.key = '123'
+    Category.persistence.bucket = MiniTest::Mock.new
+    
+    # get_many() returns the document key/value hash
+    Category.persistence.bucket.expect :get_many, { '123' => mock_document }, [mock_key_list]
+    all_docs = Category.all
+    Category.persistence.bucket.verify
+    all_docs.must_equal [ mock_document ]  # all() returns just the documents
+    
+    # Reset
+    Category.persistence.key_list_set = nil
+    Category.persistence.bucket = nil
+  end
+end

data/test/unit/persistence_riak_kv_test.rb

@@ -0,0 +1,41 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+require 'test_helper'
+
+describe "a Riagent::ActiveDocument that persists via RiakKVStrategy" do
+  it "#model persistence instance methods" do
+    user_pref = UserPreference.new
+    
+    # Adding the line +collection_type :riak_no_index+ to a model 
+    # exposes the usual array of persistence methods
+    user_pref.must_respond_to :save
+    user_pref.must_respond_to :save!
+    user_pref.must_respond_to :update
+    user_pref.must_respond_to :update_attributes  # alias for update()
+    user_pref.must_respond_to :update!
+    user_pref.must_respond_to :destroy
+  end
+  
+  it "#model persistence class methods" do
+    UserPreference.persistence.wont_respond_to :all
+    UserPreference.persistence.must_respond_to :find
+  end
+end

data/test/unit/persistence_riak_no_index_test.rb

@@ -22,20 +22,18 @@ require 'test_helper'
 
 describe "a Riagent::ActiveDocument that persists via RiakNoIndex strategy" do
   it "#model persistence instance methods" do
-    user_pref = UserPreference.new
+    contact = Contact.new
     
-    # Adding the line +collection_type :riak_no_index+ to a model 
-    # exposes the usual array of persistence methods
-    user_pref.must_respond_to :save
-    user_pref.must_respond_to :save!
-    user_pref.must_respond_to :update
-    user_pref.must_respond_to :update_attributes  # alias for update()
-    user_pref.must_respond_to :update!
-    user_pref.must_respond_to :destroy
+    contact.must_respond_to :save
+    contact.must_respond_to :save!
+    contact.must_respond_to :update
+    contact.must_respond_to :update_attributes  # alias for update()
+    contact.must_respond_to :update!
+    contact.must_respond_to :destroy
   end
   
   it "#model persistence class methods" do
-    UserPreference.must_respond_to :all
-    UserPreference.must_respond_to :find
+    Contact.persistence.must_respond_to :all
+    Contact.persistence.must_respond_to :find
   end
 end

data/test/unit/persistence_test.rb

@@ -41,11 +41,11 @@ describe "a Riagent::ActiveDocument has Persistence options" do
     assert User.persistence.allows_query?
   end
 
-  it "#:riak_no_index collection type" do
-    # Adding the line +collection_type :riak_no_index+ to a model
+  it "#:riak_kv collection type" do
+    # Adding the line +collection_type :riak_kv+ to a model
     # means that it will be persisted as a Riak object with no indices (k/v operations only)
-    UserPreference.get_collection_type.must_equal :riak_no_index
-    UserPreference.persistence.must_be_kind_of Riagent::Persistence::RiakNoIndexStrategy
+    UserPreference.get_collection_type.must_equal :riak_kv
+    UserPreference.persistence.class.must_equal Riagent::Persistence::RiakKVStrategy
 
     # It also grants access to a RiakJson::Client instance, to the model class
     UserPreference.persistence.client.must_be_kind_of Riak::Client
@@ -53,8 +53,19 @@ describe "a Riagent::ActiveDocument has Persistence options" do
     UserPreference.persistence.collection_name.must_equal 'user_preferences'
     UserPreference.persistence.bucket.must_be_kind_of Riak::Bucket
 
-    refute UserPreference.persistence.allows_query?, "RiakNoIndex strategy does not allow querying"
-    lambda { UserPreference.where({}) }.must_raise NotImplementedError, "RiakNoIndex strategy does not support querying"
-    lambda { UserPreference.find_one({}) }.must_raise NotImplementedError, "RiakNoIndex strategy does not support querying"
+    refute UserPreference.persistence.allows_query?, "RiakKVStrategy strategy does not allow querying"
+    lambda { UserPreference.where({}) }.must_raise NotImplementedError, "RiakKVStrategy strategy does not support querying"
+    lambda { UserPreference.find_one({}) }.must_raise NotImplementedError, "RiakKVStrategy strategy does not support querying"
   end
+  
+  it "#list_keys_using: :streaming_list_keys" do
+    Contact.get_collection_type.must_equal :riak_kv
+    Contact.persistence.class.must_equal Riagent::Persistence::RiakNoIndexStrategy
+  end
+  
+  it "#list_keys_using: :riak_dt_set" do
+    Category.get_collection_type.must_equal :riak_kv
+    Category.persistence.class.must_equal Riagent::Persistence::RiakDTSetStrategy
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riagent
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dmitri Zagidulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak_json
@@ -28,16 +28,16 @@ dependencies:
   name: riak-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: riagent-document
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
@@ -136,8 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides Ruby on Rails integration for RiakJson (Riak + Solr document
-  store API)
+description: Provides Ruby on Rails integration for the Riak KV NoSQL database (plus
+  Solr search)
 email:
 - dzagidulin@gmail.com
 executables: []
@@ -160,7 +160,9 @@ files:
 - lib/riagent/errors.rb
 - lib/riagent/persistence.rb
 - lib/riagent/persistence/persistence_strategy.rb
+- lib/riagent/persistence/riak_dt_set_strategy.rb
 - lib/riagent/persistence/riak_json_strategy.rb
+- lib/riagent/persistence/riak_kv_strategy.rb
 - lib/riagent/persistence/riak_no_index_strategy.rb
 - lib/riagent/railtie.rb
 - lib/riagent/search_schema.rb
@@ -169,11 +171,13 @@ files:
 - test/config/riak.yml.example
 - test/examples/models/address_book.rb
 - test/examples/models/blog_post.rb
+- test/examples/models/category.rb
 - test/examples/models/contact.rb
 - test/examples/models/user.rb
 - test/examples/models/user_preference.rb
+- test/integration/persistence_riak_dt_set_integration_test.rb
 - test/integration/persistence_riak_json_integration_test.rb
-- test/integration/persistence_riak_no_index_integration_test.rb
+- test/integration/persistence_riak_kv_integration_test.rb
 - test/seeds.rb
 - test/test_helper.rb
 - test/unit/active_document_test.rb
@@ -182,7 +186,9 @@ files:
 - test/unit/associations_has_one_test.rb
 - test/unit/config_test.rb
 - test/unit/embedded_test.rb
+- test/unit/persistence_riak_dt_set_test.rb
 - test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_riak_kv_test.rb
 - test/unit/persistence_riak_no_index_test.rb
 - test/unit/persistence_test.rb
 - test/unit/search_schema_test.rb
@@ -207,19 +213,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Rails integration for RiakJson document store
+summary: Rails integration for the Riak KV NoSQL database
 test_files:
 - test/config/riak.yml.example
 - test/examples/models/address_book.rb
 - test/examples/models/blog_post.rb
+- test/examples/models/category.rb
 - test/examples/models/contact.rb
 - test/examples/models/user.rb
 - test/examples/models/user_preference.rb
+- test/integration/persistence_riak_dt_set_integration_test.rb
 - test/integration/persistence_riak_json_integration_test.rb
-- test/integration/persistence_riak_no_index_integration_test.rb
+- test/integration/persistence_riak_kv_integration_test.rb
 - test/seeds.rb
 - test/test_helper.rb
 - test/unit/active_document_test.rb
@@ -228,7 +236,9 @@ test_files:
 - test/unit/associations_has_one_test.rb
 - test/unit/config_test.rb
 - test/unit/embedded_test.rb
+- test/unit/persistence_riak_dt_set_test.rb
 - test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_riak_kv_test.rb
 - test/unit/persistence_riak_no_index_test.rb
 - test/unit/persistence_test.rb
 - test/unit/search_schema_test.rb