renaming ActiveRecordAdditions#can method to accessible_by since it flows better and makes more sense

This commit is contained in:
Ryan Bates
2010-04-15 23:54:45 -07:00
parent ef5900c5b1
commit 240c281061
5 changed files with 11 additions and 11 deletions

View File

@@ -191,7 +191,7 @@ module CanCan
# can :read, Article, :visible => true
# conditions :read, Article # returns { :visible => true }
#
# Normally you will not call this method directly, but instead go through ActiveRecordAdditions#can method.
# Normally you will not call this method directly, but instead go through ActiveRecordAdditions#accessible_by method.
#
# If the ability is not defined then false is returned so be sure to take that into consideration.
# If the ability is defined using a block then this will raise an exception since a hash of conditions cannot be

View File

@@ -6,7 +6,7 @@ module CanCan
# can perform a given action on. The action defaults to :read. This
# is usually called from a controller and passed the +current_ability+.
#
# @articles = Article.can(current_ability)
# @articles = Article.accessible_by(current_ability)
#
# Here only the articles which the user is able to read will be returned.
# If the user does not have permission to read any articles then an empty
@@ -15,11 +15,11 @@ module CanCan
#
# An alternative action can optionally be passed as a second argument.
#
# @articles = Article.can(current_ability, :update)
# @articles = Article.accessible_by(current_ability, :update)
#
# Here only the articles which the user can update are returned. This
# internally uses Ability#conditions method, see that for more information.
def can(ability, action = :read)
def accessible_by(ability, action = :read)
conditions = ability.conditions(action, self) || {:id => nil}
if respond_to? :where
where(conditions)