Module: ActiveLdap::Associations::ClassMethods — activeldap - ActiveLdap

Module: ActiveLdap::Associations::ClassMethods

Defined in:
lib/active_ldap/associations.rb

Constant Summary

Instance Method Summary (collapse)

Instance Method Details

- (Object) associated_class(name)



26
27
28
# File 'lib/active_ldap/associations.rb', line 26

def associated_class(name)
  @associated_classes[name.to_s]
end

- (Object) belongs_to(association_id, options = {})

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",
           :many => "memberUid" # Group#memberUid
           # :primary_key => "uid" # User#uid
           ## deprecated since 1.1.0. Use :primary_key instead.
           ## :foreign_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


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/active_ldap/associations.rb', line 48

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
    foreign_key_name = opts[:foreign_key_name]
    if foreign_key_name
      message = _(":foreign_key belongs_to(:many) option is " \
                  "deprecated since 1.1.0. Use :primary_key instead.")
      ActiveSupport::Deprecation.warn(message)
      opts[:primary_key_name] ||= foreign_key_name
    end
    opts[:primary_key_name] ||= dn_attribute
  else
    association_class = Association::BelongsTo
    opts[:foreign_key_name] ||= "#{association_id}_id"

    before_save(<<-EOC)
      if defined?(@#{association_id})
        association = @#{association_id}
        if association and association.updated?
          self[association.__send__(:primary_key)] =
            association[#{opts[:foreign_key_name].dump}]
        end
      end
    EOC
  end

  association_accessor(association_id) do |target|
    association_class.new(target, opts)
  end
end

- (Object) has_many(association_id, options = {})

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 :primary_members, :class_name => "User",
         :primary_key => "gidNumber", # Group#gidNumber
         :foreign_key => "gidNumber"  # User#gidNumber
         ## deprecated since 1.1.0. Those options
         ## are inverted.
         # :primary_key => "gidNumber", # User#gidNumber
         # :foreign_key => "gidNumber"  # Group#gidNumber
has_many :members, :class_name => "User",
         :wrap => "memberUid" # Group#memberUid


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/active_ldap/associations.rb', line 112

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]
    if primary_key_name != foreign_key_name and
        primary_key_name != "dn" and
        !new.have_attribute?(primary_key_name)
      message = _(":primary_key and :foreign_key has_many options are " \
                  "inverted their mean since 1.1.0. Please invert them.")
      ActiveSupport::Deprecation.warn(message)
      opts[:foreign_key_name] = primary_key_name
      opts[:primary_key_name] = foreign_key_name
    end
  end

  association_accessor(association_id) do |target|
    association_class.new(target, opts)
  end
end

- (Object) set_associated_class(name, klass)



21
22
23
24
# File 'lib/active_ldap/associations.rb', line 21

def set_associated_class(name, klass)
  @associated_classes ||= {}
  @associated_classes[name.to_s] = klass
end