nathanl / authority

*CURRENTLY UNMAINTAINED*. Authority helps you authorize actions in your Rails app. It's ORM-neutral and has very little fancy syntax; just group your models under one or more Authorizer classes and write plain Ruby methods on them.
MIT License
1.21k stars 67 forks source link

Fix README #83

Closed awinograd closed 10 years ago

awinograd commented 10 years ago

Fix methods called on AdminAuthorizer

The testing section of the README refers to the method bulk_updatable_by(). After trying to add tests it seems that the methods defined on the class are still just updatableby() [NOTE: lack of bulk prefix] like the instance methods. Feel free to ignore the PR if I'm mistaken.

PS. Thanks for a cool gem. It's really helping me keep code cleaner and more readable.

nathanl commented 10 years ago

Hi @awinograd. That wasn't a typo; it was meant to illustrate a custom method you might define in your app. I guess that wasn't clear from the example. Maybe that example code should just have a comment saying "Assuming you've defined bulk_updatable_by?" - what do you think?

Glad you're enjoying using Authority and thanks for wanting to help out.

awinograd commented 10 years ago

I see. I think I was confused since this is sort of the first time that a non-default / expected method is used and I thought that "bulk" referred to a batch operation since it's being called on the class rather than an instance.

I think the disclaimer is fine, or maybe make the method less similar to the default/standard methods. Your call. I'm happy to update the README again.

nathanl commented 10 years ago

Merged. I subsequently removed the custom method from the test description. Thanks!