annotation_security 1.0.2 → 1.3.1

data/lib/annotation_security/includes/resource.rb

@@ -1,85 +1,85 @@
-#
-# = lib/annotation_security/includes/resource.rb
-#
-
-# Must be included by all classes that are resource classes and do not extend
-# ActiveRecord::Base.
-#
-#   class MailDispatcher
-#     include AnnotationSecurity::Resource
-#     resource_type = :email
-#     ...
-#
-# See AnnotationSecurity::Resource::ClassMethods.
-#
-module AnnotationSecurity::Resource
-
-  def self.included(base) # :nodoc:
-    base.extend(ClassMethods)
-    base.class_eval do
-      include InstanceMethods
-    end
-  end
-
-  # Provides class side methods for resource classes.
-  module ClassMethods
-
-    # Registers the class as a resource.
-    #
-    def resource_type=(symbol)
-      @resource_type = symbol
-      AnnotationSecurity::ResourceManager.add_resource_class(symbol,self)
-      symbol
-    end
-
-    def resource_type # :nodoc:
-      @resource_type || (self.resource_type = name.underscore.to_sym)
-    end
-
-    def policy_for(user,obj=nil) # :nodoc:
-      policy_factory.create_policy(user,obj)
-    end
-
-    # If required, overwrite this method to return a resource object identified
-    # by the argument.
-    #
-    # This might be necessary if you change the to_param method of an
-    # ActiveRecord class.
-    #
-    #  class Course < ActiveRecord::Base
-    #    ...
-    #    # each course has a unique name --> make better urls
-    #    def to_param
-    #      name
-    #    end
-    #
-    #    def self.get_resource(name)
-    #      find_by_name(name)
-    #    end
-    #
-    def get_resource(arg)
-      raise NoMethodError, "#{self} does not implement #get_resource"
-    end
-
-    private
-
-    def policy_factory # :nodoc:
-      @policy_factory ||= AnnotationSecurity::PolicyManager.policy_factory(resource_type)
-    end
-
-  end
-
-  module InstanceMethods # :nodoc:
-    def resource_type
-      self.class.resource_type
-    end
-
-    def __is_resource?
-      true
-    end
-
-    def policy_for(user)
-      self.class.policy_for(user,self)
-    end
-  end
+#
+# = lib/annotation_security/includes/resource.rb
+#
+
+# Must be included by all classes that are resource classes and do not extend
+# ActiveRecord::Base.
+#
+#   class MailDispatcher
+#     include AnnotationSecurity::Resource
+#     resource_type = :email
+#     ...
+#
+# See AnnotationSecurity::Resource::ClassMethods.
+#
+module AnnotationSecurity::Resource
+
+  def self.included(base) # :nodoc:
+    base.extend(ClassMethods)
+    base.class_eval do
+      include InstanceMethods
+    end
+  end
+
+  # Provides class side methods for resource classes.
+  module ClassMethods
+
+    # Registers the class as a resource.
+    #
+    def resource_type=(symbol)
+      @resource_type = symbol
+      AnnotationSecurity::ResourceManager.add_resource_class(symbol,self)
+      symbol
+    end
+
+    def resource_type # :nodoc:
+      @resource_type || (self.resource_type = name.underscore.to_sym)
+    end
+
+    def policy_for(user,obj=nil) # :nodoc:
+      policy_factory.create_policy(user,obj)
+    end
+
+    # If required, overwrite this method to return a resource object identified
+    # by the argument.
+    #
+    # This might be necessary if you change the to_param method of an
+    # ActiveRecord class.
+    #
+    #  class Course < ActiveRecord::Base
+    #    ...
+    #    # each course has a unique name --> make better urls
+    #    def to_param
+    #      name
+    #    end
+    #
+    #    def self.get_resource(name)
+    #      find_by_name(name)
+    #    end
+    #
+    def get_resource(arg)
+      raise NoMethodError, "#{self} does not implement #get_resource"
+    end
+
+    private
+
+    def policy_factory # :nodoc:
+      @policy_factory ||= AnnotationSecurity::PolicyManager.policy_factory(resource_type)
+    end
+
+  end
+
+  module InstanceMethods # :nodoc:
+    def resource_type
+      self.class.resource_type
+    end
+
+    def __is_resource?
+      true
+    end
+
+    def policy_for(user)
+      self.class.policy_for(user,self)
+    end
+  end
 end

data/lib/annotation_security/includes/role.rb

