rolify 3.3.0.rc3 → 3.3.0

data/lib/rolify.rb

@@ -9,20 +9,23 @@ require 'rolify/adapters/base'
 module Rolify
   extend Configure
 
-  attr_accessor :role_cname, :adapter, :role_table_name
+  attr_accessor :role_cname, :adapter, :role_join_table_name, :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}"
+    default_join_table = "#{self.to_s.tableize.gsub(/\//, "_")}_#{self.role_table_name}"
+    options.reverse_merge!({:role_join_table_name => default_join_table})
+    self.role_join_table_name = options[:role_join_table_name]
+
     rolify_options = { :class_name => options[:role_cname].camelize }
-    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"
+    rolify_options.merge!({ :join_table => self.role_join_table_name }) if Rolify.orm == "active_record"
+    rolify_options.merge!(options.reject{ |k,v| ![ :before_add, :after_add, :before_remove, :after_remove ].include? k.to_sym })
 
     has_and_belongs_to_many :roles, rolify_options
 
@@ -32,22 +35,22 @@ module Rolify
 
   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] }
     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
     require "rolify/adapters/#{Rolify.orm}/scopes.rb"
-    extend Rolify::Adapter::Scopes 
+    extend Rolify::Adapter::Scopes
   end
-  
+
   def role_class
     self.role_cname.constantize
   end

data/rolify.gemspec

@@ -15,23 +15,16 @@ Gem::Specification.new do |s|
   s.rubyforge_project = s.name
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
-    s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
-  else
-    s.add_development_dependency "sqlite3"
-    s.add_development_dependency "bson_ext" if RUBY_VERSION < "2.0.0"
-  end
-  s.add_development_dependency "activerecord", ">= 3.1.0"
-  s.add_development_dependency "mongoid", ">= 3.0"
   s.add_development_dependency "ammeter"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", ">= 2.0"
   s.add_development_dependency "rspec-rails", ">= 2.0"
-  s.add_development_dependency "mongoid-rspec", ">= 1.5"
-  s.add_development_dependency "bundler" 
-  s.add_development_dependency "fuubar"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "fuubar" 
+  s.add_development_dependency "activerecord", ">= 3.2.0"
+  s.add_development_dependency "mongoid", ">= 3.1"
 end

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/{rolify_generator_spec.rb → rolify_activerecord_generator_spec.rb}

@@ -1,9 +1,10 @@
 require 'generators_helper'
 
+require 'rails/all'
 # Generators are not automatically loaded by Rails
 require 'generators/rolify/rolify_generator'
 
-describe Rolify::Generators::RolifyGenerator do
+describe Rolify::Generators::RolifyGenerator, :if => ENV['ADAPTER'] == 'active_record' 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
@@ -22,10 +23,10 @@ describe Rolify::Generators::RolifyGenerator do
     before { 
       capture(:stdout) {
         generator.create_file "app/models/user.rb" do
-<<-RUBY
-  class User < ActiveRecord::Base
-  end
-RUBY
+          <<-RUBY
+          class User < ActiveRecord::Base
+          end
+          RUBY
         end
       }
       require File.join(destination_root, "app/models/user.rb")
@@ -114,13 +115,13 @@ RUBY
     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
+          <<-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")
@@ -159,96 +160,4 @@ RUBY
       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
-<<-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 })"}
-    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/rolify/rolify_mongoid_generator_spec.rb

@@ -0,0 +1,112 @@
+require 'generators_helper'
+
+require 'mongoid'
+
+# 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 })"}
+    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

@@ -5,10 +5,17 @@ require 'rolify'
 require 'rolify/matchers'
 require 'rails/all'
 
+require 'coveralls'
+Coveralls.wear_merged!
+
 module TestApp
   class Application < ::Rails::Application
     config.root = File.dirname(__FILE__)
   end
 end
 
-require 'ammeter/init'
+require 'ammeter/init'
+
+ENV['ADAPTER'] ||= 'active_record'
+
+

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,20 @@ 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 }
+  def 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 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

@@ -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 }
@@ -34,9 +38,16 @@ describe Rolify::Resource 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
           subject.with_role(:godfather).should =~ Forum.all.to_a
         end
+        
+        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
@@ -127,7 +138,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 +345,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_callbacks.rb

@@ -12,7 +12,9 @@ shared_examples_for "Rolify.callbacks" do
   describe "rolify association callbacks", :if => (Rolify.orm == "active_record") do
     describe "before_add" do
       it "should receive callback" do
-        user_class.rolify :before_add => :role_callback, :role_cname => role_class.to_s
+        rolify_options = { :role_cname => role_class.to_s, :before_add => :role_callback }
+        rolify_options[:role_join_table_name] = join_table if defined? join_table
+        user_class.rolify rolify_options
         @user = user_class.first
         @user.stub(:role_callback)
         @user.should_receive(:role_callback)
@@ -22,7 +24,9 @@ shared_examples_for "Rolify.callbacks" do
 
     describe "after_add" do
       it "should receive callback" do
-        user_class.rolify :after_add => :role_callback, :role_cname => role_class.to_s
+        rolify_options = { :role_cname => role_class.to_s, :after_add => :role_callback }
+        rolify_options[:role_join_table_name] = join_table if defined? join_table
+        user_class.rolify rolify_options
         @user = user_class.first
         @user.stub(:role_callback)
         @user.should_receive(:role_callback)
@@ -32,7 +36,9 @@ shared_examples_for "Rolify.callbacks" do
 
     describe "before_remove" do
       it "should receive callback" do
-        user_class.rolify :before_remove => :role_callback, :role_cname => role_class.to_s
+        rolify_options = { :role_cname => role_class.to_s, :before_remove => :role_callback }
+        rolify_options[:role_join_table_name] = join_table if defined? join_table
+        user_class.rolify rolify_options
         @user = user_class.first
         @user.add_role :admin
         @user.stub(:role_callback)
@@ -44,7 +50,9 @@ shared_examples_for "Rolify.callbacks" do
 
     describe "after_remove" do
       it "should receive callback" do
-        user_class.rolify :after_remove => :role_callback, :role_cname => role_class.to_s
+        rolify_options = { :role_cname => role_class.to_s, :after_remove => :role_callback }
+        rolify_options[:role_join_table_name] = join_table if defined? join_table
+        user_class.rolify rolify_options
         @user = user_class.first
         @user.add_role :admin
         @user.stub(:role_callback)