occams-record 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3fb7ced8f877916cfaea950deed2cb24381cf8f34a8af4b15e11a17c7827e5d
-  data.tar.gz: c63a11949ac704ebaf48ec98880ad8fb26aeec0024d63bd83fbb3d94e00e6634
+  metadata.gz: 6ceea75487deeadf930b9236a44980882ac539042e9d86b6ce5612da9c58642c
+  data.tar.gz: 190dab76b6f35d430f97a4be25ccf3fe56b652edb9722c83de844cd5c9d1715e
 SHA512:
-  metadata.gz: e69251d02c9361741ee39fbaaa05c037c9a37b6182b4fdc87a1e376f585a9810848da5982e913ae63fc557ef68e33dbdabd3b1c63a9d411340610b4d649c5e29
-  data.tar.gz: 6def010edc18851479f0f82184c91e4c595bdbd906e82c640b2e8752622b6e1904c063acbf79f438f23f1575acb6c1dffb211da46bfbc4486710e1ad52c1e326
+  metadata.gz: 384fcddbac59eb4663a0e4d8f3f7c0286f8ff348c5b37e74c5f052fca5138011f06a107a5b305d57df1391bf581b35605346ee11a9e5d6542af0e2298e3e0273
+  data.tar.gz: 49e71a3dd7eb5bd78180b17ba01550e7105450fdeee2ff6bbbae255fbb3f11eac1182bc233caff5567449723b45c24ed8e465a2bee0b28523ebcc74904280956

data/README.md

@@ -12,14 +12,14 @@ OccamsRecord is a high-efficiency, advanced query library for use alongside Acti
 
 ### 2) Supercharged querying & eager loading
 
-Continue using ActiveRecord's query builder, but let Occams take over eager loading and raw SQL calls. None of the examples below are possible with ActiveRecord, but OccamsRecord won't limit you. (More complete examples are shown later, but these should whet your appetite.)
+Continue using ActiveRecord's query builder, but let Occams take over running them, eager loading, and raw SQL calls. None of the examples below are possible with ActiveRecord, but OccamsRecord makes them trivial. (More complete examples are shown later, but these should whet your appetite.)
 
 **Customize the SQL used to eager load associations**
 
 ```ruby
 OccamsRecord.
   query(User.active).
-  eager_load(:orders, ->(q) { q.where("created_at >= ?", date })
+  eager_load(:orders, ->(q) { q.where("created_at >= ?", date).order("created_at DESC") })
 ```
 
 **Use `ORDER BY` with `find_each`/`find_in_batches`**
@@ -297,15 +297,25 @@ bundle install
 bundle exec rake test
 ```
 
+**Specify ActiveRecord version**
+
 By default, bundler will install the latest (supported) version of ActiveRecord. To specify a version to test against, run:
 
 ```bash
 AR=5.2 bundle update activerecord
-bundle exec rake test
+AR=5.2 bundle exec rake test
 ```
 
 Look inside `Gemfile` to see all testable versions.
 
+**Run against Postgres**
+
+By default the tests run against an in-memory Sqlite3 database. Use the following env var to force running against a Postgres database:
+
+```bash
+TEST_DATABASE_URL=postgres://postgres@localhost:5432/occams_record bundle exec rake test
+```
+
 # License
 
 MIT License. See LICENSE for details.

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,30 +63,44 @@ 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
+      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.order(model.primary_key.to_sym).offset(offset).limit(l)
+        q = scope
+        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
 
         y.yield results if results.any?

data/lib/occams-record/eager_loaders/belongs_to.rb

@@ -20,6 +20,7 @@ module OccamsRecord
             raise MissingColumnError.new(row, e.name)
           end
         }.compact.uniq
+        ids.sort! if $occams_record_test
 
         q = base_scope.where(@ref.association_primary_key => ids)
         yield q if ids.any?
@@ -33,7 +34,7 @@ module OccamsRecord
       #
       def merge!(assoc_rows, rows)
         Merge.new(rows, name).
-          single!(assoc_rows, {@ref.foreign_key.to_s => @ref.active_record_primary_key.to_s})
+          single!(assoc_rows, {@ref.foreign_key.to_s => @ref.association_primary_key.to_s})
       end
     end
   end

data/lib/occams-record/eager_loaders/has_one.rb

@@ -20,6 +20,7 @@ module OccamsRecord
             raise MissingColumnError.new(row, e.name)
           end
         }.compact.uniq
+        ids.sort! if $occams_record_test
 
         q = base_scope.where(@ref.foreign_key => ids)
         q.where!(@ref.type => rows[0].class&.model_name) if @ref.options[:as]

data/lib/occams-record/eager_loaders/polymorphic_belongs_to.rb

@@ -55,6 +55,7 @@ module OccamsRecord
           next if type.nil? or type == ""
           model = type.constantize
           ids = rows_of_type.map(&@foreign_key).uniq
+          ids.sort! if $occams_record_test
           q = base_scope(model).where(@ref.active_record_primary_key => ids)
           yield q if ids.any?
         end

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/results/row.rb

@@ -152,7 +152,7 @@ module OccamsRecord
       def define_ids_reader!(assoc)
         model = self.class._model
         ref = model.reflections[assoc]
-        pkey = ref.association_primary_key.to_sym
+        pkey = ref.klass.primary_key.to_sym
 
         self.class.class_eval do
           define_method "#{assoc.singularize}_ids" do

data/lib/occams-record/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 description: A faster, lower-memory querying API for ActiveRecord that returns results
   as unadorned, read-only objects.
 email: jordan.hollinger@gmail.com
@@ -81,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The missing high-efficiency query API for ActiveRecord