occams-record 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1dc718c0f99f5ad039974f8db3bd1c5304e41a3b3275d26dd1d86235c7790fe
-  data.tar.gz: 8af374148ca1f1c8342b7eb8fdb30031d6c31a1d923a6e7cab55b96712ed2602
+  metadata.gz: a367407e2af3e4110327d26438fcb2a590b7fbd34e6b60dd4bd9396665c495fe
+  data.tar.gz: 8cf6fb913ac787126a80fe38baff3a56940cea8afc80e1b05e3c864ae8368e11
 SHA512:
-  metadata.gz: 54b539bc70b1fc92c087fbc91f7edbaa1eb4dabacfda80ca0afa4ccd4ac53e832d431f3c95e35785cfa7bd7075879c655ae54019c3f341255b4411929b5ae615
-  data.tar.gz: c1c9aed1007bcfeb0e577d08af6f86fa340e375fede08af03bd18fbc2538cfcbd4838fc5bd07c672fca6e02ca3c0ec9e8d442b3e3275deff58215dfba873df7a
+  metadata.gz: 2bc45d11bc974e5a5ec6b2b9ffab8e3f069048ee8335122ad81a8b49cc852fa4bdb27116865000e4b70e4f6d617b3f870861288e00a43b273e3ec14d0dfdb6b6
+  data.tar.gz: af1dac7260e93ed3778ff022c3d6113819528e37d77c275b9cada6cd5e731593bbe9e4f24ae283ed572a4876672126df4cb002ab8f9c863e3de4943f95acdbc2

data/README.md

@@ -9,7 +9,7 @@ OccamsRecord is a high-efficiency, advanced query library for use alongside Acti
 * 3x-5x faster than ActiveRecord queries, *minimum*.
 * Uses 1/3 the memory of ActiveRecord query results.
 * Eliminates the N+1 query problem. (This often exceeds the baseline 3x-5x gain.)
-* Support for cursors (Postgres only, new in v1.4.0-beta1)
+* Support for cursors (Postgres only, new in v1.4.0)
 
 ### 2) Supercharged querying & eager loading
 
@@ -20,7 +20,9 @@ Continue using ActiveRecord's query builder, but let Occams take over running th
 ```ruby
 OccamsRecord
   .query(User.active)
-  .eager_load(:orders, ->(q) { q.where("created_at >= ?", date).order("created_at DESC") })
+  .eager_load(:orders) { |l|
+    l.scope { |q| q.where("created_at >= ?", date).order("created_at DESC") }
+  }
 ```
 
 **Use `ORDER BY` with `find_each`/`find_in_batches`**
@@ -135,9 +137,9 @@ Eager loading is similiar to ActiveRecord's `preload`: each association is loade
 OccamsRecord
   .query(q)
   .eager_load(:customer)
