occams-record 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1dc718c0f99f5ad039974f8db3bd1c5304e41a3b3275d26dd1d86235c7790fe
-  data.tar.gz: 8af374148ca1f1c8342b7eb8fdb30031d6c31a1d923a6e7cab55b96712ed2602
+  metadata.gz: d09d84ccc4713f32959380098b74112e45fa6a84a47698f1cec2d6fc4c4886a9
+  data.tar.gz: b94244c91ed19b02cfb36ff02c72b6510ab38da73f7d76e13e8104713fa2ed03
 SHA512:
-  metadata.gz: 54b539bc70b1fc92c087fbc91f7edbaa1eb4dabacfda80ca0afa4ccd4ac53e832d431f3c95e35785cfa7bd7075879c655ae54019c3f341255b4411929b5ae615
-  data.tar.gz: c1c9aed1007bcfeb0e577d08af6f86fa340e375fede08af03bd18fbc2538cfcbd4838fc5bd07c672fca6e02ca3c0ec9e8d442b3e3275deff58215dfba873df7a
+  metadata.gz: 950a0baa705302727a9ab9d20bb286e2fdc44cdd8b6aee3edb1b02c0a640786beca3492e799bcf4efe87c3a01289c6f4edb2daa07dc24650a5c29d6276733737
+  data.tar.gz: dc07af2830bf268dac941834d36bc1cca3ffe64f5e1e3eadfe901b11fe1fcf545ba9804da4fd683697ee26201faf0936b06aaa203ac661aa14eed69b036e2109

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) {
+    scope { |q| q.where("created_at >= ?", date).order("created_at DESC") }
+  }
 ```
 
 **Use `ORDER BY` with `find_each`/`find_in_batches`**
@@ -158,9 +160,12 @@ 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") }) {
+
+  # 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) {
+    scope { |q| q.active.order("created_at") }
+
     eager_load(:product)
     eager_load(:something_else)
   }
@@ -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/base.rb

@@ -19,7 +19,7 @@ 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)
@@ -27,6 +27,20 @@ module OccamsRecord
         instance_exec(&builder) if builder
       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
+
       #
       # Run the query and merge the results into the given rows.
       #
@@ -71,7 +85,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/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,7 +17,7 @@ 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
@@ -25,6 +25,20 @@ module OccamsRecord
         instance_exec(&builder) if builder
       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
+
       #
       # Run the query and merge the results into the given rows.
       #
@@ -83,7 +97,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.5.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.5.0
 platform: ruby
 authors:
 - Jordan Hollinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2023-02-10 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: []