module ActiveLdap::Associations::ClassMethods
Constants
- VALID_BELONGS_TO_OPTIONS
- VALID_HAS_MANY_OPTIONS
Public Instance Methods
Source
# File lib/active_ldap/associations.rb, line 26 def associated_class(name) @associated_classes[name.to_s] end
Source
# File lib/active_ldap/associations.rb, line 46 def belongs_to(association_id, options={}) validate_belongs_to_options(options) klass = options[:class] klass ||= (options[:class_name] || association_id.to_s).classify foreign_key = options[:foreign_key] primary_key = options[:primary_key] many = options[:many] set_associated_class(association_id, klass) opts = { :association_id => association_id, :foreign_key_name => foreign_key, :primary_key_name => primary_key, :many => many, :extend => options[:extend], } if opts[:many] association_class = Association::BelongsToMany opts[:primary_key_name] ||= dn_attribute else association_class = Association::BelongsTo opts[:foreign_key_name] ||= "#{association_id}_id" before_save do if instance_variable_defined?(:"@#{association_id}") association = instance_variable_get(:"@#{association_id}") if association and association.updated? self[association.__send__(:primary_key)] = association[opts[:foreign_key_name]] end end end end association_accessor(association_id) do |target| association_class.new(target, opts) end end
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", :many => "memberUid" # Group#memberUid # :primary_key => "uid" # User#uid # dn attribute value is used by default belongs_to :primary_group, :class_name => "Group", :foreign_key => "gidNumber", # User#gidNumber :primary_key => "gidNumber" # Group#gidNumber
Source
# File lib/active_ldap/associations.rb, line 99 def has_many(association_id, options = {}) validate_has_many_options(options) klass = options[:class] klass ||= (options[:class_name] || association_id.to_s).classify foreign_key = options[:foreign_key] primary_key = options[:primary_key] set_associated_class(association_id, klass) opts = { :association_id => association_id, :foreign_key_name => foreign_key, :primary_key_name => primary_key, :wrap => options[:wrap], :extend => options[:extend], } if opts[:wrap] association_class = Association::HasManyWrap else association_class = Association::HasMany primary_key_name = opts[:primary_key_name] foreign_key_name = opts[:foreign_key_name] end association_accessor(association_id) do |target| association_class.new(target, opts) end end
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 :primary_members, :class_name => "User", :primary_key => "gidNumber", # Group#gidNumber :foreign_key => "gidNumber" # User#gidNumber has_many :members, :class_name => "User", :wrap => "memberUid" # Group#memberUid
Source
# File lib/active_ldap/associations.rb, line 21 def set_associated_class(name, klass) @associated_classes ||= {} @associated_classes[name.to_s] = klass end
Private Instance Methods
Source
# File lib/active_ldap/associations.rb, line 128 def association_accessor(name, &make_association) define_method("__make_#{name}") do make_association.call(self) end associations << name association_reader(name, &make_association) association_writer(name, &make_association) end
Source
# File lib/active_ldap/associations.rb, line 137 def association_reader(name, &make_association) class_eval(<<-EOM, __FILE__, __LINE__ + 1) def #{name} @#{name} ||= __make_#{name} end EOM end
Source
# File lib/active_ldap/associations.rb, line 145 def association_writer(name, &make_association) class_eval(<<-EOM, __FILE__, __LINE__ + 1) def #{name}=(new_value) association = defined?(@#{name}) ? @#{name} : nil association ||= __make_#{name} association.replace(new_value) @#{name} = new_value.nil? ? nil : association @#{name} end EOM end
Source
# File lib/active_ldap/associations.rb, line 160 def validate_belongs_to_options(options) options.assert_valid_keys(VALID_BELONGS_TO_OPTIONS) end
Source
# File lib/active_ldap/associations.rb, line 167 def validate_has_many_options(options) options.assert_valid_keys(VALID_HAS_MANY_OPTIONS) end