cantango-core 0.1.0

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

@@ -0,0 +1,17 @@
+module CanTango
+  module Ability
+    module Executor
+      class NonCachedMode < Base
+        protected
+
+        def start_execute
+          debug "Executing non-cached Ability"
+        end
+
+        def end_execute
+          debug "DONE"
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/helper.rb

@@ -0,0 +1,11 @@
+module CanTango
+  module Ability
+    module Helper
+      def self.modules
+        [:Account, :Cache, :Engine, :Masquerade, :Permit, :PermitStore, :Role, :RoleGroup, :User]
+      end
+      
+      autoload_modules *modules
+    end
+  end
+end

data/lib/cantango/ability/helper/account.rb

@@ -0,0 +1,13 @@
+module CanTango
+  class Ability
+    module Helper
+      module Account
+        def user_account
+          return subject.active_account if subject.respond_to? :active_account
+          subject
+        end
+        alias_method :account, :user_account
+      end
+    end
+  end
+end

data/lib/cantango/ability/helper/engine.rb

@@ -0,0 +1,32 @@
+module CanTango
+  class Ability
+    module Helper
+      module Engine
+        def execute_engines!
+          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
+          engines.execution_order.each do |name|
+            yield engines.registered[name] if engines.active? name
+          end
+        end
+
+        def opts_engines_off?
+          options[:engines] == :off
+        end
+
+         def engines_on?
+          CanTango.config.engines.any?(:on) && !opts_engines_off?
+        end
+
+        def engines
+          CanTango.config.engines
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/helper/role.rb

@@ -0,0 +1,21 @@
+module CanTango
+  class Ability
+    module Helper
+      module Role
+        include CanTango::Helpers::RoleMethods
+
+        # return list roles the user has
+        def roles
+          return [] if !subject.respond_to?(roles_list_meth) || roles_of(subject).blank?
+          roles_of(subject).flatten
+        end
+
+        protected
+
+        def roles_of subject
+          @subj_roles ||= subject.send(roles_list_meth)
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/helper/role_group.rb

@@ -0,0 +1,21 @@
+module CanTango
+  class Ability
+    module Helper
+      module RoleGroup
+        include CanTango::Helpers::RoleMethods
+
+        # return list of symbols for role groups the user belongs to
+        def role_groups
+          return [] if !subject.respond_to?(role_groups_list_meth) || role_groups_of(subject).blank?
+          role_groups_of(subject).flatten
+        end
+
+        protected
+
+        def role_groups_of subject
+          @subj_role_groups ||= subject.send(role_groups_list_meth)
+        end
+      end
+    end
+  end
+end

data/lib/cantango/ability/helper/user.rb

@@ -0,0 +1,18 @@
+module CanTango
+  class Ability
+    module Helper
+      module User
+        def user
+          return subject.user if subject.respond_to? :user
+          subject
+        end
+
+        def user_key_field
+          key_field = config.user.unique_key_field
+          raise "\nModel <#{user.class}> has no ##{key_field} as defined in CanTango.config.user.unique_key_field" if !user.respond_to?(key_field)
+          key_field
+        end
+      end
+    end
+  end
+end

data/lib/cantango/cancan/rule.rb

@@ -0,0 +1,6 @@
+module CanCan
+  class Rule
+    attr_accessor :block
+  end
+end
+

data/lib/cantango/core.rb

@@ -0,0 +1,84 @@
+require 'cantango/rails/railtie' if defined?(Rails)
+require 'cantango/rails/engine' if defined?(Rails)
+
+# essential cantango extensions
+# require 'cantango/config'
+# require 'cantango/api'
+
+require 'cancan'
+require 'active_support' # for Delegate module
+require 'active_support/core_ext/module/delegation'
+
+require 'cantango/cancan/rule'
+require 'sugar-high/array'
+require 'sugar-high/blank'
+require 'hashie'
+require 'sweetloader'
+
+AutoLoader.namespaces = {:CanTango => 'cantango'}
+
+module CanTango
+  autoload_modules :Ability, :Engine, :Filter
+  autoload_modules :Helpers, :Loader, :Macros, :Model
+  autoload_modules :Rails, :Rules, :Scope
+
+  class << self
+    def configure &block
+      conf = CanTango::Configuration.instance
+      yield conf if block
+      conf
+    end
+
+    alias_method :config, :configure
+
+    # Engine hook
+    # Run after the initializers are ran for all Railties (including the application itself), but before eager loading and the middleware stack is built. 
+    # More importantly, will run upon every request in development, but only once (during boot-up) in production and test.
+    def to_prepare
+      config.hook(:to_prepare).call if config.hook(:to_prepare)
+    end
+
+    # engine hook, run after all Rails initializations have been executed
+    def after_initialize
+      config.hook(:after_initialize).call if config.hook(:after_initialize)
+    end
+
+    def permits_allowed candidate, actions, subjects, *extra_args
+      raise "Debugging has not been turned on. Turn it on using: CanTango.debug!" if CanTango.config.debug.off?
+      config.permits.allowed candidate, actions, subjects, *extra_args
+    end
+
+    def permits_denied candidate, actions, subjects, *extra_args
+      raise "Debugging has not been turned on. Turn it on using: CanTango.debug!" if CanTango.config.debug.off?
+      config.permits.denied candidate, actions, subjects, *extra_args
+    end
+
+    def debug_permits_registry
+      puts "permits registry:" << CanTango.config.permits.show_all.inspect
+    end
+
+    def debug_ability candidate, actions, subjects, *extra_args
+      puts "Ability: #{actions} on #{subjects}"
+      puts "permits allowed:" << permits_allowed(candidate, actions, subjects, *extra_args).inspect
+      puts "permits denied:"  << permits_denied(candidate, actions, subjects, *extra_args).inspect
+    end
+
+    def clear_permits_executed!
+      config.permits.clear_executed!
+    end
+
+    def debug!
+      config.debug.set :on
+    end
+
+    def debug_off!
+      config.debug.set :off
+    end
+
+    def debug?
+      config.debug.on?
+    end
+  end
+end
+
+require 'cantango/macros'

data/lib/cantango/engine.rb

@@ -0,0 +1,39 @@
+module CanTango
+  class Engine
+    include CanTango::Helpers::Debug
+
+    attr_reader :ability
+
+    delegate :session, :user, :subject, :candidate, :cached?, :to => :ability
+
+    def initialize ability
+      @ability = ability
+    end
+
+    def execute!
+      raise NotImplementedError
+    end
+
+    def engine_name
+      raise NotImplementedError
+    end
+
+    protected
+
+    def valid_mode?
+      valid_cache_mode? || valid_no_cache_mode?
+    end
+
+    def valid_cache_mode?
+      modes.include?(:cache) && cached?
+    end
+
+    def valid_no_cache_mode?
+      modes.include?(:no_cache) && !cached?
+    end
+
+    def modes
+      CanTango.config.engine(engine_name.to_sym).modes
+    end
+  end
+end

data/lib/cantango/filter.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Filter
+    autoload_modules :Base
+  end
+end

data/lib/cantango/filter/base.rb

@@ -0,0 +1,31 @@
+module CanTango
+  module Filter
+    class Base
+      attr_reader :item, :include_list
+
+      def initialize item, list = nil
+        @item         = item.to_sym
+        @include_list = list || []
+      end
+
+      def valid?
+        return false if !in_include_list?
+        return false if not_only?
+        !excluded?
+      end
+
+      def in_include_list?
+        return false if include_list.blank?
+        include_list.include? item
+      end
+
+      def not_only?
+        false
+      end
+
+      def excluded?
+        false
+      end
+    end
+  end
+end

data/lib/cantango/helpers.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Helpers
+    autoload_modules :Debug
+  end
+end

data/lib/cantango/helpers/debug.rb

@@ -0,0 +1,10 @@
+module CanTango
+  module Helpers
+    module Debug
+      # you can set another writer on CanTango.config.debug, fx to spec it!
+      def debug msg
+        CanTango.config.debug.write msg if CanTango.debug?
+      end
+    end
+  end
+end

data/lib/cantango/loader.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Loader
+    autoload_modules :Yaml
+  end
+end

data/lib/cantango/loader/yaml.rb

@@ -0,0 +1,33 @@
+module CanTango
+  module Loader
+    class Yaml
+      attr_accessor :file_name
+
+      def self.inherited subclass
+        subclass.extend ClassMethods
+      end
+
+      def parser
+        raise NotImplementedError
+      end
+
+      def yml_content
+        YAML.load_file(file_name)
+      rescue
+        raise "Couldn't load permissions file: #{file_name}. Either disable Permission engine or add this file."
+      end
+
+      module ClassMethods
+        protected
+
+        def config_file name
+          File.join(config_path, "#{name}.yml") if rails?
+        end
+
+        def config_path
+          CanTango.config.permissions.config_path
+        end
+      end
+    end
+  end
+end

data/lib/cantango/macros.rb

@@ -0,0 +1,11 @@
+module CanTango
+  module Macros
+    autoload_modules :User, :Account
+  end
+end
+
+class Module
+  [:User, :Account].each do |macro|
+    self.send :include, "CanTango::Macros::#{macro.to_s.camelize}".constantize
+  end
+end

data/lib/cantango/macros/account.rb

@@ -0,0 +1,14 @@
+module CanTango::Macros
+  module Account
+    def tango_user_account options = {}
+      self.send :include, CanTango::AccountApi
+      
+      if defined? CanTango::Macros::Masquerader
+        self.send :include, CanTango::Macros::Masquerader
+        masquerader if options[:masquerade]
+      end
+    end
+    alias_method :tango_account, :tango_user_account
+    alias_method :cantango_account, :tango_user_account
+  end  
+end

data/lib/cantango/macros/user.rb

@@ -0,0 +1,16 @@
+module CanTango::Macros
+  module User
+    def tango_user options = {}
+      self.send :include, CanTango::UserApi
+      self.send :include, CanTango::Masquerade::UserApi
+      masquerader if options[:masquerade]
+    end
+    alias_method :cantango_user, :tango_user
+
+    module Masquerader
+      def masquerader
+        self.send :include, CanTango::Masquerade::UserApi
+      end
+    end
+  end
+end

data/lib/cantango/model.rb

@@ -0,0 +1,5 @@
+module CanTango
+  module Model
+    autoload_modules :Guest
+  end
+end

data/lib/cantango/model/guest.rb

@@ -0,0 +1,25 @@
+require 'active_model'
+
+module CanTango
+  module Model
+    module Guest
+      def self.included(base)
+        base.extend  ::ActiveModel::Naming
+        base.send :include, ::ActiveModel::Conversion
+        base.send :include, ::ActiveModel::Validations
+      end
+
+      def email
+        'guest@info.com'
+      end
+
+      def has_role? role
+        role.to_sym == :guest
+      end
+
+      def persisted?
+        false
+      end
+    end
+  end
+end