occams-record 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216f5b9aff38034e5bcaab036d4a5a20add7053062546eb827bd12269d49c766
-  data.tar.gz: f481e52c6d3390b7a3f5aa7497ac15d78774ef93f5d295dca472c75f558db9d2
+  metadata.gz: 466aabbac2317ba6b65e5d02c4f244f317640bbbea08a2949c4b4ebe59be5bfb
+  data.tar.gz: cd50c8465764d9f811acccd1d833357ced98e2ba5812e3c5d12a3f2534495fb1
 SHA512:
-  metadata.gz: ee45536cbf4ea6a317647e73ac30788416bebfb3b152350fdcb4ab7d6e6e747ef1eb1763ef2aec731e11a9fb5925a8b234787933418c8c74f0724dd3b1ee1b9e
-  data.tar.gz: 30ab20cdd8611e0fec40a7a2e1b3d516ac153a5d283a393860650588c2d6f1bc93f02c43f125bb1675824ef019a29e276a05e0900899e311b838eab87a186db4
+  metadata.gz: d5935484d5a729eb82fa12eb6402b48d7a54f54d9d8fe2986694eada3af26296c88536c78bbf2a05239483d66deb2c0a7bd6f70097b51547d95d5ded77bbec11
+  data.tar.gz: b0162c9054e18a8c1c265de9e47b5cd2bb00dcc53bd7406a166d67b3c4a390389a0e06f80e345fff8ed89fc2b7edb2b87a9e30a4fc165c6a4f9be2541bbebd71

data/lib/occams-record/batches.rb

@@ -13,12 +13,13 @@ module OccamsRecord
     #
     # @param batch_size [Integer]
     # @param use_transaction [Boolean] Ensure it runs inside of a database transaction
+    # @param append_order_by [String] Append this column to ORDER BY to ensure consistent results. Defaults to the primary key. Pass false to disable.
     # @yield [OccamsRecord::Results::Row]
     # @return [Enumerator] will yield each record
     #
-    def find_each(batch_size: 1000, use_transaction: true)
+    def find_each(batch_size: 1000, use_transaction: true, append_order_by: nil)
       enum = Enumerator.new { |y|
-        batches(of: batch_size, use_transaction: use_transaction).each { |batch|
+        batches(of: batch_size, use_transaction: use_transaction, append_order_by: append_order_by).each { |batch|
           batch.each { |record| y.yield record }
         }
       }
@@ -39,11 +40,12 @@ module OccamsRecord
     #
     # @param batch_size [Integer]
     # @param use_transaction [Boolean] Ensure it runs inside of a database transaction
+    # @param append_order_by [String] Append this column to ORDER BY to ensure consistent results. Defaults to the primary key. Pass false to disable.
     # @yield [OccamsRecord::Results::Row]
     # @return [Enumerator] will yield each batch
     #
-    def find_in_batches(batch_size: 1000, use_transaction: true)
-      enum = batches(of: batch_size, use_transaction: use_transaction)
+    def find_in_batches(batch_size: 1000, use_transaction: true, append_order_by: nil)
+      enum = batches(of: batch_size, use_transaction: use_transaction, append_order_by: append_order_by)
       if block_given?
         enum.each { |batch| yield batch }
       else
@@ -61,34 +63,43 @@ module OccamsRecord
     #
     # @param of [Integer] batch size
     # @param use_transaction [Boolean] Ensure it runs inside of a database transaction
+    # @param append_order_by [String] Append this column to ORDER BY to ensure consistent results. Defaults to the primary key. Pass false to disable.
     # @return [Enumerator] yields batches
     #
-    def batches(of:, use_transaction: true)
+    def batches(of:, use_transaction: true, append_order_by: nil)
+      append_order =
+        case append_order_by
+        when false then nil
+        when nil then model.primary_key
+        else append_order_by
+        end
+
       Enumerator.new do |y|
         if use_transaction and model.connection.open_transactions == 0
           model.connection.transaction {
-            run_batches y, of
+            run_batches y, of, append_order
           }
         else
-          run_batches y, of
+          run_batches y, of, append_order
         end
       end
     end
 
-    def run_batches(y, of)
+    def run_batches(y, of, append_order_by = nil)
       limit = scope.limit_value
       batch_size = limit && limit < of ? limit : of
 
       offset = scope.offset_value || 0
       out_of_records, count = false, 0
-      pkey_regex = /#{model.primary_key}|\*/ # NOTE imperfect
-      order_by_pkey = !!model.primary_key &&
-        (scope.select_values.empty? || scope.select_values.any? { |v| v.to_s =~ pkey_regex })
+      order_by =
+        if append_order_by
+          append_order_by.to_s == model.primary_key.to_s ? append_order_by.to_sym : append_order_by
+        end
 
       until out_of_records
         l = limit && batch_size > limit - count ? limit - count : batch_size
         q = scope
-        q = q.order(model.primary_key.to_sym) if order_by_pkey
+        q = q.order(order_by) if order_by
         q = q.offset(offset).limit(l)
         results = Query.new(q, use: @use, query_logger: @query_logger, eager_loaders: @eager_loaders).run
 

data/lib/occams-record/raw_query.rb

@@ -156,7 +156,7 @@ module OccamsRecord
     # @param use_transaction [Boolean] Ensure it runs inside of a database transaction
     # @return [Enumerator] yields batches
     #
-    def batches(of:, use_transaction: true)
+    def batches(of:, use_transaction: true, append_order_by: nil)
       unless @sql =~ /LIMIT\s+%\{batch_limit\}/i and @sql =~ /OFFSET\s+%\{batch_offset\}/i
         raise ArgumentError, "When using find_each/find_in_batches you must specify 'LIMIT %{batch_limit} OFFSET %{batch_offset}'. SQL statement: #{@sql}"
       end

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = "1.1.5".freeze
+  VERSION = "1.1.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord