permissable 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brent Kirby
+
+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/README.rdoc

@@ -0,0 +1,52 @@
+= permissable
+
+Permissable creates the ability to add a permissions system to "resources" based on a "member".
+It allows you to define a member using the +permissable+ method:
+
+	class User < ActiveRecord::Base
+	  permissable do |configure|
+	    configure.permission_for :read, :posts, :categories
+	    configure.permission_for [:read, :write, :moderate], :comments
+	  end
+	end
+
+Permissable uses a single "permissions" table (and subsuquently a Permission model), with a polymorphic relationship
+between both the member and the resource.
+
+Important to know... This is my first attempt at a RubyGem. I'm using the gem itself for an application currently in development, 
+so you can be assured at least the basic functionality should work as it goes along. For the time being, I'm not writing any tests,
+but there will be some later.
+
+I decided to develop it because I couldn't find anything that achieved the same thing that didn't seem cumbersome or akward to configure.
+
+This documention is incomplete... I'll add more later.
+
+== Usage
+
+	class User < ActiveRecord::Base
+	  permissable do |configure|
+	    configure.permission_for :read, :posts, :categories
+	    configure.permission_for [:read, :write, :moderate], :comments
+	  end
+	end
+
+The permissable method accepts a block containing permission declarations.
+Each call to permission_for accepts two attributes.
+
+* method: The permission you want to assign (read, write, moderate, etc)
+* resources: A list of resources to assign those permissions to
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 kurb media, llc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "permissable"
+    gem.summary = %Q{Basic member/resource permission system for ActiveRecord objects.}
+    gem.description = %Q{Permissable lets you set a number of 'permissions' to your database models. By assigning 'members' to 'resources' (models) you can specify various permission states.}
+    gem.email = "brent@kurbmedia.com"
+    gem.homepage = "http://github.com/kurbmedia/permissable"
+    gem.authors = ["Brent Kirby"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "permissable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

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

data/lib/permissable/member.rb

@@ -0,0 +1,105 @@
+module Permissable
+  
+  module Member
+    
+    def self.included(base)
+      
+      base.send :include, InstanceMethods
+      
+      if base.permissable_by_association
+        base.send :include, AssociatedMethods
+        # Add a has many to our association so it can find permissions.
+        base.permissable_by_association.to_s.classify.constantize.class_eval do
+          has_many :permissions, :as => :member, :conditions => { :member_type => "#{self.to_s}" }
+        end
+      else
+        base.send :include, MemberMethods
+      end
+    end
+    
+    # This module includes methods that should exist on ALL members.
+    module InstanceMethods
+      
+      # Can this member perform the requested action?
+      def can?(method, resource)
+        method = method.to_s       
+        permissions.for_resource(resource).with_permission_to(method).exists?
+      end
+      
+      # Set a permission
+      def can!(method, resource)
+        method    = method.to_s.downcase
+        klassname = permissable_by_association ? permissable_by_association.to_s.classify : self.class.to_s
+        
+        throw Permissable::ResourceNotPermissable unless resource.respond_to? :permissable_methods
+        throw Permissable::PermissionNotDefined unless resource.permissable_methods.include?(method)
+        
+        members.each do |m|
+          next if resource.permissions.for_member_and_resource(m,resource).exists?
+          new_permission = Permission.new()
+          new_permission.member   = m
+          new_permission.resource = resource
+          new_permission.permission_type = method
+          new_permission.save 
+        end
+        
+      end
+      
+      def permissions_for(resource)
+        if resource.is_a?(Class)
+          permissions_scope[resource.to_s]
+        else
+          permissions.for_resource(resource).all.collect{ |p| p.permission_type.to_sym }.uniq
+        end
+      end
+      
+      def permissions_for?(resource)
+        !permissions_for(resource).empty?
+      end
+      
+      def permissions_for!(resources, *perms)
+        
+      end
+      
+      private
+      
+      def get_const(resource)
+        resource.class.to_s.classify.constantize
+      end
+            
+    end
+    
+    # This module gets included on member classes that are permissable directly.
+    module MemberMethods
+      alias_attribute :member_id, :id
+      def members; [self]; end
+    end
+    
+    # This module gets included on member classes that are permissable with an association.
+    module AssociatedMethods
+      
+      attr_reader :permissions
+      attr_reader :member_id
+      
+      def permissions
+        return @permissions unless @permissions.nil?
+        @permissions = Permission.where(:member_id => member_id, :member_type => association.to_s)
+      end
+      
+      def association
+        permissable_by_association.to_s.classify.constantize
+      end
+      
+      def member_id
+        @member_id || association.all.collect{ |a| a.attributes['id'] }
+      end
+      
+      def members
+        association.all
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/permissable/permission.rb

@@ -0,0 +1,23 @@
+class Permission < ActiveRecord::Base
+  belongs_to :member,   :polymorphic => true
+  belongs_to :resource, :polymorphic => true
+  
+  class << self
+    def for_member(member)
+      where(:member_id => member.id, :member_type => member.class.to_s)
+    end
+    
+    def for_resource(resource)
+      where(:resource_id => resource.id, :resource_type => resource.class.to_s)
+    end
+    
+    def for_member_and_resource(member, resource)
+      for_member(member).for_resource(resource)
+    end
+    
+    def with_permission_to(perm)
+      where(:permission_type => perm.to_s)
+    end
+  end
+  
+end

data/lib/permissable/resource.rb

@@ -0,0 +1,13 @@
+module Permissable
+  
+  module Resource
+    
+    private
+    
+    def self.set_permissions!
+      puts permissable_methods.inspect
+    end
+    
+  end
+  
+end

data/lib/permissable.rb

@@ -0,0 +1,92 @@
+# Author: Brent Kirby
+# Copyright:: Copyright (c) 2010 kurb media, llc.
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+#
+# Permissable creates the ability to add a permissions system to "resources" based on a "member".
+# It allows you to define a member using the +permissable+ method:
+#
+#  class User < ActiveRecord::Base
+#    permissable do |configure|
+#      configure.permission_for :read, :posts, :categories
+#      configure.permission_for [:read, :write, :moderate], :comments
+#    end
+#  end
+#
+# Permissable uses a single "permissions" table (and subsuquently a Permission model), with a polymorphic relationship
+# between both the member and the resource.
+
+require 'permissable/member'
+require 'permissable/permission'
+require 'permissable/resource'
+
+module Permissable
+    
+    class << self
+            
+      def included(base)
+        base.extend ClassMethods
+      end     
+      
+    end
+    
+    class PermissableError < StandardError
+    end
+    
+    class PermissionNotDefined < PermissableError
+    end
+    
+    class ResourceNotPermissable < PermissableError
+    end
+    
+    module ClassMethods
+      
+      # +permissable+ gives the class its called on the ability to effect various permission states on the resources
+      # it specifies. It accepts an options hash and a block. The following options are supported:
+      #
+      # * with: This is an association of the primary member class. This allows you to use an association to determine
+      #   which permissions are available. One example of this would be to assign permission to Roles of a User class.
+      #   In this case, when doing lookups, it will use the permissions assigned to each Role the user belongs to.
+      #   The with option accepts the association in the same manner as you would define it in active record.
+      #   ie: has_many roles would be: :with => :roles. belongs_to role would be :with => :role
+      def permissable(options = {})
+        
+        write_inheritable_attribute :permissable_by_association, (options[:with] || false)
+        class_inheritable_reader :permissable_by_association
+           
+        # The class that called permissable becomes a member.
+        include Permissable::Member
+        has_many(:permissions, :as => :member, :conditions => { :member_type => "#{self.to_s}" }) unless permissable_by_association
+        
+        yield self
+        
+      end
+      
+      # +permission_for+ is called via the permissable block
+      def permission_for(methods, *resources)
+        
+        methods = [methods] unless methods.is_a?(Array)
+
+        resources.each do |resource|
+
+          klass = resource.to_s.classify          
+          klass.constantize.class_eval do
+            
+            write_inheritable_attribute :permissable_methods, methods
+            class_inheritable_reader   :permissable_methods
+            has_many(:permissions, :as => :resource, :conditions => { :resource_type => "#{self.to_s}" })
+            
+            include Permissable::Resource
+            
+          end
+          
+        end 
+               
+      end
+      
+    end
+    
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, Permissable
+end

data/permissable.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{permissable}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brent Kirby"]
+  s.date = %q{2010-07-25}
+  s.description = %q{Permissable lets you set a number of 'permissions' to your database models. By assigning 'members' to 'resources' (models) you can specify various permission states.}
+  s.email = %q{brent@kurbmedia.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/permissable.rb",
+     "lib/permissable/member.rb",
+     "lib/permissable/permission.rb",
+     "lib/permissable/resource.rb",
+     "permissable.gemspec",
+     "test/helper.rb",
+     "test/test_permissable.rb"
+  ]
+  s.homepage = %q{http://github.com/kurbmedia/permissable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Basic member/resource permission system for ActiveRecord objects.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_permissable.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'permissable'
+
+class Test::Unit::TestCase
+end

data/test/test_permissable.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPermissable < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: permissable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brent Kirby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Permissable lets you set a number of 'permissions' to your database models. By assigning 'members' to 'resources' (models) you can specify various permission states.
+email: brent@kurbmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/permissable.rb
+- lib/permissable/member.rb
+- lib/permissable/permission.rb
+- lib/permissable/resource.rb
+- permissable.gemspec
+- test/helper.rb
+- test/test_permissable.rb
+has_rdoc: true
+homepage: http://github.com/kurbmedia/permissable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Basic member/resource permission system for ActiveRecord objects.
+test_files: 
+- test/helper.rb
+- test/test_permissable.rb