occams-record 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f92b611f104c0a5644c7caa0ca6aa57f7beffa381d3579490a475fb1c388d51
-  data.tar.gz: 2b399f8bbd15b0bfd1859533431432b5607a841448cb5d112e21f60090edb997
+  metadata.gz: 707ed6c9bf173cd193bb01d26149eb78acc2908e352af3eb863c483c357e6a5e
+  data.tar.gz: 257c5d00ececf487537d599103d1f60b9adede4e1411e1e82f0c66e01210bfb2
 SHA512:
-  metadata.gz: 67fdf0377759ccb13e6d59abda9e87f4a30d4be4431f4e92cf16b0cd430bfcdc74afa05cd9d0c178a0b80cc3afbfcdae292db1f53fef0c6facbceda4f49a5223
-  data.tar.gz: 8d88fc8bdb242090bf0f0a833075733fb6b05a09441bd235e2e7eb02cac6dd3ef9a8463539d28edf531b3b17474b74b5d5cfdedf45df62f89212ac649bbc216f
+  metadata.gz: ac390d24a51ed24ba8cf941bae278bf0756c55724fd1b17f496b56ad11aae74873677cc698c78d44bb39a976e241a42c3f2879df8b29d6125ade39eed9ed83df
+  data.tar.gz: c416b257ff7d5d95aea4bb195b56009e912fd93d4127d77fc68c2d3d5ca28ed6e84f99b1a959410cb39a7273927394bb10eba6a97dffa116af74a75b9078b8b2

data/README.md

@@ -31,6 +31,8 @@ gem 'occams-record'
 
 **Simple example**
 
+Build your query the same as before, using `ActiveRecord`'s excellent query builder. Just hand it off to `OccamsRecord.query` before running it. Be sure to use `OccamsRecord`'s eager loading helpers instead of `ActiveRecord`'s.
+
 ```ruby
 widgets = OccamsRecord.
   query(Widget.order("name")).
@@ -65,7 +67,7 @@ widgets[1].splines.map { |s| s.description }
 => ["Spline 4", "Spline 5"]
 ```
 
-**An insane example, but only half as insane as the one that prompted the creation of this library**
+**Even more complicated example**
 
 Here we're eager loading several levels down. Notice the `Proc` given to `eager_load(:orders)`. The `select:` option is just for convenience; you may instead pass a `Proc` and customize the query with any of ActiveRecord's query builder helpers (`select`, `where`, `order`, `limit`, etc).
 

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

@@ -16,7 +16,7 @@ module OccamsRecord
       # @param binds [Hash] any additional binds for your query.
       # @param model [ActiveRecord::Base] optional - ActiveRecord model that represents what you're loading. required when using Sqlite.
       # @param use [Array<Module>] optional - Ruby modules to include in the result objects (single or array)
-      # @yield
+      # @yield eager load associations nested under this one
       #
       def initialize(name, mapping, sql, binds: {}, model: nil, use: nil, &eval_block)
         @name = name.to_s

data/lib/occams-record/eager_loaders.rb

@@ -62,9 +62,10 @@ module OccamsRecord
       # @param binds [Hash] any additional binds for your query.
       # @param model [ActiveRecord::Base] optional - ActiveRecord model that represents what you're loading. required when using Sqlite.
       # @param use [Array<Module>] optional - Ruby modules to include in the result objects (single or array)
+      # @yield eager load associations nested under this one
       #
-      def eager_load_one(*args, &eval_block)
-        @eager_loaders << EagerLoaders::AdHocOne.new(*args, &eval_block)
+      def eager_load_one(name, mapping, sql, binds: {}, model: nil, use: nil, &eval_block)
+        @eager_loaders << EagerLoaders::AdHocOne.new(name, mapping, sql, binds: binds, model: model, use: use, &eval_block)
         self
       end
 
@@ -92,9 +93,10 @@ module OccamsRecord
       # @param use [Array<Module>] optional - Ruby modules to include in the result objects (single or array)
       # @param binds [Hash] any additional binds for your query.
       # @param model [ActiveRecord::Base] optional - ActiveRecord model that represents what you're loading. required when using Sqlite.
+      # @yield eager load associations nested under this one
       #
-      def eager_load_many(*args, &eval_block)
-        @eager_loaders << EagerLoaders::AdHocMany.new(*args, &eval_block)
+      def eager_load_many(name, mapping, sql, binds: {}, model: nil, use: nil, &eval_block)
+        @eager_loaders << EagerLoaders::AdHocMany.new(name, mapping, sql, binds: binds, model: model, use: use, &eval_block)
         self
       end
 

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = '0.23.0'.freeze
+  VERSION = '0.24.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Jordan Hollinger
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 description: A faster, lower-memory querying API for ActiveRecord that returns results
   as unadorned, read-only objects.
 email: jordan.hollinger@gmail.com