aegis 1.1.4 → 1.1.5

data/README.rdoc

@@ -89,6 +89,13 @@ Aegis assumes that the corresponding database table has a string-valued column
 called +role_name+. You may override the name with the <tt>:name_accessor =>
 :my_role_column</tt> option.
 
+You can define a default role for a model by saying
+    class User < ActiveRecord::Base
+      has_role :default => :admin
+    end
+All this will do, is initialize the +role_name+ with the given default when
++User.new+ is called.
+
 The roles and permissions themselves are defined in a class inheriting from
 <b>Aegis::Permissions</b>. To define roles you create a model <tt>permissions.rb</tt>
 and use the *role* method:

data/VERSION

@@ -1 +1 @@
-1.1.4
+1.1.5

data/aegis.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aegis}
-  s.version = "1.1.4"
+  s.version = "1.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Henning Koch"]
-  s.date = %q{2009-11-05}
+  s.date = %q{2009-11-11}
   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 = [
@@ -29,10 +29,13 @@ Gem::Specification.new do |s|
      "lib/aegis/role.rb",
      "lib/rails/active_record.rb",
      "test/app_root/app/controllers/application_controller.rb",
+     "test/app_root/app/models/old_soldier.rb",
      "test/app_root/app/models/permissions.rb",
      "test/app_root/app/models/soldier.rb",
+     "test/app_root/app/models/trust_fund_kid.rb",
      "test/app_root/app/models/user.rb",
      "test/app_root/app/models/user_subclass.rb",
+     "test/app_root/app/models/veteran_soldier.rb",
      "test/app_root/config/boot.rb",
      "test/app_root/config/database.yml",
      "test/app_root/config/environment.rb",
@@ -44,6 +47,8 @@ Gem::Specification.new do |s|
      "test/app_root/config/routes.rb",
      "test/app_root/db/migrate/20090408115228_create_users.rb",
      "test/app_root/db/migrate/20090429075648_create_soldiers.rb",
+     "test/app_root/db/migrate/20091110075648_create_veteran_soldiers.rb",
+     "test/app_root/db/migrate/20091110075649_create_trust_fund_kids.rb",
      "test/app_root/lib/console_with_fixtures.rb",
      "test/app_root/log/.gitignore",
      "test/app_root/script/console",
@@ -59,9 +64,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Role-based permissions for your user models.}
   s.test_files = [
-    "test/app_root/app/models/permissions.rb",
+    "test/app_root/app/models/trust_fund_kid.rb",
+     "test/app_root/app/models/veteran_soldier.rb",
+     "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/old_soldier.rb",
      "test/app_root/app/models/user.rb",
      "test/app_root/app/controllers/application_controller.rb",
      "test/app_root/config/environment.rb",
@@ -74,6 +82,8 @@ Gem::Specification.new do |s|
      "test/app_root/config/routes.rb",
      "test/app_root/db/migrate/20090429075648_create_soldiers.rb",
      "test/app_root/db/migrate/20090408115228_create_users.rb",
+     "test/app_root/db/migrate/20091110075649_create_trust_fund_kids.rb",
+     "test/app_root/db/migrate/20091110075648_create_veteran_soldiers.rb",
      "test/app_root/lib/console_with_fixtures.rb",
      "test/validation_test.rb",
      "test/test_helper.rb",

data/lib/aegis/has_role.rb

@@ -13,18 +13,33 @@ module Aegis
 
     def has_role(options = {})
     
-      if options[:name_accessor]
-        options[:name_reader] = "#{options[:name_accessor]}"
-        options[:name_writer] = "#{options[:name_accessor]}="
-        options.delete(:name_accessor)
+      # Legacy parameter names
+      options[:accessor] ||= options.delete(:name_accessor)
+      options[:reader] ||= options.delete(:name_reader)
+      options[:writer] ||= options.delete(:name_writer)
+    
+      if options[:accessor]
+        options[:reader] = "#{options[:accessor]}"
+        options[:writer] = "#{options[:accessor]}="
+        options.delete(:accessor)
       end
     
       self.class_eval do
       
-        class_inheritable_accessor :aegis_role_name_reader, :aegis_role_name_writer
+        class_inheritable_accessor :aegis_role_name_reader, :aegis_role_name_writer, :aegis_default_role_name
 
-        self.aegis_role_name_reader = (options[:name_reader] || "role_name").to_sym
-        self.aegis_role_name_writer = (options[:name_writer] || "role_name=").to_sym
+        unless method_defined?(:after_initialize)
+          def after_initialize
+          end
+        end
+
+        if options[:default]
+          self.aegis_default_role_name = options[:default].to_s
+          after_initialize :set_default_aegis_role_name
+        end
+        
+        self.aegis_role_name_reader = (options[:reader] || "role_name").to_sym
+        self.aegis_role_name_writer = (options[:writer] || "role_name=").to_sym
 
         def aegis_role_name_reader
           self.class.class_eval{ aegis_role_name_reader }
@@ -70,6 +85,12 @@ module Aegis
         
         alias_method_chain :method_missing, :aegis_permissions
         
+        def set_default_aegis_role_name
+          if new_record?
+            self.aegis_role_name ||= self.class.aegis_default_role_name
+          end
+        end
+        
       end
 
     end

data/lib/aegis/permissions.rb

@@ -10,7 +10,6 @@ module Aegis
     end    
 
     module ClassMethods
-    
  
       def role(role_name, options = {})
         role_name = role_name.to_sym
@@ -53,8 +52,8 @@ module Aegis
       end
       
       def evaluate_permission_blocks(role, blocks, *args)
-    evaluator = Aegis::PermissionEvaluator.new(role)
-    evaluator.evaluate(blocks, args)
+        evaluator = Aegis::PermissionEvaluator.new(role)
+        evaluator.evaluate(blocks, args)
       end
       
       def denied?(*args)

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

@@ -0,0 +1,6 @@
+class VeteranSoldier < ActiveRecord::Base
+
+  # Use legacy parameter :name_accessor instead of :accessor
+  has_role :name_accessor => "rank"
+
+end

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

@@ -1,5 +1,5 @@
 class Soldier < ActiveRecord::Base
 
-  has_role :name_accessor => "rank"
+  has_role :accessor => "rank"
 
 end

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

@@ -0,0 +1,5 @@
+class TrustFundKid < ActiveRecord::Base
+
+  has_role :default => :admin
+
+end

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

@@ -0,0 +1,6 @@
+class VeteranSoldier < ActiveRecord::Base
+
+  # Using legacy parameter names
+  has_role :name_accessor => "rank"
+
+end

data/test/app_root/db/migrate/20090408115228_create_users.rb

@@ -2,7 +2,7 @@ class CreateUsers < ActiveRecord::Migration
 
   def self.up
     create_table :users do |t|
-      t.string "role_name"
+      t.string :role_name
       t.timestamps
     end
   end

data/test/app_root/db/migrate/20090429075648_create_soldiers.rb

@@ -1,12 +1,10 @@
 class CreateSoldiers < ActiveRecord::Migration
 
   def self.up
-  
     create_table :soldiers do |t|
       t.string :rank
       t.timestamps
     end
-    
   end
 
   def self.down

data/test/app_root/db/migrate/20091110075648_create_veteran_soldiers.rb

@@ -0,0 +1,14 @@
+class CreateVeteranSoldiers < ActiveRecord::Migration
+
+  def self.up
+    create_table :veteran_soldiers do |t|
+      t.string :rank
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :veteran_soldiers
+  end
+  
+end

data/test/app_root/db/migrate/20091110075649_create_trust_fund_kids.rb

@@ -0,0 +1,15 @@
+class CreateTrustFundKids < ActiveRecord::Migration
+
+  def self.up
+    create_table :trust_fund_kids do |t|
+      t.string :role_name
+      t.integer :account_balance
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :trust_fund_kids
+  end
+  
+end

data/test/has_role_options_test.rb

@@ -10,11 +10,12 @@ class HasRoleOptionsTest < ActiveSupport::TestCase
     
     should "allow its role to be written and read" do
       @soldier.role = "guest"
-      assert "guest", @soldier.role.name
+      assert_equal :guest, @soldier.role.name
     end
     
     should "store the role name in the custom field" do
-      assert "guest", @soldier.rank
+      @soldier.role = "guest"
+      assert_equal "guest", @soldier.rank
     end
     
     should "still work with permissions" do
@@ -25,4 +26,35 @@ class HasRoleOptionsTest < ActiveSupport::TestCase
     
   end
 
+  context "A record wiring up its role using legacy parameter names" do
+
+    setup do 
+      @vetaran_soldier = VeteranSoldier.new
+    end
+    
+    should "allow its role to be written and read" do
+      @vetaran_soldier.role = "guest"
+      assert_equal :guest, @vetaran_soldier.role.name
+    end
+    
+  end
+  
+  context "A record with a default role" do
+  
+    should "create new instances with that role" do
+      assert_equal :admin, TrustFundKid.new.role.name
+    end
+  
+    should "ignore the default if another role is given" do
+      assert_equal :student, TrustFundKid.new(:role_name => "student").role.name
+    end
+    
+    should "not update existing records with the default role" do
+      kid = TrustFundKid.create!(:role_name => "student")
+      kid.update_attributes(:account_balance => 10_000_000)
+      assert_equal :student, kid.reload.role.name
+    end
+  
+  end
+
 end

data/test/has_role_test.rb

@@ -12,10 +12,10 @@ class HasRoleTest < ActiveSupport::TestCase
     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
+      assert_equal :guest, @guest.role.name
+      assert_equal :student, @student.role.name
+      assert_equal :student, @student_subclass.role.name
+      assert_equal :admin, @admin.role.name
     end
     
     should "know if they belong to a role" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aegis
 version: !ruby/object:Gem::Version 
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors: 
 - Henning Koch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 +01:00
+date: 2009-11-11 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -38,10 +38,13 @@ files:
 - lib/aegis/role.rb
 - lib/rails/active_record.rb
 - test/app_root/app/controllers/application_controller.rb
+- test/app_root/app/models/old_soldier.rb
 - test/app_root/app/models/permissions.rb
 - test/app_root/app/models/soldier.rb
+- test/app_root/app/models/trust_fund_kid.rb
 - test/app_root/app/models/user.rb
 - test/app_root/app/models/user_subclass.rb
+- test/app_root/app/models/veteran_soldier.rb
 - test/app_root/config/boot.rb
 - test/app_root/config/database.yml
 - test/app_root/config/environment.rb
@@ -53,6 +56,8 @@ files:
 - test/app_root/config/routes.rb
 - test/app_root/db/migrate/20090408115228_create_users.rb
 - test/app_root/db/migrate/20090429075648_create_soldiers.rb
+- test/app_root/db/migrate/20091110075648_create_veteran_soldiers.rb
+- test/app_root/db/migrate/20091110075649_create_trust_fund_kids.rb
 - test/app_root/lib/console_with_fixtures.rb
 - test/app_root/log/.gitignore
 - test/app_root/script/console
@@ -90,9 +95,12 @@ signing_key:
 specification_version: 3
 summary: Role-based permissions for your user models.
 test_files: 
+- test/app_root/app/models/trust_fund_kid.rb
+- test/app_root/app/models/veteran_soldier.rb
 - 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/old_soldier.rb
 - test/app_root/app/models/user.rb
 - test/app_root/app/controllers/application_controller.rb
 - test/app_root/config/environment.rb
@@ -105,6 +113,8 @@ test_files:
 - test/app_root/config/routes.rb
 - test/app_root/db/migrate/20090429075648_create_soldiers.rb
 - test/app_root/db/migrate/20090408115228_create_users.rb
+- test/app_root/db/migrate/20091110075649_create_trust_fund_kids.rb
+- test/app_root/db/migrate/20091110075648_create_veteran_soldiers.rb
 - test/app_root/lib/console_with_fixtures.rb
 - test/validation_test.rb
 - test/test_helper.rb