cantango 0.8.0 → 0.8.5.1

data/lib/cantango/permission_engine/store.rb

@@ -1,7 +1,7 @@
 require 'set'
 
 module CanTango
-  module PermissionEngine
+  class PermissionEngine < Engine
     class Store
       attr_reader :name, :options
 

data/lib/cantango/permission_engine/yaml_store.rb

@@ -1,7 +1,7 @@
 require 'yaml'
 
 module CanTango
-  module PermissionEngine
+  class PermissionEngine < Engine
     class YamlStore < Store
       attr_reader :path
 
@@ -30,7 +30,7 @@ module CanTango
         @permissions ||= loader.permissions
       end
 
-      CanTango.config.permissions.types.each do |type|
+      CanTango.config.permission_engine.types.each do |type|
         define_method(:"#{type}_permissions") do
           loader.send(:"#{type}_permissions")
         end

data/lib/cantango/permit_engine.rb

@@ -1,8 +1,33 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     autoload_modules :Builder, :Compatibility, :Executor
-    autoload_modules :Factory, :Finder, :License, :Loaders, :Permit
-    autoload_modules :RoleGroupPermit, :RolePermit, :UserPermit, :AccountPermit
-    autoload_modules :RoleMatcher, :Util
+    autoload_modules :Factory, :Finder, :Loaders, :Util, :RoleMatcher
+
+    def initialize ability
+      super
+    end
+
+    def execute!
+      permits.each do |permit|
+        break if permit.execute == :break
+      end
+    end
+
+    # by default, only execute permits for which the user
+    # has a role or a role group
+    # also execute any permit marked as special
+    def permits
+      permit_factory.build!
+    end
+
+    def permit_class_names
+      @permit_class_names ||= permits.map{|p| p.class.to_s}
+    end
+
+    protected
+
+    def permit_factory
+      @permit_factory ||= CanTango::PermitEngine::Factory.new ability
+    end
   end
 end

data/lib/cantango/permit_engine/builder.rb

@@ -1,8 +1,7 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Builder
-      autoload :Base,             'cantango/permit_engine/builder/base'
-      autoload :SpecialPermits,   'cantango/permit_engine/builder/special_permits'
+      autoload_modules :Base, :SpecialPermits
     end
   end
 end

data/lib/cantango/permit_engine/builder/base.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Builder
       class Base
         attr_accessor :ability
@@ -13,6 +13,14 @@ module CanTango
 
         protected
 
+        def finder
+          ns::Finder
+        end
+
+        def ns
+          self.class.to_s.gsub(/::Builder/, '').constantize
+        end
+
         # Tries to create a new permit for the given role
         # If no permit Class can be found, it should return nil
         # @param [Symbol] the name

data/lib/cantango/permit_engine/builder/special_permits.rb

@@ -1,20 +1,19 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Builder
-      class SpecialPermits < Base      
+      class SpecialPermits < Base
         def build
           special_permits.map{|role| create_permit(role)}.compact
-        end    
+        end
 
         def special_permits
           [:system, :any]
-        end    
-      
+        end
+
         def finder
-          CanTango::PermitEngine::RolePermit::Finder
-        end      
+          CanTango::Permits::RolePermit::Finder
+        end
       end
     end
-
   end
 end

data/lib/cantango/permit_engine/compatibility.rb

@@ -1,6 +1,6 @@
 # ensures compatibility with CanCan 1.5+ and 1.4-
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Compatibility
       def rules
         return rules_1_5 if rules_1_5

data/lib/cantango/permit_engine/executor.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Executor
       autoload_modules :Abstract, :Base, :System
     end

data/lib/cantango/permit_engine/executor/abstract.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Executor
       class Abstract
         attr_accessor :permit

data/lib/cantango/permit_engine/executor/base.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Executor
       class Base < Abstract
         # execute the permit

data/lib/cantango/permit_engine/executor/system.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Executor
       class System < Abstract
         # always execute system permit

data/lib/cantango/permit_engine/factory.rb

@@ -1,10 +1,6 @@
-require 'sugar-high/class_ext'
-
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     class Factory
-      include ClassExt
-
       attr_accessor :ability, :builders
 
       # creates the factory for the ability
@@ -28,7 +24,7 @@ module CanTango
 
       def builder_class builder
         return "CanTango::PermitEngine::Builder::SpecialPermits" if builder == :special
