treequel 1.0.4 → 1.1.0

data/spec/treequel/branchset_spec.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 )
 }
 
@@ -172,16 +173,38 @@ describe Treequel::Branchset do
 			result.branchsets.should include( @branchset, other_branchset )
 		end
 
-		they "can be combined with a Branch into a BranchCollection by adding it" do
-			other_branch = mock( "second treequel branch", :dn => 'theotherdn' )
-			other_branch.stub!( :directory ).and_return( @directory )
+		they "return 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" )
+
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+				and_yield( resultbranch ).and_yield( resultbranch2 )
 
 			result = @branchset + other_branch
-			result.should be_a( Treequel::BranchCollection )
-			result.branchsets.should have( 2 ).members
-			result.branchsets.should include( @branchset )
-			result.branchsets.select {|bs| bs != @branchset }.
-				first.branch.should == other_branch
+			result.should have( 3 ).members
+			result.should include( other_branch, resultbranch, resultbranch2 )
+		end
+
+		#
+		# #-
+		#
+		they "return 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 )
+
+				@branch.should_receive( :search ).
+					with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+					and_yield( resultbranch ).and_yield( resultbranch2 )
+
+				result = @branchset - otherbranch
+				result.should have( 1 ).members
+				result.should_not include( resultbranch2 )
 		end
 
 	end
@@ -233,6 +256,24 @@ describe Treequel::Branchset do
 			newset.filter_string.should == '(clothing=pants)'
 		end
 
+		#
+		# #or
+		#
+
+		it "creates a new branchset cloned from itself with an OR clause added to to an " +
+		   "existing filter" do
+			pantset = @branchset.filter( :clothing => 'pants' )
+			bothset = pantset.or( :clothing => 'shirt' )
+
+			bothset.filter_string.should == '(|(clothing=pants)(clothing=shirt))'
+		end
+
+		it "raises an exception if #or is invoked without an existing filter" do
+			expect {
+				@branchset.or( :clothing => 'shirt' )
+			}.to raise_exception( Treequel::ExpressionError, /no existing filter/i )
+		end
+
 		# 
 		# #scope
 		# 
@@ -287,6 +328,12 @@ describe Treequel::Branchset do
 			newset.select.should == [ 'l', 'cn', 'uid', 'firstName', 'lastName' ]
 		end
 
+		it "adding attributes via #select_more should work even if there was no current " +
+		   "attribute selection" do
+			newset = @branchset.select_more( :firstName, :uid, :lastName, :objectClass )
+			newset.select.should include( 'uid', 'firstName', 'lastName', 'objectClass' )
+		end
+
 		it "uses its selection as the list of attributes to fetch when searching" do
 			@branchset.options[:select] = [ :l, :cn, :uid ]
 			@branch.should_receive( :search ).
@@ -432,6 +479,10 @@ describe Treequel::Branchset do
 			@directory.stub!( :registered_controls ).and_return([ @control ])
 		end
 
+		after( :each ) do
+			@directory = nil
+		end
+
 		it "extends instances of itself with any controls registered with its Branch's Directory" do
 			set = Treequel::Branchset.new( @branch )
 			set.should respond_to( :yep )

data/spec/treequel/control_spec.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/treequel/controls/contentsync_spec.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/treequel/controls/pagedresults_spec.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/treequel/controls/sortedresults_spec.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/treequel/directory_spec.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 )
 }
 
@@ -88,6 +89,22 @@ describe Treequel::Directory do
 		@dir.base_dn.should == TEST_BASE_DN
 	end
 
+	it "can return its root element as a Branch instance" do
+		@dir = Treequel::Directory.new( @options )
+		@dir.base.should be_a( Treequel::Branch )
+		@dir.base.dn.should == TEST_BASE_DN
+	end
+
+	it "can return its root element as an instance of its results class if it's been set" do
+		subtype = Class.new( Treequel::Branch )
+		@dir = Treequel::Directory.new( @options )
+
+		@dir.results_class = subtype
+
+		@dir.base.should be_a( subtype )
+		@dir.base.dn.should == TEST_BASE_DN
+	end
+
 
 	describe "instances without existing connections" do
 
