cantango 0.9.4.3 → 0.9.4.5

data/README.textile

@@ -2,12 +2,13 @@ h1. CanTango
 
 CanTango is an advanced Access Control (permissions) system for Rails 3. It:
 
-* extends "CanCan":http://github.com/ryanb/cancan and offers a more role oriented design
+* extends "CanCan":http://github.com/ryanb/cancan and offers a more granular Object Oriented design
 * integrates with _role_ and _authentication_ systems in a non-intrusive manner
 * can _cache_ ability rules between requests for increased performance
-* can _store_ abilites in a permission store, including a YAML file, for easy administration
-* works well with multiple user accounts and sub applications
-* supports multiple "Devise":https://github.com/plataformatec/devise users
+* allows for context specific "Permits":https://github.com/kristianmandrup/cantango/wiki/Permits with rules
+* supports multiple "Devise":https://github.com/plataformatec/devise users/accounts
+* can _store_ static ability rules in a permission store for easy administration
+* manage the permission store from a web UI using the "cantango_editor":https://github.com/stanislaw/cantango_editor, a mountable Rails engine
 
 h3. Will CanTango meet my Access Control (permission) requirements?
 
@@ -35,47 +36,11 @@ Run bundler in a terminal/console from the folder of your Gemfile (root folder o
 
 @$ bundle@
 
-h2. Update Nov 4, 2011
+h2. Update Nov 21, 2011
 
-Version 0.9.4.2 has been released with the following features and improvements:
+Version 0.9.4.5 has been released. Fixes bug in configuration/permit_registry.
 
-* 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
-* Ability to register your own Permit base classes simply by subclassing CanTango::Permit!
-  * This is useful if you want to go beyond the built in types, see the @custom_permit_spec.rb@ for an example
-* Some bug fixes!
-
-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.
-
-<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
-</pre>
-
-Any rule method defined directly for the permit is run for any (or both) modes. To define rules specifically for cache or no-cache modes, you should place them in a nested module to signify this as shown in this example.
-
-You can configure modes with the new config object @CanTango.config.ability.modes@ and set it via @CanTango.config.ability.mode = :no_cache@ . The valid modes are: :cache, :no_cache, and :both. You can similarly configure which modes each engine should participate in, fx via @CanTango.config.permit_engine.mode = :cache@
+The "wiki":https://github.com/kristianmandrup/cantango/wiki has been rewritten and updated to reflect all latest design changes and feature additions.
 
 h2. Quickstart
 
@@ -95,7 +60,7 @@ Simply start with:
 
 * cantango:install
 
-To use the Permit generators please see the Generators wiki page ;)
+To use the Permit generators please see the "Generators":https://github.com/kristianmandrup/cantango/wiki/Generators page ;)
 
 h3. Rails 3 configuration
 
@@ -118,19 +83,17 @@ Abilities can be defined for the following conceptual entities:
 * Role groups
 * Users
 
-h3. Debugging Abilities and Permits
-
-See "Debugging permits"::https://github.com/kristianmandrup/cantango/wiki/Debugging-permits
+You can even create your own Permit types to suit your own needs! This feature will be further improved in the upcoming 1.0 release.
 
 h3. Design overview
 
 The default CanTango Ability pattern is simple.
 
-1. Return cached ability rules for candidate if available
+1. Return cached ability rules for candidate if available (and cache is on)
 2. Generate rules for candidate
-3. Cache rules for candidate
+3. Cache rules for candidate (if cache is on)
 
-A candidate is typically either a user or an account instance.
+An ability candidate is typically either a user or an account instance.
 
 Caching can be enabled or disabled. To generate the rules, one or more engines are executed.
 
@@ -139,7 +102,7 @@ CanTango comes with the following engines:
 * "Permit engine"::https://github.com/kristianmandrup/cantango/wiki/Permit-engine
 * "Permission engine":https://github.com/kristianmandrup/cantango/wiki/Permission-engine
 
-You can however freely plugin or unplug engines as you wish as described in "Pluggable engines":https://github.com/kristianmandrup/cantango/wiki/Pluggable-engines
+You can however freely plugin or unplug engines as you wish as described in "Engines":https://github.com/kristianmandrup/cantango/wiki/Engines
 
 h3. Dependencies, Adapters and Loading
 

data/VERSION

@@ -1 +1 @@
-0.9.4.3
+0.9.4.5

data/cantango.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cantango}
-  s.version = "0.9.4.3"
+  s.version = "0.9.4.5"
 
   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-11-05}