-        "CanTango::PermitEngine::#{builder.to_s.camelize}Permit::Builder"
+        "CanTango::Permits::#{builder.to_s.camelize}Permit::Builder"
       end
 
       def builders
@@ -39,7 +35,6 @@ module CanTango
         ability.options
       end
     end
-
   end
 end
 

data/lib/cantango/permit_engine/finder.rb

@@ -1,10 +1,7 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     class Finder
-      include ClassExt
-
       # This class is used to find the right permit, possible scoped for a specific user account
-
       attr_reader :user_account, :name
 
       def initialize user_account, name
@@ -13,13 +10,50 @@ module CanTango
       end
 
       def get_permit
-        begin
-          find_first_class account_permit_class, permit_class
-        rescue
-          raise "Permit for #{type} #{name} could not be loaded. Define either class: #{account_permit_class} or #{permit_class}"
-        end
+        raise find_error if !retrieve_permit
+        retrieve_permit
+      end
+
+      protected
+
+      def find_error
+        "Permit for #{type} #{name} could not be loaded. Define either class: #{account_permit_class} or #{permit_class}"
       end
 
+      def retrieve_permit
+        @found_permit ||= [account_permit(name), permit(name)].compact.first
+      end
+
+      def account_permit name
+        
+        # TODO: User/Account cases should be handled somehow following is just interim measure
+        return nil if !user_account.class.name =~ /Account/
+        account_permits_for_account.send(type).registered[name]
+      rescue
+        nil
+      end
+
+      def permit name
+        permits.send(type).registered[name]
+      end
+
+      def permits
+        CanTango.config.permits
+      end
+
+      # TODO: make proper account touching
+
+      def account_permits_for_account
+        account_permits.send(account)
+      end
+
+      def account_permits
+        CanTango.config.permits
+      end
+
+      def account
+        user_account.class.name.underscore
+      end
       # this is used to namespace role permits for a specific type of user account
       # this allows role permits to be defined differently for each user account (and hence sub application) if need be
       # otherwise it will fall back to the generic role permit (the one which is not wrapped in a user account namespace)

data/lib/cantango/permit_engine/role_matcher.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module RoleMatcher
       def role_match? user_account
         user_account.has_role? permit_name(self.class)

data/lib/cantango/permit_engine/util.rb

@@ -1,7 +1,7 @@
 require 'active_support/inflector'
 
 module CanTango
-  module PermitEngine
+  class PermitEngine < Engine
     module Util
       def permit_name clazz
         @name ||= clazz.to_s.demodulize.gsub(/Role/,'').gsub(/Permit$/, '').gsub(/Group/,'').underscore.to_sym
@@ -17,3 +17,4 @@ module CanTango
     end
   end
 end
+

data/lib/cantango/permits.rb

@@ -0,0 +1,9 @@
+module CanTango
+  module Permits
+    autoload_modules :License, :Permit
+    autoload_modules :RoleGroupPermit, :RolePermit
+    autoload_modules :UserPermit, :AccountPermit
+  end
+end
+
+

data/lib/cantango/{permit_engine → permits}/account_permit.rb

@@ -1,12 +1,23 @@
 module CanTango
-  module PermitEngine
-    class AccountPermit < CanTango::PermitEngine::Permit
+  module Permits
+    class AccountPermit < CanTango::Permit
 
       autoload_modules :Builder, :Finder
 
-      # fx for Admin account class, becomes simply AdminAccountPermit
+      def self.inherited(base_clazz)
+        CanTango.config.permits.register_permit_class account_type_name(base_clazz), base_clazz, type, account_name(base_clazz)
+      end
+
+      def self.type
+        :account
+      end
+
+      def self.account_type_name clazz
+        clazz.name.demodulize.gsub(/(.*)(AccountPermit)/, '\1').underscore.to_sym
+      end
+
       def account_type
-        self.class.name.demodulize.gsub(/(.*)(AccountPermit)/, '\1').underscore.to_sym
+        self.class.account_type_name self.class
       end
 
       # creates the permit

data/lib/cantango/{permit_engine → permits}/account_permit/builder.rb

@@ -1,6 +1,6 @@
 module CanTango
-  module PermitEngine
-    class AccountPermit < CanTango::PermitEngine::Permit
+  module Permits
+    class AccountPermit < CanTango::Permit
       class Builder < CanTango::PermitEngine::Builder::Base
         # class NoAvailableRoles < StandardError; end
 
