cantango 0.9.3.2 → 0.9.4

data/README.textile

@@ -35,17 +35,17 @@ Run bundler in a terminal/console from the folder of your Gemfile (root folder o
 
 @$ bundle@
 
-h2. Update Oct 29, 2011
+h2. Update Nov 2, 2011
 
-Versions *0.9+* have naming bug. Please use version 0.8.9 for now.
+Version 0.9.4 has been released with the following featuring and improvements:
 
-New features:
+* Redesign of Cache and Ability execution
+  * Caching at the individual engine level that can be switched (configured) on/off
+  * Individual caching for each type of Permit in the Permit engine
+  * Each engine return a set of rules which are merged into one rule set for that particular execution mode
+* Caching for the new User AC engine
 
-* Model AC filters and scopes
-* Engine _:user_ac_ (User Access Control)
-* Cache and No-Cache modes for Ability, run in succession and rule results merged
-
-The :user_ac engine is a port of the Permission system from the _Rails in Action_ book. 
+The :user_ac engine is a port of the Permission system from the _Rails in Action_ book.
 With this engine a user can have many permissions defined, where each such permission is a persisted Permission model instance that describes a 'can' action on a specific type of object.
 
 The new modal Ability model allows you to define rules that are run in Cache mode and others that can be run in no-cache mode. This enables you to circumvent the previos restriction that didn't allow you to use normal conditional ruby logic outside blocks if you enabled caching.
@@ -53,16 +53,18 @@ The new modal Ability model allows you to define rules that are run in Cache mod
 <pre>
 class UserPermit < CanTango::UserPermit
   def static_rules
-    ...
+    can :access, Article
   end
 
   module Cached
     def permit_rules
+      can :read, Project
     end
   end
 
   module NonCached
     def permit_rules
+      can :edit, Article
     end
   end
 end

data/VERSION

@@ -1 +1 @@
-0.9.3.2
+0.9.4

data/cantango.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cantango}
-  s.version = "0.9.3.2"
+  s.version = "0.9.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Kristian Mandrup}, %q{Stanislaw Pankevich}]
-  s.date = %q{2011-10-29}
+  s.date = %q{2011-11-02}
   s.description = %q{Define your permission rules as role- or role group specific permits.
 Integrates well with multiple Devise user acounts.
 Includes rules caching.
@@ -41,7 +41,9 @@ Store permissions in yaml file or key-value store}
     "lib/cantango/ability/cache/session_cache.rb",
     "lib/cantango/ability/cache/writer.rb",
     "lib/cantango/ability/cache_helpers.rb",
+    "lib/cantango/ability/cached_executor.rb",
     "lib/cantango/ability/engine_helpers.rb",
+    "lib/cantango/ability/executor.rb",
     "lib/cantango/ability/masquerade_helpers.rb",
     "lib/cantango/ability/permission_helpers.rb",
     "lib/cantango/ability/permit_helpers.rb",
@@ -89,6 +91,12 @@ Store permissions in yaml file or key-value store}
     "lib/cantango/configuration/guest.rb",
     "lib/cantango/configuration/hash_registry.rb",
     "lib/cantango/configuration/models.rb",
+    "lib/cantango/configuration/models/active_record.rb",
+    "lib/cantango/configuration/models/data_mapper.rb",
+    "lib/cantango/configuration/models/generic.rb",
+    "lib/cantango/configuration/models/mongo.rb",
+    "lib/cantango/configuration/models/mongo_mapper.rb",
+    "lib/cantango/configuration/models/mongoid.rb",
     "lib/cantango/configuration/modes.rb",
     "lib/cantango/configuration/permit_registry.rb",
     "lib/cantango/configuration/permits.rb",
@@ -160,11 +168,15 @@ Store permissions in yaml file or key-value store}
     "lib/cantango/permits/account_permit.rb",
     "lib/cantango/permits/account_permit/builder.rb",
     "lib/cantango/permits/account_permit/finder.rb",
