treequel 1.6.0 → 1.7.0

data/ChangeLog

@@ -1,8 +1,95 @@
+2011-11-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.7.0 for changeset 367d9982ea67
+	[74e7687d2837] [tip]
+
+	* .hgsigs:
+	Added signature for changeset c5b83ddad969
+	[367d9982ea67] [v1.7.0]
+
+	* README.rdoc, bin/treequel, bin/treewhat, experiments/mixohm.rb,
+	experiments/modfault.rb, lib/treequel.rb, lib/treequel/branch.rb,
+	lib/treequel/branchcollection.rb, lib/treequel/branchset.rb,
+	lib/treequel/control.rb, lib/treequel/controls/contentsync.rb,
+	lib/treequel/controls/pagedresults.rb, lib/treequel/directory.rb,
+	lib/treequel/exceptions.rb, lib/treequel/filter.rb,
+	lib/treequel/mixins.rb, lib/treequel/model.rb,
+	lib/treequel/model/errors.rb, lib/treequel/model/objectclass.rb,
+	lib/treequel/monkeypatches.rb, lib/treequel/schema.rb,
+	lib/treequel/schema/attributetype.rb,
+	lib/treequel/schema/objectclass.rb, lib/treequel/utils.rb:
+	De-Yarded
+	[c5b83ddad969] [github/master]
+
+	* Rakefile:
+	Require 'rake/clean' for the CLOBBER FileList
+	[8e6a436a4056]
+
+	* spec/treequel/monkeypatches_spec.rb:
+	Fixing generalized time tests for FreeBSD
+	[9913f6cb927f]
+
+	* History.rdoc, lib/treequel.rb:
+	Bump minor version for API changes, update History.
+	[d9c5807f1bd5]
+
+	* lib/treequel/model.rb:
+	Treat Treequel::Model#[]= with a nil value on a SINGLE-VALUE
+	attribute as a delete.
+	[06a018adffb8]
+
+	* lib/treequel/branchset.rb:
+	Splat the filterspec used in Branchset#not to avoid unnecessary
+	filter clauses.
+	[ed42352c1ed4]
+
+	* lib/treequel/branch.rb:
+	Efficiency fix for Treequel::Branch#must_attribute_types
+	[797738d823b4]
+
+	* lib/treequel/branch.rb, lib/treequel/model.rb:
+	Removed some of the more-redundant/verbose debugging.
+	[58390743bd93]
+
+2011-11-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile, lib/treequel/branchset.rb,
+	spec/treequel/branchset_spec.rb:
+	Added Branchset#first with an argument, and a #not mutator.
+	[12a92b33f049]
+
+	* Rakefile:
+	Build tgz and zip packages, too
+	[c74c3a992b6f]
+
+	* .pryrc:
+	Adding a .pryrc
+	[35bea171d90d]
+
+2011-10-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.6.0 for changeset c3abddcd7532
+	[e16351a6b919]
+
+	* .hgsigs:
+	Added signature for changeset ef0ce1481247
+	[c3abddcd7532] [v1.6.0]
+
+	* .hgtags:
+	Added tag semver for changeset 3ceba5117883
+	[ef0ce1481247]
+
+	* Manifest.txt, Rakefile:
+	Include test datafiles, update Rakefile.
+	[92151182984d]
+
 2011-10-20  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/treewhat:
 	Make the treewhat tool executable
-	[6d8a6dc8e9dc] [tip]
+	[6d8a6dc8e9dc]
 
 	* Rakefile:
 	Made checkin check the manifest, too
@@ -31,7 +118,7 @@
 
 	* Rakefile:
 	Fix dev dependency version spec.
-	[d395c6dc9c1f] [github/master]
+	[d395c6dc9c1f]
 
 2011-08-09  Michael Granger  <ged@FaerieMUD.org>
 
@@ -69,6 +156,14 @@
 	* Merged with fcb89939ba84
 	[da4761033bea]
 
