roles 0.0.5 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## v0.1.0 (Sep 2, 2012)
+- add spec test set
+- fix duplicate records in `resources#users_with_role`, `users#resources_with_role` and `users#with_role`
+- fix roles records not destroyed when user destroyed
+
+## v0.0.5 (Aug 23, 2012)
+- fix user_cname nil problem in User class
+
+## v0.0.4 (Aug 23, 2012)
+- fix method name error(roles -> rolify)
+
+## v0.0.3 (Aug 23, 2012)
+- fix generator error
+
+## v0.0.2 (Aug 19, 2012)
+- rename `user.resources` to `user.resources_with_role`
+
+## v0.0.1 (Aug 17, 2012)
+- first release

data/lib/generators/roles/role/templates/role-active_record.rb

@@ -2,4 +2,5 @@ class <%= role_cname.camelize %> < ActiveRecord::Base
   belongs_to :<%= user_cname.tableize.singularize %>
   belongs_to :resource, :polymorphic => true
   
+  validates_uniqueness_of :name, :scope => [:<%= user_cname.underscore.singularize %>_id, :resource_type, :resource_id]
 end

data/lib/roles.rb

@@ -12,7 +12,7 @@ module Roles
     options.reverse_merge!({:role_cname => 'Role'})
     options.reverse_merge!({:user_cname => 'User'})
 
-    roles_options = { :class_name => options[:role_cname].camelize }
+    roles_options = { :class_name => options[:role_cname].camelize, :dependent => :destroy }
     roles_options.merge!(options.select{ |k,v| [:before_add, :after_add, :before_remove, :after_remove].include? k.to_sym })
 
     has_many :roles, roles_options

data/lib/roles/resource.rb

@@ -7,18 +7,18 @@ module Roles
     module ClassMethods 
       def users_with_role(role_name = nil)
         if role_name.nil?
-          self.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL")
+          self.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL")
         else
-          self.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL").where("roles.name LIKE '%s'", role_name.to_s)
+          self.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL").where("roles.name LIKE '%s'", role_name.to_s)
         end
       end
     end
 
     def users_with_role(role_name = nil)
       if role_name.nil?
-        self.class.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id)
+        self.class.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id)
       else
-        self.class.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id).where("roles.name LIKE '%s'", role_name.to_s)
+        self.class.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id).where("roles.name LIKE '%s'", role_name.to_s)
       end
     end
   end

data/lib/roles/role.rb

@@ -7,11 +7,11 @@ module Roles
     module ClassMethods
       def with_role(role_name, resource = nil)
         if resource.nil?
-          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type IS NULL").where("roles.resource_id IS NULL")
+          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type IS NULL").where("roles.resource_id IS NULL")
         elsif resource.is_a? Class
-          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type = '%s'", resource.to_s).where("roles.resource_id IS NULL")
+          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type LIKE '%s'", resource.to_s).where("roles.resource_id IS NULL")
         else
-          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type = '%s'", resource.to_s).where("roles.resource_id = %s", resource.id)
+          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type LIKE '%s'", resource.class.to_s).where("roles.resource_id = %s", resource.id)
         end
       end
     end
@@ -65,9 +65,9 @@ module Roles
 
     def resources_with_role(resource_class, role_name = nil)
       if role_name.nil?
-        resource_class.joins(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s)
+        resource_class.includes(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s)
       else
-        resource_class.joins(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s).where("roles.name LIKE '%s'", role_name.to_s)
+        resource_class.includes(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s).where("roles.name LIKE '%s'", role_name.to_s)
       end
     end
 

data/lib/roles/version.rb