+    "lib/cantango/permits/executor.rb",
     "lib/cantango/permits/license.rb",
     "lib/cantango/permits/license/loader.rb",
     "lib/cantango/permits/license/rules.rb",
     "lib/cantango/permits/macros.rb",
     "lib/cantango/permits/permit.rb",
+    "lib/cantango/permits/permit/class_methods.rb",
+    "lib/cantango/permits/permit/execute.rb",
+    "lib/cantango/permits/permit/license.rb",
     "lib/cantango/permits/role_group_permit.rb",
     "lib/cantango/permits/role_group_permit/builder.rb",
     "lib/cantango/permits/role_group_permit/finder.rb",
@@ -191,14 +203,17 @@ Store permissions in yaml file or key-value store}
     "lib/cantango/rules.rb",
     "lib/cantango/rules/adaptor.rb",
     "lib/cantango/rules/adaptor/active_record.rb",
+    "lib/cantango/rules/adaptor/data_mapper.rb",
     "lib/cantango/rules/adaptor/generic.rb",
+    "lib/cantango/rules/adaptor/mongo.rb",
+    "lib/cantango/rules/adaptor/mongo_mapper.rb",
     "lib/cantango/rules/adaptor/mongoid.rb",
+    "lib/cantango/rules/adaptor/relational.rb",
     "lib/cantango/rules/dsl.rb",
     "lib/cantango/rules/rule_class.rb",
     "lib/cantango/rules/scope.rb",
     "lib/cantango/rules/user_relation.rb",
     "lib/cantango/user_ac_engine.rb",
-    "lib/cantango/user_ac_engine/executor.rb",
     "lib/cantango/users.rb",
     "lib/cantango/users/macros.rb",
     "lib/cantango/users/masquerade.rb",
@@ -299,6 +314,7 @@ Store permissions in yaml file or key-value store}
     "spec/cantango/ability/cache/session_cache_spec.rb",
     "spec/cantango/ability/cache/writer_spec.rb",
     "spec/cantango/ability/cache_spec.rb",
+    "spec/cantango/ability/executor_spec.rb",
     "spec/cantango/ability_executor/cached_only_spec.rb",
     "spec/cantango/ability_executor_spec.rb",
     "spec/cantango/ability_filters_spec.rb",
@@ -365,6 +381,7 @@ Store permissions in yaml file or key-value store}
     "spec/cantango/permission_engine/store_spec.rb",
     "spec/cantango/permission_engine/user_permission_store_spec.rb",
     "spec/cantango/permission_engine/yaml_store_spec.rb",
+    "spec/cantango/permission_engine_cached_spec.rb",
     "spec/cantango/permission_engine_spec.rb",
     "spec/cantango/permit_engine/account_permit_spec.rb",
     "spec/cantango/permit_engine/builder/role_group_permits_spec.rb",
@@ -378,10 +395,14 @@ Store permissions in yaml file or key-value store}
     "spec/cantango/permit_engine/role_group_permit_spec.rb",
     "spec/cantango/permit_engine/role_permit_spec.rb",
     "spec/cantango/permit_engine/user_permit_spec.rb",
+    "spec/cantango/permit_engine_cached_spec.rb",
     "spec/cantango/permit_engine_spec.rb",
+    "spec/cantango/permits/executor_cached_spec.rb",
+    "spec/cantango/permits/executor_spec.rb",
     "spec/cantango/permits/macros_spec.rb",
     "spec/cantango/permits/permit_spec.rb",
     "spec/cantango/rules_spec.rb",
+    "spec/cantango/user_ac_engine_cached_spec.rb",
     "spec/cantango/user_ac_engine_spec.rb",
     "spec/cantango_spec.rb",
     "spec/devise-dummy/Rakefile",

data/lib/cantango/ability/cache/key.rb

@@ -7,7 +7,7 @@ module CanTango
         def initialize user, subject = nil, method_names = nil
           @user = user
           @subject = subject || user
-          @method_names = method_names
+          @method_names = method_names if method_names
         end
 
         def method_names
