releasing version 1.2.0

CHANGELOG.rdoc

@@ -1,3 +1,55 @@
+1.2.0 (July 16, 2010)
+
+* Load nested parent resources on collection actions such as "index" (thanks dohzya)
+
+* Adding :name option to load_and_authorize_resource if it does not match controller - see issue #65
+
+* Fixing issue when using accessible_by with nil can conditions (thanks jrallison) - see issue #66
+
+* Pluralize table name for belongs_to associations in can conditions hash (thanks logandk) - see issue #62
+
+* Support has_many association or arrays in can conditions hash
+
+* Adding joins clause to accessible_by when conditions are across associations
+
+
+1.1.1 (April 17, 2010)
+
+* Fixing behavior in Rails 3 by properly initializing ResourceAuthorization
+
+
+1.1.0 (April 17, 2010)
+
+* Supporting arrays, ranges, and nested hashes in ability conditions
+
+* Removing "unauthorized!" method in favor of "authorize!" in controllers
+
+* Adding action, subject and default_message abilities to AccessDenied exception - see issue #40
+
+* Adding caching to current_ability controller method, if you're overriding this be sure to add caching too.
+
+* Adding "accessible_by" method to Active Record for fetching records matching a specific ability
+
+* Adding conditions behavior to Ability#can and fetch with Ability#conditions - see issue #53
+
+* Renaming :class option to :resource for load_and_authorize_resource which now supports a symbol for non models - see issue #45
+
+* Properly handle Admin::AbilitiesController in params[:controller] - see issue #46
+
+* Adding be_able_to RSpec matcher (thanks dchelimsky), requires Ruby 1.8.7 or higher - see issue #54
+
+* Support additional arguments to can? which get passed to the block - see issue #48
+
+
+1.0.2 (Dec 30, 2009)
+
+* Adding clear_aliased_actions to Ability which removes previously defined actions including defaults - see issue #20
+
+* Append aliased actions (don't overwrite them) - see issue #20
+
+* Adding custom message argument to unauthorized! method (thanks tjwallace) - see issue #18
+
+
 1.0.1 (Dec 14, 2009)
 
 * Adding :class option to load_resource so one can customize which class to use for the model - see issue #17

README.rdoc

@@ -1,29 +1,26 @@
 = CanCan
 
-This is a simple authorization solution for Ruby on Rails to restrict what a given user is allowed to access in the application. This is completely decoupled from any role based implementation allowing you to define user roles the way you want. All permissions are stored in a single location for convenience.
+Wiki[http://wiki.github.com/ryanb/cancan] | RDocs[http://rdoc.info/projects/ryanb/cancan] | Screencast[http://railscasts.com/episodes/192-authorization-with-cancan] | Metrics[http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fryanb%2Fcancan.git]
 
-This assumes you already have authentication (such as Authlogic[http://github.com/binarylogic/authlogic]) which provides a current_user model.
+CanCan is an authorization solution for Ruby on Rails. This restricts what a given user is allowed to access throughout the application. It is completely decoupled from any role based implementation and focusses on keeping permission logic in a single location (the +Ability+ class) so it is not duplicated across controllers, views, and database queries.
+
+This assumes you already have authentication (such as Authlogic[http://github.com/binarylogic/authlogic] or Devise[http://github.com/plataformatec/devise]) that provides a +current_user+ method which CanCan relies on. See {Changing Defaults}[http://wiki.github.com/ryanb/cancan/changing-defaults] if you need different behavior.
 
-See the RDocs[http://rdoc.info/projects/ryanb/cancan] and Wiki[http://wiki.github.com/ryanb/cancan] for additional documentation.
 
 == Installation
 
-You can set it up as a gem in your environment.rb file.
+CanCan is provided as a gem. Simply include it in your environment.rb or Gemfile.
-  
+
   config.gem "cancan"
-  
-And then install the gem.
 
-  sudo rake gems:install
+Alternatively it can be installed as a plugin.
-
-Alternatively you can install it as a Rails plugin.
 
   script/plugin install git://github.com/ryanb/cancan.git
 
 
 == Getting Started
 
-First, define a class called Ability in "models/ability.rb".
+First, define a class called +Ability+ in "models/ability.rb". It should look something like this.
 
   class Ability
     include CanCan::Ability
@@ -39,164 +36,111 @@ First, define a class called Ability in "models/ability.rb".
 
 This is where all permissions will go. See the "Defining Abilities" section below for more information.
 
-You can access the current permissions at any point using the "can?" and "cannot?" methods in the view.
+The current user's permissions can be accessed using the "can?" and "cannot?" methods in the view and controller.
 
   <% if can? :update, @article %>
     <%= link_to "Edit", edit_article_path(@article) %>
   <% end %>
 
-You can also use these methods in a controller along with the "unauthorized!" method to restrict access.
+See {Checking Abilities}[http://wiki.github.com/ryanb/cancan/checking-abilities] for more information
+
+The "authorize!" method in the controller will raise an exception if the user is not able to perform the given action.
 
   def show
     @article = Article.find(params[:id])
-    unauthorized! if cannot? :read, @article
+    authorize! :read, @article
   end
 
-Setting this for every action can be tedious, therefore the load_and_authorize_resource method is also provided to automatically authorize all actions in a RESTful style resource controller. It will set up a before filter which loads the resource into the instance variable and authorizes it.
+Setting this for every action can be tedious, therefore the +load_and_authorize_resource+ method is provided to automatically authorize all actions in a RESTful style resource controller. It will use a before filter to load the resource into an instance variable and authorize it for each action.
 
   class ArticlesController < ApplicationController
     load_and_authorize_resource
     
     def show
-      # @article is already loaded
+      # @article is already loaded and authorized
     end
   end
 
-If the user authorization fails, a CanCan::AccessDenied exception will be raised. You can catch this and modify its behavior in the ApplicationController.
+See {Authorizing Controller Actions}[http://wiki.github.com/ryanb/cancan/authorizing-controller-actions] for more information
+
+If the user authorization fails, a CanCan::AccessDenied exception will be raised. You can catch this and modify its behavior in the +ApplicationController+.
 
   class ApplicationController < ActionController::Base
     rescue_from CanCan::AccessDenied do |exception|
-      flash[:error] = "Sorry, you are not allowed to access that page."
+      flash[:error] = exception.message
       redirect_to root_url
     end
   end
 
+See {Exception Handling}[http://wiki.github.com/ryanb/cancan/exception-handling] for more information.
+
 
 == Defining Abilities
 
-As shown above, the Ability class is where all user permissions are defined. The user model is passed into the initialize method so you are free to modify the permissions based on the user's attributes. This way CanCan is completely decoupled with how you choose to handle roles.
+As shown above, the +Ability+ class is where all user permissions are defined. The user model is passed into the initialize method so the permissions can be modified based on any user attributes. CanCan makes no assumptions about how roles are handled in your application. See {Role Based Authorization}[http://wiki.github.com/ryanb/cancan/role-based-authorization] for an example.
 
-The "can" method accepts two arguments, the first one is the action you're setting the permission for, the second one is the class of object you're setting it on.
+The +can+ method is used to define permissions and requires two arguments. The first one is the action you're setting the permission for, the second one is the class of object you're setting it on.
 
   can :update, Article
 
-You can pass an array for either of these parameters to match any one.
+You can pass an array for either of these parameters to match any one. In this case the user will have the ability to update or destroy both articles and comments.
 
   can [:update, :destroy], [Article, Comment]
 
-In this case the user has the ability to update or destroy both articles and comments.
+Use :+manage+ to represent any action and :+all+ to represent any class. Here are some examples.
 
-You can pass a block to provide logic based on the article's attributes.
+  can :manage, Article   # has permissions to do anything to articles
+  can :read, :all        # has permission to read any model
+  can :manage, :all      # has permission to do anything to any model
 
-  can :update, Article do |article|
+You can pass a hash of conditions as the third argument to further restrict what the user is able to access. Here the user will only have permission to read active projects which he owns.
-    article && article.user == user
+
+  can :read, Project, :active => true, :user_id => user.id
+
+See {Defining Abilities with Hashes}[http://wiki.github.com/ryanb/cancan/defining-abilities-with-hashes] for more information.
+
+Blocks can also be used if you need more control.
+
+  can :update, Project do |project|
+    project && project.groups.include?(user.group)
   end
 
-If the block returns true then the user has that :update ability for that article, otherwise he will be denied access. It's possible for the passed in model to be nil if one isn't specified, so be sure to take that into consideration.
+If the block returns true then the user has that :+update+ ability for that project, otherwise he will be denied access. See {Defining Abilities with Blocks}[http://wiki.github.com/ryanb/cancan/defining-abilities-with-blocks] for more information.
-
-You can pass :all to reference every type of object. In this case the object type will be passed into the block as well (just in case object is nil).
-
-  can :read, :all do |object_class, object|
-    object_class != Order
-  end
-
-Here the user has permission to read all objects except orders.
-
-You can also pass :manage as the action which will match any action. In this case the action is passed to the block.
-
-  can :manage, Comment do |action, comment|
-    action != :destroy
-  end
-  
-Finally, the "cannot" method works similar to "can" but defines which abilities cannot be done.
-
-  can :read, :all
-  cannot :read, Product
-
-
-== Checking Abilities
-
-Use the "can?" method in the controller or view to check the user's permission for a given action and object.
-
-  can? :destroy, @project
-
-You can also pass the class instead of an instance (if you don't have one handy).
-
-  <% if can? :create, Project %>
-    <%= link_to "New Project", new_project_path %>
-  <% end %>
-
-The "cannot?" method is for convenience and performs the opposite check of "can?"
-
-  cannot? :destroy, @project
 
 
 == Aliasing Actions
 
-You can use the "alias_action" method to alias one or more actions into one.
+You will usually be working with four actions when defining and checking permissions: :+read+, :+create+, :+update+, :+destroy+. These aren't the same as the 7 RESTful actions in Rails. CanCan automatically adds some default aliases for mapping those actions.
-
-  alias_action :update, :destroy, :to => :modify
-  can :modify, Comment
-  can? :update, Comment # => true
-
-The following aliases are added by default for conveniently mapping common controller actions.
 
   alias_action :index, :show, :to => :read
   alias_action :new, :to => :create
   alias_action :edit, :to => :update
 
+Notice the +edit+ action is aliased to +update+. If the user is able to update a record he also has permission to edit it. You can define your own aliases in the +Ability+ class
 
-== Authorizing Controller Actions
+  alias_action :update, :destroy, :to => :modify
+  can :modify, Comment
+  can? :update, Comment # => true
 
-As mentioned in the Getting Started section, you can use the +load_and_authorize_resource+ method in your controller to load the resource into an instance variable and authorize it. If you have a nested resource you can specify that as well.
+See {Custom Actions}[http://wiki.github.com/ryanb/cancan/custom-actions] for information on adding other actions.
-
-  load_and_authorize_resource :nested => :author
-
-You can also pass an array to the :+nested+ attribute for deep nesting.
-
-If you want to customize the loading behavior on certain actions, you can do so in a before filter.
-
-  class BooksController < ApplicationController
-    before_filter :find_book_by_permalink, :only => :show
-    load_and_authorize_resource
-  
-    private
-  
-    def find_book_by_permalink
-      @book = Book.find_by_permalink!(params[:id)
-    end
-  end
-
-Here the @book instance variable is already set so it will not be loaded again for that action. This works for nested resources as well.
 
 
-== Assumptions & Configuring
+== Fetching Records
 
-CanCan makes two assumptions about your application.
+In the controller +index+ action you may want to fetch only the records which the user has permission to read. You can do this with the +accessible_by+ scope.
 
-* You have an Ability class which defines the permissions.
+  @articles = Article.accessible_by(current_ability)
-* You have a current_user method in the controller which returns the current user model.
 
-You can override these by overriding the "current_ability" method in your ApplicationController.
+See {Fetching Records}[http://wiki.github.com/ryanb/cancan/fetching-records] for more information.
-
-   def current_ability
-     UserAbility.new(current_account) # instead of Ability.new(current_user)
-   end
-
-That's it!
 
 
-== Testing Abilities
+== Additional Docs
-
-It is very easy to test the Ability model since you can call "can?" directly on it as you would in the view or controller.
-
-  def test "user can only destroy projects which he owns"
-    user = User.new
-    ability = Ability.new(user)
-    assert ability.can?(:destroy, Project.new(:user => user))
-    assert ability.cannot?(:destroy, Project.new)
-  end
 
+* {Upgrading to 1.1}[http://wiki.github.com/ryanb/cancan/upgrading-to-11]
+* {Testing Abilities}[http://wiki.github.com/ryanb/cancan/testing-abilities]
+* {Accessing Request Data}[http://wiki.github.com/ryanb/cancan/accessing-request-data]
+* {Admin Namespace}[http://wiki.github.com/ryanb/cancan/admin-namespace]
+* {See more}[http://wiki.github.com/ryanb/cancan/]
 
 == Special Thanks
 

Rakefile

@@ -9,3 +9,5 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_files = spec_files
   t.spec_opts = ["-c"]
 end
+
+task :default => :spec

cancan.gemspec

@@ -1,22 +1,15 @@
 Gem::Specification.new do |s|
-  s.name = "cancan"
+  s.name        = "cancan"
-  s.summary = "Simple authorization solution for Rails."
+  s.version     = "1.2.0"
+  s.author      = "Ryan Bates"
+  s.email       = "ryan@railscasts.com"
+  s.homepage    = "http://github.com/ryanb/cancan"
+  s.summary     = "Simple authorization solution for Rails."
   s.description = "Simple authorization solution for Rails which is completely decoupled from the user's roles. All permissions are stored in a single location for convenience."
-  s.homepage = "http://github.com/ryanb/cancan"
   
-  s.version = "1.0.1"
+  s.files        = Dir["{lib,spec}/**/*", "[A-Z]*", "init.rb"]
-  s.date = "2009-12-14"
+  s.require_path = "lib"
   
-  s.authors = ["Ryan Bates"]
+  s.rubyforge_project = s.name
-  s.email = "ryan@railscasts.com"
+  s.required_rubygems_version = ">= 1.3.4"
-  
-  s.require_paths = ["lib"]
-  s.files = Dir["lib/**/*"] + Dir["spec/**/*"] + ["LICENSE", "README.rdoc", "Rakefile", "CHANGELOG.rdoc", "init.rb"]
-  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "LICENSE"]
-  
-  s.has_rdoc = true
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "CanCan", "--main", "README.rdoc"]
-  
-  s.rubygems_version = "1.3.4"
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2")
 end

lib/cancan.rb

@@ -1,10 +1,7 @@
-module CanCan
+require 'cancan/ability'
-  # This error is raised when a user isn't allowed to access a given
+require 'cancan/can_definition'
-  # controller action. See ControllerAdditions#unauthorized! for details.
+require 'cancan/controller_resource'
-  class AccessDenied < StandardError; end
+require 'cancan/resource_authorization'
-end
+require 'cancan/controller_additions'
-
+require 'cancan/active_record_additions'
-require File.dirname(__FILE__) + '/cancan/ability'
+require 'cancan/exceptions'
-require File.dirname(__FILE__) + '/cancan/controller_resource'
-require File.dirname(__FILE__) + '/cancan/resource_authorization'
-require File.dirname(__FILE__) + '/cancan/controller_additions'

lib/cancan/ability.rb

@@ -1,8 +1,8 @@
 module CanCan
-  
+
   # This module is designed to be included into an Ability class. This will
   # provide the "can" methods for defining and checking abilities.
-  # 
+  #
   #   class Ability
   #     include CanCan::Ability
   #
@@ -14,157 +14,216 @@ module CanCan
   #       end
   #     end
   #   end
-  # 
+  #
   module Ability
-    attr_accessor :user
+    # Use to check if the user has permission to perform a given action on an object.
-
+    #
-    # Use to check the user's permission for a given action and object.
-    # 
     #   can? :destroy, @project
-    # 
+    #
     # You can also pass the class instead of an instance (if you don't have one handy).
-    # 
+    #
     #   can? :create, Project
-    # 
+    #
-    # Not only can you use the can? method in the controller and view (see ControllerAdditions), 
+    # Any additional arguments will be passed into the "can" block definition. This
+    # can be used to pass more information about the user's request for example.
+    #
+    #   can? :create, Project, request.remote_ip
+    #
+    #   can :create Project do |project, remote_ip|
+    #     # ...
+    #   end
+    #
+    # Not only can you use the can? method in the controller and view (see ControllerAdditions),
     # but you can also call it directly on an ability instance.
-    # 
+    #
     #   ability.can? :destroy, @project
-    # 
+    #
     # This makes testing a user's abilities very easy.
-    # 
+    #
     #   def test "user can only destroy projects which he owns"
     #     user = User.new
     #     ability = Ability.new(user)
     #     assert ability.can?(:destroy, Project.new(:user => user))
     #     assert ability.cannot?(:destroy, Project.new)
     #   end
-    # 
+    #
-    def can?(action, noun)
+    # Also see the RSpec Matchers to aid in testing.
-      (@can_definitions || []).reverse.each do |base_behavior, defined_action, defined_noun, defined_block|
+    def can?(action, subject, *extra_args)
-        defined_actions = expand_actions(defined_action)
+      raise Error, "Nom nom nom. I eated it." if action == :has && subject == :cheezburger
-        defined_nouns = [defined_noun].flatten
+      can_definition = matching_can_definition(action, subject)
-        if includes_action?(defined_actions, action) && includes_noun?(defined_nouns, noun)
+      can_definition && can_definition.can?(action, subject, extra_args)
-          result = can_perform_action?(action, noun, defined_actions, defined_nouns, defined_block)
-          return base_behavior ? result : !result
-        end
-      end
-      false
     end
-    
+
     # Convenience method which works the same as "can?" but returns the opposite value.
-    # 
+    #
     #   cannot? :destroy, @project
-    # 
+    #
     def cannot?(*args)
       !can?(*args)
     end
-    
+
     # Defines which abilities are allowed using two arguments. The first one is the action
     # you're setting the permission for, the second one is the class of object you're setting it on.
-    # 
+    #
     #   can :update, Article
-    # 
+    #
     # You can pass an array for either of these parameters to match any one.
     #
     #   can [:update, :destroy], [Article, Comment]
     #
     # In this case the user has the ability to update or destroy both articles and comments.
     #
-    # You can pass a block to provide logic based on the article's attributes.
+    # You can pass a hash of conditions as the third argument.
     #
-    #   can :update, Article do |article|
+    #   can :read, Project, :active => true, :user_id => user.id
-    #     article && article.user == user
+    #
+    # Here the user can only see active projects which he owns. See ActiveRecordAdditions#accessible_by
+    # for how to use this in database queries.
+    #
+    # If the conditions hash does not give you enough control over defining abilities, you can use a block to
+    # write any Ruby code you want.
+    #
+    #   can :update, Project do |project|
+    #     project && project.groups.include?(user.group)
     #   end
-    # 
+    #
-    # If the block returns true then the user has that :update ability for that article, otherwise he
+    # If the block returns true then the user has that :update ability for that project, otherwise he
     # will be denied access. It's possible for the passed in model to be nil if one isn't specified,
     # so be sure to take that into consideration.
-    # 
+    #
+    # The downside to using a block is that it cannot be used to generate conditions for database queries.
+    #
     # You can pass :all to reference every type of object. In this case the object type will be passed
     # into the block as well (just in case object is nil).
-    # 
+    #
     #   can :read, :all do |object_class, object|
     #     object_class != Order
     #   end
-    # 
+    #
     # Here the user has permission to read all objects except orders.
-    # 
+    #
-    # You can also pass :manage as the action which will match any action. In this case the action is 
+    # You can also pass :manage as the action which will match any action. In this case the action is
     # passed to the block.
-    # 
+    #
     #   can :manage, Comment do |action, comment|
     #     action != :destroy
     #   end
-    # 
+    #
     # You can pass custom objects into this "can" method, this is usually done through a symbol
     # and is useful if a class isn't available to define permissions on.
-    # 
+    #
     #   can :read, :stats
     #   can? :read, :stats # => true
-    # 
+    #
-    def can(action, noun, &block)
+    def can(action, subject, conditions = nil, &block)
-      @can_definitions ||= []
+      can_definitions << CanDefinition.new(true, action, subject, conditions, block)
-      @can_definitions << [true, action, noun, block]
     end
-    
+
-    # Define an ability which cannot be done. Accepts the same arguments as "can".
+    # Defines an ability which cannot be done. Accepts the same arguments as "can".
-    # 
+    #
     #   can :read, :all
     #   cannot :read, Comment
-    # 
+    #
     # A block can be passed just like "can", however if the logic is complex it is recommended
     # to use the "can" method.
-    # 
+    #
     #   cannot :read, Product do |product|
     #     product.invisible?
     #   end
-    # 
+    #
-    def cannot(action, noun, &block)
+    def cannot(action, subject, conditions = nil, &block)
-      @can_definitions ||= []
+      can_definitions << CanDefinition.new(false, action, subject, conditions, block)
-      @can_definitions << [false, action, noun, block]
     end
-    
+
     # Alias one or more actions into another one.
-    # 
+    #
     #   alias_action :update, :destroy, :to => :modify
     #   can :modify, Comment
-    # 
+    #
     # Then :modify permission will apply to both :update and :destroy requests.
-    # 
+    #
     #   can? :update, Comment # => true
     #   can? :destroy, Comment # => true
-    # 
+    #
     # This only works in one direction. Passing the aliased action into the "can?" call
     # will not work because aliases are meant to generate more generic actions.
-    # 
+    #
     #   alias_action :update, :destroy, :to => :modify
     #   can :update, Comment
     #   can? :modify, Comment # => false
-    # 
+    #
     # Unless that exact alias is used.
-    # 
+    #
     #   can :modify, Comment
     #   can? :modify, Comment # => true
-    # 
+    #
     # The following aliases are added by default for conveniently mapping common controller actions.
-    # 
+    #
     #   alias_action :index, :show, :to => :read
     #   alias_action :new, :to => :create
     #   alias_action :edit, :to => :update
-    # 
+    #
     # This way one can use params[:action] in the controller to determine the permission.
     def alias_action(*args)
       target = args.pop[:to]
-      aliased_actions[target] = args
+      aliased_actions[target] ||= []
+      aliased_actions[target] += args
     end
-    
+
-    private
+    # Returns a hash of aliased actions. The key is the target and the value is an array of actions aliasing the key.
-    
     def aliased_actions
       @aliased_actions ||= default_alias_actions
     end
-    
+
+    # Removes previously aliased actions including the defaults.
+    def clear_aliased_actions
+      @aliased_actions = {}
+    end
+
+    # Returns a hash of conditions which match the given ability. This is useful if you need to generate a database
+    # query based on the current ability.
+    #
+    #   can :read, Article, :visible => true
+    #   conditions :read, Article # returns { :visible => true }
+    #
+    # 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
+    # determined from that.
+    def conditions(action, subject, options = {})
+      can_definition = matching_can_definition(action, subject)
+      if can_definition
+        raise Error, "Cannot determine ability conditions from block for #{action.inspect} #{subject.inspect}" if can_definition.block
+        can_definition.conditions(options) || {}
+      else
+        false
+      end
+    end
+
+    # Returns the associations used in conditions. This is usually used in the :joins option for a search.
+    # See ActiveRecordAdditions#accessible_by for use in Active Record.
+    def association_joins(action, subject)
+      can_definition = matching_can_definition(action, subject)
+      if can_definition
+        raise Error, "Cannot determine association joins from block for #{action.inspect} #{subject.inspect}" if can_definition.block
+        can_definition.association_joins
+      end
+    end
+
+    private
+
+    def can_definitions
+      @can_definitions ||= []
+    end
+
+    def matching_can_definition(action, subject)
+      can_definitions.reverse.detect do |can_definition|
+        can_definition.expand_actions(aliased_actions)
+        can_definition.matches? action, subject
+      end
+    end
+
     def default_alias_actions
       {
         :read => [:index, :show],
@@ -172,35 +231,5 @@ module CanCan
         :update => [:edit],
       }
     end
-    
-    def expand_actions(actions)
-      [actions].flatten.map do |action|
-        if aliased_actions[action]
-          [action, *aliased_actions[action]]
-        else
-          action
-        end
-      end.flatten
-    end
-    
-    def can_perform_action?(action, noun, defined_actions, defined_nouns, defined_block)
-      if defined_block.nil?
-        true
-      else
-        block_args = []
-        block_args << action if defined_actions.include?(:manage)
-        block_args << (noun.class == Class ? noun : noun.class) if defined_nouns.include?(:all)
-        block_args << (noun.class == Class ? nil : noun)
-        return defined_block.call(*block_args)
-      end
-    end
-    
-    def includes_action?(actions, action)
-      actions.include?(:manage) || actions.include?(action)
-    end
-    
-    def includes_noun?(nouns, noun)
-      nouns.include?(:all) || nouns.include?(noun) || nouns.any? { |c| c.kind_of?(Class) && noun.kind_of?(c) }
-    end
   end
 end

lib/cancan/active_record_additions.rb

@@ -0,0 +1,43 @@
+module CanCan
+  # This module is automatically included into all Active Record models.
+  module ActiveRecordAdditions
+    module ClassMethods
+      # Returns a scope which fetches only the records that the passed ability
+      # 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.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
+      # result is returned. Since this is a scope it can be combined with any
+      # other scopes or pagination.
+      #
+      # An alternative action can optionally be passed as a second argument.
+      #
+      #   @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 accessible_by(ability, action = :read)
+        conditions = ability.conditions(action, self, :tableize => true) || {:id => nil}
+        joins = ability.association_joins(action, self)
+        if respond_to? :where
+          where(conditions).joins(joins)
+        else
+          scoped(:conditions => conditions, :joins => joins)
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end
+
+if defined? ActiveRecord
+  ActiveRecord::Base.class_eval do
+    include CanCan::ActiveRecordAdditions
+  end
+end

lib/cancan/can_definition.rb

@@ -0,0 +1,114 @@
+module CanCan
+  # This class is used internally and should only be called through Ability.
+  # it holds the information about a "can" call made on Ability and provides
+  # helpful methods to determine permission checking and conditions hash generation.
+  class CanDefinition # :nodoc:
+    include ActiveSupport::Inflector
+    attr_reader :block
+    
+    # The first argument when initializing is the base_behavior which is a true/false
+    # value. True for "can" and false for "cannot". The next two arguments are the action
+    # and subject respectively (such as :read, @project). The third argument is a hash
+    # of conditions and the last one is the block passed to the "can" call.
+    def initialize(base_behavior, action, subject, conditions, block)
+      @base_behavior = base_behavior
+      @actions = [action].flatten
+      @subjects = [subject].flatten
+      @conditions = conditions || {}
+      @block = block
+    end
+
+    # Accepts a hash of aliased actions and returns an array of actions which match.
+    # This should be called before "matches?" and other checking methods since they
+    # rely on the actions to be expanded.
+    def expand_actions(aliased_actions)
+      @expanded_actions = @actions.map do |action|
+        aliased_actions[action] ? [action, *aliased_actions[action]] : action
+      end.flatten
+    end
+
+    def matches?(action, subject)
+      matches_action?(action) && matches_subject?(subject)
+    end
+
+    def can?(action, subject, extra_args)
+      result = can_without_base_behavior?(action, subject, extra_args)
+      @base_behavior ? result : !result
+    end
+
+    # Returns a hash of conditions. If the ":tableize => true" option is passed
+    # it will pluralize the association conditions to match the table name.
+    def conditions(options = {})
+      if options[:tableize] && @conditions.kind_of?(Hash)
+        @conditions.inject({}) do |tableized_conditions, (name, value)|
+          name = tableize(name).to_sym if value.kind_of? Hash
+          tableized_conditions[name] = value
+          tableized_conditions
+        end
+      else
+        @conditions
+      end
+    end
+
+    def association_joins(conditions = @conditions)
+      joins = []
+      conditions.each do |name, value|
+        if value.kind_of? Hash
+          nested = association_joins(value)
+          if nested
+            joins << {name => nested}
+          else
+            joins << name
+          end
+        end
+      end
+      joins unless joins.empty?
+    end
+
+    private
+
+    def matches_action?(action)
+      @expanded_actions.include?(:manage) || @expanded_actions.include?(action)
+    end
+
+    def matches_subject?(subject)
+      @subjects.include?(:all) || @subjects.include?(subject) || @subjects.any? { |sub| sub.kind_of?(Class) && subject.kind_of?(sub) }
+    end
+
+    def can_without_base_behavior?(action, subject, extra_args)
+      if @block
+        call_block(action, subject, extra_args)
+      elsif @conditions && subject.class != Class
+        matches_conditions? subject
+      else
+        true
+      end
+    end
+
+    def matches_conditions?(subject, conditions = @conditions)
+      conditions.all? do |name, value|
+        attribute = subject.send(name)
+        if value.kind_of?(Hash)
+          if attribute.kind_of? Array
+            attribute.any? { |element| matches_conditions? element, value }
+          else
+            matches_conditions? attribute, value
+          end
+        elsif value.kind_of?(Array) || value.kind_of?(Range)
+          value.include? attribute
+        else
+          attribute == value
+        end
+      end
+    end
+
+    def call_block(action, subject, extra_args)
+      block_args = []
+      block_args << action if @expanded_actions.include?(:manage)
+      block_args << (subject.class == Class ? subject : subject.class) if @subjects.include?(:all)
+      block_args << (subject.class == Class ? nil : subject)
+      block_args += extra_args
+      @block.call(*block_args)
+    end
+  end
+end

lib/cancan/controller_additions.rb

@@ -1,35 +1,35 @@
 module CanCan
-  
+
   # This module is automatically included into all controllers.
   # It also makes the "can?" and "cannot?" methods available to all views.
   module ControllerAdditions
     module ClassMethods
       # Sets up a before filter which loads and authorizes the current resource. This performs both
       # load_resource and authorize_resource and accepts the same arguments. See those methods for details.
-      # 
+      #
       #   class BooksController < ApplicationController
       #     load_and_authorize_resource
       #   end
-      # 
+      #
       def load_and_authorize_resource(options = {})
-        before_filter(options.slice(:only, :except)) { |c| ResourceAuthorization.new(c, c.params, options.except(:only, :except)).load_and_authorize_resource }
+        ResourceAuthorization.add_before_filter(self, :load_and_authorize_resource, options)
       end
-      
+
       # Sets up a before filter which loads the appropriate model resource into an instance variable.
       # For example, given an ArticlesController it will load the current article into the @article
       # instance variable. It does this by either calling Article.find(params[:id]) or
       # Article.new(params[:article]) depending upon the action. It does nothing for the "index"
       # action.
-      # 
+      #
       # Call this method directly on the controller class.
-      # 
+      #
       #   class BooksController < ApplicationController
       #     load_resource
       #   end
-      # 
+      #
       # A resource is not loaded if the instance variable is already set. This makes it easy to override
       # the behavior through a before_filter on certain actions.
-      # 
+      #
       #   class BooksController < ApplicationController
       #     before_filter :find_book_by_permalink, :only => :show
       #     load_resource
@@ -40,143 +40,168 @@ module CanCan
       #       @book = Book.find_by_permalink!(params[:id)
       #     end
       #   end
-      # 
+      #
       # See load_and_authorize_resource to automatically authorize the resource too.
-      # 
+      #
       # Options:
       # [:+only+]
       #   Only applies before filter to given actions.
-      #   
+      #
       # [:+except+]
       #   Does not apply before filter to given actions.
-      #   
+      #
       # [:+nested+]
       #   Specify which resource this is nested under.
-      #   
+      #
       #     load_resource :nested => :author
-      #   
+      #
       #   Deep nesting can be defined in an array.
-      #   
+      #
       #     load_resource :nested => [:publisher, :author]
-      #   
+      #
-      # [:+class+]
+      # [:+name+]
-      #   The class to use for the model.
+      #   The name of the resource if it cannot be determined from controller (string or symbol).
-      #   
+      #
+      #     load_resource :name => :article
+      #
+      # [:+resource+]
+      #   The class to use for the model (string or constant).
+      #
       # [:+collection+]
       #   Specify which actions are resource collection actions in addition to :+index+. This
       #   is usually not necessary because it will try to guess depending on if an :+id+
       #   is present in +params+.
-      #   
+      #
       #     load_resource :collection => [:sort, :list]
-      #   
+      #
       # [:+new+]
       #   Specify which actions are new resource actions in addition to :+new+ and :+create+.
       #   Pass an action name into here if you would like to build a new resource instead of
       #   fetch one.
-      #   
+      #
       #     load_resource :new => :build
-      # 
+      #
       def load_resource(options = {})
-        before_filter(options.slice(:only, :except)) { |c| ResourceAuthorization.new(c, c.params, options.except(:only, :except)).load_resource }
+        ResourceAuthorization.add_before_filter(self, :load_resource, options)
       end
-      
+
       # Sets up a before filter which authorizes the current resource using the instance variable.
       # For example, if you have an ArticlesController it will check the @article instance variable
       # and ensure the user can perform the current action on it. Under the hood it is doing
       # something like the following.
-      # 
+      #
-      #   unauthorized! if cannot?(params[:action].to_sym, @article || Article)
+      #   authorize!(params[:action].to_sym, @article || Article)
-      # 
+      #
       # Call this method directly on the controller class.
-      # 
+      #
       #   class BooksController < ApplicationController
       #     authorize_resource
       #   end
-      # 
+      #
       # See load_and_authorize_resource to automatically load the resource too.
-      # 
+      #
       # Options:
       # [:+only+]
       #   Only applies before filter to given actions.
-      #   
+      #
       # [:+except+]
       #   Does not apply before filter to given actions.
-      # 
+      #
-      # [:+class+]
+      # [:+name+]
-      #   The class to use for the model.
+      #   The name of the resource if it cannot be determined from controller (string or symbol).
-      # 
+      #
+      #     load_resource :name => :article
+      #
+      # [:+resource+]
+      #   The class to use for the model (string or constant). Alternatively pass a symbol
+      #   to represent a resource which does not have a class.
+      #
       def authorize_resource(options = {})
-        before_filter(options.slice(:only, :except)) { |c| ResourceAuthorization.new(c, c.params, options.except(:only, :except)).authorize_resource }
+        ResourceAuthorization.add_before_filter(self, :authorize_resource, options)
       end
     end
-    
+
     def self.included(base)
       base.extend ClassMethods
       base.helper_method :can?, :cannot?
     end
-    
+
-    # Raises the CanCan::AccessDenied exception. This is often used in a
+    # Raises a CanCan::AccessDenied exception if the current_ability cannot
-    # controller action to mark a request as unauthorized.
+    # perform the given action. This is usually called in a controller action or
-    # 
+    # before filter to perform the authorization.
+    #
     #   def show
     #     @article = Article.find(params[:id])
-    #     unauthorized! if cannot? :read, @article
+    #     authorize! :read, @article
     #   end
-    # 
+    #
-    # You can rescue from the exception in the controller to specify
+    # A :message option can be passed to specify a different message.
-    # the user experience.
+    #
-    # 
+    #   authorize! :read, @article, :message => "Not authorized to read #{@article.name}"
+    #
+    # You can rescue from the exception in the controller to customize how unauthorized
+    # access is displayed to the user.
+    #
     #   class ApplicationController < ActionController::Base
-    #     rescue_from CanCan::AccessDenied, :with => :access_denied
+    #     rescue_from CanCan::AccessDenied do |exception|
-    #   
+    #       flash[:error] = exception.message
-    #     protected
-    #   
-    #     def access_denied
-    #       flash[:error] = "Sorry, you are not allowed to access that page."
     #       redirect_to root_url
     #     end
     #   end
-    # 
+    #
-    # See the load_and_authorize_resource method to automatically add
+    # See the CanCan::AccessDenied exception for more details on working with the exception.
-    # the "unauthorized!" behavior to a RESTful controller's actions.
+    #
-    def unauthorized!
+    # See the load_and_authorize_resource method to automatically add the authorize! behavior
-      raise AccessDenied, "You are unable to access this page."
+    # to the default RESTful actions.
+    def authorize!(action, subject, *args)
+      message = nil
+      if args.last.kind_of?(Hash) && args.last.has_key?(:message)
+        message = args.pop[:message]
+      end
+      raise AccessDenied.new(message, action, subject) if cannot?(action, subject, *args)
     end
-    
+
-    # Creates and returns the current user's ability. You generally do not invoke
+    def unauthorized!(message = nil)
-    # this method directly, instead you can override this method to change its
+      raise ImplementationRemoved, "The unauthorized! method has been removed from CanCan, use authorize! instead."
-    # behavior if the Ability class or current_user method are different.
+    end
-    # 
+
+    # Creates and returns the current user's ability and caches it. If you
+    # want to override how the Ability is defined then this is the place.
+    # Just define the method in the controller to change behavior.
+    #
     #   def current_ability
-    #     UserAbility.new(current_account) # instead of Ability.new(current_user)
+    #     # instead of Ability.new(current_user)
+    #     @current_ability ||= UserAbility.new(current_account)
     #   end
-    # 
+    #
+    # Notice it is important to cache the ability object so it is not
+    # recreated every time.
     def current_ability
-      ::Ability.new(current_user)
+      @current_ability ||= ::Ability.new(current_user)
     end
-    
+
     # Use in the controller or view to check the user's permission for a given action
     # and object.
-    # 
+    #
     #   can? :destroy, @project
-    # 
+    #
     # You can also pass the class instead of an instance (if you don't have one handy).
-    # 
+    #
     #   <% if can? :create, Project %>
     #     <%= link_to "New Project", new_project_path %>
     #   <% end %>
-    # 
+    #
     # This simply calls "can?" on the current_ability. See Ability#can?.
     def can?(*args)
-      (@current_ability ||= current_ability).can?(*args)
+      current_ability.can?(*args)
     end
-    
+
     # Convenience method which works the same as "can?" but returns the opposite value.
-    # 
+    #
     #   cannot? :destroy, @project
-    # 
+    #
     def cannot?(*args)
-      (@current_ability ||= current_ability).cannot?(*args)
+      current_ability.cannot?(*args)
     end
   end
 end

lib/cancan/controller_resource.rb

@@ -1,26 +1,38 @@
 module CanCan
+  # Used internally to load and authorize a given controller resource.
+  # This manages finding or building an instance of the resource. If a
+  # parent is given it will go through the association.
   class ControllerResource # :nodoc:
     def initialize(controller, name, parent = nil, options = {})
+      raise ImplementationRemoved, "The :class option has been renamed to :resource for specifying the class in CanCan." if options.has_key? :class
       @controller = controller
       @name = name
       @parent = parent
       @options = options
     end
     
+    # Returns the class used for this resource. This can be overriden by the :resource option.
+    # Sometimes one will use a symbol as the resource if a class does not exist for it. In that
+    # case "find" and "build" should not be called on it.
     def model_class
-      @options[:class] || @name.to_s.camelize.constantize
+      resource_class = @options[:resource]
+      if resource_class.nil?
+        @name.to_s.camelize.constantize
+      elsif resource_class.kind_of? String
+        resource_class.constantize
+      else
+        resource_class # could be a symbol
+      end
     end
     
     def find(id)
       self.model_instance ||= base.find(id)
     end
     
+    # Build a new instance of this resource. If it is a class we just call "new" otherwise
+    # it's an associaiton and "build" is used.
     def build(attributes)
-      if base.kind_of? Class
+      self.model_instance ||= (base.kind_of?(Class) ? base.new(attributes) : base.build(attributes))
-        self.model_instance ||= base.new(attributes)
-      else
-        self.model_instance ||= base.build(attributes)
-      end
     end
     
     def model_instance
@@ -33,6 +45,8 @@ module CanCan
     
     private
     
+    # The object that methods (such as "find", "new" or "build") are called on.
+    # If there is a parent it will be the association, otherwise it will be the model's class.
     def base
       @parent ? @parent.model_instance.send(@name.to_s.pluralize) : model_class
     end

lib/cancan/exceptions.rb

@@ -0,0 +1,43 @@
+module CanCan
+  # A general CanCan exception
+  class Error < StandardError; end
+
+  # Raised when removed code is called, an alternative solution is provided in message.
+  class ImplementationRemoved < Error; end
+
+  # This error is raised when a user isn't allowed to access a given controller action.
+  # This usually happens within a call to ControllerAdditions#authorize! but can be
+  # raised manually.
+  #
+  #   raise CanCan::AccessDenied.new("Not authorized!", :read, Article)
+  #
+  # The passed message, action, and subject are optional and can later be retrieved when
+  # rescuing from the exception.
+  #
+  #   exception.message # => "Not authorized!"
+  #   exception.action # => :read
+  #   exception.subject # => Article
+  #
+  # If the message is not specified (or is nil) it will default to "You are not authorized
+  # to access this page." This default can be overridden by setting default_message.
+  #
+  #   exception.default_message = "Default error message"
+  #   exception.message # => "Default error message"
+  #
+  # See ControllerAdditions#authorized! for more information on rescuing from this exception.
+  class AccessDenied < Error
+    attr_reader :action, :subject
+    attr_writer :default_message
+
+    def initialize(message = nil, action = nil, subject = nil)
+      @message = message
+      @action = action
+      @subject = subject
+      @default_message = "You are not authorized to access this page."
+    end
+
+    def to_s
+      @message || @default_message
+    end
+  end
+end

lib/cancan/matchers.rb

@@ -0,0 +1,13 @@
+Spec::Matchers.define :be_able_to do |*args|
+  match do |ability|
+    ability.can?(*args)
+  end
+
+  failure_message_for_should do |ability|
+    "expected to be able to #{args.map(&:inspect).join(" ")}"
+  end
+
+  failure_message_for_should_not do |ability|
+    "expected not to be able to #{args.map(&:inspect).join(" ")}"
+  end
+end

lib/cancan/resource_authorization.rb

@@ -1,38 +1,46 @@
 module CanCan
+  # Handle the load and authorization controller logic so we don't clutter up all controllers with non-interface methods.
+  # This class is used internally, so you do not need to call methods directly on it.
   class ResourceAuthorization # :nodoc:
-    attr_reader :params
+    def self.add_before_filter(controller_class, method, options = {})
-    
+      controller_class.before_filter(options.slice(:only, :except)) do |controller|
+        ResourceAuthorization.new(controller, controller.params, options.except(:only, :except)).send(method)
+      end
+    end
+
     def initialize(controller, params, options = {})
       @controller = controller
       @params = params
       @options = options
     end
-    
+
     def load_and_authorize_resource
       load_resource
       authorize_resource
     end
-    
+
     def load_resource
-      unless collection_actions.include? params[:action].to_sym
+      if collection_actions.include? @params[:action].to_sym
-        if new_actions.include? params[:action].to_sym
+        parent_resource
-          resource.build(params[model_name.to_sym])
+      else
-        elsif params[:id]
+        if new_actions.include? @params[:action].to_sym
-          resource.find(params[:id])
+          resource.build(@params[model_name.to_sym])
+        elsif @params[:id]
+          resource.find(@params[:id])
         end
       end
     end
-    
+
     def authorize_resource
-      @controller.unauthorized! if @controller.cannot?(params[:action].to_sym, resource.model_instance || resource.model_class)
+      @controller.authorize!(@params[:action].to_sym, resource.model_instance || resource.model_class)
     end
-    
+
     private
-    
+
     def resource
       @resource ||= ControllerResource.new(@controller, model_name, parent_resource, @options)
     end
-    
+
     def parent_resource
       parent = nil
       [@options[:nested]].flatten.compact.each do |name|
@@ -46,15 +54,15 @@ module CanCan
       end
       parent
     end
-    
+
     def model_name
-      params[:controller].split('/').last.singularize
+      @options[:name] || @params[:controller].sub("Controller", "").underscore.split('/').last.singularize
     end
-    
+
     def collection_actions
       [:index] + [@options[:collection]].flatten
     end
-    
+
     def new_actions
       [:new, :create] + [@options[:new]].flatten
     end

spec/cancan/ability_spec.rb

@@ -1,22 +1,21 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require "spec_helper"
 
 describe CanCan::Ability do
   before(:each) do
-    @ability_class = Class.new
+    @ability = Object.new
-    @ability_class.send(:include, CanCan::Ability)
+    @ability.extend(CanCan::Ability)
-    @ability = @ability_class.new
   end
-  
+
   it "should be able to :read anything" do
     @ability.can :read, :all
     @ability.can?(:read, String).should be_true
     @ability.can?(:read, 123).should be_true
   end
-  
+
   it "should not have permission to do something it doesn't know about" do
     @ability.can?(:foodfight, String).should be_false
   end
-  
+
   it "should return what block returns on a can call" do
     @ability.can :read, :all
     @ability.can :read, Symbol do |sym|
@@ -25,21 +24,21 @@ describe CanCan::Ability do
     @ability.can?(:read, Symbol).should be_nil
     @ability.can?(:read, :some_symbol).should == :some_symbol
   end
-  
+
   it "should pass class with object if :all objects are accepted" do
     @ability.can :preview, :all do |object_class, object|
       [object_class, object]
     end
     @ability.can?(:preview, 123).should == [Fixnum, 123]
   end
-  
+
   it "should pass class with no object if :all objects are accepted and class is passed directly" do
     @ability.can :preview, :all do |object_class, object|
       [object_class, object]
     end
     @ability.can?(:preview, Hash).should == [Hash, nil]
   end
-  
+
   it "should pass action and object for global manage actions" do
     @ability.can :manage, Array do |action, object|
       [action, object]
@@ -47,16 +46,14 @@ describe CanCan::Ability do
     @ability.can?(:stuff, [1, 2]).should == [:stuff, [1, 2]]
     @ability.can?(:stuff, Array).should == [:stuff, nil]
   end
-  
+
   it "should alias update or destroy actions to modify action" do
     @ability.alias_action :update, :destroy, :to => :modify
-    @ability.can :modify, :all do |object_class, object|
+    @ability.can(:modify, :all) { :modify_called }
-      :modify_called
-    end
     @ability.can?(:update, 123).should == :modify_called
     @ability.can?(:destroy, 123).should == :modify_called
   end
-  
+
   it "should return block result for action, object_class, and object for any action" do
     @ability.can :manage, :all do |action, object_class, object|
       [action, object_class, object]
@@ -64,56 +61,56 @@ describe CanCan::Ability do
     @ability.can?(:foo, 123).should == [:foo, Fixnum, 123]
     @ability.can?(:bar, Fixnum).should == [:bar, Fixnum, nil]
   end
-  
+
   it "should automatically alias index and show into read calls" do
     @ability.can :read, :all
     @ability.can?(:index, 123).should be_true
     @ability.can?(:show, 123).should be_true
   end
-  
+
   it "should automatically alias new and edit into create and update respectively" do
     @ability.can(:create, :all) { :create_called }
     @ability.can(:update, :all) { :update_called }
     @ability.can?(:new, 123).should == :create_called
     @ability.can?(:edit, 123).should == :update_called
   end
-  
+
   it "should not respond to prepare (now using initialize)" do
     @ability.should_not respond_to(:prepare)
   end
-  
+
   it "should offer cannot? method which is simply invert of can?" do
     @ability.cannot?(:tie, String).should be_true
   end
-  
+
   it "should be able to specify multiple actions and match any" do
     @ability.can [:read, :update], :all
     @ability.can?(:read, 123).should be_true
     @ability.can?(:update, 123).should be_true
     @ability.can?(:count, 123).should be_false
   end
-  
+
   it "should be able to specify multiple classes and match any" do
     @ability.can :update, [String, Array]
     @ability.can?(:update, "foo").should be_true
     @ability.can?(:update, []).should be_true
     @ability.can?(:update, 123).should be_false
   end
-  
+
   it "should support custom objects in the can definition" do
     @ability.can :read, :stats
     @ability.can?(:read, :stats).should be_true
     @ability.can?(:update, :stats).should be_false
     @ability.can?(:read, :nonstats).should be_false
   end
-  
+
   it "should support 'cannot' method to define what user cannot do" do
     @ability.can :read, :all
     @ability.cannot :read, Integer
     @ability.can?(:read, "foo").should be_true
     @ability.can?(:read, 123).should be_false
   end
-  
+
   it "should support block on 'cannot' method" do
     @ability.can :read, :all
     @ability.cannot :read, Integer do |int|
@@ -123,4 +120,84 @@ describe CanCan::Ability do
     @ability.can?(:read, 3).should be_true
     @ability.can?(:read, 123).should be_false
   end
+
+  it "should append aliased actions" do
+    @ability.alias_action :update, :to => :modify
+    @ability.alias_action :destroy, :to => :modify
+    @ability.aliased_actions[:modify].should == [:update, :destroy]
+  end
+
+  it "should clear aliased actions" do
+    @ability.alias_action :update, :to => :modify
+    @ability.clear_aliased_actions
+    @ability.aliased_actions[:modify].should be_nil
+  end
+
+  it "should pass additional arguments to block from can?" do
+    @ability.can :read, Integer do |int, x|
+      int > x
+    end
+    @ability.can?(:read, 2, 1).should be_true
+    @ability.can?(:read, 2, 3).should be_false
+  end
+
+  it "should use conditions as third parameter and determine abilities from it" do
+    @ability.can :read, Array, :first => 1, :last => 3
+    @ability.can?(:read, [1, 2, 3]).should be_true
+    @ability.can?(:read, [1, 2, 3, 4]).should be_false
+    @ability.can?(:read, Array).should be_true
+  end
+
+  it "should allow an array of options in conditions hash" do
+    @ability.can :read, Array, :first => [1, 3, 5]
+    @ability.can?(:read, [1, 2, 3]).should be_true
+    @ability.can?(:read, [2, 3]).should be_false
+    @ability.can?(:read, [3, 4]).should be_true
+  end
+
+  it "should allow a range of options in conditions hash" do
+    @ability.can :read, Array, :first => 1..3
+    @ability.can?(:read, [1, 2, 3]).should be_true
+    @ability.can?(:read, [3, 4]).should be_true
+    @ability.can?(:read, [4, 5]).should be_false
+  end
+
+  it "should allow nested hashes in conditions hash" do
+    @ability.can :read, Array, :first => { :length => 5 }
+    @ability.can?(:read, ["foo", "bar"]).should be_false
+    @ability.can?(:read, ["test1", "foo"]).should be_true
+  end
+
+  it "should allow nested hash of arrays and match any element" do
+    @ability.can :read, Array, :first => { :to_i => 3 }
+    @ability.can?(:read, [[1, 2, 3]]).should be_true
+    @ability.can?(:read, [[4, 5, 6]]).should be_false
+  end
+
+  it "should return conditions for a given ability" do
+    @ability.can :read, Array, :first => 1, :last => 3
+    @ability.conditions(:show, Array).should == {:first => 1, :last => 3}
+  end
+
+  it "should raise an exception when a block is used on condition" do
+    @ability.can :read, Array do |a|
+      true
+    end
+    lambda { @ability.conditions(:show, Array) }.should raise_error(CanCan::Error, "Cannot determine ability conditions from block for :show Array")
+  end
+
+  it "should return an empty hash for conditions when there are no conditions" do
+    @ability.can :read, Array
+    @ability.conditions(:show, Array).should == {}
+  end
+
+  it "should return false when performed on an action which isn't defined" do
+    @ability.conditions(:foo, Array).should == false
+  end
+
+  it "should has eated cheezburger" do
+    lambda {
+      @ability.can? :has, :cheezburger
+    }.should raise_exception(CanCan::Error, "Nom nom nom. I eated it.")
+  end
 end

spec/cancan/active_record_additions_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe CanCan::ActiveRecordAdditions do
+  before(:each) do
+    @model_class = Class.new
+    stub(@model_class).scoped { :scoped_stub }
+    @model_class.send(:include, CanCan::ActiveRecordAdditions)
+    @ability = Object.new
+    @ability.extend(CanCan::Ability)
+  end
+
+  it "should call where(:id => nil) when no ability is defined so no records are found" do
+    stub(@model_class).where(:id => nil).stub!.joins(nil) { :no_where }
+    @model_class.accessible_by(@ability, :read).should == :no_where
+  end
+
+  it "should call where with matching ability conditions" do
+    @ability.can :read, @model_class, :foo => {:bar => 1}
+    stub(@model_class).where(:foos => { :bar => 1 }).stub!.joins([:foo]) { :found_records }
+    @model_class.accessible_by(@ability, :read).should == :found_records
+  end
+
+  it "should default to :read ability and use scoped when where isn't available" do
+    @ability.can :read, @model_class, :foo => {:bar => 1}
+    stub(@model_class).scoped(:conditions => {:foos => {:bar => 1}}, :joins => [:foo]) { :found_records }
+    @model_class.accessible_by(@ability).should == :found_records
+  end
+end

spec/cancan/can_definition_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe CanCan::CanDefinition do
+  before(:each) do
+    @conditions = {}
+    @can = CanCan::CanDefinition.new(true, :read, Integer, @conditions, nil)
+  end
+
+  it "should return no association joins if none exist" do
+    @can.association_joins.should be_nil
+  end
+
+  it "should return no association for joins if just attributes" do
+    @conditions[:foo] = :bar
+    @can.association_joins.should be_nil
+  end
+
+  it "should return single association for joins" do
+    @conditions[:foo] = {:bar => 1}
+    @can.association_joins.should == [:foo]
+  end
+
+  it "should return multiple associations for joins" do
+    @conditions[:foo] = {:bar => 1}
+    @conditions[:test] = {1 => 2}
+    @can.association_joins.map(&:to_s).sort.should == [:foo, :test].map(&:to_s).sort
+  end
+
+  it "should return nested associations for joins" do
+    @conditions[:foo] = {:bar => {1 => 2}}
+    @can.association_joins.should == [{:foo => [:bar]}]
+  end
+
+  it "should return table names in conditions for association joins" do
+    @conditions[:foo] = {:bar => 1}
+    @conditions[:test] = 1
+    @can.conditions(:tableize => true).should == { :foos => { :bar => 1}, :test => 1 }
+  end
+
+  it "should return no association joins if conditions is nil" do
+    can = CanCan::CanDefinition.new(true, :read, Integer, nil, nil)
+    can.association_joins.should be_nil
+  end
+end

spec/cancan/controller_additions_spec.rb

@@ -1,44 +1,69 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require "spec_helper"
 
 describe CanCan::ControllerAdditions do
   before(:each) do
     @controller_class = Class.new
     @controller = @controller_class.new
     stub(@controller).params { {} }
+    stub(@controller).current_user { :current_user }
     mock(@controller_class).helper_method(:can?, :cannot?)
     @controller_class.send(:include, CanCan::ControllerAdditions)
   end
-  
+
-  it "should read from the cache with request uri as key and render that text" do
+  it "should raise ImplementationRemoved when attempting to call 'unauthorized!' on a controller" do
-    lambda {
+    lambda { @controller.unauthorized! }.should raise_error(CanCan::ImplementationRemoved)
-      @controller.unauthorized!
-    }.should raise_error(CanCan::AccessDenied)
   end
-  
+
+  it "should raise access denied exception if ability us unauthorized to perform a certain action" do
+    begin
+      @controller.authorize! :read, :foo, 1, 2, 3, :message => "Access denied!"
+    rescue CanCan::AccessDenied => e
+      e.message.should == "Access denied!"
+      e.action.should == :read
+      e.subject.should == :foo
+    else
+      fail "Expected CanCan::AccessDenied exception to be raised"
+    end
+  end
+
+  it "should not raise access denied exception if ability is authorized to perform an action" do
+    @controller.current_ability.can :read, :foo
+    lambda { @controller.authorize!(:read, :foo) }.should_not raise_error
+  end
+
+  it "should raise access denied exception with default message if not specified" do
+    begin
+      @controller.authorize! :read, :foo
+    rescue CanCan::AccessDenied => e
+      e.default_message = "Access denied!"
+      e.message.should == "Access denied!"
+    else
+      fail "Expected CanCan::AccessDenied exception to be raised"
+    end
+  end
+
   it "should have a current_ability method which generates an ability for the current user" do
-    stub(@controller).current_user { :current_user }
     @controller.current_ability.should be_kind_of(Ability)
   end
-  
+
   it "should provide a can? and cannot? methods which go through the current ability" do
-    stub(@controller).current_user { :current_user }
     @controller.current_ability.should be_kind_of(Ability)
     @controller.can?(:foo, :bar).should be_false
     @controller.cannot?(:foo, :bar).should be_true
   end
-  
+
   it "load_and_authorize_resource should setup a before filter which passes call to ResourceAuthorization" do
     stub(CanCan::ResourceAuthorization).new(@controller, @controller.params, :foo => :bar).mock!.load_and_authorize_resource
     mock(@controller_class).before_filter({}) { |options, block| block.call(@controller) }
     @controller_class.load_and_authorize_resource :foo => :bar
   end
-  
+
   it "authorize_resource should setup a before filter which passes call to ResourceAuthorization" do
     stub(CanCan::ResourceAuthorization).new(@controller, @controller.params, :foo => :bar).mock!.authorize_resource
     mock(@controller_class).before_filter(:except => :show) { |options, block| block.call(@controller) }
     @controller_class.authorize_resource :foo => :bar, :except => :show
   end
-  
+
   it "load_resource should setup a before filter which passes call to ResourceAuthorization" do
     stub(CanCan::ResourceAuthorization).new(@controller, @controller.params, :foo => :bar).mock!.load_resource
     mock(@controller_class).before_filter(:only => [:show, :index]) { |options, block| block.call(@controller) }

spec/cancan/controller_resource_spec.rb

@@ -1,49 +1,59 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require "spec_helper"
 
 describe CanCan::ControllerResource do
   before(:each) do
     @controller = Object.new
   end
-  
+
   it "should determine model class by constantizing give name" do
     CanCan::ControllerResource.new(@controller, :ability).model_class.should == Ability
   end
-  
+
   it "should fetch model through model class and assign it to the instance" do
     stub(Ability).find(123) { :some_ability }
     CanCan::ControllerResource.new(@controller, :ability).find(123)
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should fetch model through parent and assign it to the instance" do
     parent = Object.new
     stub(parent).model_instance.stub!.abilities.stub!.find(123) { :some_ability }
     CanCan::ControllerResource.new(@controller, :ability, parent).find(123)
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should build model through model class and assign it to the instance" do
     stub(Ability).new(123) { :some_ability }
     CanCan::ControllerResource.new(@controller, :ability).build(123)
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should build model through parent and assign it to the instance" do
     parent = Object.new
     stub(parent).model_instance.stub!.abilities.stub!.build(123) { :some_ability }
     CanCan::ControllerResource.new(@controller, :ability, parent).build(123)
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should not load resource if instance variable is already provided" do
     @controller.instance_variable_set(:@ability, :some_ability)
     CanCan::ControllerResource.new(@controller, :ability).find(123)
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should use the model class option if provided" do
     stub(Person).find(123) { :some_resource }
-    CanCan::ControllerResource.new(@controller, :ability, nil, :class => Person).find(123)
+    CanCan::ControllerResource.new(@controller, :ability, nil, :resource => Person).find(123)
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
+
+  it "should convert string to constant for resource" do
+    CanCan::ControllerResource.new(@controller, :ability, nil, :resource => "Person").model_class.should == Person
+  end
+
+  it "should raise an exception when specifying :class option since it is no longer used" do
+    lambda {
+      CanCan::ControllerResource.new(@controller, :ability, nil, :class => Person)
+    }.should raise_error(CanCan::ImplementationRemoved)
+  end
 end

spec/cancan/exceptions_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe CanCan::AccessDenied do
+  describe "with action and subject" do
+    before(:each) do
+      @exception = CanCan::AccessDenied.new(nil, :some_action, :some_subject)
+    end
+
+    it "should have action and subject accessors" do
+      @exception.action.should == :some_action
+      @exception.subject.should == :some_subject
+    end
+
+    it "should have a changable default message" do
+      @exception.message.should == "You are not authorized to access this page."
+      @exception.default_message = "Unauthorized!"
+      @exception.message.should == "Unauthorized!"
+    end
+  end
+
+  describe "with only a message" do
+    before(:each) do
+      @exception = CanCan::AccessDenied.new("Access denied!")
+    end
+
+    it "should have nil action and subject" do
+      @exception.action.should be_nil
+      @exception.subject.should be_nil
+    end
+
+    it "should have passed message" do
+      @exception.message.should == "Access denied!"
+    end
+  end
+end

spec/cancan/matchers_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "be_able_to" do
+  it "delegates to can?" do
+    object = Object.new
+    mock(object).can?(:read, 123) { true }
+    object.should be_able_to(:read, 123)
+  end
+
+  it "reports a nice failure message for should" do
+    object = Object.new
+    mock(object).can?(:read, 123) { false }
+    expect do
+      object.should be_able_to(:read, 123)
+    end.should raise_error('expected to be able to :read 123')
+  end
+
+  it "reports a nice failure message for should not" do
+    object = Object.new
+    mock(object).can?(:read, 123) { true }
+    expect do
+      object.should_not be_able_to(:read, 123)
+    end.should raise_error('expected not to be able to :read 123')
+  end
+
+  it "delegates additional arguments to can? and reports in failure message" do
+    object = Object.new
+    mock(object).can?(:read, 123, 456) { false }
+    expect do
+      object.should be_able_to(:read, 123, 456)
+    end.should raise_error('expected to be able to :read 123 456')
+  end
+end

spec/cancan/resource_authorization_spec.rb

@@ -1,102 +1,115 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require "spec_helper"
 
 describe CanCan::ResourceAuthorization do
   before(:each) do
     @controller = Object.new # simple stub for now
-    stub(@controller).unauthorized! { raise CanCan::AccessDenied }
   end
-  
+
   it "should load the resource into an instance variable if params[:id] is specified" do
     stub(Ability).find(123) { :some_resource }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "show", :id => 123)
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
-  
+
   it "should properly load resource for namespaced controller" do
     stub(Ability).find(123) { :some_resource }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "admin/abilities", :action => "show", :id => 123)
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
-  
+
+  it "should properly load resource for namespaced controller when using '::' for namespace" do
+    stub(Ability).find(123) { :some_resource }
+    authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "Admin::AbilitiesController", :action => "show", :id => 123)
+    authorization.load_resource
+    @controller.instance_variable_get(:@ability).should == :some_resource
+  end
+
   it "should build a new resource with hash if params[:id] is not specified" do
     stub(Ability).new(:foo => "bar") { :some_resource }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "create", :ability => {:foo => "bar"})
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
-  
+
   it "should build a new resource even if attribute hash isn't specified" do
     stub(Ability).new(nil) { :some_resource }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "new")
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
-  
+
   it "should not build a resource when on index action" do
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "index")
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should be_nil
   end
-  
+
   it "should perform authorization using controller action and loaded model" do
     @controller.instance_variable_set(:@ability, :some_resource)
-    stub(@controller).cannot?(:show, :some_resource) { true }
+    stub(@controller).authorize!(:show, :some_resource) { raise CanCan::AccessDenied }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "show")
-    lambda {
+    lambda { authorization.authorize_resource }.should raise_error(CanCan::AccessDenied)
-      authorization.authorize_resource
-    }.should raise_error(CanCan::AccessDenied)
   end
-  
+
   it "should perform authorization using controller action and non loaded model" do
-    stub(@controller).cannot?(:show, Ability) { true }
+    stub(@controller).authorize!(:show, Ability) { raise CanCan::AccessDenied }
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "show")
-    lambda {
+    lambda { authorization.authorize_resource }.should raise_error(CanCan::AccessDenied)
-      authorization.authorize_resource
-    }.should raise_error(CanCan::AccessDenied)
   end
-  
+
   it "should call load_resource and authorize_resource for load_and_authorize_resource" do
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "show")
     mock(authorization).load_resource
     mock(authorization).authorize_resource
     authorization.load_and_authorize_resource
   end
-  
+
   it "should not build a resource when on custom collection action" do
     authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "sort"}, {:collection => [:sort, :list]})
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should be_nil
   end
-  
+
   it "should build a resource when on custom new action even when params[:id] exists" do
     stub(Ability).new(nil) { :some_resource }
     authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "build", :id => 123}, {:new => :build})
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end
-  
+
   it "should not try to load resource for other action if params[:id] is undefined" do
     authorization = CanCan::ResourceAuthorization.new(@controller, :controller => "abilities", :action => "list")
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should be_nil
   end
-  
+
   it "should load nested resource and fetch other resource through the association" do
-    stub(Person).find(456).stub!.abilities.stub!.find(123) { :some_ability }
+    person = Object.new
+    stub(Person).find(456) { person }
+    stub(person).abilities.stub!.find(123) { :some_ability }
     authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "show", :id => 123, :person_id => 456}, {:nested => :person})
     authorization.load_resource
+    @controller.instance_variable_get(:@person).should == person
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
+  it "should load nested resource for collection action" do
+    person = Object.new
+    stub(Person).find(456) { person }
+    authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "index", :person_id => 456}, {:nested => :person})
+    authorization.load_resource
+    @controller.instance_variable_get(:@person).should == person
+  end
+
   it "should load nested resource and build resource through a deep association" do
     stub(Person).find(456).stub!.behaviors.stub!.find(789).stub!.abilities.stub!.build(nil) { :some_ability }
     authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "new", :person_id => 456, :behavior_id => 789}, {:nested => [:person, :behavior]})
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should not load nested resource and build through this if *_id param isn't specified" do
     stub(Person).find(456) { :some_person }
     stub(Ability).new(nil) { :some_ability }
@@ -105,10 +118,17 @@ describe CanCan::ResourceAuthorization do
     @controller.instance_variable_get(:@person).should == :some_person
     @controller.instance_variable_get(:@ability).should == :some_ability
   end
-  
+
   it "should load the model using a custom class" do
     stub(Person).find(123) { :some_resource }
-    authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "show", :id => 123}, {:class => Person})
+    authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "abilities", :action => "show", :id => 123}, {:resource => Person})
+    authorization.load_resource
+    @controller.instance_variable_get(:@ability).should == :some_resource
+  end
+
+  it "should use :name option to determine resource name" do
+    stub(Ability).find(123) { :some_resource }
+    authorization = CanCan::ResourceAuthorization.new(@controller, {:controller => "foo", :action => "show", :id => 123}, {:name => :ability})
     authorization.load_resource
     @controller.instance_variable_get(:@ability).should == :some_resource
   end

spec/spec_helper.rb

@@ -4,7 +4,8 @@ require 'active_support'
 require 'active_record'
 require 'action_controller'
 require 'action_view'
-require File.dirname(__FILE__) + '/../lib/cancan.rb'
+require 'cancan'
+require 'cancan/matchers'
 
 Spec::Runner.configure do |config|
   config.mock_with :rr
@@ -12,7 +13,7 @@ end
 
 class Ability
   include CanCan::Ability
-  
+
   def initialize(user)
   end
 end