rolify 3.1.0 → 4.0.0

data/spec/generators/rolify/rolify_mongoid_generator_spec.rb

@@ -0,0 +1,113 @@
+require 'generators_helper'
+
+# Generators are not automatically loaded by Rails
+require 'generators/rolify/rolify_generator'
+
+describe Rolify::Generators::RolifyGenerator, :if => ENV['ADAPTER'] == 'mongoid' do
+  # Tell the generator where to put its output (what it thinks of as Rails.root)
+  destination File.expand_path("../../../../tmp", __FILE__)
+  teardown :cleanup_destination_root
+
+  before {
+    prepare_destination
+  }
+
+  def cleanup_destination_root
+    FileUtils.rm_rf destination_root
+  end
+
+  describe 'specifying ORM adapter' do
+    before(:all) { arguments [ "Role", "User", "--orm=mongoid" ] }
+
+    before {
+      capture(:stdout) {
+        generator.create_file "app/models/user.rb" do
+<<-RUBY
+class User
+  include Mongoid::Document
+
+  field :login, :type => String
+end
+RUBY
+        end
+      }
+      require File.join(destination_root, "app/models/user.rb")
+      run_generator
+    }
+
+    describe 'config/initializers/rolify.rb' do
+      subject { file('config/initializers/rolify.rb') }
+      it { should exist }
+      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
+      subject { file('app/models/role.rb') }
+      it { should exist }
+      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({\n"
+                          "      { :name => 1 },\n"
+                          "      { :resource_type => 1 },\n"
+                          "      { :resource_id => 1 }\n"
+                          "    },\n"
+                          "    { unique => true })"}
+      it { should contain "validates :resource_type,\n"
+                          "          :inclusion => { :in => Rolify.resource_types },\n"
+                          "          :allow_nil => true" }
+    end
+
+    describe 'app/models/user.rb' do
+      subject { file('app/models/user.rb') }
+      it { should contain /class User\n  include Mongoid::Document\n  rolify\n/ }
+    end
+  end
+
+  describe 'specifying namespaced User and Role class names and ORM adapter' do
+    before(:all) { arguments %w(Admin::Role Admin::User --orm=mongoid) }
+
+    before {
+      capture(:stdout) {
+        generator.create_file "app/models/admin/user.rb" do
+<<-RUBY
+module Admin
+  class User
+    include Mongoid::Document
+  end
+end
+RUBY
+        end
+      }
+      require File.join(destination_root, "app/models/admin/user.rb")
+      run_generator
+    }
+
+    describe 'config/initializers/rolify.rb' do
+      subject { file('config/initializers/rolify.rb') }
+
+      it { should exist }
+      it { should contain "Rolify.configure(\"Admin::Role\") do |config|"}
+      it { should contain "# config.use_dynamic_shortcuts" }
+      it { should_not contain "# config.use_mongoid" }
+    end
+
+    describe 'app/models/admin/role.rb' do
+      subject { file('app/models/admin/role.rb') }
+
+      it { should exist }
+      it { should contain "class Admin::Role" }
+      it { should contain "has_and_belongs_to_many :admin_users" }
+      it { should contain "belongs_to :resource, :polymorphic => true" }
+    end
+
+    describe 'app/models/admin/user.rb' do
+      subject { file('app/models/admin/user.rb') }
+
+      it { should contain /class User\n    include Mongoid::Document\n  rolify :role_cname => 'Admin::Role'\n/ }
+    end
+  end
+end

data/spec/generators_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require "bundler/setup"
+
+require 'rolify'
+require 'rolify/matchers'
+require 'rails'
+require_relative 'support/stream_helpers'
+include StreamHelpers
+
+require 'coveralls'
+Coveralls.wear_merged!
+
+ENV['ADAPTER'] ||= 'active_record'
+
+if ENV['ADAPTER'] == 'active_record'
+  require 'active_record/railtie'
+else
+  require 'mongoid'
+end
+
+module TestApp
+  class Application < ::Rails::Application
+    config.root = File.dirname(__FILE__)
+  end
+end
+
+require 'ammeter/init'

data/spec/rolify/config_spec.rb

@@ -1,14 +1,14 @@
 require "spec_helper"
-require "active_record"
-require "mongoid"
 
-class ARUser < ActiveRecord::Base
-  extend Rolify
-end
-
-class MUser
-  include Mongoid::Document
-  extend Rolify
+if ENV['ADAPTER'] == 'active_record'
+  class ARUser < ActiveRecord::Base
+    extend Rolify
+  end
+else
+  class MUser
+    include Mongoid::Document
+    extend Rolify
+  end
 end
 
 describe Rolify do
@@ -20,7 +20,7 @@ describe Rolify do
     context "using defaults values" do
       subject { Rolify.dynamic_shortcuts }
 
-      it { should be_false }
+      it { should be_falsey }
     end
 
     context "using custom values" do
@@ -30,19 +30,19 @@ describe Rolify do
 
       subject { Rolify.dynamic_shortcuts }
 
-      it { should be_true }
+      it { should be_truthy }
     end
   end
 
   describe :orm do 
-    context "using defaults values" do
+    context "using defaults values", :if => ENV['ADAPTER'] == 'active_record' do
       subject { Rolify.orm }
 
       it { should eq("active_record") }
       
       context "on the User class" do
         before do
-          ARUser.rolify
+          subject.rolify
         end
         
         subject { ARUser }
@@ -52,7 +52,7 @@ describe Rolify do
       
       context "on the Forum class" do
         before do
-          Forum.resourcify
+          subject.resourcify
         end
         
         subject { Forum }
@@ -61,7 +61,7 @@ describe Rolify do
       end
     end
 
-    context "using custom values" do
+    context "using custom values", :if => ENV['ADAPTER'] == 'mongoid' do
       context "using :orm setter method" do
         before do
           Rolify.orm = "mongoid"
@@ -127,7 +127,7 @@ describe Rolify do
       context "using defaults values" do
         subject { Rolify.dynamic_shortcuts }
 
-        it { should be_false }
+        it { should be_falsey }
       end
       
       context "using custom values" do
@@ -138,7 +138,7 @@ describe Rolify do
 
           subject { Rolify.dynamic_shortcuts }
 
-          it { should be_true }
+          it { should be_truthy }
         end
 
         context "using :use_dynamic_shortcuts method" do
@@ -148,7 +148,7 @@ describe Rolify do
 
           subject { Rolify.dynamic_shortcuts }
 
-          it { should be_true }
+          it { should be_truthy }
         end
       end
     end
@@ -162,10 +162,10 @@ describe Rolify do
       end
     end
     
-    its(:dynamic_shortcuts) { should be_true }
+    its(:dynamic_shortcuts) { should be_truthy }
     its(:orm) { should eq("mongoid") }
     
-    context "on the User class" do
+    context "on the User class", :if => ENV['ADAPTER'] == 'mongoid' do
       before do
         MUser.rolify
       end
@@ -183,7 +183,6 @@ describe Rolify do
       end
 
       subject { Forum }
-      
       it { should satisfy { |u| u.include? Rolify::Resource }}
       its("adapter.class") { should be(Rolify::Adapter::ResourceAdapter) }
     end

data/spec/rolify/custom_spec.rb

@@ -1,15 +1,20 @@
 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 "Using Rolify with custom User and Role class names" do
-  it_behaves_like Rolify::Role do
-    let(:user_class) { Customer }
-    let(:role_class) { Privilege }
+  def user_class
+    Customer
   end
 
-  it_behaves_like Rolify::Dynamic do
-    let(:user_class) { Customer } 
-    let(:role_class) { Privilege }
+  def role_class
+    Privilege
   end
+  
+  it_behaves_like Rolify::Role
+  it_behaves_like "Role.scopes"
+  it_behaves_like Rolify::Dynamic
+  it_behaves_like "Rolify.callbacks"
 end

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,24 @@
+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
+  def user_class
+    Admin::Moderator
+  end
+
+  def role_class
+    Admin::Right
+  end
+  
+  def join_table
+    "moderators_rights"
+  end
+  
+  it_behaves_like Rolify::Role
+  it_behaves_like "Role.scopes"
+  it_behaves_like Rolify::Dynamic
+  it_behaves_like "Rolify.callbacks"
+end

data/spec/rolify/resource_spec.rb

@@ -3,21 +3,29 @@ 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"
+    silence_warnings { User.rolify }
+    Forum.resourcify
+    Group.resourcify
+    Team.resourcify
+    Organization.resourcify
+    Role.destroy_all
   end
 
   # Users
   let(:admin)   { User.first }
   let(:tourist) { User.last }
-  
+  let(:captain) { User.where(:login => "god").first }
+
   # roles
   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!(:grouper_role)    { admin.add_role(:grouper, Group.first) }
   let!(:tourist_role)    { tourist.add_role(:forum, Forum.last) }
   let!(:sneaky_role)     { tourist.add_role(:group, Forum.first) }
+  let!(:captain_role)    { captain.add_role(:captain, Team.first) }
+  let!(:player_role)     { captain.add_role(:player, Team.last) }
+  let!(:company_role)    { admin.add_role(:owner, Company.first) }
 
   describe ".with_roles" do
     subject { Group }
@@ -25,42 +33,66 @@ 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 
-          subject.with_role(:forum).should include(Forum.first, Forum.last)
+        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
+          subject.with_role(:godfather).should =~ Forum.all.to_a
         end
-        it "should include Forum instances with godfather role" do 
-          subject.with_role(:godfather).should eq(Forum.all)
+
+        it "should be able to modify the resource", :if => ENV['ADAPTER'] == 'active_record' do
+          forum_resource = subject.with_role(:forum).first
+          forum_resource.name = "modified name"
+          expect { forum_resource.save }.not_to raise_error
         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
-          subject.with_role(:group).should include(Group.last)
+          subject.with_role(:group).should =~ [ Group.last ]
         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
+        subject { Group }
+
+        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
-          subject.with_role(:forum, admin).should include(Forum.first)
+          subject.with_role(:forum, admin).should =~ [ 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 =~ [ 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.to_a
         end
 
         it "should get all Forum instances binded to the godfather role and the tourist user" do
@@ -68,7 +100,7 @@ describe Rolify::Resource do
         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 =~ [ Forum.first ]
         end
 
         it "should not get Forum instances not binded to the group role and the tourist user" do
@@ -76,11 +108,11 @@ 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
-          subject.with_role(:group, admin).should include(Group.last)
+          subject.with_role(:group, admin).should =~ [ Group.last ]
         end
 
         it "should not get resources not binded to the group role and the admin user" do
@@ -88,17 +120,52 @@ describe Rolify::Resource do
         end
       end
     end
+
+    context "with an array of role names and a user as arguments" 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
+          subject.with_roles([:forum, :group], tourist).should =~ [ Forum.first, Forum.last ]
+        end
+
+      end
+
+      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
+          subject.with_roles([:group, :grouper], admin).should =~ [ Group.first, Group.last ]
+        end
+
+      end
+    end
+
+    context "with a model not having ID column" do
+      subject { Team }
+
+      it "should find Team instance using team_code column" do
+        subject.with_roles([:captain, :player], captain).should =~ [ Team.first, Team.last ]
+      end
+    end
+
+    context "with a resource using STI" do
+      subject { Organization }
+      it "should find instances of children classes" do
+        subject.with_roles(:owner, admin).should =~ [ Company.first ]
+      end
+    end
   end
 
   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 }
 
         it "should get all roles binded to a Forum class or instance" do
-          subject.find_roles.should include(forum_role, godfather_role, tourist_role, sneaky_role)
+          subject.find_roles.to_a.should =~ [ forum_role, godfather_role, tourist_role, sneaky_role ]
         end
 
         it "should not get roles not binded to a Forum class or instance" do
@@ -107,7 +174,7 @@ describe Rolify::Resource do
 
         context "using :any parameter" do
           it "should get all roles binded to any Forum class or instance" do
-            subject.find_roles(:any, :any).should include(forum_role, godfather_role, tourist_role, sneaky_role)
+            subject.find_roles(:any, :any).to_a.should =~ [ forum_role, godfather_role, tourist_role, sneaky_role ]
           end
 
           it "should not get roles not binded to a Forum class or instance" do
@@ -118,9 +185,9 @@ 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.should include(group_role)
+          subject.find_roles.to_a.should =~ [ group_role, grouper_role ]
         end
 
         it "should not get roles not binded to a Group class or instance" do
@@ -129,7 +196,7 @@ describe Rolify::Resource do
 
         context "using :any parameter" do
           it "should get all roles binded to Group class or instance" do
-            subject.find_roles(:any, :any).should include(group_role)
+            subject.find_roles(:any, :any).to_a.should =~ [ group_role, grouper_role ]
           end
 
           it "should not get roles not binded to a Group class or instance" do
@@ -139,7 +206,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 }
 
@@ -155,7 +222,7 @@ describe Rolify::Resource do
 
         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).to_a.should =~ [ forum_role ]
           end
 
           it "should not get roles not binded to the admin user and forum role name" do
@@ -176,7 +243,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)
@@ -209,7 +276,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 }
 
@@ -278,23 +345,46 @@ describe Rolify::Resource do
         end
       end
     end
+
+    context "with a resource using STI" do
+      subject{ Organization }
+      it "should find instances of children classes" do
+        subject.find_roles(:owner, admin).should =~ [company_role]
+      end
+    end
   end
 
   describe "#roles" do
+    before(:all) { Role.destroy_all }
     subject { Forum.first }
 
     it { should respond_to :roles }
 
-    context "on a Forum instance" do 
-      its(:roles) { should include(forum_role, sneaky_role) } 
-      its(:roles) { subject.should_not include(group_role, godfather_role, tourist_role) }
+    context "on a Forum instance" do
+      its(:roles) { should match_array( [ forum_role, sneaky_role ]) }
+      its(:roles) { should_not include(group_role, godfather_role, tourist_role) }
     end
 
     context "on a Group instance" do
       subject { Group.last }
 
-      its(:roles) { should include(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
+          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
+      end
     end
   end
 
@@ -302,15 +392,23 @@ describe Rolify::Resource do
     context "on a Forum instance" do
       subject { Forum.first }
 
-      its(:applied_roles) { should include(forum_role, godfather_role, sneaky_role) }
+      its(:applied_roles) { should =~ [ forum_role, godfather_role, sneaky_role ] }
       its(:applied_roles) { should_not include(group_role, tourist_role) }
     end
 
     context "on a Group instance" do
       subject { Group.last }
 
-      its(:applied_roles) { should include(group_role) }
+      its(:applied_roles) { should =~ [ group_role ] }
       its(:applied_roles) { should_not include(forum_role, godfather_role, sneaky_role, tourist_role) }
     end
   end
-end
+
+  describe '.resource_types' do
+
+    it 'include all models that call resourcify' do
+      Rolify.resource_types.should include("HumanResource", "Forum", "Group",
+                                          "Team", "Organization")
+    end
+  end
+end