riagent 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eadd9aec51f179844d1ac1a5ff54826ba59ad35
-  data.tar.gz: 4cbaed26f3b6f06e43c0405f401b69835f10ca81
+  metadata.gz: 189f3608c683deba5f7d5396006eca9567270aef
+  data.tar.gz: 92e10aef1130cbf20a18f5796659f1ea7e6ced30
 SHA512:
-  metadata.gz: b31c273dbcc22ad47467ce2f7d5875ce6b04be513124b38973695130266341ed4e8440bc786d34f7e9d044271b0f77a46abc50b05f4f0155086765cfbe852bac
-  data.tar.gz: e59f9bdd5a8e332de5e56c49e3565c772e485fbff10e19ae3f96fd1ac79e0d6ad0e4436d1c041290c471fe95ffe50c4216710d6bc8f86a187fa5e743966e0acf
+  metadata.gz: c6246e9dfff27679cd03f175fd0500fe67f8ad7b410eff03a3b421dccb5b589cf5554464ada2dffa5e3f8828657c1bc36ace4bc431c7a91360325672865fb7d8
+  data.tar.gz: a028746246a003269eaf376248b64713415e25d1279a1f6c1ed2dfc6ca6a4d6dd2b52c6ec55a53e382d98540b747c30aaa0c296b21bf5fdcd0580633b5733c98

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riagent (0.0.1)
+    riagent (0.0.2)
       activemodel (~> 4.0)
       activesupport (~> 4.0)
       riagent-document
