Need a warning in Readme

[tranvictor]

Using enumerize with Mongoid can mislead to something pretty hard to figure out which is writer? method.

In more details, if we use writer as a valid value for a field and predicates is true, prefix is false then developers are likely to use writer? to check if the field has value of writer. In fact, this method mostly returns false because it is defined by Mongoid.

Explanation: Enumerize delegates the writer? message to Enumerize:Value, this value is inherited from String which is internally extended by Mongoid with writer? defined. On the other hand, when developer check method(:writer?), they would still see that the method is from enumerize that seems legit making it pretty hard to track down.

Proposal: We should have a strong warning for developers about this on Readme because writer is not a rare value to use. For website dealing with publishing content (news, magazine, ad network, affiliate platform, ...), developers can easily fall into using writer as a role of an user.

[nashby]

@tranvictor nice catch, thank you for filling the issue! Care to send a pull request please?

[tranvictor]

@nashby sure, i will file a PR soon.

[FunkyloverOne]

@nashby , @tranvictor , @aki77 , guys, I just have noticed that mongoid already has some method called with_type, don't know what it does yet, but,

it actually means that for quite frequent scenario when models have enumerable field called type, and have scope for it using scope: true, it's bad, for 2 reasons:

1. it overrides original with_type method on model class,

2. it does not override it for Mongoid::Criteria objects, which causes errors when trying to use generated scope in a chain after any other scope (which returns Mongoid::Criteria object, of course).

So I believe we got to have this warning as well.