occams-record 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d0dd44c9dd065285ae2a1dfc0c5cd05f27d70b2b611011f128a7692c7afc31
-  data.tar.gz: 0b08d794ce884b340d00b72d531cc3e7e1c0ee4e200eed585c65edf5066e1a4d
+  metadata.gz: e89d0ce5bbff9d0fbba5b086dffb359e5d512e530b059dc8ff5a9531af243cde
+  data.tar.gz: 701c8e99f70a483bfdd80f2137c13ee6d4a5d5e514d6d2da06cbedba2c4fded6
 SHA512:
-  metadata.gz: 7587c4c1d9464ac8a078b417afb4e9f2603419b9ef13ecc05da8496854fcf787bf93330756118e5e9b4696729f47c4c676bc9ad36b6ae4da0222c931c7bace0c
-  data.tar.gz: b897b931d76a8e87eb97a07319975cd57c6cfa355842f0097830dd75db09f22c158edcb40d476b7be2d54d8c3b489e87294bf66bf0147e234f1dbeba18c2b590
+  metadata.gz: e7d7078efccfbaf867a71c43395eff15a53365e717ecf0bcdce75977b1ad857ccb2eaa15d64e2d2487e9638fd80fbdb9a2b50c494607176051957c0426e6323f
+  data.tar.gz: '01488651aec52772ca597a86a62cb3f89f5ad7f2deb549ced6643a67d6d948c5a79f838fd158a6b6be700b5e2ad6da05909c313a74bc0d6370d5c5c90fbcfb0e'

data/README.md

@@ -2,15 +2,15 @@
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
-Occam's Record is a high-efficiency query API for ActiveRecord. It is **not** an ORM or an ActiveRecord replacement. Use it to solve pain points in your existing ActiveRecord app.
+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.
 
-* 3x-5x faster than ActiveRecord.
-* Uses 1/3 the memory of ActiveRecord.
+* 3x-5x faster than ActiveRecord queries.
+* Uses 1/3 the memory of ActiveRecord query results.
 * Eliminates the N+1 query problem.
 * Allows custom SQL when eager loading associations (use `select`, `where`, `order`, etc).
 * `find_each`/`find_in_batches` respects `order` and `limit`.
-* Allows eager loading of associations when using raw SQL.
-* Allows `find_each`/`find_in_batches` when using raw SQL.
+* Allows eager loading of associations when querying with raw SQL.
+* Allows `find_each`/`find_in_batches` when querying with raw SQL.
 * Eager load data from arbitrary SQL (no association required).
 
 [Look over the speed and memory measurements yourself!](https://github.com/jhollinger/occams-record/wiki/Measurements) OccamsRecord achieves all of this by making some very specific trade-offs:
@@ -89,7 +89,7 @@ widgets = OccamsRecord.
 
 **Eager load using raw SQL without a predefined association**
 
-Let's say we want to load each widget and eager load all the customers who've ever ordered it. We could do that using the above example, but we end up loading a bunch of stuff we don't care about. What if we could define an ad hoc association using raw SQL? Enter `eager_load_one` and `eager_load_many`! See the full documentation for a full description of all options.
+Let's say we want to load each widget and eager load all the customers who've ever ordered it. We could do that using the above example, but we end up loading a lot of useless intermediate records. What if we could define an ad hoc association, using raw SQL, to load exactly what we need? Enter `eager_load_one` and `eager_load_many`! See the full documentation for a full description of all options.
 
 ```ruby
 widgets = OccamsRecord.
@@ -165,7 +165,7 @@ widgets = OccamsRecord.sql(%(
 
 **Performing eager loading with raw SQL**
 
-To perform eager loading with raw SQL you must specify the base model. NOTE some database adapters, notably SQLite, require you to always specify the model.
+To perform eager loading with raw SQL you must specify the base model (unless you use the raw SQL eager loaders `eager_load_one` or `eager_load_many`). NOTE some database adapters, notably SQLite, require you to always specify the model.
 
 ```ruby
 widgets = OccamsRecord.

data/lib/occams-record/raw_query.rb

@@ -11,7 +11,8 @@ module OccamsRecord
   #     cat_id: 5
   #   }).run
   #
-  # If you want to do eager loading, you must first the define a model to pull the associations from.
+  # If you want to do eager loading, you must first the define a model to pull the associations from (unless
+  # you're using the raw SQL eager loaders `eager_load_one` or `eager_load_many`).
   # NOTE If you're using SQLite, you must *always* specify the model.
   #
   #   results = OccamsRecord.

data/lib/occams-record/results.rb

@@ -102,6 +102,19 @@ module OccamsRecord
 
       alias_method :to_hash, :to_h
 
+      def method_missing(name, *args, &block)
+        return super if args.any? or !block.nil?
+        model = self.class.model_name.constantize
+
+        if model.reflections.has_key? name.to_s
+          raise MissingEagerLoadError.new(model.name, name)
+        elsif model.columns_hash.has_key? name.to_s
+          raise MissingColumnSelectError.new(model.name, name)
+        else
+          super
+        end
+      end
+
       #
       # Returns a string with the "real" model name and raw result values.
       #
@@ -111,5 +124,33 @@ module OccamsRecord
         "#<OccamsRecord::Results::Row @model_name=#{self.class.model_name} @raw_values=#{@raw_values}>"
       end
     end
+
+    # Exception when an unloaded association is called on a result row
+    class MissingEagerLoadError < StandardError
+      attr_reader :model_name
+      attr_reader :name
+
+      def initialize(model_name, name)
+        @model_name, @name = model_name, name
+      end
+
+      def message
+        "The association '#{name}' is unavailable on #{model_name} because it has not been eager loaded!"
+      end
+    end
+
+    # Exception when an unselected column is called on a result row
+    class MissingColumnSelectError < StandardError
+      attr_reader :model_name
+      attr_reader :name
+
+      def initialize(model_name, name)
+        @model_name, @name = model_name, name
+      end
+
+      def message
+        "The column '#{name}' is unavailable on #{model_name} because it was not included in the SELECT statement!"
+      end
+    end
   end
 end

data/lib/occams-record/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord