rolify 3.2.0 → 3.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adb734bf9468069dbead78c35683ac1ace1525d8
+  data.tar.gz: b4a221f3435dda2c84ccccf7086bc4a41eadda8d
+SHA512:
+  metadata.gz: 7168a6699067f23cf85cb6b74b599a043e26720be10c9746e7910cc7cbdc296b5d9ffe5922ea2d8484167ccb3c9c6ce6c347efddb20c14c7d843791d0f186e52
+  data.tar.gz: 2f701c24d16d9dccbac72a270a93f9cd6e470dd60584c548812a97a09458b75f00829d5b0320ae3ab080d123c713c2c5ad32282b4c615b8ebf11e672dd576de9

data/.gitignore

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

data/.travis.yml

@@ -1,14 +1,17 @@
 rvm:
-    - 1.9.3
-    - ruby-head
-    - rbx-19mode
-    - jruby-19mode
+  - 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
+  - ADAPTER=active_record
+  - ADAPTER=mongoid
+
+services: mongodb
 
-before_install:
-  - gem update --system
-  - gem --version
-  - ruby -v
+before_script: rails --version

data/CHANGELOG.rdoc

@@ -1,3 +1,21 @@
+= 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

data/Gemfile

@@ -1,4 +1,21 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in rolify.gemspec
-gemspec
+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/README.md

@@ -1,4 +1,5 @@
-# rolify [![build status](https://secure.travis-ci.org/EppO/rolify.png?branch=master)](http://travis-ci.org/EppO/rolify) [![dependency status](https://gemnasium.com/EppO/rolify.png)](https://gemnasium.com/EppO/rolify)
+# 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.
 
@@ -9,27 +10,23 @@ user.has_role?(:moderator, Forum.first)
 => false # if user is moderator of another Forum
 ```
 
-This library was intended to be used with [CanCan](https://github.com/ryanb/cancan) and [devise](https://github.com/plataformatec/devise) but should be generic enough to be used by any other authentication/authorization solutions.
+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.1
-* ActiveRecord >= 3.1 <b>or</b> Mongoid >= 3.0
-* supports ruby 1.9, 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
+* 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"
-```
-
-Alternatively, you can install it as a plugin.
-
-```
-  rails plugin install git://github.com/EppO/rolify.git
+gem "rolify"
 ```
 
 ## Getting Started
@@ -39,44 +36,50 @@ Alternatively, you can install it as a plugin.
 First, create your Role model and migration file using this generator:
 
 ```
-  rails g rolify:role Role User
+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, follow these [instructions](https://github.com/EppO/rolify/wiki/Configuration), and skip to step #3
+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
+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 for when roles are added or removed:
+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
+class User < ActiveRecord::Base
+  rolify :before_add => :before_add_method
 
-    def :before_add_method(role)
-      # do something before it gets added
-    end
+  def before_add_method(role)
+    # do something before it gets added
   end
+end
 ```
 
-The `rolify` method accepts the following callback* options:
+The `rolify` method accepts the following callback options:
 
 - `before_add`
 - `after_add`
 - `before_remove`
 - `after_remove`
 
-*PLEASE NOTE: callbacks are currently only supported using ActiveRecord ORM. Mongoid will support association callbacks in its 3.1 release (Mongoid current version is 3.0.x)
+Mongoid callbacks are also supported and works the same way.
 
 ### 3.2 Configure your resource models
 
@@ -94,22 +97,22 @@ end
 To define a global role:
 
 ```ruby
-  user = User.find(1)
-  user.add_role :admin
+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
+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
+user = User.find(3)
+user.add_role :moderator, Forum
 ```
 
 That's it !
@@ -119,45 +122,45 @@ That's it !
 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
+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
+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
+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
+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 
@@ -167,36 +170,51 @@ Starting from rolify 3.0, you can search roles on instance level or class level
 #### 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 ]