@@ -19,7 +19,7 @@ module CanTango
         end
 
         def value
-          raise "No key could be generated for #{user} and #{subject}" if hash_values.empty?
+          raise "No key could be generated for User:#{user.inspect} and Subject:#{subject} - key field: #{user_key_field}" if hash_values.empty?
           @value ||= hash_values.hash
         end
 
@@ -28,6 +28,10 @@ module CanTango
           session[:cache_key] && (value == session[:cache_key].value)
         end
 
+        def to_s
+          "key hash: #{value}"
+        end
+
         protected
 
         def hash_values

data/lib/cantango/ability/cache/reader.rb

@@ -2,6 +2,8 @@ module CanTango
   class Ability
     class Cache
       class Reader
+        include CanTango::Helpers::Debug
+
         attr_reader :cache
 
         def initialize cache
@@ -9,6 +11,7 @@ module CanTango
         end
 
         def prepared_rules
+          debug "reading rules from cache: #{cache.key}"
           cache.compile_on? ? compiler.decompile!(loaded_rules) : loaded_rules
         end
 

data/lib/cantango/ability/cache/session_cache.rb

@@ -3,6 +3,7 @@ module CanTango
     class Cache
       class SessionCache < BaseCache
         attr_accessor :session
+        attr_reader   :key
 
         # will be called with :session => session (pointing to user session)
         def initialize name, options = {}
@@ -10,11 +11,15 @@ module CanTango
           @cache = cache
           @cache.configure_with :type => :memory
           raise "SessionCache must be initialized with a :session option" if !session
-          session[:rules_cache] = @cache
+          session[cache_key] = @cache
+        end
+
+        def cache_key
+          @cache_key ||= :rules_cache
         end
 
         def store
-          session[:rules_cache]
+          session[cache_key]
         end
 
         def load key
@@ -31,7 +36,6 @@ module CanTango
 
         def cache
           CanTango::Cache::HashCache.instance
-          # CanTango::Cache::MonetaCache.instance
         end
       end
     end

data/lib/cantango/ability/cache/writer.rb

@@ -2,7 +2,11 @@ module CanTango
   class Ability
     class Cache
       class Writer
-        attr_reader :cache
+        include CanTango::Helpers::Debug
+
+        attr_reader :cache, :cache_key
+
+        delegate :cache_key, :to => :cache
 
         def initialize cache
           @cache = cache
@@ -10,8 +14,10 @@ module CanTango
 
         def save key, rules
           cache.invalidate!
+          return if prepared_rules.blank?
+          debug "writing #{prepared_rules.size} rules to cache: #{key}"
           cache.rules_cache.save cache.key, prepared_rules
-          session[:cache_key] = cache.key if session
+          session[cache_key] = cache.key if session
         end
 
         protected

data/lib/cantango/ability/cache.rb

@@ -3,22 +3,39 @@ module CanTango
     class Cache
       autoload_modules :BaseCache, :SessionCache, :Reader, :Writer, :RulesCache, :Key
 
+      include CanTango::Helpers::Debug
+      include CanTango::Helpers::RoleMethods
+
       attr_reader :rules_cached, :ability
+      attr_writer :key_method_names, :cache_key
+
+      delegate :session, :cached?, :to => :ability
 
-      def initialize ability
+      def initialize ability, options = {}
         @ability = ability
+        @cache_key = options[:cache_key]
+        @key_method_names = options[:key_method_names]
+        debug "Creating cache with key: #{cache_key.inspect} on #{key_method_names.inspect}"
+      end
+
+      def empty?
+        cached_rules.blank?
+      end
+
+      def key_method_names
+        @key_method_names ||= [roles_list_meth, role_groups_list_meth]
       end
 
-      def session
-        ability.session
+      def cache_key
+        @cache_key ||= :cache
       end
 
       def cache_rules!
-        writer.save key, reader.prepared_rules
+        writer.save(key, reader.prepared_rules) if cached?
       end
 
       def cached_rules