+2011-06-14  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/treequel/model.rb:
+	Adding debug logging to Treequel::Model#save
+	[fcb89939ba84]
+
+2011-06-28  Michael Granger  <ged@FaerieMUD.org>
+
 	* Rakefile, spec/treequel/monkeypatches_spec.rb:
 	Some fixes for JRuby + jruby-ldap
 	- Use a modern timezone for the Time tests
@@ -82,12 +177,6 @@
 	objects sharing the same connection
 	[1a1383549960]
 
-2011-06-14  Michael Granger  <ged@FaerieMUD.org>
-
-	* lib/treequel/model.rb:
-	Adding debug logging to Treequel::Model#save
-	[fcb89939ba84]
-
 2011-05-25  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/treequel/constants.rb, lib/treequel/schema.rb,
@@ -148,13 +237,6 @@
 	Adding schema artifacts to the treewhat command
 	[58261aeb1c82]
 
-2011-03-28  Michael Granger  <ged@FaerieMUD.org>
-
-	* bin/treewhat:
-	Updated the 'treewhat' schema tool.
-	* Show additional details for some schema objects.
-	[28576726289e]
-
 2011-03-21  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/treequel:
@@ -176,6 +258,13 @@
 	Manual CSS fixes for HTML5 elements under FF3.6
 	[72d3e439772f]
 
+2011-03-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/treewhat:
+	Updated the 'treewhat' schema tool.
+	* Show additional details for some schema objects.
+	[28576726289e]
+
 2011-03-17  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
@@ -460,6 +549,12 @@
 	Merged with 411:ddbb3c3bdd00
 	[ba7895d4e64b]
 
+2011-01-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* History.md:
+	Updated History
+	[9c4db65b40d7]
+
 2011-01-18  Michael Granger  <ged@FaerieMUD.org>
 
 	* manual/layouts/default.erb, manual/resources/css/manual.css,
@@ -524,10 +619,6 @@
 
 2011-01-17  Michael Granger  <ged@FaerieMUD.org>
 
-	* History.md:
-	Updated History
-	[9c4db65b40d7]
-
 	* .hgtags:
 	Added tag v1.3.1 for changeset a6ea030fc88f
 	[4caac8976d00]
@@ -636,14 +727,14 @@
 	Automated merge with ssh://deveiate/Treequel
 	[62e7348050eb]
 
-	* bin/treequel:
-	More logging constant fixes for the treequel shell.
-	[6e159f32ed07]
-
 	* bin/treequel, lib/treequel/model/objectclass.rb:
 	Aesthetic cleanup
 	[78e65cb8f30a]
 
+	* bin/treequel:
+	More logging constant fixes for the treequel shell.
+	[6e159f32ed07]
+
 2011-01-04  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/treequel:
@@ -1018,7 +1109,7 @@
 
 	* .hgsigs:
 	Added signature for changeset c6166a5cbc23
-	[3ceba5117883] [v1.2.0]
+	[3ceba5117883] [semver, v1.2.0]
 
 	* .hgsubstate, Rakefile:
 	Updated build system.
@@ -1770,6 +1861,12 @@
 	* Re-sorted the OID constants to be in OID order
 	[8b2fb7415412]
 
+2010-01-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/treequel:
+	Make treequel shell's 'cat' command error for non-existant entries
+	[84087b01d473]
+
 2010-01-24  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/treequel:
@@ -1778,10 +1875,6 @@
 
 2010-01-13  Michael Granger  <ged@FaerieMUD.org>
 
-	* bin/treequel:
-	Make treequel shell's 'cat' command error for non-existant entries
-	[84087b01d473]
-
 	* bin/treequel:
 	Fix the 'grep' command in the Treequel shell.
 	[669a09149f48]
@@ -1812,19 +1905,6 @@
 	Updated build system
 	[00ac1bc4e917]
 
