treequel 1.4.4 → 1.5.0pre445

data/lib/treequel/model.rb

@@ -70,6 +70,7 @@ class Treequel::Model < Treequel::Branch
 
 	@objectclass_registry = SET_HASH.dup
 	@base_registry = SET_HASH.dup
+	@directory = nil
 
 	class << self
 		attr_reader :objectclass_registry
@@ -77,6 +78,25 @@ class Treequel::Model < Treequel::Branch
 	end
 
 
+	### Return the Treequel::Directory the Model will use for searches, creating it if it 
+	### hasn't been created already. The default Directory will be created by calling
+	### Treequel.directory_from_config.
+	### @return [Treequel::Directory]  the default directory
+	def self::directory
+		self.directory = Treequel.directory_from_config unless @directory
+		return @directory
+	end
+
+
+	### Set the Treequel::Directory that should be used for searches. The receiving class will also
+	### be set as the #results_class of the +newdirectory+.
+	### @param [Treequel::Directory] newdirectory
+	def self::directory=( newdirectory )
+		@directory = newdirectory
+		@directory.results_class = self if @directory
+	end
+
+
 	### Inheritance callback -- add a class-specific objectclass registry to inheriting classes.
 	### @param [Class] subclass  the inheriting class
 	def self::inherited( subclass )

data/lib/treequel/model/objectclass.rb

@@ -10,6 +10,7 @@ require 'treequel/constants'
 # Mixin that provides Treequel::Model characteristics to a mixin module.
 module Treequel::Model::ObjectClass
 	include Treequel::HashUtilities
+	extend Treequel::Delegation
 
 
 	### Extension callback -- add data structures to the extending +mod+.
@@ -30,6 +31,17 @@ module Treequel::Model::ObjectClass
 	end
 
 
+	#################################################################
+	###	I N S T A N C E   M E T H O D S
+	#################################################################
+
+	# Delegate Branchset methods through #search to allow ObjectClass.filter as a shortcut for
+	# ObjectClass.search.filter
+	def_method_delegators :search, 
+		:collection, :map, :to_hash, :each, :first, 
+		:filter, :scope, :select, :limit, :timeout, :as, :from
+
+
 	### Declare which Treequel::Model subclasses the mixin will register itself with. If this is
 	### used, it should be declared *before* declaring the mixin's bases and/or objectClasses.
 	def model_class( mclass=nil )
@@ -75,11 +87,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={} )
+	### @overload create( dn, entryhash={} )
+	###   Create a new instance of the mixin's model_class in the model_class's default
+	###   directory with the given +dn+ and the objectclasses specified by the mixin. If the
+	###   optional +entryhash+ is given, it will be used as the initial attributes of the
+	###   new entry.
+	###   @param [#to_s] dn                       the DN of the new model object
+	###   @param [Hash] entryhash                 attributes to set on the new entry
+	### @overload create( directory, dn, entryhash={} )
+	###   Create a new instance of the mixin's model_class in the specified +directory+
+	###   with the given +dn+ and the objectclasses specified by the mixin. If the
+	###   optional +entryhash+ is given, it will be used as the initial attributes of the
+	###   new entry.
+	###   @param [Treequel::Directory] directory  the directory to create the entry in (optional)
+	###   @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=nil, entryhash={} )
+
+		# Shift the arguments if the first one isn't a directory
+		unless directory.is_a?( Treequel::Directory )
+			entryhash = dn || {}
+			dn = directory
+			directory = self.model_class.directory
+		end
+
 		entryhash = stringify_keys( entryhash )
 
 		# Add the objectclasses from the mixin
@@ -103,17 +134,20 @@ module Treequel::Model::ObjectClass
 	### base) that can be used to search the given +directory+ for entries to which
 	### the receiver applies.
 	###
-	### @param [Treequel::Directory] directory  the directory to search
+	### @param [Treequel::Directory] directory  the directory to search; if not given, this defaults
+	###                                         to the directory associated with the module's
+	###                                         model_class.
 	### @return [Treequel::Branchset, Treequel::BranchCollection]  the encapsulated search
