acts_as_permission 1.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril Wack
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,10 @@
+MIT-LICENSE
+README.rdoc
+Rakefile
+VERSION.yml
+generators/acts_as_permission/USAGE
+generators/acts_as_permission/acts_as_permission_generator.rb
+init.rb
+lib/acts_as_permission.rb
+lib/permissions_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,49 @@
+= Acts as permission
+
+This Rails plugin provides a list of permissions attached to a resource, according to ACL concept.  Permissions determine specific access rights for a resource depending of its controller actions such as: show, edit, update, destroy, evaluated from the given resource and such as: index, new, create, evaluated from the parent of the given resource.
+
+Each permission field attributed to a resource can be defined as true, false or nil.  When a resource permission is set as nil, the same permission is searched from its nearest relative to its parent farthest and the first given boolean value is returned.  If permission is nil for a resource and its potential parents, then the method returns false.
+
+== Install
+
+Install the gem (recommended):
+
+  sudo gem install acts_as_permission
+
+Alternatively, you can install it as a Rails plugin:
+
+  script/plugin install git://github.com/cyril/acts_as_permission.git
+
+Generate and apply the migration:
+
+  script/generate acts_as_permission model
+  rake db:migrate
+
+== Example
+
+  script/generate acts_as_permission Category
+  script/generate acts_as_permission Article show edit update destroy
+  rake db:migrate
+
+  class Category < ActiveRecord::Base
+    acts_as_permission
+    belongs_to :user
+    has_many :articles
+  end
+
+  class Article < ActiveRecord::Base
+    acts_as_permission :category
+    belongs_to :category
+    belongs_to :user
+  end
+
+  # Check permission to list articles of the given category:
+  @category.has_permission?('index')
+
+  # Check permission to destroy the given article:
+  @article.has_permission?('destroy')
+
+  # Form helper that generate permissions fields for each article:
+  <%= permission_fields :article %>
+
+Copyright (c) 2009 Cyril Wack, released under the MIT license

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('acts_as_permission', '1.2.0') do |p|
+  p.description    = "Simple Rails plugin to assign a list of permissions on a resource."
+  p.url            = "http://github.com/cyril/acts_as_permission"
+  p.author         = "Cyril Wack"
+  p.email          = "cyril.wack@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 1
+:minor: 2
+:patch: 0

