occams-record 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9637536cde1b2f57e976fa87ab6dfc2bdb34dee0
-  data.tar.gz: b639ad58c3b7b328a7e37a858b5693832604e620
+  metadata.gz: 93cf9f49f91eee71e3ad4f920ab2a6be8f212363
+  data.tar.gz: 0b213d2fc9d5882a4c387e94989af64d96c0b037
 SHA512:
-  metadata.gz: c84146477d0ba45f0f5a36386e06ade453339b45473a8bebba2f4b4da2eda876e6cfe62dc86c4a1f539838ff765c3753436f10853bc97df2a800f605c064daba
-  data.tar.gz: f941ae734b28a694921090d664e3a263c168aba74461d3106c3a04aeeaba3889157db5629c89f3f57187150e6622b3bb66977371999525c89188022da1db2a5b
+  metadata.gz: 34f6973012cdae863862cf6a8850442d18333f320bd5920866d1f7bd402dc6530bcadb76bece429512b6ec6c5a527afbdf8d1d8041145ff5691071c95ee9dba0
+  data.tar.gz: 2068ccf8a5c863ac5c9a63f5df408b6d3fafda5cca6b0bb292873397480048f985e89c8d27e9ce08dcc80890c72f2720172c477baa527e00c51e526b04f7a5d9

data/README.md

@@ -59,7 +59,7 @@ Notice that we're eager loading splines, but *only the fields that we need*. If
 widgets = OccamsRecord.
   query(Widget.order("name")).
   eager_load(:category).
-  eager_load(:splines, -> { select("widget_id, description") }).
+  eager_load(:splines, select: "widget_id, description").
   run
 
 widgets[0].splines.map { |s| s.description }
@@ -71,7 +71,7 @@ widgets[1].splines.map { |s| s.description }
 
 **An insane example, but only half as insane as the one that prompted the creation of this library**
 
-In addition to custom eager loading queries, we're also adding nested eager loading (and customizing those queries!).
+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`, etc).
 
 ```ruby
 widgets = OccamsRecord.
@@ -79,13 +79,13 @@ widgets = OccamsRecord.
   eager_load(:category).
 
   # load order_items, but only the fields needed to identify which orders go with which widgets
-  eager_load(:order_items, -> { select("widget_id, order_id") }) {
+  eager_load(:order_items, select: "widget_id, order_id") {
 
     # load the orders
-    eager_load(:orders) {
+    eager_load(:orders, -> { order "order_date DESC" }) {
 
       # load the customers who made the orders, but only their names
-      eager_load(:customer, -> { select("id, name") })
+      eager_load(:customer, select: "id, name")
     }
   }.
   run

data/lib/occams-record/query.rb

@@ -66,13 +66,15 @@ module OccamsRecord
     #
     # @param assoc [Symbol] name of association
     # @param scope [Proc] a scope to apply to the query (optional)
+    # @param select [String] a custom SELECT statement, minus the SELECT (optional)
     # @param use [Array<Module>] optional Module to include in the result class (single or array)
     # @param eval_block [Proc] a block where you may perform eager loading on *this* association (optional)
     # @return [OccamsRecord::Query] returns self
     #
-    def eager_load(assoc, scope = nil, use: nil, &eval_block)
+    def eager_load(assoc, scope = nil, select: nil, use: nil, &eval_block)
       ref = model.reflections[assoc.to_s]
       raise "OccamsRecord: No assocation `:#{assoc}` on `#{model.name}`" if ref.nil?
+      scope ||= -> { self.select select } if select
       @eager_loaders << EagerLoaders.fetch!(ref).new(ref, scope, use, &eval_block)
       self
     end

data/lib/occams-record/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jordan Hollinger