mongoid-denormalization 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa1a0ba39056d1e83f3f6b9979d7a35ab94b5385
-  data.tar.gz: ebb5f7a673846691c0125e2688dabe112441b513
+  metadata.gz: 70d9924038cb24d4c90d1a759f1a5f6a1ad5ce38
+  data.tar.gz: 37f730557a69d668d26763e991136d2469a69d94
 SHA512:
-  metadata.gz: 4ab451d3b02ca0be0085802d4760e052a1e1dcbcbb14edcd0020ce2d217e97b52e78bd7b238c45b9bc98cdafabf466e72bc8d3f0f9c872a253f96c20c6f1c509
-  data.tar.gz: d23b0d4a2913d3a5bfca789954f76a5d5098dbae7f1d8e8f8de455b1cb5c4ad56ef4c6ef8a756425264495f8127cd225f83bd2944ff9c1d864501d7b965704c6
+  metadata.gz: dad19e9a0236597a5b33d28d344f7af9c052987e187db742e853ca2fb4643b3405325470bf6126f42a1bee4dfdc2a6f2081711993d4526eeadf5af24a2e7ddd5
+  data.tar.gz: 6cf60d715b07b80892fb97851abf5376ba46dec638732bb9abd1b69b928b6f4d00330e82d5ce099b9c6d53a4b743e4dc9d5dbecfa368d490713fc4a2d5673d4e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-denormalization (0.1.1)
+    mongoid-denormalization (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,7 @@
 # Mongoid::Denormalization
 
-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.
-
-TODO: Delete this and the text above, and describe your gem
+Helper module for denormalizing association attributes in Mongoid models & embedded models.
+Supports rails 5.1.4, mongoid 6.2, ruby 2.4.2
 
 ## Installation
 
@@ -14,7 +13,7 @@ gem 'mongoid-denormalization'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,7 +21,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your model:
+```ruby
+# Include the helper method
+include Mongoid::Denormalization
+
+# Define your denormalization
+denormalize_from(:user, :name) # this will add a user_name field on your model
+denormalize_from(:user, :email) # this will add a user_email field on your model
+```
+
+Optionally, you can also write it as
+```ruby
+# this will add a username field on your model
+denormalize_from(:user, :name, :denormalized_field_name => :username)
+
+# this will add a useremail field on your model
+denormalize_from(:user, :email, :denormalized_field_name => :useremail)
+```
+
+Lets say we have a company model with embedded jobs in it. We want to denormalize user_name and user_email in jobs.
+We can write the following code in our jobs model:
+
+```ruby
+denormalize_from(:user, :name, to_klass_infos: [{
+  klasses: [::Company],
+  selector_proc: Proc.new do |id, value|
+    {:jobs => {"$elemMatch" => {:user_id => id, :user_name => {"$ne" => value}}}}
+  end,
+  updator: "jobs.$.user_name",
+  index_key: "jobs.user_id"
+}])
+
+denormalize_from(:user, :email, to_klass_infos: [{
+  klasses: [::Company],
+  selector_proc: Proc.new do |id, value|
+    {:jobs => {"$elemMatch" => {:user_id => id, :user_email => {"$ne" => value}}}}
+  end,
+  updator: "jobs.$.user_email",
+  index_key: "jobs.user_id"
+}])
+```
+
+You can call force_denormalize also,
+```ruby
+company.force_denormalize # this will simply sync all the denormalized fields and will not triiger a save on document.
+company.force_denormalize! # this will sync all the denormalized fields and will also triiger a save on document.
+```
+
+Note: you should also create proper db indexes required, otherwise the module may through an error.
 
 ## Development
 
@@ -32,7 +79,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chaudhary/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.
 
 ## License
 

data/lib/mongoid/denormalization/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Denormalization
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-denormalization
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Amit Chaudhary