activerecord-preload_query 0.1.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: c18f581006c1e6e08c09778131433f4b4df32589
4
+ data.tar.gz: 1733fedaaab2683023fa4f0ece33fa87630b0c0a
5
+ SHA512:
6
+ metadata.gz: d63a4b9caee959307e8d56c25612ed85be1d0b161e459783a9cad17daf652d3db3c7caec2d8ba2b2ae128b825c3f5bb3a3fa2a1b3be9808f94f5360c34c8c95a
7
+ data.tar.gz: 3a9a9d3437b922ddef82125c4bddf9c4d5523d38318f67a887c9ffdff66915ebad73a0154de0273b3663408e764ac069ed8a94208ea3914c79110bb81bc9c28e
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ *.lock
2
+ /.bundle/
3
+ /.yardoc
4
+ /Gemfile.lock
5
+ /_yardoc/
6
+ /coverage/
7
+ /doc/
8
+ /pkg/
9
+ /spec/reports/
10
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,35 @@
1
+ sudo: false
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.2.3
6
+ - 2.3.1
7
+ - ruby-head
8
+
9
+ gemfile:
10
+ - Gemfile
11
+ - gemfiles/Gemfile-5-0-stable
12
+ - gemfiles/Gemfile-5-0
13
+ - gemfiles/Gemfile-4-2-stable
14
+ - gemfiles/Gemfile-4-2
15
+ - gemfiles/Gemfile-4-1-stable
16
+ - gemfiles/Gemfile-4-1
17
+ - gemfiles/Gemfile-4-0-stable
18
+ - gemfiles/Gemfile-4-0
19
+
20
+ matrix:
21
+ allow_failures:
22
+ - gemfile: gemfiles/Gemfile-4-2-stable
23
+ rvm: ruby-head
24
+ - gemfile: gemfiles/Gemfile-4-1-stable
25
+ rvm: ruby-head
26
+ - gemfile: gemfiles/Gemfile-4-0-stable
27
+ rvm: ruby-head
28
+ - gemfile: gemfiles/Gemfile-4-2
29
+ rvm: ruby-head
30
+ - gemfile: gemfiles/Gemfile-4-1
31
+ rvm: ruby-head
32
+ - gemfile: gemfiles/Gemfile-4-0
33
+ rvm: ruby-head
34
+
35
+ before_install: gem install bundler -v 1.12.5
@@ -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 ceritium@gmail.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,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in activerecord-preload_query.gemspec
4
+ gemspec
5
+
6
+ gem 'rails', '>= 4.0.0.beta', '< 5'
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Jose Galisteo
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,67 @@
1
+ # Activerecord::PreloadQuery
2
+
3
+ [![Build Status](https://travis-ci.org/ceritium/activerecord-preload_query.svg?branch=master)](https://travis-ci.org/ceritium/activerecord-preload_query)
4
+
5
+
6
+ PreloadQuery allows you preload queries and have them available as would a relations and `preload` of ActiveRecord.
7
+
8
+ For example, having `Category` and `Product` classes and a method that adds the price of products in a category like `self.sum_price`:
9
+
10
+ ```ruby
11
+ class Category < ActiveRecord::Base
12
+ has_many :products
13
+
14
+ class << self
15
+ def sum_price(ids)
16
+ where(id: ids).group("categories.id").joins(:products).select("categories.id, sum(products.price) AS sum_price")
17
+ end
18
+ end
19
+ end
20
+
21
+ class Product < ActiveRecord::Base
22
+ belongs_to :category
23
+ end
24
+ ```
25
+
26
+ We can do:
27
+
28
+ ```ruby
29
+ Category.limit(10).preload_query(:sum_price).each do |caregory|
30
+ p category.name
31
+ p category.sum_price
32
+ end
33
+ ```
34
+
35
+ The method to be preloaded must return an enumerable and each element must respond to `id` and the same method name as you can see in the example.
36
+
37
+ ## Installation
38
+
39
+ Add this line to your application's Gemfile:
40
+
41
+ ```ruby
42
+ gem 'activerecord-preload_query'
43
+ ```
44
+
45
+ And then execute:
46
+
47
+ $ bundle
48
+
49
+ Or install it yourself as:
50
+
51
+ $ gem install activerecord-preload_query
52
+
53
+ ## Development
54
+
55
+ 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.
56
+
57
+ 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).
58
+
59
+ ## Contributing
60
+
61
+ Bug reports and pull requests are welcome on GitHub at https://github.com/ceritium/activerecord-preload_query. 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.
62
+
63
+
64
+ ## License
65
+
66
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
67
+
data/Rakefile ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
3
+ require 'rake/testtask'
4
+
5
+ Rake::TestTask.new do |t|
6
+ t.libs = ["test"]
7
+ t.pattern = "test/**/*_test.rb"
8
+ t.ruby_opts = ['-w']
9
+ end
10
+
11
+ task :default => :test
@@ -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 'activerecord/preload_query/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "activerecord-preload_query"
8
+ spec.version = Activerecord::PreloadQuery::VERSION
9
+ spec.authors = ["Jose Galisteo"]
10
+ spec.email = ["ceritium@gmail.com"]
11
+
12
+ spec.summary = %q{Preload queries like relations.}
13
+ spec.description = %q{PreloadQuery allows you preload queries and have them available as would a relations and `preload` of ActiveRecord.}
14
+ spec.homepage = "https://github.com/ceritium/activerecord-preload_query"
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_development_dependency "bundler", "~> 1.12"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency 'minitest', '>= 3'
25
+ spec.add_development_dependency 'sqlite3', '~> 1.3'
26
+ spec.add_development_dependency 'pry'
27
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "activerecord/preload_query"
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
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', '~> 4.0.5'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', github: 'rails/rails', branch: '4-0-stable'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', '~> 4.1.8'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', github: 'rails/rails', branch: '4-1-stable'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', '~> 4.2.1'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', github: 'rails/rails', branch: '4-2-stable'
@@ -0,0 +1,6 @@
1
+
2
+ source 'https://rubygems.org'
3
+
4
+ gemspec :path => '..'
5
+
6
+ gem 'rails', '~> 5.0'
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec :path => '..'
4
+
5
+ gem 'rails', github: 'rails/rails', branch: '5-0-stable'
@@ -0,0 +1,5 @@
1
+ module Activerecord
2
+ module PreloadQuery
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,40 @@
1
+ require 'active_support/lazy_load_hooks'
2
+ require "activerecord/preload_query/version"
3
+
4
+ ActiveSupport.on_load(:active_record) do
5
+
6
+ class ActiveRecord::Associations::CollectionProxy
7
+ delegate :preload_query, to: :scope
8
+ end
9
+
10
+ class ActiveRecord::Relation
11
+ alias_method :origin_initialize, :initialize
12
+
13
+ def initialize(*args)
14
+ origin_initialize(*args)
15
+ @preload_queries = []
16
+ end
17
+
18
+ def preload_query(*names)
19
+ @preload_queries.push(*Array.wrap(names))
20
+ self
21
+ end
22
+
23
+ private
24
+
25
+ alias_method :origin_exec_queries, :exec_queries
26
+ def exec_queries
27
+ records = origin_exec_queries
28
+
29
+ # added
30
+ @preload_queries.each do |pc|
31
+ _tmp = @klass.send(pc, records.map(&:id)).map{|x| [x.id, x.send(pc)]}.to_h
32
+ records.map do |record|
33
+ record.define_singleton_method pc, lambda { _tmp[record.id] }
34
+ end
35
+ end
36
+
37
+ records
38
+ end
39
+ end
40
+ end
metadata ADDED
@@ -0,0 +1,135 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: activerecord-preload_query
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jose Galisteo
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '3'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '3'
55
+ - !ruby/object:Gem::Dependency
56
+ name: sqlite3
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.3'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.3'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: PreloadQuery allows you preload queries and have them available as would
84
+ a relations and `preload` of ActiveRecord.
85
+ email:
86
+ - ceritium@gmail.com
87
+ executables: []
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - ".gitignore"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - activerecord-preload_query.gemspec
99
+ - bin/console
100
+ - bin/setup
101
+ - gemfiles/Gemfile-4-0
102
+ - gemfiles/Gemfile-4-0-stable
103
+ - gemfiles/Gemfile-4-1
104
+ - gemfiles/Gemfile-4-1-stable
105
+ - gemfiles/Gemfile-4-2
106
+ - gemfiles/Gemfile-4-2-stable
107
+ - gemfiles/Gemfile-5-0
108
+ - gemfiles/Gemfile-5-0-stable
109
+ - lib/activerecord/preload_query.rb
110
+ - lib/activerecord/preload_query/version.rb
111
+ homepage: https://github.com/ceritium/activerecord-preload_query
112
+ licenses:
113
+ - MIT
114
+ metadata: {}
115
+ post_install_message:
116
+ rdoc_options: []
117
+ require_paths:
118
+ - lib
119
+ required_ruby_version: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: '0'
124
+ required_rubygems_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: '0'
129
+ requirements: []
130
+ rubyforge_project:
131
+ rubygems_version: 2.5.1
132
+ signing_key:
133
+ specification_version: 4
134
+ summary: Preload queries like relations.
135
+ test_files: []