cancancan 1.8.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7079b16052c2f98ebe67d6ce08e390188bca856d
-  data.tar.gz: faa43141ca3124dbe3d40ceb30a76ca78bc56117
+  metadata.gz: 597f9c67d00dc9af7805456aca9464c41b795f42
+  data.tar.gz: e52df51e0f69a1f98509e7d8ae7ab8e14affb418
 SHA512:
-  metadata.gz: 8168024035574501d8bef61033f458facb1b7173ed98d901b9b51aedc0c659470f6210beb308273de9cd437e4d75027eb39321f104a9e8dc8f933593f1a67aa1
-  data.tar.gz: e71e7aa4f2a66f0f660aa9ce224dff3c0de2efc3b0fb85d461113175e5349700bf4475f5f9ca7abf16c56457488a33b3b5d954e753b021f162428c5827e28cd5
+  metadata.gz: df305f2d2c391e2ce49bf98f0cdbe6b0cc0d96140467bb3efa66032ce61fe0ada2984ab94bfc956fbd5a8e3d1251ae7f64e3fe5773a815d172abb62f5f71db18
+  data.tar.gz: 33dcb0f4db08c07cf7e62103588177c628ddf7f8e219495b2e74bec94c9e2608c9b38daf2009626ef51aa77e97f6cdfc4c12d08a946f2c41d2b99e7385a8e7ea

data/.travis.yml

@@ -1,24 +1,25 @@
+language: ruby
+cache: bundler
+sudo: false
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
   - 2.1.0
-  - ree
-  - jruby
-  - rbx
+  - 2.2.0
+  - jruby-9.0.5.0
 gemfile:
-  - gemfiles/activerecord_3.0.gemfile
-  - gemfiles/activerecord_3.1.gemfile
   - gemfiles/activerecord_3.2.gemfile
-  - gemfiles/datamapper_1.x.gemfile
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_4.2.gemfile
   - gemfiles/mongoid_2.x.gemfile
   - gemfiles/sequel_3.x.gemfile
 services:
   - mongodb
 matrix:
-  allow_failures:
-    - rvm: rbx
+  fast_finish: true
+  exclude:
+    - rvm: 2.2.0
+      gemfile: gemfiles/activerecord_3.2.gemfile
 notifications:
   recipients:
     - bryan@bryanrite.com

data/Appraisals

@@ -1,7 +1,5 @@
-appraise "activerecord_3.0" do
-  gem "activerecord", "~> 3.0.20", :require => "active_record"
-  gem 'activesupport', '~> 3.0.20', :require => 'active_support/all'
-  gem "meta_where"
+appraise "activerecord_3.2" do
+  gem "activerecord", "~> 3.2.0", :require => "active_record"
 
   gemfile.platforms :jruby do
     gem "activerecord-jdbcsqlite3-adapter"
@@ -13,8 +11,9 @@ appraise "activerecord_3.0" do
   end
 end
 
-appraise "activerecord_3.1" do
-  gem "activerecord", "~> 3.1.0", :require => "active_record"
+appraise "activerecord_4.0" do
+  gem "activerecord", "~> 4.0.5", :require => "active_record"
+  gem "activesupport", "~> 4.0.5", :require => "active_support/all"
 
   gemfile.platforms :jruby do
     gem "activerecord-jdbcsqlite3-adapter"
@@ -26,8 +25,9 @@ appraise "activerecord_3.1" do
   end
 end
 
-appraise "activerecord_3.2" do
-  gem "activerecord", "~> 3.2.0", :require => "active_record"
+appraise "activerecord_4.1" do
+  gem "activerecord", "~> 4.1.1", :require => "active_record"
+  gem "activesupport", "~> 4.1.1", :require => "active_support/all"
 
   gemfile.platforms :jruby do
     gem "activerecord-jdbcsqlite3-adapter"
@@ -39,15 +39,23 @@ appraise "activerecord_3.2" do
   end
 end
 
-appraise "datamapper_1.x" do
-  gem 'activesupport', '~> 3.0', :require => 'active_support/all'
-  gem "dm-core", "~> 1.0.2"
-  gem "dm-sqlite-adapter", "~> 1.0.2"
-  gem "dm-migrations", "~> 1.0.2"
+appraise "activerecord_4.2" do
+  gem "activerecord", "~> 4.2.0", :require => "active_record"
+  gem 'activesupport', '~> 4.2.0', :require => 'active_support/all'
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+    gem "jdbc-sqlite3"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3"
+    gem "pg"
+  end
 end
 
 appraise "mongoid_2.x" do
-  gem 'activesupport', '~> 3.0', :require => 'active_support/all'
+  gem "activesupport", "~> 3.0", :require => "active_support/all"
   gem "mongoid", "~> 2.0.0"
 
   gemfile.platforms :ruby, :mswin, :mingw do
@@ -61,10 +69,9 @@ end
 
 appraise "sequel_3.x" do
   gem "sequel", "~> 3.47.0"
-  gem 'activesupport', '~> 3.0', :require => 'active_support/all'
+  gem "activesupport", "~> 3.0", :require => "active_support/all"
 
   gemfile.platforms :jruby do
-    gem "activerecord-jdbcsqlite3-adapter"
     gem "jdbc-sqlite3"
   end
 

data/CHANGELOG.rdoc

@@ -1,5 +1,80 @@
 Develop
 
+Unreleased
+
+* Add support for rails 4 enum's (markpmitchell)
+
+1.13.1 (Oct 8th, 2015)
+
+* Fix #merge with empty Ability (jhawthorn)
+
+1.13.0 (Oct 7th, 2015)
+
+* Significantly improve rule lookup time (amarshall)
+* Removed deprecation warnings for RSpec 3.2 (NekoNova)
+
+1.12.0 (June 28th, 2015)
+
+* Add a permissions method to Ability (devaroop)
+
+1.11.0 (June 15th, 2015)
+
+* Complete cancancan#115 - Specify authorization action for parent resources. (phallguy)
+
+1.10.1 (January 13th, 2015)
+
+* Fix cancancan#168 - A bug with ActiveRecord 4.2 support causing ProtocolViolation due to named parameters not being passed in.
+
+
+1.10.0 (January 7th, 2015)
+
+* Fix i18n issue for Ruby < 1.9.3 (bryanrite)
+
+* Fix cancancan#149 - Fix an issue loading namespaced models (darthjee)
+
+* Fix cancancan#160 - Support for Rails 4.2 (marshall-lee)
+
+* Fix cancancan#153 - More useful output in ability spec matchers (jondkinney)
+
+
+1.9.2 (August 8th, 2014)
+
+* Fix cancancan#77, 78 - Fix an issue with associations for namespaced models. (jjp)
+
+
+1.9.1 (July 21st, 2014)
+
+* Fix cancancan#101 - Fixes an issue where overjealous use of references would cause issues with scopes when loading associations. (bryanrite)
+
+
+1.9.0 (July 20th, 2014)
+
+* Fix cancancan#59 - Parameters are automatically detected and santitized for all actions, not just create and update. (bryanrite)
+
+* Fix cancancan#97, 72, 40, 39, 26 - Support Active Record 4 properly with references on nested permissions. (scpike, tdg5, Crystark)
+
+
+1.8.4 (June 24th, 2014)
+
+* Fix cancancan#86 - Fixes previous RSpec 3 update as there was a bug in the fix for RSpec 2.99. (bryanrite)
+
+
+1.8.3 (June 24th, 2014)
+
+* Fix cancancan#85 - Remove deprecation notices for RSpec 3 and continue backwards compatibility. (andypike, bryanrite, porteta)
+
+
+1.8.2 (June 5th, 2014)
+
+* Fix cancancan#75 - More specific hash-like object check. (bryanrite)
+
+
+1.8.1 (May 27th, 2014)
+
+* Fix cancancan#67 - Sequel tests are run properly for JRuby. (bryanrite)
+
+* Fix cancancan#68 - Checks for hash-like objects in subject better. (bryanrite)
+
 
 1.8.0 (May 8th, 2014)
 

data/CONTRIBUTING.md

@@ -2,9 +2,9 @@
 
 ### Reporting an Issue
 
