Contents

module Walruz

  base_path = File.dirname(__FILE__)
  require base_path + '/walruz/exceptions'
  autoload :Config, base_path + '/walruz/config'
  autoload :Memoization, base_path + '/walruz/core_ext/memoization'
  autoload :Manager, base_path + '/walruz/manager'
  autoload :Actor,   base_path + '/walruz/actor'
  autoload :Subject, base_path + '/walruz/subject'
  autoload :Policy,  base_path + '/walruz/policy'
  autoload :Utils,   base_path + '/walruz/utils'
  
  # including the Walruz::Manager::AuthorizationQuery methods
  extend Manager::AuthorizationQuery
  class << self
    include Memoization
    walruz_memoize :can?, :authorize, :satisfies?, :satisfies
  end

  #############################
  ### Global Walruz Methods ###
  #############################

  def self.version
    require "yaml"
    version = YAML.load_file(File.dirname(__FILE__) + "/../VERSION.yml") 
    "%s.%s.%s" % [version[:major], version[:minor], version[:patch]]
  end

  def self.setup
    config = Config.new
    yield config
  end
  
  # Holds all the policies declared on the system
  # @return [Hash<Symbol, Walruz::Policy>] A hash of policies, each identified by it's policy label
  # @todo Make this thread-safe
  def self.policies
    Walruz::Policy.policies
  end
  
  # Returns a Walruz::Policy Class represented by the specified label 
  #
  # @param [Symbol] policy_label The label that identifies a policy
  # @return [Walruz::Policy] A Policy class.
  # @raise [Walruz::ActionNotFound] if the policy label is not recognized.
  # @example Fetching a policy with label :actor_is_admin
  #   Walruz.fetch_policy(:actor_is_admin) # => ActorIsAdmin
  #
  def self.fetch_policy(policy_label)
    policy_clz = Walruz.policies[policy_label]
    raise ActionNotFound.new(:policy_label, :label => policy_label) if policy_clz.nil?
    policy_clz
  end
  
end

require File.dirname(__FILE__) + '/walruz/core_ext/array'
Array.send(:include, Walruz::CoreExt::Array)

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
walruz-0.0.16	lib/walruz.rb
walruz-0.0.15	lib/walruz.rb
walruz-0.0.14	lib/walruz.rb
walruz-0.0.13	lib/walruz.rb
walruz-0.0.12	lib/walruz.rb
walruz-0.0.11	lib/walruz.rb
walruz-0.0.10	lib/walruz.rb