polymorphic_preloader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd69a1e51664e96c696043f891baa22fc411721
+  data.tar.gz: 1a0b2a19bcd376494a53cafea94f83c2f0493e2f
+SHA512:
+  metadata.gz: 9f2a7928d774cecaa05f983fc479ed798498b4173bcd5dd9739743b952258ffbaaa7ed47d8de4f933b98206a84da61b9519209712349ba59c3135e69eee03d06
+  data.tar.gz: 62d275ed66ac8ae974e89bc4f6126bdd84dd30fcc9b5570a6409735bebbef41f43261062f508271cf7078229e5cae3b9dbde6769f2e72ae17ec7ee205d0c1395

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Submitting a Pull Request
+
+1. Fork it ( https://github.com/antstorm/polymorphic_preloader/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Implement your feature and write tests for it (`bundle exec rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'railties', '>= 4.0'
+gem 'activerecord', '>= 4.0', require: 'active_record/associations/preloader'
+
+gemspec
+
+gem 'rake', '~> 10.0'
+gem 'rails', '>= 4.0'
+gem 'rspec-rails'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anthony Dmitriyev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# PolymorphicPreloader
+
+This gem does exactly what it says — it preloads nested polymorphic associations on ActiveRecord objects.
+
+Here's a common example:
+
+```ruby
+class Transaction < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :purchase, polymorphic: true
+end
+
+class Product < ActiveRecord::Base
+  has_many :transactions, as: :purchase
+  belongs_to :company
+end
+
+class Service < ActiveRecord::Base
+  has_many :transactions, as: :purchase
+  belongs_to :provider
+end
+```
+
+Suppose we want to show all the products and services that user has purchased. Apparently we want to eager-load `products` with `companies` and `services` with `providers`.
+ActiveRecord won't allow you to do `includes(purchase: [ :company, :provider ])`. Here's where PolymorphicPreloader comes to help.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'polymorphic_preloader', github: 'antstorm/polymorphic_preloader', branch: 'initial-version'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install polymorphic_preloader
+
+## Usage
+
+Considering the above example:
+
+```ruby
+transactions = current_user.transactions.includes(:purchase)
+
+PolymorphicPreloader.new(transactions, :purchase).preload!(product: :company, service: :provider)
+```
+
+## TODO
+
+- Ensure good test coverage
+- Tidy up and release as a gem
+- Hook into ActiveRecord for a delayed preloading and nicer interface (e.g. `includes_polymorphic()`)

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/polymorphic_preloader.rb

@@ -0,0 +1,26 @@
+require 'polymorphic_preloader/version'
+
+class PolymorphicPreloader
+  attr_accessor :grouped_objects, :association_name
+
+  def initialize(objects, association_name)
+    self.association_name = association_name
+    self.grouped_objects = objects.group_by { |object| object.send("#{association_name}_type") }
+  end
+
+  def preload!(associations)
+    grouped_objects.each_pair do |object_type, objects_with_same_association|
+      target_associations = associations[object_type.to_s.underscore.to_sym]
+
+      if target_associations.present?
+        preloader.preload objects_with_same_association, association_name => target_associations
+      end
+    end
+  end
+
+private
+
+  def preloader
+    @preloader ||= ActiveRecord::Associations::Preloader.new
+  end
+end

data/lib/polymorphic_preloader/version.rb

@@ -0,0 +1,3 @@
+class PolymorphicPreloader
+  VERSION = '0.0.1'
+end

data/polymorphic_preloader.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'polymorphic_preloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'polymorphic_preloader'
+  spec.version       = PolymorphicPreloader::VERSION
+  spec.authors       = ['Anthony Dmitriyev']
+  spec.email         = ['antstorm@gmail.com']
+  spec.summary       = 'Eager loading nested polymorphic associations in ActiveRecord'
+  spec.description   = 'Adds the ability to preload nested polymorphic associations in your ActiveRecord queries'
+  spec.homepage      = 'https://github.com/antstorm/polymorphic_preloader'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- spec/*`.split("\n")
+  spec.require_paths = ['lib']
+end

data/spec/polymorphic_preloader_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe PolymorphicPreloader do
+  subject { PolymorphicPreloader }
+
+  it 'can be initialized' do
+    preloader = subject.new([], :key)
+
+    expect(preloader).to be_instance_of(PolymorphicPreloader)
+  end
+
+  it 'stores a local reference to ActiveRecord preloader' do
+    preloader = subject.new([], :key)
+
+    expect(preloader.send(:preloader)).to be_instance_of(ActiveRecord::Associations::Preloader)
+  end
+
+  it 'stores association key' do
+    preloader = subject.new([], :polymorphic)
+
+    expect(preloader.association_name).to be_eql(:polymorphic)
+  end
+
+  it 'groups objects by polymorphic association' do
+    object_1 = double
+    allow(object_1).to receive(:polymorphic_type) { 'First' }
+
+    object_2 = double
+    allow(object_2).to receive(:polymorphic_type) { 'Second' }
+
+    preloader = subject.new([object_1, object_2], :polymorphic)
+
+    expect(preloader.grouped_objects).to include('First' => [object_1])
+    expect(preloader.grouped_objects).to include('Second' => [object_2])
+  end
+
+  it 'preloads association' do
+    object = double
+    allow(object).to receive(:polymorphic_type) { 'Object' }
+
+    preloader = subject.new([object], :polymorphic)
+
+    expect(preloader.send(:preloader)).to receive(:preload).with([object], polymorphic: :association)
+
+    preloader.preload!(object: :association)
+  end
+
+  it 'preloads multiple associations' do
+    object_1 = double
+    allow(object_1).to receive(:polymorphic_type) { 'FirstObject' }
+
+    object_2 = double
+    allow(object_2).to receive(:polymorphic_type) { 'SecondObject' }
+
+    preloader = subject.new([object_1, object_2], :polymorphic)
+
+    expect(preloader.send(:preloader)).to receive(:preload).with([object_1], polymorphic: :association_1)
+    expect(preloader.send(:preloader)).to receive(:preload).with([object_2], polymorphic: :association_2)
+
+    preloader.preload!(first_object: :association_1, second_object: :association_2)
+  end
+
+  it 'does not preload not specified associations' do
+    object = double
+    allow(object).to receive(:polymorphic_type) { 'Object' }
+
+    preloader = subject.new([object], :polymorphic)
+
+    expect(preloader.send(:preloader)).not_to receive(:preload)
+
+    preloader.preload!(another_object: :association)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: polymorphic_preloader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anthony Dmitriyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-05 00:00:00.000000000 Z
+dependencies: []
+description: Adds the ability to preload nested polymorphic associations in your ActiveRecord
+  queries
+email:
+- antstorm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/polymorphic_preloader.rb
+- lib/polymorphic_preloader/version.rb
+- polymorphic_preloader.gemspec
+- spec/polymorphic_preloader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/antstorm/polymorphic_preloader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Eager loading nested polymorphic associations in ActiveRecord
+test_files:
+- spec/polymorphic_preloader_spec.rb
+- spec/spec_helper.rb