@@ -11,10 +11,6 @@ module CanTango
           # raise NoAvailableRoles, "no available roles are defined" if available_roles.empty?
           [] << create_permit(user_account.class.to_s)
         end
-
-        def finder
-          CanTango::PermitEngine::AccountPermit::Finder
-        end
       end
     end
   end

data/lib/cantango/{permit_engine → permits}/account_permit/finder.rb

@@ -1,6 +1,6 @@
 module CanTango
-  module PermitEngine
-    class AccountPermit < CanTango::PermitEngine::Permit
+  module Permits
+    class AccountPermit < CanTango::Permit
       class Finder < CanTango::PermitEngine::Finder
         def initialize account, name
           super

data/lib/cantango/{permit_engine → permits}/license.rb

@@ -1,5 +1,5 @@
 module CanTango
-  module PermitEngine
+  module Permits
     class License
       autoload_modules :Loader, :Rules
 

data/lib/cantango/{permit_engine → permits}/license/loader.rb

@@ -1,4 +1,4 @@
-module CanTango::PermitEngine
+module CanTango::Permits
   class License
     module Loader
       def load_rules name = nil

data/lib/cantango/{permit_engine → permits}/license/rules.rb

@@ -1,4 +1,4 @@
-module CanTango::PermitEngine
+module CanTango::Permits
   class License
     module Rules
       def can(action, subject, conditions = nil, &block)

data/lib/cantango/permits/macros.rb

@@ -0,0 +1,19 @@
+class Module
+  def tango_permit options = {}
+    name_from_class_name = CanTango::Permits::Permit.first_name self.to_s.split("::").last
+    name = options[:name] || name_from_class_name
+
+    account_from_class_name = CanTango::Permits::Permit.first_name self.to_s.split("::").first if (self.to_s.split("::").size > 1)
+    account = options[:account] || account_from_class_name
+
+    type = options[:type] || self.superclass.type
+
+    raise "Name of permit could not be determined, try specifying a :name option" if name.nil?
+    raise "Type of permit could not be determined, try specifying a :type option" if type.nil?
+
+    CanTango.config.permits.register_permit_class name, self, type, account
+    # return hash for debugging
+    {:name => name, :type => type, :account => account}
+  end
+end
+

data/lib/cantango/{permit_engine → permits}/permit.rb

@@ -3,18 +3,30 @@ require 'sugar-high/array'
 # The permit base class for both Role Permits and Role Group Permits
 # Should contain all common logic
 module CanTango
-  module PermitEngine
+  module Permits
     class Permit
       attr_reader :ability
 
       # strategy is used to control the owns strategy (see rules.rb)
       attr_reader :strategy
 
+      include CanTango::Api::Attributes
+
       # creates the permit
       def initialize ability
         @ability  = ability
       end
 
+      def self.first_name clazz
+        clazz.to_s.gsub(/^([A-Za-z]+).*/, '\1').underscore.to_sym # first part of class name
+      end
+
+
+      def self.account_name clazz
+        return nil if clazz.name == clazz.name.demodulize
+        clazz.name.gsub(/::.*/,'').gsub(/(.*)Permits/, '\1').underscore.to_sym
+      end
+
       # executes the permit
       def execute
         executor.execute!

data/lib/cantango/{permit_engine → permits}/role_group_permit.rb

@@ -1,11 +1,23 @@
 module CanTango
-  module PermitEngine
-    class RoleGroupPermit < CanTango::PermitEngine::Permit
+  module Permits
+    class RoleGroupPermit < CanTango::Permit
 
       autoload_modules :Builder, :Finder
 
+      def self.inherited(base_clazz)
+        CanTango.config.permits.register_permit_class role_group_name(base_clazz), base_clazz, type, account_name(base_clazz)
+      end
+
+      def self.type
+        :role_group
+      end
+
+      def self.role_group_name clazz
+        clazz.name.demodulize.gsub(/(.*)(RoleGroupPermit)/, '\1').underscore.to_sym
+      end
+
       def role_group
-        self.class.name.demodulize.gsub(/(.*)(RoleGroupPermit)/, '\1').underscore.to_sym
+        self.class.role_group_name self.class
       end
 
       # creates the permit