-        @rules ||= reader.prepared_rules
+        @rules ||= reader.prepared_rules if cached?
       end
 
       def compiler
@@ -34,11 +51,11 @@ module CanTango
       end
 
       def cached_rules?
-        key.same? session
+        key.same?(session) && cached?
       end
 
       def key
-        @key ||= Key.new ability.user, ability.subject
+        @key ||= Key.new ability.user, ability.subject, key_method_names
       end
 
       def rules_cache
@@ -47,7 +64,7 @@ module CanTango
 
       def invalidate!
         raise "no session" if !session
-        rules_cache.invalidate! session[:cache_key]
+        rules_cache.invalidate! session[cache_key]
       end
 
       def compile_on?

data/lib/cantango/ability/cache_helpers.rb

@@ -1,21 +1,12 @@
 module CanTango
   class Ability
     module CacheHelpers
+      include CanTango::Helpers::RoleMethods
 
-      def cached_rules?
-        cache.key.same?(session)
-      end
-
-      def cache_rules!
-        cache.cache_rules!
-      end
-
-      def cached_rules
-        cache.cached_rules
-      end
+      delegate :cache_rules!, :cached_rules, :cached_rules?, :to => :cache
 
-      def cache
-        @cache ||= Cache.new self
+      def cache options = {}
+        @cache ||= CanTango::Ability::Cache.new self, options
       end
     end
   end

data/lib/cantango/ability/engine_helpers.rb

@@ -2,7 +2,10 @@ module CanTango
   class Ability
     module EngineHelpers
       def execute_engines!
-        each_engine {|engine| engine.new(self).execute! if engine  }
+        each_engine do |engine|
+          engine_rules = engine.new(self).execute! if engine
+          @rules << engine_rules if !engine_rules.blank?
+        end
       end
 
       def each_engine &block

data/lib/cantango/ability/executor.rb

@@ -0,0 +1,67 @@
+module CanTango
+  class Ability
+    module Executor
+      include CanTango::Helpers::Debug
+      include CanTango::Ability::CacheHelpers
+
+      delegate :session, :user, :subject, :candidate, :cached?, :to => :ability
+
+      def execute!
+        return if !valid?
+        start_execute
+        return cached_rules if cached? && cached_rules?
+
+        clear_rules!
+        permit_rules
+
+        cache_rules! if cached?
+        end_execute
+        rules
+      end
+
+      def rules
+        @rules ||= []
+      end
+
+      def clear_rules!
+        @rules ||= []
+      end
+
+      def permit_rules
+        raise NotImplementedError
+      end
+
+      def cache
+        @cache ||= CanTango::Ability::Cache.new self, :cache_key => cache_key, :key_method_names => key_method_names
+      end
+
+      def engine_name
+        :permit
+      end
+
+      def valid?
+        raise NotImplementedError
+      end
+
+      protected
+
+      def start_execute
+        debug "executing..."
+      end
+
+      def end_execute
+        debug "DONE"
+      end
+
+      def cache_key
+        raise NotImplementedError
+      end
+
+      def key_method_names
+        []
+      end
+    end
+  end
+end
+
+

data/lib/cantango/ability/permission_helpers.rb

@@ -9,4 +9,3 @@ module CanTango
     end
   end
 end
- 

data/lib/cantango/ability.rb

@@ -2,7 +2,7 @@ require 'cantango/permit_engine/util'
 
 module CanTango
   class Ability
-    autoload_modules :Scope, :Cache
+    autoload_modules :Scope, :Cache, :Executor
     autoload_modules :MasqueradeHelpers, :PermitHelpers, :PermissionHelpers
     autoload_modules :UserHelpers, :RoleHelpers, :CacheHelpers, :EngineHelpers
 

data/lib/cantango/cached_ability.rb

@@ -6,13 +6,14 @@ module CanTango
       raise "Candidate must be something!" if !candidate
       @candidate, @options = candidate, options
 
-      return if cached_rules?
+      # return if cached_rules?
 
       clear_rules!
       permit_rules
 
       execute_engines! if engines_on?
