Support Mongoid's "Custom Primary & Foreign Keys" behavior. #3097
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the latest (7.0.2) mongoid document (https://docs.mongodb.com/mongoid/master/tutorials/mongoid-relations/), primary and foreign keys can be customized for an association. As a result, we can't assume that the foreign key is "<name>_id(s)" and primary key is "_id". With primary & foreign keys customization, below modes: class Company include Mongoid::Document # This definition of e_refs is automatically generated by Mongoid: # But the type can also be specified: field :e_refs, type: Array has_and_belongs_to_many :emails, foreign_key: 'e_refs', primary_key: 'e' end class Email include Mongoid::Document field :e, type: Object rails_admin do object_label_method do :e end end end will have the documents stored as follows: \# The company document. { "_id" : ObjectId("4d3ed089fb60ab534684b7e9"), "e_refs": ["a@example.com", "b@example.com"] } \# The email document. { "_id" : ObjectId("4d3ed089fb60ab534684b7f1"), "e" : "a@example.com" }, { "_id" : ObjectId("4d3ed089fb60ab534684b7f2"), "e" : "b@example.com" }
This method is used by fields with has_and_belongs_to_many association to retrieve the name of the <ref>_ids setter. ActiveRecord always uses <ref>_ids, whereas Mongoid may have different setter name if foreign_key option is present.
|
Test needed! |
As this commit is version dependent (mongoid >= 7.0.2), I can write some test specs for this version, i.e., to have some associations (e.g., has_and_belongs_to_many) with primary_key and foreign_key options, but they will fail on all lower versions. Could you give me some advice? |
|
Fixed by 3f67637 in a slightly different way. Thanks for the PR anyway! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the latest (7.0.2) mongoid document Mongoid|Associations, primary and foreign keys
can be customized for an association. As a result, we can't assume an association's foreign key is "_id(s)" and primary key is "_id".
With primary & foreign keys customization, below modes:
class Company include Mongoid::Document # This definition of e_refs is automatically generated by Mongoid: # But the type can also be specified: field :e_refs, type: Array has_and_belongs_to_many :emails, foreign_key: 'e_refs', primary_key: 'e' end class Email include Mongoid::Document field :e, type: Object rails_admin do object_label_method do :e end end endwill have the documents stored as follows:
# The company document. { "_id" : ObjectId("4d3ed089fb60ab534684b7e9"), "e_refs": ["a@example.com", "b@example.com"] } # The email document. { "_id" : ObjectId("4d3ed089fb60ab534684b7f1"), "e" : "a@example.com" }, { "_id" : ObjectId("4d3ed089fb60ab534684b7f2"), "e" : "b@example.com" }