jit_preloader 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd36dd4639cc012aff19a8afdfb6bee699cdd1c
-  data.tar.gz: 41d7e22054a231edba2dc80ce3d19ac16e57cef9
+  metadata.gz: d177cc9a1bc25389c34ee7088fa9d0a6182968d2
+  data.tar.gz: 7c265ce1139ab5bd96e978bc3e3213476b335775
 SHA512:
-  metadata.gz: 9cb4b5385ab0e3e7a321ac759372dbd6bd715141b89b92c82773c40f547bef92311bdfa365ad43a7b5d544c8983962f769d39a02949476fa660da305b59792d8
-  data.tar.gz: 5f24a4834a8bff484cdb849702ad71b62ddc10289134dbc1f6ad9431644015244a4ab252a6ddb74ac9d91ed47b9e1963af3cf2041fcd305e3eff0493cf1477b5
+  metadata.gz: cb77c853c929c4bc7c8379de9ebf00240d4f4016dc28814c7745db21365376d838b93a46afc8e89be269603e680c762919dd8ee3f9a8f5ac752e72064803b1e8
+  data.tar.gz: e493b69a1feea9c2ecc5502f66959ae18a02a8414e1b926137123016f01a022d6e12bdadafc8664b29b106a85d7acbc49b42521bc52c062f88d2c8220cceed3b

data/README.md

@@ -137,6 +137,42 @@ Contact.jit_preload.each do |contact|
 end
 ```
 
+### Loading aggregate methods on associations
+
+There is now a `has_many_aggregate` method available for ActiveRecord::Base. This will dynamically create a method available on objects that will allow making aggregate queries for a collection.
+
+```ruby
+# old
+Contact.all.each do |contact|
+  contact.addresses.maximum("LENGTH(street)")
+  contact.addresses.count
+end
+# SELECT * FROM contacts
+# SELECT MAX(LENGTH(street)) FROM addresses WHERE contact_id = 1
+# SELECT COUNT(*) FROM addresses WHERE contact_id = 1
+# SELECT MAX(LENGTH(street)) FROM addresses WHERE contact_id = 2
+# SELECT COUNT(*) FROM addresses WHERE contact_id = 2
+# SELECT MAX(LENGTH(street)) FROM addresses WHERE contact_id = 3
+# SELECT COUNT(*) FROM addresses WHERE contact_id = 3
+# ...
+
+#new
+class Contact < ActiveRecord::Bas
+  has_many :addresses
+  has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)"
+  has_many_aggregate :addresses, :count_all, :count, "*"
+end
+
+Contact.jit_preload.each do |contact|
+  contact.addresses_max_street_length
+  contact.adddresses_count_all
+end
+# SELECT * FROM contacts
+# SELECT contact_id, MAX(LENGTH(street)) FROM addresses WHERE contact_id IN (1, 2, 3, ...) GROUP BY contact_id
+# SELECT contact_id, COUNT(*) FROM addresses WHERE contact_id IN (1, 2, 3, ...) GROUP BY contact_id
+
+```
+
 ### Jit preloading globally across your application
 
 The JitPreloader can be globally enabled, in which case most N+1 queries in your app should just disappear. It is off by default.
@@ -165,7 +201,6 @@ This is mostly a magic bullet, but it doesn't solve all database-related problem
 ```ruby
 Contact.all.each do |contact|
   contact.emails.reload                         # Reloading the association