-  .eager_load(:line_items) {
-    eager_load(:product)
-    eager_load(:something_else)
+  .eager_load(:line_items) { |l|
+    l.eager_load(:product)
+    l.eager_load(:something_else)
   }
   .find_each { |order|
     puts order.customer.name
@@ -158,11 +160,14 @@ orders = OccamsRecord
   .query(q)
   # Only SELECT the columns you need. Your DBA will thank you.
   .eager_load(:customer, select: "id, name")
-  
-  # A Proc can use ActiveRecord's query builder
-  .eager_load(:line_items, ->(q) { q.active.order("created_at") }) {
-    eager_load(:product)
-    eager_load(:something_else)
+
+  # Or use 'scope' to access the full power of ActiveRecord's query builder.
+  # Here, only 'active' line items will be returned, and in a specific order.
+  .eager_load(:line_items) { |l|
+    l.scope { |q| q.active.order("created_at") }
+
+    l.eager_load(:product)
+    l.eager_load(:something_else)
   }
   .run
 ```
@@ -262,9 +267,9 @@ Let's say we want to load each product with an array of all customers who've ord
 ```ruby
 products_with_orders = OccamsRecord
   .query(Product.all)
-  .eager_load(:line_items) {
-    eager_load(:order) {
-      eager_load(:customer)
+  .eager_load(:line_items) { |l|
+    l.eager_load(:order) { |l|
+      l.eager_load(:customer)
     }
   }
   .map { |product|
@@ -354,7 +359,7 @@ bundle install
 bundle exec rake test
 
 # test against Postgres
-TEST_DATABASE_URL=postgres://postgres@localhost:5432/occams_record bundle exec rake test
+TEST_DATABASE_URL=postgresql://postgres@localhost:5432/occams_record bundle exec rake test
 
 # test against MySQL
 TEST_DATABASE_URL=mysql2://root:@127.0.0.1:3306/occams_record bundle exec rake test

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

@@ -26,7 +26,13 @@ module OccamsRecord
         @name, @mapping = name.to_s, mapping
         @sql, @binds, @use, @model = sql, binds, use, model
         @eager_loaders = EagerLoaders::Context.new(@model)
-        instance_exec(&builder) if builder
+        if builder
+          if builder.arity > 0
+            builder.call(self)
+          else
+            instance_exec(&builder)
+          end
+        end
       end
 
       #

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

@@ -19,12 +19,32 @@ module OccamsRecord
       # @yield perform eager loading on *this* association (optional)
       #
       def initialize(ref, scope = nil, use: nil, as: nil, optimizer: :select, &builder)
-        @ref, @scope, @use, @as = ref, scope, use, as
+        @ref, @scopes, @use, @as = ref, Array(scope), use, as
         @model = ref.klass
         @name = (as || ref.name).to_s
         @eager_loaders = EagerLoaders::Context.new(@model)
         @optimizer = optimizer
-        instance_exec(&builder) if builder
+        if builder
+          if builder.arity > 0
+            builder.call(self)
+          else
+            instance_exec(&builder)
+          end
+        end
+      end
+
+      #
+      # An alternative to passing a "scope" lambda to the constructor. Your block is passed the query
+      # so you can call select, where, order, etc on it.
+      #
+      # If you call scope multiple times, the results will be additive.
+      #
+      # @yield [ActiveRecord::Relation] a relation to modify with select, where, order, etc
+      # @return self
+      #
+      def scope(&scope)
+        @scopes << scope if scope
+        self
       end
 
       #
@@ -71,7 +91,7 @@ module OccamsRecord
       def base_scope
         q = @ref.klass.all
         q = q.instance_exec(&@ref.scope) if @ref.scope
-        q = @scope.(q) if @scope
+        q = @scopes.reduce(q) { |acc, scope| scope.(acc) }
         q
       end
     end

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

@@ -10,6 +10,12 @@ module OccamsRecord
       # Specify an association to be eager-loaded. For maximum memory savings, only SELECT the
       # colums you actually need.
       #
+      # If you pass a block to nest more eager loads, you may call it with one of two forms: with an argument and without:
+      #
+      # If you ommit the block argument, the "self" inside the block will be the eager loader. You can call "eager_load" and "scope" directly.
+      #
+      # If you include the block argument, the "self" inside the block is the same as the self outside the block. The argument will be the eager loader, which you can use to make additional "eager_load" or "scope" calls.
+      #
       # @param assoc [Symbol] name of association
       # @param scope [Proc] a scope to apply to the query (optional). It will be passed an
       # ActiveRecord::Relation on which you may call all the normal query hethods (select, where, etc) as well as any scopes you've defined on the model.

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

@@ -115,7 +115,7 @@ module OccamsRecord
 
       def build_loader!(assoc, custom_name, scope, select, use, optimizer, builder)
         build_loader(assoc, custom_name, scope, select, use, optimizer, builder) ||
-          raise("OccamsRecord: No assocation `:#{assoc}` on `#{@model.name}` or subclasses")
+          raise("OccamsRecord: No association `:#{assoc}` on `#{@model.name}` or subclasses")
       end
 
       def build_loader(assoc, custom_name, scope, select, use, optimizer, builder)

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

@@ -17,12 +17,32 @@ module OccamsRecord
       # @yield perform eager loading on *this* association (optional)
       #
       def initialize(ref, scope = nil, use: nil, as: nil, optimizer: nil, &builder)
-        @ref, @scope, @use = ref, scope, use
+        @ref, @scopes, @use = ref, Array(scope), use
         @name = (as || ref.name).to_s
         @foreign_type = @ref.foreign_type.to_sym
         @foreign_key = @ref.foreign_key.to_sym
         @eager_loaders = EagerLoaders::Context.new(nil, polymorphic: true)
-        instance_exec(&builder) if builder
+        if builder
+          if builder.arity > 0
+            builder.call(self)
+          else
+            instance_exec(&builder)
+          end
+        end
+      end
+
+      #
+      # An alternative to passing a "scope" lambda to the constructor. Your block is passed the query
+      # so you can call select, where, order, etc on it.
+      #
+      # If you call scope multiple times, the results will be additive.
+      #
+      # @yield [ActiveRecord::Relation] a relation to modify with select, where, order, etc
+      # @return self
+      #
+      def scope(&scope)
+        @scopes << scope if scope
+        self
       end
 
       #
@@ -83,7 +103,7 @@ module OccamsRecord
       def base_scope(model)
         q = model.all
         q = q.instance_exec(&@ref.scope) if @ref.scope
-        q = @scope.(q) if @scope
+        q = @scopes.reduce(q) { |acc, scope| scope.(acc) }
         q
       end
     end

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # @private
-  VERSION = "1.4.0".freeze
+  VERSION = "1.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jordan Hollinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,7 +83,7 @@ homepage: https://jhollinger.github.io/occams-record/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: The missing high-efficiency query API for ActiveRecord
 test_files: []