-2009-12-22  Michael Granger  <ged@FaerieMUD.org>
-
-	* bin/treequel:
-	Reworked LDIF display colors in the shell to be more visible.
-	[d77a0bf26034]
-
-	* bin/treequel:
-	Make the treequel shell fall back to plain connect (with a warning)
-	if TLS fails.
-	[9aeccec1ee84]
-
-2010-01-07  Michael Granger  <ged@FaerieMUD.org>
-
 	* bin/treequel, lib/treequel/branch.rb, lib/treequel/constants.rb,
 	lib/treequel/utils.rb:
 	Improvements to the treequel shell, fixes for 1.9.1.
@@ -1846,6 +1926,15 @@
 
 2009-12-22  Michael Granger  <ged@FaerieMUD.org>
 
+	* bin/treequel:
+	Reworked LDIF display colors in the shell to be more visible.
+	[d77a0bf26034]
+
+	* bin/treequel:
+	Make the treequel shell fall back to plain connect (with a warning)
+	if TLS fails.
+	[9aeccec1ee84]
+
 	* examples/ldap-monitor.rb, examples/ldap-
 	monitor/public/css/master.css, examples/ldap-
 	monitor/public/images/card_small.png, examples/ldap-
@@ -1866,27 +1955,6 @@
 	Automated merge with ssh://hg@deveiate/Treequel
 	[3bdd645530fe]
 
-2009-12-18  Michael Granger  <ged@FaerieMUD.org>
-
-	* Merged with 5fd4033e1556
-	[9571c9d8e4dd]
-
-2009-12-17  Michael Granger  <ged@FaerieMUD.org>
-
-	* docs/openldap-oids.txt, lib/treequel/constants.rb,
-	lib/treequel/controls/contentsync.rb,
-	lib/treequel/controls/persistentsearch.rb,
-	lib/treequel/directory.rb:
-	More controls work, started several more control modules.
-	* Adding a breakdown of all the controls the OpenLDAP server I have
-	has, so I know which controls I can test against.
-	* Added some control constants.
-	* Added the ContentSyncControl and the PersistentSearchControl.
-	* Added a Directory#supported_controls method.
-	[ffc2ebacdfd0]
-
-2009-12-22  Michael Granger  <ged@FaerieMUD.org>
-
 	* bin/treequel, examples/ldap-monitor.rb, examples/ldap-
 	monitor/public/css/master.css, examples/ldap-
 	monitor/public/images/card_small.png, examples/ldap-
@@ -1915,6 +1983,25 @@
 	* Bumped the version to 1.0.2.
 	[31c326800cc6]
 
+2009-12-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* Merged with 5fd4033e1556
+	[9571c9d8e4dd]
+
+2009-12-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* docs/openldap-oids.txt, lib/treequel/constants.rb,
+	lib/treequel/controls/contentsync.rb,
+	lib/treequel/controls/persistentsearch.rb,
+	lib/treequel/directory.rb:
+	More controls work, started several more control modules.
+	* Adding a breakdown of all the controls the OpenLDAP server I have
+	has, so I know which controls I can test against.
+	* Added some control constants.
+	* Added the ContentSyncControl and the PersistentSearchControl.
+	* Added a Directory#supported_controls method.
+	[ffc2ebacdfd0]
+
 2009-12-16  Michael Granger  <ged@FaerieMUD.org>
 
 	* Rakefile, lib/treequel/mixins.rb, project.yml:
@@ -3009,16 +3096,6 @@
 	Merged. Someday I'll get the hang of this.
 	[a5e715f5f877]
 
-2009-07-28  Michael Granger  <ged@FaerieMUD.org>
-
-	* .hgignore, Rakefile:
-	Merged with 34cc97817266
-	[395b7bf6f248]
-
-	* .hgignore, Rakefile, docs/manual/src/index.page:
-	Manual rewording, .hgignore updates
-	[89f74035c67d]
-
 2009-07-29  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgignore, Rakefile, docs/manual/src/index.page,
@@ -3029,6 +3106,16 @@
 	 * Made Treequel::Branch#filter treat a Hash like an array of tuples.
 	[46e6dce0c011]
 
