aegis 1.1.3 → 1.1.4

data/README.rdoc

@@ -5,13 +5,13 @@ Aegis allows you to manage fine-grained, complex permission for user accounts in
 == Installation
 
 Add the following to your <tt>Initializer.run</tt> block in your <tt>environment.rb</tt>:
-    config.gem 'makandra-aegis', :lib => 'aegis', :source => 'http://gems.github.com'
+    config.gem 'aegis', :source => 'http://gemcutter.org'
 Then do a 
     sudo rake gems:install
 
 Alternatively, use
-    sudo gem sources -a http://gems.github.com
-    sudo gem install makandra-aegis
+    sudo gem sources -a http://gemcutter.org
+    sudo gem install aegis
 
 == Example 
 
@@ -169,8 +169,20 @@ role, the later one always wins. That is
     end
 will work as expected.
 
+=== Our stance on multiple roles per user
+
+We believe that you should only distinguish roles that have different ways of resolving their permissions. A typical set of roles would be
+
+* anonymous guest (has access to nothing with some exceptions)
+* signed up user (has access to some things depending on its attributes and associations)
+* administrator (has access to everything)
+
+We don't do multiple, parametrized roles like "leader for project #2" and "author of post #7". 
+That would be reinventing associations. Just use a single :user role and let your permission block
+query regular associations and attributes.
+
 === Credits
 
 Henning Koch, Tobias Kraze
 
-{link www.makandra.de}[http://www.makandra.de/]
+{link www.makandra.de}[http://www.makandra.de/]

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.4

data/aegis.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aegis}
-  s.version = "1.1.3"
+  s.version = "1.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Henning Koch"]
-  s.date = %q{2009-10-15}
+  s.date = %q{2009-11-05}
   s.description = %q{Aegis is a role-based permission system, where all users are given a role. It is possible to define detailed and complex permissions for each role very easily.}
   s.email = %q{github@makandra.de}
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "test/app_root/app/models/permissions.rb",
      "test/app_root/app/models/soldier.rb",
      "test/app_root/app/models/user.rb",
+     "test/app_root/app/models/user_subclass.rb",
      "test/app_root/config/boot.rb",
      "test/app_root/config/database.yml",
      "test/app_root/config/environment.rb",
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/app_root/app/models/permissions.rb",
      "test/app_root/app/models/soldier.rb",
+     "test/app_root/app/models/user_subclass.rb",
      "test/app_root/app/models/user.rb",
      "test/app_root/app/controllers/application_controller.rb",
      "test/app_root/config/environment.rb",

data/lib/aegis/has_role.rb

@@ -21,15 +21,17 @@ module Aegis
     
       self.class_eval do
       
-        @aegis_role_name_reader = (options[:name_reader] || "role_name").to_sym
-        @aegis_role_name_writer = (options[:name_writer] || "role_name=").to_sym
-        
+        class_inheritable_accessor :aegis_role_name_reader, :aegis_role_name_writer
+
+        self.aegis_role_name_reader = (options[:name_reader] || "role_name").to_sym
+        self.aegis_role_name_writer = (options[:name_writer] || "role_name=").to_sym
+
         def aegis_role_name_reader
-          self.class.class_eval{ @aegis_role_name_reader }
+          self.class.class_eval{ aegis_role_name_reader }
         end
 
         def aegis_role_name_writer
-          self.class.class_eval{ @aegis_role_name_writer }
+          self.class.class_eval{ aegis_role_name_writer }
         end
 
         def aegis_role_name

data/lib/aegis.rb

@@ -1,9 +1,10 @@
 # Include hook code here
 require 'aegis/constants'
+require 'aegis/has_role'
 require 'aegis/normalization'
 require 'aegis/permission_error'
-require 'aegis/role'
+require 'aegis/permission_evaluator'
 require 'aegis/permissions'
-require 'aegis/has_role'
+require 'aegis/role'
 require 'rails/active_record'
 

data/test/app_root/app/models/user_subclass.rb

@@ -0,0 +1,2 @@
+class UserSubclass < User
+end

data/test/has_role_test.rb

@@ -7,12 +7,14 @@ class HasRoleTest < ActiveSupport::TestCase
     setup do 
       @guest = User.new(:role_name => "guest")
       @student = User.new(:role_name => "student")
+      @student_subclass = UserSubclass.new(:role_name => "student")
       @admin = User.new(:role_name => "admin")
     end
     
     should "know their role" do
       assert :guest, @guest.role.name
       assert :student, @student.role.name
+      assert :student_subclass, @student.role.name
       assert :admin, @admin.role.name
     end
     
@@ -21,8 +23,11 @@ class HasRoleTest < ActiveSupport::TestCase
       assert !@guest.student?
       assert !@guest.admin?
       assert !@student.guest?
+      assert !@student_subclass.guest?
       assert @student.student?
+      assert @student_subclass.student?
       assert !@student.admin?
+      assert !@student_subclass.admin?
       assert !@admin.guest?
       assert !@admin.student?
       assert @admin.admin?

data/test/permissions_test.rb

@@ -7,18 +7,21 @@ class PermissionsTest < ActiveSupport::TestCase
     setup do 
       @guest = User.new(:role_name => "guest")
       @student = User.new(:role_name => "student")
+      @student_subclass = UserSubclass.new(:role_name => "student")
       @admin = User.new(:role_name => "admin")
     end
     
     should "use the default permission for actions without any allow or grant directives" do
       assert !@guest.may_use_empty?
       assert !@student.may_use_empty?
+      assert !@student_subclass.may_use_empty?
       assert @admin.may_use_empty?
     end
     
     should "understand simple allow and deny directives" do
       assert !@guest.may_use_simple?
       assert @student.may_use_simple?
+      assert @student_subclass.may_use_simple?
       assert !@admin.may_use_simple?
     end
     
@@ -34,6 +37,7 @@ class PermissionsTest < ActiveSupport::TestCase
     should 'do nothing if an allowed action is queried with an exclamation mark' do
       assert_nothing_raised do
         @student.may_use_simple!
+        @student_subclass.may_use_simple!
       end
     end
     
@@ -41,49 +45,62 @@ class PermissionsTest < ActiveSupport::TestCase
       assert !@guest.may_update_users?
       assert !@guest.may_update_user?("foo")
       assert @student.may_update_users?
+      assert @student_subclass.may_update_users?
       assert @student.may_update_user?("foo")
+      assert @student_subclass.may_update_user?("foo")
       assert !@admin.may_update_users?
       assert !@admin.may_update_user?("foo")
     end
     
     should 'implicate create, read, update and destroy forms for actions named "crud_..."' do
       assert @student.may_create_projects?
+      assert @student_subclass.may_create_projects?
       assert @student.may_read_projects?
+      assert @student_subclass.may_read_projects?
       assert @student.may_update_projects?
+      assert @student_subclass.may_update_projects?
       assert @student.may_destroy_projects?
+      assert @student_subclass.may_destroy_projects?
     end
     
     should 'perform normalization of CRUD verbs (e.g. "edit" and "update")' do
       assert !@guest.may_edit_drinks?
       assert @student.may_edit_drinks?
+      assert @student_subclass.may_edit_drinks?
       assert !@admin.may_edit_drinks?
       assert !@guest.may_update_drinks?
       assert @student.may_update_drinks?
+      assert @student_subclass.may_update_drinks?
       assert !@admin.may_update_drinks?
     end
     
     should "be able to grant or deny actions to all roles using :everyone" do
       assert @guest.may_hug?
       assert @student.may_hug?
+      assert @student_subclass.may_hug?
       assert @admin.may_hug?
     end
     
     should "allow the definition of parametrized actions" do
       assert !@guest.may_divide?(10, 2)
       assert @student.may_divide?(10, 2)
+      assert @student_subclass.may_divide?(10, 2)
       assert !@student.may_divide?(10, 0)
+      assert !@student_subclass.may_divide?(10, 0)
       assert @admin.may_divide?(10, 2)
       assert @admin.may_divide?(10, 0)
     end
     
     should 'use default permissions for undefined actions' do
       !@student.may_do_undefined_stuff?("foo")
+      !@student_subclass.may_do_undefined_stuff?("foo")
       @admin.may_do_undefined_stuff?("foo")
     end
     
     should 'overshadow previous action definitions with the same name' do
       assert @guest.may_draw?
       assert !@student.may_draw?
+      assert !@student_subclass.may_draw?
       assert !@admin.may_draw?
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aegis
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors: 
 - Henning Koch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +02:00
+date: 2009-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - test/app_root/app/models/permissions.rb
 - test/app_root/app/models/soldier.rb
 - test/app_root/app/models/user.rb
+- test/app_root/app/models/user_subclass.rb
 - test/app_root/config/boot.rb
 - test/app_root/config/database.yml
 - test/app_root/config/environment.rb
@@ -91,6 +92,7 @@ summary: Role-based permissions for your user models.
 test_files: 
 - test/app_root/app/models/permissions.rb
 - test/app_root/app/models/soldier.rb
+- test/app_root/app/models/user_subclass.rb
 - test/app_root/app/models/user.rb
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/config/environment.rb