lib/.svn/entries lib/.svn/format lib/.svn/text-base/acts_as_checkpoint.rb.svn-base tasks/.svn/entries tasks/.svn/format tasks/.svn/text-base/acts_as_checkpoint_tasks.rake.svn-base test/.svn/entries test/.svn/format test/.svn/text-base/acts_as_checkpoint_test.rb.svn-base test/database.yml test/fixtures/projects.yml test/fixtures/roles.yml test/fixtures/users.yml test/models/project.rb test/models/role.rb test/models/user.rb test/schema.rb test/test_helper.rb @@ -8,56 +8,56 @@ Example for Controllers Role-oriented approach: -class YourController < ApplicationController - acts_as_checkpoint :get_user_method => :current_user - controller_allows :administrator, :to => [ :index, :show, :destroy ] - controller_allows :registered_user, :to => [ :index, :show, :new, :edit, :create, :update ] - controller_allows :anonymous_user, :to => [ :index, :show ] -end + class YourController < ApplicationController + acts_as_checkpoint :get_user_method => :current_user + controller_allows :administrator, :to => [ :index, :show, :destroy ] + controller_allows :registered_user, :to => [ :index, :show, :new, :edit, :create, :update ] + controller_allows :anonymous_user, :to => [ :index, :show ] + end Action-oriented approach: -class YourController < ApplicationController - acts_as_checkpoint :get_user_method => :current_user - controller_allows :index , :by => [ :administrator, :registered_user, :anonymous_user ] - controller_allows :show , :by => [ :administrator, :registered_user ] - controller_allows :new , :by => :registered_user - controller_allows :edit , :by => :registered_user - controller_allows :create , :by => :registered_user - controller_allows :update , :by => :registered_user - controller_allows :destroy, :by => :administrator -end + class YourController < ApplicationController + acts_as_checkpoint :get_user_method => :current_user + controller_allows :index , :by => [ :administrator, :registered_user, :anonymous_user ] + controller_allows :show , :by => [ :administrator, :registered_user ] + controller_allows :new , :by => :registered_user + controller_allows :edit , :by => :registered_user + controller_allows :create , :by => :registered_user + controller_allows :update , :by => :registered_user + controller_allows :destroy, :by => :administrator + end The two approaches may be interspersed at will... just try not to get confused. Example for Models ================== -class Dog < ActiveRecord::Base - belongs_to :owner + class Dog < ActiveRecord::Base + belongs_to :owner - acts_as_checkpoint - model_may :eat, :drink, :lick - model_allows :lick, :by => :self - model_allows :pet, :by => :owner -end + acts_as_checkpoint + model_may :eat, :drink, :lick + model_allows :lick, :by => :self + model_allows :pet, :by => :owner + end -class Human < ActiveRecord::Base - has_many :dogs + class Human < ActiveRecord::Base + has_many :dogs - acts_as_checkpoint - model_may :pet - model_allows :lick, :by => :dogs -end + acts_as_checkpoint + model_may :pet + model_allows :lick, :by => :dogs + end -human = Human.new -dog = Dog.new( :owner => human ) + human = Human.new + dog = Dog.new( :owner => human ) -human.can_pet?( dog ) -# => true -dog.can_eat?( human ) -# => false -dog.can_lick?( human ) -# => true + human.can_pet?( dog ) + # => true + dog.can_eat?( human ) + # => false + dog.can_lick?( human ) + # => true Copyright (c) 2008 Brian Langenfeld, released under the MIT license README @@ -1,8 +1,151 @@ -require 'test/unit' +require "#{File.dirname(__FILE__)}/test_helper" + +include Knotfield::Acts::Checkpoint::Model class ActsAsCheckpointTest < Test::Unit::TestCase - # Replace this with your real tests. - def test_this_plugin - flunk + + def setup + @admin = Role.create( :name => 'Administrator' ) + @superuser = Role.create( :name => 'Superuser' ) + @user = Role.create( :name => 'Registered User' ) + @guest = Role.create( :name => 'Guest' ) + + @housework = Project.create( :name => 'Housework' ) + @yardwork = Project.create( :name => 'Yardwork' ) + + @aaron = User.create( + :name => 'Aaron the Admin', + :roles => [ @user, @superuser, @admin ] + ) + @steve = User.create( + :name => 'Steve the Superuser', + :roles => [ @user, @superuser ], + :projects_owned => [ @housework ], + :projects_joined => [ @housework ] + ) + @umberto = User.create( + :name => 'Umberto the User', + :roles => [ @user ], + :projects_owned => [ @yardwork ], + :projects_joined => [ @yardwork, @housework ] + ) + @gary = User.create( + :name => 'Gary', + :roles => [ @guest ], + :projects_joined => [ @yardwork ] + ) + end + + # Make sure all of our test data is set up properly. + def test_data + assert_not_nil Project.first, "Projects not loaded" + assert_not_nil Role.first, "Roles not loaded" + assert_not_nil User.first, "Users not loaded" + + assert_equal true , @aaron.admin? + assert_equal true , @aaron.superuser? + assert_equal true , @aaron.user? + assert_equal false, @aaron.guest? + + assert_equal false, @steve.admin? + assert_equal true , @steve.superuser? + assert_equal true , @steve.user? + assert_equal false, @steve.guest? + + assert_equal false, @umberto.admin? + assert_equal false, @umberto.superuser? + assert_equal true , @umberto.user? + assert_equal false, @umberto.guest? + + assert_equal false, @gary.admin? + assert_equal false, @gary.superuser? + assert_equal false, @gary.user? + assert_equal true , @gary.guest? + + assert_equal 1, @admin.users.length + assert_equal 2, @superuser.users.length + assert_equal 3, @user.users.length + assert_equal 1, @guest.users.length + + assert_equal 0, @aaron.projects_owned.length + assert_equal 1, @steve.projects_owned.length + assert_equal 1, @umberto.projects_owned.length + assert_equal 0, @gary.projects_owned.length + + assert_equal 0, @aaron.projects_joined.length + assert_equal 1, @steve.projects_joined.length + assert_equal 2, @umberto.projects_joined.length + assert_equal 1, @gary.projects_joined.length + + assert_equal @steve, @housework.owner + assert_equal @umberto, @yardwork.owner + + assert_equal 2, @housework.helpers.count + assert @housework.helpers.include?( @steve ) + assert @housework.helpers.include?( @umberto ) + assert_equal 2, @yardwork.helpers.length + assert @yardwork.helpers.include?( @umberto ) + assert @yardwork.helpers.include?( @gary ) + end + + # These tests all deal with role-based permission checks. + def test_role_based_checkpoint_model_methods + # Aaron should be able to do anything but destroy himself. + assert_equal true, @aaron.can_view?( @aaron ) + assert_equal true, @aaron.can_edit?( @aaron ) + assert_equal false, @aaron.can_destroy?( @aaron ) + + # Aaron should be able to do anything he wants to anyone else. + assert_equal true, @aaron.can_view?( @steve ) + assert_equal true, @aaron.can_edit?( @steve ) + assert_equal true, @aaron.can_destroy?( @steve ) + + # Steve should be able to do anything but destroy himself. + assert_equal true, @steve.can_view?( @steve ) + assert_equal true, @steve.can_edit?( @steve ) + assert_equal false, @steve.can_destroy?( @steve ) + + # Steve can only view Aaron, because Aaron outranks him. + assert_equal true, @steve.can_view?( @aaron ) + assert_equal false, @steve.can_edit?( @aaron ) + assert_equal false, @steve.can_destroy?( @aaron ) + + # Steve can view or edit anyone else, though. + assert_equal true, @steve.can_view?( @umberto ) + assert_equal true, @steve.can_edit?( @umberto ) + assert_equal false, @steve.can_destroy?( @umberto ) + + # Umberto should be able to do anything but destroy himself. + assert_equal true, @umberto.can_view?( @umberto ) + assert_equal true, @umberto.can_edit?( @umberto ) + assert_equal false, @umberto.can_destroy?( @umberto ) + + # Umberto is playing with fire here... + assert_equal true, @umberto.can_view?( @aaron ) + assert_equal false, @umberto.can_edit?( @aaron ) + assert_equal false, @umberto.can_destroy?( @aaron ) + + # Umberto outranks Gary, but lacks superuser or admin. + assert_equal true, @umberto.can_view?( @gary ) + assert_equal false, @umberto.can_edit?( @gary ) + assert_equal false, @umberto.can_destroy?( @gary ) + end + + # These tests all deal with association-based permission checks. + def test_association_based_checkpoint_model_methods + # Steve is the owner of the housework project. + assert_equal true, @steve.can_view?( @housework ) + assert_equal true, @steve.can_edit?( @housework ) + assert_equal true, @steve.can_destroy?( @housework ) + + # Gary is one of the Yardwork project's helpers, but does not own it. + assert_equal true, @gary.can_view?( @yardwork ) + assert_equal false, @gary.can_edit?( @yardwork ) + assert_equal false, @gary.can_destroy?( @yardwork ) + + # Steve neither owns nor helps on the Yardwork project. + assert_equal false, @steve.can_view?( @yardwork ) + assert_equal false, @steve.can_edit?( @yardwork ) + assert_equal false, @steve.can_destroy?( @yardwork ) end end test/acts_as_checkpoint_test.rb cc6a589f10b359db835969b4602b143e3ccfe148 Brian Langenfeld blangenfeld@gmail.com http://github.com/blangenfeld/acts_as_checkpoint/commit/b9fc773a6aba8053ef5adc6a06b252acbcd30398 b9fc773a6aba8053ef5adc6a06b252acbcd30398 2008-08-13T23:11:11-07:00 2008-08-13T23:11:11-07:00 Added tests for Knotfield::Acts::Checkpoint::Model. aab2d03ee92f649d80f4edde36facd2201a1f603 Brian Langenfeld blangenfeld@gmail.com