+  s.date = %q{2011-11-21}
   s.description = %q{Define your permission rules as role- or role group specific permits.
 Integrates well with multiple Devise user acounts.
 Includes rules caching.
@@ -332,6 +332,7 @@ Store permissions in yaml file or key-value store}
     "spec/cantango/api/user_account/scope_api_spec.rb",
     "spec/cantango/api/user_account_api_spec.rb",
     "spec/cantango/api/user_api_spec.rb",
+    "spec/cantango/api_spec.rb",
     "spec/cantango/cached_ability_spec.rb",
     "spec/cantango/configuration/ability_spec.rb",
     "spec/cantango/configuration/adapter_spec.rb",

data/lib/cantango/ability_executor.rb

@@ -1,12 +1,16 @@
 module CanTango
   class AbilityExecutor < CanTango::Ability
-    attr_reader :rules
 
     def initialize candidate, options = {}
       raise "Candidate must be something!" if !candidate
       @candidate, @options = [candidate, options]
       @rules = cached_rules + non_cached_rules
-      @rules.flatten!.compact!
+      rules.flatten!
+      rules.compact!
+    end
+
+    def rules
+      @rules ||= []
     end
 
     def cached_rules

data/lib/cantango/api.rb

@@ -1,5 +1,14 @@
 module CanTango
   module Api
     autoload_modules :User, :UserAccount, :Options, :Common, :Attributes
+
+    def self.apis
+      [:Can, :Scope, :Ability, :Session]
+    end
+
+    apis.each do |api|
+      self.extend "CanTango::Api::User::#{api}".constantize
+      self.extend "CanTango::Api::UserAccount::#{api}".constantize
+    end
   end
 end

data/lib/cantango/configuration/permit_registry.rb

@@ -1,9 +1,9 @@
 module CanTango
   class Configuration
     class PermitRegistry
-      def get permit
-        raise ArgumentError, "Not an available permit" if !CanTango.config.permits.available_types.include? permit
-        inst_var_name = "@#{permit}"
+      def get_permit label
+        raise ArgumentError, "Not an available permit" if !CanTango.config.permits.available_types.include? label
+        inst_var_name = "@#{label}"
         instance_variable_set(inst_var_name, HashRegistry.new) if !instance_variable_get(inst_var_name)
         instance_variable_get(inst_var_name)
       end
@@ -17,7 +17,7 @@ module CanTango
       end
 
       def all
-        (CanTango.config.permits.available_types - [:special]).map{|p| send(p) if respond_to?(p)}
+        (CanTango.config.permits.available_types - [:special]).map{|label| get_permit(label) }
       end
 
       def show_all

data/lib/cantango/configuration/permits.rb

@@ -78,11 +78,11 @@ module CanTango
       end
 
       def register_permit_class(permit_name, permit_clazz, permit_type, account_name)
-        registry = account_name ? self.send(account_name.to_sym) : self
+        registry = account_name ? get_permit(account_name.to_sym) : self
         debug "Registering #{permit_type} permit: #{permit_name} of class #{permit_clazz}"
 
         registry.get(permit_type)[permit_name] = permit_clazz
-        debug registry.get(permit_type).inspect
+        debug registry.get_permit(permit_type).inspect
       end
 
       def allowed candidate, actions, subjects, *extra_args

data/lib/cantango/rails/helpers/base_helper.rb

@@ -12,13 +12,14 @@ module CanTango
           def include_apis(clazz)
             return if !respond_to?(:apis) || !apis
             apis.each do |api|
+              # puts "include API: #{api}"
               clazz.send :include, "CanTango::Api::User::#{api}".constantize
               clazz.send :include, "CanTango::Api::UserAccount::#{api}".constantize
             end
           end
 
           def apis
-            [:Can, :Scope]
+            [:Can, :Scope, :Ability, :Session]
           end
         end
         extend ClassMethods

data/spec/cantango/api_spec.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'cantango'
+require 'fixtures/models'
+require 'cantango/rspec'
+
+def config_folder
+  File.dirname(__FILE__)+ "/../fixtures/config/"
+end
+
+describe CanTango::Api do
+  subject { CanTango::Api }
+
+  specify { subject.methods.should include(:current_user_ability) }
+end

data/spec/cantango/configuration/permit_registry_spec.rb

@@ -5,9 +5,9 @@ describe CanTango::Configuration::PermitRegistry do
     @permit_registry = CanTango::Configuration::PermitRegistry.new
   end
 
