eager_loadable_polymorphic_association 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eager_loadable_polymorphic_association.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 moro
+
+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,44 @@
+# EagerLoadablePolymorphicAssociation
+
+add eager loading functionality to ActiveRecord's polymorphic association.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eager_loadable_polymorphic_association'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eager_loadable_polymorphic_association
+
+## Usage
+
+```
+class Paste < ActiveRecord::Base
+  extend EagerLoadablePolymorphicAssociation
+
+  belongs_to :item, polymorphic: true
+  eager_loadable_polymorphic_association :item, [:snippet, :picture]
+end
+
+Paste.with_item.all # => eager load associated snippet or picture
+```
+
+1. extend this module
+2. decrare `eager\_loadable\_polymorphic\_association` during class definition.
+  1. first argument is polymorphic association name
+  2. second, pass an array which contains associated objects class names (item_type.under_score).
+ 3. step 2 defines new scope `with\_item`, which is the scope to eager load polymorphic objects.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:spec]
+

data/eager_loadable_polymorphic_association.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eager_loadable_polymorphic_association/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "eager_loadable_polymorphic_association"
+  gem.version       = EagerLoadablePolymorphicAssociation::VERSION
+  gem.authors       = ["moro"]
+  gem.email         = ["moronatural@gmail.com"]
+  gem.description   = %q{add eager loading functionality to ActiveRecord's polymorphic association.}
+  gem.summary       = %q{add eager loading functionality to ActiveRecord's polymorphic association.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activerecord", [">= 3.0"]
+
+  gem.add_development_dependency "rspec", [">= 2.0"]
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "database_cleaner"
+end

data/lib/eager_loadable_polymorphic_association.rb

@@ -0,0 +1,62 @@
+require 'active_support/core_ext/string/strip'
+require 'eager_loadable_polymorphic_association/version'
+
+module EagerLoadablePolymorphicAssociation
+  class AssociationWriter
+    def initialize(association, types)
+      raise ArgumentError, "#{association} is not polymorphic association" unless association.options[:polymorphic]
+      @association = association
+      @types = types
+    end
+
+    def belong_to_them(ref_from)
+      @types.each do |t|
+        ref_from.belongs_to t, readonly: true, foreign_key: fk, conditions: condition_sql(t.to_s.classify.constantize)
+      end
+    end
+
+    def define_scope(ref_from)
+      ref_from.scope "with_#{@association.name}", ref_from.includes(*@types)
+    end
+
+    def override_accessor(ref_from)
+      ref_from.class_eval <<-RUBY.strip_heredoc
+        def #{@association.name}
+          concreate_item = association(self[#{ft.dump}].underscore.to_sym)
+          polymorphic_item = association(:#{@association.name})
+          if concreate_item.loaded? && !polymorphic_item.loaded?
+            polymorphic_item.target = concreate_item.target
+          end
+          super
+        end
+      RUBY
+    end
+
+    private
+
+    # aliasses
+    def ft
+      @association.foreign_type
+    end
+
+    def fk
+      @association.foreign_key
+    end
+
+    def tbl
+      @association.active_record.quoted_table_name
+    end
+
+    def condition_sql(klass)
+      ["EXISTS(SELECT 1 FROM #{tbl} WHERE #{tbl}.#{ft} = ? AND #{tbl}.#{fk} = #{klass.quoted_table_name}.#{klass.primary_key})", klass.name]
+    end
+  end
+
+  def eager_loadable_polymorphic_association(association_name, types)
+    assoc = AssociationWriter.new(reflections[association_name.to_sym], types)
+
+    assoc.belong_to_them(self)
+    assoc.define_scope(self)
+    assoc.override_accessor(self)
+  end
+end

data/lib/eager_loadable_polymorphic_association/version.rb

@@ -0,0 +1,3 @@
+module EagerLoadablePolymorphicAssociation
+  VERSION = "0.0.1"
+end

data/spec/active_record_models.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+  adapter: 'sqlite3',
+  database: ':memory:'
+})
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table 'pastes', force: true do |t|
+    t.belongs_to :item, polymorphic: true
+    t.timestamps
+  end
+
+  create_table 'snippets', force: true do |t|
+    t.text 'content', null: false
+    t.timestamps
+  end
+
+  create_table 'pictures', force: true do |t|
+    t.string :url, null: false
+    t.timestamps
+  end
+end
+
+class Paste < ActiveRecord::Base
+  belongs_to :item, polymorphic: true
+end
+
+class Snippet < ActiveRecord::Base
+end
+
+class Picture < ActiveRecord::Base
+end

data/spec/eager_loadable_polymorphic_association/paste_spec.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+require 'spec_helper'
+require 'eager_loadable_polymorphic_association'
+
+describe EagerLoadablePolymorphicAssociation do
+  Paste.class_eval do
+    extend EagerLoadablePolymorphicAssociation
+
+    eager_loadable_polymorphic_association :item, [:snippet, :picture]
+  end
+
+  context 'included into Paste' do
+    let!(:snippet) do
+      Snippet.create!(content: 'Lorem porem').tap {|item| Paste.create(item: item) }
+    end
+
+    let!(:picture) {
+      Picture.create!(url: 'http://example.com/example.jpeg').tap {|item| Paste.create(item: item) }
+    }
+
+    before do
+      @loaded_pastes = Paste.with_item.order(:id).all
+      ActiveRecord::Base.connection.should_not_receive(:select_all)
+    end
+
+    specify { @loaded_pastes.map(&:item).should =~ [snippet, picture] }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'active_record_models'
+
+require 'database_cleaner'
+DatabaseCleaner.strategy = :transaction
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.before do
+    DatabaseCleaner.start
+  end
+  config.after do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: eager_loadable_polymorphic_association
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- moro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: add eager loading functionality to ActiveRecord's polymorphic association.
+email:
+- moronatural@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eager_loadable_polymorphic_association.gemspec
+- lib/eager_loadable_polymorphic_association.rb
+- lib/eager_loadable_polymorphic_association/version.rb
+- spec/active_record_models.rb
+- spec/eager_loadable_polymorphic_association/paste_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -864253679892836643
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -864253679892836643
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: add eager loading functionality to ActiveRecord's polymorphic association.
+test_files:
+- spec/active_record_models.rb
+- spec/eager_loadable_polymorphic_association/paste_spec.rb
+- spec/spec_helper.rb