third-prestige-rolify 3.3.0.rc5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2db18461c5d4b36fba759899728a36106c6a6591
+  data.tar.gz: bded9de6408ca7582da1d41125633f92d72d9441
+SHA512:
+  metadata.gz: 6fae547b69f1c7f89a3fca11735dd153826ed6f477773bb95ac76bc46829493e791f7cf85a2eeefa5bd7847c10a08d4c7a627f76cc120e8655af138fe6f5f889
+  data.tar.gz: 55ad679b5c49555ee6124a6e36f5e39c93bc2a02d224765e8db6a4732d736b680c06d5bdf843ee277e3671ce70034001e8dffb5c1ad0adb9c5f59d455c092d3e

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+gemfiles/*.lock
+pkg/*
+tmp/*
+coverage/*
+log*/*
+.rbx/*
+.rspec

data/.travis.yml

@@ -0,0 +1,17 @@
+rvm:
+  - 1.9.3
+  - 2.0.0 
+  - rbx-19mode
+  - jruby-19mode
+
+gemfile:
+  - gemfiles/Gemfile.rails-3.2
+  - gemfiles/Gemfile.rails-4.0
+
+env:
+  - ADAPTER=active_record
+  - ADAPTER=mongoid
+
+services: mongodb
+
+before_script: rails --version

data/CHANGELOG.rdoc

@@ -0,0 +1,157 @@
+= 3.3 (not released yet)
+* <b>DEPRECATION NOTICE:</b>Rails 3.1 support dropped: if you use Rails 3.1, please stick to rolify 3.2
+* code cleanup in finders methods
+* generators rewritten entirely. now using ActiveRecord/Mongoid model generator to create Role model
+* added rspec matchers for detailed spec error messages (thanks to @delwyn)
+* clean up specs (thanks to @delwyn), removed subject and let declarations in before(:all) block
+* roles query needs 1 DB hit instead of 1 up to 3 (thanks to @terraplane)
+* remove nil entries from ResourceAdapter#resources_find when using Mongoid adapter (thanks to @daviscabral)
+* fixed a bug regarding redundant index for Mongoid Role model (thanks to  @rschultheis)
+* added support for rolify and resourcify methods on the same model class (specs by @amer)
+* added support for namespaced models (thanks to @intrica)
+* fixed compatibility issue with squeel when using symbols as role parameters (hint by @f3ndot)
+* now raises a warning in the initializer if migration has not been run
+* add support for primary key different than 'id' for resource Model (thanks to @rafaeldl)
+* Rails 4 (thanks to @adammathys) and ruby 2.0 compliant
+* configured travis-ci to run the specs on Rails 3.2/4.0 and Rubies 1.9.3/2.0/rbx/jruby
+* added code climate to check for code smell
+
+= 3.2 (Aug 7, 2012)
+* <b>DEPRECATION NOTICE:</b> Ruby 1.8 support dropped ! Mongoid 3.0 only supports MRI 1.9.3, and HEAD, and JRuby 1.6.0+ in 1.9 mode
+* removed <tt>dynamic_shortcuts</tt> arguments from the generator
+  * to use dynamic shortcuts feature when you're using ActiveRecord, you have to enable it _after_ running rake db:migrate as it relies on the roles table
+* support for Mongoid 3.x (thanks to @Leonas)
+* new class methods on the User class to find users depending on roles they have
+* added scopes to Role class to be able to fetch global, class scoped and instance scoped roles for a specific user
+* deletions of n-n relation are unreliable with Mongoid. Removing ids instead (thanks to @nfo)
+* <tt>has_role?</tt> method now supports new instance (i.e. record not saved in the database yet) (thanks to @demental)
+* added association callbacks <tt>(before|after)_add</tt>, <tt>(before|after)_remove</tt> on <tt>rolify</tt> method (thanks to @shekibobo)
+* added ability to pass an array of roles to <tt>Resource.with_role()</tt>, aliased by <tt>Resource.with_roles()</tt> (thanks to @lukes)
+* added option to have roles be destroyed by default if parent resource is destroyed (thanks to @treydock)
+* added new method <tt>only_has_role?</tt> to check if user has only a specific role (thanks to @jalcine)
+* better edge cases covering in the specs
+* fixed a bug regarding the loading order of the railtie when using Mongoid ORM and other gems using initializer files (thanks to @stigi)
+* fixed double quote syntax when using MySQL
+* fixed a nasty bug regarding class level queries (thanks to @kamrulhassan)
+* fixed uninitialized constant error in scopify method
+* documentation improvement
+
+= 3.1 (Apr 6, 2012)
+* Mongoid adapter optimization
+* adapter code refactoring
+* generator now adds the role class name to the rolify method injected in the user class
+* fixed a bug on the generator when using a 2 words Camel case for the Role class name
+* <b>DEPRECATION NOTICE:</b> <tt>has_role</tt> and <tt>has_no_role</tt> have been depecrated. They are replaced by <tt>add_role</tt> and <tt>remove_role</tt>
+* some internals cleanup (backward compatible)
+* stop requiring <tt>active_record</tt> in <tt>rolify.rb</tt> to prevent other gems ORM detection issue
+* fixed a bug when removing a role to the user using Mongoid adapter
+* added indexes to generator for mongoid (thanks to @stigi)
+* fixed a bug regarding **with_role** method on resource classes (thanks to @nfo)
+
+= 3.0 (Apr 2, 2012)
+* support for Mongoid
+* roles search on resources on instance level (e.g. <tt>Forum.first.roles</tt>) and class level (e.g. <tt>Forum.with_role("admin", user)</tt>)
+* heavy lifting and redesign of the library, code and specs refactoring
+* enhanced drastically specs coverage: 1001 examples !
+
+= 2.2.2 (Feb 17, 2012)
+* fixed another bug occurring when dynamic shortcuts is enabled
+* display now a README file after running the generator to show the next setup steps
+
+= 2.2.1 (Jan 24, 2012)
+* fixed a backward incompatible change introduced in Rails 3.2 release (<tt>find_or_create_by_* generated methods</tt>)
+
+= 2.2 (Jan 18, 2012)
+* fixed a bug in the initializer file regarding dynamic shortcuts 
+
+= 2.1 (Nov 30, 2011)
+* added syntactic sugar: <tt>grant</tt> and <tt>revoke</tt> are aliases for <tt>has_role</tt> and <tt>has_no_role</tt>
+* check if RUBY_ENGINE is defined in the gemspec to be able to use jdbc with JRuby for SQLite
+
+= 2.0 (Nov 10, 2011)
+* improved performance of <tt>has_all_roles?</tt> method using one single DB query instead of doing one DB lookup per argument
+  * significant speed-up when requesting with many arguments
+  * database choice can mitigate the results
+* clean up the initializer code
+  * using a DSL to configure the library
+  * setting defaults for User and Role classes
+  * dynamic shortcuts feature is now <b>disabled</b> by default. To turn it on:
+    * set it to true in the initializer file
+    * uncomment the <tt>extend Rolify::Dynamic</tt> line in the User class
+  * detecting if it's loaded by Rails::Server or Rails::Console
+* now also running on Rubinius, JRuby, REE and Ruby 1.8. all specs pass successfully, yeah !
+
+= 1.2 (Nov 4, 2011)
+* fixed a strange bug, probably rails related (thanks to @scottkf)
+  * when using rails in development mode, the <tt>config.cache_classes = false</tt> makes the role class to be loaded at every call and can lead to a <tt>AssociationTypeMismatch</tt>
+  * use of <tt>role_ids</tt> array instead of the <tt>roles</tt> association
+* now running on JRuby (<b>specs are still failing for JRuby though</b>)
+
+= 1.1 (Oct 14, 2011)
+* added a spec to test the rails generator using ammeter gem
+* Gemfile cleanup, moved all dependencies in gemspec instead
+* edited the dependency to Rails 3.1 and newer, now that Rails 3.1 has been released
+* new role scoping capabilities
+  * instance level : <tt>user.has_role "moderator", Forum.first</tt> (<em>already supported in previous release</em>). user has the moderator role only on that Forum in particular
+  * class level : <tt>user.has_role "moderator", Forum</tt>. User has the moderator role on all instances of Forum
+  * global level : <tt>user.has_role "moderator"</tt> (<em>already supported in previous release</em>). User has the moderator role globally (e.q. on all resources)
+* new scoped query capabilities
+  * <tt>user.has_role? "moderator", Forum.first</tt> (<em>already supported in previous release</em>). asks if the user has the moderator role on Forum.first instance
+  * <tt>user.has_role? "moderator", Forum</tt>. asks if the user has the moderator role on all Forum instances
+  * <tt>user.has_role? "moderator"</tt> (<em>already supported in previous release</em>). asks if the user has the global moderator role
+  * <tt>user.has_role? "moderator", :any</tt>. asks if the user has at least one moderator role no matter the scope is (instance, class or global).
+
+= 1.0 (Aug 25, 2011)
+* added a new parameter to disable dynamic shortcut methods due to potential incompatibility with other gems using method_missing with the same pattern
+  * add <tt>Rolify.dynamic_shortcuts = false</tt> in the initializer file or 
+  * use the generator command with a third parameter: 
+    * <tt>rails g rolify:role Role User false</tt>
+* removed the railtie as it created more problems than it solved
+* code refactoring to do some speed improvements and code clean up
+* added a lot of specs to improve tests coverage
+* wrote a tutorial showing how to use rolify with CanCan and Devise
+* rolify is now on travis-ci to monitor build status
+
+= 0.7 (June 20, 2011)
+* added a method_missing to catch newly created role outside the current ruby process (i.e. dynamic shortcut methods are not defined within this process) 
+  * dynamic shortcut is created on the fly in the method_missing to avoid extra method_missing for the same dynamic shortcut 
+  * check if the role actually exists in the database before defining the new method 
+  * first call is slower due to method_missing but next calls are fast
+  * avoid strange bugs when spawning many ruby processes as the dynamic shortcut methods were only defined in the process that used the <tt>has_role</tt> command
+
+= 0.6 (June 19, 2011)
+* custom User and Role class names support
+  * can now use other class names for Role and User classes
+  * fixed generators and templates 
+  * join table is explicitly set to avoid alphabetical order issue
+* created a new railtie to load the dynamic shortcuts at startup
+
+= 0.5.1 (June 07, 2011)
+* fixed a nasty typo on a variable name and added a spec to make it never happen again
+
+= 0.5 (June 07, 2011)
+* dynamic shortcuts support
+  * creates automatically new methods upon new role creation (or at startup for a Rails app)
+  * <tt>has_role "admin"</tt> will create a method called <tt>is_admin?</tt>
+  * <tt>has_role "moderator", Forum.first</tt> will create 2 methods:
+     * <tt>is_moderator_of?(resource)</tt>
+     * <tt>is_moderator?</tt>
+
+= v0.4 (June 07, 2011)
+* removing role support
+  * <tt>has_no_role</tt> removes a global role or a role scoped to a resource
+  * Please note that trying to remove a global role whereas the user a role with the same name on a resource will remove that scoped role
+  * Trying to remove a role scoped to a resource whereas the user has a global role won't remove it
+
+= v0.3 (June 06, 2011)
+* multiple roles check: 
+  * <tt>has_all_roles?</tt> returns true if the user has ALL the roles in arguments
+  * <tt>has_any_role?</tt> returns true if the user has ANY the roles in arguments
+
+= v0.2 (June 04, 2011)
+* fixed the generator to include the lib
+* fixed the migration file with missing polymorphic field
+* added some examples in documentation
+
+= v0.1 (June 04, 2011)
+* first release

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+case ENV["ADAPTER"]
+when nil, "active_record"
+  group :test do
+    gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.rc", :platform => "jruby"
+    gem "sqlite3", :platform => "ruby"
+  end
+  gem "activerecord", ">= 3.2.0", :require => "active_record"
+when "mongoid"
+  gem "mongoid", ">= 3.1"
+  gem "bson_ext", :platform => "ruby"
+else
+  raise "Unknown model adapter: #{ENV["ADAPTER"]}"
+end
+
+group :test do
+  gem 'coveralls', :require => false
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Florent Monbillard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,220 @@
+# rolify [![Gem Version](https://badge.fury.io/rb/rolify.png)](http://badge.fury.io/rb/rolify) [![build status](https://secure.travis-ci.org/EppO/rolify.png)](http://travis-ci.org/EppO/rolify) [![dependency status](https://gemnasium.com/EppO/rolify.png)](https://gemnasium.com/EppO/rolify) [![Code Climate](https://codeclimate.com/github/EppO/rolify.png)](https://codeclimate.com/github/EppO/rolify) [![Coverage Status](https://coveralls.io/repos/EppO/rolify/badge.png?branch=master)](https://coveralls.io/r/EppO/rolify)
+
+
+Very simple Roles library without any authorization enforcement supporting scope on resource object.
+
+Let's see an example: 
+
+```ruby
+user.has_role?(:moderator, Forum.first) 
+=> false # if user is moderator of another Forum
+```
+
+This library can be easily integrated with any authentication gem ([devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), [Clearance](https://github.com/thoughtbot/clearance)) and authorization gem<span style="color: red"><strong>*</strong></span> ([CanCan](https://github.com/ryanb/cancan), [authority](https://github.com/nathanl/authority))
+
+<span style="color: red"><strong>*</strong></span>: authorization gem that doesn't provide a role class
+
+## Requirements
+
+* Rails >= 3.2
+* ActiveRecord >= 3.2 <b>or</b> Mongoid >= 3.1
+* supports ruby 2.0/1.9.3, JRuby 1.6.0+ (in 1.9 mode) and Rubinius 2.0.0dev (in 1.9 mode)
+* support of ruby 1.8 has been dropped due to Mongoid >=3.0 that only supports 1.9 new hash syntax
+
+## Installation
+
+In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
+
+```ruby
+gem "rolify"
+```
+
+## Getting Started
+
+### 1. Generate Role Model
+
+First, create your Role model and migration file using this generator:
+
+```
+rails g rolify Role User
+```
+
+**NB** for versions of Rolify prior to 3.3, use:
+
+```
+rails g rolify:role Role User
+```
+
+Role and User classes are the default. You can specify any Role class name you want. This is completly a new file so any name can do the job.
+For the User class name, you would probably use the one provided by your authentication solution. rolify just adds some class methods in an existing User class.
+
+If you want to use Mongoid instead of ActiveRecord, just add `--orm=mongoid` argument, and skip to step #3
+
+### 2. Run the migration (only required when using ActiveRecord)
+
+Let's migrate !
+
+```
+rake db:migrate
+```
+
+### 3.1 Configure your user model
+
+This gem adds the `rolify` method to your User class. You can also specify optional callbacks on the User class for when roles are added or removed:
+
+```ruby
+class User < ActiveRecord::Base
+  rolify :before_add => :before_add_method
+
+  def before_add_method(role)
+    # do something before it gets added
+  end
+end
+```
+
+The `rolify` method accepts the following callback options:
+
+- `before_add`
+- `after_add`
+- `before_remove`
+- `after_remove`
+
+Mongoid callbacks are also supported and works the same way.
+
+### 3.2 Configure your resource models
+
+In the resource models you want to apply roles on, just add ``resourcify`` method.
+For example, on this ActiveRecord class:
+
+```ruby
+class Forum < ActiveRecord::Base
+  resourcify
+end
+```
+
+### 4. Add a role to a user
+
+To define a global role:
+
+```ruby
+user = User.find(1)
+user.add_role :admin
+```
+
+To define a role scoped to a resource instance
+
+```ruby
+user = User.find(2)
+user.add_role :moderator, Forum.first
+```
+
+To define a role scoped to a resource class
+
+```ruby
+user = User.find(3)
+user.add_role :moderator, Forum
+```
+
+That's it !
+
+### 5. Role queries
+
+To check if a user has a global role: 
+
+```ruby
+user = User.find(1)
+user.add_role :admin # sets a global role
+user.has_role? :admin
+=> true
+```
+
+To check if a user has a role scoped to a resource instance:
+
+```ruby
+user = User.find(2)
+user.add_role :moderator, Forum.first # sets a role scoped to a resource instance
+user.has_role? :moderator, Forum.first
+=> true
+user.has_role? :moderator, Forum.last
+=> false
+```
+
+To check if a user has a role scoped to a resource class:
+
+```ruby
+user = User.find(3)
+user.add_role :moderator, Forum # sets a role scoped to a resource class
+user.has_role? :moderator, Forum
+=> true
+user.has_role? :moderator, Forum.first
+=> true
+user.has_role? :moderator, Forum.last
+=> true
+```
+
+A global role overrides resource role request: 
+
+```ruby
+user = User.find(4)
+user.add_role :moderator # sets a global role
+user.has_role? :moderator, Forum.first
+=> true
+user.has_role? :moderator, Forum.last
+=> true
+```
+
+### 6. Resource roles querying 
+
+Starting from rolify 3.0, you can search roles on instance level or class level resources.
+
+#### Instance level
+
+```ruby
+forum = Forum.first
+forum.roles
+# => [ list of roles that are only binded to forum instance ]
+forum.applied_roles
+# => [ list of roles binded to forum instance and to the Forum class ]
+```
+
+#### Class level
+
+```ruby
+Forum.with_role(:admin)
+# => [ list of Forum instances that has role "admin" binded to it ] 
+Forum.with_role(:admin, current_user)
+# => [ list of Forum instances that has role "admin" binded to it and belongs to current_user roles ]
+
+User.with_any_role(:user, :admin)
+# => [ list of User instances that has role "admin" or "user" binded to it ]
+
+Forum.find_roles
+# => [ list of roles that binded to any Forum instance or to the Forum class ]
+Forum.find_roles(:admin)
+# => [ list of roles that binded to any Forum instance or to the Forum class with "admin" as a role name ]
+Forum.find_roles(:admin, current_user)
+# => [ list of roles that binded to any Forum instance or to the Forum class with "admin" as a role name and belongs to current_user roles ]
+```
+
+## Resources
+
+* [Wiki](https://github.com/EppO/rolify/wiki)
+* [Usage](https://github.com/EppO/rolify/wiki/Usage): all the available commands
+* [Tutorials](https://github.com/EppO/rolify/wiki#wiki-tutorials):  
+  * [How-To use rolify with Devise and CanCan](https://github.com/EppO/rolify/wiki/Tutorial)
+  * [Using rolify with Devise and Authority](https://github.com/EppO/rolify/wiki/Using-rolify-with-Devise-and-Authority)
+  * [Step-by-step tutorial](http://railsapps.github.com/tutorial-rails-bootstrap-devise-cancan.html) provided by [RailsApps](http://railsapps.github.com/)
+
+## Upgrade from previous versions
+
+Please read the [upgrade instructions](UPGRADE.rdoc).
+
+## Known issues
+
+If you are using Mongoid and/or less-rails gem, please read [this](https://github.com/EppO/rolify/wiki/FAQ#when-i-start-rails-using-server-console-whatever-i-get-this-error)
+
+## Questions or Problems?
+
+If you have any issue or feature request with/for rolify, please create an new [issue on GitHub](https://github.com/EppO/rolify/issues) **specifying the ruby runtime, rails and rolify versions you're using and the gems listed in your Gemfile**, or fork the project and send a pull request.
+
+To get the specs running you should call `bundle` and then `rake`. See the spec/README for more information.