treequel 1.8.6 → 1.9.0

data/ChangeLog

@@ -1,8 +1,43 @@
+2012-05-22  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, .tm_properties, README.rdoc, lib/treequel.rb,
+	lib/treequel/branch.rb, lib/treequel/branchcollection.rb,
+	lib/treequel/branchset.rb, lib/treequel/directory.rb,
+	lib/treequel/filter.rb, lib/treequel/mixins.rb,
+	lib/treequel/model.rb, lib/treequel/model/errors.rb,
+	lib/treequel/schema.rb, lib/treequel/schema/attributetype.rb,
+	lib/treequel/schema/ldapsyntax.rb,
+	lib/treequel/schema/matchingrule.rb,
+	lib/treequel/schema/matchingruleuse.rb,
+	lib/treequel/schema/objectclass.rb, lib/treequel/schema/table.rb,
+	spec/lib/helpers.rb, spec/treequel/directory_spec.rb,
+	spec/treequel/mixins_spec.rb, spec/treequel_spec.rb:
+	Convert to Loggability for logging
+	[2e32ed84d899] [tip]
+
+2012-04-16  Michael Granger  <ged@FaerieMUD.org>
+
+	* README.rdoc, Rakefile:
+	Update README, use Fivefish if available.
+	[4dcbdee767aa]
+
 2012-03-20  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgtags:
+	Added tag v1.8.6 for changeset 85858da99269
+	[e1a894f09484]
+
+	* .hgsigs:
+	Added signature for changeset 4b71de99d5fd
+	[85858da99269] [v1.8.6]
+
+	* History.rdoc, Rakefile, lib/treequel.rb:
+	Bump the patch version, update History.
+	[4b71de99d5fd]
+
 	* experiments/spec-profile-r408f5fadc4c5.graffle:
 	Add spec profile
-	[654ba9e47642] [github/master, tip]
+	[654ba9e47642] [github/master]
 
 	* .hgignore, Manifest.txt, Rakefile, lib/treequel/constants.rb,
 	lib/treequel/directory.rb, spec/lib/helpers.rb,

data/History.rdoc

@@ -1,3 +1,9 @@
+== v1.9.0 [2012-06-06] Michael Granger <ged@FaerieMUD.org>
+
+- Convert to Loggability for logging
+- Update README, use Fivefish if available.
+
+
 == v1.8.6 [2012-03-20] Michael Granger <ged@FaerieMUD.org>
 
 - Fix encoding of directory strings under Ruby 1.9 and newer versions

data/Manifest.txt

@@ -39,7 +39,6 @@ lib/treequel/schema/matchingruleuse.rb
 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

data/README.rdoc

@@ -1,19 +1,21 @@
-= Treequel - an honest LDAP library
+= Treequel
+
+home :: http://deveiate.org/projects/Treequel
+code :: http://repo.deveiate.org/Treequel
+docs :: http://deveiate.org/code/treequel
+github :: http://github.com/ged/treequel
 
-* http://deveiate.org/projects/Treequel
 
 == 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,
-free-form nature. 
+free-form nature.
 
 It's inspired by and modeled after {Sequel}[http://sequel.rubyforge.org/], a
 kick-ass database library.
 
 
-
-
 == Contributing
 
 You can check out the current development source
@@ -27,7 +29,7 @@ You can submit bug reports, suggestions, and read more about future plans at
 
 == License
 
-Copyright (c) 2008-2011, Michael Granger and Mahlon E. Smith
+Copyright (c) 2008-2012, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -55,7 +57,7 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-This software includes some code from the Sequel database toolkit, used under 
+This software includes some code from the Sequel database toolkit, used under
 the following license terms:
 
   Copyright (c) 2007-2008 Sharon Rosner

data/Rakefile

@@ -19,6 +19,7 @@ hoespec = Hoe.spec 'treequel' do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
+	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Treequel']
 
 	self.need_tar = true
 	self.need_zip = true
