ocean-dynamo 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 577f687042b84996c0c8b6490f970a3827f90b4f
-  data.tar.gz: 8632b8095f13fa066e3ee63831e723b5a9398c47
+  metadata.gz: eeab3b16bea7186a7a996113e1de39a7f9d21651
+  data.tar.gz: 9bf14c5d5521673acb6637bd03885f02a7ec05e6
 SHA512:
-  metadata.gz: ec0edf51b620ed1082879309efd47d53e5bcbd97bb4689f8c294c74f930cace03389afbc28479d81f080ace84aceeb4590bda4dd57a9b6a78c9ce39ae3ee28d1
-  data.tar.gz: fda47b459b7c0e71977dce1490bdea63d71668dfb38cf6bc568a589c5d625411b0f7a129cfc44f4820847e0f5787db7ecbef068b5c205edb1d113e7eb7891d14
+  metadata.gz: 71dd4bed657bb9fe67ec15f422f3007bbee26ed88bf5880bc2e569dafdf0a1726260b7d73eb0ec9598a3d7bc2565e9a9c0940aa875fbe268afa247d1a8df2de5
+  data.tar.gz: 2558c9434f37ce7af79a34ced28eaf87f1257e6c0dbe7a0b8d2be6cab1d6966c8d345341b9ef0dbd2875b860d00cb85a3a55f47436882177fdb2177bb0f930a0

data/README.rdoc

@@ -33,9 +33,8 @@ with FactoryGirl.
 
 === Current State
 
-* Secondary indices are now supported! See below for more information.
-* Version 2 of the AWS Ruby SDK is now used. This required an internal reorganisation, 
-  but it also gives us access to local and global secondary indices.
+* Secondary indices are now fully supported! See below for more information.
+* Version 2 of the AWS Ruby SDK is now used.
 * Work begun on association proxies, etc.
 
 
@@ -216,13 +215,7 @@ the possibility to define both local and secondary indices for Tables.
 
 == Secondary Indices
 
-We now have basic support for secondary indices. High-level support for global secondary indices
-is also available; we will add high-level support for local secondary indices very soon.
-For now you will have to specify that a secondary index is to be used explicitly in the options 
-passed to +in_batches+, +query+, and +scan+. 
-* +query+: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Table.html#query-instance_method
-* +scan+: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Table.html#scan-instance_method
-* +in_batches+, +find_each+: lib/ocean-dynamo/queries.rb
+We now have support for secondary indices.
 
 === Local Secondary Indices
 
@@ -249,6 +242,27 @@ combination of keys. Secondary indices don't require the range key to be unique
 the same hash key. This means that secondary index searches always will return a
 collection.
 
+High-level support for local secondary indices is now available through
++find_local_each+ and +find_local+. They take the same arguments; the former
+yields to a block for each item, the other returns all items in an array.
+
+The following finds all Authentications where +:username+ is "joe" and +:token+ is "quux":
+
+ Authentication.find_local(:username, "joe", :token, "=", "quux")
+
+This retrieves all Authentications belonging to Joe, sorted on +:token+:
+
+ Authentication.find_local(:username, "joe", :token, ">=", "0")
+
+The same thing but with the only the item with the highest token value:
+
+ Authentication.find_local(:username, "joe", :token, ">=", "0",
+                           scan_index_forward: false, limit: 1)
+
+For more information, see the documentation for
++find_local_each+ and +find_local+.
+
+
 === Global Secondary Indices
 
 Global secondary indices are declared after all attributes, but still within the +do+
@@ -296,7 +310,7 @@ To get the highest +:expires_at+ record, execute the following:
                             scan_index_forward: false, limit: 1)
 
 The combination of hash and range key must have been explicitly declared using
-+global_secondary_index+. For more information, see the documentation of
++global_secondary_index+. For more information, see the documentation for
 +find_global_each+ and +find_global+.
 
 

data/lib/ocean-dynamo/queries.rb

@@ -113,9 +113,15 @@ module OceanDynamo
     # end
 
 
+    #
+    # This helper constructs the +options+ hash for a subsequent call to +in_batches+ and friends.
+    # It takes care of creating expression attributes names and values for all data and takes
+    # parameters to control scan direction and limits, etc.
+    #
     def condition_builder(hash_key, hash_value,
                           range_key=nil, comparator=nil, range_value=nil,
-                          limit: nil, consistent: false, scan_index_forward: true)
+                          limit: nil, consistent: false, scan_index_forward: true,
+                          select: nil)
       if range_key
         options = { 
           expression_attribute_names: { "#H" => hash_key, "#R" => range_key },
@@ -132,6 +138,7 @@ module OceanDynamo
       options[:limit] = limit if limit
       options[:consistent_read] = consistent if consistent
       options[:scan_index_forward] = scan_index_forward if !scan_index_forward
+      options[:select] = select.to_s.upcase if select
       options
     end
 
@@ -195,5 +202,61 @@ module OceanDynamo
       result
     end
 
+
+    #
+    # This method finds each item of a local secondary index, sequentially yielding each item
+    # to the given block (required). The parameters are as follows:
+    #
+    # +hash_key+    The name of the hash key to use (required, must be the table's hash_key).
+    # +hash_value+  The value of the hash key to match (required).
+    # +range_key+   The name of the range key to use (required).
+    # +comparator+  The comparator to use. "=", "<", ">", "<=", ">=". (required).
+    # +range-value+ The value of the range key to match (required).
+    # 
+    # Note that +range_key+ must all be present.
+    #
+    # The following keyword arguments are accepted:
+    # 
+    # +:limit+              The maximum number of items to read.
+    # +:scan_index_forward+ If false, items will be in reverse order.
+    # +:consistent+         If true, consistent reads will be used. Default false.
+    #
+    def find_local_each(hash_key, hash_value,
+                        range_key, comparator, range_value,
+                        limit: nil, scan_index_forward: true, consistent: false,
+                        &block)
+      raise "The hash_key is #{hash_key.inspect} but must be #{table_hash_key.inspect}" unless hash_key == table_hash_key
+      hash_value = hash_value.to_i if hash_value.is_a?(Time)
+      range_value = range_value.to_i if range_value.is_a?(Time)
+      options = condition_builder(hash_key, hash_value, range_key, comparator, range_value,
+                                  select: :all_attributes,
+                                  limit: limit, scan_index_forward: scan_index_forward,
+                                  consistent: consistent)
+      index_name = range_key.to_s
+      options[:index_name] = index_name
+      raise "Undefined local index: #{index_name}" unless local_secondary_indexes.include?(index_name)
+      in_batches :query, options do |attrs|
+        if limit
+          return if limit <= 0
+          limit = limit - 1
+        end
+        yield new._setup_from_dynamo(attrs)
+      end
+    end
+
+
+    #
+    # This method takes the same args as +find_local_each+ but returns all found items as
+    # an array.
+    #
+    def find_local(*args)
+      result = []
+      find_local_each(*args) do |item|
+        result << item
+      end
+      result
+    end
+
+
   end
 end

data/lib/ocean-dynamo/version.rb

@@ -1,3 +1,3 @@
 module OceanDynamo
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-dynamo
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Peter Bengtson