roleable 0.2.0 → 0.2.1

data/CHANGELOG

@@ -4,4 +4,16 @@
 
 ## v0.0.2
 
-* Fix a bug that allowed users not associated with a resource to be listed in Resource#users_with_role.
+* Fix a bug that allowed users not associated with a resource to be listed in Resource#users_with_role.
+
+## v0.1.0
+
+* Allow resource_with_role and users_with_role to accept an array of role names.
+
+## v0.2.0
+
+* Allow the subject class name to be customized so that it does not always have to be "User".
+
+## v0.2.1
+
+* Ensure applied_roles are destroyed when an associated subject or resource is destroyed.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/mcrowe/roleable.png?branch=master)](http://travis-ci.org/mcrowe/roleable)
 
-A flexible roles solution for active-record-backed Rails 3 applications. Allows for multiple roles scoped to instances of any model, as well as global roles (admin, for example). 
+A flexible roles solution for active-record-backed Rails 3 applications. Allows for multiple roles scoped to instances of any model, as well as global roles (admin, for example).
 
 Roleable is designed to be ultra simple and obvious, letting you build upon it to satisfy your needs. It is also designed to be efficient: using database indices, and well-crafted queries so that it can handle a huge number of roles.
 
@@ -21,15 +21,15 @@ And then execute:
 Run the generator to create the `Role` and `AppliedRole` models, migrations, and a configuration initializer:
 
     $ rails g roleable:install
-    
+
 And then run the migrations:
 
     $ rake db:migrate
-    
+
 (This will create the `roles` and `applied_roles` tables, together with the appropriate database indices.)
 
 ## Setup
-    
+
 Include `Roleable::Subject` into your subject model, e.g.:
 
 ```ruby
@@ -37,7 +37,7 @@ class User < ActiveRecord::Base
   include Roleable::Subject
   ...
 end
-```  
+```
 
 Include `Roleable::Resource` into any models you want to relate a subject role to (resource), e.g.:
 
@@ -67,11 +67,11 @@ Remove a role:
 ```ruby
 # global
 user.remove_role(:admin)
-  
+
 # resource-scoped
 user.remove_role(:editor, page)
 ```
-  
+
 Query a role:
 
 ```ruby
@@ -81,7 +81,7 @@ user.has_role?(:admin)
 # resource-scoped
 user.has_role?(:editor, page)
 ```
-  
+
 Find the resources of a given class for which a user has a given role:
 
 ```ruby
@@ -105,7 +105,7 @@ Or, all the global roles for a user:
 ```ruby
 user.roles_for_resource(nil)
 ```
-  
+
 ### Resource
 
 Find subjects (users) with a given role:
@@ -114,6 +114,12 @@ Find subjects (users) with a given role:
 page.subjects_with_role(:editor)
 ```
 
+Find subjects matching _any_ of a list of roles:
+
+```ruby
+page.subjects_with_role([:editor, :author])
+```
+
 ## Customization
 
 By default, roleable assumes that your subject model is called `User`. You can customize this by modifying the generated configuration intializer located at `config/initializers/roleable.rb`, e.g.:
@@ -124,14 +130,8 @@ Roleable.configure do |config|
 end
 ```
 
-Find users matching _any_ of a list of roles:
-
-```ruby
-page.users_with_role([:editor, :author])
-```
-
 For more details check out the [API documentation](http://rubydoc.info/github/mcrowe/roleable/master/frames) on rubydoc.info.
- 
+
 ## Requirements
 
 Rails 3, ActiveRecord, Ruby >= 1.8.7
@@ -142,4 +142,4 @@ Rails 3, ActiveRecord, Ruby >= 1.8.7
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/generators/roleable/install/install_generator.rb

@@ -13,11 +13,11 @@ module Roleable
         copy_file 'initializer.rb', 'config/initializers/roleable.rb'
         migration_template 'migration.rb', 'db/migrate/roleable_create_roles_and_applied_roles.rb'
       end
-      
+
       def self.next_migration_number(path)
         Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
-      
+
     end
   end
-end
+end

data/lib/generators/roleable/install/templates/applied_role.rb

@@ -1,5 +1,5 @@
 class AppliedRole < ActiveRecord::Base
-  
+
   extend Roleable::AppliedRole
-  
-end
+
+end

data/lib/generators/roleable/install/templates/migration.rb

@@ -1,8 +1,8 @@
 class RoleableCreateRolesAndAppliedRoles < ActiveRecord::Migration
-  
+
   def change
     create_table :roles do |t|
-      t.string :name      
+      t.string :name
       t.timestamps
     end
 
@@ -12,9 +12,9 @@ class RoleableCreateRolesAndAppliedRoles < ActiveRecord::Migration
       t.references :resource, :polymorphic => true
       t.timestamps
     end
-    
+
     add_index :applied_roles, :subject_id
     add_index :applied_roles, [:resource_type, :resource_id]
   end
-  
-end
+
+end

data/lib/generators/roleable/install/templates/role.rb

@@ -1,5 +1,5 @@
 class Role < ActiveRecord::Base
-  
+
   extend Roleable::Role
-  
-end
+
+end

data/lib/roleable.rb

@@ -6,13 +6,13 @@ require 'roleable/applied_role'
 require 'roleable/configuration'
 
 module Roleable
-  
+
   def self.configuration
     @configuration ||= Roleable::Configuration.new
   end
-  
+
   def self.configure
     yield configuration if block_given?
   end
-  
-end
+
+end

data/lib/roleable/applied_role.rb

@@ -1,10 +1,10 @@
 module Roleable::AppliedRole
-  
+
   def self.extended(base)
     base.belongs_to :subject, :class_name => Roleable.configuration.subject_class_name
     base.belongs_to :role
     base.belongs_to :resource, :polymorphic => true
-    
+
     base.attr_accessible :role, :subject_id, :resource
   end
 
@@ -29,18 +29,18 @@ module Roleable::AppliedRole
   def with_resource_class(resource_class)
     where(:resource_type => resource_type_from_class(resource_class))
   end
-  
+
   # Create a record with the given attributes if there are no records
   # that already have those attributes.
   #
   # Returns the record if it was saved, otherwise nil.
-  def create_if_unique!(attributes)  
+  def create_if_unique!(attributes)
     applied_role = new(attributes)
 
-    record_attributes = applied_role.attributes.reject do |k, v| 
+    record_attributes = applied_role.attributes.reject do |k, v|
       %w(id updated_at created_at).include?(k)
     end
-    
+
     if !exists?(record_attributes) && applied_role.save
       applied_role
     else
@@ -57,5 +57,5 @@ module Roleable::AppliedRole
   def resource_type_from_class(resource_class)
     resource_class.name
   end
-  
-end
+
+end

data/lib/roleable/configuration.rb

@@ -1,9 +1,9 @@
 class Roleable::Configuration
-  
+
   attr_accessor :subject_class_name
 
   def initialize
     @subject_class_name = 'User'
   end
-    
-end
+
+end

data/lib/roleable/resource.rb

@@ -1,7 +1,7 @@
 module Roleable::Resource
 
   def self.included(base)
-    base.has_many :applied_roles, :as => :resource
+    base.has_many :applied_roles, :as => :resource, :dependent => :destroy
   end
 
   # Return a list of users that have the given role for this resource.
@@ -16,11 +16,11 @@ module Roleable::Resource
     subject_class.joins(:applied_roles).
       merge( ::AppliedRole.with_role_name(role_name).with_resource(self) )
   end
-  
+
   private
-  
+
   def subject_class
     Roleable.configuration.subject_class_name.classify.constantize
   end
-  
-end
+
+end

data/lib/roleable/role.rb

@@ -1,9 +1,9 @@
 module Roleable::Role
 
-  def self.extended(base) 
+  def self.extended(base)
     base.has_many :applied_roles
 
     base.attr_accessible :name
   end
-  
-end
+
+end

data/lib/roleable/subject.rb

@@ -1,7 +1,7 @@
 module Roleable::Subject
-  
+
   def self.included(base)
-    base.has_many :applied_roles, :foreign_key => 'subject_id'
+    base.has_many :applied_roles, :foreign_key => 'subject_id', :dependent => :destroy
   end
 
   # Add a role to the subject scoped to the given resource or global if no resource given.
@@ -16,8 +16,8 @@ module Roleable::Subject
   #
   def add_role(role_name, resource = nil)
     role = ::Role.find_by_name(role_name) or return
-    
-    ::AppliedRole.create_if_unique!(:subject_id => self.id, :role => role, :resource => resource)    
+
+    ::AppliedRole.create_if_unique!(:subject_id => self.id, :role => role, :resource => resource)
   end
 
   # Check if the subject has the given role for the given resource, or if they have the role globally
@@ -37,7 +37,7 @@ module Roleable::Subject
       with_role_name(role_name).
       exists?
   end
-  
+
   # Remove the given role from the subject for the given resource, or globally if no resource given.
   #
   # Returns <tt>true</tt> if the role was found and deleted, <tt>false</tt> otherwise.
@@ -49,12 +49,12 @@ module Roleable::Subject
   #
   def remove_role(role_name, resource = nil)
     applied_roles = ::AppliedRole.with_subject(self).with_resource(resource).with_role_name(role_name)
-    
+
     deleted_count = applied_roles.delete_all
-        
+
     deleted_count > 0
   end
-  
+
   # Return a list of resources of the given class, for which the subject has the given role.
   # If passed an array or roles, returns resources for which the subject has any of the roles.
   #
@@ -67,16 +67,16 @@ module Roleable::Subject
     applied_roles = ::AppliedRole.with_subject(self).with_role_name(role_name).with_resource_class(resource_class)
     resource_class.includes(:applied_roles).merge(applied_roles)
   end
-  
+
   # Return a list of roles that the subject has for the given resource.
   #
   # ==== Examples
   #
   #   user.roles_for_resource(page)   # => [role1, role2, ...]
-  #  
+  #
   def roles_for_resource(resource)
-    applied_roles = ::AppliedRole.with_subject(self).with_resource(resource)    
+    applied_roles = ::AppliedRole.with_subject(self).with_resource(resource)
     ::Role.includes(:applied_roles).merge(applied_roles)
   end
-  
-end
+
+end

data/lib/roleable/version.rb

@@ -1,3 +1,3 @@
 module Roleable
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/roleable.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "roleable"
   gem.require_paths = ["lib"]
   gem.version       = Roleable::VERSION
-  
+
   gem.add_development_dependency 'rake', '~> 0.9'
   gem.add_development_dependency 'rspec', '~> 2.8'
   gem.add_development_dependency 'sqlite3', '~> 1.3'

data/spec/roleable/resource_spec.rb

@@ -3,62 +3,72 @@ require 'spec_helper'
 describe Roleable::Resource do
 
   include_context 'with models'
-  
+
+  before do
+    @page = Page.create
+    @editor_role = Role.create(:name => 'editor')
+    @author_role = Role.create(:name => 'author')
+  end
+
   describe '#subjects_with_role' do
-    
-    before do
-      @page = Page.create
-      @editor_role = Role.create(:name => 'editor')
-      @author_role = Role.create(:name => 'author')
-    end
 
     context 'with a single role' do
-      
+
       context 'with a role that doesnt exist' do
         it 'returns an empty list' do
           @page.subjects_with_role(:notarole).should be_empty
         end
       end
-    
+
       context 'when multiple users have the given role' do
-      
+
         before do
           3.times { User.create.add_role(:editor, @page) }
-        end        
-        
+        end
+
 
-        it 'returns a list of the users' do    
+        it 'returns a list of the users' do
           users = @page.subjects_with_role(:editor)
-        
+
           users.length.should == 3
           users.first.should be_a(User)
         end
-      
+
         it 'doesnt return users that dont have the role' do
           other_page = Page.create
           other_user = User.create.add_role(:editor, other_page)
 
           users = @page.subjects_with_role(:editor)
-        
+
           users.length.should == 3
         end
-      
+
       end
-      
+
     end
-    
+
     context 'with a list of roles' do
       it 'returns a list of users that have any of the given roles for this resource' do
         3.times { User.create.add_role(:editor, @page) }
         2.times { User.create.add_role(:author, @page) }
         User.create
-        
+
         users = @page.subjects_with_role([:editor, :author])
-      
+
         users.length.should == 5
       end
     end
-    
+
   end
   
-end
+  describe '#destroy' do
+    
+    it 'destroys any associated applied_roles' do
+      User.create.add_role(:editor, @page)
+
+      expect { @page.destroy }.to change { AppliedRole.count}.by(-1)
+    end
+    
+  end
+
+end

data/spec/roleable/subject_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Roleable::Subject do
 
   include_context 'with models'
-    
+
   before do
     @user = User.create
     @admin_role = Role.create(:name => 'admin')
@@ -12,66 +12,66 @@ describe Roleable::Subject do
   end
 
   describe '#add_role' do
-  
+
     context 'with a role that doesnt exist' do
-    
+
       before do
         @result = @user.add_role(:notarole)
       end
-    
+
       it 'returns false' do
         @result.should be_false
       end
-    
+
       it 'doesnt create a new applied_role' do
         AppliedRole.count.should == 0
       end
-    
+
     end
-  
+
     context 'without a resource' do
-  
+
       before do
         @user_role = @user.add_role(:admin)
       end
-  
+
       it 'creates a new user role' do
         AppliedRole.count.should == 1
       end
-    
+
       it 'associates the user role with the given user' do
         @user_role.subject.should == @user
-      end          
+      end
 
       it 'associates the user role with the given role' do
         @user_role.role.should == @admin_role
       end
-    
+
       it 'sets the resource to nil' do
         @user_role.resource.should == nil
       end
-      
+
     end
-  
+
     context 'with a resource' do
-    
+
       before do
         @page = Page.create
         @user_role = @user.add_role(:admin, @page)
       end
-    
+
       it 'associates the user role with the given resource' do
         @user_role.resource.should == @page
       end
-      
+
       context 'when the user already has the given role for the resource' do
         it 'doesnt create another user role' do
           expect { @user.add_role(:admin, @page) }.to_not change(AppliedRole, :count)
         end
       end
-          
+
     end
-  
+
   end
 
   describe '#has_role?' do
@@ -83,47 +83,47 @@ describe Roleable::Subject do
     end
 
     context 'without a resource' do
-    
-      context 'when the user DOESNT have the given role' do    
+
+      context 'when the user DOESNT have the given role' do
         it 'is false' do
           @user.has_role?(:admin).should be_false
         end
       end
-    
+
       context 'when the user DOES have the given role' do
         it 'is true' do
           @user.add_role(:admin)
           @user.has_role?(:admin).should be_true
         end
       end
-    
+
     end
-  
+
     context 'with a resource' do
- 
+
       before do
         @page = Page.create
       end
-    
+
       context 'when the user DOESNT have the role for that resource' do
         it 'is false' do
           @user.has_role?(:editor, @page).should be_false
         end
       end
-    
+
       context 'when the user DOES have the role for that resource' do
         it 'is true' do
           @user.add_role(:editor, @page)
           @user.has_role?(:editor, @page).should be_true
         end
       end
-    
+
     end
-  
+
   end
 
   describe '#remove_role' do
-  
+
     context 'global' do
 
       context 'when the user doesnt have the role' do
@@ -131,69 +131,69 @@ describe Roleable::Subject do
           @user.remove_role(:admin).should be_false
         end
       end
-      
+
       context 'when the role doesnt exist' do
         it 'is false' do
           @user.remove_role(:notarole).should be_false
         end
       end
-    
+
       context 'when the user has the given role' do
-      
+
         before do
           @user.add_role(:admin)
           @result = @user.remove_role(:admin)
         end
-      
+
         it 'is true' do
           @result.should be_true
         end
-      
+
         it 'removes the given role' do
           @user.has_role?(:admin).should be_false
         end
-      
+
       end
-    
+
     end
-  
+
   end
 
   describe '#resources_with_role' do
-  
+
     context 'with a single role' do
-    
+
       context 'when the user has the given role for several resources of the given class' do
         it 'returns a list containing those resources' do
           3.times { @user.add_role(:editor, Page.create) }
-      
+
           pages = @user.resources_with_role(:editor, Page)
-        
+
           pages.length.should == 3
           pages.first.should be_a(Page)
         end
       end
-  
+
       context 'when the user doesnt have the given role for any resources of the given class' do
         it 'returns an empty list' do
-          @user.resources_with_role(:editor, Page).should be_empty        
+          @user.resources_with_role(:editor, Page).should be_empty
         end
       end
-      
+
     end
-    
+
     context 'with a list of roles' do
       it 'returns a list of resources the user has those roles for' do
         3.times { @user.add_role(:editor, Page.create) }
         2.times { @user.add_role(:author, Page.create) }
         Page.create
-        
+
         pages = @user.resources_with_role([:editor, :author], Page)
-        
-        pages.length.should == 5        
+
+        pages.length.should == 5
       end
     end
-  
+
   end
 
   describe '#roles_for_resource' do
@@ -201,11 +201,21 @@ describe Roleable::Subject do
       page = Page.create
       @user.add_role(:editor, page)
       @user.add_role(:admin, page)
-    
+
       roles = @user.roles_for_resource(page)
       roles.length.should == 2
       roles.first.should be_a(Role)
     end
   end
-  
+
+  describe '#destroy' do
+    
+    it 'destroys any associated applied_roles' do
+      @user.add_role(:admin)
+
+      expect { @user.destroy }.to change { AppliedRole.count}.by(-1)
+    end
+    
+  end
+
 end

data/spec/spec_helper.rb

@@ -10,6 +10,6 @@ Dir['spec/support/**/*.rb'].each { |f| require File.expand_path("../../#{f}", __
 
 RSpec.configure do |config|
   config.extend WithModel
-  
+
   ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-end
+end

data/spec/support/shared_contexts.rb

@@ -19,10 +19,10 @@ shared_context 'with models' do
       t.integer :role_id
       t.integer :resource_id
       t.string :resource_type
-      
+
       t.timestamps
     end
     model { extend Roleable::AppliedRole }
   end
-  
-end
+
+end

metadata

@@ -1,78 +1,108 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: roleable
-version: !ruby/object:Gem::Version
-  version: 0.2.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
-authors:
+authors: 
 - Mitch Crowe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2162720700 !ruby/object:Gem::Requirement
+
+date: 2012-05-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  prerelease: false
+  name: rake
+  version_requirements: *id001
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
   prerelease: false
-  version_requirements: *2162720700
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2162719820 !ruby/object:Gem::Requirement
+  version_requirements: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.8'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   prerelease: false
-  version_requirements: *2162719820
-- !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2162719040 !ruby/object:Gem::Requirement
+  version_requirements: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   prerelease: false
-  version_requirements: *2162719040
-- !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2162718020 !ruby/object:Gem::Requirement
+  version_requirements: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
   prerelease: false
-  version_requirements: *2162718020
-- !ruby/object:Gem::Dependency
   name: with_model
-  requirement: &2162717140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.2'
+  version_requirements: *id005
   type: :development
-  prerelease: false
-  version_requirements: *2162717140
 description: Roles solution for active-record-backed Rails 3 applications
-email:
+email: 
 - crowe.mitch@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
@@ -99,37 +129,41 @@ files:
 - spec/roleable/subject_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_contexts.rb
+has_rdoc: true
 homepage: https://github.com/mcrowe/roleable
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 3443296545749404592
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 3443296545749404592
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.3.9.4
 signing_key: 
 specification_version: 3
 summary: Roles solution for active-record-backed Rails 3 applications
-test_files:
+test_files: 
 - spec/roleable/resource_spec.rb
 - spec/roleable/subject_spec.rb
 - spec/spec_helper.rb