@@ -1,3 +1,3 @@
 module Roles
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/roles.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency "sqlite3"
   end
   s.add_development_dependency "activerecord", ">= 3.1.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"

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

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+# Generators are not automatically loaded by Rails
+require 'generators/roles/role/role_generator'
+
+describe Roles::Generators::RoleGenerator 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 'no arguments' do
+    before(:all) { arguments [] }
+
+    before { 
+      capture(:stdout) {
+        generator.create_file "app/models/user.rb" do
+          "class User < ActiveRecord::Base\nend"
+        end
+      }
+      run_generator 
+    }
+    
+    describe 'app/models/role.rb' do
+      subject { file('app/models/role.rb') }
+      it { should exist }
+      it { should contain "class Role < ActiveRecord::Base" }
+      it { should contain "belongs_to :user" }
+      it { should contain "belongs_to :resource, :polymorphic => true" }
+      it { should contain "validates_uniqueness_of :name, :scope => [:user_id, :resource_type, :resource_id]" }
+    end
+    
+    describe 'app/models/user.rb' do
+      subject { file('app/models/user.rb') }
+      it { should contain /class User < ActiveRecord::Base\n  rolify\n/ }
+    end
+    
+    describe 'migration file' do
+      subject { migration_file('db/migrate/roles_create_roles.rb') }
+      
+      it { should be_a_migration }
+      it { should contain "create_table(:roles) do" }
+    end
+  end
+
+  describe 'specifying user and role names' do
+    before(:all) { arguments %w(AdminRole AdminUser) }
+    
+    before { 
+      capture(:stdout) {
+        generator.create_file "app/models/admin_user.rb" do
+          "class AdminUser < ActiveRecord::Base\nend"
+        end
+      }
+      run_generator
+    }
+    
+    describe 'app/models/rank.rb' do
+      subject { file('app/models/admin_role.rb') }
+      
+      it { should exist }
+      it { should contain "class AdminRole < ActiveRecord::Base" }
+      it { should contain "belongs_to :admin_user" }
+      it { should contain "belongs_to :resource, :polymorphic => true" }
+      it { should contain "validates_uniqueness_of :name, :scope => [:admin_user_id, :resource_type, :resource_id]" }
+    end
+    
+    describe 'app/models/admin_user.rb' do
+      subject { file('app/models/admin_user.rb') }
+      
+      it { should contain /class AdminUser < ActiveRecord::Base\n  rolify :role_cname => 'AdminRole'\n/ }
+    end
+    
+    describe 'migration file' do
+      subject { migration_file('db/migrate/roles_create_admin_roles.rb') }
+      
+      it { should be_a_migration }
+      it { should contain "create_table(:admin_roles)" }
+    end
+  end
+end

data/spec/roles/resource_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Roles::Resource do
+  before do
+    User.rolify :role_cname => "Role"
+    Forum.resourcify :role_cname => "Role"
+    Group.resourcify :role_cname => "Role"
+    reset_data
+  end
+
+  # Users
+  let(:admin)   { User.first }
+  let(:tourist) { User.last }
+
+  describe "#users_with_role" do
+    before do
+      admin.add_role(:moderator, Forum.first)
+      admin.add_role(:admin, Forum.first)
+      admin.add_role(:admin, Forum)
+      tourist.add_role(:moderator, Forum.first)
+    end
+
+    context "on a Forum instance" do
+      subject { Forum.first }
+      it { should respond_to :users_with_role }
+      specify { subject.users_with_role.should == [admin, tourist] }
+      specify { subject.users_with_role(:moderator).should == [admin, tourist] }
+      specify { subject.users_with_role(:admin).should == [admin] }
+      specify { subject.users_with_role(:teacher).should == [] }
+    end
+
+    context "on Forum class" do
+      specify { Forum.should respond_to :users_with_role }
+      specify { Forum.users_with_role.should == [admin] }
+      specify { Forum.users_with_role(:moderator).should == [] }
+      specify { Forum.users_with_role(:admin).should == [admin] }
+    end
+
+    context "on a Group instance" do
+      subject { Group.last }
+
+      context "when deleting a Group instance" do
+        subject do 
+          Group.create(:name => "to delete")
+        end
+        
+        before do
+          subject.roles.create :name => "group_role1", :user => admin
+          subject.roles.create :name => "group_role2", :user => tourist
+        end
+        
+        it "should remove the roles binded to this instance" do
+          expect { subject.destroy }.to change { Role.count }.by(-2)
+        end
+      end
+    end
+  end
+
+end

data/spec/roles/role_spec.rb