+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 ]
-  
-  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 ]
+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
-* [Tutorial](https://github.com/EppO/rolify/wiki/Tutorial): how to use [rolify](http://eppo.github.com/rolify) with [Devise](https://github.com/plataformatec/devise) and [CanCan](https://github.com/ryanb/cancan).
-* [Amazing tutorial](http://railsapps.github.com/tutorial-rails-bootstrap-devise-cancan.html) provided by [RailsApps](http://railsapps.github.com/)
+* [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 add an [issue on GitHub](https://github.com/EppO/rolify/issues) or fork the project and send a pull request.
+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.

data/Rakefile

@@ -1,9 +1,34 @@
 require 'bundler'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
+Coveralls::RakeTask.new
+
+RSpec::Core::RakeTask.new(:generators) do |task|
+  task.pattern = "spec/generators/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:rolify) do |task|
+  task.pattern = "spec/rolify/**/*_spec.rb"
+end
+
+task :default => [ :spec, 'coveralls:push' ]
 
 desc "Run all specs"
 task "spec" do
-  exec "bundle exec rspec spec"
+  Rake::Task['generators'].invoke
+  return_code1 = $?.exitstatus
+  Rake::Task['rolify'].invoke
+  return_code2 = $?.exitstatus
+  fail if return_code1 != 0 || return_code2 != 0
 end
+
+desc "Run specs for all adapters"
+task :spec_all do
+  %w[active_record mongoid].each do |model_adapter|
+    puts "ADAPTER = #{model_adapter}"
+    system "ADAPTER=#{model_adapter} rake"
+  end
+end

data/UPGRADE.rdoc

@@ -20,3 +20,25 @@ If you use <i>dynamic methods</i> (<tt>user.is_admin?</tt> like methods), you sh
       c.use_dynamic_shortcuts
    end
 The old fashion way still works though, but won't work anymore if the setter method name is changed in a possible future. You've been warned :-)
+
+== From a rolify installation 3.x
+
+=== Dependencies: 
+
+Starting from 3.3 release, rolify supports Rails 3.2 and newer.
+
+Mongoid callbacks are supported if Mongoid 3.1 and newer is installed.
+
+=== Rails Generators
+
+Role model template when using Mongoid has been changed, you should re-run the generator.
+
+Rails generator has been renamed to: <tt>rails g rolify</tt> and arguments have been changed: 
+* Role class name is now mandatory, User class name remains optional and its default is still <tt>User</tt>
+* ORM optional argument is now <tt>-o</tt> or <tt>--orm=</tt>
+For instance, here is a new rolify generator command example: <tt>rails g rolify Role</tt>
+You can use <tt>rails g rolify --help</tt> to see all available options.
+
+=== Testing
+
+Starting from rolify 3.3, to run the specs you should run: <tt>rake spec</tt> or simply <tt>rake</tt>.

data/gemfiles/Gemfile.rails-3.2

@@ -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 :path => '../'

data/gemfiles/Gemfile.rails-4.0

@@ -0,0 +1,27 @@
+source "https://rubygems.org"
+
+case ENV["ADAPTER"]
+when nil, "active_record"
+  gem "activerecord", "~> 4.0.0.rc", :require => "active_record"
+when "mongoid"
+  gem "mongoid", :git => "git://github.com/mongoid/mongoid.git"
+  gem "bson_ext", :platform => "ruby"
+else
+  raise "Unknown model adapter: #{ENV["ADAPTER"]}"
+end
+
+group :test do
+  gem "rails", "~> 4.0.0.rc"
+  gem "ammeter"
+  gem "rake"
+  gem "rspec"
+  gem "rspec-rails"
+  gem "fuubar"
+  gem "bundler"
+  
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.0.beta", :platform => "jruby"
+  gem "sqlite3", :platform => "ruby"
+  gem "activerecord", "~> 4.0.0.rc", :require => "active_record"
+  gem "mongoid", :git => "git://github.com/mongoid/mongoid.git"
+  gem 'coveralls', :require => false
+end

data/lib/generators/active_record/rolify_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators/active_record'
+require 'active_support/core_ext'
+
+module ActiveRecord
+  module Generators
+    class RolifyGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      
+      argument :user_cname, :type => :string, :default => "User", :banner => "User"
+      
+      def generate_model
+        invoke "active_record:model", [ name ], :migration => false
+      end
+      
+      def inject_role_class
+        inject_into_class(model_path, class_name, model_content)
+      end
+      
+      def copy_rolify_migration
+        migration_template "migration.rb", "db/migrate/rolify_create_#{table_name}"
+      end
+      
+      def join_table
+        user_cname.constantize.table_name + "_" + table_name
+      end
+      
+      def user_reference
+        user_cname.demodulize.underscore
+      end
+      
+      def role_reference
+        class_name.demodulize.underscore
+      end
+      
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+      
+      def model_content
+        content = <<RUBY
+  has_and_belongs_to_many :%{user_cname}, :join_table => :%{join_table}
+  belongs_to :resource, :polymorphic => true
+  
+  scopify
+RUBY
+        content % { :user_cname => user_cname.constantize.table_name, :join_table => "#{user_cname.constantize.table_name}_#{table_name}"}
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/README

@@ -0,0 +1,8 @@
+Now, you just have to run the migration using rake command:
+
+   rake db:migrate
+
+and you will be able to add the resourcify method inside all models you want 
+scoped by a role.
+
+===============================================================================

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,19 @@
+class RolifyCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+      t.string :name
+      t.references :resource, :polymorphic => true
+
+      t.timestamps
+    end
+
+    create_table(:<%= join_table %>, :id => false) do |t|
+      t.references :<%= user_reference %>
+      t.references :<%= role_reference %>
+    end
+
+    add_index(:<%= table_name %>, :name)
+    add_index(:<%= table_name %>, [ :name, :resource_type, :resource_id ])
+    add_index(:<%= join_table %>, [ :<%= user_reference %>_id, :<%= role_reference %>_id ])
+  end
+end

data/lib/generators/mongoid/rolify_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators/mongoid_generator'
+require 'active_support/core_ext'
+
+module Mongoid
+  module Generators
+    class RolifyGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      
+      argument :user_cname, :type => :string, :default => "User", :banner => "User"
+      
+      def generate_model
+        invoke "mongoid:model", [ name ]
+      end
+      
+      def inject_role_class
+        inject_into_file(model_path, model_contents, :after => "include Mongoid::Document\n")
+      end
+      
+      def user_reference
+        user_cname.demodulize.underscore
+      end
+      
+      def role_reference
+        class_name.demodulize.underscore
+      end
+      
+      def model_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+      
+      def model_contents
+        content = <<RUBY
+  has_and_belongs_to_many :%{user_cname}
+  belongs_to :resource, :polymorphic => true
+  
+  field :name, :type => String
+
+  index({
+    :name => 1,
+    :resource_type => 1,
+    :resource_id => 1
+  },
+  { :unique => true})
+  
+  scopify
+RUBY
+        content % { :user_cname => user_cname.constantize.collection_name }
+      end
+    end
+  end
+end

data/lib/generators/mongoid/templates/README-mongoid

@@ -0,0 +1,4 @@
+Now, you are able to add the resourcify method inside all models you want 
+scoped by a role.
+
+===============================================================================

data/lib/generators/rolify/rolify_generator.rb

@@ -0,0 +1,35 @@
+module Rolify
+  module Generators
+    class RolifyGenerator < Rails::Generators::NamedBase
+      Rails::Generators::ResourceHelpers
+      
+      source_root File.expand_path('../templates', __FILE__)
+      argument :user_cname, :type => :string, :default => "User"
+
+      namespace :rolify
+      hook_for :orm, :required => true
+
+      desc "Generates a model with the given NAME and a migration file."
+
+      def self.start(args, config)
+        user_cname = args.size > 1 ? args[1] : "User"
+        args.insert(1, user_cname) # 0 being the view name
+        super
+      end
+      
+      def inject_user_class
+        invoke "rolify:user", [ user_cname, class_name ], :orm => options.orm
+      end
+        
+      def copy_initializer_file
+        template "initializer.rb", "config/initializers/rolify.rb"
+      end
+      
+      def show_readme
+        if behavior == :invoke
+          readme "README"
+        end
+      end
+    end
+  end
+end