@@ -11,56 +11,56 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.0.2)
-      activesupport (= 4.0.2)
+    activemodel (4.0.5)
+      activesupport (= 4.0.5)
       builder (~> 3.1.0)
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    atomic (1.1.14)
-    axiom-types (0.0.5)
-      descendants_tracker (~> 0.0.1)
-      ice_nine (~> 0.9)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     beefcake (0.3.7)
     builder (3.1.4)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    descendants_tracker (0.0.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     equalizer (0.0.9)
     i18n (0.6.9)
     ice_nine (0.11.0)
     innertube (1.0.2)
     json (1.8.1)
-    mime-types (2.1)
+    mime-types (2.3)
     minitest (4.7.5)
     minitest-spec-context (0.0.3)
-    multi_json (1.8.4)
-    rake (10.1.1)
+    multi_json (1.10.1)
+    rake (10.3.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     riagent-document (0.0.1)
       activesupport (~> 4.0)
       virtus
-    riak-client (1.4.3)
+    riak-client (1.4.4.1)
       beefcake (~> 0.3.7)
       builder (>= 2.1.2)
       i18n (>= 0.4.0)
       innertube (~> 1.0.2)
       multi_json (~> 1.0)
-    riak_json (0.0.2)
+    riak_json (0.0.4)
       json
       rest-client
-    thread_safe (0.1.3)
-      atomic
-    tzinfo (0.3.38)
-    virtus (1.0.1)
-      axiom-types (~> 0.0.5)
+    thread_safe (0.3.4)
+    tzinfo (0.3.39)
+    virtus (1.0.2)
+      axiom-types (~> 0.1)
       coercible (~> 1.0)
-      descendants_tracker (~> 0.0.1)
-      equalizer (~> 0.0.7)
+      descendants_tracker (~> 0.0.3)
+      equalizer (~> 0.0.9)
 
 PLATFORMS
   ruby

data/lib/riagent/active_document.rb

@@ -39,6 +39,8 @@ module Riagent
       include Riagent::Persistence
       include Riagent::Associations
       extend Riagent::SearchSchema
+      
+      attr_accessor :source_object
     end
     
     module ClassMethods

data/lib/riagent/configuration.rb

@@ -19,6 +19,7 @@
 ## -------------------------------------------------------------------
 
 require "active_support/concern"
+require "riak"
 
 module Riagent
   module Configuration
@@ -30,6 +31,9 @@ module Riagent
       @config = value
     end
     
+    # Return a configuration hash for a given environment
+    # @param [Symbol] environment Environment for which to load the client configs 
+    # @return [Hash]
     def config_for(environment=:development)
       if self.config.present?
         env_config = self.config[environment.to_s]
@@ -42,15 +46,28 @@ module Riagent
       end
       env_config
     end
-    
-    def init_clients(environment=:development)
-      self.init_riak_json_client(environment)
+
+    # @param [Hash] env_config Configuration hash for a given environment
+    def init_riak_json_client(env_config)
+      client = RiakJson::Client.new(env_config['host'], env_config['http_port'])
+      self.riak_json_client = client
+    end
+
+    # @param [Hash] env_config Configuration hash for a given environment
+    def init_riak_client(env_config)
+      client = Riak::Client.new host: env_config['host'], pb_port: env_config['pb_port'], protocol: 'pbc'
+      self.riak_client = client
     end
     
-    def init_riak_json_client(environment=:development)
+    # Initialize a Riagent persistence client for a given environment
+    # Either called explicitly (see test/test_helper.rb for example usage)
+    # or called by Rails through the 'riagent.configure_rails_initialization' initializer
+    # in lib/railtie.rb
+    # @param [Symbol] environment
+    def init_clients(environment=:development)
       env_config = self.config_for(environment)
-      client = RiakJson::Client.new(env_config['host'], env_config['http_port'])
-      self.riak_json_client = client
+      self.init_riak_json_client(env_config)
+      self.init_riak_client(env_config)
     end
     
     def load_config_file(config_file_path)
@@ -59,12 +76,23 @@ module Riagent
       self.config = config_hash
     end
     
-    # @return [RiakJson::Client] The client for the current thread.
+    # @return [Riak::Client] The Riak client for the current thread.
+    def riak_client
+      Thread.current[:riak_client] ||= nil
+    end
+    
+    # Sets the Riak client for the current thread.
+    # @param [Riak::Client] value the client
+    def riak_client=(value)
+      Thread.current[:riak_client] = value
+    end
+    
+    # @return [RiakJson::Client] The RiakJson client for the current thread.
     def riak_json_client
       Thread.current[:riak_json_client] ||= nil
     end
-  
-    # Sets the client for the current thread.
+    
+    # Sets the RiakJson client for the current thread.
     # @param [RiakJson::Client] value the client
     def riak_json_client=(value)
       Thread.current[:riak_json_client] = value

data/lib/riagent/conversion.rb

@@ -29,6 +29,7 @@ module Riagent
     def destroyed?
       @destroyed ||= false
     end
+    alias :deleted? :destroyed?
     
     # Is this a new, unsaved document?
     # Required by ActiveModel::Conversion API
@@ -37,7 +38,7 @@ module Riagent
       !persisted?
     end
     
-    # Mark the document as saved/persisted
+    # Marks the document as saved/persisted
     # Called by +save+, and when instantiating query results (see ::Persistence)
     def persist!
       @persisted = true
@@ -66,7 +67,7 @@ module Riagent
     # Returns a +string+ representing the object's key suitable for use in URLs,
     # or +nil+ if <tt>persisted?</tt> is +false+.
     # Required by ActiveModel::Conversion API
-    # @return [String, nil]
+    # @return [String|nil]
     def to_param
       self.key
     end

data/lib/riagent/persistence.rb

@@ -19,12 +19,19 @@
 ## -------------------------------------------------------------------
 
 require "active_support/concern"
+require "riagent/persistence/persistence_strategy"
 require "riagent/persistence/riak_json_strategy"
+require "riagent/persistence/riak_no_index_strategy"
 
 module Riagent
+  # Provides a common persistence API for RiakJson Documents.
+  # Most persistence calls are delegated to the Collection class instance,
+  # which are implemented in persistence/*_strategy.rb modules.
   module Persistence
     extend ActiveSupport::Concern
     
+    COLLECTION_TYPES = [:riak_json, :riak_no_index]
+    
     included do
       extend ActiveModel::Callbacks
       define_model_callbacks :create, :update, :save, :destroy
@@ -32,8 +39,9 @@ module Riagent
     
     # Delete the document from its collection
     def destroy
+      return nil if self.new_record?
       run_callbacks(:destroy) do
-        self.class.collection.remove(self)
+        self.class.persistence.remove(self)
         @destroyed = true
       end
     end
@@ -43,13 +51,17 @@ module Riagent
     # Also triggers :before_create / :after_create type callbacks
     # @return [String] Returns the key for the inserted document
     def save(options={:validate => true})
-      context = new_record? ? :create : :update
+      context = self.new_record? ? :create : :update
       return false if options[:validate] && !valid?(context)
       
       run_callbacks(context) do
-        result = self.class.collection.insert(self)
+        if context == :create
+          key = self.class.persistence.insert(self)
+        else
+          key = self.class.persistence.update(self)
+        end
         self.persist!
-        result
+        key
       end
     end
     
@@ -84,25 +96,14 @@ module Riagent
     end
     
     module ClassMethods
-      # Returns all documents (within results/pagination limit) 
-      #  from a collection.
-      # Implemented instead of all() to get around current RiakJson API limitations
-      # @param [String,Symbol] Name of a document field
-      # @param [Integer] Optional results limit
-      # @return [Array] of ActiveDocument instances
-      def all_for_field(field_name, results_limit=1000)
-        query = {
-            field_name => {'$regex' => "/.*/"},
-            '$per_page'=>results_limit
-        }.to_json
-        result = self.collection.find_all(query)
-        if result.present?
-          result.documents.map {|doc| self.from_rj_document(doc, persisted=true) }
-        end
+      # Return all the documents in the collection
+      # @param [Integer] results_limit Number of results returned
+      # @return [Array|nil] of ActiveDocument instances
+      def all(results_limit=1000)
+        self.persistence.all(results_limit)
       end
       
-      # Determines the document's persistence strategy
-      # Valid options: [:riak_json]
+      # Set the document's persistence strategy
       # Usage:
       # <code>
       # class SomeModel
@@ -111,55 +112,50 @@ module Riagent
       # end
       # </code>
       def collection_type(coll_type)
+        unless COLLECTION_TYPES.include? coll_type
+          raise ArgumentError, "Invalid collection type: #{coll_type.to_s}"
+        end
         @collection_type = coll_type
         case @collection_type
         when :riak_json
-          self.persistence_strategy = :riak_json
-          include Riagent::Persistence::RiakJsonStrategy
+          self.persistence = Riagent::Persistence::RiakJsonStrategy.new(self)
+        when :riak_no_index
+          self.persistence = Riagent::Persistence::RiakNoIndexStrategy.new(self)
         end
       end
       
       # Load a document by key.
       def find(key)
         return nil if key.nil? or key.empty?
-        doc = self.collection.find_by_key(key)
-        self.from_rj_document(doc, persisted=true)
+        self.persistence.find(key)
       end
       
       # Return the first document that matches the query
       def find_one(query)
-        if query.kind_of? Hash
-          query = query.to_json
-        end
-        doc = self.collection.find_one(query)
-        if doc.present?
-          self.from_rj_document(doc, persisted=true) 
+        unless self.persistence.allows_query?
+          raise NotImplementedError, "This collection type does not support querying"
         end
+        self.persistence.find_one(query)
       end
       
       def get_collection_type
         @collection_type ||= nil
       end
       
-      def persistence_strategy
-        @persistence_strategy ||= nil
+      def persistence
+        @persistence ||= nil
       end
       
-      def persistence_strategy=(strategy)
-        @persistence_strategy = strategy
+      def persistence=(persistence_strategy)
+        @persistence = persistence_strategy
       end
       
       # Return all documents that match the query
       def where(query)
-        if query.kind_of? Hash
-          query = query.to_json
-        end
-        result = self.collection.find_all(query)
-        if result.present?
-          result.documents.map do |doc| 
-            self.from_rj_document(doc, persisted=true)
-          end
+        unless self.persistence.allows_query?
+          raise NotImplementedError, "This collection type does not support querying"
         end
+        self.persistence.where(query)
       end
     end
   end

data/lib/riagent/persistence/persistence_strategy.rb

@@ -0,0 +1,37 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "riak_json"
+
+module Riagent
+  module Persistence
+    # Riagent document persistence strategy
+    class PersistenceStrategy
+      attr_accessor :client
+      attr_accessor :collection_name
+      attr_accessor :model_class
+      
+      def initialize(model_class)
+        self.model_class = model_class
+        self.collection_name = model_class.collection_name
+      end
+    end
+  end
+end

data/lib/riagent/persistence/riak_json_strategy.rb

@@ -1,5 +1,5 @@
-## ------------------------------------------------------------------- 
-## 
+## -------------------------------------------------------------------
+##
 ## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
 ##
 ## This file is provided to you under the Apache License,
@@ -19,42 +19,101 @@
 ## -------------------------------------------------------------------
 
 require "riak_json"
-require "active_support/concern"
+require "riagent/persistence/persistence_strategy"
 
 module Riagent
   module Persistence
-    module RiakJsonStrategy
-      extend ActiveSupport::Concern
+    class RiakJsonStrategy < PersistenceStrategy
+      attr_writer :collection
+      
+      # Return all the documents in the collection
+      # @param [Integer] results_limit Number of results returned
+      # @return [Array|nil] of ActiveDocument instances
+      def all(results_limit=1000)
+        result = self.collection.all(results_limit)
+        if result.present?
+          result.documents.map do |doc| 
+            self.from_rj_document(doc, persisted=true)
+          end
+        end
+      end
+      
+      # @return [Boolean] Does this persistence strategy support querying?
+      def allows_query?
+        true
+      end
+      
+      # @return [RiakJson::Client] RiakJson client for this persistence strategy (lazy initialize)
+      def client
+        @client ||= Riagent.riak_json_client  # See lib/configuration.rb
+      end
+
+      # @return [RiakJson::Collection] instance for this persistence strategy (lazy initialize)
+      def collection
+        @collection ||= self.client.collection(self.collection_name)
+      end
+
+      # Fetch a document by key.
+      # @param [String] key
+      # @return [ActiveDocument|nil]
+      def find(key)
+        return nil if key.nil? or key.empty?
+        doc = self.collection.find_by_key(key)
+        self.from_rj_document(doc, persisted=true)
+      end
       
-      module ClassMethods
-        def client
-          @client ||= Riagent.riak_json_client
+      # Return the first document that matches the query
+      # @param [String] query RiakJson query, in JSON string form
+      def find_one(query)
+        if query.kind_of? Hash
+          query = query.to_json
         end
-        
-        def client=(client)
-          @client = client
+        doc = self.collection.find_one(query)
+        if doc.present?
+          self.from_rj_document(doc, persisted=true) 
         end
-        
-        # Returns a RiakJson::Collection instance for this document
-        def collection
-          @collection ||= self.client.collection(self.collection_name)
+      end
+      
+      # Converts from a RiakJson::Document instance to an instance of ActiveDocument
+      # @return [ActiveDocument|nil] ActiveDocument instance, or nil if the Document is nil
+      def from_rj_document(doc, persisted=false)
+        return nil if doc.nil?
+        active_doc_instance = self.model_class.instantiate(doc.attributes)
+        active_doc_instance.key = doc.key
+        if persisted
+          active_doc_instance.persist!  # Mark as persisted / not new
         end
-        
-        # Sets the RiakJson::Collection instance for this document
-        def collection=(collection_obj)
-          @collection = collection_obj
+        active_doc_instance
+      end
+      
+      # @param [RiakJson::ActiveDocument] doc Document to be inserted
+      # @return [Integer] Document key
+      def insert(doc)
+        self.collection.insert(doc)
+      end
+
+      # @param [RiakJson::ActiveDocument] doc Document to be deleted
+      def remove(doc)
+        self.collection.remove(doc)
+      end
+
+      # @param [RiakJson::ActiveDocument] doc Document to be updated
+      # @return [Integer] Document key
+      def update(doc)
+        self.collection.update(doc)
+      end
+      
+      # Return all documents that match the query
+      # @param [String] query RiakJson query, in JSON string form
+      def where(query)
+        if query.kind_of? Hash
+          query = query.to_json
         end
-        
-        # Converts from a RiakJson::Document instance to an instance of ActiveDocument
-        # @return [ActiveDocument, nil] ActiveDocument instance, or nil if the Document is nil
-        def from_rj_document(doc, persisted=false)
-          return nil if doc.nil?
-          active_doc_instance = self.instantiate(doc.attributes)
-          active_doc_instance.key = doc.key
-          if persisted
-            active_doc_instance.persist!  # Mark as persisted / not new
+        result = self.collection.find_all(query)
+        if result.present?
+          result.documents.map do |doc| 
+            self.from_rj_document(doc, persisted=true)
           end
-          active_doc_instance
         end
       end
     end

data/lib/riagent/persistence/riak_no_index_strategy.rb

@@ -0,0 +1,122 @@
+## -------------------------------------------------------------------
+##
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 "riak"
+require "riagent/persistence/persistence_strategy"
+
+module Riagent
+  module Persistence
+    class RiakNoIndexStrategy < PersistenceStrategy
+      attr_writer :bucket
+      
+      # Return all the documents in the collection.
+      # Since this is a "no index" strategy, this can only be done via a streaming list keys
+      # @param [Integer] results_limit Number of results returned (currently ignored)
+      # @return [Array<Riagent::ActiveDocument>] List of ActiveDocument instances
+      def all(results_limit)
+        self.bucket.keys.inject([]) do |acc, k|
+          obj = self.find(k)
+          obj ? acc << obj : acc
+        end
+      end
+      
+      # @return [Boolean] Does this persistence strategy support querying?
+      def allows_query?
+        false
+      end
+      
+      # @return [Riak::Bucket] Riak bucket associated with this model/collection
+      def bucket
+        @bucket ||= self.client.bucket(self.collection_name)
+      end
+      
+      # @return [Riak::Client] Riak client (lazy-initialized, cached in current Thread)
+      def client
+        @client ||= Riagent.riak_client  # See lib/configuration.rb
+      end
+
+      # Fetch a document by key.
+      # @param [String] key
+      # @return [ActiveDocument|nil]
+      def find(key)
+        begin
+          result = self.bucket.get(key)
+        rescue Riak::FailedRequest => fr
+          if fr.not_found?
+            result = nil
+          else
+            raise fr
+          end
+        end
+        self.from_riak_object(result)
+      end
+      
+      # Converts from a Riak::RObject instance to an instance of ActiveDocument
+      # @param [Riak::RObject] riak_object
+      # @param [Boolean] persisted Mark the document as persisted/not new?
+      # @return [ActiveDocument|nil] ActiveDocument instance, or nil if the Riak Object is nil
+      def from_riak_object(riak_object, persisted=true)
+        return nil if riak_object.nil?
+        active_doc_instance = self.model_class.from_json(riak_object.raw_data, riak_object.key)
+        if persisted
+          active_doc_instance.persist!  # Mark as persisted / not new
+        end
+        active_doc_instance.source_object = riak_object
+        active_doc_instance
+      end
+      
+      # @param [RiakJson::ActiveDocument] document Document to be inserted
+      # @return [Integer] Document key
+      def insert(document)
+        if document.key.present?
+          # Attempt to fetch existing object, just in case
+          riak_object = self.bucket.get_or_new(document.key)
+        else
+          riak_object = self.new_riak_object()
+        end
+        riak_object.raw_data = document.to_json_document
+        riak_object = riak_object.store
+        document.source_object = riak_object  # store the riak object in document
+        document.key = riak_object.key
+      end
+      
+      # @param [String|nil] Optional key
+      # @return [Riak::RObject] New Riak object instance for this model/collection
+      def new_riak_object(key=nil)
+        Riak::RObject.new(self.bucket, key).tap do |obj|
+          obj.content_type = "application/json"
+        end
+      end
+      
+      # Deletes the riak object that stores the document
+      # @param [RiakJson::ActiveDocument] document Document to be deleted
+      def remove(document)
+        self.new_riak_object(document.key).delete
+        document.source_object = nil
+      end
+      
+      # @param [RiakJson::ActiveDocument] document Document to be updated
+      # @return [Integer] Document key
+      def update(document)
+        self.insert(document)
+      end
+    end
+  end
+end

data/lib/riagent/search_schema.rb

@@ -52,7 +52,7 @@ module Riagent
     #   SampleModel.save_solr_schema()
     # </code>
     def save_solr_schema
-      self.collection.set_schema(self.schema)
+      self.persistence.collection.set_schema(self.schema)
     end
   end
 end

data/lib/riagent/version.rb

@@ -19,5 +19,5 @@
 ## -------------------------------------------------------------------
 
 module Riagent
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/examples/models/user_preference.rb

@@ -0,0 +1,30 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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.
+##
+## -------------------------------------------------------------------
+
+class UserPreference
+  include Riagent::ActiveDocument
+  
+  collection_type :riak_no_index  # Persist to a plain Riak bucket (k/v only)
+  
+  # Explicit attributes
+  # (key is an implied attribute, present in all ActiveDocument instances)
+  attribute :email_ok, Boolean, default: true
+  attribute :email_format, String, default: 'txt'
+end

data/test/integration/persistence_riak_no_index_integration_test.rb

@@ -0,0 +1,52 @@
+## ------------------------------------------------------------------- 
+## 
+## 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 "RiakNoIndexStrategy persistence" do  
+  it "can save an ActiveDocument to a Riak object" do
+    # First, save the object to Riak
+    user_pref = UserPreference.new email_format: 'html'
+    generated_key = user_pref.save
+    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
+    fetched_pref.key.must_equal generated_key
+    fetched_pref.email_format.must_equal 'html'
+    fetched_pref.source_object.must_be_kind_of Riak::RObject
+    
+    # Update the object
+    fetched_pref.update(email_format: 'pdf')
+    updated_pref = fetched_pref = UserPreference.find(generated_key)
+    updated_pref.email_format.must_equal 'pdf'
+    
+    # Delete the object (clean up)
+    fetched_pref.destroy
+    assert fetched_pref.destroyed?
+  end
+end

data/test/test_helper.rb

@@ -24,10 +24,12 @@ require 'riagent'
 require 'examples/models/address_book'
 require 'examples/models/contact'
 require 'examples/models/user'
+require 'examples/models/user_preference'
 
 # Set this to silence "[deprecated] I18n.enforce_available_locales will default to true in the future." warnings
 I18n.config.enforce_available_locales = true
 
 # Load config file and set up the relevant clients for integration testing
+Riak.disable_list_keys_warnings = true
 Riagent.load_config_file('test/config/riak.yml')
 Riagent.init_clients(:test)  # Set up the client for the test environment

data/test/unit/active_model_lint_test.rb

@@ -23,7 +23,7 @@ require 'active_model/lint'
 
 # Runs the ActiveModel::Lint test suite, to make sure a model fits the ActiveModel API
 # See http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/
-class ActiveModelLintTest < MiniTest::Test
+class ActiveModelLintTest < Minitest::Unit::TestCase
   include ActiveModel::Lint::Tests
   
   def setup

data/test/unit/associations_has_one_test.rb

@@ -63,15 +63,15 @@ describe "Riagent::Document has_one association" do
     mock_loaded_address_book = AddressBook.new
     mock_loaded_address_book.key = 'test-book-123'
     
-    AddressBook.collection = MiniTest::Mock.new
-    AddressBook.collection.expect :find_by_key, mock_loaded_address_book, ['test-book-123']
+    AddressBook.persistence = MiniTest::Mock.new
+    AddressBook.persistence.expect :find, mock_loaded_address_book, ['test-book-123']
       
     # Calling user.address_book should lazy-load via the target collection.find_by_key()
     user.address_book
-    AddressBook.collection.verify
+    AddressBook.persistence.verify
     
     # Reset
-    AddressBook.collection = nil
+    AddressBook.persistence = nil
   end
   
   it "adds a build_<target> method" do

data/test/unit/config_test.rb

@@ -28,10 +28,18 @@ describe "Riagent" do
     Riagent.must_respond_to :init_clients
     Riagent.must_respond_to :init_riak_json_client
     Riagent.must_respond_to :riak_json_client
+    Riagent.must_respond_to :init_riak_client
+    Riagent.must_respond_to :riak_client
   end
   
   it "initializes a RiakJson client" do
     # This should have been initialized from config file in test_helper.rb
     Riagent.riak_json_client.must_be_kind_of RiakJson::Client
   end
+  
+  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_json_test.rb

@@ -21,43 +21,66 @@
 require 'test_helper'
 
 describe "a Riagent::ActiveDocument that persists to RiakJson" do
+  it "#model persistence instance methods" do
+    user = User.new
+    
+    # Adding the line +collection_type :riak_json+ to a model 
+    # exposes the usual array of persistence methods
+    user.must_respond_to :save
+    user.must_respond_to :save!
+    user.must_respond_to :update
+    user.must_respond_to :update_attributes  # alias for update()
+    user.must_respond_to :update!
+    user.must_respond_to :destroy
+  end
+  
+  it "#model persistence class methods" do
+    User.must_respond_to :all
+    User.must_respond_to :find
+    User.must_respond_to :find_one
+    User.must_respond_to :where
+  end
+  
   it "saves via collection.insert()" do
     user = User.new
-    User.collection = MiniTest::Mock.new
-    User.collection.expect :insert, nil, [user]
+    User.persistence.collection = MiniTest::Mock.new
+    User.persistence.collection.expect :insert, nil, [user]
     
     # Calling model.save() should result in a collection.insert() call
     user.save({:validate => false})
-    User.collection.verify
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
 
   it "updates via collection.update()" do
     user = User.new username: 'TestUserInitial'
-    User.collection = MiniTest::Mock.new
-    User.collection.expect :insert, nil, [user]
+    user.persist!  # Updates only make sense for a persisted document
+    User.persistence.collection = MiniTest::Mock.new
+    User.persistence.collection.expect :update, nil, [user]
     
     # model.update() is implemented as a save() call (with updated attributes)
     user.update({ username: 'TestUserNewName'} )
-    User.collection.verify
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
   
   it "destroys via collection.remove()" do
     user = User.new
-    User.collection = MiniTest::Mock.new
-    User.collection.expect :remove, nil, [user]
+    user.key = 'user123'
+    user.persist!  # Remove can only be called on persisted objects that have a key
+    User.persistence.collection = MiniTest::Mock.new
+    User.persistence.collection.expect :remove, nil, [user]
     
     # Calling model.destroy() should result in a collection.remove() call
     user.destroy
-    User.collection.verify
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
   
   it "returns nil when doing a find() for nil or empty key" do
@@ -67,52 +90,52 @@ describe "a Riagent::ActiveDocument that persists to RiakJson" do
   
   it "performs a find() via collection.find_by_key()" do
     test_key = 'user123'
-    User.collection = MiniTest::Mock.new
-    User.collection.expect :find_by_key, nil, [test_key]
+    User.persistence.collection = MiniTest::Mock.new
+    User.persistence.collection.expect :find_by_key, nil, [test_key]
     
     # Calling Model class find() should result in a collection.find_by_key()
     User.find(test_key)
-    User.collection.verify
+    User.persistence.collection.verify
+    
+    # Reset
+    User.persistence.collection = nil
+  end
+  
+  it "performs an all() listing via collection.all()" do
+    User.persistence.collection = MiniTest::Mock.new
+    User.persistence.collection.expect :all, [], [1000]  # default results limit of 1000
+    
+    # Calling Model class where() should result in a collection.all()
+    User.all()
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
   
   it "performs a where() via collection.find_all()" do
-    User.collection = MiniTest::Mock.new
+    User.persistence.collection = MiniTest::Mock.new
     query = { country: 'USA' }
-    User.collection.expect :find_all, [], [query.to_json]
+    User.persistence.collection.expect :find_all, [], [query.to_json]
     
     # Calling Model class where() should result in a collection.find_all()
     User.where(query)
-    User.collection.verify
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
   
   it "performs a find_one() via collection.find_one()" do
-    User.collection = MiniTest::Mock.new
+    User.persistence.collection = MiniTest::Mock.new
     query = { username: 'TestUser' }
-    User.collection.expect :find_one, [], [query.to_json]
+    User.persistence.collection.expect :find_one, [], [query.to_json]
     
     # Calling Model class find_one() should result in a collection.find_one()
     User.find_one(query)
-    User.collection.verify
-    
-    # Reset
-    User.collection = nil
-  end
-  
-  it "performs an all_for_field() via collection.find_all()" do
-    User.collection = MiniTest::Mock.new
-    User.collection.expect :find_all, [], [String]
-    
-    # Calling Model class all_for_field() should result in a collection.find_all()
-    User.all_for_field(:username)
-    User.collection.verify
+    User.persistence.collection.verify
     
     # Reset
-    User.collection = nil
+    User.persistence.collection = nil
   end
 end

data/test/unit/persistence_riak_no_index_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 RiakNoIndex strategy" 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.must_respond_to :all
+    UserPreference.must_respond_to :find
+  end
+end

data/test/unit/persistence_test.rb

@@ -1,5 +1,5 @@
-## ------------------------------------------------------------------- 
-## 
+## -------------------------------------------------------------------
+##
 ## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
 ##
 ## This file is provided to you under the Apache License,
@@ -21,37 +21,40 @@
 require 'test_helper'
 
 describe "a Riagent::ActiveDocument has Persistence options" do
-  context "via collection_type :riak_json" do
-    it "#model class methods" do
-      # Adding the line +collection_type :riak_json+ to a model 
-      # means that it will be persisted to a RiakJson::Collection
-      User.get_collection_type.must_equal :riak_json
-      User.persistence_strategy.must_equal :riak_json
-      
-      # It also grants access to a RiakJson::Client instance, to the model class
-      User.client.must_be_kind_of RiakJson::Client
-      
-      User.collection.must_be_kind_of RiakJson::Collection
-      User.collection_name.must_equal 'users'
-    end
-    
-    it "#model persistence instance methods" do
-      user = User.new
-      
-      # Adding the line +collection_type :riak_json+ to a model 
-      # exposes the usual array of persistence methods
-      user.must_respond_to :save
-      user.must_respond_to :save!
-      user.must_respond_to :update
-      user.must_respond_to :update_attributes  # alias for update()
-      user.must_respond_to :update!
-      user.must_respond_to :destroy
-    end
-    
-    it "#model persistence class methods" do
-      User.must_respond_to :find
-      User.must_respond_to :find_one
-      User.must_respond_to :where
-    end
+  it "can only persist to valid collection types" do
+    lambda { User.collection_type :invalid }.must_raise ArgumentError
+  end
+
+  it "#:riak_json collection_type" do
+    # Adding the line +collection_type :riak_json+ to a model
+    # means that it will be persisted to a RiakJson::Collection
+    User.get_collection_type.must_equal :riak_json
+    User.persistence.must_be_kind_of Riagent::Persistence::RiakJsonStrategy
+
+    # It also grants access to a RiakJson::Client instance, to the model class
+    User.persistence.client.must_be_kind_of RiakJson::Client
+
+    User.persistence.collection.must_be_kind_of RiakJson::Collection
+    User.persistence.collection_name.must_equal 'users'
+
+    # Check to see if the RiakJson persistence strategy supports querying
+    assert User.persistence.allows_query?
+  end
+
+  it "#:riak_no_index collection type" do
+    # Adding the line +collection_type :riak_no_index+ 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
+
+    # It also grants access to a RiakJson::Client instance, to the model class
+    UserPreference.persistence.client.must_be_kind_of Riak::Client
+
+    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"
   end
 end

data/test/unit/search_schema_test.rb

@@ -16,11 +16,14 @@ describe "an Active Document" do
   
   it "can save the Solr indexing schema to RiakJson" do
     schema = User.schema
-    User.collection = MiniTest::Mock.new
+    User.persistence.collection = MiniTest::Mock.new
 
     # Ensure that calling User.save_solr_schema() results in a call to collection.set_schema()
-    User.collection.expect :set_schema, nil, [RiakJson::CollectionSchema]
+    User.persistence.collection.expect :set_schema, nil, [RiakJson::CollectionSchema]
     User.save_solr_schema
-    User.collection.verify
+    User.persistence.collection.verify
+    
+    # Reset
+    User.persistence.collection = nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riagent
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dmitri Zagidulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak_json
@@ -159,7 +159,9 @@ files:
 - lib/riagent/conversion.rb
 - lib/riagent/errors.rb
 - lib/riagent/persistence.rb
+- lib/riagent/persistence/persistence_strategy.rb
 - lib/riagent/persistence/riak_json_strategy.rb
+- lib/riagent/persistence/riak_no_index_strategy.rb
 - lib/riagent/railtie.rb
 - lib/riagent/search_schema.rb
 - lib/riagent/version.rb
@@ -169,7 +171,9 @@ files:
 - test/examples/models/blog_post.rb
 - test/examples/models/contact.rb
 - test/examples/models/user.rb
-- test/integration/persistence_integration_test.rb
+- test/examples/models/user_preference.rb
+- test/integration/persistence_riak_json_integration_test.rb
+- test/integration/persistence_riak_no_index_integration_test.rb
 - test/seeds.rb
 - test/test_helper.rb
 - test/unit/active_document_test.rb
@@ -179,6 +183,7 @@ files:
 - test/unit/config_test.rb
 - test/unit/embedded_test.rb
 - test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_riak_no_index_test.rb
 - test/unit/persistence_test.rb
 - test/unit/search_schema_test.rb
 - test/unit/validation_test.rb
@@ -212,7 +217,9 @@ test_files:
 - test/examples/models/blog_post.rb
 - test/examples/models/contact.rb
 - test/examples/models/user.rb
-- test/integration/persistence_integration_test.rb
+- test/examples/models/user_preference.rb
+- test/integration/persistence_riak_json_integration_test.rb
+- test/integration/persistence_riak_no_index_integration_test.rb
 - test/seeds.rb
 - test/test_helper.rb
 - test/unit/active_document_test.rb
@@ -222,6 +229,7 @@ test_files:
 - test/unit/config_test.rb
 - test/unit/embedded_test.rb
 - test/unit/persistence_riak_json_test.rb
+- test/unit/persistence_riak_no_index_test.rb
 - test/unit/persistence_test.rb
 - test/unit/search_schema_test.rb
 - test/unit/validation_test.rb