-  contact.phone_numbers.max("LENGTH(number)")   # Aggregate functions on the association
   contact.addresses.where(billing: true).to_a   # Querying the association
 end
 ```

data/lib/jit_preloader/active_record/base.rb

@@ -5,10 +5,43 @@ module JitPreloadExtension
   included do
     attr_accessor :jit_preloader
     attr_accessor :jit_n_plus_one_tracking
+    attr_accessor :jit_preload_aggregates
   end
 
   class_methods do
     delegate :jit_preload, to: :all
+
+    def has_many_aggregate(assoc, name, aggregate, field, default: 0)
+      define_method("#{assoc}_#{name}") do
+        self.jit_preload_aggregates ||= {}
+        return jit_preload_aggregates[aggregate] if jit_preload_aggregates[aggregate]
+        if jit_preloader
+          reflection = association(assoc).reflection
+          primary_ids = jit_preloader.records.collect{|r| r[reflection.active_record_primary_key] }
+          klass = reflection.klass
+
+          preloaded_data = Hash[klass
+                                 .where(reflection.foreign_key => primary_ids)
+                                 .group(reflection.foreign_key)
+                                 .send(aggregate, field)
+                               ]
+
+          jit_preloader.records.each do |record|
+            record.jit_preload_aggregates ||= {}
+            record.jit_preload_aggregates[aggregate] = preloaded_data[record.id] || default
+          end
+        else
+          self.jit_preload_aggregates[aggregate] = send(assoc).send(aggregate, field) || default
+        end
+        jit_preload_aggregates[aggregate]
+      end
+
+      def reload(*args)
+        self.jit_preload_aggregates = {}
+        super
+      end
+
+    end
   end
 end
 

data/lib/jit_preloader/version.rb

@@ -1,3 +1,3 @@
 module JitPreloader
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/jit_preloader/preloader_spec.rb

@@ -4,9 +4,9 @@ RSpec.describe JitPreloader::Preloader do
 
   let!(:contact1) do
     Contact.create(
-                   name: "Only Addresses", 
+                   name: "Only Addresses",
                    addresses: [
-                               Address.new(street: "123 Fake st", country: canada), 
+                               Address.new(street: "123 Fake st", country: canada),
                                Address.new(street: "21 Jump st", country: usa)
                               ]
                    )
@@ -21,9 +21,9 @@ RSpec.describe JitPreloader::Preloader do
 
   let!(:contact3) do
     Contact.create(
-                   name: "Both!", 
+                   name: "Both!",
                    addresses: [
-                               Address.new(street: "1 First st", country: canada), 
+                               Address.new(street: "1 First st", country: canada),
                                Address.new(street: "10 Tenth Ave", country: usa)
                               ],
                    email_address: EmailAddress.new(address: "woot@woot.com"),
@@ -38,6 +38,36 @@ RSpec.describe JitPreloader::Preloader do
     ->(event, data){ source_map[data[:source]] << data[:association] }
   end
 
+  context "when preloading an aggregate" do
+    context "without jit_preload" do
+      it "generates N+1 query notifications for each one" do
+        ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+          counts = [2,0,2]
+          maxes = [11,0,12]
+          Contact.all.each_with_index do |c, i|
+            expect(c.addresses_count).to eql counts[i]
+            expect(c.addresses_max_street_length).to eql maxes[i]
+          end
+        end
+        contact_queries = [contact1,contact2, contact3].product([["addresses.count", "addresses.maximum"]])
+        expect(source_map).to eql(Hash[contact_queries])
+      end
+    end
+    context "without jit_preload" do
+      it "generates N+1 query notifications for each one" do
+        ActiveSupport::Notifications.subscribed(callback, "n_plus_one_query") do
+          counts = [2,0,2]
+          maxes = [11,0,12]
+          Contact.jit_preload.each_with_index do |c, i|
+            expect(c.addresses_count).to eql counts[i]
+            expect(c.addresses_max_street_length).to eql maxes[i]
+          end
+        end
+        expect(source_map).to eql({})
+      end
+    end
+  end
+
   context "when we marshal dump the active record object" do
     it "nullifes the jit_preloader reference" do
       contacts = Contact.jit_preload.to_a
@@ -73,7 +103,7 @@ RSpec.describe JitPreloader::Preloader do
         end
         contact_queries = [contact1,contact2, contact3].product([["addresses.count", "addresses.sum"]])
         expect(source_map).to eql(Hash[contact_queries])
-      end      
+      end
     end
   end
 
@@ -85,7 +115,7 @@ RSpec.describe JitPreloader::Preloader do
         end
         contact_queries = [contact1,contact2, contact3].product([["addresses.count", "addresses.sum"]])
         expect(source_map).to eql(Hash[contact_queries])
-      end      
+      end
     end
 
     context "when explicitly finding a contact" do
@@ -140,7 +170,7 @@ RSpec.describe JitPreloader::Preloader do
           contact_queries = [contact1,contact2,contact3].product([[:email_address]])
           address_queries = Address.all.product([[:country]])
           expect(source_map).to eql(Hash[address_queries.concat(contact_queries)])
-        end        
+        end
       end
 
       context "and we use jit preload" do

data/spec/support/models.rb

@@ -1,6 +1,9 @@
 class Contact < ActiveRecord::Base
   has_many :addresses
   has_one :email_address
+
+  has_many_aggregate :addresses, :max_street_length, :maximum, "LENGTH(street)"
+  has_many_aggregate :addresses, :count, :count, "*"
 end
 
 class Address < ActiveRecord::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jit_preloader
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Tool to understand N+1 queries and to remove them