-  it "should respond to permits groups methods" do
-    [:user, :account, :role, :role_group].each do |permit_group|
-      @permit_registry.should respond_to(permit_group)
+  it '#get_permit should respond to default permit types' do
+    [:user, :account, :role, :role_group].each do |type|
+      @permit_registry.get_permit(type).should_not be_nil
     end
   end
 

data/spec/cantango/configuration/permits_spec.rb

@@ -38,24 +38,10 @@ describe CanTango::Configuration::Permits do
     @permit_registry = CanTango::Configuration::Permits.instance
   end
 
-  it "should respond to permits groups methods" do
-    [:user, :account, :role, :role_group].each do |permit_group|
-      @permit_registry.should respond_to(permit_group)
-    end
-  end
-
   it "should treat missing methods as account keys" do
     @permit_registry.any_method.should be_kind_of(CanTango::Configuration::PermitRegistry)
   end
 
-  context "account keys" do
-    it "should behave like PermitRegistry" do
-      [:user, :account, :role, :role_group].each do |permit_group|
-        @permit_registry.admin_account.should respond_to(permit_group) 
-      end
-    end
-  end
-
   describe 'debugging permits' do
     let(:context) { Context.new }
     let (:user) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cantango
 version: !ruby/object:Gem::Version
-  version: 0.9.4.3
+  version: 0.9.4.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000Z
+date: 2011-11-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70093336203760 !ruby/object:Gem::Requirement
+  requirement: &70220124631000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70093336203760
+  version_requirements: *70220124631000
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &70093336203220 !ruby/object:Gem::Requirement
+  requirement: &70220124630520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70093336203220
+  version_requirements: *70220124630520
 - !ruby/object:Gem::Dependency
   name: sugar-high
-  requirement: &70093336202700 !ruby/object:Gem::Requirement
+  requirement: &70220124630020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70093336202700
+  version_requirements: *70220124630020
 - !ruby/object:Gem::Dependency
   name: sweetloader
-  requirement: &70093336202180 !ruby/object:Gem::Requirement
+  requirement: &70220124629400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70093336202180
+  version_requirements: *70220124629400
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70093336201600 !ruby/object:Gem::Requirement
+  requirement: &70220124628760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70093336201600
+  version_requirements: *70220124628760
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70093336201060 !ruby/object:Gem::Requirement
+  requirement: &70220124628100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.6.1
   type: :development
   prerelease: false
-  version_requirements: *70093336201060
+  version_requirements: *70220124628100
 - !ruby/object:Gem::Dependency
   name: forgery
-  requirement: &70093336200540 !ruby/object:Gem::Requirement
+  requirement: &70220124627420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70093336200540
+  version_requirements: *70220124627420
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70093336200000 !ruby/object:Gem::Requirement
+  requirement: &70220124626940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093336200000
+  version_requirements: *70220124626940
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70093336199500 !ruby/object:Gem::Requirement
+  requirement: &70220124620920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093336199500
+  version_requirements: *70220124620920
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70093336198960 !ruby/object:Gem::Requirement
+  requirement: &70220124620260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093336198960
+  version_requirements: *70220124620260
 - !ruby/object:Gem::Dependency
   name: dkastner-moneta
-  requirement: &70093336198420 !ruby/object:Gem::Requirement
+  requirement: &70220124619620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +132,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70093336198420
+  version_requirements: *70220124619620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70093336197860 !ruby/object:Gem::Requirement
+  requirement: &70220124618860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,10 +143,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70093336197860
+  version_requirements: *70220124618860
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70093336197320 !ruby/object:Gem::Requirement
+  requirement: &70220124618380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -154,10 +154,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70093336197320
+  version_requirements: *70220124618380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70093336196800 !ruby/object:Gem::Requirement
+  requirement: &70220124617720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -165,10 +165,10 @@ dependencies:
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *70093336196800
+  version_requirements: *70220124617720
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70093336196280 !ruby/object:Gem::Requirement
+  requirement: &70220124617020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -176,7 +176,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70093336196280
+  version_requirements: *70220124617020
 description: ! 'Define your permission rules as role- or role group specific permits.
 
   Integrates well with multiple Devise user acounts.
@@ -503,6 +503,7 @@ files:
 - spec/cantango/api/user_account/scope_api_spec.rb
 - spec/cantango/api/user_account_api_spec.rb
 - spec/cantango/api/user_api_spec.rb
+- spec/cantango/api_spec.rb
 - spec/cantango/cached_ability_spec.rb
 - spec/cantango/configuration/ability_spec.rb
 - spec/cantango/configuration/adapter_spec.rb
@@ -872,7 +873,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -442753695255517293
+      hash: -477019430598223523
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: