cancan-permits 0.3.5 → 0.3.6

data/README.markdown

@@ -96,6 +96,46 @@ class AdminPermit < Permit::Base
 end
 </code>
 
+The call to #load_rules will call both #load_user_roles and #load_role_rules. 
+If you want you can call these methods individually, fx if you only want to apply one set of rules.
+
+*Permit rules:*
+- config/permits.yml
+
+Each key at the top level is expected to match a permit/role name.
+
+Example yml config file:
+<code>
+admin:
+  can:
+    manage:
+      - Article
+      - Post
+guest:
+  can:
+    manage:
+      - all
+  cannot:
+    manage:
+      - User  
+</code>
+
+Usage in a license
+
+<code>
+class GuestPermit < Permit::Base
+  def initialize(ability, options = {})
+    super
+  end
+
+  def permit?(user, options = {})    
+    super
+    return if !role_match? user
+    can :manage, :all    
+    load_rules user
+  end  
+end
+</code>
 
 *License permissions:*
 - config/licenses.yml

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/cancan-permits.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cancan-permits}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-11-29}
+  s.date = %q{2010-11-30}
   s.description = %q{Role specific Permits for use with CanCan permission system}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -62,10 +62,11 @@ Gem::Specification.new do |s|
     "spec/active_record/owner_permits_spec.rb",
     "spec/active_record/permits_spec.rb",
     "spec/active_record/spec_helper.rb",
-    "spec/cancan-permits/license_loader/license_loader_spec.rb",
-    "spec/cancan-permits/license_loader/licenses.yml",
-    "spec/cancan-permits/user_permissions_loader/user_permissions.yml",
-    "spec/cancan-permits/user_permissions_loader/user_permissions_loader.rb",
+    "spec/cancan-permits/loader/config/licenses.yml",
+    "spec/cancan-permits/loader/config/user_permissions.yml",
+    "spec/cancan-permits/loader/license_loader_spec.rb",
+    "spec/cancan-permits/loader/permits_loader_spec.rb",
+    "spec/cancan-permits/loader/user_permissions_loader.rb",
     "spec/data_mapper/models/all_models.rb",
     "spec/data_mapper/owner_permits_spec.rb",
     "spec/data_mapper/permits_spec.rb",
@@ -118,8 +119,9 @@ Gem::Specification.new do |s|
     "spec/active_record/owner_permits_spec.rb",
     "spec/active_record/permits_spec.rb",
     "spec/active_record/spec_helper.rb",
-    "spec/cancan-permits/license_loader/license_loader_spec.rb",
-    "spec/cancan-permits/user_permissions_loader/user_permissions_loader.rb",
+    "spec/cancan-permits/loader/license_loader_spec.rb",
+    "spec/cancan-permits/loader/permits_loader_spec.rb",
+    "spec/cancan-permits/loader/user_permissions_loader.rb",
     "spec/data_mapper/models/all_models.rb",
     "spec/data_mapper/owner_permits_spec.rb",
     "spec/data_mapper/permits_spec.rb",

data/lib/cancan-permits/license/base_license.rb

@@ -16,7 +16,7 @@ module License
     def load_rules name = nil
       return if !licenses || licenses.empty?      
 
-      name ||= self.class.to_s..gsub(/License$/, "").underscore.to_sym
+      name ||= self.class.to_s.gsub(/License$/, "").underscore.to_sym
             
       licenses[name].can_statement do |permission_statement|
         instance_eval permission_statement

data/lib/cancan-permits/loader/permissions_loader.rb

@@ -6,7 +6,7 @@ class PermissionsLoader
     begin
       if file_name.nil? || !File.file?(file_name)
         # raise ArgumentError, "PermissionsLoader Error: The permissions file #{file_name} could not be found" 
-        puts "PermissionsLoader Error: The permissions file #{file_name} could not be found" 
+        # puts "PermissionsLoader Error: The permissions file #{file_name} could not be found" 
         return nil
       end
 
@@ -33,14 +33,34 @@ class PermissionsLoader
     name ||= licenses_config_file
     PermissionsLoader.new name
   end
+
+  def self.load_permits name = nil
+    name ||= permits_config_file
+    PermissionsLoader.new name
+  end
+  
+  def self.permits_config_file
+    # raise '#user_permissions_config_file only works in a Rails app enviroment' if !defined? Rails
+    get_config_file 'permits'
+  end
   
   def self.user_permissions_config_file
     # raise '#user_permissions_config_file only works in a Rails app enviroment' if !defined? Rails
-    File.join(::Rails.root, 'config', 'user_permissions.yml') if defined? Rails
+    get_config_file 'user_permissions'
   end
 
   def self.licenses_config_file
     # raise '#licenses_config_file only works in a Rails app enviroment' if !defined? Rails
-    File.join(::Rails.root, 'config', 'licenses.yml') if defined? Rails
+    get_config_file 'licenses'
+  end
+  
+  protected
+
+  def self.get_config_file name
+    File.join(::Rails.root, 'config', "#{name}.yml") if rails?
+  end
+  
+  def self.rails?
+    defined?(Rails) && Rails.respond_to?(:root)
   end
 end

data/lib/cancan-permits/permit/base_permit.rb

@@ -25,9 +25,27 @@ module Permit
       end
     end
 
-    def load_rules user 
+    def load_rules user
+      load_role_rules
+      load_user_rules user
+    end
+
+    def load_role_rules
+      return if !role_permissions || role_permissions.empty?
+      name ||= self.class.to_s.gsub(/Permit$/, "").underscore.to_sym
+            
+      role_permissions[name].can_statement do |permission_statement|
+        instance_eval permission_statement
+      end
+
+      role_permissions[name].cannot_statement do |permission_statement|
+        instance_eval permission_statement
+      end
+    end
+
+    def load_user_rules user 
       return if !user_permissions || user_permissions.empty?
-      raise "#load_enforcements expects the user to have an email property: #{user.inspect}" if !user || !user.respond_to?(:email) 
+      raise "#load_user_rules expects the user to have an email property: #{user.inspect}" if !user || !user.respond_to?(:email) 
 
       id = user.email
       return nil if id.strip.empty?
@@ -44,7 +62,8 @@ module Permit
     def initialize ability, options = {}
       @ability  = ability
       @strategy = options[:strategy] || Permits::Ability.strategy || :default      
-      @user_permissions = ::PermissionsLoader.load_user_permissions options[:permissions_file]
+      @user_permissions = ::PermissionsLoader.load_user_permissions options[:user_permissions_file]
+      @role_permissions = ::PermissionsLoader.load_permits options[:permits_file]
     end
 
     def permit?(user, options = {}) 

data/lib/cancan-permits/permits/ability.rb

@@ -59,14 +59,22 @@ module Permits
     protected
 
     include Permit::Util
+
+    def self.get_permit role
+      begin            
+        clazz_name = "#{role.to_s.camelize}Permit"
+        clazz_name.constantize
+      rescue
+        raise "Permit #{clazz_name} not loaded and thus not defined"
+      end
+    end
     
     def self.make_permit role, ability, options = {}
       begin            
-        clazz_name = "#{role.to_s.camelize}Permit"
-        permit_clazz = clazz_name.constantize
+        permit_clazz = get_permit role
         permit_clazz.new(ability, options) if permit_clazz && permit_clazz.kind_of?(Class)
-      rescue
-        raise "Permit #{clazz_name} not found"
+      rescue RuntimeError => e
+        raise "Error instantiating Permit instance for #{permit_clazz}, cause #{e}"
       end
     end          
   end

data/spec/cancan-permits/{license_loader → loader}/license_loader_spec.rb

@@ -3,9 +3,9 @@ require 'cancan-permits'
 
 DIR = File.dirname(__FILE__) 
 
