treequel 1.1.1 → 1.2.0pre320

data/spec/lib/constants.rb

@@ -15,6 +15,7 @@ module Treequel::TestConstants # :nodoc:all
 		TEST_HOST             = 'ldap.example.com'
 		TEST_PORT             = LDAP::LDAP_PORT
 		TEST_BASE_DN          = 'dc=acme,dc=com'
+		TEST_LDAPURI          = "ldap://#{TEST_HOST}:#{TEST_PORT}/#{TEST_BASE_DN}"
 
 		TEST_BIND_DN          = "cn=admin,#{TEST_BASE_DN}"
 		TEST_BIND_PASS        = 'passomaquoddy'

data/spec/lib/control_behavior.rb

@@ -10,7 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'spec'
+require 'rspec'
+
 require 'spec/lib/constants'
 require 'spec/lib/helpers'
 
@@ -23,13 +24,14 @@ include Treequel::Constants
 #####################################################################
 ###	C O N T E X T S
 #####################################################################
-describe "A Treequel::Control", :shared => true do
+shared_examples_for "A Treequel::Control" do
 	include Treequel::SpecHelpers
 
-	before( :each ) do
-		raise "Spec doesn't set @control before the Control shared behavior" unless @control
+	let( :control ) do
+		described_class
 	end
 
+
 	it "implements one of either #get_client_controls or #get_server_controls" do
 		methods = [
 			'get_client_controls',		# 1.8.x
@@ -37,7 +39,7 @@ describe "A Treequel::Control", :shared => true do
 			:get_client_controls,		# 1.9.x
 			:get_server_controls
 		]
-		(@control.instance_methods( false ) | methods).should_not be_empty()
+		(control.instance_methods( false ) | methods).should_not be_empty()
 	end
 
 end

data/spec/lib/helpers.rb

@@ -10,29 +10,22 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
 }
 
-begin
-	require 'yaml'
-	require 'treequel'
-
-	require 'spec/lib/constants'
-rescue LoadError
-	unless Object.const_defined?( :Gem )
-		require 'rubygems'
-		retry
-	end
-	raise
-end
+require 'rspec'
+
+require 'yaml'
+require 'treequel'
+
+require 'spec/lib/constants'
+require 'spec/lib/matchers'
 
 
 ### RSpec helper functions.
 module Treequel::SpecHelpers
 	include Treequel::TestConstants
 
-	### Make an easily-comparable version vector out of +ver+ and return it.
-	def vvec( ver )
-		return ver.split('.').collect {|char| char.to_i }.pack('N*')
-	end
-
+	SCHEMA_DUMPFILE = Pathname( __FILE__ ).dirname.parent + 'data' + 'schema.yml'
+	SCHEMAHASH      = LDAP::Schema.new( YAML.load_file(SCHEMA_DUMPFILE) )
+	SCHEMA          = Treequel::Schema.new( SCHEMAHASH )
 
 	class ArrayLogger
 		### Create a new ArrayLogger that will append content to +array+.
@@ -65,6 +58,12 @@ module Treequel::SpecHelpers
 	module_function
 	###############
 
+	### Make an easily-comparable version vector out of +ver+ and return it.
+	def vvec( ver )
+		return ver.split('.').collect {|char| char.to_i }.pack('N*')
+	end
+
+
 	### Reset the logging subsystem to its default state.
 	def reset_logging
 		Treequel.reset_logger
@@ -93,8 +92,32 @@ module Treequel::SpecHelpers
 		end
 	end
 
+
+	### Make a Treequel::Directory that will use the given +conn+ object as its
+	### 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 )
+		conn.stub( :root_dse ).and_return( nil )
+		directory = Treequel.directory( TEST_LDAPURI )
+		directory.stub( :schema ).and_return( SCHEMA )
+
+		return directory
+	end
+
 end
 
 
+### Mock with Rspec
+Rspec.configure do |c|
+	c.mock_with :rspec
+	c.include( Treequel::TestConstants )
+	c.include( Treequel::SpecHelpers )
+	c.include( Treequel::Matchers )
+
+	c.filter_run_excluding( :ruby_1_8_only => true ) if
+		Treequel::SpecHelpers.vvec( RUBY_VERSION ) >= Treequel::SpecHelpers.vvec('1.9.1')
+end
+
 # vim: set nosta noet ts=4 sw=4:
 

data/spec/lib/matchers.rb

@@ -10,6 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
 }
 
+require 'rspec'
+
 require 'yaml'
 require 'treequel'
 

data/spec/treequel/branch_spec.rb

