generators/permissable/permissible_generator.rb generators/permissable/templates/acts_as_permissible.rb generators/permissable/templates/acts_as_permissible_spec.rb tasks/acts_as_permissible_tasks.rake test/acts_as_permissible_test.rb @@ -5,20 +5,20 @@ This plugin enables any activerecord model to have permissions. It provides a set of methods for querying the model's permissions. In addition, the plugin can generate roles support, which turns in into a full RBAC (Role Based Access Control) solution. -Any model which includes the line "acts_as_permissable" can have permissions, and with roles support it can also have roles which in turn have their own permissions. +Any model which includes the line "acts_as_permissible" can have permissions, and with roles support it can also have roles which in turn have their own permissions. Roles can also belong to roles, which creates a sort of inheritance hierarchy. When permissions are calculated, the model's permissions are merged with the model's role permissions (if any), which in turn are merged with the role's roles permissions, until a finite permissions hash is generated. In the case of identical keys, a false value overrides a true value. A nil value is false. Setup ===== -script/generate permissable <PermissionModelName> [RoleModelName] +script/generate permissible <PermissionModelName> [RoleModelName] The role model name is optional. If you do not want the roles support generated, use the --skip-roles option. -examples: script/generate permissable Permission Role - script/generate permissable Permission Group - script/generate permissable Allowance --skip-roles +examples: script/generate permissible Permission Role + script/generate permissible Permission Group + script/generate permissible Allowance --skip-roles use --skip-migration if you don't want a migration created for the permissions model. @@ -31,7 +31,7 @@ Add role->role relationships in your roles_memberships table. Important ========= -add these lines to any model which acts_as_permissable and has roles: +add these lines to any model which acts_as_permissible and has roles: has_many :role_memberships, :as => :roleable has_many :roles, :through => :role_memberships @@ -46,7 +46,7 @@ Usage ===== class User < Activerecord::Base - acts_as_permissable + acts_as_permissible end Now a user will have the following methods: @@ -76,4 +76,4 @@ Copyright (c) 2008 Noam Ben-Ari, released under the MIT license # TODO: - # acts_as_permissable_system that includes controller stuff like before_filters. + # acts_as_permissible_system that includes controller stuff like before_filters. README @@ -5,17 +5,17 @@ require 'rake/rdoctask' desc 'Default: run unit tests.' task :default => :test -desc 'Test the acts_as_permissable plugin.' +desc 'Test the acts_as_permissible plugin.' Rake::TestTask.new(:test) do |t| t.libs << 'lib' t.pattern = 'test/**/*_test.rb' t.verbose = true end -desc 'Generate documentation for the acts_as_permissable plugin.' +desc 'Generate documentation for the acts_as_permissible plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' - rdoc.title = 'ActsAsPermissable' + rdoc.title = 'ActsAsPermissible' rdoc.options << '--line-numbers' << '--inline-source' rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') Rakefile @@ -1 +1 @@ -./script/generate permissable PermissionsModelName \ No newline at end of file +./script/generate permissible PermissionsModelName \ No newline at end of file generators/permissable/USAGE @@ -1,48 +1,48 @@ one: id: 1 - permissable_id: 7 - permissable_type: "<%= class_name %>" + permissible_id: 7 + permissible_type: "<%= class_name %>" action: "view_something" granted: 1 two: id: 2 - permissable_id: 7 - permissable_type: "<%= class_name %>" + permissible_id: 7 + permissible_type: "<%= class_name %>" action: "delete_something" granted: 0 three: id: 3 - permissable_id: 8 - permissable_type: "<%= class_name %>" + permissible_id: 8 + permissible_type: "<%= class_name %>" action: "view_something" granted: 1 four: id: 4 - permissable_id: 8 - permissable_type: "<%= class_name %>" + permissible_id: 8 + permissible_type: "<%= class_name %>" action: "delete_something" granted: 1 five: id: 5 - permissable_id: 8 - permissable_type: "<%= class_name %>" + permissible_id: 8 + permissible_type: "<%= class_name %>" action: "update_something" granted: 1 six: id: 6 - permissable_id: 8 - permissable_type: "<%= class_name %>" + permissible_id: 8 + permissible_type: "<%= class_name %>" action: "create_something" granted: 0 perm: id: 7 - permissable_id: 47 - permissable_type: "User" + permissible_id: 47 + permissible_type: "User" action: "non_important" granted: 1 perm2: id: 8 - permissable_id: 48 - permissable_type: "User" + permissible_id: 48 + permissible_type: "User" action: "non_important" granted: 1 \ No newline at end of file generators/permissable/templates/fixtures.yml @@ -1,2 +1,2 @@ -require 'lib/acts_as_permissable' -ActiveRecord::Base.send(:include, NoamBenAri::Acts::Permissable) \ No newline at end of file +require 'lib/acts_as_permissible' +ActiveRecord::Base.send(:include, NoamBenAri::Acts::Permissible) \ No newline at end of file generators/permissable/templates/initializer.rb @@ -1,8 +1,8 @@ class <%= migration_name %> < ActiveRecord::Migration def self.up create_table "<%= table_name %>", :force => true do |t| - t.integer :permissable_id - t.string :permissable_type + t.integer :permissible_id + t.string :permissible_type t.string :action t.boolean :granted generators/permissable/templates/migration.rb @@ -1,14 +1,14 @@ class <%= class_name %> < ActiveRecord::Base # uncomment any of the following lines which is relevant to your application, - # or create your own with the name of the model which acts_as_permissable. + # or create your own with the name of the model which acts_as_permissible. #belongs_to :user belongs_to :<%= role_model_file_name %> - belongs_to :permissable, :polymorphic => true + belongs_to :permissible, :polymorphic => true - validates_presence_of :permissable_id, :permissable_type, :action + validates_presence_of :permissible_id, :permissible_type, :action validates_format_of :action, :with => /^[a-z_]+$/ - validates_numericality_of :permissable_id - validates_uniqueness_of :action, :scope => [:permissable_id,:permissable_type] + validates_numericality_of :permissible_id + validates_uniqueness_of :action, :scope => [:permissible_id,:permissible_type] def to_hash self.new_record? ? {} : {self.action => self.granted} generators/permissable/templates/model.rb @@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper' describe <%= class_name %>, "to_hash" do before(:each) do - @permission = <%= class_name %>.new(:permissable_id => 1, :permissable_type => "User", :action => "some_action", :granted => 1) + @permission = <%= class_name %>.new(:permissible_id => 1, :permissible_type => "User", :action => "some_action", :granted => 1) end it "to_hash returns {} if new record" do @@ -18,26 +18,26 @@ end describe <%= class_name %>, "validations" do before(:each) do - @permission = <%= class_name %>.new(:permissable_id => 1, :permissable_type => "User", :action => "some_action", :granted => 1) + @permission = <%= class_name %>.new(:permissible_id => 1, :permissible_type => "User", :action => "some_action", :granted => 1) end it "should be valid" do @permission.should be_valid end - it "action should be unique to a permissable id and type" do + it "action should be unique to a permissible id and type" do @permission.save - @permission2 = <%= class_name %>.new(:permissable_id => 1, :permissable_type => "User", :action => "some_action", :granted => 0) + @permission2 = <%= class_name %>.new(:permissible_id => 1, :permissible_type => "User", :action => "some_action", :granted => 0) @permission2.should_not be_valid end - it "must have a permissable_id" do - @permission.permissable_id = nil + it "must have a permissible_id" do + @permission.permissible_id = nil @permission.should_not be_valid end - it "must have a permissable_type" do - @permission.permissable_type = nil + it "must have a permissible_type" do + @permission.permissible_type = nil @permission.should_not be_valid end generators/permissable/templates/model_spec.rb @@ -8,5 +8,5 @@ class <%= role_model_name %> < ActiveRecord::Base validates_uniqueness_of :name - acts_as_permissable + acts_as_permissible end \ No newline at end of file generators/permissable/templates/role_model.rb generators/permissable/permissable_generator.rb generators/permissable/templates/acts_as_permissable.rb generators/permissable/templates/acts_as_permissable_spec.rb tasks/acts_as_permissable_tasks.rake test/acts_as_permissable_test.rb b6bc36298b3889fb1929c0264140130ea471e80d Noam Ben-Ari nbenari@gmail.com http://github.com/NoamB/acts_as_permissible/commit/0b2bee7f27bbe607b6ee398027c3531765b99b72 0b2bee7f27bbe607b6ee398027c3531765b99b72 2008-05-09T16:19:35-07:00 2008-05-09T16:19:35-07:00 changed spelling error permissable to permissible. 513c0c00de72e6c2473552e89c65663ca74dbb01 Noam Ben-Ari nbenari@gmail.com