lib/riak/secondary_index.rb in riak-client-2.2.0.pre1 vs lib/riak/secondary_index.rb in riak-client-2.2.0

@@ -1,19 +1,22 @@
 require 'riak/index_collection'
 require 'riak/bucket_typed/bucket'
 
 module Riak
+  # {Riak::SecondaryIndex} provides an object-oriented interface to secondary
+  # index ("2i") functionality in Riak, available on the `memory` and `leveldb`
+  # backends.
   class SecondaryIndex
     include Util::Translation
     include Client::FeatureDetection
 
     # Create a Riak Secondary Index operation
     # @param [Bucket] bucket the {Riak::Bucket} we'll query against
     # @param [String] index the index name
     # @param [String,Integer,Range<String,Integer>] query
     #   a single value or range of values to query for
-    def initialize(bucket, index, query, options={})
+    def initialize(bucket, index, query, options = {})
       @bucket = bucket
       @client = @bucket.client
       @index = index
       @query = query
       @options = options
@@ -24,11 +27,11 @@
 
       validate_options
     end
 
     def get_server_version
-      @client.backend{|b| b.send :get_server_version }
+      @client.backend { |b| b.send :get_server_version }
     end
 
     # Get the array of matched keys
     def keys(&block)
       @collection ||=
@@ -37,34 +40,39 @@
         end
     end
 
     # Get the array of values
     def values
-      @values ||= @bucket.get_many(self.keys).values
+      @values ||= @bucket.get_many(keys).values
     end
 
     # Get a new SecondaryIndex fetch for the next page
     def next_page
-      raise t('index.no_next_page') unless keys.continuation
+      fail t('index.no_next_page') unless keys.continuation
 
-      self.class.new(@bucket, 
-                     @index, 
-                     @query, 
-                     @options.merge(:continuation => keys.continuation))
+      self.class.new(@bucket,
+                     @index,
+                     @query,
+                     @options.merge(continuation: keys.continuation))
     end
 
     # Determine whether a SecondaryIndex fetch has a next page available
     def has_next_page?
       !!keys.continuation
     end
 
     private
+
     def validate_options
-      raise t('index.pagination_not_available') if paginated? && !index_pagination?
-      raise t('index.return_terms_not_available') if @options[:return_terms] && !index_return_terms?
-      raise t('index.include_terms_is_wrong') if @options[:include_terms]
+      if paginated? && !index_pagination?
+        fail t('index.pagination_not_available')
+      end
 
-      # raise t('index.streaming_not_available') if @options[:stream] && !index_streaming?
+      if @options[:return_terms] && !index_return_terms?
+        fail t('index.return_terms_not_available')
+      end
+
+      fail t('index.include_terms_is_wrong') if @options[:include_terms]
     end
 
     def paginated?
       @options[:continuation] || @options[:max_results]
     end