occams-record 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a403231d294ef71185626a819905f486206a5fdf6b94e2d0cd7eb459393a5be8
-  data.tar.gz: 0a19d6226484a10da785bcc2dff3d4f8a068b376b8b9443f0f2a1c6eebefe50d
+  metadata.gz: 214f1fb4b74fb65d13461419473fdf865ece2fae7797dc5d9c47ba4d1ad14b45
+  data.tar.gz: 4a836cb9bbc0e5a694aaf7f5220628d1b9ff4afbd11c4e6c5e1e9af1c6f3e3e9
 SHA512:
-  metadata.gz: '05977e1eb8936770d167e200db0925d0b6e93422b72b88925e71ef0d50df703f5e1171b175630f63ac6f4b02696ef9d5320f6b770d7414aea2c2458d1e0038f6'
-  data.tar.gz: eace78527961d84999ad34e99be7a71be64bcbc64377f9cf907c9cc35f6d25f110586e5991f0e315246bc5b5fb3bd4b59a2550f5b58965aab72fb2ec1e3905ca
+  metadata.gz: 112fff206d8d9ea868351b91707b100f0eba99d81f7bb3fcfab9706bb71d611328e7f977796dc36c40c82b029ed1f4df0f38013465c0afeead3ba588b77ca3a9
+  data.tar.gz: f938b969b6688b3203d0b98abf58c18835f7b6eba76525794495778bfcbbad970a2f7cfe161a010dadf329dcd0ee00a57ddb27f0cafdd89114dd63be542f7567

data/README.md

@@ -2,23 +2,80 @@
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
-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:
+OccamsRecord is a high-efficiency, advanced query library for use alongside ActiveRecord. It is **not** an ORM or an ActiveRecord replacement. OccamsRecord can breathe fresh life into your ActiveRecord app by giving it two things:
 
-**Performance**
+### 1) Huge performance gains
 
 * 3x-5x faster than ActiveRecord queries, *minimum*.
 * Uses 1/3 the memory of ActiveRecord query results.
-* Eliminates the N+1 query problem.
+* Eliminates the N+1 query problem. (This often exceeds the baseline 3x-5x gain.)
 
-**More powerful queries & eager loading**
+### 2) Supercharged querying & eager loading
 
-* Customize the SQL used to eager load associations.
-* Use `ORDER BY` with `find_each`/`find_in_batches`.
-* Use `find_each`/`find_in_batches` with raw SQL.
-* Eager load associations when you're writing raw SQL.
-* Eager load "ad hoc associations" using raw SQL.
+Continue using ActiveRecord's query builder, but let Occams take over eager loading and raw SQL calls. None of the examples below are possible with ActiveRecord, but OccamsRecord won't limit you. (More complete examples are shown later, but these should whet your appetite.)
 
-[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:
+**Customize the SQL used to eager load associations**
+
+```ruby
+OccamsRecord.
+  query(User.active).
+  eager_load(:orders, ->(q) { q.where("created_at >= ?", date })
+```
+
+**Use `ORDER BY` with `find_each`/`find_in_batches`**
+
+```ruby
+OccamsRecord.
+  query(Order.order("created_at DESC")).
+  find_each { |order|
+    ...
+  }
+```
+
+**Use `find_each`/`find_in_batches` with raw SQL**
+
+```ruby
+OccamsRecord.
+  sql("
+    SELECT * FROM orders
+    WHERE created_at >= %{date}
+    LIMIT %{batch_limit}
+    OFFSET %{batch_offset}",
+    {date: 10.years.ago}
+  ).
+  find_each { |order|
+    ...
+  }
+```
+
+**Eager load associations when you're writing raw SQL**
+
+```ruby
+OccamsRecord.
+  sql("
+    SELECT * FROM users
+    LEFT OUTER JOIN ...
+  ").
+  model(User).
+  eager_load(:orders)
+```
+
+**Eager load "ad hoc associations" using raw SQL**
+
+Relationships are complicated, and sometimes they can't be expressed in ActiveRecord models. Define your relationship on the fly!
+(Don't worry, there's a full explanation later on.)
+
+```ruby
+OccamsRecord.
+  query(User.all).
+  eager_load_many(:orders, {:id => :user_id}, "
+    SELECT user_id, orders.*
+    FROM orders INNER JOIN ...
+    WHERE user_id IN (%{ids})
+  ")
+```
+
+[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:**
 
 * OccamsRecord results are *read-only*.
 * OccamsRecord results are *purely database rows* - they don't have any instance methods from your Rails models.
@@ -116,7 +173,7 @@ OccamsRecord.
     LIMIT %{batch_limit}
     OFFSET %{batch_offset}
   ", {
-    date: 30.days.ago
+    date: 10.years.ago
   }).
   find_each(batch_size: 1000) do |order|
     ...

