occams-record 1.1.0.beta2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8396c1695d88e04c27d2807e5435ba155aab811270acd24b44d4618703394153
-  data.tar.gz: 70e401a280a6fe8b31529965600e4eb1abf96b8e5b779ddc9c3ddb46ba00c3ff
+  metadata.gz: a403231d294ef71185626a819905f486206a5fdf6b94e2d0cd7eb459393a5be8
+  data.tar.gz: 0a19d6226484a10da785bcc2dff3d4f8a068b376b8b9443f0f2a1c6eebefe50d
 SHA512:
-  metadata.gz: 66d83d639237ad10fa32cdcbfa1110d3d6f646abcaca365486673f11c5f3e7f37eb7c96c0eeedc30617d6762ffaa616f61ccf343947a2812f5af4c8055667b18
-  data.tar.gz: 5dd60b455bc38dbe7466e5fa09cf505d59067db1f0460132b553af9f49b0069951eb44f70cfc793588cbfb95352dee37646473ebcf325a5b9d5c6c9e95cdafab
+  metadata.gz: '05977e1eb8936770d167e200db0925d0b6e93422b72b88925e71ef0d50df703f5e1171b175630f63ac6f4b02696ef9d5320f6b770d7414aea2c2458d1e0038f6'
+  data.tar.gz: eace78527961d84999ad34e99be7a71be64bcbc64377f9cf907c9cc35f6d25f110586e5991f0e315246bc5b5fb3bd4b59a2550f5b58965aab72fb2ec1e3905ca

data/README.md

