occams-record 1.0.0.rc7 → 1.0.0.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 964e9c20b250ab9599801912147978d7d477104d
-  data.tar.gz: 48184b52dbf038c40508bb6ab06e93399567196e
+SHA256:
+  metadata.gz: 77e8b9c5da26d6d76932bfca57a9470648e97bb07ca33ee3fbdfe7fa5e67aed7
+  data.tar.gz: 694e75291ee550813f0732cd8d4d2361e5c6e44f324637789af0afa4637e7865
 SHA512:
-  metadata.gz: 90243f9b079d7e94a6d474ffdee700dd1212e3066e96e2af89d662d70d7a253e85cbf1a793d9bd377b1962715205efa941a35d48f3b5d984710570f359c6cd24
-  data.tar.gz: 302edf479ab834b775394a6b1962fb0f1a707b81e4ea5e6db9d8441b5ad72e00ca5adf3c86a389f18e0923b621b425192b7eb7eb1fe5cead18c49aa3fbf2c29a
+  metadata.gz: 5831bafffa9f1da1677d2dff25d59d9a1480be2db886a0e275fa9a7e0d7f874dd22314bd18632df383e7213cb5e0fd50b046a526e44d5cae553c7d807af6bb0a
+  data.tar.gz: 40ab48b4680d2cf5aabbd48fa90e5564111fc77239bbfa6a0ec7ecdd7f3cc05bb4a906fd28134706a9a216c0eb8c2c9b9cf449791ec1a6dc225334d9fe356233

data/README.md

@@ -55,7 +55,9 @@ orders = OccamsRecord.
   run
 ````
 
-`each`, `map`, `reduce`, and other Enumerable methods may be used instead of *run*. `find_each` and `find_in_batches` are also supported, and unlike their ActiveRecord counterparts they respect *ORDER BY*. Occams Record has great support for raw SQL queries too, but we'll get to those later.
+`each`, `map`, `reduce`, and other Enumerable methods may be used instead of *run*. `find_each` and `find_in_batches` are also supported. Occams Record has great support for raw SQL queries too, but we'll get to those later.
+
+NOTE Unlike in Active Record, `find_each` and `find_in_batches` respect *ORDER BY*. However, to ensure consistency, it's strongly recomended to use `find_each`/`find_in_batches` inside of a transaction.
 
 ## Basic eager loading
 
@@ -212,6 +214,10 @@ orders = OccamsRecord.
   run
 ```
 
+## Ugly Module
+
+`OccamsRecord::Ugly` contains helpers for things that shouldn't, but sometimes must, be done in legacy codebases. See the docs.
+
 ---
 
 # Unsupported features

data/lib/occams-record.rb

@@ -6,3 +6,7 @@ require 'occams-record/results'
 require 'occams-record/query'
 require 'occams-record/raw_query'
 require 'occams-record/errors'
+
+module OccamsRecord
+  autoload :Ugly, 'occams-record/ugly'
+end

data/lib/occams-record/batches.rb

@@ -7,8 +7,11 @@ module OccamsRecord
     # Load records in batches of N and yield each record to a block if given.
     # If no block is given, returns an Enumerator.
     #
-    # NOTE Unlike ActiveRecord's find_each, order IS respected. The primary key will be appended
-    # to the ORDER BY clause to help ensure consistent batches.
+    # NOTE Unlike ActiveRecord's find_each, order is respected. The primary key will be appended
+    # to the ORDER BY clause to help ensure consistent batches. HOWEVER, it's still possible for
+    # batches to be "corrupted" (miss records or repeat records) if table data changes out from
+    # enderneath them. To prevent this, it's strongly recomended to always run find_each inside
+    # of a transaction.
     #
     # @param batch_size [Integer]
     # @yield [OccamsRecord::Results::Row]
@@ -31,8 +34,11 @@ module OccamsRecord
     # Load records in batches of N and yield each batch to a block if given.
     # If no block is given, returns an Enumerator.
     #
-    # NOTE Unlike ActiveRecord's find_in_batches, order IS respected. The primary key will be appended
-    # to the ORDER BY clause to help ensure consistent batches.
+    # NOTE Unlike ActiveRecord's find_in_batches, order is respected. The primary key will be appended
+    # to the ORDER BY clause to help ensure consistent batches. HOWEVER, it's still possible for
+    # batches to be "corrupted" (miss records or repeat records) if table data changes out from
+    # enderneath them. To prevent this, it's strongly recomended to always run find_in_batches inside
+    # of a transaction.
     #
     # @param batch_size [Integer]
     # @yield [OccamsRecord::Results::Row]
@@ -59,6 +65,10 @@ module OccamsRecord
     # @return [Enumerator] yields batches
     #
     def batches(of:)
+      if model.connection.open_transactions == 0
+        $stderr.puts "Occams Record Warning: find_each or find_in_batches is being run outside of transaction. Batch consistency can only be ensured within a transaction."
+      end
+
       limit = scope.limit_value
       batch_size = limit && limit < of ? limit : of
       Enumerator.new do |y|

data/lib/occams-record/ugly.rb

@@ -0,0 +1,43 @@
+module OccamsRecord
+  #
+  # This module contains helpers for things you shouldn't, but sometimes must, do in legacy codebases.
+  #
+  module Ugly
+    #
+    # Loads an Occams Record object into an ActiveRecord model. THIS WILL NEGATE ALL PERFORMANCE IMPROVEMENTS!
+    # The ONLY reason to use this is if you absolutely need ActiveRecord objects but still want to use Occams's
+    # more advanced eager loading or find_each/find_in_batches features.
+    #
+    #   OccamsRecord.
+    #     query(Order.order("created_at DESC")).
+    #     eager_load(:line_items, ->(q) { q.order("price") }).
+    #     find_each do |o|
+    #       order = OccamsRecord::Ugly.active_record(o)
+    #       ...
+    #     end
+    #
+    # @param model [ActiveRecord::Base] The model to load the record into
+    # @param record [OccamsRecord::Result::Row] The OccamsRecord row
+    # @return [ActiveRecord::Base]
+    #
+    def self.active_record(model, record)
+      active = model.new(record.to_h)
+
+      record.class.associations.each do |assoc_name|
+        assoc = active.class.reflections[assoc_name]
+        obj = record.send assoc_name
+        next if assoc.nil? or obj.nil?
+
+        if obj.is_a? Array
+          active.send(assoc_name).load_target.replace obj.map { |x|
+            active_record(assoc.klass, x)
+          }
+        else
+          active.send "#{assoc_name}=", active_record(assoc.klass, obj)
+        end
+      end
+
+      active
+    end
+  end
+end

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = '1.0.0.rc7'.freeze
+  VERSION = '1.0.0.rc8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.0.0.rc8
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,6 +58,7 @@ files:
 - lib/occams-record/query.rb
 - lib/occams-record/raw_query.rb
 - lib/occams-record/results.rb
+- lib/occams-record/ugly.rb
 - lib/occams-record/version.rb
 homepage: https://jhollinger.github.io/occams-record/
 licenses:
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The missing high-efficiency query API for ActiveRecord