-1. If you have any questions about CanCanCan, search the [Wiki](https://github.com/bryanrite/cancancan/wiki), use [Stack Overflow](http://stackoverflow.com/questions/tagged/cancancan), or [our mailing list](https://groups.google.com/forum/#!forum/cancancan). Do not post questions here.
+1. If you have any questions about CanCanCan, search the [Wiki](https://github.com/cancancommunity/cancancan/wiki), use [Stack Overflow](http://stackoverflow.com/questions/tagged/cancancan), or [our mailing list](https://groups.google.com/forum/#!forum/cancancan). Do not post questions here.
 
-1. If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to [bryan@bryanrite.com](mailto:bryan@bryanrite.com) instead.
+1. If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to the current maintainer instead.
 
 1. Do a small search on the issues tracker before submitting your issue to see if it was already reported / fixed.
 

data/README.md

@@ -0,0 +1,217 @@
+# CanCanCan
+
+[![Gem Version](https://badge.fury.io/rb/cancancan.svg)](http://badge.fury.io/rb/cancancan)
+[![Travis badge](https://travis-ci.org/CanCanCommunity/cancancan.svg?branch=develop)](https://travis-ci.org/CanCanCommunity/cancancan)
+[![Code Climate Badge](https://codeclimate.com/github/CanCanCommunity/cancancan.svg)](https://codeclimate.com/github/CanCanCommunity/cancancan)
+[![Inch CI](http://inch-ci.org/github/CanCanCommunity/cancancan.svg)](http://inch-ci.org/github/CanCanCommunity/cancancan)
+
+[Wiki](https://github.com/CanCanCommunity/cancancan/wiki) | [RDocs](http://rdoc.info/projects/CanCanCommunity/cancancan) | [Screencast](http://railscasts.com/episodes/192-authorization-with-cancan) | [IRC: #cancancan (freenode)](http://webchat.freenode.net/?channels=cancancan)
+
+CanCan is an authorization library for Ruby on Rails which restricts what resources a given user is allowed to access. All permissions are defined in a single location (the `Ability` class) and not duplicated across controllers, views, and database queries.
+
+## This is the master branch!
+This branch represents work towards version 2.0. Please checkout the 1.x branch for the stable release. Use master at your own risk.
+
+## Mission
+
+This repo is a continuation of the dead [CanCan](https://github.com/ryanb/cancan) project. Our mission is to keep CanCan alive and moving forward, with maintenance fixes and new features. Pull Requests are welcome!
+
+I am currently focusing on the 1.x branch for the immediate future, making sure it is up to date as well as ensuring compatibility with Rails 4+. I will take a look into the 2.x branch and try to see what improvements, reorganizations and redesigns Ryan was attempting and go forward from there.
+
+Any help is greatly appreciated, feel free to submit pull-requests or open issues.
+
+
+## Installation
+
+In **Rails 3 and 4**, add this to your Gemfile and run the `bundle install` command.
+
+    gem 'cancancan', '~> 1.10'
+
+## Getting Started
+
+CanCanCan expects a `current_user` method to exist in the controller. First, set up some authentication (such as [Authlogic](https://github.com/binarylogic/authlogic) or [Devise](https://github.com/plataformatec/devise)). See [Changing Defaults](https://github.com/CanCanCommunity/cancancan/wiki/changing-defaults) if you need different behavior.
+
+When using [rails-api](https://github.com/rails-api/rails-api), you have to manually include the controller methods for CanCan:
+```ruby
+class ApplicationController < ActionController::API
+  include CanCan::ControllerAdditions
+end
+```
+
+### 1. Define Abilities
+
+User permissions are defined in an `Ability` class. CanCan 1.5 includes a Rails 3 and 4 generator for creating this class.
+
+    rails g cancan:ability
+
+In Rails 2.3, just add a new class in `app/models/ability.rb` with the following contents:
+
+```ruby
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+  end
+end
+```
+
+See [Defining Abilities](https://github.com/CanCanCommunity/cancancan/wiki/defining-abilities) for details.
+
+
+### 2. Check Abilities & Authorization
+
+The current user's permissions can then be checked using the `can?` and `cannot?` methods in the view and controller.
+
+```erb
+<% if can? :update, @article %>
+  <%= link_to "Edit", edit_article_path(@article) %>
+<% end %>
+```
+
+See [Checking Abilities](https://github.com/CanCanCommunity/cancancan/wiki/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.
+
+```ruby
+def show
+  @article = Article.find(params[:id])
+  authorize! :read, @article
+end
+```
+
+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 every action.
+
+```ruby
+class ArticlesController < ApplicationController
+  load_and_authorize_resource
+
+  def show
+    # @article is already loaded and authorized
+  end
+end
+```
+
+See [Authorizing Controller Actions](https://github.com/CanCanCommunity/cancancan/wiki/authorizing-controller-actions) for more information.
+
+
+#### Strong Parameters
+
+When using `strong_parameters` or Rails 4+, you have to sanitize inputs before saving the record, in actions such as `:create` and `:update`.
+
+For the `:update` action, CanCan will load and authorize the resource but *not* change it automatically, so the typical usage would be something like:
+
+```ruby
+def update
+  if @article.update_attributes(update_params)
+    # hurray
+  else
+    render :edit
+  end
+end
+...
+
+def update_params
+  params.require(:article).permit(:body)
+end
+```
+
+For the `:create` action, CanCan will try to initialize a new instance with sanitized input by seeing if your controller will respond to the following methods (in order):
+
+1. `create_params`
+2. `<model_name>_params` such as `article_params` (this is the default convention in rails for naming your param method)
+3. `resource_params` (a generically named method you could specify in each controller)
+
+Additionally, `load_and_authorize_resource` can now take a `param_method` option to specify a custom method in the controller to run to sanitize input.
+
+You can associate the `param_method` option with a symbol corresponding to the name of a method that will get called:
+
+```ruby
+class ArticlesController < ApplicationController
+  load_and_authorize_resource param_method: :my_sanitizer
+
+  def create
+    if @article.save
+      # hurray
+    else
+      render :new
+    end
+  end
+
+  private
+
+  def my_sanitizer
+    params.require(:article).permit(:name)
+  end
+end
+```
+
+You can also use a string that will be evaluated in the context of the controller using `instance_eval` and needs to contain valid Ruby code. This does come in handy when using a PermittedParams class as suggested in Railscast 371:
+
+    load_and_authorize_resource param_method: 'permitted_params.article'
+
+Finally, it's possible to associate `param_method` with a Proc object which will be called with the controller as the only argument:
+
+    load_and_authorize_resource param_method: Proc.new { |c| c.params.require(:article).permit(:name) }
+
+See [Strong Parameters](https://github.com/CanCanCommunity/cancancan/wiki/Strong-Parameters) for more information.
+
+### 3. Handle Unauthorized Access
+
+If the user authorization fails, a `CanCan::AccessDenied` exception will be raised. You can catch this and modify its behavior in the `ApplicationController`.
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from CanCan::AccessDenied do |exception|
+    redirect_to root_url, :alert => exception.message
+  end
+end
+```
+
+See [Exception Handling](https://github.com/CanCanCommunity/cancancan/wiki/exception-handling) for more information.
+
+
+### 4. Lock It Down
+
+If you want to ensure authorization happens on every action in your application, add `check_authorization` to your `ApplicationController`.
+
+```ruby
+class ApplicationController < ActionController::Base
+  check_authorization
+end
+```
+
+This will raise an exception if authorization is not performed in an action. If you want to skip this, add `skip_authorization_check` to a controller subclass. See [Ensure Authorization](https://github.com/CanCanCommunity/cancancan/wiki/Ensure-Authorization) for more information.
+
+
+## Wiki Docs
+
+* [Upgrading to 1.6](https://github.com/CanCanCommunity/cancancan/wiki/Upgrading-to-1.6)
+* [Defining Abilities](https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities)
+* [Checking Abilities](https://github.com/CanCanCommunity/cancancan/wiki/Checking-Abilities)
+* [Authorizing Controller Actions](https://github.com/CanCanCommunity/cancancan/wiki/Authorizing-Controller-Actions)
+* [Exception Handling](https://github.com/CanCanCommunity/cancancan/wiki/Exception-Handling)
+* [Changing Defaults](https://github.com/CanCanCommunity/cancancan/wiki/Changing-Defaults)
+* [See more](https://github.com/CanCanCommunity/cancancan/wiki)
+
+## Questions?
+If you have any question or doubt regarding CanCanCan which you cannot find the solution to in the [documentation](https://github.com/CanCanCommunity/cancancan/wiki) or our [mailing list](http://groups.google.com/group/cancancan), please [open a question on Stackoverflow](http://stackoverflow.com/questions/ask?tags=cancancan) with tag [cancancan](http://stackoverflow.com/questions/tagged/cancancan)
+
+## Bugs?
+
+If you find a bug please add an [issue on GitHub](https://github.com/CanCanCommunity/cancancan/issues) or fork the project and send a pull request.
+
+
+## Development
+
+Cancancan uses [appraisals](https://github.com/thoughtbot/appraisal) to test the code base against multiple versions of Rails, as well as the different model adapters.
+
+When first developing, you may need to run `bundle install` and then `appraisal install`, to install the different sets.
+
+You can then run all appraisal files (like CI does), with `appraisal rake` or just run a specific set `appraisal activerecord_3.0 rake`.
+
+See the [CONTRIBUTING](https://github.com/CanCanCommunity/cancancan/blob/develop/CONTRIBUTING.md) and [spec/README](https://github.com/CanCanCommunity/cancancan/blob/master/spec/README.rdoc) for more information.
+
+
+## Special Thanks
+
+CanCan was inspired by [declarative_authorization](https://github.com/stffn/declarative_authorization/) and [aegis](https://github.com/makandra/aegis). Also many thanks to the [CanCan contributors](https://github.com/CanCanCommunity/cancancan/contributors). See the [CHANGELOG](https://github.com/CanCanCommunity/cancancan/blob/master/CHANGELOG.rdoc) for the full list.

data/cancancan.gemspec

@@ -6,8 +6,8 @@ require 'cancan/version'
 Gem::Specification.new do |s|
   s.name        = "cancancan"
   s.version     = CanCan::VERSION
-  s.authors     = ["Bryan Rite", "Ryan Bates"]
-  s.email       = "bryan@bryanrite.com"
+  s.authors     = ["Bryan Rite", "Ryan Bates", "Richard Wilson"]
+  s.email       = "r.crawfordwilson@gmail.com"
   s.homepage    = "https://github.com/CanCanCommunity/cancancan"
   s.summary     = "Simple authorization solution for Rails."
   s.description = "Continuation of the simple authorization solution for Rails which is decoupled from user roles. All permissions are stored in a single location."
@@ -19,13 +19,10 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split($/).map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
-  s.required_rubygems_version = ">= 1.3.4"
+  s.required_ruby_version = ">= 2.0.0"
 
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake', '~> 10.1.1'
-  s.add_development_dependency 'rspec', '~> 2.14'
-  s.add_development_dependency 'appraisal', '>= 1.0.0'
-
-  s.rubyforge_project = s.name
+  s.add_development_dependency 'rspec', '~> 3.2.0'
+  s.add_development_dependency 'appraisal', '>= 2.0.0'
 end

data/gemfiles/{activerecord_3.1.gemfile → activerecord_4.0.gemfile}

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 3.1.0", :require => "active_record"
+gem "activerecord", "~> 4.0.5", :require => "active_record"
+gem "activesupport", "~> 4.0.5", :require => "active_support/all"
 
 platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"

data/gemfiles/{activerecord_3.0.gemfile → activerecord_4.1.gemfile}

@@ -2,9 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 3.0.20", :require => "active_record"
-gem "activesupport", "~> 3.0.20", :require => "active_support/all"
-gem "meta_where"
+gem "activerecord", "~> 4.1.1", :require => "active_record"
+gem "activesupport", "~> 4.1.1", :require => "active_support/all"
 
 platforms :jruby do
   gem "activerecord-jdbcsqlite3-adapter"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0", :require => "active_record"
+gem "activesupport", "~> 4.2.0", :require => "active_support/all"
+
+platforms :jruby do
+  gem "activerecord-jdbcsqlite3-adapter"
+  gem "jdbc-sqlite3"
+end
+
+platforms :ruby, :mswin, :mingw do
+  gem "sqlite3"
+  gem "pg"
+end
+
+gemspec :path => "../"

data/gemfiles/sequel_3.x.gemfile

@@ -6,7 +6,6 @@ gem "sequel", "~> 3.47.0"
 gem "activesupport", "~> 3.0", :require => "active_support/all"
 
 platforms :jruby do
-  gem "activerecord-jdbcsqlite3-adapter"
   gem "jdbc-sqlite3"
 end