treequel 1.2.2 → 1.3.0pre384

data/lib/treequel/model/errors.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'treequel'
+require 'treequel/model'
+require 'treequel/mixins'
+require 'treequel/constants'
+
+
+# Mixin that provides Treequel::Model characteristics to a mixin module.
+# 
+# The ideas and a large portion of the implementation of this class is borrowed from
+# Sequel under the following license terms:
+# 
+#     Copyright (c) 2007-2008 Sharon Rosner
+#     Copyright (c) 2008-2010 Jeremy Evans
+#     
+#     Permission is hereby granted, free of charge, to any person obtaining a copy
+#     of this software and associated documentation files (the "Software"), to
+#     deal in the Software without restriction, including without limitation the
+#     rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+#     sell copies of the Software, and to permit persons to whom the Software is
+#     furnished to do so, subject to the following conditions:
+#       
+#     The above copyright notice and this permission notice shall be included in
+#     all copies or substantial portions of the Software.
+#        
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+#     THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+#     IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+#     CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# 
+class Treequel::Model::Errors < ::Hash
+	include Treequel::HashUtilities,
+	        Treequel::Loggable
+
+	# The word to use between attributes in error messages
+	ATTRIBUTE_CONJUNCTION = ' and '
+
+
+	### Set the initializer block to auto-create Array values.
+	def initialize( *args )
+		block = lambda {|h,k| h[k] = [] }
+		super( *args, &block )
+	end
+
+
+	### Adds an error for the given +attribute+.
+	### @param [Symbol, #to_sym] attribute  the attribute with an error
+	### @param [String] message             the description of the error condition
+	def add( attribute, message )
+		self[ attribute ] << message
+	end
+
+
+	### Get the number of errors that have been registered.
+	### @Return [Fixnum]  the number of errors
+	def count
+		return self.values.inject( 0 ) {|num, val| num + val.length }
+	end
+
+
+    ### Get an Array of messages describing errors which have occurred.
+    ### @example
+    ###   errors.full_messages
+    ###   # => ['cn is not valid',
+    ###   #     'uid is not at least 2 letters']
+	def full_messages
+		return self.inject([]) do |full_messages, (attribute, messages)|
+			subject = Array( attribute ).join( ATTRIBUTE_CONJUNCTION )
+			messages.each {|part| full_messages << "#{subject} #{part}" }
+			full_messages
+		end
+	end
+
+end # class Treequel::Model::Errors
+

data/lib/treequel/model/objectclass.rb

@@ -9,12 +9,12 @@ require 'treequel/constants'
 
 # Mixin that provides Treequel::Model characteristics to a mixin module.
 module Treequel::Model::ObjectClass
+	include Treequel::HashUtilities
+
 
 	### Extension callback -- add data structures to the extending +mod+.
 	### @param [Module] mod  the mixin module to be extended
 	def self::extended( mod )
-		# mod.instance_variable_set( :@model_directory, nil )
-		# mod.instance_variable_set( :@model_bases, [] )
 		mod.instance_variable_set( :@model_class, Treequel::Model )
 		mod.instance_variable_set( :@model_objectclasses, [] )
 		mod.instance_variable_set( :@model_bases, [] )
@@ -75,6 +75,30 @@ module Treequel::Model::ObjectClass
 	end
 
 
+	### Instantiate a new Treequel::Model object with given +dn+ and the objectclasses 
+	### specified by the receiving module.
+	### @param [#to_s] dn        the DN of the new model object
+	### @param [Hash] entryhash  attributes to set on the new entry
+	def create( directory, dn, entryhash={} )
+		entryhash = stringify_keys( entryhash )
+
+		# Add the objectclasses from the mixin
+		entryhash['objectClass'] ||= []
+		entryhash['objectClass'].collect!( &:to_s )
+		entryhash['objectClass'] |= self.model_objectclasses.map( &:to_s )
+
+		# Add all the attribute pairs from the RDN bit of the DN to the entry
+		rdn_pair, _ = dn.split( /\s*,\s*/, 2 )
+		rdn_pair.split( /\+/ ).each do |attrpair|
+			k, v = attrpair.split( /\s*=\s*/ )
+			entryhash[ k ] ||= []
+			entryhash[ k ] << v
+		end
+
+		return self.model_class.new( directory, dn, entryhash )
+	end
+
+
 	### Return a Branchset (or BranchCollection if the receiver has more than one
 	### base) that can be used to search the given +directory+ for entries to which
 	### the receiver applies.

data/lib/treequel/model/schemavalidations.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+
+require 'treequel/model'
+
+
+# A collection of schema-based validations for LDAP model objects.
+module Treequel::Model::SchemaValidations
+
+	### Entrypoint -- run all the validations, adding any errors to the
+	### object's #error collector.
+	def validate( options={} )
+		return unless options[:with_schema]
+
+		self.validate_must_attributes
+		self.validate_may_attributes
+		self.validate_attribute_syntax
+	end
+
+
+	### Validate that all attributes that MUST be included according to the entry's
+	### objectClasses have at least one value.
+	def validate_must_attributes
+		self.must_attribute_types.each do |attrtype|
+			oid = attrtype.name
+			if attrtype.single?
+				self.errors.add( oid, "MUST have a value" ) unless self[ oid ]
+			else
+				self.errors.add( oid, "MUST have at least one value" ) if self[ oid ].empty?
+			end
+		end
+	end
+
+
+	### Validate that all attributes present in the entry are allowed by either a
+	### MUST or a MAY rule of one of its objectClasses.
+	def validate_may_attributes
+		hash = (self.entry || {} ).merge( @values )
+		attributes = hash.keys.map( &:to_sym ).uniq
+		valid_attributes = self.valid_attribute_oids
+
+		self.log.debug "Validating MAY attributes: %p against the list of valid OIDs: %p" %
+			[ attributes, valid_attributes ]
+		unknown_attributes = attributes - valid_attributes
+		unknown_attributes.each do |oid|
+			self.errors.add( oid, "is not allowed by entry's objectClasses" )
+		end
+	end
+
+
+	### Validate that the attribute values present in the entry are all valid according to
+	### the syntax rule for it.
+	def validate_attribute_syntax
+		@values.each do |attribute, values|
+			[ values ].flatten.each do |value|
+				begin
+					self.get_converted_attribute( attribute.to_sym, value )
+				rescue => err
+					self.log.error "validation for %p failed: %s: %s" %
+						[ attribute, err.class.name, err.message ]
+					attrtype = self.find_attribute_type( attribute )
+					self.errors.add( attribute, "isn't a valid %s value" % [attrtype.syntax.desc] )
+				end
+			end
+		end
+	end
+
+end # module Treequel::Model::SchemaValidations
+

data/lib/treequel/monkeypatches.rb

@@ -1,5 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'date'
+
+require 'diff/lcs'
+require 'diff/lcs/change'
+
 require 'ldap'
 require 'ldap/control'
 
@@ -57,26 +62,26 @@ module Treequel::TimeExtensions
 			if fraction_digits == 0
 				''
 			elsif fraction_digits <= 6
-				'.' + sprintf('%06d', usec)[0, fraction_digits]
+				'.' + sprintf('%06d', self.usec)[0, fraction_digits]
 			else
-				'.' + sprintf('%06d', usec) + '0' * (fraction_digits - 6)
+				'.' + sprintf('%06d', self.usec) + '0' * (fraction_digits - 6)
 			end
 		tz =
 			if self.utc?
 				'Z'
 			else
-				off  = utc_offset
+				off  = self.utc_offset
 				sign = off < 0 ? '-' : '+'
 				"%s%02d%02d" % [ sign, *(off.abs / 60).divmod(60) ]
 			end
 
 		return "%02d%02d%02d%02d%02d%02d%s%s" % [
-			year,
-			mon,
-			day,
-			hour,
-			min,
-			sec,
+			self.year,
+			self.mon,
+			self.day,
+			self.hour,
+			self.min,
+			self.sec,
 			fractional_seconds,
 			tz
 		]
@@ -87,21 +92,21 @@ module Treequel::TimeExtensions
 	### (UTC Time)
 	def ldap_utc
 		tz =
-			if utc?
+			if self.utc?
 				'Z'
 			else
-				off  = utc_offset
+				off  = self.utc_offset
 				sign = off < 0 ? '-' : '+'
 				"%s%02d%02d" % [ sign, *(off.abs / 60).divmod(60) ]
 			end
 
 		return "%02d%02d%02d%02d%02d%02d%s" % [
-			year.divmod(100).last,
-			mon,
-			day,
-			hour,
-			min,
-			sec,
+			self.year.divmod(100).last,
+			self.mon,
+			self.day,
+			self.hour,
+			self.min,
+			self.sec,
 			tz
 		]
 	end
@@ -113,3 +118,80 @@ class Time
 end
 
 
+### Extensions to the Date class to add LDAP (RFC4517) Generalized Time syntax
+module Treequel::DateExtensions
+
+	### Return +self+ as a String formatted as specified in RFC4517 
+	### (LDAP Generalized Time).
+	def ldap_generalized( fraction_digits=0 )
+		fractional_seconds =
+			if fraction_digits == 0
+				''
+			else
+				'.' + ('0' * fraction_digits)
+			end
+
+		off  = Time.now.utc_offset
+		sign = off < 0 ? '-' : '+'
+		tz   = "%s%02d%02d" % [ sign, *(off.abs / 60).divmod(60) ]
+
+		return "%02d%02d%02d%02d%02d%02d%s%s" % [
+			self.year,
+			self.mon,
+			self.day,
+			0,
+			0,
+			1,
+			fractional_seconds,
+			tz
+		]
+
+	end
+
+	### Returns +self+ as a String formatted as specified in RFC4517
+	### (UTC Time)
+	def ldap_utc
+		off  = Time.now.utc_offset
+		sign = off < 0 ? '-' : '+'
+		tz   = "%s%02d%02d" % [ sign, *(off.abs / 60).divmod(60) ]
+
+		return "%02d%02d%02d%02d%02d%02d%s" % [
+			self.year.divmod(100).last,
+			self.mon,
+			self.day,
+			0,
+			0,
+			1,
+			tz
+		]
+	end
+
+end # module Treequel::TimeExtensions
+
+class Date
+	include Treequel::DateExtensions
+end
+
+
+### These three predicates use the wrong instance variable in the library.
+### :TODO: Submit a patch!
+module Treequel::DiffLCSChangeTypeTestFixes
+
+	def changed?
+		@action == '!'
+	end
+
+	def finished_a?
+		@action == '>'
+	end
+
+	def finished_b?
+		@action == '<'
+	end
+
+end
+
+class Diff::LCS::ContextChange
+	include Treequel::DiffLCSChangeTypeTestFixes
+end
+

data/lib/treequel/schema.rb

@@ -209,17 +209,21 @@ class Treequel::Schema
 	end
 
 
+	### Return the schema as a human-readable english string.
+	def to_s
+		parts = [ "Schema:" ]
+		parts << self.ivar_descriptions.collect {|desc| '  ' + desc }
+		return parts.join( $/ )
+	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
-			"%d %s" % [ len, ivar.to_s.gsub(/_/, ' ')[1..-1] ]
-		end
 		return %{#<%s:0x%0x %s>} % [
 			self.class.name,
 			self.object_id / 2,
-			ivar_descs.join(', '),
+			self.ivar_descriptions.join( ', ' ),
 		]
 	end
 
@@ -308,5 +312,15 @@ class Treequel::Schema
 	end
 
 
+	### Return descriptions of the schema's artifacts.
+	### @return [Array<String>]  the descriptions of the schema's artifacts, and how many of each 
+	###     it has.
+	def ivar_descriptions
+		self.instance_variables.sort.collect do |ivar|
+			len = self.instance_variable_get( ivar ).length
+			"%d %s" % [ len, ivar.to_s.gsub(/_/, ' ')[1..-1] ]
+		end		
+	end
+
 end # class Treequel::Schema
 

data/spec/lib/constants.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'yaml'
 require 'ldap'
 require 'treequel'
 
@@ -40,7 +41,8 @@ module Treequel::TestConstants # :nodoc:all
 				"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.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"
+				"1.3.6.1.1.13.1", "1.3.6.1.1.12",
+				"1.2.840.113556.1.4.473", "1.2.840.113556.1.4.474"
 			],
 			"supportedExtension" => [
 				"1.3.6.1.4.1.1466.20037", "1.3.6.1.4.1.4203.1.11.1",
@@ -50,6 +52,9 @@ module Treequel::TestConstants # :nodoc:all
 		}]
 		TEST_DSE.first.keys.each {|key| TEST_DSE.first[key].freeze }
 
+		SCHEMA_DUMPFILE = Pathname( __FILE__ ).dirname.parent + 'data' + 'schema.yml'
+		SCHEMAHASH      = LDAP::Schema.new( YAML.load_file(SCHEMA_DUMPFILE) )
+		SCHEMA          = Treequel::Schema.new( SCHEMAHASH )
 
 		TEST_HOSTS_DN_ATTR      = 'ou'
 		TEST_HOSTS_DN_VALUE     = 'Hosts'
@@ -82,7 +87,7 @@ module Treequel::TestConstants # :nodoc:all
 		TEST_PEOPLE_DN          = "#{TEST_PEOPLE_RDN},#{TEST_BASE_DN}"
 
 		TEST_PERSON_DN_ATTR     = 'uid'
-		TEST_PERSON_DN_VALUE    = 'arogers'
+		TEST_PERSON_DN_VALUE    = 'jrandom'
 		TEST_PERSON_RDN         = "#{TEST_PERSON_DN_ATTR}=#{TEST_PERSON_DN_VALUE}"
 		TEST_PERSON_DN          = "#{TEST_PERSON_RDN},#{TEST_PEOPLE_DN}"
 
@@ -106,6 +111,19 @@ module Treequel::TestConstants # :nodoc:all
 		TEST_ROOM_RDN           = "#{TEST_ROOM_DN_ATTR}=#{TEST_ROOM_DN_VALUE}"
 		TEST_ROOM_DN            = "#{TEST_ROOM_RDN},#{TEST_ROOMS_DN}"
 
+		# Multivalue DN
+		TEST_HOST_MULTIVALUE_DN_ATTR1  = 'cn'
+		TEST_HOST_MULTIVALUE_DN_VALUE1 = 'honcho'
+		TEST_HOST_MULTIVALUE_DN_ATTR2  = 'l'
+		TEST_HOST_MULTIVALUE_DN_VALUE2 = 'sandiego'
+		TEST_HOST_MULTIVALUE_RDN       = "%s=%s+%s=%s" % [
+			TEST_HOST_MULTIVALUE_DN_ATTR1,
+			TEST_HOST_MULTIVALUE_DN_VALUE1,
+			TEST_HOST_MULTIVALUE_DN_ATTR2,
+			TEST_HOST_MULTIVALUE_DN_VALUE2,
+		]
+		TEST_HOST_MULTIVALUE_DN        = "#{TEST_HOST_MULTIVALUE_RDN},#{TEST_HOSTS_DN}"
+
 		constants.each do |cname|
 			const_get(cname).freeze
 		end