ar-preloader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 584f98e3ee0d6805aeeb6ad6b93403c0385c6ee5
+  data.tar.gz: 864b63c2631cd805b72c4f513a095b312aad4177
+SHA512:
+  metadata.gz: f261c86808b820ad41ace486d0bec69379bdbad03529c42451eece0888039e034e3af3778b5b946bd9dc6797f4049087b3099618bd71b5e61b30b93d9f54466f
+  data.tar.gz: a480f9e5ea51d9ac98922194b9cfecf124b410c2a5226851bf1fdb7ad9b592830f24345de591d4951b4f3a3327afe86596f5fb0095418932f5ef28814a322541

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at csy0013@googlemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ajith Hussain
+
+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,41 @@
+# Ar::Preloader
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ar/preloader`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ar-preloader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar-preloader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ar-preloader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ar-preloader.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ar/preloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar-preloader"
+  spec.version       = Ar::Preloader::VERSION
+  spec.authors       = ["Ajith Hussain"]
+  spec.email         = ["csy0013@googlemail.com"]
+
+  spec.summary       = %q{ar-preloader lets you preload a select list of associations on a specified list of ActiveRecord objects.}
+  spec.description   = %q{ar-preloader lets you fetch the selected associations for a list of ActiveRecord objects.}
+  spec.homepage      = "https://github.com/sparkymat/ar-preloader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activerecord", [">= 4.0.0"])
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ar/preloader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ar/preloader/version.rb

@@ -0,0 +1,5 @@
+module Ar
+  module Preloader
+    VERSION = "1.0.0"
+  end
+end

data/lib/ar/preloader.rb

@@ -0,0 +1,128 @@
+require "ar/preloader/version"
+
+module Ar
+  module Preloader
+    class Error < RuntimeError
+    end
+
+    def self.check_association_exists(klass, association)
+      case association
+      when String, Symbol
+        return klass.reflections.keys.include?(association.to_s)
+      when Hash
+        association.each_pair do |k,v|
+          return false unless klass.reflections.keys.include?(k.to_s)
+
+          associated_klass = klass.reflections[k.to_s].class_name.constantize
+
+          case v
+          when String, Symbol, Hash
+            return false unless Ar::Preloader.check_association_exists(associated_klass, v)
+          when Array
+            v.each do |each_v|
+              return false unless Ar::Preloader.check_association_exists(associated_klass, each_v)
+            end
+          else
+          end
+        end
+
+        return true
+      else
+        return false
+      end
+    end
+
+    def self.preload_association(list, association, inner_associations = [])
+      return if list.length == 0
+
+      case association
+      when String, Symbol
+        klass = list.first.class
+        association_details = klass.reflections[association.to_s]
+        association_klass = association_details.class_name.constantize
+
+        case association_details
+        when ActiveRecord::Reflection::HasManyReflection
+          foreign_key = association_details.foreign_key
+          association_pk = association_klass.primary_key
+
+          query = <<-EOS
+SELECT
+  distinct #{association_klass.table_name}.*
+FROM #{association_klass.table_name}
+WHERE #{association_klass.table_name}.#{foreign_key} in (#{ list.map{ |e| e[klass.primary_key.to_sym].try(:to_s) }.compact.join(",") })
+
+EOS
+
+          association_list = association_klass.find_by_sql(query).to_a
+
+          association_list.preload(*inner_associations)
+
+          list.each do |obj|
+            klass.send :attr_reader, "_#{association}".to_sym
+
+            instance_variable_name = "@_#{association}".to_sym
+            if obj.instance_variable_get(instance_variable_name).nil?
+              obj.instance_variable_set(instance_variable_name, [])
+            end
+
+            association_list.select{ |e| e[foreign_key.to_sym] == obj[klass.primary_key.to_sym] }.each do |association_obj|
+              each_list = obj.instance_variable_get(instance_variable_name)
+              each_list << association_obj
+              obj.instance_variable_set(instance_variable_name, each_list)
+            end
+          end
+        when ActiveRecord::Reflection::BelongsToReflection
+          foreign_key = association_details.foreign_key
+          association_pk = association_klass.primary_key
+
+          query = <<-EOS
+SELECT
+  distinct #{association_klass.table_name}.*
+FROM #{association_klass.table_name}
+WHERE #{association_klass.table_name}.#{association_klass.primary_key} in (#{ list.map{ |e| e[foreign_key.to_sym].try(:to_s) }.compact.join(",") })
+
+EOS
+
+          association_list = association_klass.find_by_sql(query).to_a
+
+          association_list.preload(*inner_associations)
+
+          association_map = association_list.map{ |e| [e[e.class.primary_key.to_sym], e] }.to_h
+
+          list.each do |obj|
+            if obj[foreign_key.to_sym].present? && association_map[obj[foreign_key.to_sym]].present?
+              klass.send :attr_reader, "_#{association}".to_sym
+              obj.instance_variable_set( "@_#{association}".to_sym, association_map[obj[foreign_key.to_sym]] )
+            end
+          end
+        else
+          raise Ar::Preloader::Error.new("Unsupported assocation type: '#{assocation}'")
+        end
+      when Hash
+        association.each_pair do |k,v|
+          Ar::Preloader.preload_association(list, k, [v])
+        end
+      end
+    end
+  end
+end
+
+class Array
+  def preload(*args)
+    return if args.length == 0
+
+    raise Ar::Preloader::Error.new("Cannot preload. Mixed type lists are not supported.") if (self.map(&:class).uniq.count > 1)
+    raise Ar::Preloader::Error.new("Cannot preload. At least one element in array is not an ActiveRecord object.") if (self.reject{|e| e.is_a?(ActiveRecord::Base) }.count > 0)
+
+    args.each do |arg|
+      raise Ar::Preloader::Error.new("Cannot find association '#{arg}' on one or more of the ActiveRecord objects.") if (self.reject{|e| Ar::Preloader.check_association_exists(e.class, arg) }.count > 0)
+    end
+
+    args.each do |arg|
+     Ar::Preloader.preload_association(self, arg) 
+    end
+
+    true
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ar-preloader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ajith Hussain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ar-preloader lets you fetch the selected associations for a list of ActiveRecord
+  objects.
+email:
+- csy0013@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar-preloader.gemspec
+- bin/console
+- bin/setup
+- lib/ar/preloader.rb
+- lib/ar/preloader/version.rb
+homepage: https://github.com/sparkymat/ar-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.5.1
+signing_key: 
+specification_version: 4
+summary: ar-preloader lets you preload a select list of associations on a specified
+  list of ActiveRecord objects.
+test_files: []