@@ -31,6 +32,8 @@ hoespec = Hoe.spec 'treequel' do
 	else
 		self.dependency 'ruby-ldap', '~> 0.9'
 	end
+	self.dependency 'loggability', '~> 0.4'
+
 	self.dependency 'rspec', '~> 2.8', :developer
 	self.dependency 'ruby-termios', '~> 0.9', :developer
 	self.dependency 'ruby-terminfo', '~> 0.1', :developer

data/lib/treequel.rb

@@ -4,7 +4,7 @@ require 'ldap'
 require 'ldap/schema'
 require 'ldap/control'
 
-require 'logger'
+require 'loggability'
 require 'pathname'
 
 require 'uri'
@@ -24,12 +24,18 @@ end
 
 # A library for interacting with LDAP modelled after Sequel[http://sequel.rubyforge.org/].
 module Treequel
+	extend Loggability
+
+
+	# Loggability API -- set up a Logger for all Treequel-related logging
+	log_as :treequel
+
 
 	# Library version
-	VERSION = '1.8.6'
+	VERSION = '1.9.0'
 
 	# VCS revision
-	REVISION = %q$Revision: 4b71de99d5fd $
+	REVISION = %q$Revision: 29134510ef85 $
 
 	# Common paths for ldap.conf
 	COMMON_LDAP_CONF_PATHS = %w[
@@ -60,58 +66,6 @@ module Treequel
 	end
 
 
-	#
-	# :section: Logging
-	#
-
-	# Log levels
-	LOG_LEVELS = {
-		'debug' => Logger::DEBUG,
-		'info'  => Logger::INFO,
-		'warn'  => Logger::WARN,
-		'error' => Logger::ERROR,
-		'fatal' => Logger::FATAL,
-	}.freeze
-	LOG_LEVEL_NAMES = LOG_LEVELS.invert.freeze
-
-	@default_logger = Logger.new( $stderr )
-	@default_logger.level = $DEBUG ? Logger::DEBUG : Logger::WARN
-
-	@default_log_formatter = Treequel::LogFormatter.new( @default_logger )
-	@default_logger.formatter = @default_log_formatter
-
-	@logger = @default_logger
-
-
-	class << self
-		# The log formatter that will be used when the logging subsystem is reset
-		attr_accessor :default_log_formatter
-
-		# The logger that will be used when the logging subsystem is reset
-		attr_accessor :default_logger
-
-		# The logger that's currently in effect
-		attr_accessor :logger
-		alias_method :log, :logger
-		alias_method :log=, :logger=
-	end
-
-
-	### Reset the global logger object to the default
-	def self::reset_logger
-		self.logger = self.default_logger
-		self.logger.level = Logger::WARN
-		self.logger.formatter = self.default_log_formatter
-	end
-
-
-	### Returns +true+ if the global logger has not been set to something other than
-	### the default one.
-	def self::using_default_logger?
-		return self.logger == self.default_logger
-	end
-
-
 	#
 	# :section:
 	#
@@ -318,6 +272,22 @@ module Treequel
 	end
 
 
+	### Reset the logger associated with Treequel. Backward-compatibility method.
+	def self::reset_logger
+		Treequel.logger = Treequel.default_logger
+		Treequel.logger.formatter = nil
+		Treequel.logger.output_to( $stderr )
+		Treequel.logger.level = :fatal
+	end
+
+
+	### Returns +true+ if the current logger for Treequel is the default one.
+	### Backward-compatibility method.
+	def self::using_default_logger?
+		return Loggability[ Treequel ] == Treequel.default_logger
+	end
+
+
 	# Now load the rest of the library
 	require 'treequel/exceptions'
 	require 'treequel/directory'

data/lib/treequel/branch.rb

@@ -15,15 +15,19 @@ require 'treequel/branchcollection'
 # for the entries below itself, and how to search for those entries.
 class Treequel::Branch
 	include Comparable,
-	        Treequel::Loggable,
 	        Treequel::Constants,
 	        Treequel::Constants::Patterns,
 	        Treequel::HashUtilities
 
-	extend Treequel::Delegation,
+	extend Loggability,
+	       Treequel::Delegation,
 	       Treequel::AttributeDeclarations
 
 
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
+
 	# The default width of LDIF output
 	DEFAULT_LDIF_WIDTH = 70
 

data/lib/treequel/branchcollection.rb

@@ -12,29 +12,33 @@ require 'treequel/branch'
 # A Treequel::BranchCollection is a union of Treequel::Branchset
 # objects, suitable for performing operations on multiple branches
 # of the directory at once.
-# 
+#
 # For example, if you have hosts under ou=Hosts in two different
 # subdomains (e.g., acme.com, seattle.acme.com, and newyork.acme.com),
 # and you want to search for a host by its CN, you could do so like
 # this:
-# 
+#
 #   # Top-level hosts, and those in the 'seattle' subdomain, but not
 #   # those in the 'newyork' subdomain:
 #   west_coast_hosts = dir.ou( :hosts ) + dir.dc( :seattle ).ou( :hosts )
 #   west_coast_www_hosts = west_coast_hosts.filter( :cn => 'www' )
-#   
+#
 #   # And one that includes hosts in all three DCs:
 #   all_hosts = west_coast_hosts + dir.dc( :newyork ).ou( :hosts )
 #   all_ns_hosts = all_hosts.filter( :cn => 'ns*' )
-# 
+#
 # Note that you could accomplish most of what BranchCollection does
 # using filters, but some people might find this a bit more readable.
 class Treequel::BranchCollection
 	include Enumerable,
-	        Treequel::Loggable,
 	        Treequel::Constants
 
-	extend Treequel::Delegation
+	extend Loggability,
+	       Treequel::Delegation
+
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
 
 
 	#################################################################

data/lib/treequel/branchset.rb

@@ -43,11 +43,14 @@ require 'treequel/control'
 # Branchsets are Enumerable objects, so they can be manipulated using any of the 
 # Enumerable methods, such as map, inject, etc.
 class Treequel::Branchset
+	extend Loggability
 	include Enumerable,
-	        Treequel::Loggable,
 	        Treequel::Constants,
 	        Treequel::Control
 
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
 	# The default scope to use when searching if none is specified
 	DEFAULT_SCOPE = :subtree
 	DEFAULT_SCOPE.freeze

data/lib/treequel/directory.rb

@@ -15,11 +15,15 @@ require 'treequel/branch'
 # The object in Treequel that represents a connection to a directory, the
 # binding to that directory, and the base from which all DNs start.
 class Treequel::Directory
-	include Treequel::Loggable,
-	        Treequel::Constants,
+	include Treequel::Constants,
 	        Treequel::HashUtilities
 
-	extend Treequel::Delegation
+	extend Loggability,
+	       Treequel::Delegation
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
 
 	# The default directory options
 	DEFAULT_OPTIONS = {
@@ -146,7 +150,7 @@ class Treequel::Directory
 	end
 
 
-	### Copy constructor -- the duplicate should have a distinct connection, bound user, 
+	### Copy constructor -- the duplicate should have a distinct connection, bound user,
 	### and should have a distinct copy of the +original+'s registered controls.
 	def initialize_copy( original )
 		@conn       = nil

data/lib/treequel/filter.rb

@@ -37,12 +37,20 @@ require 'treequel/sequel_integration'
 #   value      = AttributeValue from Section 4.1.6 of [1]
 # 
 class Treequel::Filter
-	include Treequel::Loggable,
-	        Treequel::Constants::Patterns
+	extend Loggability
+	include Treequel::Constants::Patterns
+
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
 
 	### Filter list component of a Treequel::Filter.
 	class FilterList
-		include Treequel::Loggable
+		extend Loggability
+
+		# Loggability API -- Log to the Treequel module's logger
+		log_to :treequel
 
 		### Create a new filter list with the given +filters+ in it.
 		def initialize( *filters )
@@ -75,11 +83,15 @@ class Treequel::Filter
 	### An abstract class for filter components.
 	### Subclass and override #to_s to implement a custom Component class.
 	class Component
-		include Treequel::Loggable
+		extend Loggability
+
+		# Loggability API -- Log to the Treequel module's logger
+		log_to :treequel
 
 		# Hide this class's new method
 		private_class_method :new
 
+
 		### Inherited hook: re-expose inheriting class's .new method
 		def self::inherited( klass )
 			klass.module_eval( 'public_class_method :new' )
@@ -323,7 +335,7 @@ class Treequel::Filter
 				raise Treequel::ExpressionError,
 					"unable to parse %p as a substring literal" % [ literal ]
 
-			Treequel.logger.debug "  parsed substring literal as: %p" % [ match.captures ]
+			self.log.debug "  parsed substring literal as: %p" % [ match.captures ]
 			return self.new( *(match.captures.values_at(1,3,2)) )
 		end
 
@@ -408,7 +420,7 @@ class Treequel::Filter
 	### Turn the specified filter +expression+ into a Treequel::Filter::Component
 	### object and return it.
 	def self::parse_expression( expression )
-		Treequel.logger.debug "Parsing expression %p" % [ expression ]
+		self.log.debug "Parsing expression %p" % [ expression ]
 		expression = expression[0] if expression.is_a?( Array ) && expression.length == 1
 
 		case expression
@@ -447,19 +459,19 @@ class Treequel::Filter
 	### Turn the specified expression Array into a Treequel::Filter::Component object
 	### and return it.
 	def self::parse_array_expression( expression )
-		Treequel.logger.debug "Parsing Array expression %p" % [ expression ]
+		self.log.debug "Parsing Array expression %p" % [ expression ]
 
 		case
 
 		# [ ] := '(objectClass=*)'
 		when expression.empty?
-			Treequel.logger.debug "  empty expression -> objectClass presence item component"
+			self.log.debug "  empty expression -> objectClass presence item component"
 			return Treequel::Filter::PresentItemComponent.new
 
 		# Collection of subfilters
 		# [ [:uid, 'mahlon'], [:employeeNumber, 20202] ]
 		when expression.all? {|elem| elem.is_a?(Array) }
-			Treequel.logger.debug "  parsing array of subfilters"
+			self.log.debug "  parsing array of subfilters"
 			filters = expression.collect {|exp| Treequel::Filter.new(exp) }
 			if filters.length > 1
 				return Treequel::Filter::AndComponent.new( filters )
@@ -494,22 +506,22 @@ class Treequel::Filter
 	### Parse one or more tuples contained in a Hash into an ANDed set of 
 	### Treequel::Filter::Components and return it.
 	def self::parse_hash_expression( expression )
-		Treequel.logger.debug "Parsing Hash expression %p" % [ expression ]
+		self.log.debug "Parsing Hash expression %p" % [ expression ]
 
 		filterlist = expression.collect do |key, expr|
-			Treequel.logger.debug "  adding %p => %p to the filter list" % [ key, expr ]
+			self.log.debug "  adding %p => %p to the filter list" % [ key, expr ]
 			if expr.respond_to?( :fetch )
 				if expr.respond_to?( :length ) && expr.length > 1
-					Treequel.logger.debug "    ORing together %d subfilters since %p has indices" %
+					self.log.debug "    ORing together %d subfilters since %p has indices" %
 						[ expr.length, expr ]
 					subfilters = expr.collect {|val| Treequel::Filter.new(key, val) }
 					Treequel::Filter.new( :or, subfilters )
 				else
-					Treequel.logger.debug "    unwrapping singular subfilter"
+					self.log.debug "    unwrapping singular subfilter"
 					Treequel::Filter.new([ key.to_sym, expr.first ])
 				end
 			else
-				Treequel.logger.debug "    value is a scalar; creating a single filter"
+				self.log.debug "    value is a scalar; creating a single filter"
 				Treequel::Filter.new( key.to_sym, expr )
 			end
 		end
@@ -525,7 +537,7 @@ class Treequel::Filter
 	### Parse a tuple of the form: [ Symbol, Object ] into a Treequel::Filter::Component
 	### and return it.
 	def self::parse_tuple_array_expression( expression )
-		Treequel.logger.debug "Parsing tuple Array expression %p" % [ expression ]
+		self.log.debug "Parsing tuple Array expression %p" % [ expression ]
 
 		case expression[1]
 
@@ -535,7 +547,7 @@ class Treequel::Filter
 			return self.parse_logical_array_expression( *expression )
 
 		when Range
-			Treequel.logger.debug "  two ANDed item expressions from a Range"
+			self.log.debug "  two ANDed item expressions from a Range"
 			attribute = expression[0]
 			range = expression[1]
 			left = "#{attribute}>=#{range.begin}"
@@ -545,7 +557,7 @@ class Treequel::Filter
 		# [ :attribute, 'value' ]  := '(attribute=value)'
 		# when String, Symbol, Numeric, Time
 		else
-			Treequel.logger.debug "  item expression from a %p" % [ expression[1].class ]
+			self.log.debug "  item expression from a %p" % [ expression[1].class ]
 			return self.parse_item_component( *expression )
 		end
 	end
@@ -554,7 +566,7 @@ class Treequel::Filter
 	### Break down the given +expression+ as a logical (AND, OR, or NOT)
 	### filter component and return it.
 	def self::parse_logical_array_expression( op, *components )
-		Treequel.logger.debug "Parsing logical %p expression with components: %p" %
+		self.log.debug "Parsing logical %p expression with components: %p" %
 			[ op, components ]
 
 		compclass = LOGICAL_COMPONENTS[ op ] or
@@ -562,7 +574,7 @@ class Treequel::Filter
 			 	[ op, LOGICAL_COMPONENTS.keys ]
 
 		filterlist = components.collect do |filterexp|
-			Treequel.logger.debug "  making %p into a component" % [ filterexp ]
+			self.log.debug "  making %p into a component" % [ filterexp ]
 			Treequel::Filter.new( filterexp )
 		end.flatten
 
@@ -572,7 +584,7 @@ class Treequel::Filter
 
 	### Parse an item component from the specified +attribute+ and +value+
 	def self::parse_item_component( attribute, value )
-		Treequel.logger.debug "  tuple expression (%p=%p)-> item component" %
+		self.log.debug "  tuple expression (%p=%p)-> item component" %
 			[ attribute, value ]
 
 		case
@@ -590,7 +602,7 @@ class Treequel::Filter
 
 	### Parse a Sequel::SQL::Expression as a Treequel::Filter::Component and return it.
 	def self::parse_sequel_expression( expression )
-		Treequel.logger.debug "  parsing Sequel expression: %p" % [ expression ]
+		self.log.debug "  parsing Sequel expression: %p" % [ expression ]
 
 		if expression.respond_to?( :op )
 			op = expression.op.to_s.downcase.to_sym
@@ -601,11 +613,11 @@ class Treequel::Filter
 				# Turn :sn.like( 'bob' ) into (cn~=bob) 'cause it has no asterisks
 				if op == :like 
 					if value.index( '*' )
-						Treequel.logger.debug \
+						self.log.debug \
 							"    turning a LIKE expression with an asterisk into a substring filter"
 						return Treequel::Filter::SubstringItemComponent.new( attribute, value )
 					else
-						Treequel.logger.debug \
+						self.log.debug \
 							"    turning a LIKE expression with no wildcards into an 'approx' filter"
 						equivalent = :approx
 					end
@@ -618,7 +630,7 @@ class Treequel::Filter
 				return Treequel::Filter::NotComponent.new( contents )
 
 			elsif op == :'not like'
-				Treequel.logger.debug "  making a NOT LIKE expression out of: %p" % [ expression ]
+				self.log.debug "  making a NOT LIKE expression out of: %p" % [ expression ]
 				attribute, value = *expression.args
 				component = nil