cantango 0.8.8.1 → 0.8.9

data/README.textile

@@ -35,16 +35,25 @@ Run bundler in a terminal/console from the folder of your Gemfile (root folder o
 
 @$ bundle@
 
-h2. Update Oct 6, 2011
+h2. Update Oct 8, 2011
 
-Version *0.8.8.1* has been released.
+Version *0.8.9* has been released.
 
-* Fixed some bugs when using :user and :account permits
-* Enhanced Permits debugging so you can now track the execution flow of the Permits engine. 
-* You can now disable specific types of Permits to be used for the Permits engine
-  * CanTango.config.permits.disable :role_groups, :special
-  * CanTango.config.permits.enabled
-  * CanTango.config.permits.available 
+* You can now disable specific Permits to not be executed by the Permits engine
+
+This is especially useful when you are conerting permits into permissions
+
+<pre>
+CanTango.config.permits.disable_for :user, [:admin, :editor]  # AdminPermit, EditorPermit
+CanTango.config.permits.disable_for :role, :guest # GuestRolePermit
+CanTango.config.permits.disable_for :account, :admin # AdminAccountPermit
+puts CanTango.config.permits.disabled # => {:role => ['guest'], :user ...}
+puts CanTango.config.permits.disabled_for :role # => :guest
+CanTango.config.permits.enable_all_types! # reset types only
+CanTango.config.permits.enable_all! # reset types and specific
+</pre>
+
+Note: You can also disable a permit directly from within the Permit class, using the new @disable!@ method. This can fx be done in a permit initializer.
 
 h2. Quickstart
 

data/VERSION

@@ -1 +1 @@
-0.8.8.1
+0.8.9

data/cantango.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cantango"
-  s.version = "0.8.8.1"
+  s.version = "0.8.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup", "Stanislaw Pankevich"]
-  s.date = "2011-10-06"
+  s.date = "2011-10-08"
   s.description = "Define your permission rules as role- or role group specific permits.\nIntegrates well with multiple Devise user acounts.\nIncludes rules caching.\nStore permissions in yaml file or key-value store"
   s.email = "kmandrup@gmail.com, s.pankevich@gmail.com"
   s.extra_rdoc_files = [

data/lib/cantango.rb

@@ -41,6 +41,10 @@ module CanTango
       config.debug.set :on
     end
 
+    def debug_off!
+      config.debug.set :off
+    end
+
     def debug?
       config.debug.on?
     end

data/lib/cantango/configuration/permits.rb

@@ -5,16 +5,45 @@ module CanTango
 
       attr_reader :accounts
 
-      def enabled
-        @enabled || available
+      def enabled_types
+        @enabled_types || available_types
       end
+      alias_method :enabled, :enabled_types
 
-      def available
+      def available_types
         [:user, :account, :role, :role_group, :special]
       end
 
-      def disable *types
-        @enabled = available - types.flatten
+      def disable_types *types
+        @enabled_types = available_types - types.flatten
+      end
+      alias_method :disable, :disable_types      
+
+      def enable_all_types!
+        @enabled_types = available_types
+      end
+
+      def disable_for type, *names
+        @disabled ||= {}
+        @disabled[type.to_sym] = names.flatten.select_labels.map{|n| n.to_s.underscore}
+      end
+
+      def enable_all_for type
+        @disabled ||= {}
+        @disabled[type.to_sym] = nil
+      end
+
+      def disabled
+        @disabled ||= {}
+      end
+
+      def disabled_for type
+        disabled[type]
+      end
+
+      def enable_all!
+        @disabled = {}
+        enable_all_types!
       end
 
       def accounts

data/lib/cantango/permit_engine/factory.rb

@@ -17,9 +17,9 @@ module CanTango
 
       def permits
         @permits ||= builders.inject([]) do |permits, builder|
-          puts "++ Permit Builder: #{builder_class builder}"
+          puts "++ Permit Builder: #{builder_class builder}" if CanTango.debug?
           built_permits = permits_built_with(builder)
-          puts "== Permits built: #{built_permits.size}"
+          puts "== Permits built: #{built_permits.size}" if CanTango.debug?
           permits = permits + built_permits if built_permits
         end.flatten
       end

data/lib/cantango/permits/account_permit.rb

@@ -16,9 +16,10 @@ module CanTango
         clazz.name.demodulize.gsub(/(.*)(AccountPermit)/, '\1').underscore.to_sym
       end
 
-      def account_type
+      def permit_name
         self.class.account_type_name self.class
       end
+      alias_method :account_type, :permit_name
 
       # creates the permit
       # @param [Permits::Ability] the ability
@@ -27,7 +28,6 @@ module CanTango
         super
       end
 
-
       # In a specific Role based Permit you can use 
       #   def permit? user, options = {}
       #     ... permission logic follows
@@ -46,14 +46,14 @@ module CanTango
       end
 
       def valid_for? subject
-        debug_invalid if CanTango.debug? && !(subject_name == account_name)
+        debug_invalid if !(subject_name == account_name)
         subject_name == account_name
       end
 
       protected
 
       def debug_invalid
-        puts "Not a valid permit for subject: (account class) #{subject_account} != #{permit_account} (permit account)"
+        puts "Not a valid permit for subject: (account class) #{subject_account} != #{permit_account} (permit account)" if CanTango.debug?
       end
 
       def subject_name
@@ -62,7 +62,7 @@ module CanTango
       end
 
       def account_name
-        self.class.account_type_name(self.class)
+        account_type(self.class)
       end
     end
   end

data/lib/cantango/permits/permit.rb

@@ -8,7 +8,7 @@ module CanTango
       attr_reader :ability
 
       # strategy is used to control the owns strategy (see rules.rb)
-      attr_reader :strategy
+      attr_reader :strategy, :disabled
 
       include CanTango::Api::Attributes
 
@@ -21,14 +21,31 @@ module CanTango
         clazz.to_s.gsub(/^([A-Za-z]+).*/, '\1').underscore.to_sym # first part of class name
       end
 
+      def self.type
+        :abstract
+      end
+
       def self.account_name clazz
         return nil if clazz.name == clazz.name.demodulize
         clazz.name.gsub(/::.*/,'').gsub(/(.*)Permits/, '\1').underscore.to_sym
       end
 
+      def permit_type
+        self.class.type
+      end
+
+      def disable!
+        @disabled = true
+      end
+
+      def disabled?
+        @disabled || config_disabled?
+      end
+
       # executes the permit
       def execute
-        puts "Execute Permit: #{self}" if CanTango.config.debug.on?        
+        return if disabled?
+        puts "Execute Permit: #{self}" if CanTango.debug?
         executor.execute!
         ability_sync!
       end
@@ -117,6 +134,10 @@ module CanTango
 
       protected
 
+      def config_disabled?
+        (CanTango.config.permits.disabled[permit_type] || []).include?(permit_name.to_s)
+      end
+
       def try_license name
         module_name = "#{name.camelize}License"
         clazz = module_name.constantize

data/lib/cantango/permits/role_group_permit.rb

@@ -16,9 +16,10 @@ module CanTango
         clazz.name.demodulize.gsub(/(.*)(RoleGroupPermit)/, '\1').underscore.to_sym
       end
 
-      def role_group
+      def permit_name
         self.class.role_group_name self.class
       end
+      alias_method :role_group, :permit_name
 
       # creates the permit
       def initialize ability

data/lib/cantango/permits/role_permit.rb

@@ -16,9 +16,10 @@ module CanTango
         clazz.name.demodulize.gsub(/(.*)(RolePermit)/, '\1').underscore.to_sym
       end
 
-      def role
+      def permit_name
         self.class.role_name self.class
       end
+      alias_method :role, :permit_name
 
       # creates the permit
       # @param [Permits::Ability] the ability

data/lib/cantango/permits/user_permit.rb

@@ -16,10 +16,11 @@ module CanTango
         clazz.name.demodulize.gsub(/(.*)(Permit)/, '\1').underscore.to_sym
       end
 
-      # fx for User user class, becomes simply UserPermit
-      def user_type
+      # UserPermit becomes :user
+      def permit_name
         self.class.user_type_name self.class
       end
+      alias_method :user_type, :permit_name
 
       # creates the permit
       # @param [Permits::Ability] the ability
@@ -28,7 +29,6 @@ module CanTango
         super
       end
 
-
       # In a specific Role based Permit you can use 
       #   def permit? user, options = {}
       #     ... permission logic follows
@@ -47,14 +47,14 @@ module CanTango
       end
 
       def valid_for? subject
-        debug_invalid if CanTango.debug? && !(subject_user == permit_user)
+        debug_invalid if !(subject_user == permit_user)
         subject_user == permit_user
       end
 
       protected
 
       def debug_invalid
-        puts "Not a valid permit for subject: (user class) #{subject_user} != #{permit_user} (permit user)"
+        puts "Not a valid permit for subject: (user class) #{subject_user} != #{permit_user} (permit user)" if CanTango.debug?
       end
 
       def subject_user
@@ -62,7 +62,7 @@ module CanTango
       end
 
       def permit_user
-        self.class.user_type_name(self.class)
+        permit_name(self.class)
       end
     end
   end

data/spec/cantango/permit_engine/user_permit_spec.rb

@@ -27,14 +27,40 @@ describe CanTango::Permits::UserPermit do
     AdminPermit.new ability
   end
 
+  before do
+    CanTango.debug_off!
+  end
+
   describe 'attributes' do
     it "should be the permit for the :admin user" do
       permit.user_type.should == :admin
+      permit.permit_name.should == :admin
     end
 
     it "should have an ability" do
       permit.ability.should be_a(CanTango::Ability)
     end
   end
+
+  describe 'disable Admin Permit' do
+    before do
+      CanTango.config.permits.disable_for :user, [:admin, :editor]
+    end
+
+    it "should have an ability" do
+      permit.disabled?.should be_true
+    end
+  end
+
+  describe 'enable all Permits' do
+    before do
+      CanTango.config.permits.enable_all!      
+    end
+
+    it "should be disabled" do
+      CanTango.config.permits.disabled.should be_empty
+      permit.disabled?.should be_false
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cantango
 version: !ruby/object:Gem::Version
-  version: 0.8.8.1
+  version: 0.8.9
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-06 00:00:00.000000000Z
+date: 2011-10-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2155846940 !ruby/object:Gem::Requirement
+  requirement: &2158311360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2155846940
+  version_requirements: *2158311360
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &2155846160 !ruby/object:Gem::Requirement
+  requirement: &2158310420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2155846160
+  version_requirements: *2158310420
 - !ruby/object:Gem::Dependency
   name: sugar-high
-  requirement: &2155845200 !ruby/object:Gem::Requirement
+  requirement: &2158309000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155845200
+  version_requirements: *2158309000
 - !ruby/object:Gem::Dependency
   name: sweetloader
-  requirement: &2155844260 !ruby/object:Gem::Requirement
+  requirement: &2158307620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155844260
+  version_requirements: *2158307620
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &2155843720 !ruby/object:Gem::Requirement
+  requirement: &2158305560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2155843720
+  version_requirements: *2158305560
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2155837120 !ruby/object:Gem::Requirement
+  requirement: &2158304220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.6.1
   type: :development
   prerelease: false
-  version_requirements: *2155837120
+  version_requirements: *2158304220
 - !ruby/object:Gem::Dependency
   name: forgery
-  requirement: &2155836320 !ruby/object:Gem::Requirement
+  requirement: &2158302900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *2155836320
+  version_requirements: *2158302900
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &2155834940 !ruby/object:Gem::Requirement
+  requirement: &2158302380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155834940
+  version_requirements: *2158302380
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2155834260 !ruby/object:Gem::Requirement
+  requirement: &2158301860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155834260
+  version_requirements: *2158301860
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &2155833280 !ruby/object:Gem::Requirement
+  requirement: &2158301260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155833280
+  version_requirements: *2158301260
 - !ruby/object:Gem::Dependency
   name: dkastner-moneta
-  requirement: &2155831600 !ruby/object:Gem::Requirement
+  requirement: &2158296100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2155831600
+  version_requirements: *2158296100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2155829460 !ruby/object:Gem::Requirement
+  requirement: &2158294880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *2155829460
+  version_requirements: *2158294880
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2155822220 !ruby/object:Gem::Requirement
+  requirement: &2158293680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,10 +154,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2155822220
+  version_requirements: *2158293680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2155821060 !ruby/object:Gem::Requirement
+  requirement: &2158292980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -165,10 +165,10 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *2155821060
+  version_requirements: *2158292980
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2155820440 !ruby/object:Gem::Requirement
+  requirement: &2158291700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -176,7 +176,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155820440
+  version_requirements: *2158291700
 description: ! 'Define your permission rules as role- or role group specific permits.
 
   Integrates well with multiple Devise user acounts.
@@ -822,7 +822,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3348262799499856729
+      hash: -3737746753132701377
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: