treequel 1.1.1 → 1.2.0pre320

data/ChangeLog

@@ -1,4 +1,52 @@
-304[tip]   92c28b14730a   2010-09-20 13:51 -0700   ged
+320[tip]   ccdee2d78e68   2010-11-24 18:21 -0800   ged
+  Updated build system.
+
+319   47697f2ebc27   2010-11-24 18:18 -0800   ged
+  Added hash-key conversion so Branches can be constructed with Symbol-key hashargs.
+
+318   44f8be0662c4   2010-11-18 15:43 -0800   ged
+  Adding 'Treequel::Branchset#from' mutator for changing the base DN.
+
+317:316,315   72dd41272f6f   2010-11-11 12:46 -0600   ged
+  Merging with 316:33a7dcde80a1
+
+316:313   9f9460125077   2010-11-11 10:59 -0600   ged
+  Spec fixes for RSpec 2.0
+
+315   33a7dcde80a1   2010-11-09 13:00 -0800   ged
+  Readding subrepo
+
+314   fc9ae9f5b034   2010-11-09 12:53 -0800   ged
+  Fixing subrepo corruption caused by rollback
+
+313:312,311   c1b750e4e9fc   2010-11-09 12:09 -0800   ged
+  Merged with 310:cc7c63ff15a0
+
+312:310   380662d385e0   2010-11-09 12:08 -0800   ged
+  stub! -> stub; added more debugging to try to track down the model test failure
+
+311:309   cc7c63ff15a0   2010-11-03 07:50 -0700   ged
+  Converting the README to Markdown
+
+310   7f20ab74d6b1   2010-11-08 12:53 -0800   ged
+  Fixed treequel shell's cp to support relative and absolute DNs
+
+309   26c3853695ea   2010-10-22 17:47 -0700   ged
+  Converted to RSpec 2.0
+
+308   98b6847de872   2010-10-22 14:58 -0700   ged
+  Updating build system; add requirement for Ruby 1.8.7
+
+307   7f70394868e2   2010-09-21 08:49 -0700   ged
+  Added tag 1.1.1 for changeset e52c71f4e4ca
+
+306[1.1.1]   e52c71f4e4ca   2010-09-21 08:49 -0700   ged
+  Added signature for changeset c6d26ab6a7a4
+
+305   c6d26ab6a7a4   2010-09-21 08:48 -0700   ged
+  Critical bugfix.
+
+304   92c28b14730a   2010-09-20 13:51 -0700   ged
   Added tag 1.1.0 for changeset b415e0fce774
 
 303[1.1.0]   b415e0fce774   2010-09-20 13:51 -0700   ged

data/README.md

@@ -0,0 +1,65 @@
+# Treequel - an honest LDAP library
+
+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,
+free-form nature. 
+
+It's inspired by and modeled after [Sequel](http://sequel.rubyforge.org/), a
+kick-ass database library.
+
+
+## Examples
+
+Here are a few short examples to whet your appetite:
+
+    # Connect to the directory at the specified URL
+    dir = Treequel.directory( 'ldap://ldap.company.com/dc=company,dc=com' )
+    
+    # Get a list of email addresses of every person in the directory (as
+    # long as people are under ou=people)
+    dir.ou( :people ).filter( :mail ).map( :mail ).flatten
+    
+    # Get a list of all IP addresses for all hosts in any ou=hosts group
+    # in the whole directory:
+    dir.filter( :ou => :hosts ).collection.filter( :ipHostNumber ).
+      map( :ipHostNumber ).flatten
+    
+    # Get all people in the directory in the form of a hash of names 
+    # keyed by email addresses
+    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.
+
+
+## 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 submit bug reports, suggestions, and read more about future plans at
+[the project page][projectpage].
+
+
+## License
+
+See the included LICENSE file for licensing details.
+
+
+## Authors
+
+* Michael Granger
+* Mahlon E. Smith
+
+
+## Contributors
+
+A special thanks to Ben Bleything, who was part of the initial brainstorm that
+led to the creation of this library.
+
+
+[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

@@ -171,9 +171,9 @@ include RakefileHelpers
 # Set the build ID if the mercurial executable is available
 if hg = which( 'hg' )
 	id = `#{hg} id -n`.chomp
-	PKG_BUILD = "pre%03d" % [(id.chomp[ /^[[:xdigit:]]+/ ] || '1')]
+	PKG_BUILD = (id.chomp[ /^[[:xdigit:]]+/ ] || '1')
 else
-	PKG_BUILD = 'pre000'
+	PKG_BUILD = '0'
 end
 SNAPSHOT_PKG_NAME = "#{PKG_FILE_NAME}.#{PKG_BUILD}"
 SNAPSHOT_GEM_NAME = "#{SNAPSHOT_PKG_NAME}.gem"
@@ -190,7 +190,6 @@ RDOC_OPTIONS = [
   ]
 YARD_OPTIONS = [
 	'--use-cache',
-	'--no-private',
 	'--protected',
 	'-r', README_FILE,
 	'--exclude', 'extconf\\.rb',
@@ -210,27 +209,29 @@ PROJECT_DOCDIR = "#{PROJECT_PUBDIR}/#{PKG_NAME}"
 PROJECT_SCPPUBURL = "#{PROJECT_HOST}:#{PROJECT_PUBDIR}"
 PROJECT_SCPDOCURL = "#{PROJECT_HOST}:#{PROJECT_DOCDIR}"
 
+GEM_PUBHOST = 'rubygems.org'
+
 # Gem dependencies: gemname => version
 DEPENDENCIES = {
-	'ruby-ldap' => '>= 0.9.9',
+	'ruby-ldap' => '~> 0.9.9',
 }
 
 # Developer Gem dependencies: gemname => version
 DEVELOPMENT_DEPENDENCIES = {
-	'rake'         => '>= 0.8.7',
-	'rcodetools'   => '>= 0.7.0.0',
-	'rcov'         => '>= 0.8.1.2.0',
-	'rdoc'         => '>= 2.4.3',
-	'RedCloth'     => '>= 4.0.3',
-	'rspec'        => '>= 1.2.6',
-	'ruby-termios' => '>= 0.9.6',
-	'text-format'  => '>= 1.0.0',
-	'tmail'        => '>= 1.2.3.1',
-	'diff-lcs'     => '>= 1.1.2',
-	'columnize' => '>= 0.3.1',
-	'diff-lcs' => '>= 1.1.2',
-	'ruby-termios' => '>= 0.9.6',
-	'ruby-terminfo' => '>= 0.1.1',
+	'rake'          => '~> 0.8.7',
+	'rcodetools'    => '~> 0.7.0.0',
+	'rcov'          => '~> 0.8.1.2.0',
+	'yard'          => '~> 0.6.1',
+	'RedCloth'      => '~> 4.2.3',
+	'rspec'         => '~> 2.0.1',
+	'ruby-termios'  => '~> 0.9.6',
+	'text-format'   => '~> 1.0.0',
+	'tmail'         => '~> 1.2.3.1',
+	'columnize' => '~> 0.3.1',
+	'diff-lcs' => '~> 1.1.2',
+	'ruby-termios' => '~> 0.9.6',
+	'rspec' => '~> 2.0.1',
+	'ruby-terminfo' => '~> 0.1.1',
 }
 
 # Non-gem requirements: packagename => version
@@ -258,9 +259,10 @@ GEMSPEC   = Gem::Specification.new do |gem|
 		"    - diff-lcs",
 	  ].join( "\n" )
 
-	gem.authors           = "Michael Granger, Mahlon E. Smith"
+	gem.authors           = ["Michael Granger", "Mahlon E. Smith"]
 	gem.email             = ["mahlon@martini.nu", "ged@FaerieMUD.org"]
 	gem.homepage          = 'http://deveiate.org/projects/Treequel'
+	gem.licenses          = ["BSD"]
 
 	gem.has_rdoc          = true
 	gem.rdoc_options      = RDOC_OPTIONS
@@ -282,6 +284,9 @@ GEMSPEC   = Gem::Specification.new do |gem|
 	gem.signing_key       = '/Volumes/Keys/ged-private_gem_key.pem'
 	gem.cert_chain        = [File.expand_path('~/.gem/ged-public_gem_cert.pem')]
 
+
+	gem.required_ruby_version = '>=1.8.7'
+
 	DEPENDENCIES.each do |name, version|
 		version = '>= 0' if version.length.zero?
 		gem.add_runtime_dependency( name, version )

data/bin/treequel

@@ -690,10 +690,27 @@ class Treequel::Shell
 
 	### Copy an entry
 	def cp_command( options, rdn, newrdn )
-		branch = @currbranch.get_child( rdn )
-		newbranch = @currbranch.get_child( newrdn )
+		base_dn = @currbranch.directory.base_dn
+
+		# If the RDN includes the base, it's a DN
+		branch = if rdn =~ /,#{base_dn}$/i
+				Treequel::Branch.new( @currbranch.directory, rdn )
+			else
+				@currbranch.get_child( rdn )
+			end
+
+		# The source should already exist
+		raise "#{branch.dn}: no such entry" unless branch.exists?
+
+		# Same for the other RDN...
+		newbranch = if newrdn =~ /,#{base_dn}$/i
+				Treequel::Branch.new( @currbranch.directory, newrdn )
+			else
+				@currbranch.get_child( newrdn )
+			end
 
-		raise "#{branch.dn}: already exists" if newbranch.exists?
+		# But it *shouldn't* exist already
+		raise "#{newbranch.dn}: already exists" if newbranch.exists?
 
 		attributes = branch.entry.merge( :dn => newbranch.dn )
 		newbranch.create( attributes )

data/lib/treequel.rb

@@ -25,7 +25,7 @@ end
 
 # A library for interacting with LDAP modelled after Sequel.
 #
-# @version 1.1.1
+# @version 1.2.0
 # 
 # @example
 #   # Connect to the directory at the specified URL
@@ -53,10 +53,10 @@ end
 module Treequel
 
 	# Library version
-	VERSION = '1.1.1'
+	VERSION = '1.2.0'
 
 	# VCS revision
-	REVISION = %q$Revision: c6d26ab6a7a4 $
+	REVISION = %q$Revision: 44f8be0662c4 $
 
 	# Common paths for ldap.conf
 	COMMON_LDAP_CONF_PATHS = %w[

data/lib/treequel/branch.rb

@@ -17,7 +17,8 @@ class Treequel::Branch
 	include Comparable,
 	        Treequel::Loggable,
 	        Treequel::Constants,
-	        Treequel::Constants::Patterns
+	        Treequel::Constants::Patterns,
+	        Treequel::HashUtilities
 
 	extend Treequel::Delegation,
 	       Treequel::AttributeDeclarations
@@ -52,6 +53,7 @@ class Treequel::Branch
 	### 
 	### @return [Treequel::Branch]  The new branch object.
 	def self::new_from_entry( entry, directory )
+		entry = Treequel::HashUtilities.stringify_keys( entry )
 		return self.new( directory, entry['dn'].first, entry )
 	end
 
@@ -76,7 +78,7 @@ class Treequel::Branch
 
 		@directory = directory
 		@dn        = dn
-		@entry     = entry
+		@entry     = entry ? stringify_keys( entry ) : nil
 		@values    = {}
 
 		@include_operational_attrs = self.class.include_operational_attrs?
@@ -287,11 +289,13 @@ class Treequel::Branch
 		attrsym = attrname.to_sym
 
 		unless @values.key?( attrsym )
+			self.log.debug "  value for %p is NOT cached." % [ attrsym ]
 			value = self.get_converted_object( attrsym )
+			self.log.debug "  converted value is: %p" % [ value ]
 			value.freeze if value.respond_to?( :freeze )
 			@values[ attrsym ] = value
 		else
-			self.log.debug "  value is cached."
+			self.log.debug "  value for %p is cached." % [ attrname ]
 		end
 
 		return @values[ attrsym ]
@@ -474,11 +478,13 @@ class Treequel::Branch
 	### @param [Array<String, Symbol>] additional_classes 
 	### @return [Array<Treequel::Schema::ObjectClass>]
 	def object_classes( *additional_classes )
+		self.log.debug "Fetching object classes for %s" % [ self.dn ]
 		schema = self.directory.schema
 
 		oc_oids = self[:objectClass] || []
+		self.log.debug "  objectClass OIDs are: %p" % [ oc_oids ]
 		oc_oids |= additional_classes.collect {|str| str.to_sym }
-		oc_oids << 'top' if oc_oids.empty?
+		oc_oids << :top if oc_oids.empty?
 
 		oclasses = []
 		oc_oids.each do |oid|
@@ -487,6 +493,7 @@ class Treequel::Branch
 			oclasses << oc
 		end
 
+		self.log.debug "  found %d objectClasses: %p" % [  oclasses.length, oclasses ]
 		return oclasses.uniq
 	end
 
@@ -517,7 +524,8 @@ class Treequel::Branch
 	def must_attribute_types( *additional_object_classes )
 		types = []
 		oclasses = self.object_classes( *additional_object_classes )
-		self.log.debug "Gathering MUST attribute types for objectClasses: %p" % [ oclasses ]
+		self.log.debug "Gathering MUST attribute types for objectClasses: %p" %
+		 	[ oclasses.map(&:name) ]
 
 		oclasses.each do |oc|
 			self.log.debug "  adding %p from %p" % [ oc.must, oc ]
@@ -734,13 +742,19 @@ class Treequel::Branch
 
 	### Fetch the entry from the Branch's directory.
 	def lookup_entry
+		self.log.debug "Looking up entry for %s" % [ self.dn ]
+		entry = nil
+
 		if self.include_operational_attrs?
 			self.log.debug "  including operational attributes."
-			return self.directory.get_extended_entry( self )
+			entry = self.directory.get_extended_entry( self )
 		else
 			self.log.debug "  not including operational attributes."
-			return self.directory.get_entry( self )
+			entry = self.directory.get_entry( self )
 		end
+
+		self.log.debug "  entry is: %p" % [ entry ]
+		return entry
 	end
 
 

data/lib/treequel/branchset.rb

@@ -399,6 +399,16 @@ class Treequel::Branchset
 	end
 
 
+	### Return a clone of the receiving Branchset that will perform its search from
+	### +other_dn+ instead of its own.
+	### @param [String, #dn]  other_dn  the new base DN of the search
+	def from( other_dn )
+		newset = self.clone
+		other_dn = other_dn.dn if other_dn.respond_to?( :dn )
+		newset.branch = newset.branch.class.new( self.branch.directory, other_dn )
+		return newset
+	end
+
 end # class Treequel::Branchset
 
 

data/lib/treequel/model.rb

@@ -162,7 +162,7 @@ class Treequel::Model < Treequel::Branch
 	### @param [Symbol,String] sym  the name of the method to test for
 	### @return [Boolean]
 	def respond_to?( sym, include_priv=false )
-		return super if caller(1).first =~ %r{/spec/} &&
+		return super if caller(1).first =~ %r{/r?spec/} &&
 			caller(1).first !~ /respond_to/ # RSpec workaround
 		return true if super
 		plainsym, _ = attribute_from_method( sym )
@@ -213,26 +213,34 @@ class Treequel::Model < Treequel::Branch
 
 	### Proxy method -- Handle calls to missing methods by searching for an attribute.
 	def method_missing( sym, *args )
+		self.log.debug "Dynamic dispatch to %p with args: %p" % [ sym, args ]
 
 		# First, if the entry hasn't yet been loaded, try loading it to make sure the 
 		# object is already extended with any applicable objectClass mixins. If that ends
 		# up defining the method in question, call it.
 		if !@entry && self.entry
+			self.log.debug "  entry wasn't loaded, looking for methods added by loading it..."
 			meth = begin
 				self.method( sym )
-			rescue NoMethodError, NameError
+			rescue NoMethodError, NameError => err
+				self.log.debug "  it still didn't define %p: %s: %s" %
+					[ sym, err.class.name, err.message ]
 				nil
 			end
 			return meth.call( *args ) if meth
 		end
 
+		self.log.debug "  checking to see if it's a traversal call"
 		# Next, super to rdn-traversal if it looks like a reader but has arguments
 		plainsym, methodtype = attribute_from_method( sym )
+		self.log.debug "    method look like a %p" % [ methodtype ]
 		return super if methodtype == :reader && !args.empty?
+		self.log.debug "  ...but it doesn't have any arguments. Finding attr type."
 
 		# Now make a method body for a new method based on what attributeType it is if 
 		# it's a valid attribute
 		attrtype = self.find_attribute_type( plainsym ) or return super
+		self.log.debug "  attrtype is: %p" % [ attrtype ]
 		methodbody = case methodtype
 			when :writer
 				self.make_writer( attrtype )
@@ -310,6 +318,8 @@ class Treequel::Model < Treequel::Branch
 		if entry = super
 			self.log.debug "  applying mixins to %p" % [ entry ]
 			self.apply_applicable_mixins( self.dn, entry )
+		else
+			self.log.debug "  failed to fetch the entry."
 		end
 		return entry
 	end

data/lib/treequel/schema.rb

@@ -214,7 +214,7 @@ class Treequel::Schema
 	def inspect
 		ivar_descs = self.instance_variables.sort.collect do |ivar|
 			len = self.instance_variable_get( ivar ).length
-			"%d %s" % [ len, ivar.gsub(/_/, ' ')[1..-1] ]
+			"%d %s" % [ len, ivar.to_s.gsub(/_/, ' ')[1..-1] ]
 		end
 		return %{#<%s:0x%0x %s>} % [
 			self.class.name,

data/rake/documentation.rb

@@ -54,7 +54,7 @@ begin
 	class YARD::RegistryStore; include YardGlobals; end
 	class YARD::Docstring; include YardGlobals; end
 	module YARD::Templates::Helpers::ModuleHelper; include YardGlobals; end
-	module YARD::Tags::RefTaglist; include YardGlobals; end
+	module YARD::Templates::Helpers::HtmlHelper; include YardGlobals; end
 
 	if vvec(RUBY_VERSION) >= vvec("1.9.1")
 		# Monkeypatched to allow more than two '#' characters at the beginning
@@ -63,8 +63,15 @@ begin
 		require 'yard/parser/ruby/ruby_parser'
 		class YARD::Parser::Ruby::RipperParser < Ripper
 			def on_comment(comment)
-				$stderr.puts "Adding comment: %p" % [ comment ]
 				visit_ns_token(:comment, comment)
+				case comment
+				when /\A# @group\s+(.+)\s*\Z/
+					@groups.unshift [lineno, $1]
+					return
+				when /\A# @endgroup\s*\Z/
+					@groups.unshift [lineno, nil]
+					return
+				end
 
 				comment = comment.gsub(/^\#+\s{0,1}/, '').chomp
 				append_comment = @comments[lineno - 1]