treequel 1.0.1 → 1.0.4

data/rake/hg.rb

@@ -22,6 +22,8 @@ unless defined?( HG_DOTDIR )
 	### 
 
 	module MercurialHelpers
+		require './helpers.rb' unless defined?( RakefileHelpers )
+		include RakefileHelpers
 
 		###############
 		module_function
@@ -83,7 +85,7 @@ unless defined?( HG_DOTDIR )
 
 		### Return the list of files which are of status 'unknown'
 		def get_unknown_files
-			list = read_command_output( 'hg', 'status', '-un', '--no-color' )
+			list = read_command_output( 'hg', 'status', '-un', '--color', 'never' )
 			list = list.split( /\n/ )
 
 			trace "New files: %p" % [ list ]
@@ -208,8 +210,20 @@ unless defined?( HG_DOTDIR )
 		task :add => :newfiles
 
 
+		desc "Pull and update from the default repo"
+		task :pull do
+			paths = get_repo_paths()
+			if origin_url = paths['default']
+				ask_for_confirmation( "Pull and update from '#{origin_url}'?", false ) do
+					run 'hg', 'pull', '-u'
+				end
+			else
+				trace "Skipping pull: No 'default' path."
+			end
+		end
+
 		desc "Check the current code in if tests pass"
-		task :checkin => ['hg:newfiles', 'test', COMMIT_MSG_FILE] do
+		task :checkin => ['hg:pull', 'hg:newfiles', 'test', COMMIT_MSG_FILE] do
 			targets = get_target_args()
 			$stderr.puts '---', File.read( COMMIT_MSG_FILE ), '---'
 			ask_for_confirmation( "Continue with checkin?" ) do

data/rake/manual.rb

@@ -147,9 +147,14 @@ module Manual
 
 			layout = self.config['layout'].sub( /\.page$/, '' )
 			templatepath = @layouts_dir + "#{layout}.page"
-			template = ERB.new( templatepath.read )
-			page = self
+			template = nil
+			if Object.const_defined?( :Encoding )
+				template = ERB.new( templatepath.read(:encoding => 'UTF-8') )
+			else
+				template = ERB.new( templatepath.read )
+			end
 
+			page = self
 			html = template.result( binding() )
 
 			# Use Tidy to clean up the html if 'cleanup' is turned on, but remove the Tidy
@@ -565,7 +570,7 @@ module Manual
 				manual_pages = setup_page_conversion_tasks( sourcedir, outputdir, catalog )
 
 				desc "Build the manual"
-				task :build => [ :rdoc, :copy_resources, :copy_apidocs, :generate_pages ]
+				task :build => [ :apidocs, :copy_resources, :copy_apidocs, :generate_pages ]
 
 				task :clobber do
 					RakeFileUtils.verbose( $verbose ) do
@@ -686,8 +691,8 @@ module Manual
 			end
 
 			desc "Copy API documentation to the manual output directory"
-			task :copy_apidocs => :rdoc do
-				cp_r( RDOCDIR, outputdir )
+			task :copy_apidocs => :apidocs do
+				cp_r( API_DOCSDIR, outputdir )
 			end
 
 			# Now group all the resource file tasks into a containing task
@@ -713,7 +718,7 @@ if MANUALDIR.exist?
 
 		Manual::GenTask.new do |manual|
 			manual.metadata.version = PKG_VERSION
-			manual.metadata.api_dir = RDOCDIR
+			manual.metadata.api_dir = API_DOCSDIR
 			manual.output_dir = MANUALOUTPUTDIR
 			manual.base_dir = MANUALDIR
 			manual.source_dir = 'src'

data/rake/packaging.rb

@@ -1,17 +1,27 @@
-# 
-# Packaging Rake Tasks
-
-# 
+#####################################################################
+###	P A C K A G I N G   T A S K S
+#####################################################################
 
 require 'rbconfig'
 require 'pathname'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 
-require Pathname( __FILE__ ).dirname.expand_path + 'hg.rb'
 
 include Config
 
+### Task: prerelease
+desc "Append the package build number to package versions"
+task :prerelease do
+	GEMSPEC.version.version << ".#{PKG_BUILD}"
+	Rake::Task[:gem].clear
+
+	Gem::PackageTask.new( GEMSPEC ) do |pkg|
+		pkg.need_zip = true
+		pkg.need_tar = true
+	end
+end
+
+
 ### Task: gem
 ### Task: package
 Rake::PackageTask.new( PKG_NAME, PKG_VERSION ) do |task|
@@ -24,34 +34,9 @@ end
 task :package => [:gem]
 
 
-### Task: gem
-gempath = PKGDIR + GEM_FILE_NAME
-
-desc "Build a RubyGem package (#{GEM_FILE_NAME})"
-task :gem => gempath.to_s
-file gempath.to_s => [PKGDIR.to_s] + GEMSPEC.files do
-	when_writing( "Creating GEM" ) do
-		Gem::Builder.new( GEMSPEC ).build
-		verbose( true ) do
-			mv GEM_FILE_NAME, gempath
-		end
-	end
-end
-
-
-prerelease_gempath = PKGDIR + SNAPSHOT_GEM_NAME
-
-desc "Build a pre-release RubyGem package"
-task :prerelease_gem => prerelease_gempath.to_s
-file prerelease_gempath.to_s => [PKGDIR.to_s] + GEMSPEC.files do
-	when_writing( "Creating prerelease GEM" ) do
-		gemspec = GEMSPEC.clone
-		gemspec.version = Gem::Version.create( "%s.%s" % [GEMSPEC.version, PKG_BUILD] )
-		Gem::Builder.new( gemspec ).build
-		verbose( true ) do
-			mv SNAPSHOT_GEM_NAME, prerelease_gempath
-		end
-	end
+Gem::PackageTask.new( GEMSPEC ) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar = true
 end
 
 

data/rake/publishing.rb

@@ -34,7 +34,13 @@ class Net::SMTP
 
 	def do_ssl_start( helodomain, user, secret, authtype )
 		raise IOError, 'SMTP session already started' if @started
-		check_auth_args user, secret if user or secret
+		if user or secret
+			if self.method( :check_auth_args ).arity == 3
+				check_auth_args( user, secret, authtype )
+			else
+				check_auth_args( user, secret )
+			end
+		end
 
 		# Open the connection
       	@debug_output << "opening connection to #{@address}...\n" if @debug_output
@@ -85,7 +91,6 @@ begin
 	require 'tmail'
 	require 'net/smtp'
 	require 'etc'
-	require 'rubyforge'
 	require 'socket'
 	require 'text/format'
 
@@ -134,11 +139,11 @@ begin
 		task :project => :upload # the old name
 
 		desc "Publish the project docs to #{PROJECT_HOST}"
-		task :upload_docs => [ :rdoc ] do
+		task :upload_docs => [ :apidocs ] do
 			when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
 				log "Uploading API documentation to %s:%s" % [ PROJECT_HOST, PROJECT_DOCDIR ]
 				run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_DOCDIR}"
-				run 'scp', '-qCr', RDOCDIR, PROJECT_SCPDOCURL
+				run 'scp', '-qCr', API_DOCSDIR, PROJECT_SCPDOCURL
 			end
 		end
 
@@ -195,15 +200,20 @@ begin
 		desc 'Send out a release announcement'
 		task :announce => [RELEASE_ANNOUNCE_FILE] do
 			email         = TMail::Mail.new
-			if $publish_privately
+
+			if $publish_privately || RELEASE_ANNOUNCE_ADDRESSES.empty?
 				trace "Sending private announce mail"
 				email.to = 'rubymage@gmail.com'
 			else
 				trace "Sending public announce mail"
-				email.to  = 'Ruby-Talk List <ruby-talk@ruby-lang.org>'
+				email.to  = RELEASE_ANNOUNCE_ADDRESSES
 				email.bcc = 'rubymage@gmail.com'
 			end
-			email.from    = GEMSPEC.email
+
+			from = prompt_with_default( "Send announcement as:",
+				'Michael Granger <ged@FaerieMUD.org>' ) or fail
+
+			email.from    = from
 			email.subject = "[ANN] #{PKG_NAME} #{PKG_VERSION}"
 			email.body    = File.read( RELEASE_ANNOUNCE_FILE )
 			email.date    = Time.new
@@ -236,61 +246,11 @@ begin
 		end
 
 
-		desc 'Publish the new release to RubyForge'
-		task :publish => [:clean, :package, :notes] do |task|
-			project = RUBYFORGE_PROJECT
-
-			if $publish_privately
-				log "Skipping push of release files to RubyForge"
-			else
-				rf = RubyForge.new
-				log "Loading RubyForge config"
-				rf.configure
-
-				group_id = rf.autoconfig['group_ids'][RUBYFORGE_GROUP] or
-					fail "Your configuration doesn't have a group id for '#{RUBYFORGE_GROUP}'"
-
-				# If this project doesn't yet exist, create it
-				unless rf.autoconfig['package_ids'].key?( project )
-					ask_for_confirmation( "Package '#{project}' doesn't exist on RubyForge. Create it?" ) do
-						log "Creating new package '#{project}'"
-						rf.create_package( group_id, project )
-					end
-				end
-
-				package_id = rf.autoconfig['package_ids'][ project ]
-
-				# Make sure this release doesn't already exist
-				releases = rf.autoconfig['release_ids']
-				if releases.key?( GEMSPEC.name ) && releases[ GEMSPEC.name ].key?( PKG_VERSION )
-					log "Rubyforge seems to already have #{ PKG_FILE_NAME }"
-				else
-					config = rf.userconfig or
-						fail "You apparently haven't set up your RubyForge credentials on this machine."
-					config['release_notes'] = GEMSPEC.description
-					config['release_changes'] = File.read( RELEASE_NOTES_FILE )
-
-					files = FileList[ PKGDIR + GEM_FILE_NAME ]
-					files.include PKGDIR + "#{PKG_FILE_NAME}.tar.gz"
-					files.include PKGDIR + "#{PKG_FILE_NAME}.tar.bz2"
-					files.include PKGDIR + "#{PKG_FILE_NAME}.zip"
-
-					log "Releasing #{PKG_FILE_NAME}"
-					when_writing do
-						log "Publishing to RubyForge: \n",
-							"\tproject: #{RUBYFORGE_GROUP}\n",
-							"\tpackage: #{PKG_NAME.downcase}\n",
-							"\tpackage version: #{PKG_VERSION}\n",
-							"\tfiles: " + files.collect {|f| f.to_s }.join(', ') + "\n"
-
-						ask_for_confirmation( "Publish to RubyForge?" ) do
-							log 'Logging in...'
-							rf.login
-							log "Adding the new release to the '#{project}' project"
-							rf.add_release( group_id, package_id, PKG_VERSION, *files )
-						end
-					end
-				end
+		desc 'Publish the new release to Gemcutter'
+		task :publish => [:clean, :gem, :notes] do |task|
+			ask_for_confirmation( "Publish #{GEM_FILE_NAME} to Gemcutter?", false ) do
+				gempath = PKGDIR + GEM_FILE_NAME
+				sh 'gem', 'push', gempath
 			end
 		end
 	end

data/spec/lib/constants.rb

@@ -68,6 +68,11 @@ module Treequel::TestConstants # :nodoc:all
 		TEST_SUBHOSTS_RDN       = "#{TEST_HOSTS_DN_ATTR}=#{TEST_HOSTS_DN_VALUE}"
 		TEST_SUBHOSTS_DN        = "#{TEST_HOSTS_RDN},#{TEST_SUBDOMAIN_DN}"
 
+		TEST_SUBHOST_DN_ATTR    = 'cn'
+		TEST_SUBHOST_DN_VALUE   = 'ronky'
+		TEST_SUBHOST_RDN        = "#{TEST_SUBHOST_DN_ATTR}=#{TEST_SUBHOST_DN_VALUE}"
+		TEST_SUBHOST_DN         = "#{TEST_SUBHOST_RDN},#{TEST_SUBHOSTS_DN}"
+
 		TEST_PEOPLE_DN_ATTR     = 'ou'
 		TEST_PEOPLE_DN_VALUE    = 'People'
 		TEST_PEOPLE_RDN         = "#{TEST_PEOPLE_DN_ATTR}=#{TEST_PEOPLE_DN_VALUE}"
@@ -83,6 +88,21 @@ module Treequel::TestConstants # :nodoc:all
 		TEST_PERSON2_RDN        = "#{TEST_PERSON2_DN_ATTR}=#{TEST_PERSON2_DN_VALUE}"
 		TEST_PERSON2_DN         = "#{TEST_PERSON2_RDN},#{TEST_PEOPLE_DN}"
 
+		TEST_PHONES_DN_ATTR     = 'ou'
+		TEST_PHONES_DN_VALUE    = 'Phones'
+		TEST_PHONES_RDN         = "#{TEST_PHONES_DN_ATTR}=#{TEST_PHONES_DN_VALUE}"
+		TEST_PHONES_DN          = "#{TEST_PHONES_RDN},#{TEST_BASE_DN}"
+
+		TEST_ROOMS_DN_ATTR      = 'ou'
+		TEST_ROOMS_DN_VALUE     = 'Rooms'
+		TEST_ROOMS_RDN          = "#{TEST_ROOMS_DN_ATTR}=#{TEST_ROOMS_DN_VALUE}"
+		TEST_ROOMS_DN           = "#{TEST_ROOMS_RDN},#{TEST_BASE_DN}"
+
+		TEST_ROOM_DN_ATTR       = 'cn'
+		TEST_ROOM_DN_VALUE      = 'broomcloset'
+		TEST_ROOM_RDN           = "#{TEST_ROOM_DN_ATTR}=#{TEST_ROOM_DN_VALUE}"
+		TEST_ROOM_DN            = "#{TEST_ROOM_RDN},#{TEST_ROOMS_DN}"
+
 		constants.each do |cname|
 			const_get(cname).freeze
 		end

