treequel 1.8.6 → 1.9.0

data/lib/treequel/mixins.rb

@@ -149,64 +149,11 @@ module Treequel
 	### Add logging to a Treequel class. Including classes get #log and #log_debug methods.
 	module Loggable
 
-		### A logging proxy class that wraps calls to the logger into calls that include
-		### the name of the calling class.
-		class ClassNameProxy
-
-			### Create a new proxy for the given +klass+.
-			def initialize( klass, force_debug=false )
-				@classname   = klass.name
-				@force_debug = force_debug
-			end
-
-			### Delegate debug messages to the global logger with the appropriate class name.
-			def debug( msg=nil, &block )
-				Treequel.logger.add( Logger::DEBUG, msg, @classname, &block )
-			end
-
-			### Delegate info messages to the global logger with the appropriate class name.
-			def info( msg=nil, &block )
-				return self.debug( msg, &block ) if @force_debug
-				Treequel.logger.add( Logger::INFO, msg, @classname, &block )
-			end
-
-			### Delegate warn messages to the global logger with the appropriate class name.
-			def warn( msg=nil, &block )
-				return self.debug( msg, &block ) if @force_debug
-				Treequel.logger.add( Logger::WARN, msg, @classname, &block )
-			end
-
-			### Delegate error messages to the global logger with the appropriate class name.
-			def error( msg=nil, &block )
-				return self.debug( msg, &block ) if @force_debug
-				Treequel.logger.add( Logger::ERROR, msg, @classname, &block )
-			end
-
-			### Delegate fatal messages to the global logger with the appropriate class name.
-			def fatal( msg=nil, &block )
-				Treequel.logger.add( Logger::FATAL, msg, @classname, &block )
-			end
-
-		end # ClassNameProxy
-
-		#########
-		protected
-		#########
-
-		### Copy constructor -- clear the original's log proxy.
-		def initialize_copy( original )
-			@log_proxy = @log_debug_proxy = nil
-			super
-		end
-
-		### Return the proxied logger.
-		def log
-			@log_proxy ||= ClassNameProxy.new( self.class )
-		end
-
-		### Return a proxied "debug" logger that ignores other level specification.
-		def log_debug
-			@log_debug_proxy ||= ClassNameProxy.new( self.class, true )
+		### Inclusion callback -- extend including modules with Loggability instead for
+		### backward-compatibility.
+		def self::included( mod )
+			mod.extend( Loggability )
+			mod.log_to( :treequel )
 		end
 
 	end # module Loggable

data/lib/treequel/model.rb

@@ -10,17 +10,22 @@ require 'treequel/branchset'
 
 # An object interface to LDAP entries.
 class Treequel::Model < Treequel::Branch
+	extend Loggability
+
 	require 'treequel/model/objectclass'
 	require 'treequel/model/errors'
 	require 'treequel/model/schemavalidations'
 
-	include Treequel::Loggable,
-	        Treequel::Constants,
+	include Treequel::Constants,
 	        Treequel::Normalization,
 	        Treequel::Constants::Patterns,
 	        Treequel::Model::SchemaValidations
 
 
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
+
 	# A prototype Hash that autovivifies its members as Sets, for use in
 	# the objectclass_registry and the base_registry
 	SET_HASH = Hash.new {|h,k| h[k] = Set.new }

data/lib/treequel/model/errors.rb

@@ -33,8 +33,12 @@ require 'treequel/constants'
 #     CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 # 
 class Treequel::Model::Errors < ::Hash
-	include Treequel::HashUtilities,
-	        Treequel::Loggable
+	extend Loggability
+	include Treequel::HashUtilities
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
 
 	# The word to use between attributes in error messages
 	ATTRIBUTE_CONJUNCTION = ' and '

data/lib/treequel/schema.rb

@@ -22,8 +22,11 @@ require 'treequel/mixins'
 # Please see the file LICENSE in the base directory for licensing details.
 #
 class Treequel::Schema
-	include Treequel::Loggable,
-	        Treequel::Constants::Patterns
+	extend Loggability
+	include Treequel::Constants::Patterns
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
 
 	require 'treequel/schema/table'
 	require 'treequel/schema/objectclass'

data/lib/treequel/schema/attributetype.rb

@@ -22,11 +22,15 @@ require 'treequel/exceptions'
 # Please see the file LICENSE in the base directory for licensing details.
 #
 class Treequel::Schema::AttributeType
-	include Treequel::Loggable,
-	        Treequel::Normalization,
+	include Treequel::Normalization,
 	        Treequel::Constants::Patterns
 
-	extend Treequel::AttributeDeclarations
+	extend Loggability,
+	       Treequel::AttributeDeclarations
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
 
 	# Regex for splitting a syntax OID from its length specifier
 	OID_SPLIT_PATTERN = /

data/lib/treequel/schema/ldapsyntax.rb

@@ -10,10 +10,13 @@ require 'treequel/exceptions'
 
 # This is a class for representing ldapSyntax declarations in a Treequel::Schema.
 class Treequel::Schema::LDAPSyntax
-	include Treequel::Loggable,
-	        Treequel::Constants::Patterns
+	include Treequel::Constants::Patterns
+	extend Loggability,
+	       Treequel::AttributeDeclarations
 
-	extend Treequel::AttributeDeclarations
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
 
 
 	#############################################################

data/lib/treequel/schema/matchingrule.rb

@@ -10,10 +10,13 @@ require 'treequel/exceptions'
 
 # This is a class for representing matchingRule declarations in a Treequel::Schema.
 class Treequel::Schema::MatchingRule
-	include Treequel::Loggable,
-	        Treequel::Constants::Patterns
+	include Treequel::Constants::Patterns
+	extend Loggability,
+	       Treequel::AttributeDeclarations
 
-	extend Treequel::AttributeDeclarations
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
 
 
 	#############################################################

data/lib/treequel/schema/matchingruleuse.rb

@@ -10,10 +10,14 @@ require 'treequel/exceptions'
 
 # This is a class for representing matchingRuleUse declarations in a Treequel::Schema.
 class Treequel::Schema::MatchingRuleUse
-	include Treequel::Loggable,
-	        Treequel::Constants::Patterns
+	include Treequel::Constants::Patterns
 
-	extend Treequel::AttributeDeclarations
+	extend Loggability,
+	       Treequel::AttributeDeclarations
+
+
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
 
 
 	#############################################################

data/lib/treequel/schema/objectclass.rb

@@ -29,12 +29,17 @@ class Treequel::Schema
 
 	### objectClass entries in a Treequel::Schema.
 	class ObjectClass
-		include Treequel::Loggable,
-		        Treequel::Constants::Patterns
+		include Treequel::Constants::Patterns
 
-		extend Treequel::AttributeDeclarations
+		extend Loggability,
+		       Treequel::AttributeDeclarations
 
 
+		# Loggability API -- Log to the Treequel module's logger
+		log_to :treequel
+
+
+		# Hide the constructor
 		private_class_method :new
 
 		# The 'kind' of objectClasses which don't specify a 'kind' explicitly

data/lib/treequel/schema/table.rb

@@ -12,12 +12,16 @@ require 'treequel/mixins'
 # This is an object that is used to store LDAP schema information in a 
 # case-insensitive table.
 class Treequel::Schema::Table
-	extend Forwardable
+	extend Forwardable,
+	       Loggability
 	include Enumerable,
-	        Treequel::Loggable,
 	        Treequel::Normalization,
 	        Treequel::Constants::Patterns
 
