mongoid-denormalization 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: 3450a3db2d1001f58818aa4be939989346d2fc6c
4
+ data.tar.gz: df43b7783536398fd4860e2162636250678a531a
5
+ SHA512:
6
+ metadata.gz: 8b6397fdc8db41602144f6ae34e8f0735863affde60cc1de5213a512e5742a3f10c8971d664a0aa48211c7387fac3f0ee1970ba22c2e6f4314938568b518b27f
7
+ data.tar.gz: faae101317f6782222bd3db9a21f7c8bdb69cf7310747e15876f792fd1ae6bdac66e40ab4253e08aba86c56c0a4c85ea1d663be45cb150de4d374fe8a47c0d8d
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.2
5
+ before_install: gem install bundler -v 1.16.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at TODO: Write your email address. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in mongoid-denormalization.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 TODO: Write your name
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,43 @@
1
+ # Mongoid::Denormalization
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/mongoid/denormalization`. 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 'mongoid-denormalization'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install mongoid-denormalization
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]/mongoid-denormalization. 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
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the Mongoid::Denormalization project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mongoid-denormalization/blob/master/CODE_OF_CONDUCT.md).
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
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "mongoid/denormalization"
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(__FILE__)
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 Mongoid
2
+ module Denormalization
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,198 @@
1
+ require "mongoid/denormalization/version"
2
+
3
+ module Mongoid
4
+ module Denormalization
5
+ extend ActiveSupport::Concern
6
+
7
+ included do
8
+ def force_denormalize!
9
+ force_denormalize
10
+ self.save
11
+ end
12
+
13
+ def force_denormalize
14
+ end
15
+ end
16
+
17
+ module Helpers
18
+ def self.update_from_klass_changes(to_klass_infos, from_doc_id, field_value)
19
+ to_klass_infos.each do |to_klass_info|
20
+ selector = to_klass_info[:selector_proc].call(from_doc_id, field_value)
21
+ to_klass_info[:klasses].each do |klass|
22
+ query = klass.where(selector)
23
+ while query.present?
24
+ klass.collection.find(selector).update_many({"$set" => {to_klass_info[:updator].to_sym => field_value}}, multi: true, safe: true)
25
+ end
26
+ end
27
+ end
28
+ end
29
+
30
+ def self.field_value(from_doc, field_terms)
31
+ value = from_doc
32
+ field_terms.each do |field_term|
33
+ value = value.send(field_term)
34
+ end
35
+ return value
36
+ end
37
+ end
38
+
39
+
40
+ module ClassMethods
41
+ def denormalize_from(relation, field_name, denormalized_field_name: nil, to_klass_infos: [])
42
+ to_klass = self
43
+ field_terms = field_name.to_s.split(".")
44
+ denormalized_field_name ||= [relation, field_terms.last].flatten.join("_")
45
+
46
+ if to_klass_infos.blank? && !(to_klass.embedded?)
47
+ to_klass_infos = [{
48
+ klasses: [to_klass],
49
+ selector_proc: Proc.new do |id, value|
50
+ {"#{relation}_id".to_sym => id, denormalized_field_name.to_sym => {"$ne" => value}}
51
+ end,
52
+ updator: denormalized_field_name,
53
+ index_key: "#{relation}_id"
54
+ }]
55
+ end
56
+
57
+ # to_klass_infos.each do |to_klass_info|
58
+ # index_key = to_klass_info[:index_key]
59
+ # raise "Index key is blank" if index_key.blank?
60
+ # to_klass_info[:klasses].each do |klass|
61
+ # if klass.collection.indexes.to_a.select{|index_info| index_info["key"].keys.index(index_key) == 0}.blank?
62
+ # raise "Index missing exception for #{index_key} on #{klass.to_s} class"
63
+ # end
64
+ # end
65
+ # end
66
+
67
+ to_klass_roots = to_klass_infos.map{|to_klass_info| to_klass_info[:klasses].map(&:to_s)}.flatten.uniq
68
+ from_klass = self.relations[relation.to_s][:class_name].constantize
69
+
70
+ field_type = from_klass.fields[field_name.to_s].options[:type] if field_terms.size == 1 && field_name.to_s != "_type"
71
+ field_type ||= String
72
+
73
+ to_klass_infos.each do |to_klass_info|
74
+ next unless to_klass_info[:index_key].include?(".")
75
+ field_path = to_klass_info[:index_key].split(".").first
76
+
77
+ to_klass_info[:klasses].each do |klass|
78
+ unless klass.method_defined?(:force_denormalize)
79
+ klass.send(:define_method, :force_denormalize) do
80
+ end
81
+ end
82
+
83
+ unless klass.method_defined?(:force_denormalize!)
84
+ klass.send(:define_method, :force_denormalize!) do
85
+ force_denormalize
86
+ self.save
87
+ end
88
+ end
89
+
90
+ unless klass.method_defined?("force_denormalize_#{field_path}".to_sym)
91
+ klass.send(:define_method, "force_denormalize_#{field_path}".to_sym) do
92
+ docs = self.send(field_path.to_sym)
93
+ if docs.respond_to?(:each)
94
+ docs.each{|doc| doc.force_denormalize}
95
+ else
96
+ docs.force_denormalize
97
+ end
98
+ end
99
+
100
+ force_denormalize_module = Module.new do
101
+ define_method "force_denormalize" do |*args|
102
+ super(*args)
103
+ self.send("force_denormalize_#{field_path}")
104
+ end
105
+ end
106
+ klass.prepend(force_denormalize_module)
107
+ end
108
+ end
109
+ end
110
+
111
+
112
+
113
+
114
+ from_klass.instance_eval do
115
+ after_save do |from_doc|
116
+ changed_fn = "#{field_terms[0]}_changed?"
117
+ changed_fn = "asset_filename_changed?" if field_terms[0].to_s == "asset"
118
+ if from_doc.send(changed_fn)
119
+ field_value = ::AcDenormalize::Helpers.field_value(from_doc, field_terms)
120
+ ::AcDenormalize::Helpers.update_from_klass_changes(to_klass_infos, from_doc.id, field_value)
121
+ end
122
+ end
123
+
124
+ after_destroy do |from_doc|
125
+ field_value = nil
126
+ ::AcDenormalize::Helpers.update_from_klass_changes(to_klass_infos, from_doc.id, field_value)
127
+ end
128
+ end
129
+
130
+
131
+
132
+ to_klass.class_eval do
133
+
134
+ get_func_module = Module.new do
135
+ define_method denormalized_field_name.to_s do |*args|
136
+ use_denormalized = to_klass_roots.find{|to_klass_root| self._root.is_a?(to_klass_root.constantize)}.present?
137
+ field_value = super(*args) if use_denormalized
138
+ return field_value if field_value.present?
139
+
140
+ from_doc = self.send(relation)
141
+ return nil if from_doc.blank?
142
+
143
+ field_value = ::AcDenormalize::Helpers.field_value(from_doc, field_terms)
144
+
145
+ if use_denormalized
146
+ self.send("#{denormalized_field_name}=", field_value)
147
+ self.set("#{denormalized_field_name}" => field_value) if self.persisted?
148
+ end
149
+ return field_value
150
+ end
151
+ end
152
+ self.prepend(get_func_module)
153
+
154
+ define_method "denormalize_#{denormalized_field_name}" do
155
+ use_denormalized = to_klass_roots.find{|to_klass_root| self._root.is_a?(to_klass_root.constantize)}.present?
156
+ return unless use_denormalized
157
+ from_doc = self.send(relation)
158
+ return nil if from_doc.blank?
159
+
160
+ field_value = ::AcDenormalize::Helpers.field_value(from_doc, field_terms)
161
+ self.send("#{denormalized_field_name}=", field_value)
162
+ return true
163
+ end
164
+
165
+ define_method "denormalize_#{denormalized_field_name}!" do
166
+ use_denormalized = to_klass_roots.find{|to_klass_root| self._root.is_a?(to_klass_root.constantize)}.present?
167
+ return unless use_denormalized
168
+ from_doc = self.send(relation)
169
+ return nil if from_doc.blank?
170
+
171
+ field_value = ::AcDenormalize::Helpers.field_value(from_doc, field_terms)
172
+ self.set(denormalized_field_name.to_sym => field_value)
173
+ end
174
+
175
+ force_denormalize_module = Module.new do
176
+ define_method "force_denormalize" do |*args|
177
+ super(*args)
178
+ self.send("denormalize_#{denormalized_field_name}")
179
+ end
180
+ end
181
+ self.prepend(force_denormalize_module)
182
+ end
183
+
184
+ to_klass.instance_eval do
185
+ self.field(denormalized_field_name, type: field_type)
186
+
187
+ before_save do |doc|
188
+ if doc.send("#{relation}_id_changed?")
189
+ doc.send("denormalize_#{denormalized_field_name}")
190
+ end
191
+ end
192
+ end
193
+
194
+ end
195
+ end
196
+
197
+ end
198
+ end
@@ -0,0 +1,36 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "mongoid/denormalization/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "mongoid-denormalization"
8
+ spec.version = Mongoid::Denormalization::VERSION
9
+ spec.authors = ["Amit Chaudhary"]
10
+ spec.email = ["chaudharyamitiit2007@gmail.com"]
11
+
12
+ spec.summary = %q{Mongoid denormalization helper module}
13
+ spec.description = %q{Helper module for denormalizing association attributes in Mongoid models.}
14
+ spec.homepage = "http://github.com/chaudhary/mongoid_denormalization"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against " \
23
+ # "public gem pushes."
24
+ # end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_development_dependency "bundler", "~> 1.16"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mongoid-denormalization
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Amit Chaudhary
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-12-17 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.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
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: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Helper module for denormalizing association attributes in Mongoid models.
56
+ email:
57
+ - chaudharyamitiit2007@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/mongoid/denormalization.rb
73
+ - lib/mongoid/denormalization/version.rb
74
+ - mongoid-denormalization.gemspec
75
+ homepage: http://github.com/chaudhary/mongoid_denormalization
76
+ licenses:
77
+ - MIT
78
+ metadata: {}
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubyforge_project:
95
+ rubygems_version: 2.6.13
96
+ signing_key:
97
+ specification_version: 4
98
+ summary: Mongoid denormalization helper module
99
+ test_files: []