+2009-07-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, Rakefile:
+	Merged with 34cc97817266
+	[395b7bf6f248]
+
+	* .hgignore, Rakefile, docs/manual/src/index.page:
+	Manual rewording, .hgignore updates
+	[89f74035c67d]
+
 2009-07-27  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgignore, Rakefile:
@@ -3040,6 +3127,10 @@
 
 2009-07-24  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgsub, .hgsubstate:
+	Unlinking the subrepo, as it doesn't behave well enough quite yet.
+	[fc3c3bac2c22]
+
 	* .hgsub, .hgsubstate:
 	Merging build system fixes
 	[b7a919b2ad5d]
@@ -3052,10 +3143,6 @@
 	Removing subrepo, as it doesn't work quite the way I'd hoped.
 	[f631900a9ad8] <build-system-fixes>
 
-	* .hgsub, .hgsubstate:
-	Unlinking the subrepo, as it doesn't behave well enough quite yet.
-	[fc3c3bac2c22]
-
 	* .hgignore, .hgsubstate, Rakefile, Rakefile.local, project.yml:
 	Initial commit of Mercurial-based tasks
 	[65236b2101e5] <build-system-fixes>

data/History.rdoc

@@ -1,3 +1,14 @@
+== v1.7.0 [2011-11-09] Michael Granger <ged@FaerieMUD.org>
+
+- Treat Treequel::Model#[]= with a nil value on a SINGLE-VALUE
+  attribute as a delete.
+- Splat the filterspec used in Branchset#not to avoid unnecessary
+  filter clauses.
+- Efficiency fix for Treequel::Branch#must_attribute_types
+- Removed some of the more-redundant/verbose debugging.
+- Added Branchset#first with an argument, and a #not mutator.
+
+
 == v1.6.0 [2011-10-06] Michael Granger <ged@FaerieMUD.org>
 
 - Adding workaround for vendored "sysexits" library under MacOX X 10.7

data/README.rdoc

@@ -1,8 +1,8 @@
-# Treequel - an honest LDAP library
+= Treequel - an honest LDAP library
 
 * http://deveiate.org/projects/Treequel
 
-## Description
+== Description
 
 Treequel is an LDAP toolkit for Ruby. It is intended to allow quick, easy
 access to LDAP directories in a manner consistent with LDAP's hierarchical,
@@ -12,7 +12,7 @@ It's inspired by and modeled after [Sequel](http://sequel.rubyforge.org/), a
 kick-ass database library.
 
 
-## Examples
+== Examples
 
 Here are a few short examples to whet your appetite:
 
@@ -33,19 +33,22 @@ Here are a few short examples to whet your appetite:
     dir.ou( :people ).filter( :mail ).to_hash( :mail, :cn )
 
 More elaborate examples of real-world usage can be found 