@@ -2,13 +2,11 @@
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
-**Breaking change since pre-1.0** See [HISTORY.md](https://github.com/jhollinger/occams-record/blob/master/HISTORY.md#100rc1-2018-12-01).
-
 Occam's Record is a high-efficiency, advanced query library for ActiveRecord apps. It is **not** an ORM or an ActiveRecord replacement. Use it to solve pain points in your existing ActiveRecord app. Occams Record gives you two things:
 
 **Performance**
 
-* 3x-5x faster than ActiveRecord queries.
+* 3x-5x faster than ActiveRecord queries, *minimum*.
 * Uses 1/3 the memory of ActiveRecord query results.
 * Eliminates the N+1 query problem.
 
@@ -61,31 +59,29 @@ Occams Record has great support for raw SQL queries too, but we'll get to those
 
 ## Basic eager loading
 
-Eager loading is similiar to ActiveRecord's `preload` (each association is loaded in a separate query). Nested associations use blocks instead of Hashes. If you try to use an association you didn't eager load an exception will be raised.
+Eager loading is similiar to ActiveRecord's `preload`: each association is loaded in a separate query. Unlike ActiveRecord, nested associations use blocks instead of Hashes. More importantly, if you try to use an association you didn't eager load *an exception will be raised*. In other words, the N+1 query problem simply doesn't exist.
 
 ```ruby
-orders = OccamsRecord.
+OccamsRecord.
   query(q).
   eager_load(:customer).
   eager_load(:line_items) {
     eager_load(:product)
     eager_load(:something_else)
   }.
-  run
-  
-order = orders[0]
-puts order.customer.name
-
-order.line_items.each { |line_item|
-  puts line_item.product.name
-  puts line_item.product.category.name
-  OccamsRecord::MissingEagerLoadError: Association 'category' is unavailable on Product because it was not eager loaded!
-}
+  find_each { |order|
+    puts order.customer.name
+    order.line_items.each { |line_item|
+      puts line_item.product.name
+      puts line_item.product.category.name
+      OccamsRecord::MissingEagerLoadError: Association 'category' is unavailable on Product because it was not eager loaded!
+    }
+  }
 ```
 
 ## Advanced eager loading
 
-Occams Record allows you to customize each eager load query using the full power of ActiveRecord's query builder.
+Occams Record allows you to tweak the SQL of any eager load. Pull back only the columns you need, change the order, add a `WHERE` clause, etc.
 
 ```ruby
 orders = OccamsRecord.
@@ -93,8 +89,7 @@ orders = OccamsRecord.
   # Only SELECT the columns you need. Your DBA will thank you.
   eager_load(:customer, select: "id, name").
   
-  # A Proc can customize the query using any of ActiveRecord's query
-  # builders and any scopes you've defined on the LineItem model.
+  # 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)
@@ -130,7 +125,7 @@ OccamsRecord.
 
 **Eager loading**
 
-To use `eager_load` with a raw SQL query you must tell Occams what the base model is. (That doesn't apply if you're loading an ad hoc, raw SQL association. We'll get to those later.)
+To use `eager_load` with a raw SQL query you must tell Occams what the base model is. (That doesn't apply if you're loading an ad hoc, raw SQL association. We'll get to those next.)
 
 ```ruby
 orders = OccamsRecord.
@@ -181,13 +176,11 @@ products = OccamsRecord.
   run
 ```
 
-`eager_load_many` allows us to declare an ad hoc *has_many* association called *customers*. The `{:id => :product_id}` Hash defines the mapping: *id* in the parent record maps to *product_id* in the child records.
-
-The SQL string and binds should be familiar by now. `%{ids}` will be provided for you - just stick it in the right place. Note that it won't always be called *ids*; the name will be the plural version of the key in your mapping.
+`eager_load_many` is declaring an ad hoc *has_many* association called *customers*. The `{:id => :product_id}` Hash defines the mapping: *id* in the parent record maps to *product_id* in the child records.
 
-`eager_load_one` defines an ad hoc `has_one`/`belongs_to` association.
+The SQL string and binds should be familiar. `%{ids}` will be provided for you - just stick it in the right place. Note that it won't always be called *ids*; the name will be the plural version of the key in your mapping.
 
-These ad hoc eager loaders are available on both `OccamsRecord.query` and `OccamsRecord.sql`. While eager loading with `OccamsRecord.sql` normallly requires you to declare the model, that isn't necessary when using these methods.
+`eager_load_one` defines an ad hoc `has_one`/`belongs_to` association. It and `eager_load_many` are available with both `OccamsRecord.query` and `OccamsRecord.sql`.
 
 ## Injecting instance methods
 
@@ -214,10 +207,6 @@ 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/eager_loaders/context.rb

@@ -45,7 +45,7 @@ module OccamsRecord
       # @return [Array<String>]
       #
       def names
-        @loaders.map(&:name) +
+        @loaders.map(&:name) |
           @loaders.select { |l| l.respond_to? :through_name }.map(&:through_name) # TODO make not hacky
       end
 

data/lib/occams-record/merge.rb

@@ -51,7 +51,7 @@ module OccamsRecord
           rescue NoMethodError => e
             raise MissingColumnError.new(row, e.name)
           end
-          row.send @assign, attr ? assoc_rows_by_ids[attr] : nil
+          row.send(@assign, attr ? assoc_rows_by_ids[attr] : nil)
         end
 
       # Slower but works with any number of mapping key pairs
@@ -72,7 +72,7 @@ module OccamsRecord
           rescue NoMethodError => e
             raise MissingColumnError.new(row, e.name)
           end
-          row.send @assign, attrs.any? ? assoc_rows_by_ids[attrs] : nil
+          row.send(@assign, attrs.any? ? assoc_rows_by_ids[attrs] : nil)
         end
       end
 
@@ -108,7 +108,7 @@ module OccamsRecord
           rescue NoMethodError => e
             raise MissingColumnError.new(row, e.name)
           end
-          row.send @assign, assoc_rows_by_attr[pkey] || []
+          row.send(@assign, assoc_rows_by_attr[pkey] || [])
         end
 
       # Slower but works with any number of mapping key pairs
@@ -127,7 +127,7 @@ module OccamsRecord
           rescue NoMethodError => e
             raise MissingColumnError.new(row, e.name)
           end
-          row.send @assign, assoc_rows_by_attrs[pkeys] || []
+          row.send(@assign, assoc_rows_by_attrs[pkeys] || [])
         end
       end
 

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = "1.1.0.beta2".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2019-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,12 +77,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: The missing high-efficiency query API for ActiveRecord