Add new option to save embedded relations changes in parent

[jagdeepsingh]

This add a new option embeds_many to the history_trackable_options to save history of embedded objects in parent record itself.
e.g. if there are User and Article models as following:

class User
  include Mongoid::Document
  field :foo
  embeds_many :articles
  track_history embeds_many: [:articles]
end

class Article
  include Mongoid::Document
  field :bar
  embedded_in :user
end

This will save the article.attributes in addition to user's trackable fields to user's history record whenever an user/article is created/updated/destroyed.

[coveralls]

Coverage increased (+0.2%) to 99.415% when pulling bb879e6 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.2%) to 99.415% when pulling f81ce5f on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.2%) to 99.415% when pulling f81ce5f on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.2%) to 99.416% when pulling 0fe0d74 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[jagdeepsingh]

Build failing with following error:

rbx-2.2.10 is not installed - installing.
Searching for binary rubies, this might take some time.
Requested binary installation but no rubies are available to download, consider skipping --binary flag.
Gemset '' does not exist, 'rvm rbx-2.2.10 do rvm gemset create ' first, or append '--create'.

[dblock]

This is great, but I think embedded objects are no different from other fields in some way, so I think the DSL should just be on: [ :articles ] and the code should be smart enough to know that those are embedded objects, relationships, etc. What do you think?

[jagdeepsingh]

@dblock on: [ :articles ] seems as good as embeds_many: [ :articles ]. I will see if this can solve my requirement and do the change if possible.

[coveralls]

Coverage increased (+0.05%) to 99.296% when pulling d5c4456 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[jagdeepsingh]

@dblock Now if a model has track_history on: :all, should it also track all embedded relations in addition to all the fields?

[jagdeepsingh]

If not, will the user have to specify all fields and embedded associations here?

[jagdeepsingh]

Also, if we track all fields and embedded relations in :all, then it will affect users who are already using it. They will be tracking the embedded objects in their applications, unintentionally.

[dblock]

I think we shouldn't touch :all for backward compatibility purposes. We can add :all_fields and :all_relations or similar in a separate PR if we want to.

[jagdeepsingh]

We can't touch on: :all, to support existing users. So, how would you like me to modify the DSL in this PR?. May be i can modify it to use a new option associations: :all (Other values can be associations: :embeds_many, associations: :has_many, associations: :belongs_to, etc and of course associations:[:articles, ...]). Wdyt?

[dblock]

First, thanks for hanging on here.

What I don't like about a DSL that you propose is that it's not naming "things", but "kinds of things". We can't touch on: :all, but we can do on: [:all, :comments], right? It's not ideal because :all should, as you point out, be everything, but i think it's better than associations: :comments and much better than associations: :has_many.

[dblock]

We should alias :all to :fields and in the future add :associations.

[jagdeepsingh]

Ok. For now, i will make it on: [:all, :comments, ...]. And make :all an alias to :fields.

[johnnyshields]

@dblock the term :relations is better than :associations (in Mongoid parlance)

[dblock]

Thanks @jagdeepsingh, let us know when it's updated.

[dblock]

This is still wrong.

[dblock]

LMK when this is ready to re-review, see comment above, update CHANGELOG, fix the build, etc.

[coveralls]

Coverage decreased (-21.5%) to 77.792% when pulling 52da937 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[jagdeepsingh]

This is still a WIP. I will let you know when to re-review it.

[coveralls]

Coverage increased (+0.07%) to 99.318% when pulling 511542d on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.2%) to 99.436% when pulling d7bd271 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.3%) to 99.517% when pulling 113d825 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[dblock]

You do need to re-add rbx-2 above though ;)

[dblock]

Thanks. I made a comment on class naming, I think we should rename it.

There's still an entry in CHANGELOG needed.

[coveralls]

Coverage decreased (-0.01%) to 99.239% when pulling ab6dc25 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage decreased (-0.008%) to 99.242% when pulling 50de994 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[jagdeepsingh]

@dblock Please check now.

[coveralls]

Coverage decreased (-0.03%) to 99.222% when pulling e7c57bc on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage decreased (-0.03%) to 99.222% when pulling 211ff84 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage decreased (-0.03%) to 99.223% when pulling 12c7d74 on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.04%) to 99.292% when pulling e4d15ea on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage decreased (-0.08%) to 99.172% when pulling e4d15ea on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.3%) to 99.59% when pulling dc2bf2e on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[coveralls]

Coverage increased (+0.2%) to 99.435% when pulling dc2bf2e on JagdeepSingh:store-embedded-relations-in-parent into 6948018 on aq1018:master.

[jagdeepsingh]

@dblock This is ready to be reviewed now.

[dblock]

Excellent work, thank you.