Class: Treequel::Schema::LDAPSyntax

Inherits:

Object

Object
Treequel::Schema::LDAPSyntax

show all

Extended by:: Loggability, AttributeDeclarations

Includes:: Constants::Patterns

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

Overview

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

Constant Summary

Constants included from Constants::Patterns

Instance Attribute Summary collapse

#desc ⇒ Object

The syntax’s description.
#extensions ⇒ Object

The syntax’s extensions (as a String).
#oid ⇒ Object readonly

The syntax’s oid.
#schema ⇒ Object readonly

The schema the syntax belongs to.

Class Method Summary collapse

.parse(schema, description) ⇒ Object

Parse an LDAPSyntax entry from an ldapSyntax description from a schema.

Instance Method Summary collapse

#initialize(schema, oid, desc = nil, extensions = nil) ⇒ LDAPSyntax constructor

Create a new LDAPSyntax.
#inspect ⇒ Object

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

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

Methods included from AttributeDeclarations

predicate_attr

Constructor Details

#initialize(schema, oid, desc = nil, extensions = nil) ⇒ `LDAPSyntax`

Create a new LDAPSyntax

# File 'lib/treequel/schema/ldapsyntax.rb', line 48

def initialize( schema, oid, desc=nil, extensions=nil )

	@schema     = schema

	@oid        = oid
	@desc       = desc
	@extensions = extensions

	super()
end

Instance Attribute Details

#desc ⇒ `Object`

The syntax’s description



71
72
73

# File 'lib/treequel/schema/ldapsyntax.rb', line 71

def desc
  @desc
end

#extensions ⇒ `Object`

The syntax’s extensions (as a String)



74
75
76

# File 'lib/treequel/schema/ldapsyntax.rb', line 74

def extensions
  @extensions
end

#oid ⇒ `Object` (readonly)

The syntax’s oid



68
69
70

# File 'lib/treequel/schema/ldapsyntax.rb', line 68

def oid
  @oid
end

#schema ⇒ `Object` (readonly)

The schema the syntax belongs to



65
66
67

# File 'lib/treequel/schema/ldapsyntax.rb', line 65

def schema
  @schema
end

Class Method Details

.parse(schema, description) ⇒ `Object`

Parse an LDAPSyntax entry from an ldapSyntax description from a schema.

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

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

	oid, desc, extensions = match.captures
	# Treequel.logger.debug "  parsed syntax: %p" % [ match.captures ]

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

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

Instance Method Details

#inspect ⇒ `Object`

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

# File 'lib/treequel/schema/ldapsyntax.rb', line 93

def inspect
	return "#<%s:0x%0x %s(%s)>" % [
		self.class.name,
		self.object_id / 2,
		self.oid,
		self.desc,
	]
end

#to_s ⇒ `Object`

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

# File 'lib/treequel/schema/ldapsyntax.rb', line 83

def to_s
	parts = [ self.oid ]
	parts << "DESC '%s'" % [ self.desc ] if self.desc
	parts << self.extensions.strip unless self.extensions.empty?

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