rolify 0.2.1 → 0.3.0

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+# 0.3
+* multiple roles check: 
+  * ``has_all_roles?`` returns true if the user has ALL the roles in arguments
+  * ``has_any_role?`` returns true if the user has ANY the roles in arguments
+
+# 0.2
+* fixed the generator to include the lib
+* fixed the migration file with missing polymorphic field
+* added some examples in documentation
+
+# 0.1
+* first release

data/README.rdoc

@@ -57,27 +57,38 @@ That's it !
 
 === 4. Check roles
 
-To check if a user has a global role
+To check if a user has a global role: 
 
   user = User.find(1)
+  user.has_role "admin" # sets a global role
   user.has_role? "admin"
   => true
 
-To check if a user has a role scoped to a resource
+To check if a user has a role scoped to a resource:
 
   user = User.find(2)
+  user.has_role "moderator", Forum.first # sets a role scoped to a resource
   user.has_role? "moderator", Forum.first
   => true
   user.has_role? "moderator", Forum.last
   => false
 
+A global role overrides resource role request: 
+
+  user = User.find(3)
+  user.has_role "moderator" # sets a global role
+  user.has_role? "moderator", Forum.first
+  => true
+  user.has_role? "moderator", Forum.last
+  => true
+
 == Questions or Problems?
 
-If you have any issues with rolify which you cannot find the solution to in the tiny README[https://github.com/EppO/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.
 
 == TODO
 
 * put syntactic sugar:
-  * +is_admin?+ like shortcuts
+  * <tt>is_admin?</tt> and <tt>is_admin_of?(resource)</tt> like shortcuts
   * multiple role names query at the same time
 * write a tutorial showing how to use rolify with CanCan and devise

data/lib/rolify/role.rb

@@ -7,16 +7,56 @@ module Rolify
   end
   
   def has_role?(role, resource = nil)
-    global_role_query = "((name = ?) AND (resource_type IS NULL) AND (resource_id IS NULL))"
-    if resource
-      self.roles.where("#{global_role_query} OR ((name = ?) AND (resource_type = ?) AND (resource_id = ?))", 
-                        role, role, resource.class.name, resource.id).size > 0
-    else
-      self.roles.where(global_role_query, role).size > 0
+    query, values = build_query(role, resource)
+    self.roles.where(*query, *values).size > 0
+  end
+
+  def has_all_roles?(*args)
+    conditions = []
+    values = []
+    args.each do |arg|
+      if arg.is_a? Hash
+        return false if !self.has_role?(arg[:name], arg[:resource])
+      elsif arg.is_a? String
+        return false if !self.has_role?(arg)
+      else
+        raise ArgumentError, "Invalid argument type: only hash or string allowed"
+      end
     end
+    true
+  end
+
+  def has_any_role?(*args)
+    conditions = []
+    values = []
+    args.each do |arg|
+      if arg.is_a? Hash
+        a, v = build_query(arg[:name], arg[:resource])
+      elsif arg.is_a? String
+        a, v = build_query(arg)
+      else
+        raise ArgumentError, "Invalid argument type: only hash or string allowed"
+      end
+      conditions << a
+      values += v
+    end
+    self.roles.where([ conditions.join(' OR '), *values ]).size > 0
   end
   
   def roles_name
     self.roles.select(:name).map { |r| r.name }
   end
-end
+  
+  private
+  
+  def build_query(role, resource = nil)
+    query = "((name = ?) AND (resource_type IS NULL) AND (resource_id IS NULL))"
+    values = [ role ]
+    if resource
+      query.insert(0, "(")
+      query += " OR ((name = ?) AND (resource_type = ?) AND (resource_id = ?)))" 
+      values << role << resource.class.name << resource.id
+    end
+    [ [ query ], values]
+  end
+end

data/lib/rolify/version.rb

@@ -1,3 +1,3 @@
 module Rolify
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/rolify/role_spec.rb

@@ -1,11 +1,37 @@
 require "spec_helper"
 
-describe "Rolify::Role" do
+describe Rolify do
+  context "in a Instance level" do 
+    before(:all) do
+      @admin = User.first
+    end
+
+    it "should respond to has_role method" do 
+      @admin.should respond_to(:has_role).with(1).arguments
+      @admin.should respond_to(:has_role).with(2).arguments
+    end
+
+    it "should respond to has_role? method" do
+      @admin.should respond_to(:has_role?).with(1).arguments
+      @admin.should respond_to(:has_role?).with(2).arguments
+    end
+
+    it "should respond to has_all_roles? method" do
+      @admin.should respond_to(:has_all_roles?)
+      @admin.should respond_to(:has_all_roles?)
+    end
+
+    it "should respond to has_any_role? method" do
+      @admin.should respond_to(:has_any_role?)
+      @admin.should respond_to(:has_any_role?)
+    end
+  end
 
   context "with a global role" do 
     before(:all) do
       @admin = User.first
       @admin.has_role "admin"
+      @admin.has_role "staff"
     end
     
     it "should set a global role" do
@@ -41,16 +67,32 @@ describe "Rolify::Role" do
       @admin.has_role?("dummy").should be(false)
       @admin.has_role?("dumber", Forum.first).should be(false)
     end
+
+    it "should check if user has all of a global roles set" do
+      @admin.has_role?("staff").should be(true)
+      @admin.has_all_roles?("admin", "staff").should be(true)
+      @admin.has_all_roles?("admin", "dummy").should be(false)
+      @admin.has_all_roles?("dummy", "dumber").should be(false)
+    end
+
+    it "should check if user has any of a global roles set" do
+      @admin.has_any_role?("admin", "staff").should be(true)
+      @admin.has_any_role?("admin", "moderator").should be(true)
+      @admin.has_any_role?("dummy", "dumber").should be(false)
+    end
   end
   
   context "with a scoped role" do
     before(:all) do
-      @moderator = User.last
+      @moderator = User.find(2)
       @moderator.has_role "moderator", Forum.first
     end
       
     it "should set a scoped role" do
-      @moderator
+      expect { @moderator.has_role "visitor", Forum.last }.to change{ Role.count }.by(1)
+      supermodo = Role.last
+      supermodo.name.should eq("visitor")
+      supermodo.resource.should eq(Forum.last)
     end
     
     it "should not create another role if already existing" do
@@ -59,10 +101,7 @@ describe "Rolify::Role" do
     end
     
     it "should get a scoped role" do
-      expect { @moderator.has_role "supermodo", Forum.last }.to change{ Role.count }.by(1)
-      supermodo = Role.last
-      supermodo.name.should eq("supermodo")
-      supermodo.resource.should eq(Forum.last)
+      @moderator.has_role?("moderator", Forum.first).should be(true)
     end
     
     it "should not get a global role" do
@@ -83,5 +122,55 @@ describe "Rolify::Role" do
       @moderator.has_role?("dummy", Forum.last).should be(false)
       @moderator.has_role?("dumber").should be(false)
     end
+    
+    it "should check if user has all of a scoped roles set" do
+      @moderator.has_all_roles?({ :name => "moderator", :resource => Forum.first }, 
+                                { :name => "visitor", :resource => Forum.last }).should be(true)
+      @moderator.has_all_roles?({ :name => "moderator", :resource => Forum.first }, 
+                                { :name => "dummy", :resource => Forum.last }).should be(false)
+      @moderator.has_all_roles?({ :name => "dummy", :resource => Forum.first }, 
+                                { :name => "dumber", :resource => Forum.last }).should be(false)
+    end
+
+    it "should check if user has any of a scoped roles set" do
+      @moderator.has_any_role?( { :name => "moderator", :resource => Forum.first }, 
+                                { :name => "visitor", :resource => Forum.last }).should be(true)
+      @moderator.has_any_role?( { :name => "moderator", :resource => Forum.first }, 
+                                { :name => "dummy", :resource => Forum.last }).should be(true)
+      @moderator.has_any_role?( { :name => "dummy", :resource => Forum.first }, 
+                                { :name => "dumber", :resource => Forum.last }).should be(false)
+    end
+  end
+  
+  context "with different roles" do 
+    before(:all) do 
+      @user = User.last
+      @user.has_role "admin"
+      @user.has_role "moderator", Forum.first
+      @user.has_role "visitor", Forum.last
+      @user.has_role "anonymous"
+    end
+    
+    it "should get a global role" do
+      @user.has_role?("admin").should be(true)
+      @user.has_role?("anonymous").should be(true)
+    end
+    
+    it "should get a scoped role" do
+      @user.has_role?("moderator", Forum.first).should be(true)
+      @user.has_role?("visitor", Forum.last).should be(true)
+    end
+    
+    it "should check if user has all of a mix of global and scoped roles set" do
+      @user.has_all_roles?("admin", { :name => "moderator", :resource => Forum.first }).should be(true)
+      @user.has_all_roles?("admin", { :name => "moderator", :resource => Forum.last }).should be(false)
+      @user.has_all_roles?("dummy", { :name => "dumber", :resource => Forum.last }).should be(false)
+    end
+
+    it "should check if user has any of a mix of global and scoped roles set" do
+      @user.has_any_role?("admin", { :name => "moderator", :resource => Forum.first }).should be(true)
+      @user.has_any_role?("admin", { :name => "moderator", :resource => Forum.last }).should be(true)
+      @user.has_any_role?("dummy", { :name => "dumber", :resource => Forum.last }).should be(false)
+    end
   end
-end
+end

data/spec/support/data.rb

@@ -1,5 +1,6 @@
 User.create(:login => "admin")
 User.create(:login => "moderator")
+User.create(:login => "god")
 Forum.create(:name => "forum 1")
 Forum.create(:name => "forum 2")
 Forum.create(:name => "forum 3")

metadata

@@ -2,7 +2,7 @@
 name: rolify
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Florent Monbillard
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 -04:00
+date: 2011-06-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.rdoc
 - Gemfile
 - LICENSE
 - README.rdoc