treequel 1.0.4 → 1.1.0

data/lib/treequel/schema/objectclass.rb

@@ -92,7 +92,7 @@ class Treequel::Schema
 			@names      = names
 			@desc       = desc
 			@obsolete   = obsolete ? true : false
-			@sup_name   = sup
+			@sup_oid    = sup
 			@must_oids  = must_oids
 			@may_oids   = may_oids
 			@extensions = extensions
@@ -120,8 +120,8 @@ class Treequel::Schema
 		# Is the objectClass obsolete?
 		predicate_attr :obsolete
 
-		# The name of the objectClass's superior class (if specified)
-		attr_accessor :sup_name
+		# The OID of the objectClass's superior class (if specified)
+		attr_accessor :sup_oid
 
 		# The objectClass's extensions (as a String)
 		attr_accessor :extensions
@@ -194,6 +194,48 @@ class Treequel::Schema
 		end
 
 
+		### Returns the objectClass as a String, which is the RFC4512-style schema
+		### description.
+		def to_s
+			# ObjectClassDescription = LPAREN WSP
+		    #     numericoid                 ; object identifier
+		    #     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
+		    #     [ SP "DESC" SP qdstring ]  ; description
+		    #     [ SP "OBSOLETE" ]          ; not active
+		    #     [ SP "SUP" SP oids ]       ; superior object classes
+		    #     [ SP kind ]                ; kind of class
+		    #     [ SP "MUST" SP oids ]      ; attribute types
+		    #     [ SP "MAY" SP oids ]       ; attribute types
+		    #     extensions WSP RPAREN
+            #
+		    # kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
+
+			parts = [ self.oid ]
+
+			parts << "NAME %s" % Treequel::Schema.qdescrs( self.names ) unless self.names.empty?
+			parts << "DESC %s" % [ Treequel::Schema.qdstring(self.desc) ] if self.desc
+			parts << "OBSOLETE" if self.obsolete?
+			parts << "SUP %s" % [ Treequel::Schema.oids(self.sup_oid) ] if self.sup_oid
+			parts << self.kind
+			parts << "MUST %s" % [ Treequel::Schema.oids(self.must_oids(false)) ] unless
+				self.must_oids(false).empty?
+			parts << "MAY %s" % [ Treequel::Schema.oids(self.may_oids(false)) ] unless
+				self.may_oids(false).empty?
+			parts << self.extensions.strip unless self.extensions.empty?
+
+			return "( %s )" % [ parts.join(' ') ]
+		end
+
+		# @oid        = oid
+		# @names      = names
+		# @desc       = desc
+		# @obsolete   = obsolete ? true : false
+		# @sup_oid   = sup
+		# @must_oids  = must_oids
+		# @may_oids   = may_oids
+		# @extensions = extensions
+
+
 		### Return a human-readable representation of the object suitable for debugging
 		def inspect
 			return %{#<%s:0x%0x %s(%s) < %s "%s" MUST: %p, MAY: %p>} % [
@@ -201,7 +243,7 @@ class Treequel::Schema
 				self.object_id / 2,
 				self.name,
 				self.oid,
-				self.sup_name,
+				self.sup_oid,
 				self.desc,
 				self.must_oids,
 				self.may_oids,
@@ -212,13 +254,36 @@ class Treequel::Schema
 		### Return the ObjectClass for the receiver's SUP. If this is called on
 		### 'top', returns nil.
 		def sup
-			unless name = self.sup_name
+			unless name = self.sup_oid
 				return nil if self.oid == Treequel::Constants::OIDS::TOP_OBJECTCLASS
 				return self.schema.object_classes[ :top ]
 			end
 			return self.schema.object_classes[ name.to_sym ]
 		end
 
+
+		### Return the SUP chain for the receiver up to 'top', including the receiver
+		### itself.
+		### @return [Array<Treequel::Schema::ObjectClass>]  the array of ObjectClass objects
+		###                                                 the receiver inherits from.
+		def ancestors
+			rval = [ self ]
+
+			if parent = self.sup
+				rval += parent.ancestors
+			end
+
+			return rval
+		end
+
+
+		### Return the string that represents the kind of objectClass
+		### the receiver represents.
+		### @return [String] one of: 'ABSTRACT', 'STRUCTURAL', 'AUXILIARY'
+		def kind
+			return Treequel::Schema::OBJECTCLASS_TYPES.invert[ self.class ]
+		end
+
 	end # class ObjectClass
 
 

data/lib/treequel/schema/table.rb

@@ -11,27 +11,16 @@ require 'treequel/mixins'
 
 # This is an object that is used to store LDAP schema information in a 
 # case-insensitive table.
-# 
-# == Authors
-# 
-# * Michael Granger <ged@FaerieMUD.org>
-# * Mahlon E. Smith <mahlon@martini.nu>
-# 
-# :include: LICENSE
-#
-#--
-#
-# Please see the file LICENSE in the base directory for licensing details.
-#
 class Treequel::Schema::Table
 	extend Forwardable
-	include Treequel::Loggable,
+	include Enumerable,
+	        Treequel::Loggable,
 	        Treequel::Normalization,
 	        Treequel::Constants::Patterns
 
 	# The list of methods that should be delegated through the key-normalization
 	# method.
-	KEYED_METHODS = [ :"[]", :"[]=", :delete, :fetch, :key?, :has_key?, :include?, 
+	KEYED_METHODS = [ :"[]", :"[]=", :delete, :fetch, :key?, :has_key?, :include?,
 		:member?, :store ]
 
 
@@ -73,7 +62,8 @@ class Treequel::Schema::Table
 
 	# Delegate some methods to the underlying Hash
 	begin
-		unoverridden_methods = Hash.instance_methods(false).collect {|mname| mname.to_sym }
+		unoverridden_methods = Hash.
+			instance_methods(false).collect {|mname| mname.to_sym }
 		def_delegators :@hash, *( unoverridden_methods - KEYED_METHODS )
 	end
 

data/lib/treequel/schema.rb

@@ -105,6 +105,54 @@ class Treequel::Schema
 	end
 
 
+	### Return a description of the given +descriptors+ suitable for inclusion in 
+	### an RFC4512-style schema description entry.
+	### @param [Array<String>] descriptors  an Array of descriptors
+	### @return [String] the 'qdescrs' text
+	def self::qdescrs( *descriptors )
+		descriptors.flatten!
+		if descriptors.length > 1
+			return "( %s )" % [ descriptors.collect {|str| self.qdstring(str) }.join(" ") ]
+		else
+			return self.qdstring( descriptors.first )
+		end
+	end
+
+
+    # qdstring = SQUOTE dstring SQUOTE
+    # dstring = 1*( QS / QQ / QUTF8 )   ; escaped UTF-8 string
+    # 
+    # QQ =  ESC %x32 %x37 ; "\27"
+    # QS =  ESC %x35 ( %x43 / %x63 ) ; "\5C" / "\5c"
+    # 
+    # ; Any UTF-8 encoded Unicode character
+    # ; except %x27 ("\'") and %x5C ("\")
+    # QUTF8    = QUTF1 / UTFMB
+
+	### Escape and quote the specified +string+ according to the rules in 
+	### RFC4512/2252.
+	### @param [String] string  the unescaped UTF8 string
+	### @return [String] the string after quoting and escaping
+	def self::qdstring( string )
+		return "'%s'" % [ string.to_s.gsub(/\\/, '\\\\5c').gsub(/'/, '\\\\27') ]
+	end
+
+
+	### Return a description of the given +oids+ suitable for inclusion in 
+	### an RFC4512-style schema description entry.
+	### @param [Array<String>] oids  an Array of numeric or symbolic OIDs
+	### @return [String] the oid list text
+	def self::oids( *oids )
+		oids.flatten!
+		if oids.length > 1
+			return "( %s )" % [ oids.join(" $ ") ]
+		else
+			return oids.first
+		end
+	end
+
+
+
 	#################################################################
 	###	I N S T A N C E   M E T H O D S
 	#################################################################
@@ -126,28 +174,43 @@ class Treequel::Schema
 	public
 	######
 
-	# The Hash of Treequel::Schema::ObjectClass objects, keyed by OID and any associated NAME 
+	# The table of Treequel::Schema::ObjectClass objects, keyed by OID and any associated NAME 
 	# attributes (as Symbols), that describes the objectClasses in the directory's schema.
+	# @return [Treequel::Schema::Table]
 	attr_reader :object_classes
 
 	# The hash of Treequel::Schema::AttributeType objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the attributeTypes in the directory's schema.
+	# @return [Treequel::Schema::Table]
 	attr_reader :attribute_types
 
 	# The hash of Treequel::Schema::LDAPSyntax objects, keyed by OID, that describe the 
 	# syntaxes in the directory's schema.
+	# @return [Treequel::Schema::Table]
 	attr_reader :ldap_syntaxes
 
 	# The hash of Treequel::Schema::MatchingRule objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the matchingRules int he directory's schema.
+	# @return [Treequel::Schema::Table]
 	attr_reader :matching_rules
 
 	# The hash of Treequel::Schema::MatchingRuleUse objects, keyed by OID and any associated NAME
 	# attributes (as Symbols), that describe the attributes to which a matchingRule can be applied.
+	# @return [Treequel::Schema::Table]
 	attr_reader :matching_rule_uses
+	alias_method :matching_rule_use, :matching_rule_uses
+
+
+	### Return the Treequel::Schema::AttributeType objects that correspond to the
+	### operational attributes that are supported by the directory.
+	### @return [Array<Treequel::Schema::AttributeType>]  the operational attributes
+	def operational_attribute_types
+		return self.attribute_types.values.find_all {|attrtype| attrtype.operational? }.uniq
+	end
 
 
 	### Return a human-readable representation of the object suitable for debugging.
+	### @return [String]
 	def inspect
 		ivar_descs = self.instance_variables.sort.collect do |ivar|
 			len = self.instance_variable_get( ivar ).length

data/lib/treequel.rb

@@ -25,7 +25,7 @@ end
 
 # A library for interacting with LDAP modelled after Sequel.
 #
-# @version 1.0.4
+# @version 1.1.0
 # 
 # @example
 #   # Connect to the directory at the specified URL
@@ -53,10 +53,10 @@ end
 module Treequel
 
 	# Library version
-	VERSION = '1.0.4'
+	VERSION = '1.1.0'
 
 	# VCS revision
-	REVISION = %q$Revision: c8534439a5bc $
+	REVISION = %q$Revision: 2e2b035d3721 $
 
 	# Common paths for ldap.conf
 	COMMON_LDAP_CONF_PATHS = %w[
@@ -250,7 +250,7 @@ module Treequel
 	### @return [Hash] The hash of configuration values read from the file, in a form suitable for
 	###   passing to {Treequel::Directory#initialize}.
 	def self::read_opts_from_config( configfile )
-		Treequel.log.debug "Reading config options from %s..." % [ configfile ]
+		Treequel.log.info "Reading config options from %s..." % [ configfile ]
 		opts = {}
 
 		linecount = 0
@@ -292,7 +292,7 @@ module Treequel
 				opts[:port] = $1.to_i
 
 			# SSL <on|off|start_tls>
-			when /^\s*SSL\s+(on|off|start_tls)/i
+			when /^\s*SSL\s+(\S+)/i
 				mode = $1.downcase
 				case mode
 				when 'on'

data/rake/documentation.rb

@@ -44,6 +44,7 @@ begin
 	end
 
 	class YARD::CLI::Base; include YardGlobals; end
+	class YARD::CLI::Command; include YardGlobals; end
 	class YARD::Parser::SourceParser; extend YardGlobals; include YardGlobals; end
 	class YARD::Parser::CParser; include YardGlobals; end
 	class YARD::CodeObjects::Base; include YardGlobals; end
@@ -53,6 +54,32 @@ begin
 	class YARD::RegistryStore; include YardGlobals; end
 	class YARD::Docstring; include YardGlobals; end
 	module YARD::Templates::Helpers::ModuleHelper; include YardGlobals; end
+	module YARD::Tags::RefTaglist; include YardGlobals; end
+
+	if vvec(RUBY_VERSION) >= vvec("1.9.1")
+		# Monkeypatched to allow more than two '#' characters at the beginning
+		# of the comment line.
+		# Patched from yard-0.5.8
+		require 'yard/parser/ruby/ruby_parser'
+		class YARD::Parser::Ruby::RipperParser < Ripper
+			def on_comment(comment)
+				$stderr.puts "Adding comment: %p" % [ comment ]
+				visit_ns_token(:comment, comment)
+
+				comment = comment.gsub(/^\#+\s{0,1}/, '').chomp
+				append_comment = @comments[lineno - 1]
+
+				if append_comment && @comments_last_column == column
+					@comments.delete(lineno - 1)
+					comment = append_comment + "\n" + comment
+				end
+
+				@comments[lineno] = comment
+				@comments_last_column = column
+			end
+		end # class YARD::Parser::Ruby::RipperParser
+	end
+
 	# </metamonkeypatch>
 
 	YARD_OPTIONS = [] unless defined?( YARD_OPTIONS )

data/rake/hg.rb

@@ -215,13 +215,20 @@ unless defined?( HG_DOTDIR )
 			paths = get_repo_paths()
 			if origin_url = paths['default']
 				ask_for_confirmation( "Pull and update from '#{origin_url}'?", false ) do
-					run 'hg', 'pull', '-u'
+					Rake::Task['hg:pull_without_confirmation'].invoke
 				end
 			else
 				trace "Skipping pull: No 'default' path."
 			end
 		end
 
+
+		desc "Pull and update without confirmation"
+		task :pull_without_confirmation do
+			run 'hg', 'pull', '-u'
+		end
+
+
 		desc "Check the current code in if tests pass"
 		task :checkin => ['hg:pull', 'hg:newfiles', 'test', COMMIT_MSG_FILE] do
 			targets = get_target_args()
@@ -242,13 +249,18 @@ unless defined?( HG_DOTDIR )
 			paths = get_repo_paths()
 			if origin_url = paths['default']
 				ask_for_confirmation( "Push to '#{origin_url}'?", false ) do
-					run 'hg', 'push'
+					Rake::Task['hg:push_without_confirmation'].invoke
 				end
 			else
 				trace "Skipping push: No 'default' path."
 			end
 		end
 
+		desc "Push to the default repo without confirmation"
+		task :push_without_confirmation do
+			run 'hg', 'push'
+		end
+
 	end
 
 	if HG_DOTDIR.exist?

data/rake/manual.rb

@@ -269,7 +269,7 @@ module Manual
 
 		### Create a new PageCatalog that will load Manual::Page objects for .page files 
 		### in the specified +sourcedir+.
-		def initialize( sourcedir, layoutsdir )			
+		def initialize( sourcedir, layoutsdir )
 			@sourcedir = sourcedir
 			@layoutsdir = layoutsdir
 

data/spec/lib/constants.rb

@@ -21,32 +21,34 @@ module Treequel::TestConstants # :nodoc:all
 
 		TEST_DSE = [{
 			"supportedSASLMechanisms" => [
-				"SRP", "SRP", "SRP", "PLAIN", "PLAIN", 
-				"PLAIN", "OTP", "OTP", "OTP", "NTLM", "NTLM", "NTLM", "LOGIN", 
-				"LOGIN", "LOGIN", "GSSAPI", "GSSAPI", "GSSAPI", "DIGEST-MD5", 
+				"SRP", "SRP", "SRP", "PLAIN", "PLAIN",
+				"PLAIN", "OTP", "OTP", "OTP", "NTLM", "NTLM", "NTLM", "LOGIN",
+				"LOGIN", "LOGIN", "GSSAPI", "GSSAPI", "GSSAPI", "DIGEST-MD5",
 				"DIGEST-MD5", "DIGEST-MD5", "CRAM-MD5", "CRAM-MD5", "CRAM-MD5"
 			],
 			"supportedFeatures" => [
 				"1.3.6.1.1.14", "1.3.6.1.4.1.4203.1.5.1", "1.3.6.1.4.1.4203.1.5.2",
-				"1.3.6.1.4.1.4203.1.5.3", "1.3.6.1.4.1.4203.1.5.4", 
+				"1.3.6.1.4.1.4203.1.5.3", "1.3.6.1.4.1.4203.1.5.4",
 				"1.3.6.1.4.1.4203.1.5.5"
 			],
 			"namingContexts" => [TEST_BASE_DN],
 			"supportedLDAPVersion" => ["3"],
 			"subschemaSubentry" => ["cn=Subschema"],
 			"supportedControl" => [
-				"1.3.6.1.4.1.4203.1.9.1.1", "2.16.840.1.113730.3.4.18", 
+				"1.3.6.1.4.1.4203.1.9.1.1", "2.16.840.1.113730.3.4.18",
 				"2.16.840.1.113730.3.4.2", "1.3.6.1.4.1.4203.1.10.1",
-				"1.2.840.113556.1.4.319", "1.2.826.0.1.334810.2.3", 
+				"1.2.840.113556.1.4.319", "1.2.826.0.1.334810.2.3",
 				"1.2.826.0.1.3344810.2.3", "1.3.6.1.1.13.2",
 				"1.3.6.1.1.13.1", "1.3.6.1.1.12"
 			],
 			"supportedExtension" => [
-				"1.3.6.1.4.1.1466.20037", "1.3.6.1.4.1.4203.1.11.1", 
+				"1.3.6.1.4.1.1466.20037", "1.3.6.1.4.1.4203.1.11.1",
 				"1.3.6.1.4.1.4203.1.11.3"
 			],
 			"dn"=>[""]
 		}]
+		TEST_DSE.first.keys.each {|key| TEST_DSE.first[key].freeze }
+
 
 		TEST_HOSTS_DN_ATTR      = 'ou'
 		TEST_HOSTS_DN_VALUE     = 'Hosts'

data/spec/lib/control_behavior.rb

@@ -6,6 +6,7 @@ BEGIN {
 
 	libdir = basedir + "lib"
 
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 

data/spec/lib/matchers.rb

@@ -47,5 +47,6 @@ module Treequel::Matchers
 		ArrayIncludingMatcher.new( objects )
 	end
 
+
 end # module Treequel::Matchers