ruby-activeldap 0.4.1

data/lib/activeldap/associations.rb

@@ -0,0 +1,122 @@
+
+module ActiveLDAP
+ # Associations
+ #
+ # Associations provides the class methods needed for
+ # the extension classes to create methods using
+ # belongs_to and has_many
+ module Associations
+   def self.append_features(base)
+     super
+     base.extend(ClassMethods)
+   end
+   module ClassMethods
+     # This class function is used to setup all mappings between the subclass
+     # and ldap for use in activeldap
+     def ldap_mapping(options = {})
+       # The immediate ancestor should be the caller....
+       klass = self.ancestors[0]
+
+       dnattr = options[:dnattr] || 'cn'
+       prefix = options[:prefix] || "ou=#{klass.to_s.split(':').last}"
+       classes_array = options[:classes] || ['top']
+
+       raise TypeError, ":classes must be an array" \
+         unless classes_array.respond_to? :size
+       # Build classes array
+       classes = '['
+       classes_array.map! {|x| x = "'#{x}'"}
+       classes << classes_array.join(', ')
+       classes << ']'
+
+       # This adds the methods to the local
+       # class which can then be inherited, etc
+       # which describe the mapping to LDAP.
+       klass.class_eval <<-"end_eval"
+         class << #{klass}
+           # Return the list of required object classes
+           def required_classes
+             #{classes}
+           end
+
+           # Return the full base of the class
+           def base
+             "#{prefix},\#{super}"
+           end
+
+           # Return the expected DN attribute of an object
+           def dnattr
+             '#{dnattr}'
+           end
+         end
+
+         # Hide connect
+         private_class_method :connect
+
+         # Unhide class methods
+         public_class_method :find_all
+         public_class_method :find
+         public_class_method :new
+         public_class_method :dnattr
+      end_eval
+     end
+
+    # belongs_to
+    #
+    # This defines a method for an extension class map its DN key
+    # attribute value on to multiple items which reference it by
+    # |:foreign_key| in the other LDAP entry covered by class |:class_name|.
+    #
+    # Example:
+    #  belongs_to :groups, :class_name => Group, :foreign_key => memberUid, :local_key => 'uid'
+    #
+    def belongs_to(association_id, options = {})
+      klass = options[:class_name] || association_id.to_s
+      key = options[:foreign_key]  || association_id.to_s + "_id"
+      local_key = options[:local_key] || ''
+      class_eval <<-"end_eval"
+        def #{association_id}(objects = false)
+          local_key = "#{local_key}"
+          local_key = dnattr() if local_key.empty?
+          return #{klass}.find_all(:attribute => "#{key}", :value => attribute_method(local_key), :objects => objects)
+        end
+      end_eval
+    end
+
+
+    # has_many
+    #
+    # This defines a method for an extension class expand an 
+    # existing multi-element attribute into ActiveLDAP objects.
+    # This discards any calls which result in entries that
+    # don't exist in LDAP!
+    #
+    # Example:
+    #   has_many :members, :class_name => User, :local_key => memberUid, :foreign_key => 'uid'
+    #
+    # TODO[ENH]: def #{...}=(val) to redefine group membership
+    def has_many(association_id, options = {})
+      klass = options[:class_name] || association_id.to_s
+      key = options[:local_key]  || association_id.to_s + "_id"
+      foreign_key = options[:foreign_key] || ''
+      class_eval <<-"end_eval"
+        def #{association_id}(objects = false)
+          foreign_key = "#{foreign_key}"
+          if foreign_key.empty?
+            foreign_key = dnattr()
+          end
+          results = []
+          @data["#{key}"].each do |item|
+            # This will even yield entries that don't necessarily exist
+            #{klass}.find_all(:attribute => foreign_key, :value => item, :objects => objects).each do |match|
+              results << match
+            end
+          end
+          return results
+        end
+      end_eval
+    end
+
+  end
+end
+end