-      cache_rules!
+
+      # cache_rules!
     end
 
     def cached?

data/lib/cantango/configuration/engines/cache.rb

@@ -1,10 +1,7 @@
-require 'singleton'
-
 module CanTango
   class Configuration
     class Engines
       class Cache < Engine
-        include Singleton
 
         def compile state
           raise "Must be set to :on or :off" if ![:on, :off].include? state

data/lib/cantango/configuration/engines/engine.rb

@@ -1,7 +1,12 @@
+require 'singleton'
+
 module CanTango
   class Configuration
     class Engines
       class Engine
+        include Singleton
+        include CanTango::Configuration::Modes
+
         def set state = :on
           raise ArgumentError, "Must be :on or :off" unless !state || [:on, :off].include?(state)
           @state = state || :on

data/lib/cantango/configuration/engines/permission.rb

@@ -4,9 +4,6 @@ module CanTango
   class Configuration
     class Engines
       class Permission < Engine
-        include Singleton
-        include CanTango::Configuration::Modes
-
         def modes
           @modes ||= [:cache]
         end
@@ -34,9 +31,13 @@ module CanTango
 
         private
 
+        def valid_mode_names
+          [:cache, :no_cache]
+        end
+ 
         def current_config_path
           @config_path ||= File.join(::Rails.root.to_s, 'config') if rails?
-          @config_path or raise "Define path to config files dir!\n"
+          @config_path or raise "Define path to config files dir!\nCanTango.config.engine(:permission).config_path(dir_path)"
         end
 
         def rails?

data/lib/cantango/configuration/engines/permit.rb

@@ -1,12 +1,7 @@
-require 'singleton'
-
 module CanTango
   class Configuration
     class Engines
       class Permit < Engine
-        include Singleton
-        include CanTango::Configuration::Modes
-
         def on?
           @state ||= :on
           @state == :on

data/lib/cantango/configuration/engines/user_ac.rb

@@ -4,12 +4,15 @@ module CanTango
   class Configuration
     class Engines
       class UserAc < Engine
-        include Singleton
-        include CanTango::Configuration::Modes
-
         def modes
           @modes ||= [:no_cache]
         end
+
+        private
+
+        def valid_mode_names
+          [:cache, :no_cache]
+        end
       end
     end
   end

data/lib/cantango/configuration/models/active_record.rb

@@ -0,0 +1,11 @@
+module CanTango
+  class Configuration
+    class Models
+      class ActiveRecord < Generic
+       def models
+          ActiveRecord::Base.descendants
+        end
+      end
+    end
+  end
+end

data/lib/cantango/configuration/models/data_mapper.rb

@@ -0,0 +1,12 @@
+module CanTango
+  class Configuration
+    class Models
+      class DataMapper < Generic
+        def models
+          DataMapper::Resource.descendants
+        end
+      end
+    end
+  end
+end
+

data/lib/cantango/configuration/models/generic.rb

@@ -0,0 +1,12 @@
+module CanTango
+  class Configuration
+    class Models
+      class Generic
+        def available_models
+          models.map(&:name)
+        end
+      end
+    end
+  end
+end
+

data/lib/cantango/configuration/models/mongo.rb

@@ -0,0 +1,12 @@
+module CanTango
+  class Configuration
+    class Models
+      class Mongo
+        def available_models
+          models.map {|m| m.to_s.camelize }
+        end
+      end
+    end
+  end
+end
+

data/lib/cantango/configuration/models/mongo_mapper.rb

@@ -0,0 +1,11 @@
+module CanTango
+  class Configuration
+    class Models
+      module MongoMapper < Mongo
+        def models
+          MongoMapper.database.collections
+        end
+      end
+    end
+  end
+end

data/lib/cantango/configuration/models/mongoid.rb

@@ -0,0 +1,13 @@
+module CanTango
+  class Configuration
+    class Models
+      class Mongoid < Mongo
+        def models
+          ::Mongoid.database.collections
+        end
+      end
+    end
+  end
+end
+
+