@@ -0,0 +1,173 @@
+require "spec_helper"
+
+describe Roles::Role do
+  before do
+    User.rolify :role_cname => "Role"
+    Forum.resourcify :role_cname => "Role"
+    Group.resourcify :role_cname => "Role"
+    reset_data
+
+    @admin = User.first
+    @tourist = User.last
+  end
+
+  describe "#with_role" do
+    before do
+      @admin.add_role(:admin)
+      @admin.add_role(:moderator, Forum.first)
+      @admin.add_role(:godfather, Forum)
+      @tourist.add_role(:moderator, Forum.first)
+    end
+
+    specify { User.should respond_to :with_role }
+    specify { User.with_role(:admin).should == [@admin] }
+    specify { User.with_role(:moderator, Forum.first).should == [@admin, @tourist] }
+    specify { User.with_role(:moderator, Forum).should == [] }
+    specify { User.with_role(:godfather, Forum).should == [@admin] }
+  end
+
+  describe ".add_role" do
+    it "should be able to add global role" do
+      @admin.add_role :moderator
+      @admin.has_role?(:moderator).should be_true
+    end
+
+    it "should be able to add role on Forum class" do
+      @admin.add_role :moderator, Forum
+      @admin.has_role?(:moderator, Forum).should be_true
+    end
+
+    it "should be able to add role on a Forum instance" do
+      @admin.add_role :moderator, Forum.first
+      @admin.has_role?(:moderator, Forum.first).should be_true
+    end
+
+    it "should not add duplicate roles" do
+      @admin.add_role :moderator
+      @admin.add_role :moderator
+      @admin.role_names.should == ["moderator"]
+
+      @admin.add_role :moderator, Forum
+      @admin.add_role :moderator, Forum
+      @admin.role_names(Forum).should == ["moderator"]
+
+      @admin.add_role :moderator, Forum.first
+      @admin.add_role :moderator, Forum.first
+      @admin.role_names(Forum.first).should == ["moderator"]
+    end
+  
+    it "should be use grant instead of add_role" do
+      @tourist.grant :admin
+      @tourist.has_role?(:admin).should be_true
+    end
+  end
+
+  describe ".remove_role" do
+    it "should be able to remove global role" do
+      @admin.add_role :moderator
+      @admin.has_role?(:moderator).should be_true
+      @admin.remove_role :moderator
+      @admin.has_role?(:moderator).should be_false
+    end
+
+    it "should be able to remove role on Forum class" do
+      @admin.add_role :moderator, Forum
+      @admin.has_role?(:moderator, Forum).should be_true
+      @admin.remove_role :moderator, Forum
+      @admin.has_role?(:moderator, Forum).should be_false
+    end
+
+    it "should be able to remove role on a Forum instance" do
+      @admin.add_role :moderator, Forum.first
+      @admin.has_role?(:moderator, Forum.first).should be_true
+      @admin.remove_role :moderator, Forum.first
+      @admin.has_role?(:moderator, Forum.first).should be_false
+    end
+
+    it "should be use revoke instead of remove_role" do
+      @tourist.grant :admin
+      @tourist.has_role?(:admin).should be_true
+      @tourist.revoke :admin
+      @tourist.has_role?(:admin).should be_false
+    end
+  end
+
+  describe ".has_role?" do
+    it "should be able to has_role? global role" do
+      @admin.add_role :moderator
+      @admin.add_role :teacher
+      @admin.has_role?(:moderator).should be_true
+      @admin.has_role?(:teacher).should be_true
+    end
+
+    it "should be able to has_role? on Forum class" do
+      @admin.add_role :moderator, Forum
+      @admin.add_role :teacher, Forum
+      @admin.has_role?(:moderator, Forum).should be_true
+      @admin.has_role?(:teacher, Forum).should be_true
+    end
+
+    it "should be able to has_role? on a Forum instance" do
+      @admin.add_role :moderator, Forum.first
+      @admin.add_role :teacher, Forum.first
+      @admin.has_role?(:moderator, Forum.first).should be_true
+      @admin.has_role?(:teacher, Forum.first).should be_true
+    end
+
+    it "should be use is_xxx instead of has_role?" do
+      @tourist.grant :admin
+      @tourist.has_role?(:admin).should be_true
+      @tourist.is_admin?.should be_true
+    end
+  end
+
+  describe ".role_names" do
+    it "should be able to list global role names" do
+      @admin.add_role :moderator
+      @admin.add_role :teacher
+      @admin.role_names.should == ["moderator", "teacher"]
+    end
+
+    it "should be able to list role names on Forum class" do
+      @admin.add_role :moderator, Forum
+      @admin.add_role :teacher, Forum
+      @admin.role_names(Forum).should == ["moderator", "teacher"]
+    end
+
+    it "should be able to list role names on a Forum instance" do
+      @admin.add_role :moderator, Forum.first
+      @admin.add_role :teacher, Forum.first
+      @admin.role_names(Forum.first).should == ["moderator", "teacher"]
+    end
+  end
+
+  describe ".resources_with_role" do
+    before do
+      @admin.add_role(:moderator, Forum.first)
+      @admin.add_role(:moderator, Forum.last)
+      @admin.add_role(:teacher, Forum.last)
+      @tourist.add_role(:moderator, Forum.first)
+    end
+
+    it "should be able to find all resources of which user has any role" do
+      @admin.resources_with_role(Forum).should == [Forum.first, Forum.last]
+    end
+
+    it "should be able to find all resources of which user has specific role" do
+      @admin.resources_with_role(Forum, :moderator).should == [Forum.first, Forum.last]
+      @admin.resources_with_role(Forum, :teacher).should == [Forum.last]
+    end
+  end
+
+  describe "roles get destroyed when user destroyed" do
+    before do
+      @admin.roles.create :name => "teacher"
+      @admin.roles.create :name => "moderator", :resource_type => "Forum"
+      @admin.roles.create :name => "admin", :resource => Forum.first
+    end
+    
+    it "should remove the roles binded to this instance" do
+      expect { @admin.destroy }.to change { Role.count }.by(-3)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require "bundler/setup"
+
+require 'roles'
+require 'ammeter/init'
+
+load File.dirname(__FILE__) + "/support/active_record.rb"
+
+def reset_data
+  User.destroy_all
+  Role.destroy_all
+  Forum.destroy_all
+  Group.destroy_all
+  Privilege.destroy_all
+  Customer.destroy_all
+
+  # Users
+  User.create(:login => "admin")
+  User.create(:login => "moderator")
+  User.create(:login => "god")
+  User.create(:login => "zombie")
+
+  Customer.create(:login => "admin")
+  Customer.create(:login => "moderator")
+  Customer.create(:login => "god")
+  Customer.create(:login => "zombie")
+
+  # Resources
+  Forum.create(:name => "forum 1")
+  Forum.create(:name => "forum 2")
+  Forum.create(:name => "forum 3")
+
+  Group.create(:name => "group 1")
+  Group.create(:name => "group 2")
+end