@@ -10,7 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'spec'
+require 'rspec'
+
 require 'spec/lib/constants'
 require 'spec/lib/helpers'
 require 'spec/lib/matchers'
@@ -70,6 +71,28 @@ describe Treequel::Branch do
 		branch.entry.should == entry
 	end
 
+	it "can be constructed from an entry with Symbol keys"  do
+		entry = {
+			:dn                 => [TEST_PERSON_DN],
+			TEST_PERSON_DN_ATTR => TEST_PERSON_DN_VALUE,
+		}
+		branch = Treequel::Branch.new_from_entry( entry, @directory )
+
+		branch.rdn_attributes.should == { TEST_PERSON_DN_ATTR => [TEST_PERSON_DN_VALUE] }
+		branch.entry.should == {
+			'dn'                => [TEST_PERSON_DN],
+			TEST_PERSON_DN_ATTR => TEST_PERSON_DN_VALUE,
+		}
+	end
+
+	it "can be instantiated with a Hash with Symbol keys"  do
+		branch = Treequel::Branch.new( @directory, TEST_PERSON_DN,
+			TEST_PERSON_DN_ATTR.to_sym => TEST_PERSON_DN_VALUE )
+		branch.entry.should == {
+			TEST_PERSON_DN_ATTR => TEST_PERSON_DN_VALUE,
+		}
+	end
+
 	it "raises an exception if constructed with something other than a Hash entry" do
 		expect {
 			Treequel::Branch.new( @directory, TEST_PEOPLE_DN, 18 )
@@ -91,10 +114,10 @@ describe Treequel::Branch do
 
 			@schema = mock( "treequel schema" )
 			@entry = mock( "entry object" )
-			@directory.stub!( :schema ).and_return( @schema )
-			@directory.stub!( :get_entry ).and_return( @entry )
-			@directory.stub!( :base_dn ).and_return( TEST_BASE_DN )
-			@schema.stub!( :attribute_types ).
+			@directory.stub( :schema ).and_return( @schema )
+			@directory.stub( :get_entry ).and_return( @entry )
+			@directory.stub( :base_dn ).and_return( TEST_BASE_DN )
+			@schema.stub( :attribute_types ).
 				and_return({ :cn => :a_value, :ou => :a_value })
 
 			@syntax = stub( "attribute ldapSyntax object", :oid => OIDS::STRING_SYNTAX )
@@ -375,8 +398,8 @@ describe Treequel::Branch do
 		end
 
 		it "can return the set of all its MUST attributeTypes based on which objectClasses it has" do
-			oc1 = mock( "first objectclass" )
-			oc2 = mock( "second objectclass" )
+			oc1 = mock( "first objectclass", :name => 'first_oc' )
+			oc2 = mock( "second objectclass", :name => 'second_oc' )
 
 			@branch.should_receive( :object_classes ).and_return([ oc1, oc2 ])
 			oc1.should_receive( :must ).at_least( :once ).and_return([ :cn, :uid ])
@@ -735,8 +758,8 @@ describe Treequel::Branch do
 				@entry.should_receive( :[] ).with( 'glumpy' ).at_least( :once ).
 					and_return([ 'glumpa1', 'glumpa2' ])
 
-				@attribute_type.stub!( :syntax ).and_return( @syntax )
-				@directory.stub!( :convert_to_object ).and_return {|_,str| str }
+				@attribute_type.stub( :syntax ).and_return( @syntax )
+				@directory.stub( :convert_to_object ).and_return {|_,str| str }
 
 				@branch[ :glumpy ].should == [ 'glumpa1', 'glumpa2' ]
 			end
@@ -747,8 +770,8 @@ describe Treequel::Branch do
 				@entry.should_receive( :[] ).with( 'glumpy' ).at_least( :once ).
 					and_return([ 'glumpa1' ])
 
-				@attribute_type.stub!( :syntax ).and_return( @syntax )
-				@directory.stub!( :convert_to_object ).and_return {|_,str| str }
+				@attribute_type.stub( :syntax ).and_return( @syntax )
+				@directory.stub( :convert_to_object ).and_return {|_,str| str }
 
 				@branch[ :glumpy ].should == 'glumpa1'
 			end
@@ -766,10 +789,10 @@ describe Treequel::Branch do
 			end
 
 			it "caches the value fetched from its entry" do
-				@schema.stub!( :attribute_types ).and_return({ :glump => @attribute_type })
-				@attribute_type.stub!( :single? ).and_return( true )
-				@attribute_type.stub!( :syntax ).and_return( @syntax )
-				@directory.stub!( :convert_to_object ).and_return {|_,str| str }
+				@schema.stub( :attribute_types ).and_return({ :glump => @attribute_type })
+				@attribute_type.stub( :single? ).and_return( true )
+				@attribute_type.stub( :syntax ).and_return( @syntax )
+				@directory.stub( :convert_to_object ).and_return {|_,str| str }
 				@entry.should_receive( :[] ).with( 'glump' ).once.and_return( [:a_value] )
 				2.times { @branch[ :glump ] }
 			end
@@ -779,7 +802,7 @@ describe Treequel::Branch do
 				@attribute_type.should_receive( :single? ).and_return( true )
 				@entry.should_receive( :[] ).with( 'bvector' ).at_least( :once ).
 					and_return([ '010011010101B' ])
-				@syntax.stub!( :oid ).and_return( OIDS::BIT_STRING_SYNTAX )
+				@syntax.stub( :oid ).and_return( OIDS::BIT_STRING_SYNTAX )
 				@directory.should_receive( :convert_to_object ).
 					with( OIDS::BIT_STRING_SYNTAX, '010011010101B' ).
 					and_return( 1237 )
@@ -805,14 +828,14 @@ describe Treequel::Branch do
 			end
 
 			it "clears the cache after a successful write" do
-				@schema.stub!( :attribute_types ).and_return({ :glorpy => @attribute_type })
-				@attribute_type.stub!( :single? ).and_return( true )
-				@attribute_type.stub!( :syntax ).and_return( @syntax )
-				@directory.stub!( :convert_to_object ).and_return {|_,val| val }
+				@schema.stub( :attribute_types ).and_return({ :glorpy => @attribute_type })
+				@attribute_type.stub( :single? ).and_return( true )
+				@attribute_type.stub( :syntax ).and_return( @syntax )
+				@directory.stub( :convert_to_object ).and_return {|_,val| val }
 				@entry.should_receive( :[] ).with( 'glorpy' ).and_return( [:firstval], [:secondval] )
 
 				@directory.should_receive( :modify ).with( @branch, {'glorpy' => ['chunks']} )
-				@directory.stub!( :convert_to_attribute ).and_return {|_,val| val }
+				@directory.stub( :convert_to_attribute ).and_return {|_,val| val }
 				@entry.should_receive( :[]= ).with( 'glorpy', ['chunks'] )
 
 				@branch[ :glorpy ].should == :firstval

data/spec/treequel/branchcollection_spec.rb

@@ -10,7 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'spec'
+require 'rspec'
+
 require 'spec/lib/constants'
 require 'spec/lib/helpers'
 
@@ -148,7 +149,7 @@ describe Treequel::BranchCollection do
 			@branchset1.should_receive( :each ).and_yield( :bs1_stuff )
 			@branchset2.should_receive( :each ).and_yield( :bs2_stuff )
 			added_branch = stub( "added branch", :directory => @directory )
-			added_branch.stub!( :to_ary ).and_return( [added_branch] )
+			added_branch.stub( :to_ary ).and_return( [added_branch] )
 
 			results = @collection + added_branch
 
@@ -236,7 +237,7 @@ describe Treequel::BranchCollection do
 
 		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 )
+			@branchset1.stub( :filter ).and_return( filter )
 
 			expect {
 				@collection.filter

data/spec/treequel/branchset_spec.rb

@@ -10,7 +10,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-require 'spec'
+require 'rspec'
+
 require 'spec/lib/constants'
 require 'spec/lib/helpers'
 
@@ -18,20 +19,12 @@ require 'treequel/branchset'
 require 'treequel/branchcollection'
 require 'treequel/control'
 
-include Treequel::TestConstants
-include Treequel::Constants
 
 #####################################################################
 ###	C O N T E X T S
 #####################################################################
 
 describe Treequel::Branchset do
-	include Treequel::SpecHelpers
-
-	# Make the specs read more clearly
-	class << self
-		alias_method :they, :it
-	end
 
 	DEFAULT_PARAMS = {
 		:limit           => 0,
@@ -50,19 +43,19 @@ describe Treequel::Branchset do
 	end
 
 	before( :each ) do
-		@directory = mock( "treequel directory ", :registered_controls => [] )
-		@branch = mock( "treequel branch", :dn => 'thedn' )
-		@branch.stub!( :directory ).and_return( @directory )
+		@conn = double( "LDAP connection", :set_option => true, :bound? => false )
+		@directory = get_fixtured_directory( @conn )
+		@branch = @directory.base
 		@params = DEFAULT_PARAMS.dup
 	end
 
 
-	describe "instances" do
+	context "an instance" do
 		before( :each ) do
 			@branchset = Treequel::Branchset.new( @branch )
 		end
 
-		they "are Enumerable" do
+		it "is Enumerable" do
 			resultbranch = mock( "Result Branch" )
 
 			@branch.should_receive( :search ).
@@ -76,7 +69,7 @@ describe Treequel::Branchset do
 		# 
 		# #empty?
 		# 
-		they "know that they are empty if they don't match at least one entry" do
+		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 ).
@@ -85,7 +78,7 @@ describe Treequel::Branchset do
 			@branchset.should be_empty()
 		end
 
-		they "know that they are empty if they match at least one entry" do
+		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 ).
@@ -97,7 +90,7 @@ describe Treequel::Branchset do
 		# 
 		# #map
 		# 
-		they "can be mapped into an Array of attribute values" do
+		it "can be mapped into an Array of attribute values" do
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
@@ -114,7 +107,7 @@ describe Treequel::Branchset do
 		# 
 		# #to_hash
 		# 
-		they "can be mapped into a Hash of entries keyed by one of their attributes" do
+		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" )
 
@@ -136,7 +129,7 @@ describe Treequel::Branchset do
 		end
 
 
-		they "can be mapped into a Hash of tuples using two attributes" do
+		it "can be mapped into a Hash of tuples using two attributes" do
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
@@ -162,9 +155,9 @@ describe Treequel::Branchset do
 		#
 		# #+
 		#
-		they "can be combined into a BranchCollection by adding them together" 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.stub( :directory ).and_return( @directory )
 			other_branchset = Treequel::Branchset.new( other_branch )
 
 			result = @branchset + other_branchset
@@ -173,9 +166,9 @@ describe Treequel::Branchset do
 			result.branchsets.should include( @branchset, other_branchset )
 		end
 
-		they "return the results of the search with the additional Branch if one is added to it" do
+		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] )
+			other_branch.stub( :to_ary ).and_return( [other_branch] )
 			resultbranch = mock( "Result Branch" )
 			resultbranch2 = mock( "Result Branch 2" )
 
@@ -191,7 +184,7 @@ describe Treequel::Branchset do
 		#
 		# #-
 		#
-		they "return the results of the search without the specified object if an object is " +
+		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 )
@@ -209,7 +202,7 @@ describe Treequel::Branchset do
 
 	end
 
-	describe "instance with no filter, options, or scope set" do
+	context "instance with no filter, options, or scope set" do
 
 		before( :each ) do
 			@branchset = Treequel::Branchset.new( @branch )
@@ -431,17 +424,35 @@ describe Treequel::Branchset do
 		# 
 		# #as
 		# 
-		it "can create a new branchset cloned from itself that will return instances of a different branch class" do
+		it "can create a new branchset cloned from itself that will return instances of a " +
+		   "different branch class" do
 			subclass = Class.new( Treequel::Branch )
-			@branch.stub!( :directory ).and_return( :the_directory )
-			@branch.stub!( :dn ).and_return( TEST_HOSTS_DN )
+			@branch.stub( :directory ).and_return( :the_directory )
+			@branch.stub( :dn ).and_return( TEST_HOSTS_DN )
 			newset = @branchset.as( subclass )
 			newset.branch.should be_an_instance_of( subclass )
 		end
 
+
+		#
+		# from
+		#
+		it "can create a new branchset cloned from itself with a different base DN (String)" do
+			newset = @branchset.from( TEST_SUBHOSTS_DN )
+			newset.base_dn.should == TEST_SUBHOSTS_DN
+		end
+
+		it "can create a new branchset cloned from itself with a different base DN " +
+		   "(Treequel::Branch)" do
+			branch = Treequel::Branch.new( @directory, TEST_SUBHOSTS_DN )
+			newset = @branchset.from( branch )
+			newset.base_dn.should == TEST_SUBHOSTS_DN
+		end
+
 	end
 
-	describe "instance with no filter, and scope set to 'onelevel'" do
+
+	context "instance with no filter, and scope set to 'onelevel'" do
 
 		before( :each ) do
 			@branchset = Treequel::Branchset.new( @branch, :scope => :onelevel )
@@ -462,7 +473,7 @@ describe Treequel::Branchset do
 
 	end
 
-	describe "created for a directory with registered controls" do
+	context "created for a directory with registered controls" do
 
 		before( :all ) do
 			@control = Module.new {
@@ -476,7 +487,7 @@ describe Treequel::Branchset do
 		end
 
 		before( :each ) do
-			@directory.stub!( :registered_controls ).and_return([ @control ])
+			@directory.stub( :registered_controls ).and_return([ @control ])
 		end
 
 		after( :each ) do