-[in the examples/ directory][examples] in the distribution.
+{in the examples/ directory}[http://deveiate.org/projects/Treequel/browser/examples] 
+in the distribution.
 
 
-## Contributing
+== Contributing
 
-You can check out the current development source [with Mercurial][hgrepo], or
-if you prefer Git, via the project's [Github mirror][gitmirror].
+You can check out the current development source
+{with Mercurial}[http://repo.deveiate.org/Treequel], or
+if you prefer Git, via the project's
+{Github mirror}[https://github.com/ged/treequel].
 
 You can submit bug reports, suggestions, and read more about future plans at
-[the project page][projectpage].
+{the project page}[http://deveiate.org/projects/Treequel].
 
 
-## License
+== License
 
 Copyright (c) 2008-2011, Michael Granger and Mahlon E. Smith
 All rights reserved.
@@ -99,13 +102,13 @@ the following license terms:
   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   
 
-## Authors
+== Authors
 
 * Michael Granger <ged@FaerieMUD.org>
 * Mahlon E. Smith <mahlon@martini.nu>
 
 
-## Contributors
+== Contributors
 
 A special thanks to Ben Bleything, who was part of the initial brainstorm that
 led to the creation of this library.
@@ -115,8 +118,3 @@ ideas for the Model side of Treequel; it's vastly better for his
 suggestions.
 
 
-[examples]:http://deveiate.org/projects/Treequel/browser/examples
-[hgrepo]:http://repo.deveiate.org/Treequel
-[gitmirror]:https://github.com/ged/treequel
-[projectpage]:http://deveiate.org/projects/Treequel
-

data/Rakefile

@@ -6,6 +6,8 @@ rescue LoadError
 	abort "This Rakefile requires hoe (gem install hoe)"
 end
 
+require 'rake/clean'
+
 Hoe.plugin :mercurial
 Hoe.plugin :signing
 Hoe.plugin :manualgen
@@ -17,6 +19,9 @@ hoespec = Hoe.spec 'treequel' do
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
 
+	self.need_tar = true
+	self.need_zip = true
+
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 	self.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
 
@@ -26,7 +31,7 @@ hoespec = Hoe.spec 'treequel' do
 		self.dependency 'ruby-ldap', '~> 0.9'
 	end
 	self.dependency 'diff-lcs', '~> 1.1'
-	self.dependency 'rspec', '~> 2.6.0', :developer
+	self.dependency 'rspec', '~> 2.7', :developer
 	self.dependency 'ruby-termios', '~> 0.9', :developer
 	self.dependency 'ruby-terminfo', '~> 0.1', :developer
 	self.dependency 'columnize', '~> 0.3', :developer

data/bin/treequel

@@ -194,8 +194,7 @@ class Treequel::Shell
 	###	I N S T A N C E   M E T H O D S
 	#################################################################
 
-	### Create a new shell for the specified +directory+.
-	### @param [Treequel::Directory] directory  the LDAP directory to navigate
+	### Create a new shell for the specified +directory+ (a Treequel::Directory).
 	def initialize( directory )
 		@dir        = directory
 		@uri        = directory.uri
@@ -224,9 +223,8 @@ class Treequel::Shell
 	attr_accessor :quit
 
 
-	### The command loop: run the shell until the user wants to quit
-	### @param [String]              bind_as    The DN of the user to bind as. If none is
-	###                                         specified, the shell will bind anonymously.
+	### The command loop: run the shell until the user wants to quit, binding as +bind_as+ if
+	### given.
 	def run( bind_as=nil )
 		@original_tty_settings = IO.read( '|-' ) or exec 'stty', '-g'
 		message "Connected to %s" % [ @uri ]
@@ -911,11 +909,7 @@ class Treequel::Shell
 
 
 	### Return the description of the specified +branch+ suitable for displaying in
-	### the directory listing.
-	### @param [Treequel::Branch] branch  the branch to be described
-	### @param [Fixnum] oclen             the length of the largest objectclass that 
-	###                                   will be displayed; used to calculate the 
-	###                                   width of the objectclass column.
+	### the directory listing. The +oclen+ is the width of the objectclass column.
 	def format_description( branch, oclen=40 )
 		rdn = format_rdn( branch.rdn )
 		metadatalen = oclen + 16 + 6 # oc + timestamp + whitespace

data/bin/treewhat

@@ -58,8 +58,7 @@ class Treequel::What
 	end
 
 
-	### Create and configure a command-line option parser for the command.
-	### @return [Trollop::Parser] the option parser
+	### Create and configure a command-line option parser (a Trollop::Parser) for the command.
 	def self::make_option_parser
 		progname = File.basename( $0 )
 		default_directory = Treequel.directory_from_config
@@ -343,8 +342,7 @@ class Treequel::What
 	end
 
 
-	### Display additional details for the specified +attrtype+.
-	### @param [Treequel::Schema::AttributeType] attrtype  the attribute type object to display
+	### Display additional details for the specified +attrtype+ (a Treequel::Schema::AttributeType).
 	def display_attrtype_details( attrtype )
 		ocs = self.directory.schema.object_classes.values.find_all do |oc|
 			( oc.must_oids | oc.may_oids ).include?( attrtype.name.to_sym )