-describe 'Load License permissions' do
+describe 'Load License rules' do
   before :each do
-    @permissions_file = File.join(DIR, 'licenses.yml')
+    @permissions_file = File.join(DIR, 'config', 'licenses.yml')
   end
 
   it "should load a licenses permission file" do
@@ -19,7 +19,7 @@ describe 'Load License permissions' do
   end   
   
   it "should be able to instantiate a base permit without permission file" do
-    Permit::Base.new 'x'
+    License::Base.new 'x'
   end     
 end
 

data/spec/cancan-permits/loader/permits_loader_spec.rb

@@ -0,0 +1,28 @@
+require 'rspec/core'
+require 'cancan-permits' 
+
+DIR = File.dirname(__FILE__) 
+
+describe 'Load Permits rules' do
+  before :each do
+    @permission_file = File.join(DIR, 'config', 'permits.yml')
+  end
+
+  it "should load a licenses permission file" do
+    loader = PermissionsLoader.new @permissions_file
+    # puts "loaded permissions #{loader.permissions}"
+    loader.permissions.should_not be_empty    
+  end 
+  
+  it "should be able to instantiate a base license with permission file" do
+    Permit::Base.new 'x', @permissions_file
+  end   
+  
+  it "should be able to instantiate a base permit without permission file" do
+    Permit::Base.new 'x'
+  end     
+end
+
+
+
+

data/spec/cancan-permits/{user_permissions_loader → loader}/user_permissions_loader.rb

@@ -5,7 +5,7 @@ DIR = File.dirname(__FILE__)
 
 describe 'User Permissions Loader' do
   before :each do
-    @permissions_file = File.join(DIR, 'user_permissions.yml')
+    @permissions_file = File.join(DIR, 'config', 'user_permissions.yml')
   end
 
   it "should load a user permissions file" do
@@ -15,7 +15,7 @@ describe 'User Permissions Loader' do
   end    
   
   it "should be able to instantiate a base permit with permission file" do
-    Permit::Base.new 'x', :permissions_file => @permissions_file
+    Permit::Base.new 'x', :user_permissions_file => @permissions_file
   end   
 
   it "should be able to instantiate a base permit without permission file" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 +01:00
+date: 2010-11-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -207,10 +207,11 @@ files:
 - spec/active_record/owner_permits_spec.rb
 - spec/active_record/permits_spec.rb
 - spec/active_record/spec_helper.rb
-- spec/cancan-permits/license_loader/license_loader_spec.rb
-- spec/cancan-permits/license_loader/licenses.yml
-- spec/cancan-permits/user_permissions_loader/user_permissions.yml
-- spec/cancan-permits/user_permissions_loader/user_permissions_loader.rb
+- spec/cancan-permits/loader/config/licenses.yml
+- spec/cancan-permits/loader/config/user_permissions.yml
+- spec/cancan-permits/loader/license_loader_spec.rb
+- spec/cancan-permits/loader/permits_loader_spec.rb
+- spec/cancan-permits/loader/user_permissions_loader.rb
 - spec/data_mapper/models/all_models.rb
 - spec/data_mapper/owner_permits_spec.rb
 - spec/data_mapper/permits_spec.rb
@@ -290,8 +291,9 @@ test_files:
 - spec/active_record/owner_permits_spec.rb
 - spec/active_record/permits_spec.rb
 - spec/active_record/spec_helper.rb
-- spec/cancan-permits/license_loader/license_loader_spec.rb
-- spec/cancan-permits/user_permissions_loader/user_permissions_loader.rb
+- spec/cancan-permits/loader/license_loader_spec.rb
+- spec/cancan-permits/loader/permits_loader_spec.rb
+- spec/cancan-permits/loader/user_permissions_loader.rb
 - spec/data_mapper/models/all_models.rb
 - spec/data_mapper/owner_permits_spec.rb
 - spec/data_mapper/permits_spec.rb