data/lib/occams-record.rb

@@ -2,7 +2,7 @@ require 'active_record'
 require 'occams-record/version'
 require 'occams-record/merge'
 require 'occams-record/measureable'
-require 'occams-record/eager_loaders'
+require 'occams-record/eager_loaders/eager_loaders'
 require 'occams-record/results/results'
 require 'occams-record/results/row'
 require 'occams-record/query'

data/lib/occams-record/raw_query.rb

@@ -71,7 +71,6 @@ module OccamsRecord
       @use = use
       @eager_loaders = eager_loaders || EagerLoaders::Context.new
       @query_logger, @measurements = query_logger, measurements
-      @conn = @eager_loaders.model&.connection || ActiveRecord::Base.connection
     end
 
     #
@@ -100,10 +99,10 @@ module OccamsRecord
       result = if measure?
                  record_start_time!
                  measure!(table_name, _escaped_sql) {
-                   @conn.exec_query _escaped_sql
+                   conn.exec_query _escaped_sql
                  }
                else
-                 @conn.exec_query _escaped_sql
+                 conn.exec_query _escaped_sql
                end
       row_class = OccamsRecord::Results.klass(result.columns, result.column_types, @eager_loaders.names, model: @eager_loaders.model, modules: @use)
       rows = result.rows.map { |row| row_class.new row }
@@ -136,9 +135,9 @@ module OccamsRecord
       return sql if binds.empty?
       sql % binds.reduce({}) { |a, (col, val)|
         a[col.to_sym] = if val.is_a? Array
-                          val.map { |x| @conn.quote x }.join(', ')
+                          val.map { |x| conn.quote x }.join(', ')
                         else
-                          @conn.quote val
+                          conn.quote val
                         end
         a
       }
@@ -163,8 +162,8 @@ module OccamsRecord
       end
 
       Enumerator.new do |y|