@@ -539,22 +556,40 @@ describe Treequel::Directory do
 
 		### Datatype conversion
 
-		it "allows a mapping to be overridden by a block for a valid syntax OID" do
-			@dir.add_syntax_mapping( OIDS::BIT_STRING_SYNTAX ) do |unconverted_value|
+		it "allows an attribute conversion to be overridden by a block for a valid syntax OID" do
+			@dir.add_attribute_conversion( OIDS::BIT_STRING_SYNTAX ) do |unconverted_value, directory|
 				unconverted_value.to_sym
 			end
-			@dir.convert_syntax_value( OIDS::BIT_STRING_SYNTAX, 'a_value' ).should == :a_value
+			@dir.convert_to_object( OIDS::BIT_STRING_SYNTAX, 'a_value' ).should == :a_value
+		end
+
+		it "allows an attribute conversion to be overridden by a Hash for a valid syntax OID" do
+			@dir.add_attribute_conversion( OIDS::BOOLEAN_SYNTAX, {'true' => true, 'false' => false} )
+			@dir.convert_to_object( OIDS::BOOLEAN_SYNTAX, 'true' ).should == true
+		end
+
+		it "allows an attribute conversion to be cleared by adding a nil mapping" do
+			@dir.add_attribute_conversion( OIDS::BOOLEAN_SYNTAX, {'true' => true, 'false' => false} )
+			@dir.add_attribute_conversion( OIDS::BOOLEAN_SYNTAX )
+			@dir.convert_to_object( OIDS::BOOLEAN_SYNTAX, 'true' ).should == 'true'
+		end
+
+		it "allows an object conversion to be overridden by a block for a valid syntax OID" do
+			@dir.add_object_conversion( OIDS::BIT_STRING_SYNTAX ) do |unconverted_value, directory|
+				unconverted_value.to_s
+			end
+			@dir.convert_to_attribute( OIDS::BIT_STRING_SYNTAX, :a_value ).should == 'a_value'
 		end
 
-		it "allows a mapping to be overridden by a Hash for a valid syntax OID" do
-			@dir.add_syntax_mapping( OIDS::BOOLEAN_SYNTAX, {'true' => true, 'false' => false} )
-			@dir.convert_syntax_value( OIDS::BOOLEAN_SYNTAX, 'true' ).should == true
+		it "allows an object conversion to be overridden by a Hash for a valid syntax OID" do
+			@dir.add_object_conversion( OIDS::BOOLEAN_SYNTAX, {false => 'FALSE', true => 'TRUE'} )
+			@dir.convert_to_attribute( OIDS::BOOLEAN_SYNTAX, false ).should == 'FALSE'
 		end
 
-		it "allows a mapping to be cleared by adding a nil mapping" do
-			@dir.add_syntax_mapping( OIDS::BOOLEAN_SYNTAX, {'true' => true, 'false' => false} )
-			@dir.add_syntax_mapping( OIDS::BOOLEAN_SYNTAX )
-			@dir.convert_syntax_value( OIDS::BOOLEAN_SYNTAX, 'true' ).should == 'true'
+		it "allows an object conversion to be cleared by adding a nil mapping" do
+			@dir.add_object_conversion( OIDS::BOOLEAN_SYNTAX, {'true' => true, 'false' => false} )
+			@dir.add_object_conversion( OIDS::BOOLEAN_SYNTAX )
+			@dir.convert_to_attribute( OIDS::BOOLEAN_SYNTAX, true ).should == 'true'
 		end
 
 
@@ -591,6 +626,7 @@ describe Treequel::Directory do
 			end
 
 			it "raises an exception if a registered control doesn't define an OID" do