data/spec/support/active_record.rb

@@ -0,0 +1,32 @@
+require 'active_record'
+
+RSpec::Matchers::OperatorMatcher.register(ActiveRecord::Relation, '=~', RSpec::Matchers::BuiltIn::MatchArray)
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.extend Roles
+
+load File.dirname(__FILE__) + '/schema.rb'
+
+# ActiveRecord models
+class User < ActiveRecord::Base
+end
+
+class Role < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :resource, :polymorphic => true
+end
+
+class Forum < ActiveRecord::Base
+  #resourcify done during specs setup to be able to use custom user classes
+end
+
+class Group < ActiveRecord::Base
+  #resourcify done during specs setup to be able to use custom user classes
+end
+
+class Customer < ActiveRecord::Base
+end
+
+class Privilege < ActiveRecord::Base
+  belongs_to :customer
+  belongs_to :resource, :polymorphic => true
+end

data/spec/support/schema.rb

@@ -0,0 +1,33 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table(:roles) do |t|
+    t.string :name
+    t.references :resource, :polymorphic => true
+    t.references :user
+
+    t.timestamps
+  end
+
+  create_table(:users) do |t|
+    t.string :login
+  end
+
+  create_table(:forums) do |t|
+    t.string :name
+  end
+
+  create_table(:groups) do |t|
+    t.string :name
+  end
+
+  create_table(:privileges) do |t|
+    t.string :name
+    t.references :resource, :polymorphic => true
+    t.references :customer
+  end
+
+  create_table(:customers) do |t|
+    t.string :login
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roles
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -133,6 +149,12 @@ files:
 - lib/roles/role.rb
 - lib/roles/version.rb
 - roles.gemspec
+- spec/generators/roles/role/role_generator_spec.rb
+- spec/roles/resource_spec.rb
+- spec/roles/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/schema.rb
 homepage: http://github.com/liufengyun/roles
 licenses: []
 post_install_message: 
@@ -157,4 +179,10 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Roles library with resource scoping
-test_files: []
+test_files:
+- spec/generators/roles/role/role_generator_spec.rb
+- spec/roles/resource_spec.rb
+- spec/roles/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/schema.rb

data/CHANGELOG.rdoc

@@ -1,14 +0,0 @@
-= v0.0.5 (Aug 23, 2012)
-* fix user_cname nil problem in User class
-
-= v0.0.4 (Aug 23, 2012)
-* fix method name error(roles -> rolify)
-
-= v0.0.3 (Aug 23, 2012)
-* fix generator error
-
-= v0.0.2 (Aug 19, 2012)
-* rename `user.resources` to `user.resources_with_role`
-
-= v0.0.1 (Aug 17, 2012)
-* first release