+	# Loggability API -- Log to the Treequel module's logger
+	log_to :treequel
+
+
 	# The list of methods that should be delegated through the key-normalization
 	# method.
 	KEYED_METHODS = [ :"[]", :"[]=", :delete, :fetch, :key?, :has_key?, :include?,

data/spec/lib/helpers.rb

@@ -28,73 +28,13 @@ require 'treequel'
 require 'spec/lib/constants'
 require 'spec/lib/matchers'
 
-### IRb.start_session, courtesy of Joel VanderWerf in [ruby-talk:42437].
-require 'irb'
-require 'irb/completion'
-
-module IRB # :nodoc:
-	def self.start_session( obj )
-		unless @__initialized
-			args = ARGV
-			ARGV.replace( ARGV.dup )
-			IRB.setup( nil )
-			ARGV.replace( args )
-			@__initialized = true
-		end
-
-		workspace = WorkSpace.new( obj )
-		irb = Irb.new( workspace )
-
-		@CONF[:IRB_RC].call( irb.context ) if @CONF[:IRB_RC]
-		@CONF[:MAIN_CONTEXT] = irb.context
-
-		begin
-			prevhandler = Signal.trap( 'INT' ) do
-				irb.signal_handle
-			end
-
-			catch( :IRB_EXIT ) do
-				irb.eval_input
-			end
-		ensure
-			Signal.trap( 'INT', prevhandler )
-		end
-
-	end
-end
+require 'loggability/spechelpers'
 
 
 ### RSpec helper functions.
 module Treequel::SpecHelpers
 	include Treequel::TestConstants
 
-	class ArrayLogger
-		### Create a new ArrayLogger that will append content to +array+.
-		def initialize( array )
-			@array = array
-		end
-
-		### Write the specified +message+ to the array.
-		def write( message )
-			@array << message
-		end
-
-		### No-op -- this is here just so Logger doesn't complain
-		def close; end
-
-	end # class ArrayLogger
-
-
-	unless defined?( LEVEL )
-		LEVEL = {
-			:debug => Logger::DEBUG,
-			:info  => Logger::INFO,
-			:warn  => Logger::WARN,
-			:error => Logger::ERROR,
-			:fatal => Logger::FATAL,
-		  }
-	end
-
 	###############
 	module_function
 	###############
@@ -105,35 +45,6 @@ module Treequel::SpecHelpers
 	end
 
 
-	### Reset the logging subsystem to its default state.
-	def reset_logging
-		Treequel.reset_logger
-	end
-
-
-	### Alter the output of the default log formatter to be pretty in SpecMate output
-	def setup_logging( level=Logger::FATAL )
-
-		# Turn symbol-style level config into Logger's expected Fixnum level
-		if Treequel::LOG_LEVELS.key?( level.to_s )
-			level = Treequel::LOG_LEVELS[ level.to_s ]
-		end
-
-		logger = Logger.new( $stderr )
-		Treequel.logger = logger
-		Treequel.logger.level = level
-
-		# Only do this when executing from a spec in TextMate
-		if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
-			Thread.current['logger-output'] = []
-			logdevice = ArrayLogger.new( Thread.current['logger-output'] )
-			Treequel.logger = Logger.new( logdevice )
-			# Treequel.logger.level = level
-			Treequel.logger.formatter = Treequel::HtmlLogFormatter.new( logger )
-		end
-	end
-
-
 	### Make a Treequel::Directory that will use the given +conn+ object as its
 	### LDAP connection. Also pre-loads the schema object and fixtures some other
 	### external data.
@@ -176,7 +87,8 @@ abort "You need a version of RSpec >= 2.6.0" unless defined?( RSpec )
 
 ### Mock with RSpec
 RSpec.configure do |c|
-	include Treequel::TestConstants
+	include Treequel::TestConstants,
+	        Loggability::SpecHelpers
 
 	c.mock_with :rspec
 
@@ -185,6 +97,7 @@ RSpec.configure do |c|
 	c.include( Treequel::TestConstants )
 	c.include( Treequel::SpecHelpers )
 	c.include( Treequel::Matchers )
+	c.include( Loggability::SpecHelpers )
 
 	c.treat_symbols_as_metadata_keys_with_true_values = true
 

data/spec/treequel/directory_spec.rb

@@ -150,15 +150,8 @@ describe Treequel::Directory do
 	describe "instances with a connection" do
 
 		before( :each ) do
-			@conn = mock( "ldap connection", :bound? => false )
-
-			@dir = Treequel::Directory.new( @options )
+			@dir = Treequel.directory( TEST_LDAPURI )
 			@dir.instance_variable_set( :@conn, @conn )
-
-			@schema = mock( "Directory schema" )
-			@conn.stub( :schema ).and_return( :the_schema )
-			Treequel::Schema.stub( :new ).with( :the_schema ).and_return( @schema )
-			@schema.stub( :attribute_types ).and_return({ :cn => :a_value, :ou => :a_value })
 		end
 
 		it "can bind with the given user DN and password" do
@@ -359,7 +352,7 @@ describe Treequel::Directory do
 			@conn.stub( :search_ext2 ).and_raise( LDAP::ResultError.new("Can't contact LDAP server") )
 
 			second_conn = mock( "LDAP connection", :set_option => true, :bound? => false )
-			LDAP::Conn.should_receive( :new ).and_return( second_conn )
+			LDAP::SSLConn.should_receive( :new ).and_return( second_conn )
 			second_conn.should_receive( :search_ext2 ).and_return([])
 
 			already_tried_reconnect = false
@@ -374,7 +367,7 @@ describe Treequel::Directory do
 		end
 
 		it "re-raises an exception rescued during a reconnect as a RuntimeError" do
-			LDAP::Conn.should_receive( :new ).
+			LDAP::SSLConn.should_receive( :new ).
 				and_raise( LDAP::ResultError.new("Can't contact LDAP server") )
 
 			expect {
@@ -384,6 +377,10 @@ describe Treequel::Directory do
 
 
 		it "doesn't retain its connection when duplicated" do
+			LDAP::SSLConn.stub( :new ).and_return do
+				mock( "LDAP connection", :set_option => true, :bound? => false )
+			end
+
 			@dir.dup.conn.should_not equal( @dir.conn )
 		end
 
@@ -469,25 +466,15 @@ describe Treequel::Directory do
 		end
 
 		it "can fetch the server's schema" do
-			@conn.should_receive( :schema ).and_return( :the_schema )
-			Treequel::Schema.should_receive( :new ).with( :the_schema ).
-				and_return( :the_parsed_schema )
-			@dir.schema.should == :the_parsed_schema
+			@dir.schema.should be_a( Treequel::Schema )
 		end
 
 		it "creates branches for messages that match valid attributeType OIDs" do
-			@schema.should_receive( :attribute_types ).
-				and_return({ :cn => :a_value, :ou => :a_value })
-
-			@dir.stub( :bound? ).and_return( false )
 			rval = @dir.ou( :people )
 			rval.dn.downcase.should == TEST_PEOPLE_DN.downcase
 		end
 
 		it "doesn't create branches for messages that don't match valid attributeType OIDs" do
-			@schema.should_receive( :attribute_types ).
-				and_return({ :cn => :a_value, :ou => :a_value })
-
 			expect { @dir.void('sbc') }.to raise_error( NoMethodError )
 		end
 

data/spec/treequel/mixins_spec.rb

@@ -32,8 +32,9 @@ describe Treequel, "mixin" do
 
 	describe Treequel::Loggable, "mixed into a class" do
 		before(:each) do
-			@logfile = StringIO.new('')
-			Treequel.logger = Logger.new( @logfile )
+			@log_output = []
+			Treequel.logger.output_to( @log_output )
+			Treequel.logger.level = :debug
 
 			@test_class = Class.new do
 				include Treequel::Loggable
@@ -41,10 +42,6 @@ describe Treequel, "mixin" do
 				def log_test_message( level, msg )
 					self.log.send( level, msg )
 				end
-
-				def logdebug_test_message( msg )
-					self.log_debug.debug( msg )
-				end
 			end
 			@obj = @test_class.new
 		end
@@ -52,14 +49,7 @@ describe Treequel, "mixin" do
 
 		it "is able to output to the log via its #log method" do
 			@obj.log_test_message( :debug, "debugging message" )
-			@logfile.rewind
-			@logfile.read.should =~ /debugging message/
-		end
-
-		it "is able to output to the log via its #log_debug method" do
-			@obj.logdebug_test_message( "sexydrownwatch" )
-			@logfile.rewind
-			@logfile.read.should =~ /sexydrownwatch/
+			@log_output.last.should =~ /debugging message/i
 		end
 	end