+				@control.const_set( :OID, nil )
 				expect {
 					@dir.register_controls( @control )
 				}.to raise_error( NotImplementedError, /doesn't define/i )

data/spec/treequel/filter_spec.rb

@@ -6,12 +6,10 @@ BEGIN {
 
 	libdir = basedir + "lib"
 
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'rubygems'
-gem 'rspec', '>= 1.2.6'
-
 require 'spec'
 require 'spec/lib/constants'
 require 'spec/lib/helpers'
@@ -221,13 +219,27 @@ describe Treequel::Filter do
 			result.should == @filter1
 		end
 
+		it "creates a new OR filter out of two filters that are bitwise-ORed together" do
+			result = @filter1 | @filter2
+			result.should be_a( Treequel::Filter )
+		end
+
+		it "collapses two OR filters into a single OR clause when bitwise-ORed together" do
+			orfilter = @filter1 | @filter2
+			thirdfilter = Treequel::Filter.new( :l => :saturn )
+			result = ( orfilter | thirdfilter )
+
+			result.should be_a( Treequel::Filter )
+			result.to_s.should == '(|(uid=buckrogers)(l=mars)(l=saturn))'
+		end
+
 	end
 
 	describe "components:" do
 
 		before( :each ) do
-			@filter1 = stub( "filter1", :to_s => '(filter1)' )
-			@filter2 = stub( "filter2", :to_s => '(filter2)' )
+			@filter1 = Treequel::Filter.new( '(filter1)' )
+			@filter2 = Treequel::Filter.new( '(filter2)' )
 		end
 
 
@@ -236,6 +248,12 @@ describe Treequel::Filter do
 				Treequel::Filter::FilterList.new( @filter1, @filter2 ).to_s.
 					should == '(filter1)(filter2)'
 			end
+
+			it "supports appending via the << operator" do
+				list = Treequel::Filter::FilterList.new( @filter1 )
+				( list << @filter2 ).should == list
+				list.to_s.should == '(filter1)(filter2)'
+			end
 		end
 
 		describe Treequel::Filter::Component do
@@ -365,6 +383,11 @@ describe Treequel::Filter do
 					should == '|(filter1)'
 			end
 
+			it "allows futher alternations to be added to it" do
+				filter = Treequel::Filter::OrComponent.new( @filter1 )
+				filter.add_alternation( @filter2 )
+				filter.to_s.should == '|(filter1)(filter2)'
+			end
 		end
 
 		describe Treequel::Filter::NotComponent do

data/spec/treequel/mixins_spec.rb

@@ -7,24 +7,17 @@ BEGIN {
 	libdir = basedir + "lib"
 	extdir = basedir + "ext"
 
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 	$LOAD_PATH.unshift( extdir ) unless $LOAD_PATH.include?( extdir )
 }
 
-begin
-	require 'spec'
-	require 'spec/lib/constants'
-	require 'spec/lib/helpers'
-
-	require 'treequel'
-	require 'treequel/mixins'
-rescue LoadError
-	unless Object.const_defined?( :Gem )
-		require 'rubygems'
-		retry
-	end
-	raise
-end
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'treequel'
+require 'treequel/mixins'
 
 
 include Treequel::TestConstants

data/spec/treequel/model/objectclass_spec.rb

@@ -0,0 +1,330 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+require 'spec/lib/matchers'
+
+require 'treequel/model'
+require 'treequel/model/objectclass'
+require 'treequel/branchset'
+
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Treequel::Model::ObjectClass do
+	include Treequel::SpecHelpers,
+	        Treequel::Matchers
+
+	class << self
+		alias_method :they, :it
+	end
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	it "outputs a warning when it is included instead of used to extend a Module" do
+		Treequel::Model::ObjectClass.should_receive( :warn ).
+			with( /extending.*rather than appending/i )
+		mixin = Module.new do
+			include Treequel::Model::ObjectClass
+		end
+	end
+
+
+	describe "modules" do
+
+		after( :each ) do
+			Treequel::Model.objectclass_registry.clear
+			Treequel::Model.base_registry.clear
+		end
+
+		they "can declare a required objectClass" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :inetOrgPerson
+			end
+
+			mixin.model_objectclasses.should == [:inetOrgPerson]
+		end
+
+		they "can declare multiple required objectClasses" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :inetOrgPerson, :acmeAccount
+			end
+
+			mixin.model_objectclasses.should == [ :inetOrgPerson, :acmeAccount ]
+		end
+
+		they "can declare a single base" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :device
+				model_bases TEST_PHONES_DN
+			end
+
+			mixin.model_bases.should == [TEST_PHONES_DN]
+		end
+
+		they "can declare base with spaces" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :device
+				model_bases 'ou=phones, dc=acme, dc=com'
+			end
+
+			mixin.model_bases.should == ['ou=phones,dc=acme,dc=com']
+		end
+
+		they "can declare multiple bases" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :ipHost
+				model_bases TEST_HOSTS_DN,
+				            TEST_SUBHOSTS_DN
+			end
+
+			mixin.model_bases.should include( TEST_HOSTS_DN, TEST_SUBHOSTS_DN )
+		end
+
+		they "raises an exception when creating a search for a mixin that hasn't declared " +
+		     "at least one objectClass or base"  do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+			end
+
+			expect {
+				mixin.search( @directory )
+			}.to raise_exception( Treequel::ModelError, /has no search criteria defined/ )
+		end
+
+		they "default to using Treequel::Model as their model class" do
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+			end
+
+			mixin.model_class.should == Treequel::Model
+		end
+
+		they "can declare a model class other than Treequel::Model" do
+			class MyModel < Treequel::Model; end
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_class MyModel
+			end
+
+			mixin.model_class.should == MyModel
+		end
+
+		they "re-register objectClasses that have already been declared when declaring a " +
+		     "new model class" do
+			class MyModel < Treequel::Model; end
+
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :inetOrgPerson
+				model_class MyModel
+			end
+
+			Treequel::Model.objectclass_registry[:inetOrgPerson].should_not include( mixin )
+			MyModel.objectclass_registry[:inetOrgPerson].should include( mixin )
+		end
+
+		they "re-register bases that have already been declared when declaring a " +
+		     "new model class" do
+			class MyModel < Treequel::Model; end
+
+			mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_bases 'ou=people,dc=acme,dc=com', 'ou=notpeople,dc=acme,dc=com'
+				model_class MyModel
+			end
+
+			Treequel::Model.base_registry['ou=people,dc=acme,dc=com'].should_not include( mixin )
+			MyModel.base_registry['ou=people,dc=acme,dc=com'].should include( mixin )
+		end
+
+	end
+
+	describe "module that has one required objectClass declared" do
+
+		before( :each ) do
+			@mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :inetOrgPerson
+			end
+		end
+
+		after( :each ) do
+			Treequel::Model.objectclass_registry.clear
+		end
+
+
+		it "is returned as one of the mixins for entries with only that objectClass" do
+			Treequel::Model.mixins_for_objectclasses( :inetOrgPerson ).
+				should include( @mixin )
+		end
+
+		it "is not returned in the list of mixins to apply to an entry without that objectClass" do
+			Treequel::Model.mixins_for_objectclasses( :device ).
+				should_not include( @mixin )
+		end
+
+		it "can set up a search for applicable entries given a Treequel::Directory to " +
+		   "search"  do
+			directory = mock( "Treequel directory", :registered_controls => [] )
+			directory.should_receive( :base_dn ).and_return( TEST_BASE_DN )
+
+			result = @mixin.search( directory )
+
+			result.should be_a( Treequel::Branchset )
+			result.base_dn.should == TEST_BASE_DN
+			result.filter.to_s.should == '(objectClass=inetOrgPerson)'
+		end
+
+	end
+
+	describe "module that has more than one required objectClass declared" do
+
+		before( :each ) do
+			@mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_objectclasses :device, :ipHost
+			end
+		end
+
+		after( :each ) do
+			Treequel::Model.objectclass_registry.clear
+		end
+
+
+		it "is returned as one of the mixins to apply to entries with all of its required " +
+		     "objectClasses" do
+			Treequel::Model.mixins_for_objectclasses( :device, :ipHost ).
+				should include( @mixin )
+		end
+
+		it "is not returned in the list of mixins to apply to an entry with only one of its " +
+		     "objectClasses" do
+			Treequel::Model.mixins_for_objectclasses( :device ).
+				should_not include( @mixin )
+		end
+
+		it "can set up a search for applicable entries given a Treequel::Directory to " +
+		   "search"  do
+			directory = mock( "Treequel directory", :registered_controls => [] )
+			directory.should_receive( :base_dn ).and_return( TEST_BASE_DN )
+
+			result = @mixin.search( directory )
+
+			result.should be_a( Treequel::Branchset )
+			result.base_dn.should == TEST_BASE_DN
+			result.filter.to_s.should == '(&(objectClass=device)(objectClass=ipHost))'
+		end
+
+	end
+
+	describe "module that has one base declared" do
+		before( :each ) do
+			@mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_bases TEST_PEOPLE_DN
+			end
+		end
+
+		after( :each ) do
+			Treequel::Model.base_registry.clear
+		end
+
+
+		it "is returned as one of the mixins to apply to an entry that is a child of its base" do
+			Treequel::Model.mixins_for_dn( TEST_PERSON_DN ).
+				should include( @mixin )
+		end
+
+		it "is not returned as one of the mixins to apply to an entry that is not a child of " +
+		   "its base" do
+			Treequel::Model.mixins_for_dn( TEST_ROOM_DN ).
+				should_not include( @mixin )
+		end
+
+		it "can set up a search for applicable entries given a Treequel::Directory to " +
+		   "search"  do
+			directory = stub( "Treequel directory", :registered_controls => [] )
+
+			result = @mixin.search( directory )
+
+			result.should be_a( Treequel::Branchset )
+			result.base_dn.should == TEST_PEOPLE_DN
+			result.filter.to_s.should == '(objectClass=*)'
+		end
+
+	end
+
+	describe "module that has more than one base declared" do
+		before( :each ) do
+			@mixin = Module.new do
+				extend Treequel::Model::ObjectClass
+				model_bases TEST_HOSTS_DN,
+				            TEST_SUBHOSTS_DN
+			end
+		end
+
+		after( :each ) do
+			Treequel::Model.base_registry.clear
+		end
+
+
+		it "is returned as one of the mixins to apply to an entry that is a child of one of " +
+		   "its bases" do
+			Treequel::Model.mixins_for_dn( TEST_SUBHOST_DN ).
+				should include( @mixin )
+		end
+
+		it "is not returned as one of the mixins to apply to an entry that is not a child of " +
+		   "its base" do
+			Treequel::Model.mixins_for_dn( TEST_PERSON_DN ).
+				should_not include( @mixin )
+		end
+
+		it "can set up a search for applicable entries given a Treequel::Directory to " +
+		   "search"  do
+			directory = stub( "Treequel directory", :registered_controls => [] )
+
+			result = @mixin.search( directory )
+
+			result.should be_a( Treequel::BranchCollection )
+			result.base_dns.should have( 2 ).members
+			result.base_dns.should include( TEST_HOSTS_DN, TEST_SUBHOSTS_DN )
+			result.branchsets.all? {|brset| brset.filter_string == '(objectClass=*)' }.
+				should be_true()
+		end
+
+	end
+
+end
+
+
+# vim: set nosta noet ts=4 sw=4: