treequel 1.5.3 → 1.6.0

data/ChangeLog

@@ -1,8 +1,186 @@
+2011-10-20  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/treewhat:
+	Make the treewhat tool executable
+	[6d8a6dc8e9dc] [tip]
+
+	* Rakefile:
+	Made checkin check the manifest, too
+	[0a70199cddf3]
+
+	* Manifest.txt:
+	Updated the Manifest
+	[18f6fafe8b76]
+
+	* misc/ruby-ldap-controlsfix.patch, misc/ruby-terminfo-0.1.1.gem:
+	Removed old cruft under misc/
+	[b1af9f473836]
+
+	* History.md, History.rdoc, README.md, README.rdoc, Rakefile,
+	lib/treequel.rb, spec/lib/helpers.rb:
+	Bumped version to 1.6.0, added coverage support, updated history.
+	[2639d7f96151]
+
+2011-10-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/treewhat:
+	Adding workaround for vendored "sysexits" library under MacOX X 10.7
+	[b3474679e7f3]
+
+2011-08-15  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile:
+	Fix dev dependency version spec.
+	[d395c6dc9c1f] [github/master]
+
+2011-08-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/treequel/model.rb:
+	Add a log message to Treequel::Model#validate if some validations
+	fail.
+	[8678f65925df]
+
+	* lib/treequel/branchset.rb, spec/treequel/branchset_spec.rb:
+	Added convenience mutator to Treequel::Branchset for selecting
+	operational attributes.
+	[64c7bd0d6870]
+
+2011-06-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* manual/src/connecting.page:
+	Add the auto-toc to the connecting page of the manual
+	[84f4281ddd08]
+
+	* Rakefile:
+	De-Yard the project
+	[8452d7f6ae81]
+
+2011-06-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile, spec/lib/helpers.rb, spec/treequel/schema_spec.rb:
+	Updated for newest version of RSpec, make specs behave nicer under
+	JRuby.
+	[35033dbe4ce4]
+
+	* lib/treequel/branch.rb, spec/treequel/branch_spec.rb:
+	Adding a Branch#dn2ufn workaround for jruby-ldap
+	[161b54f6d80c]
+
+	* Merged with fcb89939ba84
+	[da4761033bea]
+
+	* Rakefile, spec/treequel/monkeypatches_spec.rb:
+	Some fixes for JRuby + jruby-ldap
+	- Use a modern timezone for the Time tests
+	- Depend on jruby-ldap instead of ruby-ldap when run under JRuby
+	[126b71a64184]
+
+2011-06-16  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/treequel/directory.rb, spec/treequel/directory_spec.rb:
+	Add a copy constructor to Treequel::Directory to avoid two directory
+	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,
+	lib/treequel/schema/attributetype.rb,
+	lib/treequel/schema/objectclass.rb, spec/data/opends.yml,
+	spec/data/ticket11.yml, spec/treequel/schema/attributetype_spec.rb,
+	spec/treequel/schema/matchingrule_spec.rb,
+	spec/treequel/schema/objectclass_spec.rb,
+	spec/treequel/schema_spec.rb:
+	Adding support for Sun OpenDS schema artifacts (fixes #11)
+	* various workarounds for malformed objectClass and attributeType
+	declarations
+	* Regex encoding fixes for 1.9.2
+	* Treequel::Schema.strict_parse_mode flag for enabling the old
+	(strict) parsing behavior.
+	[80ee64e262bb]
+
+2011-04-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/treequel/constants.rb:
+	Change WSP and SP patterns to literal characters instead of using a
+	charclass
+	[794b4e96de47]
+
+2011-04-20  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile:
+	Add guard for the 'hoe' require to the Rakefile.
+	[f07207762a63]
+
+2011-04-07  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v1.5.3 for changeset 979f03a70e97
+	[028260f9e256]
+
+	* .hgsigs:
+	Added signature for changeset 1f396aca7d8b
+	[979f03a70e97] [v1.5.3]
+
+	* History.md, Rakefile, lib/treequel.rb:
+	Bump the patch version.
+	[1f396aca7d8b]
+
+	* lib/treequel/directory.rb, spec/lib/helpers.rb,
+	spec/treequel/directory_spec.rb:
+	Include regular attributes (in addition to operational ones) in the
+	root_dse, as AD stores everything in regular attributes.
+	[1bfa919abbb6]
+
+2011-04-04  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/treewhat:
+	Merged with 28576726289e
+	[ed9e50bcfe1b]
+
+	* bin/treewhat:
+	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:
+	Adding a --no-tls flag to the treequel shell
+	[30a7f36e7321]
+
+	* Rakefile:
+	Re-enable the Yard plugin, but don't pollute the gemspec with Yard-
+	only options
+	[63134a964df5]
+
+2011-03-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* manual/resources/css/manual.css:
+	CSS tweaks for examples
+	[67425ac31205]
+
+	* manual/resources/css/manual.css:
+	Manual CSS fixes for HTML5 elements under FF3.6
+	[72d3e439772f]
+
 2011-03-17  Michael Granger  <ged@FaerieMUD.org>
 
 	* .hgtags:
 	Added tag v1.5.2 for changeset 93550dca4121
-	[5132c59e6e3b] [tip]
+	[5132c59e6e3b]
 
 	* .hgsigs:
 	Added signature for changeset 585d3733441e
@@ -42,7 +220,7 @@
 
 	* spec/treequel/monkeypatches_spec.rb:
 	Fixing bad time tests uncovered by the DST switch
-	[63ac5e6f0b10] [master]
+	[63ac5e6f0b10]
 
 2011-03-08  Michael Granger  <ged@FaerieMUD.org>
 
@@ -59,7 +237,7 @@
 
 	* .hgtags:
 	Added tag v1.5.1 for changeset b0945a1e6ee0
-	[f3dbf7033b58] [github/master]
+	[f3dbf7033b58]
 
 	* .hgsigs:
 	Added signature for changeset 01662c7a2a07

data/{History.md → History.rdoc}

@@ -1,4 +1,28 @@
-## 1.5.3 [2011-04-07] Michael Granger <ged@FaerieMUD.org>
+== v1.6.0 [2011-10-06] Michael Granger <ged@FaerieMUD.org>
+
+- Adding workaround for vendored "sysexits" library under MacOX X 10.7
+- Add a log message to Treequel::Model#validate if some validations
+  fail.
+- Added convenience mutator to Treequel::Branchset for selecting
+  operational attributes.
+- De-Yard the API docs
+- Some fixes for JRuby + jruby-ldap
+- Use a modern timezone for the Time tests
+- Add a copy constructor to Treequel::Directory to avoid two directory
+  objects sharing the same connection
+- Adding support for Sun OpenDS schema artifacts (fixes #11)
+  * various workarounds for malformed objectClass and attributeType
+    declarations
+  * Regex encoding fixes for 1.9.2
+  * Treequel::Schema.strict_parse_mode flag for enabling the old
+    (strict) parsing behavior.
+
+
+== v1.5.3 [2011-04-07] Michael Granger <ged@FaerieMUD.org>
+
+- Added signature for changeset 1f396aca7d8b
+
+== v1.5.3 [2011-04-07] Michael Granger <ged@FaerieMUD.org>
 
 * Don't pollute the gemspec with Yard-only options
 * Adding a --no-tls flag to the treequel shell
@@ -8,7 +32,7 @@
 * Include regular attributes (in addition to operational ones) in the
   root_dse, as AD stores everything in regular attributes.
 
-## 1.5.2 [2011-03-17] Michael Granger <ged@FaerieMUD.org>
+== v1.5.2 [2011-03-17] Michael Granger <ged@FaerieMUD.org>
 
 * Manual updates
 * Fixing bad time tests uncovered by the DST switch
@@ -16,13 +40,13 @@
 * Fix for Github issue [ged/treequel GH-1] (closes #7)
 
 
-## 1.5.1 [2011-02-25] Michael Granger <ged@FaerieMUD.org>
+== v1.5.1 [2011-02-25] Michael Granger <ged@FaerieMUD.org>
 
 * Adding handling of operational attributes to Treequel::Model schema
   validations, updated the subschema test data to a recent OpenLDAP.
 
 
-## 1.5.0 [2011-02-24] Michael Granger <ged@FaerieMUD.org>
+== v1.5.0 [2011-02-24] Michael Granger <ged@FaerieMUD.org>
 
 * Make Treequel::Model::ObjectClass Enumerable
 * Add a default directory to Treequel::Model for creating and
@@ -36,26 +60,26 @@
 * Make dependencies not so pessimistic.
 
 
-## 1.4.4 [2011-02-10] Michael Granger <ged@FaerieMUD.org>
+== v1.4.4 [2011-02-10] Michael Granger <ged@FaerieMUD.org>
 
 * Add the .gemtest and Manifest to the manifest, bump patch version.
 * Make Treequel testable via Gem Testers
 * Hack to work around the pointer-mismanagement of LDAP::Mod
 
 
-## 1.4.3 [2011-02-10] Michael Granger <ged@FaerieMUD.org>
+== v1.4.3 [2011-02-10] Michael Granger <ged@FaerieMUD.org>
 
 * Added gem-testers support
 * Added a monkeypatch to work around a memory-corruption issue in 
   ruby-ldap.
 
 
-## 1.4.2 [2011-02-07] Michael Granger <ged@FaerieMUD.org>
+== v1.4.2 [2011-02-07] Michael Granger <ged@FaerieMUD.org>
 
 Fixed missing DEFAULT_EDITOR constant.
 
 
-## 1.4.1 [2011-02-02] Michael Granger <ged@FaerieMUD.org>
+== v1.4.1 [2011-02-02] Michael Granger <ged@FaerieMUD.org>
 
 More Treequel shell cleanup based on feedback from Michael Hix.
 
@@ -63,13 +87,13 @@ More Treequel shell cleanup based on feedback from Michael Hix.
 * Consistently verify RDN arguments where they're used.
 
 
-## 1.4.1 [2011-02-02] Michael Granger <ged@FaerieMUD.org>
+== v1.4.1 [2011-02-02] Michael Granger <ged@FaerieMUD.org>
 
 Bugfix:
 
 * Fixed result error as fatal exception in Treequel shell
 
-## 1.4.0 [2011-01-31] Michael Granger <ged@FaerieMUD.org>
+== v1.4.0 [2011-01-31] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:
 
@@ -82,19 +106,19 @@ Bugfixes:
 * Escape filter metacharacters in simple filter components
 
 
-## 1.3.2
+== v1.3.2
 
 Bugfix:
 
 * Ensure the entry hash that's passed to Treequel::Model#apply_applicable_mixins isn't modified; fixes a bug when modifying a new unsaved Model object.
 
 
-## 1.3.1 [2011-01-17] Michael Granger <ged@FaerieMUD.org>
+== v1.3.1 [2011-01-17] Michael Granger <ged@FaerieMUD.org>
 
 Fixed a bug that caused DN attributes in objects created via Treequel::Model.new_from_entry to be doubled.
 
 
-## 1.3.0 [2011-01-13] Michael Granger <ged@FaerieMUD.org>
+== v1.3.0 [2011-01-13] Michael Granger <ged@FaerieMUD.org>
 
 Enhancements:
 
@@ -137,8 +161,8 @@ Bugfixes:
 * Simplified and removed duplication from the logging code
 * Fixed a bug in the proxy method for single-letter attribute names.
 * Monkeypatched Date for LDAP time type conversions
-* Change the return values of unset attributes to distinguish between SINGLE and non-SINGLE 
-  attributes
+* Change the return values of unset attributes to distinguish between 
+  SINGLE and non-SINGLE attributes
 * Treequel::Branch
   - Check for explicit nil DN in .new
   - Check for nil parent_dn in #parent
@@ -146,14 +170,24 @@ Bugfixes:
   - Don't cache attempts to fetch invalid attributes
 
 
-## 1.2.2 [2010-12-14] Michael Granger <ged@FaerieMUD.org>
+== v1.2.2 [2010-12-14] Michael Granger <ged@FaerieMUD.org>
 
 Bugfixes for Treequel::Branch, Treequel::Model.
 
 
-## 1.2.1 [2010-12-13] Michael Granger <ged@FaerieMUD.org>
+== v1.2.1 [2010-12-13] Michael Granger <ged@FaerieMUD.org>
+
+- Converted to Hoe.
+
+Bugfix:
 
-Converted to Hoe.
+- objectClasses listed in Treequel::Model::ObjectClass.model_objectclasses
+  can be Strings, too.
 
-Bugfix: objectClasses listed in Treequel::Model::ObjectClass.model_objectclasses can be Strings, too.
+== v1.2.0 [2010-11-30] Michael Granger <ged@FaerieMUD.org>
 
+- Added hash-key conversion so Branches can be constructed with
+  Symbol-key hashargs.
+- Adding 'Treequel::Branchset#from' mutator for changing the base DN.
+- Fixed treequel shell's cp to support relative and absolute DNs
+- Converted to RSpec 2.0

data/Manifest.txt

@@ -1,9 +1,9 @@
 .gemtest
 ChangeLog
-History.md
+History.rdoc
 LICENSE
 Manifest.txt
-README.md
+README.rdoc
 Rakefile
 bin/treeirb
 bin/treequel
@@ -39,8 +39,11 @@ lib/treequel/schema/objectclass.rb
 lib/treequel/schema/table.rb
 lib/treequel/sequel_integration.rb
 lib/treequel/utils.rb
+spec/data/ad_schema.yml
 spec/data/objectClasses.yml
+spec/data/opends.yml
 spec/data/schema.yml
+spec/data/ticket11.yml
 spec/lib/constants.rb
 spec/lib/helpers.rb
 spec/lib/matchers.rb

data/Rakefile

@@ -1,34 +1,37 @@
 #!/usr/bin/env rake
 
-require 'hoe'
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires hoe (gem install hoe)"
+end
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
-Hoe.plugin :yard
 Hoe.plugin :manualgen
 
 Hoe.plugins.delete :rubyforge
 
 hoespec = Hoe.spec 'treequel' do
-	self.name = 'treequel'
-	self.readme_file = 'README.md'
-	self.history_file = 'History.md'
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 	self.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
 
-	self.extra_deps.push *{
-		'ruby-ldap' => '~> 0.9',
-		'diff-lcs'  => '~> 1.1',
-	}
-	self.extra_dev_deps.push *{
-		'rspec'         => '~> 2.4',
-		'ruby-termios'  => '~> 0.9',
-		'ruby-terminfo' => '~> 0.1',
-		'columnize'     => '~> 0.3',
-		'sysexits'      => '~> 1.0',
-		'sequel'        => '~> 3.20',
-	}
+	if RUBY_PLATFORM == 'java'
+		self.dependency 'jruby-ldap', '~> 0.0.1'
+	else
+		self.dependency 'ruby-ldap', '~> 0.9'
+	end
+	self.dependency 'diff-lcs', '~> 1.1'
+	self.dependency 'rspec', '~> 2.6.0', :developer
+	self.dependency 'ruby-termios', '~> 0.9', :developer
+	self.dependency 'ruby-terminfo', '~> 0.1', :developer
+	self.dependency 'columnize', '~> 0.3', :developer
+	self.dependency 'sysexits', '~> 1.0', :developer
+	self.dependency 'sequel', '~> 3.20', :developer
 
 	self.spec_extras[:licenses] = ["BSD"]
 	self.spec_extras[:post_install_message] = [
@@ -43,12 +46,11 @@ hoespec = Hoe.spec 'treequel' do
 		"You can install them automatically if you use the --development flag when",
 		"installing Treequel."
 	  ].join( "\n" )
-	self.spec_extras[:signing_key] = '/Volumes/Keys/ged-private_gem_key.pem'
 
 	self.require_ruby_version( '>=1.8.7' )
 
-	self.rspec_options += ['-cfd'] if self.respond_to?( :rspec_options= )
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
 	self.manual_source_dir = 'src' if self.respond_to?( :manual_source_dir= )
 
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
@@ -56,6 +58,38 @@ end
 
 ENV['VERSION'] ||= hoespec.spec.version.to_s
 
-# Tests use RSpec
-task :test => :spec
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => [ :check_history, :check_manifest, :spec ]
+
+### Make the ChangeLog update if the repo has changed since it was last built
+file '.hg/branch'
+file 'ChangeLog' => '.hg/branch' do |task|
+	$stderr.puts "Updating the changelog..."
+	content = make_changelog()
+	File.open( task.name, 'w', 0644 ) do |fh|
+		fh.print( content )
+	end
+end
+
+# Rebuild the ChangeLog immediately before release
+task :prerelease => 'ChangeLog'
+
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+
+if Rake::Task.task_defined?( '.gemtest' )
+	Rake::Task['.gemtest'].clear
+	task '.gemtest' do
+		$stderr.puts "Not including a .gemtest until I'm confident the test suite is idempotent."
+	end
+end
+
+
+# Add admin app testing directories to the clobber list
+CLOBBER.include( 'ChangeLog' )
+
 

data/bin/treewhat

@@ -5,6 +5,10 @@ require 'abbrev'
 require 'trollop'
 require 'highline'
 require 'shellwords'
+
+# Work around MacOS X's vendored 'sysexits' that does the same thing,
+# but with a different API
+gem 'sysexits'
 require 'sysexits'
 
 require 'treequel'

data/lib/treequel/branch.rb

@@ -266,7 +266,34 @@ class Treequel::Branch
 	### Return the entry's DN as an RFC1781-style UFN (User-Friendly Name).
 	### @return [String]
 	def to_ufn
-		return LDAP.dn2ufn( self.dn )
+		if LDAP.respond_to?( :dn2ufn )
+			return LDAP.dn2ufn( self.dn )
+
+		# An implementation for LDAP libraries with no
+		# dn2ufn
+		else
+			ufn = ''
+			tuples = self.split_dn
+
+			# Separate the trailing domainComponents
+			dcs = []
+			dcs << tuples.pop while tuples.last =~ /^dc\s*=/i
+
+			# Append the non-dc tuples with their attributes stripped first
+			ufn << tuples.collect do |rdn|
+				rdn.
+					gsub(/\b#{ATTRIBUTE_TYPE}\s*=/, '').
+					gsub(/\s*\+\s*/, ' + ')
+			end.join( ', ' )
+
+			# Now append the DCs joined with dots
+			unless dcs.empty?
+				ufn << ', '
+				ufn << dcs.reverse.map {|rdn| rdn.sub(/dc\s*=\s*/i, '') }.join( '.' )
+			end
+
+			return ufn
+		end
 	end
 
 

data/lib/treequel/branchset.rb

@@ -366,6 +366,15 @@ class Treequel::Branchset
 	end
 
 
+	### Return a clone of the receiving Branchset that will fetch any operational attributes
+	### in addition to its own. This is exactly equivalent to:
+	###
+	###    branchset.select( :+ ).
+	def with_operational_attributes
+		return self.select( :+ )
+	end
+
+
 	### If called with a +new_limit+, returns a clone of the receiving Branchset that will
 	### fetch (at most) +new_limit+ Branches. If no +new_limit+ argument is specified,
 	### returns the Branchset's current limit. A limit of '0' means that all Branches