-	def search( directory )
+	def search( directory=nil )
+		directory ||= self.model_class.directory
 		bases = self.model_bases
 		objectclasses = self.model_objectclasses
 
 		raise Treequel::ModelError, "%p has no search criteria defined" % [ self ] if
 			bases.empty? && objectclasses.empty?
 
-		Treequel.log.debug "Creating search for %s using model class %p" %
-			[ self.name, self.model_class ]
+		Treequel.log.debug "Creating search for %p using model class %p" %
+			[ self, self.model_class ]
 
 		# Start by making a Branchset or BranchCollection for the mixin's bases. If
 		# the mixin doesn't have any bases, just use the base DN of the directory

data/spec/lib/constants.rb

@@ -87,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    = 'jrandom'
+		TEST_PERSON_DN_VALUE    = 'slappy'
 		TEST_PERSON_RDN         = "#{TEST_PERSON_DN_ATTR}=#{TEST_PERSON_DN_VALUE}"
 		TEST_PERSON_DN          = "#{TEST_PERSON_RDN},#{TEST_PEOPLE_DN}"
 
@@ -124,6 +124,67 @@ module Treequel::TestConstants # :nodoc:all
 		]
 		TEST_HOST_MULTIVALUE_DN        = "#{TEST_HOST_MULTIVALUE_RDN},#{TEST_HOSTS_DN}"
 
+		# Test entry hashes
+		TEST_HOSTS_ENTRY = {
+			'dn'               => [TEST_HOSTS_DN],
+			TEST_HOSTS_DN_ATTR => [TEST_HOSTS_DN_VALUE], 
+			'objectClass'      => ['top', 'organizationalUnit'],
+			'description'      => ['Hosts under acme.com'],
+		}
+
+		TEST_PEOPLE_ENTRY = {
+			'dn'               => [TEST_PEOPLE_DN],
+			TEST_PEOPLE_DN_ATTR => [TEST_PEOPLE_DN_VALUE], 
+			'objectClass'      => ['top', 'organizationalUnit'],
+			'description'      => ['Acme.com employees'],
+		}
+
+		TEST_PERSON_ENTRY = {
+			'dn'                => [TEST_PERSON_DN],
+			TEST_PERSON_DN_ATTR => [TEST_PERSON_DN_VALUE],
+			'cn'                => ['Slappy the Frog'],
+			'givenName'         => ['Slappy'],
+			'sn'                => ['Frog'],
+			'l'                 => ['a forest in England'],
+			'title'             => ['Forest Fire Prevention Advocate'],
+			'displayName'       => ['Slappy the Frog'],
+			'logonTime'         => ['1293167318'],
+			'uidNumber'         => ['1121'],
+			'gidNumber'         => ['200'],
+			'homeDirectory'     => ['/u/j/jrandom'],
+			'description'       => [
+				'Smokey the Bear is much more intense in person.', 
+				'Alright.'
+			],
+			'objectClass'       => %w[
+				top
+				person
+				organizationalPerson
+				inetOrgPerson
+				posixAccount
+				shadowAccount
+				apple-user
+			],
+		}
+
+		TEST_OPERATIONAL_PEOPLE_ENTRY = {
+			TEST_PEOPLE_DN_ATTR     => [TEST_PEOPLE_DN_VALUE], 
+			'structuralObjectClass' => ['organizationalUnit'],
+			'entryUUID'             => ['5035e674-bae3-102b-992e-e9e937d524d6'],
+			'creatorsName'          => ['cn=admin,dc=laika,dc=com'],
+			'createTimestamp'       => ['20070629232213Z'],
+			'entryCSN'              => ['20070629232213.000000Z#000000#000#000000'],
+			'modifiersName'         => ['cn=admin,dc=laika,dc=com'],
+			'modifyTimestamp'       => ['20070629232213Z'],
+			'entryDN'               => [TEST_PEOPLE_DN],
+			'subschemaSubentry'     => ['cn=Subschema'],
+			'hasSubordinates'       => ['TRUE'],
+			'dn'                    => [TEST_PEOPLE_DN],
+			'objectClass'           => ['top', 'organizationalUnit'],
+			'description'           => ['Acme.com employees'],
+		}
+
+
 		constants.each do |cname|
 			const_get(cname).freeze
 		end

