treequel 1.0.1 → 1.0.4

data/spec/treequel/branchcollection_spec.rb

@@ -34,7 +34,7 @@ describe Treequel::BranchCollection do
 	include Treequel::SpecHelpers
 
 	before( :all ) do
-		setup_logging( :debug )
+		setup_logging( :fatal )
 	end
 
 	after( :all ) do
@@ -105,6 +105,20 @@ describe Treequel::BranchCollection do
 			@collection = Treequel::BranchCollection.new( @branchset1, @branchset2 )
 		end
 
+		it "knows that it is empty if all of its branchsets are empty" do
+			@branchset1.should_receive( :empty? ).and_return( true )
+			@branchset2.should_receive( :empty? ).and_return( true )
+
+			@collection.should be_empty()
+		end
+
+		it "knows that it is not empty if one of its branchsets has matching entries" do
+			@branchset1.should_receive( :empty? ).and_return( true )
+			@branchset2.should_receive( :empty? ).and_return( false )
+
+			@collection.should_not be_empty()
+		end
+
 		it "fetches all of the results from each of its branchsets if asked for all results" do
 			@branchset1.should_receive( :each ).and_yield( :bs1_stuff )
 			@branchset2.should_receive( :each ).and_yield( :bs2_stuff )
@@ -186,6 +200,15 @@ describe Treequel::BranchCollection do
 			filtered_collection.should include( filtered_branchset1, filtered_branchset2 )
 		end
 
+		it "raises a reasonable exception if one of its delegates returns a non-branchset" do
+			filter = Treequel::Filter.new
+			@branchset1.stub!( :filter ).and_return( filter )
+
+			expect {
+				@collection.filter
+			}.to raise_exception( ArgumentError, /0 for 1/ )
+		end
+
 		# it "can create a clone of itself with ordered branchsets" do
 		# 	ordered_branchset1 = stub( "branchset 3", :dn => 'cn=example3,dc=acme,dc=com', :each => 1 )
 		# 	ordered_branchset2 = stub( "branchset 4", :dn => 'cn=example4,dc=acme,dc=com', :each => 1 )

data/spec/treequel/branchset_spec.rb

@@ -9,20 +9,13 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-begin
-	require 'spec'
-	require 'spec/lib/constants'
-	require 'spec/lib/helpers'
-
-	require 'treequel/branchset'
-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/branchset'
+require 'treequel/branchcollection'
+require 'treequel/control'
 
 include Treequel::TestConstants
 include Treequel::Constants
@@ -34,14 +27,17 @@ include Treequel::Constants
 describe Treequel::Branchset do
 	include Treequel::SpecHelpers
 
+	# Make the specs read more clearly
 	class << self
 		alias_method :they, :it
 	end
 
 	DEFAULT_PARAMS = {
-		:limit       => 0,
-		:selectattrs => [],
-		:timeout     => 0,
+		:limit           => 0,
+		:selectattrs     => [],
+		:timeout         => 0,
+		:client_controls => [],
+		:server_controls => [],
 	}
 
 	before( :all ) do
@@ -53,8 +49,9 @@ describe Treequel::Branchset do
 	end
 
 	before( :each ) do
-		@directory = mock( "treequel directory ")
+		@directory = mock( "treequel directory ", :registered_controls => [] )
 		@branch = mock( "treequel branch", :dn => 'thedn' )
+		@branch.stub!( :directory ).and_return( @directory )
 		@params = DEFAULT_PARAMS.dup
 	end
 
@@ -67,15 +64,35 @@ describe Treequel::Branchset do
 		they "are Enumerable" do
 			resultbranch = mock( "Result Branch" )
 
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
 				and_yield( resultbranch )
 			resultbranch.should_receive( :dn ).and_return( :its_dn )
 
 			@branchset.all? {|b| b.dn }
 		end
 
+		# 
+		# #empty?
+		# 
+		they "know that they are empty if they don'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( [] )
+
+			@branchset.should be_empty()
+		end
+
+		they "know that they are empty if they 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( [:a_branch] )
+
+			@branchset.should_not be_empty()
+		end
+
 		# 
 		# #map
 		# 
@@ -83,9 +100,8 @@ describe Treequel::Branchset do
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+			@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 ])
@@ -101,9 +117,8 @@ describe Treequel::Branchset do
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
 				and_yield( resultbranch ).and_yield( resultbranch2 )
 
 			resultbranch.should_receive( :[] ).with( :email ).
@@ -124,9 +139,8 @@ describe Treequel::Branchset do
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
 				and_yield( resultbranch ).and_yield( resultbranch2 )
 
 			resultbranch.should_receive( :[] ).with( :email ).
@@ -143,6 +157,33 @@ describe Treequel::Branchset do
 				:second_email => :second_cn,
 			}
 		end
+
+		#
+		# #+
+		#
+		they "can be combined into a BranchCollection by adding them together" do
+			other_branch = mock( "second treequel branch", :dn => 'theotherdn' )
+			other_branch.stub!( :directory ).and_return( @directory )
+			other_branchset = Treequel::Branchset.new( other_branch )
+
+			result = @branchset + other_branchset
+			result.should be_a( Treequel::BranchCollection )
+			result.branchsets.should have( 2 ).members
+			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 )
+
+			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
+		end
+
 	end
 
 	describe "instance with no filter, options, or scope set" do
@@ -170,9 +211,8 @@ describe Treequel::Branchset do
 
 
 		it "performs a search using the default filter and scope when all records are requested" do
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, @params ).
 				and_yield( :matching_branches )
 
 			@branchset.all.should == [ :matching_branches ]
@@ -180,10 +220,9 @@ describe Treequel::Branchset do
 
 		it "performs a search using the default filter, scope, and a limit of 1 when the first " +
 		   "record is requested" do
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
-				      @params.merge(:limit => 1) ).
+			params = @params.merge( :limit => 1 )
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter, params ).
 				and_return( [:first_matching_branch, :other_branches] )
 
 			@branchset.first.should == :first_matching_branch
@@ -222,9 +261,8 @@ describe Treequel::Branchset do
 
 		it "uses its scope setting as the scope to use when searching" do
 			@branchset.options[:scope] = :onelevel
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, :onelevel, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( :onelevel, @branchset.filter, @params ).
 				and_yield( :matching_branches )
 
 			@branchset.all.should == [:matching_branches]
@@ -251,9 +289,8 @@ describe Treequel::Branchset do
 
 		it "uses its selection as the list of attributes to fetch when searching" do
 			@branchset.options[:select] = [ :l, :cn, :uid ]
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
 				      @params.merge(:selectattrs => ['l', 'cn', 'uid']) ).
 				and_yield( :matching_branches )
 
@@ -277,9 +314,8 @@ describe Treequel::Branchset do
 
 		it "uses its timeout as the timeout values when searching" do
 			@branchset.options[:timeout] = 5.375
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
 				      @params.merge(:timeout => 5.375) ).
 				and_yield( :matching_branches )
 
@@ -337,9 +373,8 @@ describe Treequel::Branchset do
 
 		it "uses its limit as the limit when searching" do
 			@branchset.options[:limit] = 8
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, @branchset.filter,
 				      @params.merge(:limit => 8) ).
 				and_yield( :matching_branches )
 
@@ -371,9 +406,8 @@ describe Treequel::Branchset do
 		end
 
 		it "performs a search using the default filter and scope when all records are requested" do
-			@branch.should_receive( :directory ).and_return( @directory )
-			@directory.should_receive( :search ).
-				with( @branch, :onelevel, @branchset.filter, @params ).
+			@branch.should_receive( :search ).
+				with( :onelevel, @branchset.filter, @params ).
 				and_yield( :matching_branches )
 
 			@branchset.all.should == [:matching_branches]
@@ -381,6 +415,44 @@ describe Treequel::Branchset do
 
 	end
 
+	describe "created for a directory with registered controls" do
+
+		before( :all ) do
+			@control = Module.new {
+				include Treequel::Control
+				OID = '3.1.4.1.5.926'
+
+				def yep; end
+				def get_client_controls; [:client_control]; end
+				def get_server_controls; [:server_control]; end
+			}
+		end
+
+		before( :each ) do
+			@directory.stub!( :registered_controls ).and_return([ @control ])
+		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 )
+		end
+
+		it "appends client controls to search arguments" do
+			resultbranch = mock( "Result Branch" )
+			set = Treequel::Branchset.new( @branch )
+
+			@params[:server_controls] = [:server_control]
+			@params[:client_controls] = [:client_control]
+
+			@branch.should_receive( :search ).
+				with( Treequel::Branchset::DEFAULT_SCOPE, set.filter, @params ).
+				and_yield( resultbranch )
+
+			set.all.should == [ resultbranch ]
+		end
+
+	end
+
 end
 
 

data/spec/treequel/control_spec.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'treequel'
+require 'treequel/control'
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+module TestControl
+	OID = 'an OID'
+	include Treequel::Control
+end
+
+describe Treequel::Control do
+	include Treequel::SpecHelpers
+
+	before( :each ) do
+		@testclass = Class.new
+		@obj = @testclass.new
+		@obj.extend( TestControl )
+	end
+
+	it "provides a empty client control list by default" do
+		@obj.get_client_controls.should == []
+	end
+
+	it "provides a empty server control list by default" do
+		@obj.get_server_controls.should == []
+	end
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/controls/contentsync_spec.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+require 'spec/lib/control_behavior'
+
+require 'treequel'
+require 'treequel/controls/contentsync'
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+describe Treequel::ContentSyncControl do
+	include Treequel::SpecHelpers
+
+	before( :each ) do
+		# Used by the shared behavior
+		@control = Treequel::ContentSyncControl
+	end
+
+	it_should_behave_like "A Treequel::Control"
+
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/controls/pagedresults_spec.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+require 'spec/lib/control_behavior'
+
+require 'treequel'
+require 'treequel/controls/pagedresults'
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+describe Treequel::PagedResultsControl do
+	include Treequel::SpecHelpers
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	before( :each ) do
+		# Used by the shared behavior
+		@control = Treequel::PagedResultsControl
+		@branch = mock( "Branch", :dn => 'cn=example,dc=acme,dc=com' )
+		@directory = mock( "Directory" )
+
+		@branch.stub!( :directory ).and_return( @directory )
+		@directory.stub!( :registered_controls ).and_return([ Treequel::PagedResultsControl ])
+		@branchset = Treequel::Branchset.new( @branch )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	it_should_behave_like "A Treequel::Control"
+
+
+	it "adds a paged_results_setsize attribute to extended branchsets" do
+		@branchset.should respond_to( :paged_results_setsize )
+	end
+
+	it "adds a paged_results_cookie attribute to extended branchsets" do
+		@branchset.should respond_to( :paged_results_cookie )
+	end
+
+	it "can add paging of a specific size to a Branchset via the #with_paged_results mutator" do
+		@branchset.with_paged_results( 17 ).paged_results_setsize.should == 17
+	end
+
+	it "can create an unpaged Branchset from a paged one by passing nil to #with_paged_results" do
+		paged_branchset = @branchset.with_paged_results( 25 )
+		paged_branchset.with_paged_results( nil ).paged_results_setsize.should == nil
+	end
+
+	it "can create an unpaged Branchset from a paged one by passing 0 to #with_paged_results" do
+		paged_branchset = @branchset.with_paged_results( 25 )
+		paged_branchset.with_paged_results( 0 ).paged_results_setsize.should == nil
+	end
+
+	it "can create an unpaged Branchset from a paged one via the #without_paging mutator" do
+		paged_branchset = @branchset.with_paged_results( 25 )
+		paged_branchset.without_paging.paged_results_setsize.should == nil
+	end
+
+	it "can remove any existing paging from a Branchset via the #without_paging! imperative method" do
+		paged_branchset = @branchset.with_paged_results( 25 )
+		paged_branchset.without_paging!
+		paged_branchset.paged_results_setsize.should == nil
+	end
+
+	it "injects the correct server-control structure into the search when iterating" do
+		oid = Treequel::PagedResultsControl::OID
+		expected_asn1_string = "0\005\002\001\031\004\000"
+		expected_control = LDAP::Control.new( oid, expected_asn1_string, true )
+
+		resultbranch  = mock( "Paged result branch" )
+		resultcontrol = mock( "Paged result control" )
+
+		@branch.should_receive( :search ).with( :subtree,
+			instance_of(Treequel::Filter),
+			{
+				:limit           => 0,
+				:selectattrs     => [],
+				:timeout         => 0,
+				:server_controls => [ expected_control ],
+				:client_controls => []
+			}
+		  ).and_yield( resultbranch )
+
+		resultbranch.should_receive( :controls ).and_return([ resultcontrol ])
+		resultcontrol.should_receive( :oid ).
+			and_return( Treequel::PagedResultsControl::OID )
+		resultcontrol.should_receive( :decode ).and_return([ 25, "cookievalue" ])
+
+		@branchset.with_paged_results( 25 ).each do |*args|
+			args.should == [ resultbranch ]
+		end
+	end
+
+	it "doesn't add a paging control if no set size has been set" do
+		resultbranch = mock( "Result branch" )
+
+		@branch.should_receive( :search ).with( :subtree,
+			instance_of(Treequel::Filter),
+			{
+				:limit           => 0,
+				:selectattrs     => [],
+				:timeout         => 0,
+				:server_controls => [],
+				:client_controls => []
+			}
+		  ).and_yield( resultbranch )
+
+		resultbranch.should_receive( :controls ).and_return( [] )
+
+		@branchset.without_paging.each do |*args|
+			args.should == [ resultbranch ]
+		end
+	end
+
+
+end
+
+# vim: set nosta noet ts=4 sw=4: