Class: Treequel::Schema::MatchingRule

Inherits:

Object

Object
Treequel::Schema::MatchingRule

show all

Extended by:: Loggability, AttributeDeclarations

Includes:: Constants::Patterns

Defined in:: lib/treequel/schema/matchingrule.rb

Overview

This is a class for representing matchingRule declarations in a Treequel::Schema.

Constant Summary

Constants included from Constants::Patterns

Instance Attribute Summary collapse

#desc ⇒ Object

The matchingRule’s description.
#extensions ⇒ Object

The matchingRule’s extensions (as a String).
#names ⇒ Object readonly

The Array of the matchingRule’s names.
#oid ⇒ Object readonly

The matchingRule’s oid.
#schema ⇒ Object readonly

The schema the matchingRule belongs to.
#syntax_oid ⇒ Object

The oid of the matchingRule’s SYNTAX.

Class Method Summary collapse

.parse(schema, description) ⇒ Object

Parse an MatchingRule entry from a matchingRule description from a schema.

Instance Method Summary collapse

#initialize(schema, oid, syntax_oid, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ MatchingRule constructor

Create a new MatchingRule.
#inspect ⇒ Object

Return a human-readable representation of the object suitable for debugging.
#name ⇒ Object

Return the first of the matchingRule’s names, if it has any, or nil.
#syntax ⇒ Object

Return the Treequel::Schema::LDAPSyntax object that corresponds to the matchingRule’s SYNTAX attribute.
#to_s ⇒ Object

Returns the matchingRule as a String, which is the RFC4512-style schema description.

Methods included from AttributeDeclarations

predicate_attr

Constructor Details

#initialize(schema, oid, syntax_oid, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ `MatchingRule`

Create a new MatchingRule

# File 'lib/treequel/schema/matchingrule.rb', line 49

def initialize( schema, oid, syntax_oid, names=nil, desc=nil, obsolete=false, extensions=nil )

  @schema     = schema

  @oid        = oid
  @syntax_oid = syntax_oid
  @names      = names
  @desc       = desc
  @obsolete   = obsolete ? true : false
  @extensions = extensions

  super()
end

Instance Attribute Details

#desc ⇒ `Object`

The matchingRule’s description



81
82
83

# File 'lib/treequel/schema/matchingrule.rb', line 81

def desc
  @desc
end

#extensions ⇒ `Object`

The matchingRule’s extensions (as a String)



87
88
89

# File 'lib/treequel/schema/matchingrule.rb', line 87

def extensions
  @extensions
end

#names ⇒ `Object` (readonly)

The Array of the matchingRule’s names



78
79
80

# File 'lib/treequel/schema/matchingrule.rb', line 78

def names
  @names
end

#oid ⇒ `Object` (readonly)

The matchingRule’s oid



72
73
74

# File 'lib/treequel/schema/matchingrule.rb', line 72

def oid
  @oid
end

#schema ⇒ `Object` (readonly)

The schema the matchingRule belongs to



69
70
71

# File 'lib/treequel/schema/matchingrule.rb', line 69

def schema
  @schema
end

#syntax_oid ⇒ `Object`

The oid of the matchingRule’s SYNTAX



75
76
77

# File 'lib/treequel/schema/matchingrule.rb', line 75

def syntax_oid
  @syntax_oid
end

Class Method Details

.parse(schema, description) ⇒ `Object`

Parse an MatchingRule entry from a matchingRule description from a schema.

# File 'lib/treequel/schema/matchingrule.rb', line 28

def self::parse( schema, description )
  unless match = ( LDAP_MATCHING_RULE_DESCRIPTION.match(description) )
    raise Treequel::ParseError, "failed to parse matchingRule from %p" % [ description ]
  end

  oid, names, desc, obsolete, syntax_oid, extensions = match.captures
  # Treequel.logger.debug "  parsed matchingRule: %p" % [ match.captures ]

  # Normalize the attributes
  names = Treequel::Schema.parse_names( names )
  desc  = Treequel::Schema.unquote_desc( desc )

  return self.new( schema, oid, syntax_oid, names, desc, obsolete, extensions )
end

Instance Method Details

#inspect ⇒ `Object`

Return a human-readable representation of the object suitable for debugging

# File 'lib/treequel/schema/matchingrule.rb', line 121

def inspect
  return "#<%s:0x%0x %s(%s) %s %sSYNTAX: %p>" % [
    self.class.name,
    self.object_id / 2,
    self.name,
    self.oid,
    self.desc,
    self.obsolete? ? "(OBSOLETE)" : '',
    self.syntax,
  ]
end

#name ⇒ `Object`

Return the first of the matchingRule’s names, if it has any, or nil.



91
92
93

# File 'lib/treequel/schema/matchingrule.rb', line 91

def name
  return self.names.first
end

#syntax ⇒ `Object`

Return the Treequel::Schema::LDAPSyntax object that corresponds to the matchingRule’s SYNTAX attribute.



136
137
138

# File 'lib/treequel/schema/matchingrule.rb', line 136

def syntax
  return self.schema.ldap_syntaxes[ self.syntax_oid ]
end

#to_s ⇒ `Object`

Returns the matchingRule as a String, which is the RFC4512-style schema description.

# File 'lib/treequel/schema/matchingrule.rb', line 106

def to_s
  parts = [ self.oid ]

  parts << "NAME %s" % Treequel::Schema.qdescrs( self.names ) unless self.names.empty?

  parts << "DESC '%s'" % [ self.desc ]           if self.desc
  parts << "OBSOLETE"                            if self.obsolete?
  parts << "SYNTAX %s" % [ self.syntax_oid ]
  parts << self.extensions.strip             unless self.extensions.empty?

  return "( %s )" % [ parts.join(' ') ]
end

Class: Treequel::Schema::MatchingRule

Overview

Constant Summary

Constants included from Constants::Patterns

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AttributeDeclarations

Constructor Details

#initialize(schema, oid, syntax_oid, names = nil, desc = nil, obsolete = false, extensions = nil) ⇒ MatchingRule

Instance Attribute Details

#desc ⇒ Object

#extensions ⇒ Object

#names ⇒ Object (readonly)

#oid ⇒ Object (readonly)

#schema ⇒ Object (readonly)

#syntax_oid ⇒ Object