smart_preloads 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5203b8b2b5dbd92bc5643f6688a3e73571150d85
-  data.tar.gz: 504790d10fa6b9e43733d5e8ae012fcf2c8e5c03
+  metadata.gz: 18f4e3190dc51950fb7a67eb68be6e2f9d8b86a4
+  data.tar.gz: f47c16e997076ce9041616ae243d50974b4a57be
 SHA512:
-  metadata.gz: 76ca0adc8537ffcf01e1459185ecd2c0143f65d6b74d060d478c0289a310e35a4befaf9b793758d1ff4ae486c11266eba430bfe38edfdc4d96d378915a646fe1
-  data.tar.gz: d5d259616f5b62597f3eeeeedfa2c7191b04ccee0238817ca2a8b44897472a985e5f586469a57199859dbc1793110adf4766db857ca36c1900895d8df7c781e7
+  metadata.gz: 60e9e6f7c3fbc8da1e845ab31ef6e74ca7fca4bc4ca48dd40d43fb303374abea9426bd43ed9b825fce77243709071c1f151cc44f626b94d89884f579368dad39
+  data.tar.gz: b3ca7004e8f80ba53a1cea14985767cd210e93d61df45e9ce4b8c525a4252c6d2057c66e0665663610b4c1780ac4be3b7c14082b2e1d76ad773e16c55c4aa662

data/README.md

@@ -5,7 +5,15 @@ when you do not have control over which associations are going to be used by
 the view, like when you provide users customizable views with
 [Liquid](https://github.com/chamnap/liquid-rails).
 
-## How it Works
+## Installation
+
+You can use `gem install smart_preloads` to install it manually or use Bundler:
+
+```ruby
+gem 'smart_preloads'
+```
+
+## Usage
 
 You have to call `smart_preloads` at the end of your association. This will
 generate a smart list of items that will load associations **if and when**
@@ -39,13 +47,24 @@ end
 #=> SELECT "categories".* FROM "categories" WHERE "categories"."id" IN (1, 2)
 ```
 
-## Installation
+## How it Works
 
-You can use `gem install smart_preloads` to install it manually or use Bundler:
+In order for it to work, `smart_preloads` has a custom list class
+(`SmartPreloads::List`) and a custom item class for each item in a list
+(`SmartPreloads::Item`).
 
-```ruby
-gem 'smart_preloads'
-```
+The List class allows detecting when the collection
+is really used (iterated) so only then the associations will be detected and
+mokey patched in place. This is needed so whenever a call to an association
+is made it will be loaded, even from calls from within the object itself.
+
+The Item class monkey patches all association methods in the objects loaded
+to intercept the calls. The monkey patch is **in place**, not global. Only
+the objects in the `smart_preloads` collection will be monkey patched.
+
+Note that when you call `Author.all.smart_preloads.first` you will **not**
+have an instance of `Author`. Instead, you will have an instance of
+`SmartPreloads::Item` that delegates calls to the original `Author` object.
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/smart_preloads/item.rb

@@ -3,23 +3,24 @@ module SmartPreloads
     def initialize(record, loader: nil)
       super(record)
       @loader = loader || Loader.new([record])
+      _override_associations
+    end
 
-      record.class.reflections.each do |key, association|
-        original = method(key)
-        singleton_class.class_exec do
-          body = nil
-          if %i(has_many has_and_belongs_to_many).include?(association.macro)
-            body = lambda do
-              List.new(original.call, loader: @loader.nested(key.to_sym))
-            end
-          else
-            body = lambda do
-              @loader.load(key.to_sym)
-              original.call
-            end
+    def _override_associations
+      __getobj__.class.reflections.each do |key, association|
+        body = nil
+        loader = @loader
+        if %i(has_many has_and_belongs_to_many).include?(association.macro)
+          body = lambda do
+            List.new(super(), loader: loader.nested(key.to_sym))
+          end
+        else
+          body = lambda do
+            loader.load(key.to_sym)
+            super()
           end
-          define_method(key, &body)
         end
+        __getobj__.define_singleton_method(key, &body)
       end
     end
   end

data/lib/smart_preloads/list.rb

@@ -9,7 +9,11 @@ module SmartPreloads
 
     def each
       loaded_collection.each do |resource|
-        yield Item.new(resource, loader: @loader)
+        if resource.is_a?(Item)
+          yield resource
+        else
+          yield Item.new(resource, loader: @loader)
+        end
       end
     end
 
@@ -21,6 +25,14 @@ module SmartPreloads
       to_a.size
     end
 
+    def +(other)
+      to_a + other.to_a
+    end
+
+    def [](idx)
+      to_a[idx]
+    end
+
     protected
 
     def loaded_collection

data/smart_preloads.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: smart_preloads 0.0.1 ruby lib
+# stub: smart_preloads 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "smart_preloads".freeze
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Diego Aguir Selzlein".freeze]
-  s.date = "2017-05-02"
+  s.date = "2017-05-26"
   s.description = "Avoid N + 1 queries without having to worry about it at all!".freeze
   s.email = "diegoselzlein@gmail.com".freeze
   s.extra_rdoc_files = [

data/spec/smart_preloads_spec.rb

@@ -12,6 +12,10 @@ class Book < ActiveRecord::Base
   belongs_to :author
   belongs_to :category
   has_many :tags, as: :taggable
+
+  def author_name
+    author.try!(:name)
+  end
 end
 
 class Tag < ActiveRecord::Base
@@ -78,4 +82,31 @@ describe 'SmartPreloads' do
     expect(list.first.books.first.association(:category)).to be_loaded
     expect(list.last.books.first.association(:category)).to  be_loaded
   end
+
+  it 'supports concatenation' do
+    Book.create!(name: 'Rework')
+    Book.create!(name: 'Lean Startup')
+    Author.create!(books: [Book.first])
+    Author.create!(books: [Book.last])
+
+    list = Book.all.smart_preloads + Author.all.smart_preloads
+
+    list[2].books.to_a
+    expect(list[3].association(:books)).to be_loaded
+
+    list.first.author
+    expect(list[1].association(:author)).to be_loaded
+  end
+
+  it 'works with internal methods' do
+    a1 = Author.create!(name: 'John')
+    a2 = Author.create!(name: 'Doe')
+    Book.create!(name: 'Rework', author: a1)
+    Book.create!(name: 'Lean Startup', author: a2)
+
+    list = Book.all.smart_preloads
+
+    list.first.author_name
+    expect(list[1].association(:author)).to be_loaded
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_preloads
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Diego Aguir Selzlein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec