dynamoid_advanced_where 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f415151e23b5baba11532ebc26bf31020983502dd979a41a49e262933bf4ea50
-  data.tar.gz: be4300fcbfe8db7056c2c0e0163f8573854434c3a40826476686243dc4cafd5b
+  metadata.gz: f806a04e8969341d1397e35cc86d7694dec55693ae90c5d34d85ccb4faa95805
+  data.tar.gz: f2f44f2f359c679cffa89f150eb20406a8712c2fb5d22cb857e78e7aa5ecee1f
 SHA512:
-  metadata.gz: ce2f7f1722ffbfb98bc4302495679d5511ef59b88f0b676850e77c20600bb7f19b728bdb0fd6bee8f385abd42947a9afb0b12ffd469165bb5ffaaeffeb5586fa
-  data.tar.gz: 69dd0f4ad676256f5e6b0d52decd79198f69aa7f03efec1602d87e8bebb5a133076b337a00d7c2ef91ac71b0d9bf48c599aef9f9d1cc097028762a07724e5e5e
+  metadata.gz: c5a692ab92a62c20d36b563f0e452aa897cc5b22eeaf527624a709fe01145566c13fa5a37789741d5dddf5c0b79eeb8c3c6e30412e139f93a40dc1a6b6f54989
+  data.tar.gz: 39ca15de11981b84b41484042f141927b8076f718bdf449cebf193c2845cf1d7773b9653cbaf3d1efe19f75c685e07b4a7c23edb04e111c976f19de5d72a12e7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamoid_advanced_where (1.0.1)
+    dynamoid_advanced_where (1.1.0)
       dynamoid (>= 3.2, < 4)
 
 GEM
@@ -21,13 +21,13 @@ GEM
       thor (>= 0.14.0)
     ast (2.4.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.270.0)
-    aws-sdk-core (3.89.1)
+    aws-partitions (1.275.0)
+    aws-sdk-core (3.90.1)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.41.0)
+    aws-sdk-dynamodb (1.42.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
@@ -67,6 +67,7 @@ GEM
       method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -80,11 +81,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.79.0)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)

data/README.md

@@ -174,6 +174,10 @@ Provided methods
 * `first`
 * `each` (and related enumerable methods)
 
+### Start
+
+`.start({ some_hash_key: some_value })` takes a hash argument that must match the key structure of the table (range key must be specified where valid). If passed an empty hash, results will start from the beginning of the table. Records before the specified start key will not be scanned or returned. This is useful when doing manual pagination.
+
 ### Scan vs Query
 DAW will automatically preform a query when it determines it is possible,
 however if a query is determined to not be appropriate, a scan will be conduced

data/lib/dynamoid_advanced_where/query_builder.rb

@@ -4,13 +4,16 @@ require_relative './batched_updater'
 
 module DynamoidAdvancedWhere
   class QueryBuilder
-    attr_accessor :klass, :root_node
+    attr_accessor :klass, :root_node, :start_hash
 
     delegate :all, :each, to: :query_materializer
 
-    def initialize(klass:, &blk)
+    def initialize(klass:, start_hash: nil, root_node: nil, &blk)
       self.klass = klass
-      self.root_node = Nodes::RootNode.new(klass: klass, &blk)
+      self.root_node = root_node || Nodes::RootNode.new(klass: klass, &blk)
+      self.start_hash = start_hash
+
+      freeze
     end
 
     def query_materializer
@@ -43,5 +46,10 @@ module DynamoidAdvancedWhere
     end
     alias and where
 
+    def start(key_hash)
+      return self if key_hash.nil? || key_hash.empty?
+
+      self.class.new(klass: klass, start_hash: key_hash, root_node: root_node)
+    end
   end
 end

data/lib/dynamoid_advanced_where/query_materializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './filter_builder'
 
 module DynamoidAdvancedWhere
@@ -5,8 +7,7 @@ module DynamoidAdvancedWhere
     include Enumerable
     attr_accessor :query_builder
 
-
-    delegate :klass, to: :query_builder
+    delegate :klass, :start_hash, to: :query_builder
     delegate :table_name, to: :klass
     delegate :to_a, :first, to: :each
 
@@ -23,39 +24,70 @@ module DynamoidAdvancedWhere
     def each(&blk)
       return enum_for(:each) unless blk
 
+      records.each(&blk)
+    end
+    alias find_each each
+
+    def each_page(&blk)
+      return enum_for(:each_page) unless blk
+
+      pages.each(&blk)
+    end
+
+    def records
+      pages.flat_map { |i, _| i }
+    end
+
+    def pages
       if must_scan?
-        each_via_scan(&blk)
+        each_page_via_scan
       else
-        each_via_query(&blk)
+        each_page_via_query
       end
     end
 
-    def each_via_query
+    def each_page_via_query
       query = {
-        table_name: table_name,
+        table_name: table_name
       }.merge(filter_builder.to_query_filter)
 
-      results = client.query(query)
+      page_start = start_hash
 
-      if results.items
-        results.items.each do |item|
-          yield klass.from_database(item.symbolize_keys)
+      Enumerator.new do |yielder|
+        loop do
+          results = client.query(query.merge(exclusive_start_key: page_start))
+
+          items = (results.items || []).each do |item|
+            klass.from_database(item.symbolize_keys)
+          end
+
+          yielder.yield(items, results)
+
+          (page_start = results.last_evaluated_key) || break
         end
-      end
+      end.lazy
     end
 
-    def each_via_scan
+    def each_page_via_scan
       query = {
         table_name: table_name
       }.merge(filter_builder.to_scan_filter)
 
-      results = client.scan(query)
+      page_start = start_hash
+
+      Enumerator.new do |yielder|
+        loop do
+          results = client.scan(query.merge(exclusive_start_key: page_start))
 
-      if results.items
-        results.items.each do |item|
-          yield klass.from_database(item.symbolize_keys)
+          items = (results.items || []).map do |item|
+            klass.from_database(item.symbolize_keys)
+          end
+
+          yielder.yield(items, results)
+
+          (page_start = results.last_evaluated_key) || break
         end
-      end
+      end.lazy
     end
 
     def filter_builder
@@ -66,6 +98,7 @@ module DynamoidAdvancedWhere
     end
 
     private
+
     def client
       Dynamoid.adapter.client
     end

data/lib/dynamoid_advanced_where/version.rb

@@ -1,3 +1,3 @@
 module DynamoidAdvancedWhere
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamoid_advanced_where
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Malinconico
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynamoid