rolify 3.3.0.rc2 → 3.3.0.rc4

data/spec/README.rdoc

@@ -0,0 +1,24 @@
+= Rolify Specs
+
+== Running the specs
+
+To run the specs first run the +bundle+ command to install the necessary gems and the +rake+ command to run the specs.
+
+  bundle
+  rake
+
+== Model Adapters
+
+Rolify currently supports 2 different ORMs: ActiveRecord and Mongoid. By default it will use Active Record but you can change this by setting the +ADAPTER+ environment variable before running the specs. You can run the +bundle+ command with this as well to ensure you have all the required gems.
+
+  ADAPTER=mongoid bundle
+  ADAPTER=mongoid rake
+
+The different model adapters you can specify are:
+
+* active_record (default)
+* mongoid
+
+You can also run the +spec_all+ rake task to run specs for each adapter.
+
+  rake spec_all

data/spec/generators/rolify/{role/role_generator_spec.rb → rolify_generator_spec.rb}

@@ -1,11 +1,11 @@
-require 'spec_helper'
+require 'generators_helper'
 
 # Generators are not automatically loaded by Rails
-require 'generators/rolify/role/role_generator'
+require 'generators/rolify/rolify_generator'
 
-describe Rolify::Generators::RoleGenerator do
+describe Rolify::Generators::RolifyGenerator do
   # Tell the generator where to put its output (what it thinks of as Rails.root)
-  destination File.expand_path("../../../../../tmp", __FILE__)
+  destination File.expand_path("../../../../tmp", __FILE__)
   teardown :cleanup_destination_root
   
   before { 
@@ -16,15 +16,19 @@ describe Rolify::Generators::RoleGenerator do
     FileUtils.rm_rf destination_root
   end
 
-  describe 'no arguments' do
-    before(:all) { arguments [] }
+  describe 'specifying only Role class name' do
+    before(:all) { arguments %w(Role) }
 
     before { 
       capture(:stdout) {
         generator.create_file "app/models/user.rb" do
-          "class User < ActiveRecord::Base\nend"
+<<-RUBY
+  class User < ActiveRecord::Base
+  end
+RUBY
         end
       }
+      require File.join(destination_root, "app/models/user.rb")
       run_generator 
     }
     
@@ -58,7 +62,7 @@ describe Rolify::Generators::RoleGenerator do
     end
   end
 
-  describe 'specifying user and role names' do
+  describe 'specifying User and Role class names' do
     before(:all) { arguments %w(AdminRole AdminUser) }
     
     before { 
@@ -67,6 +71,7 @@ describe Rolify::Generators::RoleGenerator do
           "class AdminUser < ActiveRecord::Base\nend"
         end
       }
+      require File.join(destination_root, "app/models/admin_user.rb")
       run_generator
     }
     
@@ -79,7 +84,7 @@ describe Rolify::Generators::RoleGenerator do
       it { should contain "# config.use_mongoid" }
     end
     
-    describe 'app/models/rank.rb' do
+    describe 'app/models/admin_role.rb' do
       subject { file('app/models/admin_role.rb') }
       
       it { should exist }
@@ -103,21 +108,74 @@ describe Rolify::Generators::RoleGenerator do
     end
   end
   
-  describe 'specifying orm adapter' do 
-    before(:all) { arguments [ "Role", "User", "mongoid" ] }
+  describe 'specifying namespaced User and Role class names' do
+    before(:all) { arguments %w(Admin::Role Admin::User) }
+    
+    before { 
+      capture(:stdout) {
+        generator.create_file "app/models/admin/user.rb" do
+<<-RUBY
+module Admin
+  class User < ActiveRecord::Base
+    self.table_name_prefix = 'admin_'
+  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 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 < 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/admin/user.rb' do
+      subject { file('app/models/admin/user.rb') }
+      
+      it { should contain /class User < ActiveRecord::Base\n  rolify :role_cname => 'Admin::Role'\n/ }
+    end
+    
+    describe 'migration file' do
+      subject { migration_file('db/migrate/rolify_create_admin_roles.rb') }
+      
+      it { should be_a_migration }
+      it { should contain "create_table(:admin_roles)" }
+      it { should contain "create_table(:admin_users_admin_roles, :id => false) do" }
+    end
+  end
+  
+  describe 'specifying ORM adapter' do 
+    before(:all) { arguments [ "Role", "User", "--orm=mongoid" ] }
     
     before { 
       capture(:stdout) {
         generator.create_file "app/models/user.rb" do
-<<-CLASS 
+<<-RUBY
 class User
   include Mongoid::Document
 
   field :login, :type => String
 end
-CLASS
+RUBY
         end
       }
+      require File.join(destination_root, "app/models/user.rb")
       run_generator
     }
       
@@ -149,4 +207,48 @@ CLASS
       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,14 @@
+require 'rubygems'
+require "bundler/setup"
+
+require 'rolify'
+require 'rolify/matchers'
+require 'rails/all'
+
+module TestApp
+  class Application < ::Rails::Application
+    config.root = File.dirname(__FILE__)
+  end
+end
+
+require 'ammeter/init'

data/spec/rolify/custom_spec.rb

@@ -5,23 +5,16 @@ 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 "Role.scopes" do
-    let(:user_class) { Customer } 
-    let(:role_class) { Privilege }
-  end
-
-  it_behaves_like Rolify::Dynamic do
-    let(:user_class) { Customer } 
-    let(:role_class) { Privilege }
-  end
-
-  it_behaves_like "Rolify.callbacks" 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/namespace_spec.rb

@@ -5,23 +5,16 @@ 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 }
+  def user_class
+    Admin::Moderator
   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 }
+  def role_class
+    Admin::Right
   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

@@ -6,12 +6,14 @@ describe Rolify::Resource do
     User.rolify
     Forum.resourcify
     Group.resourcify
+    Team.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) }
@@ -20,6 +22,8 @@ describe Rolify::Resource do
   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) }
 
   describe ".with_roles" do
     subject { Group }
@@ -127,7 +131,14 @@ describe Rolify::Resource do
 
       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
   end
 
   describe ".find_role" do
@@ -327,7 +338,7 @@ describe Rolify::Resource 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) }
+      its(:roles) { should_not include(group_role, godfather_role, tourist_role) }
     end
 
     context "on a Group instance" do

data/spec/rolify/resourcifed_and_rolifed_spec.rb

@@ -8,7 +8,11 @@ describe "Resourcify and rolify on the same model" do
     HumanResource.delete_all
   end
   
-  let!(:user) { user = HumanResource.new login: 'Samer'; user.save; user }
+  let!(:user) do
+    user = HumanResource.new login: 'Samer' 
+    user.save
+    user
+  end
   
   it "should add the role to the user" do
     expect { user.add_role :admin }.to change { user.roles.count }.by(1)

data/spec/rolify/role_spec.rb

@@ -5,23 +5,16 @@ require "rolify/shared_examples/shared_examples_for_scopes"
 require "rolify/shared_examples/shared_examples_for_callbacks"
 
 describe Rolify do
-  it_behaves_like Rolify::Role do
-    let(:user_class) { User } 
-    let(:role_class) { Role }
+  def user_class
+    User
   end
 
-  it_behaves_like "Role.scopes" do
-    let(:user_class) { User } 
-    let(:role_class) { Role }
-  end
-
-  it_behaves_like Rolify::Dynamic do
-    let(:user_class) { User } 
-    let(:role_class) { Role }
-  end
-
-  it_behaves_like "Rolify.callbacks" do
-    let(:user_class) { User }
-    let(:role_class) { Role }
+  def role_class
+    Role
   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/shared_contexts.rb

@@ -1,7 +1,9 @@
 shared_context "global role", :scope => :global do
   subject { admin }
   
-  let(:admin) { user_class.first }
+  def admin
+    user_class.first
+  end
   
   before(:all) do
     load_roles
@@ -29,7 +31,9 @@ shared_context "class scoped role", :scope => :class do
     create_other_roles
   end
   
-  let(:manager) { user_class.where(:login => "moderator").first }
+  def manager
+    user_class.where(:login => "moderator").first
+  end
   
   def load_roles
     role_class.destroy_all
@@ -51,7 +55,9 @@ shared_context "instance scoped role", :scope => :instance do
     create_other_roles
   end
   
-  let(:moderator) { user_class.where(:login => "god").first }
+  def moderator
+    user_class.where(:login => "god").first
+  end
   
   def load_roles
     role_class.destroy_all

data/spec/rolify/shared_examples/shared_examples_for_add_role.rb

@@ -50,7 +50,7 @@ shared_examples_for "#add_role_examples" do |param_name, param_method|
       context "should not create another role" do
         it "if the role was already assigned to the user" do
           subject.add_role "warrior".send(param_method), Forum
-          expect { subject.add_role "warrior".send(param_method), Forum }.not_to change { subject.roles.size }
+          expect { subject.add_role "warrior".send(param_method), Forum }.not_to change { subject.roles.count }
         end
 
         it "if already existing in the database" do
@@ -62,7 +62,7 @@ shared_examples_for "#add_role_examples" do |param_name, param_method|
 
     context "with an instance scoped role", :scope => :instance do
       it "should add the role to the user" do
-        expect { subject.add_role "visitor".send(param_method), Forum.last }.to change { subject.roles.size }.by(1)
+        expect { subject.add_role "visitor".send(param_method), Forum.last }.to change { subject.roles.count }.by(1)
       end
 
       it "should create a role in the roles table" do

data/spec/rolify/shared_examples/shared_examples_for_dynamic.rb

@@ -1,4 +1,4 @@
-shared_examples_for Rolify::Dynamic do 
+shared_examples_for Rolify::Dynamic do
   before(:all) do
     Rolify.dynamic_shortcuts = true
     role_class.destroy_all

data/spec/rolify/shared_examples/shared_examples_for_has_any_role.rb

@@ -1,7 +1,7 @@
 shared_examples_for "#has_any_role?_examples" do |param_name, param_method|
   context "using #{param_name} as parameter" do
     context "with a global role", :scope => :global do
-      before(:all) do
+      before do
         subject.add_role "staff".send(param_method)
       end
       
@@ -20,7 +20,7 @@ shared_examples_for "#has_any_role?_examples" do |param_name, param_method|
     end
     
     context "with a class scoped role", :scope => :class do
-      before(:all) do
+      before do
         subject.add_role "player".send(param_method), Forum
         subject.add_role "superhero".send(param_method)
       end
@@ -40,7 +40,7 @@ shared_examples_for "#has_any_role?_examples" do |param_name, param_method|
     end
     
     context "with a instance scoped role", :scope => :instance do
-      before(:all) do
+      before do
         subject.add_role "visitor".send(param_method), Forum.last
         subject.add_role "leader", Group
         subject.add_role "warrior"

data/spec/rolify/shared_examples/shared_examples_for_only_has_role.rb

@@ -36,7 +36,7 @@ shared_examples_for "#only_has_role?_examples" do |param_name, param_method|
       end
       
       context "with multiple roles" do
-        before(:all) { subject.add_role "multiple_global_roles".send(param_method) }
+        before { subject.add_role "multiple_global_roles".send(param_method) }
         
         it { subject.only_has_role?("global_role".send(param_method)).should be_false }
       end
@@ -93,7 +93,7 @@ shared_examples_for "#only_has_role?_examples" do |param_name, param_method|
       end
       
       context "with multiple roles" do
-        before(:all) { subject.add_role "multiple_class_roles".send(param_method) }
+        before { subject.add_role "multiple_class_roles".send(param_method) }
         
         it { subject.only_has_role?("class_role".send(param_method), Forum).should be_false }
         it { subject.only_has_role?("class_role".send(param_method), Forum.first).should be_false }
@@ -164,7 +164,7 @@ shared_examples_for "#only_has_role?_examples" do |param_name, param_method|
       end
     
       context "with multiple roles" do
-        before(:all) { subject.add_role "multiple_instance_roles".send(param_method), Forum.first }
+        before { subject.add_role "multiple_instance_roles".send(param_method), Forum.first }
         
         it { subject.only_has_role?("instance_role".send(param_method), Forum.first).should be_false }
         it { subject.only_has_role?("instance_role".send(param_method), :any).should be_false }

data/spec/rolify/shared_examples/shared_examples_for_roles.rb

@@ -82,7 +82,7 @@ shared_examples_for Rolify::Role do
   context "with a new instance" do
     let(:user) { user_class.new }
 
-    before(:all) do
+    before do
       user.add_role :admin
       user.add_role :moderator, Forum.first
     end

data/spec/rolify/shared_examples/shared_examples_for_scopes.rb

@@ -1,7 +1,7 @@
 require "rolify/shared_contexts"
 
-shared_examples_for "Role.scopes" do |param_name, param_method|
-  before(:all) do
+shared_examples_for "Role.scopes" do
+  before do
     role_class.destroy_all
   end
   
@@ -18,9 +18,9 @@ shared_examples_for "Role.scopes" do |param_name, param_method|
     let!(:manager_role) { subject.add_role :manager, Group }
     let!(:moderator_role) { subject.add_role :moderator, Forum }
     
-    it { subject.roles.class_scoped.should == [ manager_role, moderator_role ] }
-    it { subject.roles.class_scoped(Group).should == [ manager_role ] }
-    it { subject.roles.class_scoped(Forum).should == [ moderator_role ] }
+    it { subject.roles.class_scoped.should =~ [ manager_role, moderator_role ] }
+    it { subject.roles.class_scoped(Group).should =~ [ manager_role ] }
+    it { subject.roles.class_scoped(Forum).should =~ [ moderator_role ] }
   end
   
   describe ".instance_scoped" do
@@ -28,11 +28,11 @@ shared_examples_for "Role.scopes" do |param_name, param_method|
     let!(:zombie_role) { subject.add_role :visitor, Forum.last }
     let!(:anonymous_role) { subject.add_role :anonymous, Group.last }
     
-    it { subject.roles.instance_scoped.should == [ visitor_role, zombie_role, anonymous_role ] }
-    it { subject.roles.instance_scoped(Forum).should == [ visitor_role, zombie_role ] }
-    it { subject.roles.instance_scoped(Forum.first).should == [ visitor_role ] }
-    it { subject.roles.instance_scoped(Forum.last).should == [ zombie_role ] }
-    it { subject.roles.instance_scoped(Group.last).should == [ anonymous_role ] }
+    it { subject.roles.instance_scoped.all.entries.should =~ [ visitor_role, zombie_role, anonymous_role ] }
+    it { subject.roles.instance_scoped(Forum).should =~ [ visitor_role, zombie_role ] }
+    it { subject.roles.instance_scoped(Forum.first).should =~ [ visitor_role ] }
+    it { subject.roles.instance_scoped(Forum.last).should =~ [ zombie_role ] }
+    it { subject.roles.instance_scoped(Group.last).should =~ [ anonymous_role ] }
     it { subject.roles.instance_scoped(Group.first).should be_empty }
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require "bundler/setup"
 
 require 'rolify'
 require 'rolify/matchers'
-require 'ammeter/init'
+require 'rails/all'
 
 ENV['ADAPTER'] ||= 'active_record'
 

data/spec/support/adapters/active_record.rb

@@ -66,4 +66,11 @@ class Group < ActiveRecord::Base
   def subgroups
     Group.where(:parent_id => id)
   end
+end
+
+class Team < ActiveRecord::Base
+  #resourcify done during specs setup to be able to use custom user classes
+  self.primary_key = "team_code"
+  
+  default_scope order(:team_code)
 end

data/spec/support/adapters/mongoid.rb

@@ -2,10 +2,6 @@ require 'mongoid'
 
 Mongoid.load!("spec/support/adapters/mongoid.yml", :test)
 
-RSpec.configure do |config|
-  config.include Mongoid::Matchers
-end
-
 ::Mongoid::Document.module_eval do
   def self.included(base)
     base.extend Rolify
@@ -137,3 +133,11 @@ class Group
     Group.in(:parent_id => _id)
   end
 end
+
+class Team
+  include Mongoid::Document
+  #resourcify done during specs setup to be able to use custom user classes
+
+  field :team_code, :type => Integer
+  field :name, :type => String
+end

data/spec/support/data.rb

@@ -20,3 +20,6 @@ Forum.create(:name => "forum 3")
 
 Group.create(:name => "group 1")
 Group.create(:name => "group 2")
+
+Team.create(:team_code => "1", :name => "PSG")
+Team.create(:team_code => "2", :name => "MU")

data/spec/support/schema.rb

@@ -44,4 +44,9 @@ ActiveRecord::Schema.define do
     t.integer :parent_id
     t.string :name
   end
+  
+  create_table(:teams, :id => false) do |t|
+    t.primary_key :team_code
+    t.string :name
+  end
 end