data/acts_as_permission.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_permission}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Wack"]
+  s.cert_chain = ["/Users/cyril/gem-public_cert.pem"]
+  s.date = %q{2010-04-12}
+  s.description = %q{Simple Rails plugin to assign a list of permissions on a resource.}
+  s.email = %q{cyril.wack@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/acts_as_permission.rb", "lib/permissions_helper.rb"]
+  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "VERSION.yml", "generators/acts_as_permission/USAGE", "generators/acts_as_permission/acts_as_permission_generator.rb", "init.rb", "lib/acts_as_permission.rb", "lib/permissions_helper.rb", "Manifest", "acts_as_permission.gemspec"]
+  s.homepage = %q{http://github.com/cyril/acts_as_permission}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_permission", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_permission}
+  s.rubygems_version = %q{1.3.6}
+  s.signing_key = %q{/Users/cyril/gem-private_key.pem}
+  s.summary = %q{Simple Rails plugin to assign a list of permissions on a resource.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/generators/acts_as_permission/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Alter the structure model in order to attache an access control list (ACL)
+    to its resources.
+
+Usage:
+    Pass the name of the model, and an optional list of controller actions.
+
+    If no controller actions is specified, those following will be generated:
+    index, show, new, create, edit, update and destroy.
+
+Examples:
+    script/generate acts_as_permission Article
+
+        Will alter the Article model table by adding a field for each seven
+        default actions (index, show, create, new, edit, update, and destroy).
+
+    script/generate acts_as_permission Category index new create
+
+        Will alter categories table with index, new and create action
+        permission fields.

data/generators/acts_as_permission/acts_as_permission_generator.rb

@@ -0,0 +1,40 @@
+class ActsAsPermissionGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @args = actions if @args.empty?
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration:migration.rb', "db/migrate", {:assigns => permissions_local_assigns, :migration_file_name => "add_permissions_fields_to_#{plural_name}"}
+    end
+  end
+
+  def class_name
+    name.camelize
+  end
+
+  def plural_name
+    custom_name = class_name.underscore.downcase
+    custom_name = custom_name.pluralize if ActiveRecord::Base.pluralize_table_names
+    custom_name
+  end
+
+  private
+
+  def actions
+    %w[index show new create edit update destroy]
+  end
+
+  def permissions_local_assigns
+    returning(assigns = {}) do
+      assigns[:migration_action] = "add"
+      assigns[:class_name] = "add_permissions_fields_to_#{plural_name}"
+      assigns[:table_name] = plural_name
+      assigns[:attributes] = []
+      @args.each do |action|
+        assigns[:attributes] << Rails::Generator::GeneratedAttribute.new("#{action}_permission", "boolean")
+      end
+    end
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_permission'

data/lib/acts_as_permission.rb

@@ -0,0 +1,51 @@
+require 'active_record/base'
+
+module ActsAsPermission
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    attr_accessor :parental_resource_permission
+
+    def acts_as_permission(resource = nil)
+      attr_accessible :index_permission, :new_permission, :create_permission, :show_permission, :edit_permission, :update_permission, :destroy_permission
+      before_save :complete_permissions_if_needed
+
+      self.parental_resource_permission = resource
+
+      class_eval <<-EOV
+        include ActsAsPermission::InstanceMethods
+
+        def self.could_have_permission_from_the_parent_resource?
+          !self.parental_resource_permission.nil?
+        end
+      EOV
+    end
+  end
+
+  module InstanceMethods
+    def has_permission?(action)
+      if self.respond_to?("#{action}_permission")
+        return self.send("#{action}_permission") unless self.send("#{action}_permission").nil?
+      end
+
+      if self.class.could_have_permission_from_the_parent_resource?
+        self.send(self.class.parental_resource_permission).has_permission?(action)
+      else
+        false
+      end
+    end
+
+    private
+
+    def complete_permissions_if_needed
+      self.update_permission = self.edit_permission if self.respond_to?('edit_permission') && self.respond_to?('update_permission')
+      self.create_permission = self.new_permission if self.respond_to?('new_permission') && self.respond_to?('create_permission')
+      true
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActsAsPermission }
+ActionController::Base.helper PermissionsHelper

data/lib/permissions_helper.rb

@@ -0,0 +1,17 @@
+module PermissionsHelper
+  def permission_fields(object_name, actions = [])
+    actions = %w[index show new create edit update destroy] if actions.empty?
+    actions.delete('create') if actions.include?('new')
+    actions.delete('update') if actions.include?('edit')
+    content_tag(:fieldset, :id => "#{object_name}_permissions") do
+      content_tag(:legend, "Permissions") +
+      actions.collect do |action|
+        content_tag(:p) do
+          label(object_name, "#{action}_permission", action.to_s.humanize) +
+          tag('br') + "\n" +
+          select(object_name, "#{action}_permission", [ ["allow", true], ["deny", false] ], {:include_blank => 'ignore'})
+        end
+      end.join("\n")
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_permission
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
+platform: ruby
+authors: 
+- Cyril Wack
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApjeXJp
+  bC53YWNrMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+  b20wHhcNMTAwNDExMjI1OTI4WhcNMTEwNDExMjI1OTI4WjBBMRMwEQYDVQQDDApj
+  eXJpbC53YWNrMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDGJFqPSXGYdS6t
+  t+kXyFuLg7uIbQHToLhdbfpu5j7dl65EWAspRI37ZE/FIFosmwQ0DAGiJ35gVX7K
+  5/rj745EUW9vijemlNHZjTY40AQAP2avlcMd6DnA7pl/x8dxC9G2dW/IS0nmjH0E
+  +X7X0BZ8WIY7PBvLsq5ptpGaoaxpmqRjJDANolnODwyBjFWtUqpvOGeUWL24orZ3
+  xwcW6d1vl8hraZ3UUJtIVXFg85lHclyrP33DYxj5sstgRwovaCPrvUQ6ZZ+hX/iJ
+  MYaEFZsw74WVD4RLHl1bEz2RQGDgSwfFnOnrQ1gi2SaeqUN7uFThAEbbyiJK+rNL
+  xapWOFs9AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBSsO/YPzLP2/ZtBKQfWveZNRK3uKDANBgkqhkiG9w0BAQUFAAOCAQEAGaGpPlEc
+  Z8A7Jtfws1tpdLOlQrQQXfIgBrPvfjO18MxT2BVgnusYcMuJgrY1skbH6RDxhdia
+  EetICD0kvyGnbK+dHdhRwvmmiqc7ZOaiFb3RNLcW6jduxafH4zgKUeg23KpfJYy3
+  MOqVgHckM1hMZTWz7nmrXJBAjj/48jFOPrwtTed8kd6KpIjUz4e2oTwT+JIVnryF
+  sYFesvR4DywbXL88T29gq5biCHsAgbK89DW5DNx1Yg1HNLxCdJurJFrcQQS3XQco
+  h2svBTlG7Yg1wLZAGkVx4RSkrFujrxpgLsz5bfmdnbiEgKcF9njIOdVO4P4vwyoS
+  G4VzQZjAGxprTw==
+  -----END CERTIFICATE-----
+
+date: 2010-04-12 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Simple Rails plugin to assign a list of permissions on a resource.
+email: cyril.wack@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/acts_as_permission.rb
+- lib/permissions_helper.rb
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- generators/acts_as_permission/USAGE
+- generators/acts_as_permission/acts_as_permission_generator.rb
+- init.rb
+- lib/acts_as_permission.rb
+- lib/permissions_helper.rb
+- Manifest
+- acts_as_permission.gemspec
+has_rdoc: true
+homepage: http://github.com/cyril/acts_as_permission
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_permission
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: acts_as_permission
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple Rails plugin to assign a list of permissions on a resource.
+test_files: []
+