-        if use_transaction and @conn.open_transactions == 0
-          @conn.transaction {
+        if use_transaction and conn.open_transactions == 0
+          conn.transaction {
             run_batches y, of
           }
         else
@@ -186,5 +185,9 @@ module OccamsRecord
         offset += results.size
       end
     end
+
+    def conn
+      @conn ||= @eager_loaders.model&.connection || ActiveRecord::Base.connection
+    end
   end
 end

data/lib/occams-record/results/results.rb

@@ -9,8 +9,8 @@ module OccamsRecord
              end
 
     #
-    # Dynamically build a class for a specific set of result rows. It inherits from OccamsRecord::Results::Row, and optionall includes
-    # a user-defined module.
+    # Dynamically build a class for a specific set of result rows. It inherits from OccamsRecord::Results::Row, and optionall prepends
+    # user-defined modules.
     #
     # @param column_names [Array<String>] the column names in the result set. The order MUST match the order returned by the query.
     # @param column_types [Hash] Column name => type from an ActiveRecord::Result
@@ -25,6 +25,7 @@ module OccamsRecord
 
         self.columns = column_names.map(&:to_s)
         self.associations = association_names.map(&:to_s)
+        self._model = model
         self.model_name = model ? model.name : nil
         self.table_name = model ? model.table_name : nil
         self.primary_key = if model&.primary_key and (pkey = model.primary_key.to_s) and columns.include?(pkey)
@@ -34,20 +35,6 @@ module OccamsRecord
         # Build getters & setters for associations. (We need setters b/c they're set AFTER the row is initialized
         attr_accessor(*association_names)
 
-        # Build id getters for associations, e.g. "widget_ids" for "widgets"
-        self.associations.each do |assoc|
-          if (ref = model.reflections[assoc]) and !ref.polymorphic? and (ref.macro == :has_many or ref.macro == :has_and_belongs_to_many)
-            pkey = ref.association_primary_key.to_sym
-            define_method "#{assoc.singularize}_ids" do
-              begin
-                self.send(assoc).map(&pkey).uniq
-              rescue NoMethodError => e
-                raise MissingColumnError.new(self, e.name)
-              end
-            end
-          end
-        end if model
-
         # Build a getter for each attribute returned by the query. The values will be type converted on demand.
         model_column_types = model ? model.attributes_builder.types : {}
         self.columns.each_with_index do |col, idx|

data/lib/occams-record/results/row.rb

@@ -12,6 +12,7 @@ module OccamsRecord
         attr_accessor :columns
         # Array of associations names
         attr_accessor :associations
+        attr_accessor :_model
         # Name of Rails model
         attr_accessor :model_name
         # Name of originating database table
@@ -106,18 +107,50 @@ module OccamsRecord
         "#<#{self.class.model_name || "Anonymous"} #{self.class.primary_key}: #{id}>"
       end
 
+      IDS_SUFFIX = /_ids$/
       def method_missing(name, *args, &block)
-        return super if args.any? or !block.nil? or self.class.model_name.nil?
-        model = self.class.model_name.constantize
+        model = self.class._model
+        return super if args.any? or !block.nil? or model.nil?
 
-        if model.reflections.has_key? name.to_s
+        name_str = name.to_s
+        assoc = name_str.sub(IDS_SUFFIX, "").pluralize
+        if name_str =~ IDS_SUFFIX and can_define_ids_reader? assoc
+          define_ids_reader! assoc
+          send name
+        elsif model.reflections.has_key? name_str
           raise MissingEagerLoadError.new(self, name)
-        elsif model.columns_hash.has_key? name.to_s
+        elsif model.columns_hash.has_key? name_str
           raise MissingColumnError.new(self, name)
         else
           super
         end
       end
+
+      private
+
+      def can_define_ids_reader?(assoc)
+        model = self.class._model
+        self.class.associations.include?(assoc) &&
+         (ref = model.reflections[assoc]) &&
+         !ref.polymorphic? &&
+         (ref.macro == :has_many || ref.macro == :has_and_belongs_to_many)
+      end
+
+      def define_ids_reader!(assoc)
+        model = self.class._model
+        ref = model.reflections[assoc]
+        pkey = ref.association_primary_key.to_sym
+
+        self.class.class_eval do
+          define_method "#{assoc.singularize}_ids" do
+            begin
+              self.send(assoc).map(&pkey).uniq
+            rescue NoMethodError => e
+              raise MissingColumnError.new(self, e.name)
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/occams-record/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -40,7 +40,6 @@ files:
 - README.md
 - lib/occams-record.rb
 - lib/occams-record/batches.rb
-- lib/occams-record/eager_loaders.rb
 - lib/occams-record/eager_loaders/ad_hoc_base.rb
 - lib/occams-record/eager_loaders/ad_hoc_many.rb
 - lib/occams-record/eager_loaders/ad_hoc_one.rb
@@ -48,6 +47,7 @@ files:
 - lib/occams-record/eager_loaders/belongs_to.rb
 - lib/occams-record/eager_loaders/builder.rb
 - lib/occams-record/eager_loaders/context.rb
+- lib/occams-record/eager_loaders/eager_loaders.rb
 - lib/occams-record/eager_loaders/habtm.rb
 - lib/occams-record/eager_loaders/has_many.rb
 - lib/occams-record/eager_loaders/has_one.rb