ar-preloader 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 584f98e3ee0d6805aeeb6ad6b93403c0385c6ee5
4
+ data.tar.gz: 864b63c2631cd805b72c4f513a095b312aad4177
5
+ SHA512:
6
+ metadata.gz: f261c86808b820ad41ace486d0bec69379bdbad03529c42451eece0888039e034e3af3778b5b946bd9dc6797f4049087b3099618bd71b5e61b30b93d9f54466f
7
+ data.tar.gz: a480f9e5ea51d9ac98922194b9cfecf124b410c2a5226851bf1fdb7ad9b592830f24345de591d4951b4f3a3327afe86596f5fb0095418932f5ef28814a322541
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.gem
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at csy0013@googlemail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in ar-preloader.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Ajith Hussain
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # Ar::Preloader
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'ar-preloader'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install ar-preloader
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ 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.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'ar/preloader/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "ar-preloader"
8
+ spec.version = Ar::Preloader::VERSION
9
+ spec.authors = ["Ajith Hussain"]
10
+ spec.email = ["csy0013@googlemail.com"]
11
+
12
+ spec.summary = %q{ar-preloader lets you preload a select list of associations on a specified list of ActiveRecord objects.}
13
+ spec.description = %q{ar-preloader lets you fetch the selected associations for a list of ActiveRecord objects.}
14
+ spec.homepage = "https://github.com/sparkymat/ar-preloader"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency("activerecord", [">= 4.0.0"])
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.11"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "ar/preloader"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ module Ar
2
+ module Preloader
3
+ VERSION = "1.0.0"
4
+ end
5
+ end
@@ -0,0 +1,128 @@
1
+ require "ar/preloader/version"
2
+
3
+ module Ar
4
+ module Preloader
5
+ class Error < RuntimeError
6
+ end
7
+
8
+ def self.check_association_exists(klass, association)
9
+ case association
10
+ when String, Symbol
11
+ return klass.reflections.keys.include?(association.to_s)
12
+ when Hash
13
+ association.each_pair do |k,v|
14
+ return false unless klass.reflections.keys.include?(k.to_s)
15
+
16
+ associated_klass = klass.reflections[k.to_s].class_name.constantize
17
+
18
+ case v
19
+ when String, Symbol, Hash
20
+ return false unless Ar::Preloader.check_association_exists(associated_klass, v)
21
+ when Array
22
+ v.each do |each_v|
23
+ return false unless Ar::Preloader.check_association_exists(associated_klass, each_v)
24
+ end
25
+ else
26
+ end
27
+ end
28
+
29
+ return true
30
+ else
31
+ return false
32
+ end
33
+ end
34
+
35
+ def self.preload_association(list, association, inner_associations = [])
36
+ return if list.length == 0
37
+
38
+ case association
39
+ when String, Symbol
40
+ klass = list.first.class
41
+ association_details = klass.reflections[association.to_s]
42
+ association_klass = association_details.class_name.constantize
43
+
44
+ case association_details
45
+ when ActiveRecord::Reflection::HasManyReflection
46
+ foreign_key = association_details.foreign_key
47
+ association_pk = association_klass.primary_key
48
+
49
+ query = <<-EOS
50
+ SELECT
51
+ distinct #{association_klass.table_name}.*
52
+ FROM #{association_klass.table_name}
53
+ WHERE #{association_klass.table_name}.#{foreign_key} in (#{ list.map{ |e| e[klass.primary_key.to_sym].try(:to_s) }.compact.join(",") })
54
+
55
+ EOS
56
+
57
+ association_list = association_klass.find_by_sql(query).to_a
58
+
59
+ association_list.preload(*inner_associations)
60
+
61
+ list.each do |obj|
62
+ klass.send :attr_reader, "_#{association}".to_sym
63
+
64
+ instance_variable_name = "@_#{association}".to_sym
65
+ if obj.instance_variable_get(instance_variable_name).nil?
66
+ obj.instance_variable_set(instance_variable_name, [])
67
+ end
68
+
69
+ association_list.select{ |e| e[foreign_key.to_sym] == obj[klass.primary_key.to_sym] }.each do |association_obj|
70
+ each_list = obj.instance_variable_get(instance_variable_name)
71
+ each_list << association_obj
72
+ obj.instance_variable_set(instance_variable_name, each_list)
73
+ end
74
+ end
75
+ when ActiveRecord::Reflection::BelongsToReflection
76
+ foreign_key = association_details.foreign_key
77
+ association_pk = association_klass.primary_key
78
+
79
+ query = <<-EOS
80
+ SELECT
81
+ distinct #{association_klass.table_name}.*
82
+ FROM #{association_klass.table_name}
83
+ WHERE #{association_klass.table_name}.#{association_klass.primary_key} in (#{ list.map{ |e| e[foreign_key.to_sym].try(:to_s) }.compact.join(",") })
84
+
85
+ EOS
86
+
87
+ association_list = association_klass.find_by_sql(query).to_a
88
+
89
+ association_list.preload(*inner_associations)
90
+
91
+ association_map = association_list.map{ |e| [e[e.class.primary_key.to_sym], e] }.to_h
92
+
93
+ list.each do |obj|
94
+ if obj[foreign_key.to_sym].present? && association_map[obj[foreign_key.to_sym]].present?
95
+ klass.send :attr_reader, "_#{association}".to_sym
96
+ obj.instance_variable_set( "@_#{association}".to_sym, association_map[obj[foreign_key.to_sym]] )
97
+ end
98
+ end
99
+ else
100
+ raise Ar::Preloader::Error.new("Unsupported assocation type: '#{assocation}'")
101
+ end
102
+ when Hash
103
+ association.each_pair do |k,v|
104
+ Ar::Preloader.preload_association(list, k, [v])
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
110
+
111
+ class Array
112
+ def preload(*args)
113
+ return if args.length == 0
114
+
115
+ raise Ar::Preloader::Error.new("Cannot preload. Mixed type lists are not supported.") if (self.map(&:class).uniq.count > 1)
116
+ 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)
117
+
118
+ args.each do |arg|
119
+ 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)
120
+ end
121
+
122
+ args.each do |arg|
123
+ Ar::Preloader.preload_association(self, arg)
124
+ end
125
+
126
+ true
127
+ end
128
+ end
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ar-preloader
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Ajith Hussain
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-04-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activerecord
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 4.0.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 4.0.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: ar-preloader lets you fetch the selected associations for a list of ActiveRecord
70
+ objects.
71
+ email:
72
+ - csy0013@googlemail.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - LICENSE.txt
83
+ - README.md
84
+ - Rakefile
85
+ - ar-preloader.gemspec
86
+ - bin/console
87
+ - bin/setup
88
+ - lib/ar/preloader.rb
89
+ - lib/ar/preloader/version.rb
90
+ homepage: https://github.com/sparkymat/ar-preloader
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.5.1
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: ar-preloader lets you preload a select list of associations on a specified
114
+ list of ActiveRecord objects.
115
+ test_files: []