@@ -1,31 +1,31 @@
-#
-# = lib/annotation_security/includes/role.rb
-#
-
-# = AnnotationSecurity::Role
-# 
-# This module should be included by all role classes
-# to enable full support of all features.
-#
-# A role class is a domain class that represents user roles
-# and does not extend the user class. It should have the method #user that
-# returns the user object it belongs to.
-#
-module AnnotationSecurity::Role
-
-  # Returns true if this belongs to the user given as parameter.
-  #
-  # Required to have a common interface with AnnotationSecurity::User.
-  #
-  def is_user?(user)
-    self.user == user
-  end
-
-  # If +obj+ is a UserWrapper, extract the role before comparing
-  #
-  def ==(obj)
-    obj = obj.__role__ if obj.is_a? AnnotationSecurity::UserWrapper
-    super(obj)
-  end
-
+#
+# = lib/annotation_security/includes/role.rb
+#
+
+# = AnnotationSecurity::Role
+# 
+# This module should be included by all role classes
+# to enable full support of all features.
+#
+# A role class is a domain class that represents user roles
+# and does not extend the user class. It should have the method #user that
+# returns the user object it belongs to.
+#
+module AnnotationSecurity::Role
+
+  # Returns true if this belongs to the user given as parameter.
+  #
+  # Required to have a common interface with AnnotationSecurity::User.
+  #
+  def is_user?(user)
+    self.user == user
+  end
+
+  # If +obj+ is a UserWrapper, extract the role before comparing
+  #
+  def ==(obj)
+    obj = obj.__role__ if obj.is_a? AnnotationSecurity::UserWrapper
+    super(obj)
+  end
+
 end

data/lib/annotation_security/includes/user.rb

@@ -1,27 +1,27 @@
-#
-# = lib/annotation_security/includes/user.rb
-#
-
-# = AnnotationSecurity::User
-# 
-# This module should be included by the user domain class to
-# enable full support of all features.
-#
-module AnnotationSecurity::User
-
-  # Returns true if this is the user given as parameter.
-  #
-  # Required to have a common interface with AnnotationSecurity::Role.
-  #
-  def is_user?(user)
-    self == user
-  end
-
-  # If +obj+ is a UserWrapper, extract the user before comparing
-  #
-  def ==(obj)
-    obj = obj.__user__ if obj.is_a? AnnotationSecurity::UserWrapper
-    super(obj)
-  end
-
+#
+# = lib/annotation_security/includes/user.rb
+#
+
+# = AnnotationSecurity::User
+# 
+# This module should be included by the user domain class to
+# enable full support of all features.
+#
+module AnnotationSecurity::User
+
+  # Returns true if this is the user given as parameter.
+  #
+  # Required to have a common interface with AnnotationSecurity::Role.
+  #
+  def is_user?(user)
+    self == user
+  end
+
+  # If +obj+ is a UserWrapper, extract the user before comparing
+  #
+  def ==(obj)
+    obj = obj.__user__ if obj.is_a? AnnotationSecurity::UserWrapper
+    super(obj)
+  end
+
 end

data/lib/annotation_security/manager/policy_factory.rb

@@ -1,30 +1,30 @@
-#
-# = lib/annotation_security/manager/policy_factory.rb
-#
-
-# = AnnotationSecurity::PolicyFactory
-# Builds the policy classes.
-#
-class AnnotationSecurity::PolicyFactory # :nodoc:
-
-  def initialize(resource_class)
-    @klass = AnnotationSecurity::AbstractPolicy.new_subclass(resource_class)
-  end
-
-  def policy_class
-    @klass
-  end
-
-  def add_rule(symbol,*args,&block)
-    @klass.add_rule(symbol,*args,&block)
-  end
-
-  def create_policy(*args)
-    @klass.new(*args)
-  end
-
-  def reset
-    @klass.reset
-  end
-
+#
+# = lib/annotation_security/manager/policy_factory.rb
+#
+
+# = AnnotationSecurity::PolicyFactory
+# Builds the policy classes.
+#
+class AnnotationSecurity::PolicyFactory # :nodoc:
+
+  def initialize(resource_class)
+    @klass = AnnotationSecurity::AbstractPolicy.new_subclass(resource_class)
+  end
+
+  def policy_class
+    @klass
+  end
+
+  def add_rule(symbol,*args,&block)
+    @klass.add_rule(symbol,*args,&block)
+  end
+
+  def create_policy(*args)
+    @klass.new(*args)
+  end
+
+  def reset
+    @klass.reset
+  end
+
 end

data/lib/annotation_security/manager/policy_manager.rb

