rolify 3.2.0 → 3.3.0.rc1

data/.travis.yml

@@ -12,3 +12,5 @@ before_install:
   - gem update --system
   - gem --version
   - ruby -v
+  
+services: mongodb

data/README.md

@@ -1,4 +1,4 @@
-# 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?branch=master)](http://travis-ci.org/EppO/rolify) [![dependency status](https://gemnasium.com/EppO/rolify.png)](https://gemnasium.com/EppO/rolify) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/EppO/rolify)
 
 Very simple Roles library without any authorization enforcement supporting scope on resource object.
 
@@ -9,7 +9,9 @@ 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
 
@@ -194,9 +196,11 @@ Starting from rolify 3.0, you can search roles on instance level or class level
 
 * [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/)
 
 ## 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 add an [issue on GitHub](https://github.com/EppO/rolify/issues) or fork the project and send a pull request.

data/lib/generators/rolify/role/role_generator.rb

@@ -34,7 +34,10 @@ module Rolify
       end
       
       def show_readme
-        readme "README-#{orm_adapter}" if behavior == :invoke
+        if behavior == :invoke
+          readme "README"
+          readme "README-#{orm_adapter}"
+        end
       end
       
       def inject_rolify_method

data/lib/generators/rolify/role/templates/README

@@ -1,11 +1,13 @@
 ===============================================================================
 
-Now, you just have to run the migration using rake command:
+An initializer file has been created here: config/initializers/rolify.rb, you 
+can change rolify settings to match your needs. 
+Defaults values are commented out.
 
-   rake db:migrate
+A Role class has been been created in app/models (with the name you gave as 
+argument otherwise the default is role.rb), you can add your own business logic 
+inside.
 
-An initializer file has been created here: config/initializers/rolify.rb, 
-you can change rolify settings to match your needs. 
-Defaults values are commented out.
+Inside your User class (or the name you gave as argument otherwise the default 
+is user.rb), rolify method has been inserted to provide rolify methods.
 
-===============================================================================

data/lib/generators/rolify/role/templates/README-active_record

@@ -1,21 +1,8 @@
-===============================================================================
-
-An initializer file has been created here: config/initializers/rolify.rb, you 
-can change rolify settings to match your needs. 
-Defaults values are commented out.
-
-A Role class has been been created in app/models (with the name you gave as 
-argument otherwise the default is role.rb), you can add your own business logic 
-inside.
-
-Inside your User class (or the name you gave as argument otherwise the default 
-is user.rb), rolify method has been inserted to provide rolify methods.
-
-Now, if you just have to run the migration using rake command:
+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/rolify/role/templates/README-mongoid

@@ -1,17 +1,4 @@
-===============================================================================
-
-An initializer file has been created here: config/initializers/rolify.rb, you 
-can change rolify settings to match your needs. 
-Defaults values are commented out.
-
-A Role class has been been created in app/models (with the name you gave as 
-argument otherwise the default is role.rb), you can add your own business logic 
-inside.
-
-Inside your User class (or the name you gave as argument otherwise the default 
-is user.rb), rolify method has been inserted to provide rolify methods.
-
-Now, if you are able to add the resourcify method inside all models you want 
+Now, you are able to add the resourcify method inside all models you want 
 scoped by a role.
 
-===============================================================================
+===============================================================================

data/lib/generators/rolify/role/templates/role-mongoid.rb

@@ -5,8 +5,6 @@ class <%= role_cname.camelize %>
   belongs_to :resource, :polymorphic => true
   
   field :name, :type => String
-  index({ :name => 1 }, { :unique => true })
-
 
   index({
     :name => 1,

data/lib/rolify.rb

@@ -9,35 +9,38 @@ require 'rolify/adapters/base'
 module Rolify
   extend Configure
 
-  attr_accessor :role_cname, :adapter
+  attr_accessor :role_cname, :adapter, :role_table_name
 
   def rolify(options = {})
     include Role
     extend Dynamic if Rolify.dynamic_shortcuts
     
     options.reverse_merge!({:role_cname => 'Role'})
+    self.role_cname = options[:role_cname]
+    self.role_table_name = self.role_cname.tableize.gsub(/\//, "_")
 
+    join_table = "#{self.to_s.tableize.gsub(/\//, "_")}_#{self.role_table_name}"
     rolify_options = { :class_name => options[:role_cname].camelize }
-    rolify_options.merge!({ :join_table => "#{self.to_s.tableize}_#{options[:role_cname].tableize}" }) if Rolify.orm == "active_record"
-    rolify_options.merge!(options.select{ |k,v| [:before_add, :after_add, :before_remove, :after_remove].include? k.to_sym }) if Rolify.orm == "active_record"
+    rolify_options.merge!({ :join_table => join_table }) if Rolify.orm == "active_record"
+    rolify_options.merge!(options.reject{ |k,v| ![:before_add, :after_add, :before_remove, :after_remove].include? k.to_sym }) if Rolify.orm == "active_record"
 
     has_and_belongs_to_many :roles, rolify_options
 
-    self.adapter = Rolify::Adapter::Base.create("role_adapter", options[:role_cname], self.name)
-    self.role_cname = options[:role_cname]
-    
+    self.adapter = Rolify::Adapter::Base.create("role_adapter", self.role_cname, self.name)
     load_dynamic_methods if Rolify.dynamic_shortcuts
   end
 
-  def resourcify(options = {})
+  def resourcify(association_name = :roles, options = {})
     include Resource
     
     options.reverse_merge!({ :role_cname => 'Role', :dependent => :destroy })
     resourcify_options = { :class_name => options[:role_cname].camelize, :as => :resource, :dependent => options[:dependent] }
-    has_many :roles, resourcify_options
-    
-    self.adapter = Rolify::Adapter::Base.create("resource_adapter", options[:role_cname], self.name)
     self.role_cname = options[:role_cname]
+    self.role_table_name = self.role_cname.tableize.gsub(/\//, "_")
+
+    has_many association_name, resourcify_options
+    
+    self.adapter = Rolify::Adapter::Base.create("resource_adapter", self.role_cname, self.name)
   end
   
   def scopify

data/lib/rolify/adapters/active_record/resource_adapter.rb

@@ -12,7 +12,7 @@ module Rolify
 
       def in(relation, user, role_names)
         roles = user.roles.where(:name => role_names)
-        relation.where("#{quote(role_class.to_s.tableize)}.id IN (?) AND ((resource_id = #{quote(relation.table_name)}.id) OR (resource_id IS NULL))", roles)
+        relation.where("#{quote(role_class.table_name)}.id IN (?) AND ((resource_id = #{quote(relation.table_name)}.id) OR (resource_id IS NULL))", roles)
       end
       
       private

data/lib/rolify/adapters/active_record/role_adapter.rb

@@ -17,13 +17,14 @@ module Rolify
       end
 
       def remove(relation, role_name, resource = nil)
-        roles = relation.roles.where(:name => role_name)
-        roles = roles.where(:resource_type => (resource.is_a?(Class) ? resource.to_s : resource.class.name)) if resource
-        roles = roles.where(:resource_id => resource.id) if resource && !resource.is_a?(Class)
+        cond = { :name => role_name }
+        cond[:resource_type] = (resource.is_a?(Class) ? resource.to_s : resource.class.name) if resource
+        cond[:resource_id] = resource.id if resource && !resource.is_a?(Class)
+        roles = relation.roles.where(cond)
         if roles
           relation.roles.delete(roles)
           roles.each do |role| 
-            role.destroy if role.send(user_class.table_name.to_sym).empty? 
+            role.destroy if role.send(ActiveSupport::Inflector.demodulize(user_class).tableize.to_sym).empty? 
           end
         end
         roles

data/lib/rolify/adapters/base.rb

@@ -15,7 +15,7 @@ module Rolify
       end
       
       def role_table
-        @role_cname.tableize
+        role_class.table_name
       end
       
       def self.create(adapter, role_cname, user_cname)

data/lib/rolify/adapters/mongoid/resource_adapter.rb

@@ -1,7 +1,7 @@
 require 'rolify/adapters/base'
 
 module Rolify
-  module Adapter  
+  module Adapter
     class ResourceAdapter < ResourceAdapterBase
       def resources_find(roles_table, relation, role_name)
         roles = roles_table.classify.constantize.where(:name.in => Array(role_name), :resource_type => relation.to_s)
@@ -13,7 +13,7 @@ module Rolify
             resources << role.resource
           end
         end
-        resources.uniq
+        resources.compact.uniq
       end
 
       def in(resources, user, role_names)

data/lib/rolify/adapters/mongoid/role_adapter.rb

@@ -19,20 +19,30 @@ module Rolify
       end
 
       def remove(relation, role_name, resource = nil)
-        roles = { :name => role_name }
-        roles.merge!({:resource_type => (resource.is_a?(Class) ? resource.to_s : resource.class.name)}) if resource
-        roles.merge!({ :resource_id => resource.id }) if resource && !resource.is_a?(Class)
-        roles_to_remove = relation.roles.where(roles)
-        roles_to_remove.each do |role|
-          # Deletion in n-n relations is unreliable. Sometimes it works, sometimes not. 
-          # So, this does not work all the time: `relation.roles.delete(role)`
-          # @see http://stackoverflow.com/questions/9132596/rails3-mongoid-many-to-many-relation-and-delete-operation
-          # We instead remove ids from the Role object and the relation object.
-          relation.role_ids.delete(role.id)
-          role.send((user_class.to_s.underscore + '_ids').to_sym).delete(relation.id)
-
-          role.destroy if role.send(user_class.to_s.tableize.to_sym).empty?
-        end
+        #roles = { :name => role_name }
+        #roles.merge!({:resource_type => (resource.is_a?(Class) ? resource.to_s : resource.class.name)}) if resource
+        #roles.merge!({ :resource_id => resource.id }) if resource && !resource.is_a?(Class)
+        #roles_to_remove = relation.roles.where(roles)
+        #roles_to_remove.each do |role|
+        #  # Deletion in n-n relations is unreliable. Sometimes it works, sometimes not. 
+        #  # So, this does not work all the time: `relation.roles.delete(role)`
+        #  # @see http://stackoverflow.com/questions/9132596/rails3-mongoid-many-to-many-relation-and-delete-operation
+        #  # We instead remove ids from the Role object and the relation object.
+        #  relation.role_ids.delete(role.id)
+        #  role.send((user_class.to_s.underscore + '_ids').to_sym).delete(relation.id)
+        #
+        #  role.destroy if role.send(user_class.to_s.tableize.to_sym).empty?
+        #end
+        cond = { :name => role_name }
+        cond[:resource_type] = (resource.is_a?(Class) ? resource.to_s : resource.class.name) if resource
+        cond[:resource_id] = resource.id if resource && !resource.is_a?(Class)
+        roles = relation.roles.where(cond)
+        roles.each do |role| 
+          relation.roles.delete(role)
+          role.send(ActiveSupport::Inflector.demodulize(user_class).tableize.to_sym).delete(relation)
+          role.destroy if role.send(ActiveSupport::Inflector.demodulize(user_class).tableize.to_sym).empty? 
+        end if roles
+        roles
       end
 
       def exists?(relation, column)

data/lib/rolify/finders.rb

@@ -6,14 +6,7 @@ module Rolify
 
     def with_all_roles(*args)
       users = []
-      args.each do |arg|
-        if arg.is_a? Hash
-          users_to_add = self.with_role(arg[:name], arg[:resource])
-        elsif arg.is_a?(String) || arg.is_a?(Symbol)
-          users_to_add = self.with_role(arg)
-        else
-          raise ArgumentError, "Invalid argument type: only hash or string or symbol allowed"
-        end
+      parse_args(args, users) do |users_to_add|
         users = users_to_add if users.empty?
         users &= users_to_add
         return [] if users.empty?
@@ -23,17 +16,25 @@ module Rolify
 
     def with_any_role(*args)
       users = []
-      args.each do |arg|
-        if arg.is_a? Hash
-          users_to_add = self.with_role(arg[:name], arg[:resource])
-        elsif arg.is_a?(String) || arg.is_a?(Symbol)
-          users_to_add = self.with_role(arg)
-        else
-          raise ArgumentError, "Invalid argument type: only hash or string or symbol allowed"
-        end
+      parse_args(args, users) do |users_to_add|
         users += users_to_add
       end
       users.uniq
     end
   end
+  
+  private
+  
+  def parse_args(args, users, &block)
+    args.each do |arg|
+      if arg.is_a? Hash
+        users_to_add = self.with_role(arg[:name], arg[:resource])
+      elsif arg.is_a?(String) || arg.is_a?(Symbol)
+        users_to_add = self.with_role(arg)
+      else
+        raise ArgumentError, "Invalid argument type: only hash or string or symbol allowed"
+      end
+      block.call(users_to_add)
+    end
+  end
 end

data/lib/rolify/matchers.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :have_role do |*args|
+  match do |resource|
+    resource.has_role?(*args)
+  end
+
+  failure_message_for_should do |resource|
+    "expected to have role #{args.map(&:inspect).join(" ")}"
+  end
+
+  failure_message_for_should_not do |resource|
+    "expected not to have role #{args.map(&:inspect).join(" ")}"
+  end
+end

data/lib/rolify/resource.rb

@@ -13,7 +13,7 @@ module Rolify
       end
 
       def with_role(role_name, user = nil)
-        resources = self.adapter.resources_find(self.role_class.to_s.tableize, self, role_name)
+        resources = self.adapter.resources_find(self.role_table_name, self, role_name)
         user ? self.adapter.in(resources, user, role_name) : resources
       end
       alias :with_roles :with_role

data/lib/rolify/version.rb

@@ -1,3 +1,3 @@
 module Rolify
-  VERSION = "3.2.0"
+  VERSION = "3.3.0.rc1"
 end

data/spec/generators/rolify/role/role_generator_spec.rb

@@ -136,7 +136,6 @@ CLASS
       it { should contain "has_and_belongs_to_many :users\n" }
       it { should contain "belongs_to :resource, :polymorphic => true" }
       it { should contain "field :name, :type => String" }
-      it { should contain "index({ :name => 1 }, { :unique => true })" }
       it { should contain "  index({\n"
                           "      { :name => 1 },\n"
                           "      { :resource_type => 1 },\n"

data/spec/rolify/custom_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "rolify/shared_examples/shared_examples_for_roles"
 require "rolify/shared_examples/shared_examples_for_dynamic"
 require "rolify/shared_examples/shared_examples_for_scopes"
-require "rolify/shared_examples/shared_examples_for_callbacks"  
+require "rolify/shared_examples/shared_examples_for_callbacks"
 
 describe "Using Rolify with custom User and Role class names" do
   it_behaves_like Rolify::Role do

data/spec/rolify/matchers_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'have_role', focus: true do
+  let(:object) { Object.new }
+
+  it 'delegates to has_role?' do
+    object.should_receive(:has_role?).with(:read, 'Resource') { true }
+    object.should have_role(:read, 'Resource')
+  end
+
+  it 'reports a nice failure message for should' do
+    object.should_receive(:has_role?) { false }
+    expect{
+      object.should have_role(:read, 'Resource')
+    }.to raise_error('expected to have role :read "Resource"')
+  end
+
+  it 'reports a nice failure message for should_not' do
+    object.should_receive(:has_role?) { true }
+    expect{
+      object.should_not have_role(:read, 'Resource')
+    }.to raise_error('expected not to have role :read "Resource"')
+  end
+end

data/spec/rolify/namespace_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "rolify/shared_examples/shared_examples_for_roles"
+require "rolify/shared_examples/shared_examples_for_dynamic"
+require "rolify/shared_examples/shared_examples_for_scopes"
+require "rolify/shared_examples/shared_examples_for_callbacks"
+
+describe "Rolify.namespace" do
+  it_behaves_like Rolify::Role do
+    let(:user_class) { Admin::Moderator } 
+    let(:role_class) { Admin::Right }
+  end
+
+  it_behaves_like "Role.scopes" do
+    let(:user_class) { Admin::Moderator } 
+    let(:role_class) { Admin::Right }
+  end
+
+  it_behaves_like Rolify::Dynamic do
+    let(:user_class) { Admin::Moderator } 
+    let(:role_class) { Admin::Right }
+  end
+
+  it_behaves_like "Rolify.callbacks" do
+    let(:user_class) { Admin::Moderator } 
+    let(:role_class) { Admin::Right }
+  end
+end

data/spec/rolify/resource_spec.rb

@@ -3,16 +3,16 @@ require "spec_helper"
 describe Rolify::Resource do
   before(:all) do
     reset_defaults
-    User.rolify :role_cname => "Role"
-    Forum.resourcify :role_cname => "Role"
-    Group.resourcify :role_cname => "Role"
+    User.rolify
+    Forum.resourcify
+    Group.resourcify
     Role.destroy_all
   end
 
   # Users
   let(:admin)   { User.first }
   let(:tourist) { User.last }
-  
+
   # roles
   let!(:forum_role)      { admin.add_role(:forum, Forum.first) }
   let!(:godfather_role)  { admin.add_role(:godfather, Forum) }
@@ -27,19 +27,19 @@ describe Rolify::Resource do
     it { should respond_to(:find_roles).with(1).arguments }
     it { should respond_to(:find_roles).with(2).arguments }
 
-    context "with a role name as argument" do 
-      context "on the Forum class" do 
+    context "with a role name as argument" do
+      context "on the Forum class" do
         subject { Forum }
 
-        it "should include Forum instances with forum role" do 
+        it "should include Forum instances with forum role" do
           subject.with_role(:forum).should =~ [ Forum.first, Forum.last ]
         end
-        it "should include Forum instances with godfather role" do 
+        it "should include Forum instances with godfather role" do
           subject.with_role(:godfather).should =~ Forum.all.to_a
         end
       end
 
-      context "on the Group class" do 
+      context "on the Group class" do
         subject { Group }
 
         it "should include Group instances with group role" do
@@ -47,20 +47,27 @@ describe Rolify::Resource do
         end
       end
 
+      context "on a Group instance" do
+        subject { Group.last }
+
+        it "should ignore nil entries" do
+          subject.subgroups.with_role(:group).should =~ [ ]
+        end
+      end
     end
 
-    context "with an array of role names as argument" do 
-      context "on the Group class" do 
+    context "with an array of role names as argument" do
+      context "on the Group class" do
         subject { Group }
-        
-        it "should include Group instances with both group and grouper roles" do 
+
+        it "should include Group instances with both group and grouper roles" do
           subject.with_roles([:group, :grouper]).should =~ [ Group.first, Group.last ]
         end
       end
     end
 
     context "with a role name and a user as arguments" do
-      context "on the Forum class" do 
+      context "on the Forum class" do
         subject { Forum }
 
         it "should get all Forum instances binded to the forum role and the admin user" do
@@ -88,7 +95,7 @@ describe Rolify::Resource do
         end
       end
 
-      context "on the Group class" do 
+      context "on the Group class" do
         subject { Group }
 
         it "should get all resources binded to the group role and the admin user" do
@@ -102,7 +109,7 @@ describe Rolify::Resource do
     end
 
     context "with an array of role names and a user as arguments" do
-      context "on the Forum class" do 
+      context "on the Forum class" do
         subject { Forum }
 
         it "should get Forum instances binded to the forum and group roles and the tourist user" do
@@ -111,7 +118,7 @@ describe Rolify::Resource do
 
       end
 
-      context "on the Group class" do 
+      context "on the Group class" do
         subject { Group }
 
         it "should get Group instances binded to the group and grouper roles and the admin user" do
@@ -125,8 +132,8 @@ describe Rolify::Resource do
 
   describe ".find_role" do
 
-    context "without using a role name parameter" do 
-      
+    context "without using a role name parameter" do
+
       context "on the Forum class" do
         subject { Forum }
 
@@ -151,7 +158,7 @@ describe Rolify::Resource do
 
       context "on the Group class" do
         subject { Group }
-        
+
         it "should get all roles binded to a Group class or instance" do
           subject.find_roles.to_a.should =~ [ group_role, grouper_role ]
         end
@@ -172,7 +179,7 @@ describe Rolify::Resource do
       end
     end
 
-    context "using a role name parameter" do 
+    context "using a role name parameter" do
       context "on the Forum class" do
         subject { Forum }
 
@@ -209,7 +216,7 @@ describe Rolify::Resource do
 
       context "on the Group class" do
         subject { Group }
-        
+
         context "without using a user parameter" do
           it "should get all roles binded to a Group class or instance and group role name" do
             subject.find_roles(:group).should include(group_role)
@@ -242,7 +249,7 @@ describe Rolify::Resource do
       end
     end
 
-    context "using :any as role name parameter" do 
+    context "using :any as role name parameter" do
       context "on the Forum class" do
         subject { Forum }
 
@@ -318,7 +325,7 @@ describe Rolify::Resource do
 
     it { should respond_to :roles }
 
-    context "on a Forum instance" do 
+    context "on a Forum instance" do
       its(:roles) { should eq([ forum_role, sneaky_role ]) }
       its(:roles) { subject.should_not include(group_role, godfather_role, tourist_role) }
     end
@@ -326,19 +333,19 @@ describe Rolify::Resource do
     context "on a Group instance" do
       subject { Group.last }
 
-      its(:roles) { should eq([ group_role ]) } 
+      its(:roles) { should eq([ group_role ]) }
       its(:roles) { should_not include(forum_role, godfather_role, sneaky_role, tourist_role) }
-      
+
       context "when deleting a Group instance" do
-        subject do 
+        subject do
           Group.create(:name => "to delete")
         end
-        
+
         before do
           subject.roles.create :name => "group_role1"
           subject.roles.create :name => "group_role2"
         end
-        
+
         it "should remove the roles binded to this instance" do
           expect { subject.destroy }.to change { Role.count }.by(-2)
         end