rolify 3.0.0 → 3.1.0

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

@@ -0,0 +1,23 @@
+require 'rolify/adapters/base'
+
+module Rolify
+  module Adapter  
+    class ResourceAdapter < ResourceAdapterBase
+      def resources_find(roles_table, relation, role_name)
+        roles = roles_table.classify.constantize.where(:name => role_name, :resource_type => relation.to_s)
+        resources = []
+        roles.each do |role|
+          return relation.all if role.resource_id.nil?
+          resources << role.resource
+        end
+        resources
+      end
+
+      def in(resources, roles)
+        return [] if resources.empty? || roles.empty?
+        resources.delete_if { |resource| (resource.applied_roles & roles).empty? }
+        resources
+      end
+    end
+  end
+end

data/lib/rolify/adapters/{mongoid.rb → mongoid/role_adapter.rb}

@@ -1,18 +1,9 @@
 require 'rolify/adapters/base'
 
 module Rolify
-  module Adapter  
-    class Mongoid < Adapter::Base
-      def find(relation, role_name, resource)
-        query = build_query(role_name, resource)
-        query.each do |condition|
-          criteria = relation.where(condition)
-          return criteria.all if !criteria.empty?
-        end
-        []
-      end
-
-      def where(relation, args)
+  module Adapter
+    class RoleAdapter < RoleAdapterBase
+      def where(relation, *args)
         conditions = build_conditions(relation, args)
         relation.any_of(*conditions)
       end
@@ -28,26 +19,15 @@ module Rolify
       end
 
       def remove(relation, role_name, resource = nil)
-        role = { :name => role_name }
-        role.merge!({:resource_type => (resource.is_a?(Class) ? resource.to_s : resource.class.name)}) if resource
-        role.merge!({ :resource_id => resource.id }) if resource && !resource.is_a?(Class)
-        relation.where(role).destroy_all
-      end
-
-      def resources_find(roles_table, relation, role_name)
-        roles = roles_table.classify.constantize.where(:name => role_name, :resource_type => relation.to_s)
-        resources = []
-        roles.each do |role|
-          return relation.all if role.resource_id.nil?
-          resources << role.resource
+        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|
+          relation.roles.delete(role)
+          role.reload
+          role.destroy if role.send(user_class.to_s.tableize.to_sym).empty?
         end
-        resources
-      end
-
-      def in(resources, roles)
-        return [] if resources.empty? || roles.empty?
-        resources.delete_if { |resource| (resource.applied_roles && roles).empty? }
-        resources
       end
 
       def exists?(relation, column)

data/lib/rolify/configure.rb

@@ -8,7 +8,7 @@ module Rolify
     end
 
     def dynamic_shortcuts
-      @@dynamic_shortcuts || false
+      @@dynamic_shortcuts
     end
 
     def dynamic_shortcuts=(is_dynamic)
@@ -32,9 +32,10 @@ module Rolify
     end
 
     def use_defaults
-      @@dynamic_shortcuts = false
-      @@orm = "active_record"
-      @@adapter = Rolify::Adapter::ActiveRecord.new("Role")
+      configure do |config|
+        config.dynamic_shortcuts = false
+        config.orm = "active_record"
+      end
     end
   end
 end

data/lib/rolify/dynamic.rb

@@ -14,7 +14,7 @@ module Rolify
 
         define_method("is_#{role_name}_of?".to_sym) do |arg|
           has_role?("#{role_name}", arg)
-        end if !method_defined?("is_#{role_name}_of?".to_sym) && !!resource
+        end if !method_defined?("is_#{role_name}_of?".to_sym) && resource
       end
     end
   end

data/lib/rolify/role.rb

@@ -1,6 +1,8 @@
 module Rolify
   module Role
-    def has_role(role_name, resource = nil)
+    extend Utils
+    
+    def add_role(role_name, resource = nil)
       role = self.class.adapter.find_or_create_by(role_name, 
                                                   (resource.is_a?(Class) ? resource.to_s : resource.class.name if resource), 
                                                   (resource.id if resource && !resource.is_a?(Class)))
@@ -11,10 +13,11 @@ module Rolify
       end
       role
     end
-    alias_method :grant, :has_role
+    alias_method :grant, :add_role
+    deprecate :has_role, :add_role
 
     def has_role?(role_name, resource = nil)
-      self.class.adapter.find(self.roles, role_name, resource).size > 0
+      self.class.adapter.where(self.roles, :name => role_name, :resource => resource).size > 0
     end
 
     def has_all_roles?(*args)
@@ -31,13 +34,14 @@ module Rolify
     end
 
     def has_any_role?(*args)
-      self.class.adapter.where(self.roles, args).size > 0
+      self.class.adapter.where(self.roles, *args).size > 0
     end
 
-    def has_no_role(role_name, resource = nil)
-      self.class.adapter.remove(self.roles, role_name, resource)
+    def remove_role(role_name, resource = nil)
+      self.class.adapter.remove(self, role_name, resource)
     end
-    alias_method :revoke, :has_no_role
+    alias_method :revoke, :remove_role
+    deprecate :has_no_role, :remove_role
 
     def roles_name
       self.roles.select(:name).map { |r| r.name }

data/lib/rolify/utils.rb

@@ -0,0 +1,10 @@
+module Rolify
+  module Utils
+    def deprecate(old_method, new_method)
+      define_method(old_method) do |*args|
+        warn "[DEPRECATION] #{caller.first}: `#{old_method}` is deprecated.  Please use `#{new_method}` instead."
+        send(new_method, *args)
+      end
+    end
+  end
+end

data/lib/rolify/version.rb

@@ -1,3 +1,3 @@
 module Rolify
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/rolify.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["f.monbillard@gmail.com"]
   s.homepage    = "https://github.com/EppO/rolify"
   s.summary     = %q{Roles library with resource scoping}
-  s.description = %q{Very simple Roles library without any authorization enforcement (built to use with cancan) supporting scope on resource: user.is_moderator?(Forum.first) => # return false if user is moderator of another Forum }
+  s.description = %q{Very simple Roles library without any authorization enforcement supporting scope on resource objects (instance or class)}
 
   s.rubyforge_project = s.name
 

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

@@ -31,7 +31,9 @@ describe Rolify::Generators::RoleGenerator do
     describe 'config/initializers/rolify.rb' do
       subject { file('config/initializers/rolify.rb') }
       it { should exist }
-      it { should contain "# c.use_dynamic_shortcuts" }
+      it { should contain "Rolify.configure do |config|"}
+      it { should contain "# config.use_dynamic_shortcuts" }
+      it { should contain "# config.use_mongoid" }
     end
     
     describe 'app/models/role.rb' do
@@ -48,20 +50,21 @@ describe Rolify::Generators::RoleGenerator do
     end
     
     describe 'migration file' do
-      subject { file('db/migrate/rolify_create_roles.rb') }
+      subject { migration_file('db/migrate/rolify_create_roles.rb') }
       
-      # should be_a_migration - verifies the file exists with a migration timestamp as part of the filename 
       it { should be_a_migration }
+      it { should contain "create_table(:roles) do" }
+      it { should contain "create_table(:users_roles, :id => false) do" }
     end
   end
 
   describe 'specifying user and role names' do
-    before(:all) { arguments %w(Rank Client) }
+    before(:all) { arguments %w(AdminRole AdminUser) }
     
     before { 
       capture(:stdout) {
-        generator.create_file "app/models/client.rb" do
-          "class Client < ActiveRecord::Base\nend"
+        generator.create_file "app/models/admin_user.rb" do
+          "class AdminUser < ActiveRecord::Base\nend"
         end
       }
       run_generator
@@ -69,29 +72,34 @@ describe Rolify::Generators::RoleGenerator do
     
     describe 'config/initializers/rolify.rb' do
       subject { file('config/initializers/rolify.rb') }
+      
       it { should exist }
-      it { should contain "# c.use_dynamic_shortcuts" }
+      it { should contain "Rolify.configure do |config|"}
+      it { should contain "# config.use_dynamic_shortcuts" }
+      it { should contain "# config.use_mongoid" }
     end
     
     describe 'app/models/rank.rb' do
-      subject { file('app/models/rank.rb') }
+      subject { file('app/models/admin_role.rb') }
+      
       it { should exist }
-      it { should contain "class Rank < ActiveRecord::Base" }
-      it { should contain "has_and_belongs_to_many :clients, :join_table => :clients_ranks" }
+      it { should contain "class AdminRole < ActiveRecord::Base" }
+      it { should contain "has_and_belongs_to_many :admin_users, :join_table => :admin_users_admin_roles" }
       it { should contain "belongs_to :resource, :polymorphic => true" }
     end
     
     describe 'app/models/client.rb' do
-      subject { file('app/models/client.rb') }
+      subject { file('app/models/admin_user.rb') }
+      
       it { should contain "rolify" }
     end
     
     describe 'migration file' do
-      subject { file('db/migrate/rolify_create_ranks.rb') }
+      subject { migration_file('db/migrate/rolify_create_admin_roles.rb') }
       
-      # should be_a_migration - verifies the file exists with a migration timestamp as part of the filename 
       it { should be_a_migration }
-      #it { should contain "create_table(:ranks)" }
+      it { should contain "create_table(:admin_roles)" }
+      it { should contain "create_table(:admin_users_admin_roles, :id => false) do" }
     end
   end
   
@@ -110,7 +118,9 @@ describe Rolify::Generators::RoleGenerator do
     describe 'config/initializers/rolify.rb' do
       subject { file('config/initializers/rolify.rb') }
       it { should exist }
-      it { should_not contain "# c.use_dynamic_shortcuts" }
+      it { should contain "Rolify.configure do |config|"}
+      it { should_not contain "# config.use_dynamic_shortcuts" }
+      it { should contain "# config.use_mongoid" }
     end
     
     describe 'app/models/role.rb' do
@@ -127,10 +137,11 @@ describe Rolify::Generators::RoleGenerator do
     end
     
     describe 'migration file' do
-      subject { file('db/migrate/rolify_create_roles.rb') }
+      subject { migration_file('db/migrate/rolify_create_roles.rb') }
       
-      # should be_a_migration - verifies the file exists with a migration timestamp as part of the filename 
       it { should be_a_migration }
+      it { should contain "create_table(:roles) do" }
+      it { should contain "create_table(:users_roles, :id => false) do" }
     end
   end
   
@@ -155,8 +166,9 @@ describe Rolify::Generators::RoleGenerator do
     describe 'config/initializers/rolify.rb' do
       subject { file('config/initializers/rolify.rb') }
       it { should exist }
-      it { should_not contain "# c.use_mongoid" }
-      it { should contain "# c.use_dynamic_shortcuts" }
+      it { should contain "Rolify.configure do |config|"}
+      it { should_not contain "# config.use_mongoid" }
+      it { should contain "# config.use_dynamic_shortcuts" }
     end
     
     describe 'app/models/role.rb' do
@@ -165,6 +177,16 @@ describe Rolify::Generators::RoleGenerator do
       it { should contain "class Role\n" }
       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, unique: true" }
+      it { should contain "  index(\n"
+                          "    [\n"
+                          "      [:name, Mongo::ASCENDING],\n"
+                          "      [:resource_type, Mongo::ASCENDING],\n"
+                          "      [:resource_id, Mongo::ASCENDING]\n"
+                          "    ],\n"
+                          "    unique: true\n"
+                          "  )\n" }
     end
     
     describe 'app/models/user.rb' do

data/spec/rolify/config_spec.rb

@@ -1,4 +1,6 @@
 require "spec_helper"
+require "active_record"
+require "mongoid"
 
 class ARUser < ActiveRecord::Base
   extend Rolify
@@ -45,7 +47,7 @@ describe Rolify do
         
         subject { ARUser }
         
-        its("adapter.class") { should be(Rolify::Adapter::ActiveRecord) }
+        its("adapter.class") { should be(Rolify::Adapter::RoleAdapter) }
       end
       
       context "on the Forum class" do
@@ -55,7 +57,7 @@ describe Rolify do
         
         subject { Forum }
         
-        its("adapter.class") { should be(Rolify::Adapter::ActiveRecord) }
+        its("adapter.class") { should be(Rolify::Adapter::ResourceAdapter) }
       end
     end
 
@@ -76,7 +78,7 @@ describe Rolify do
 
           subject { MUser }
           
-          its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+          its("adapter.class") { should be(Rolify::Adapter::RoleAdapter) }
         end
 
         context "on the Forum class" do
@@ -86,7 +88,7 @@ describe Rolify do
 
           subject { Forum }
 
-          its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+          its("adapter.class") { should be(Rolify::Adapter::ResourceAdapter) }
         end
       end
       
@@ -106,7 +108,7 @@ describe Rolify do
 
           subject { MUser }
           
-          its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+          its("adapter.class") { should be(Rolify::Adapter::RoleAdapter) }
         end
 
         context "on the Forum class" do
@@ -116,7 +118,7 @@ describe Rolify do
 
           subject { Forum }
 
-          its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+          its("adapter.class") { should be(Rolify::Adapter::ResourceAdapter) }
         end
       end
     end
@@ -154,9 +156,9 @@ describe Rolify do
   
   describe :configure do
     before do
-      Rolify.configure do |r|
-        r.dynamic_shortcuts = true
-        r.orm = "mongoid"
+      Rolify.configure do |config|
+        config.dynamic_shortcuts = true
+        config.orm = "mongoid"
       end
     end
     
@@ -172,7 +174,7 @@ describe Rolify do
       
       it { should satisfy { |u| u.include? Rolify::Role }}
       it { should satisfy { |u| u.singleton_class.include? Rolify::Dynamic } }
-      its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+      its("adapter.class") { should be(Rolify::Adapter::RoleAdapter) }
     end
 
     context "on the Forum class" do
@@ -183,7 +185,7 @@ describe Rolify do
       subject { Forum }
       
       it { should satisfy { |u| u.include? Rolify::Resource }}
-      its("adapter.class") { should be(Rolify::Adapter::Mongoid) }
+      its("adapter.class") { should be(Rolify::Adapter::ResourceAdapter) }
     end
   end
 end

data/spec/rolify/resource_spec.rb

@@ -3,7 +3,6 @@ require "spec_helper"
 describe Rolify::Resource do
   before(:all) do
     reset_defaults
-    #Role.destroy_all
     User.rolify :role_cname => "Role"
     Forum.resourcify :role_cname => "Role"
     Group.resourcify :role_cname => "Role"
@@ -14,11 +13,11 @@ describe Rolify::Resource do
   let(:tourist) { User.last }
   
   # roles
-  let!(:forum_role)      { admin.has_role("forum", Forum.first) }
-  let!(:godfather_role)  { admin.has_role("godfather", Forum) }
-  let!(:group_role)      { admin.has_role("group", Group.last) }
-  let!(:tourist_role)    { tourist.has_role("forum", Forum.last) }
-  let!(:sneaky_role)     { tourist.has_role("group", Forum.first) }
+  let!(:forum_role)      { admin.add_role(:forum, Forum.first) }
+  let!(:godfather_role)  { admin.add_role(:godfather, Forum) }
+  let!(:group_role)      { admin.add_role(:group, Group.last) }
+  let!(:tourist_role)    { tourist.add_role(:forum, Forum.last) }
+  let!(:sneaky_role)     { tourist.add_role(:group, Forum.first) }
 
   describe ".with_roles" do
     subject { Group }
@@ -31,10 +30,10 @@ describe Rolify::Resource do
         subject { Forum }
 
         it "should include Forum instances with forum role" do 
-          subject.with_role("forum").should include(Forum.first, Forum.last)
+          subject.with_role(:forum).should include(Forum.first, Forum.last)
         end
         it "should include Forum instances with godfather role" do 
-          subject.with_role("godfather").should eq(Forum.all)
+          subject.with_role(:godfather).should eq(Forum.all)
         end
       end
 
@@ -42,7 +41,7 @@ describe Rolify::Resource do
         subject { Group }
 
         it "should include Group instances with group role" do
-          subject.with_role("group").should include(Group.last)
+          subject.with_role(:group).should include(Group.last)
         end
       end
 
@@ -53,27 +52,27 @@ describe Rolify::Resource do
         subject { Forum }
 
         it "should get all Forum instances binded to the forum role and the admin user" do
-          subject.with_role("forum", admin).should include(Forum.first)
+          subject.with_role(:forum, admin).should include(Forum.first)
         end
 
         it "should get all Forum instances binded to the forum role and the tourist user" do
-          subject.with_role("forum", tourist).should include(Forum.last)
+          subject.with_role(:forum, tourist).should include(Forum.last)
         end
 
         it "should get all Forum instances binded to the godfather role and the admin user" do
-          subject.with_role("godfather", admin).should == Forum.all
+          subject.with_role(:godfather, admin).should == Forum.all
         end
 
         it "should get all Forum instances binded to the godfather role and the tourist user" do
-          subject.with_role("godfather", tourist).should be_empty
+          subject.with_role(:godfather, tourist).should be_empty
         end
 
         it "should get Forum instances binded to the group role and the tourist user" do
-          subject.with_role("group", tourist).should include(Forum.first)
+          subject.with_role(:group, tourist).should include(Forum.first)
         end
 
         it "should not get Forum instances not binded to the group role and the tourist user" do
-          subject.with_role("group", tourist).should_not include(Forum.last)
+          subject.with_role(:group, tourist).should_not include(Forum.last)
         end
       end
 
@@ -81,11 +80,11 @@ describe Rolify::Resource do
         subject { Group }
 
         it "should get all resources binded to the group role and the admin user" do
-          subject.with_role("group", admin).should include(Group.last)
+          subject.with_role(:group, admin).should include(Group.last)
         end
 
         it "should not get resources not binded to the group role and the admin user" do
-          subject.with_role("group", admin).should_not include(Group.first)
+          subject.with_role(:group, admin).should_not include(Group.first)
         end
       end
     end
@@ -146,31 +145,31 @@ describe Rolify::Resource do
 
         context "without using a user parameter" do
           it "should get all roles binded to a Forum class or instance and forum role name" do
-            subject.find_roles("forum").should include(forum_role, tourist_role)
+            subject.find_roles(:forum).should include(forum_role, tourist_role)
           end
 
           it "should not get roles not binded to a Forum class or instance and forum role name" do
-            subject.find_roles("forum").should_not include(godfather_role, sneaky_role, group_role)
+            subject.find_roles(:forum).should_not include(godfather_role, sneaky_role, group_role)
           end
         end
 
         context "using a user parameter" do
           it "should get all roles binded to any resource" do
-            subject.find_roles("forum", admin).should include(forum_role)
+            subject.find_roles(:forum, admin).should include(forum_role)
           end
 
           it "should not get roles not binded to the admin user and forum role name" do
-            subject.find_roles("forum", admin).should_not include(godfather_role, tourist_role, sneaky_role, group_role)
+            subject.find_roles(:forum, admin).should_not include(godfather_role, tourist_role, sneaky_role, group_role)
           end
         end
 
         context "using :any parameter" do
           it "should get all roles binded to any resource with forum role name" do
-            subject.find_roles("forum", :any).should include(forum_role, tourist_role)
+            subject.find_roles(:forum, :any).should include(forum_role, tourist_role)
           end
 
           it "should not get roles not binded to a resource with forum role name" do
-            subject.find_roles("forum", :any).should_not include(godfather_role, sneaky_role, group_role)
+            subject.find_roles(:forum, :any).should_not include(godfather_role, sneaky_role, group_role)
           end
         end
       end
@@ -180,31 +179,31 @@ describe Rolify::Resource do
         
         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)
+            subject.find_roles(:group).should include(group_role)
           end
 
           it "should not get roles not binded to a Forum class or instance and forum role name" do
-            subject.find_roles("group").should_not include(tourist_role, godfather_role, sneaky_role, forum_role)
+            subject.find_roles(:group).should_not include(tourist_role, godfather_role, sneaky_role, forum_role)
           end
         end
 
         context "using a user parameter" do
           it "should get all roles binded to any resource" do
-            subject.find_roles("group", admin).should include(group_role)
+            subject.find_roles(:group, admin).should include(group_role)
           end
 
           it "should not get roles not binded to the admin user and forum role name" do
-            subject.find_roles("group", admin).should_not include(godfather_role, tourist_role, sneaky_role, forum_role)
+            subject.find_roles(:group, admin).should_not include(godfather_role, tourist_role, sneaky_role, forum_role)
           end
         end
 
         context "using :any parameter" do
           it "should get all roles binded to any resource with forum role name" do
-            subject.find_roles("group", :any).should include(group_role)
+            subject.find_roles(:group, :any).should include(group_role)
           end
 
           it "should not get roles not binded to a resource with forum role name" do
-            subject.find_roles("group", :any).should_not include(godfather_role, sneaky_role, forum_role, tourist_role)
+            subject.find_roles(:group, :any).should_not include(godfather_role, sneaky_role, forum_role, tourist_role)
           end
         end
       end