@@ -1,80 +1,88 @@
-#
-# = lib/annotation_security/manager/policy_manager.rb
-#
-require 'yaml'
-
-# = AnnotationSecurity::PolicyManager
-#
-# Manages loading and creation of all policy classes.
-#
-class AnnotationSecurity::PolicyManager # :nodoc:
-
-  # Get the policy factory for a resource class
-  def self.policy_factory(resource_type) # :nodoc:
-    policy_factories[resource_type.to_sym]
-  end
-
-  # Creates a policy object for a user and a resource type
-  #
-  # ==== Example
-  #
-  #  picture = Picture.find_by_id(params[:picture])
-  #  policy = PolicyManager.get_policy(:picture,@current_user)
-  #  policy.allowed? :show, picture # => true or false
-  #
-  def self.create_policy(resource_type,*args)
-    policy_factory(resource_type).create_policy(*args)
-  end
-
-  def self.policy_class(resource_class) # :nodoc:
-    policy_factory(resource_class).policy_class
-  end
-
-  def self.config_files # :nodoc:
-    @files ||= []
-  end
-
-  # Adds a file that contains security configurations
-  # * +f+ file name
-  # * +ext+ 'yml' or 'rb'
-  def self.add_file(f,ext) # :nodoc:
-    unless config_files.include? [f,ext]
-      config_files.push [f,ext]
-      load_file(f,ext)
-    end
-  end
-
-  def self.reset
-    policy_factories.each_value(&:reset)
-    config_files.each { |f,ext| load_file(f,ext) }
-  end
-
-  private
-
-  def self.load_file(f,ext)
-    fname = get_file_name(f,ext)
-    case ext
-    when 'yml'
-      AnnotationSecurity::RightLoader.define_rights(YAML.load_file(fname))
-    when 'rb'
-      load fname
-    end
-  end
-
-  SEARCH_PATH = ['', RAILS_ROOT, RAILS_ROOT + '/config/security/',
-                 RAILS_ROOT + '/config/', RAILS_ROOT + '/security/']
-
-  def self.get_file_name(f,ext)
-    SEARCH_PATH.each do |fname1|
-      [f, f+'.'+ext].each do |fname2|
-        return (fname1 + fname2) if File.exist?(fname1 + fname2)
-      end
-    end
-    raise "File not found: '#{f+'.'+ext}'"
-  end
-
-  def self.policy_factories
-    # Create a new factory if it is needed
-    @factories ||= Hash.new { |h,k| h[k] = AnnotationSecurity::PolicyFactory.new(k) }
-  end
+#
+# = lib/annotation_security/manager/policy_manager.rb
+#
+require 'yaml'
+
+# = AnnotationSecurity::PolicyManager
+#
+# Manages loading and creation of all policy classes.
+#
+class AnnotationSecurity::PolicyManager # :nodoc:
+
+  # Get the policy factory for a resource class
+  def self.policy_factory(resource_type) # :nodoc:
+    policy_factories[resource_type.to_sym]
+  end
+
+  # Creates a policy object for a user and a resource type
+  #
+  # ==== Example
+  #
+  #  picture = Picture.find_by_id(params[:picture])
+  #  policy = PolicyManager.get_policy(:picture,@current_user)
+  #  policy.allowed? :show, picture # => true or false
+  #
+  def self.create_policy(resource_type,*args)
+    policy_factory(resource_type).create_policy(*args)
+  end
+
+  def self.policy_class(resource_class) # :nodoc:
+    policy_factory(resource_class).policy_class
+  end
+
+  def self.config_files # :nodoc:
+    @files ||= []
+  end
+
+  # Adds a file that contains security configurations
+  # * +f+ file name
+  # * +ext+ 'yml' or 'rb'
+  def self.add_file(f,ext) # :nodoc:
+    unless config_files.include? [f,ext]
+      config_files.push [f,ext]
+      load_file(f,ext)
+    end
+  end
+
+  def self.reset
+    policy_factories.each_value(&:reset)
+    config_files.each { |f,ext| load_file(f,ext) }
+  end
+
+  private
+
+  def self.load_file(f,ext)
+    fname = get_file_name(f,ext)
+    case ext
+    when 'yml'
+      AnnotationSecurity::RightLoader.define_rights(YAML.load_file(fname))
+    when 'rb'
+      load fname
+    end
+  end
+
+  def self.search_path
+    @search_path ||=
+      [ Pathname.new(''),
+         ::Rails.root,
+         ::Rails.root.join('config', 'security'),
+         ::Rails.root.join('config'),
+         ::Rails.root.join('security')]
+
+  end
+
+  def self.get_file_name(f,ext)
+    search_path.each do |path|
+      [f, f + '.' + ext].each do |fname|
+        full_path = path.join(fname)
+        return (full_path) if File.exist?(full_path)
+      end
+    end
+    raise "File not found: '#{f}.#{ext}'"
+  end
+
+  def self.policy_factories
+    # Create a new factory if it is needed
+    @factories ||= Hash.new { |h,k| h[k] = AnnotationSecurity::PolicyFactory.new(k) }
+  end
 end