cantango-core 0.1.0

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cantango-core.gemspec

@@ -0,0 +1,177 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cantango-core"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup", "Stanislaw Pankevich"]
+  s.date = "2011-11-25"
+  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 = [
+    "LICENSE.txt",
+    "README.mdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mdown",
+    "Rakefile",
+    "VERSION",
+    "cantango-core.gemspec",
+    "lib/cantango/ability.rb",
+    "lib/cantango/ability/base.rb",
+    "lib/cantango/ability/cache.rb",
+    "lib/cantango/ability/cache/key.rb",
+    "lib/cantango/ability/cached.rb",
+    "lib/cantango/ability/executor.rb",
+    "lib/cantango/ability/executor/base.rb",
+    "lib/cantango/ability/executor/cache_mode.rb",
+    "lib/cantango/ability/executor/modes.rb",
+    "lib/cantango/ability/executor/no_cache_mode.rb",
+    "lib/cantango/ability/helper.rb",
+    "lib/cantango/ability/helper/account.rb",
+    "lib/cantango/ability/helper/engine.rb",
+    "lib/cantango/ability/helper/role.rb",
+    "lib/cantango/ability/helper/role_group.rb",
+    "lib/cantango/ability/helper/user.rb",
+    "lib/cantango/cancan/rule.rb",
+    "lib/cantango/core.rb",
+    "lib/cantango/engine.rb",
+    "lib/cantango/filter.rb",
+    "lib/cantango/filter/base.rb",
+    "lib/cantango/helpers.rb",
+    "lib/cantango/helpers/debug.rb",
+    "lib/cantango/loader.rb",
+    "lib/cantango/loader/yaml.rb",
+    "lib/cantango/macros.rb",
+    "lib/cantango/macros/account.rb",
+    "lib/cantango/macros/user.rb",
+    "lib/cantango/model.rb",
+    "lib/cantango/model/guest.rb",
+    "lib/cantango/rails.rb",
+    "lib/cantango/rails/engine.rb",
+    "lib/cantango/rails/helpers/base_helper.rb",
+    "lib/cantango/rails/helpers/controller_helper.rb",
+    "lib/cantango/rails/helpers/rest_helper.rb",
+    "lib/cantango/rails/helpers/view_helper.rb",
+    "lib/cantango/rails/railtie.rb",
+    "lib/cantango/rspec.rb",
+    "lib/cantango/rspec/config.rb",
+    "lib/cantango/rspec/matchers.rb",
+    "lib/cantango/rspec/matchers/be_allowed_to.rb",
+    "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/relation.rb",
+    "lib/cantango/rules/rule_class.rb",
+    "lib/cantango/rules/scope.rb",
+    "lib/cantango/scope.rb",
+    "lib/cantango/scope/ability.rb",
+    "lib/generators/cantango/install/install_generator.rb",
+    "lib/generators/cantango/install/templates/cantango.rb",
+    "lib/generators/cantango/install/templates/categories.yml",
+    "lib/generators/cantango/install/templates/permissions.yml",
+    "spec/cantango/ability/base_spec.rb",
+    "spec/cantango/ability/cached_spec.rb",
+    "spec/cantango/ability/executor/base2.rb",
+    "spec/cantango/ability/executor/base_spec.rb",
+    "spec/cantango/ability/executor/cache_mode_spec.rb",
+    "spec/cantango/ability/executor/modes_spec.rb",
+    "spec/cantango/ability/executor/no_cache_mode_spec.rb",
+    "spec/cantango/cancan/rule_spec.rb",
+    "spec/cantango/core_spec.rb",
+    "spec/cantango/engine_spec.rb",
+    "spec/cantango/filter/base_spec.rb",
+    "spec/cantango/helpers/debug_spec.rb",
+    "spec/cantango/loader/yaml_spec.rb",
+    "spec/cantango/macros/account_spec.rb",
+    "spec/cantango/macros/user_spec.rb",
+    "spec/cantango/rspec/be_allowed_to_spec.rb",
+    "spec/cantango/rules/adaptor/active_record_spec.rb",
+    "spec/cantango/rules/adaptor/data_mapper_spec.rb",
+    "spec/cantango/rules/adaptor/mongo_mapper_spec.rb",
+    "spec/cantango/rules/adaptor/mongoid_spec.rb",
+    "spec/cantango/rules/adaptor_spec.rb",
+    "spec/cantango/rules/dsl_spec.rb",
+    "spec/cantango/rules/relation_spec.rb",
+    "spec/cantango/rules/rule_class_spec.rb",
+    "spec/cantango/rules/scope_spec.rb",
+    "spec/cantango/rules_spec.rb",
+    "spec/cantango/scope/ability_spec.rb",
+    "spec/cantango_spec.rb",
+    "spec/generators/cantango/install_generator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/cantango"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "CanCan extension with role oriented permission management and more"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.1"])
+      s.add_runtime_dependency(%q<cancan>, [">= 1.4"])
+      s.add_runtime_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<sweetloader>, ["~> 0.1.0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 2.6.1"])
+      s.add_development_dependency(%q<forgery>, [">= 0.3"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.rc"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0.9.2.2"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.1"])
+      s.add_dependency(%q<cancan>, [">= 1.4"])
+      s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+      s.add_dependency(%q<sweetloader>, ["~> 0.1.0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 2.6.1"])
+      s.add_dependency(%q<forgery>, [">= 0.3"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<bundler>, [">= 1.1.rc"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0.9.2.2"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.1"])
+    s.add_dependency(%q<cancan>, [">= 1.4"])
+    s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
+    s.add_dependency(%q<sweetloader>, ["~> 0.1.0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 2.6.1"])
+    s.add_dependency(%q<forgery>, [">= 0.3"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<bundler>, [">= 1.1.rc"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0.9.2.2"])
+  end
+end
+

data/lib/cantango/ability.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Ability    
+    autoload_modules :Base, :Cache, :Cached, :Executor, :Helper
+  end
+end

data/lib/cantango/ability/base.rb

@@ -0,0 +1,61 @@
+module CanTango
+  module Ability
+    class Base
+      include CanCan::Ability
+
+      attr_reader :options, :candidate
+
+      # Equivalent to a CanCan Ability#initialize call
+      # which executes all the permission logic
+      def initialize candidate, options = {}
+        raise "Candidate must be something!" if !candidate
+        @candidate, @options = candidate, options
+
+        clear_rules!
+        permit_rules
+
+        execute_engines! if engines_on?
+      end
+
+      def cached?
+        false
+      end
+
+      def rules
+        @rules
+      end
+
+      # developer can add rules here to be included in all subclasses!
+      def permit_rules
+      end
+
+      def clear_rules!
+        @rules ||= default_rules
+      end
+
+      def session
+        @session = options[:session] || {} # seperate session cache for each type of user?
+      end
+
+      def subject
+        return candidate.active_user if masquerade_user?
+        return candidate.active_account if masquerade_account?
+        candidate
+      end
+
+      def config
+        CanTango.config
+      end
+
+      Helper.modules.each do |name|
+        include "CanTango::Ability::Helper::#{name.to_s.camelize}".constantize
+      end
+    
+      protected
+
+      def default_rules
+        []
+      end
+    end
+  end
+end

data/lib/cantango/ability/cache.rb

@@ -0,0 +1,7 @@
+module CanTango
+  module Ability
+    module Cache
+      autoload_modules :Key
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module CanTango
+  module Ability
+    module Cache
+      class Key
+        attr_reader :user, :subject
+
+        def initialize user, subject = nil
+          @user = user
+          @subject = subject || user
+        end
+
+        def self.create_for ability
+          self.new ability.user, ability.subject
+        end
+
+        def value
+          raise "No key could be generated for User:#{user.inspect} and Subject:#{subject} - key field: #{user_key_field}" if !user_key
+          @value ||= user_key.hash
+        end
+
+        def to_s
+          "key hash: #{value}"
+        end
+
+        protected
+
+        def user_key
+          # raise "#{user.class} must have a method ##{user_key_field}. You can configure this with CanTango.config#user.unique_key_field" if !user.respond_to?(user_key_field)
+          user.send(user_key_field) if user.respond_to? user_key_field
+        end
+
+        def user_key_field
+          CanTango.config.user.unique_key_field || :email
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/cached.rb

@@ -0,0 +1,28 @@
+module CanTango
+  module Ability
+    class Cached < Base
+      # Equivalent to a CanCan Ability#initialize call
+      # which executes all the permission logic
+      def initialize candidate, options = {}
+        raise "Candidate must be something!" if !candidate
+        @candidate, @options = candidate, options
+
+        # return if cached_rules?
+
+        clear_rules!
+        permit_rules
+
+        execute_engines! if engines_on?
+
+        # cache_rules!
+      end
+
+      def cached?
+        true
+      end
+
+      def permit_rules
+      end
+    end
+  end
+end

data/lib/cantango/ability/executor.rb

@@ -0,0 +1,7 @@
+module CanTango
+  module Ability
+    module Executor
+      autoload_modules :Base, :CacheMode, :NoCacheMode, :Modes
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module CanTango
+  module Ability
+    module Executor
+      class Base
+        include CanTango::Helpers::Debug
+
+        delegate :session, :user, :subject, :candidate, :cached?, :to => :ability
+
+        def execute!
+          return if !valid?
+          start_execute
+          return if cached? # rule set already loaded
+
+          clear_rules!
+          permit_rules
+
+          end_execute
+          rules # return rule set
+        end
+
+        def rules
+          @rules ||= []
+        end
+
+        def clear_rules!
+          @rules ||= []
+        end
+
+        def permit_rules
+          raise NotImplementedError
+        end
+
+        def cached?
+          false
+        end
+
+        protected
+
+        def start_execute
+          debug "Executing base Ability"
+        end
+
+        def end_execute
+          debug "DONE"
+        end
+
+        def key_method_names
+          []
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/executor/cache_mode.rb

@@ -0,0 +1,33 @@
+module CanTango
+  class Ability
+    module Executor
+      class CachedMode < Base
+        include CanTango::Ability::CacheHelpers
+
+        # FIX! no reason for double cache check!
+        def cached?
+          @rules = cached_rules if cached_rules? && caching_on?
+        end
+
+       def cache
+          @cache ||= cache_class.new self, :cache_key => cache_key, :key_method_names => key_method_names
+        end
+
+        protected
+
+        def cache_class
+          CanTango::Ability::Cache
+        end
+
+        def start_execute
+          debug "Executing cached ability"
+        end
+
+        def end_execute
+          cache_rules! if caching_on?
+          debug "DONE"
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/executor/modes.rb

@@ -0,0 +1,52 @@
+module CanTango
+  module Ability
+    module Executor
+      class Modes < Base
+        def initialize candidate, options = {}
+          raise "Candidate must be something!" if !candidate
+          @candidate, @options = [candidate, options]
+          calculate_modal_rules.normalize!
+        end
+
+        def rules
+          @rules ||= []
+        end
+
+        def modal_rules mode
+          mode?(mode) ? get_ability(mode).rules : []
+        end
+
+        protected
+
+        def calculate_modal_rules
+          @rules = modes.inject([]) do |result, mode|
+            result = result + modal_rules(mode)
+            result
+          end
+          self
+        end
+
+        def normalize!
+          rules.flatten!
+          rules.compact!
+        end
+
+        def get_ability mode
+          ability_class_for(mode).new candidate, options
+        end
+
+        def ability_class_for mode
+          mode == :cache ? CanTango::Ability::Cached : CanTango::Ability::NonCached
+        end
+
+        def mode? mode
+          modes.include?(mode)
+        end
+
+        def modes
+          CanTango.config.ability.modes
+        end
+      end
+    end
+  end
+end