data/spec/lib/control_behavior.rb

@@ -0,0 +1,44 @@
+#!/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
+#####################################################################
+describe "A Treequel::Control", :shared => true do
+	include Treequel::SpecHelpers
+
+	before( :each ) do
+		raise "Spec doesn't set @control before the Control shared behavior" unless @control
+	end
+
+	it "implements one of either #get_client_controls or #get_server_controls" do
+		methods = [
+			'get_client_controls',		# 1.8.x
+			'get_server_controls',
+			:get_client_controls,		# 1.9.x
+			:get_server_controls
+		]
+		(@control.instance_methods( false ) | methods).should_not be_empty()
+	end
+
+end
+
+

data/spec/lib/matchers.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+require 'yaml'
+require 'treequel'
+
+require 'spec/lib/constants'
+
+### RSpec matchers
+module Treequel::Matchers
+
+	class ArrayIncludingMatcher
+		def initialize( expected )
+			@expected = expected
+		end
+
+		def ==( actual )
+			@expected.each do |value|
+				return false unless actual.include?( value )
+			end
+			true
+		rescue NoMethodError => ex
+			return false
+		end
+
+		def description
+			"array_including(#{ @expected.inspect.sub(/^\[|\]$/,"") })"
+		end
+	end
+
+
+	###############
+	module_function
+	###############
+
+	### Return true if the actual value includes the specified +objects+.
+	def array_including( *objects )
+		ArrayIncludingMatcher.new( objects )
+	end
+
+end # module Treequel::Matchers
+

data/spec/treequel/branch_spec.rb

@@ -9,22 +9,14 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-begin
-	require 'spec'
-	require 'spec/lib/constants'
-	require 'spec/lib/helpers'
-
-	require 'treequel/branch'
-	require 'treequel/branchset'
-	require 'treequel/branchcollection'
-rescue LoadError
-	unless Object.const_defined?( :Gem )
-		require 'rubygems'
-		retry
-	end
-	raise
-end
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+require 'spec/lib/matchers'
 
+require 'treequel/branch'
+require 'treequel/branchset'
+require 'treequel/branchcollection'
 
 include Treequel::TestConstants
 include Treequel::Constants
@@ -34,7 +26,8 @@ include Treequel::Constants
 #####################################################################
 
 describe Treequel::Branch do
-	include Treequel::SpecHelpers
+	include Treequel::SpecHelpers,
+	        Treequel::Matchers
 
 	before( :all ) do
 		setup_logging( :fatal )
@@ -150,6 +143,22 @@ describe Treequel::Branch do
 			@branch.entry.should == :the_extended_entry
 		end
 
+		it "can search its directory for values using itself as a base" do
+			@directory.should_receive( :search ).with( @branch, :one, '(objectClass=*)', {} ).
+				and_return( :entries )
+			@branch.search( :one, '(objectClass=*)' ).should == :entries
+		end
+
+		it "can search its directory for values with a block" do
+			@directory.should_receive( :search ).with( @branch, :one, '(objectClass=*)', {} ).
+				and_yield( :an_entry )
+			yielded_val = nil
+			@branch.search( :one, '(objectClass=*)' ) do |val|
+				yielded_val = val
+			end
+			yielded_val.should == :an_entry
+		end
+
 		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 )
@@ -201,13 +210,20 @@ describe Treequel::Branch do
 
 			lambda {
 				@branch.facelart( 'sbc' )
-			}.should raise_error( NoMethodError )
+			}.should raise_exception( NoMethodError, /undefined method.*facelart/i )
 		end
 
+		it "don't create sub-branches for multi-value RDNs with an invalid attribute" do
+			@schema.should_receive( :attribute_types ).
+				and_return({ :cn => :a_value, :ou => :a_value })
+
+			lambda {
+				@branch.cn( 'benchlicker', :facelart => 'sbc' )
+			}.should raise_exception( NoMethodError, /invalid secondary attribute.*facelart/i )
+		end
 
 		it "can return all of its immediate children as Branches" do
-			@directory.should_receive( :search ).
-				with( @branch, :one, '(objectClass=*)' ).
+			@directory.should_receive( :search ).with( @branch, :one, '(objectClass=*)', {} ).
 				and_return([ :the_children ])
 			@branch.children.should == [ :the_children ]
 		end
@@ -350,13 +366,14 @@ describe Treequel::Branch do
 		end
 
 		it "knows if a attribute is valid given its objectClasses" do
-			attrs = mock( "Attribute list", :null_object => true )
+			attrtype = mock( "attribute type object" )
 
 			@branch.should_receive( :valid_attribute_types ).
 				twice.
-				and_return([ attrs ])
+				and_return([ attrtype ])
 
-			attrs.should_receive( :names ).twice.and_return([ :cn, :l, :uid ])
+			attrtype.should_receive( :valid_name? ).with( :uid ).and_return( true )
+			attrtype.should_receive( :valid_name? ).with( :rubberChicken ).and_return( false )
 
 			@branch.valid_attribute?( :uid ).should be_true()
 			@branch.valid_attribute?( :rubberChicken ).should be_false()
@@ -364,7 +381,7 @@ describe Treequel::Branch do
 
 		it "can be moved to a new location within the directory" do
 			newdn = "ou=hosts,dc=admin,#{TEST_BASE_DN}"
-			@directory.should_receive( :move ).with( @branch, newdn, {} )
+			@directory.should_receive( :move ).with( @branch, newdn )
 			@branch.move( newdn )
 		end
 
@@ -379,12 +396,6 @@ describe Treequel::Branch do
 		end
 
 
-		it "can be deleted from the directory" do
-			@directory.should_receive( :delete ).with( @branch )
-			@branch.delete
-		end
-
-
 		it "can create children under itself" do
 			newattrs = {
 				:ipHostNumber => '127.0.0.1',
@@ -436,6 +447,46 @@ describe Treequel::Branch do
 		end
 
 
+		it "can delete all values of one of its entry's individual attributes" do
+			LDAP::Mod.should_receive( :new ).with( LDAP::LDAP_MOD_DELETE, 'displayName', [] ).
+				and_return( :mod_delete )
+			@directory.should_receive( :modify ).with( @branch, [:mod_delete] )
+
+			@branch.delete( :displayName )
+		end
+
+		it "can delete all values of more than one of its entry's individual attributes" do
+			LDAP::Mod.should_receive( :new ).with( LDAP::LDAP_MOD_DELETE, 'displayName', [] ).
+				and_return( :first_mod_delete )
+			LDAP::Mod.should_receive( :new ).with( LDAP::LDAP_MOD_DELETE, 'gecos', [] ).
+				and_return( :second_mod_delete )
+			@directory.should_receive( :modify ).
+				with( @branch, [:first_mod_delete, :second_mod_delete] )
+
+			@branch.delete( :displayName, :gecos )
+		end
+
+		it "can delete one particular value of its entry's individual attributes" do
+			LDAP::Mod.should_receive( :new ).
+				with( LDAP::LDAP_MOD_DELETE, 'objectClass', ['apple-user'] ).
+				and_return( :mod_delete )
+			@directory.should_receive( :modify ).with( @branch, [:mod_delete] )
+
+			@branch.delete( :objectClass => 'apple-user' )
+		end
+
+		it "can delete particular values of more than one of its entry's individual attributes" do
+			LDAP::Mod.should_receive( :new ).
+				with( LDAP::LDAP_MOD_DELETE, 'objectClass', ['apple-user', 'inetOrgPerson'] ).
+				and_return( :first_mod_delete )
+			LDAP::Mod.should_receive( :new ).
+				with( LDAP::LDAP_MOD_DELETE, 'cn', [] ).and_return( :second_mod_delete )
+			@directory.should_receive( :modify ).
+				with( @branch, array_including(:first_mod_delete, :second_mod_delete) )
+
+			@branch.delete( :objectClass => ['apple-user',:inetOrgPerson], :cn => [] )
+		end
+
 		it "knows how to represent its DN as an RFC1781-style UFN" do
 			@branch.to_ufn.should =~ /Hosts, acme\.com/i
 		end
@@ -561,6 +612,14 @@ describe Treequel::Branch do
 			end
 		end
 
+		it "can fetch multiple values via #values_at" do
+			@branch.should_receive( :[] ).with( :cn ).and_return( :cn_value )
+			@branch.should_receive( :[] ).with( :desc ).and_return( :desc_value )
+			@branch.should_receive( :[] ).with( :l ).and_return( :l_value )
+
+			@branch.values_at( :cn, :desc, :l ).should == [ :cn_value, :desc_value, :l_value ]
+		end
+
 	end
 
 end