data/spec/lib/helpers.rb

@@ -127,7 +127,7 @@ module Treequel::SpecHelpers
 	### LDAP connection. Also pre-loads the schema object and fixtures some other
 	### external data.
 	def get_fixtured_directory( conn )
-		LDAP::SSLConn.stub( :new ).and_return( @conn )
+		LDAP::SSLConn.stub( :new ).and_return( conn )
 		conn.stub( :search_ext2 ).
 			with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
 			and_return( TEST_DSE )
@@ -163,6 +163,8 @@ end
 
 ### Mock with Rspec
 Rspec.configure do |c|
+	include Treequel::TestConstants
+
 	c.mock_with :rspec
 
 	c.extend( Treequel::TestConstants )

data/spec/treequel/branch_spec.rb

@@ -28,9 +28,6 @@ include Treequel::Constants
 #####################################################################
 
 describe Treequel::Branch do
-	include Treequel::SpecHelpers,
-			Treequel::Matchers
-
 
 	before( :all ) do
 		setup_logging( :fatal )
@@ -241,13 +238,13 @@ describe Treequel::Branch do
 
 		it "clears any cached values if its include_operational_attrs attribute is changed" do
 			@directory.should_receive( :get_entry ).with( @branch ).exactly( :once ).
-				and_return( :the_entry )
+				and_return( TEST_PEOPLE_ENTRY.dup )
 			@directory.should_receive( :get_extended_entry ).with( @branch ).exactly( :once ).
-				and_return( :the_extended_entry )
+				and_return( TEST_OPERATIONAL_PEOPLE_ENTRY.dup )
 
-			@branch.entry.should == :the_entry
+			@branch.entry.should == TEST_PEOPLE_ENTRY.dup.tap {|entry| entry.delete('dn') }
 			@branch.include_operational_attrs = true
-			@branch.entry.should == :the_extended_entry
+			@branch.entry.should == TEST_OPERATIONAL_PEOPLE_ENTRY.dup.tap {|entry| entry.delete('dn') }
 		end
 
 		it "returns a human-readable representation of itself for #inspect" do

data/spec/treequel/branchset_spec.rb

@@ -34,6 +34,7 @@ describe Treequel::Branchset do
 		:server_controls => [],
 	}
 
+
 	before( :all ) do
 		setup_logging( :fatal )
 	end
@@ -56,12 +57,10 @@ describe Treequel::Branchset do
 		end
 
 		it "is Enumerable" do
-			resultbranch = mock( "Result Branch" )
-
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-				and_yield( resultbranch )
-			resultbranch.should_receive( :dn ).and_return( :its_dn )
+			@conn.should_receive( :search_ext2 ).
+				with( TEST_BASE_DN, LDAP::LDAP_SCOPE_SUBTREE, "(objectClass=*)", 
+				      [], false, [], [], 0, 0, 0, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup ])
 
 			@branchset.all? {|b| b.dn }
 		end
@@ -70,20 +69,18 @@ describe Treequel::Branchset do
 		# #empty?
 		# 
 		it "is empty if it doesn't match at least one entry" do
-			params = @params.merge( :limit => 1 )
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, params ).
-				and_return( [] )
-
+			@conn.should_receive( :search_ext2 ).
+				with( TEST_BASE_DN, LDAP::LDAP_SCOPE_SUBTREE, "(objectClass=*)", 
+				      [], false, [], [], 0, 0, 1, "", nil ).
+				and_return([ ])
 			@branchset.should be_empty()
 		end
 
 		it "isn't empty if it matches at least one entry" do
-			params = @params.merge( :limit => 1 )
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, params ).
-				and_return( [:a_branch] )
-
+			@conn.should_receive( :search_ext2 ).
+				with( TEST_BASE_DN, LDAP::LDAP_SCOPE_SUBTREE, "(objectClass=*)", 
+				      [], false, [], [], 0, 0, 1, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup ])
 			@branchset.should_not be_empty()
 		end
 
@@ -91,16 +88,12 @@ describe Treequel::Branchset do
 		# #map
 		# 
 		it "can be mapped into an Array of attribute values" do
-			resultbranch = mock( "Result Branch" )
-			resultbranch2 = mock( "Result Branch 2" )
+			@conn.should_receive( :search_ext2 ).
+				with( TEST_BASE_DN, LDAP::LDAP_SCOPE_SUBTREE, "(objectClass=*)", 
+				      [], false, [], [], 0, 0, 0, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup, TEST_PEOPLE_ENTRY.dup ])
 
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-				and_yield( resultbranch ).and_yield( resultbranch2 )
-			resultbranch.should_receive( :[] ).with( :cn ).and_return([ :first_cn ])
-			resultbranch2.should_receive( :[] ).with( :cn ).and_return([ :second_cn ])
-
-			@branchset.map( :cn ).should == [[:first_cn], [:second_cn]]
+			@branchset.map( :ou ).should == [ ['Hosts'], ['People'] ]
 		end
 
 
@@ -108,47 +101,30 @@ describe Treequel::Branchset do
 		# #to_hash
 		# 
 		it "can be mapped into a Hash of entries keyed by one of its attributes" do
-			resultbranch = mock( "Result Branch" )
-			resultbranch2 = mock( "Result Branch 2" )
-
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-				and_yield( resultbranch ).and_yield( resultbranch2 )
-
-			resultbranch.should_receive( :[] ).with( :email ).
-				and_return([ :first_email ])
-			resultbranch.should_receive( :entry ).and_return( :entry1 )
-			resultbranch2.should_receive( :[] ).with( :email ).
-				and_return([ :second_email, :second_second_email ])
-			resultbranch2.should_receive( :entry ).and_return( :entry2 )
-
-			@branchset.to_hash( :email ).should == {
-				:first_email => :entry1,
-				:second_email => :entry2,
+			@conn.should_receive( :search_ext2 ).
+				with( "dc=acme,dc=com", 2, "(objectClass=*)", [], false, [], [], 0, 0, 0, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup, TEST_PEOPLE_ENTRY.dup ])
+
+			hosthash = TEST_HOSTS_ENTRY.dup
+			hosthash.delete( 'dn' )
+			peoplehash = TEST_PEOPLE_ENTRY.dup
+			peoplehash.delete( 'dn' )
+
+			@branchset.to_hash( :ou ).should == {
+				'Hosts'  => hosthash,
+				'People' => peoplehash,
 			}
 		end
 
 
 		it "can be mapped into a Hash of tuples using two attributes" do
-			resultbranch = mock( "Result Branch" )
-			resultbranch2 = mock( "Result Branch 2" )
+			@conn.should_receive( :search_ext2 ).
+				with( "dc=acme,dc=com", 2, "(objectClass=*)", [], false, [], [], 0, 0, 0, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup, TEST_PEOPLE_ENTRY.dup ])
 
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-				and_yield( resultbranch ).and_yield( resultbranch2 )
-
-			resultbranch.should_receive( :[] ).with( :email ).
-				and_return([ :first_email ])
-			resultbranch.should_receive( :[] ).with( :cn ).
-				and_return([ :first_cn ])
-			resultbranch2.should_receive( :[] ).with( :email ).
-				and_return([ :second_email, :second_second_email ])
-			resultbranch2.should_receive( :[] ).with( :cn ).
-				and_return([ :second_cn, :second_second_cn ])
-
-			@branchset.to_hash( :email, :cn ).should == {
-				:first_email => :first_cn,
-				:second_email => :second_cn,
+			@branchset.to_hash( :ou, :description ).should == {
+				'Hosts'  => TEST_HOSTS_ENTRY['description'].first,
+				'People' => TEST_PEOPLE_ENTRY['description'].first,
 			}
 		end
 
@@ -156,8 +132,7 @@ describe Treequel::Branchset do
 		# #+
 		#
 		it "can be combined with another instance into a BranchCollection by adding them together" do
-			other_branch = mock( "second treequel branch", :dn => 'theotherdn' )
-			other_branch.stub( :directory ).and_return( @directory )
+			other_branch = @directory.ou( :people )
 			other_branchset = Treequel::Branchset.new( other_branch )
 
 			result = @branchset + other_branchset
@@ -167,18 +142,15 @@ describe Treequel::Branchset do
 		end
 
 		it "returns the results of the search with the additional Branch if one is added to it" do
-			other_branch = mock( "additional treequel branch", :dn => 'theotherdn' )
-			other_branch.stub( :to_ary ).and_return( [other_branch] )
-			resultbranch = mock( "Result Branch" )
-			resultbranch2 = mock( "Result Branch 2" )
+			@conn.should_receive( :search_ext2 ).
+				with( "dc=acme,dc=com", 2, "(objectClass=*)", [], false, [], [], 0, 0, 0, "", nil ).
+				and_return([ TEST_HOSTS_ENTRY.dup, TEST_PEOPLE_ENTRY.dup ])
 
-			@branch.should_receive( :search ).
-				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-				and_yield( resultbranch ).and_yield( resultbranch2 )
+			other_branch = @directory.ou( :netgroups )
 
 			result = @branchset + other_branch
 			result.should have( 3 ).members
-			result.should include( other_branch, resultbranch, resultbranch2 )
+			result.should include( other_branch )
 		end
 
 		#
@@ -186,18 +158,15 @@ describe Treequel::Branchset do
 		#
 		it "returns the results of the search without the specified object if an object is " +
 		     "subtracted from it" do
-				resultbranch = stub( "Result Branch", :dn => TEST_PERSON_DN )
-				resultbranch2 = stub( "Result Branch 2", :dn => TEST_PERSON2_DN )
-
-				otherbranch = stub( "Subtracted Branch", :dn => TEST_PERSON2_DN )
+				otherbranch = @directory.ou( :people )
 
-				@branch.should_receive( :search ).
-					with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
-					and_yield( resultbranch ).and_yield( resultbranch2 )
+				@conn.should_receive( :search_ext2 ).
+					with( "dc=acme,dc=com", 2, "(objectClass=*)", [], false, [], [], 0, 0, 0, "", nil ).
+					and_return([ TEST_HOSTS_ENTRY.dup, TEST_PEOPLE_ENTRY.dup ])
 
 				result = @branchset - otherbranch
 				result.should have( 1 ).members
-				result.should_not include( resultbranch2 )
+				result.should_not include( otherbranch )
 		end
 
 	end

data/spec/treequel/mixins_spec.rb

@@ -245,6 +245,14 @@ describe Treequel, "mixin" do
 				@obj.delegated_method( :arg1, :arg2 )
 			end
 
+			it "allows delegation to the delegate object's method with a block" do
+				@subobj.should_receive( :delegated_method ).with( :arg1 ).
+					and_yield( :the_block_argument )
+				blockarg = nil
+				@obj.delegated_method( :arg1 ) {|arg| blockarg = arg }
+				blockarg.should == :the_block_argument
+			end
+
 			it "reports errors from its caller's perspective", :ruby_1_8_only => true do
 				begin
 					@obj.erroring_delegated_method
@@ -291,6 +299,14 @@ describe Treequel, "mixin" do
 				@obj.delegated_method( :arg1, :arg2 )
 			end
 
+			it "allows delegation to the delegate's method with a block" do
+				@subobj.should_receive( :delegated_method ).with( :arg1 ).
+					and_yield( :the_block_argument )
+				blockarg = nil
+				@obj.delegated_method( :arg1 ) {|arg| blockarg = arg }
+				blockarg.should == :the_block_argument
+			end
+
 			it "reports errors from its caller's perspective", :ruby_1_8_only => true do
 				begin
 					@obj.erroring_delegated_method