treequel 1.0.1 → 1.0.4

data/lib/treequel/schema/matchingrule.rb

@@ -9,17 +9,6 @@ require 'treequel/exceptions'
 
 
 # This is a class for representing matchingRule declarations in a Treequel::Schema.
-# 
-# == Authors
-# 
-# * Michael Granger <ged@FaerieMUD.org>
-# 
-# :include: LICENSE
-#
-#--
-#
-# Please see the file LICENSE in the base directory for licensing details.
-#
 class Treequel::Schema::MatchingRule
 	include Treequel::Loggable,
 	        Treequel::Constants::Patterns

data/lib/treequel/schema/matchingruleuse.rb

@@ -9,17 +9,6 @@ require 'treequel/exceptions'
 
 
 # This is a class for representing matchingRuleUse declarations in a Treequel::Schema.
-# 
-# == Authors
-# 
-# * Michael Granger <ged@FaerieMUD.org>
-# 
-# :include: LICENSE
-#
-#--
-#
-# Please see the file LICENSE in the base directory for licensing details.
-#
 class Treequel::Schema::MatchingRuleUse
 	include Treequel::Loggable,
 	        Treequel::Constants::Patterns

data/lib/treequel/schema/objectclass.rb

@@ -123,12 +123,6 @@ class Treequel::Schema
 		# The name of the objectClass's superior class (if specified)
 		attr_accessor :sup_name
 
-		# The Array of the objectClass's MUST OIDs
-		attr_reader :must_oids
-
-		# The Array of the objectClass's MAY OIDs
-		attr_reader :may_oids
-
 		# The objectClass's extensions (as a String)
 		attr_accessor :extensions
 
@@ -139,10 +133,26 @@ class Treequel::Schema
 		end
 
 
+		### Return the objectClass's MUST OIDs as Symbols (for symbolic OIDs) or Strings (for
+		### dotted-numeric OIDs).
+		### @param [Boolean] include_sup  (true) include MUST OIDs inherited from the 
+		###                               objectClass's SUP, if it has one.
+		### @return [Array<Symbol,String>] the objectClass's MUST OIDs
+		def must_oids( include_sup=true )
+			oids = @must_oids.dup
+
+			if include_sup && superclass = self.sup
+				oids.unshift( *superclass.must_oids )
+			end
+
+			return oids.flatten
+		end
+
+
 		### Return Treequel::Schema::AttributeType objects for each of the objectClass's
 		### MUST attributes.
-		def must
-			self.must_oids.collect do |oid|
+		def must( include_sup=true )
+			self.must_oids( include_sup ).collect do |oid|
 				self.log.warn "No attribute type for OID %p (case bug?)" % [ oid ] unless
 					self.schema.attribute_types.key?( oid )
 				self.schema.attribute_types[oid]
@@ -150,10 +160,26 @@ class Treequel::Schema
 		end
 
 
+		### Return the objectClass's MAY OIDs as Symbols (for symbolic OIDs) or Strings (for
+		### dotted-numeric OIDs).
+		### @param [Boolean] include_sup  (true) include MAY OIDs inherited from the 
+		###                               objectClass's SUP, if it has one.
+		### @return [Array<Symbol,String>] the objectClass's MAY OIDs
+		def may_oids( include_sup=true )
+			oids = @may_oids.dup
+
+			if include_sup && superclass = self.sup
+				oids.unshift( *superclass.may_oids )
+			end
+
+			return oids.flatten
+		end
+
+
 		### Return Treequel::Schema::AttributeType objects for each of the objectClass's
 		### MAY attributes.
-		def may
-			self.may_oids.collect do |oid|
+		def may( include_sup=true )
+			self.may_oids( include_sup ).collect do |oid|
 				self.log.warn "No attribute type for OID %p (case bug?)" % [ oid ] unless
 					self.schema.attribute_types.key?( oid )
 				self.schema.attribute_types[oid]

data/lib/treequel/schema/table.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+
+require 'forwardable'
+require 'ldap'
+require 'ldap/schema'
+
+require 'treequel'
+require 'treequel/constants'
+require 'treequel/mixins'
+
+
+# This is an object that is used to store LDAP schema information in a 
+# case-insensitive table.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# * Mahlon E. Smith <mahlon@martini.nu>
+# 
+# :include: LICENSE
+#
+#--
+#
+# Please see the file LICENSE in the base directory for licensing details.
+#
+class Treequel::Schema::Table
+	extend Forwardable
+	include Treequel::Loggable,
+	        Treequel::Normalization,
+	        Treequel::Constants::Patterns
+
+	# The list of methods that should be delegated through the key-normalization
+	# method.
+	KEYED_METHODS = [ :"[]", :"[]=", :delete, :fetch, :key?, :has_key?, :include?, 
+		:member?, :store ]
+
+
+	### Auto-generate methods which call the given +delegate+ after normalizing
+	### their first argument via +normalize_key+
+	def self::def_normalized_delegators( delegate, *syms )
+		syms.each do |methodname|
+			define_method( methodname ) do |key, *args|
+				nkey = normalize_key( key )
+				instance_variable_get( delegate ).
+					__send__( methodname, nkey, *args )
+			end
+		end
+	end
+
+
+	### Create a new Treequel::Table using the given +hash+ for initial
+	### values.
+	def initialize( initial_values={} )
+		@hash = {}
+		initial_values.each {|k,v| self.append(k => v) }
+	end
+
+
+	### Make sure +@hash+ is unique on Table duplications.
+	def initialize_copy( orig_table ) # :nodoc:
+		@hash = orig_table.to_hash
+	end
+
+
+	######
+	public
+	######
+
+	# Delegate a handful of methods to the underlying Hash after normalizing
+	# the key.
+	def_normalized_delegators :@hash, *KEYED_METHODS
+
+
+	# Delegate some methods to the underlying Hash
+	begin
+		unoverridden_methods = Hash.instance_methods(false).collect {|mname| mname.to_sym }
+		def_delegators :@hash, *( unoverridden_methods - KEYED_METHODS )
+	end
+
+
+	### Return the Table in LDIF format
+	def to_s
+		@hash.collect do |oid,value|
+			"%s: %s" % [ oid, value ]
+		end.flatten.sort.join( "\r\n" ) + "\r\n"
+	end
+
+
+	### Return the Table as a hash.
+	def to_h
+		@hash.dup
+	end
+	alias_method :to_hash, :to_h
+
+
+	### Merge +other_table+ into the receiver.
+	def merge!( other_table, &merge_callback )
+		nhash = normalize_hash( other_table.to_hash )
+		@hash.merge!( nhash, &merge_callback )
+	end
+	alias_method :update!, :merge!
+
+
+	### Return a new table which is the result of merging the receiver
+	### with +other_table+ in the same fashion as Hash#merge. If the optional
+	### +merge_callback+ block is provided, it is called whenever there is a
+	### key collision between the two.
+	def merge( other_table, &merge_callback ) # :yields: key, original_value, new_value
+		other = self.dup
+		other.merge!( other_table, &merge_callback )
+		return other
+	end
+	alias_method :update, :merge
+
+
+	### Return an array containing the values associated with the given
+	### keys.
+	def values_at( *keys )
+		@hash.values_at( *(keys.collect {|k| normalize_key(k)}) )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Proxy method: handle getting/setting headers via methods instead of the
+	### index operator.
+	def method_missing( sym, *args )
+		# work magic
+		return super unless sym.to_s =~ /^([a-z]\w+)(=)?$/
+
+		# If it's an assignment, the (=)? will have matched
+		key, assignment = $1, $2
+
+		method_body = nil
+		if assignment
+			method_body = self.make_setter( key )
+		else
+			method_body = self.make_getter( key )
+		end
+
+		self.class.send( :define_method, sym, &method_body )
+		return self.method( sym ).call( *args )
+	end
+
+
+	### Create a Proc that will act as a setter for the given key
+	def make_setter( key )
+		return Proc.new {|new_value| self[ key ] = new_value }
+	end
+
+
+	### Create a Proc that will act as a getter for the given key
+	def make_getter( key )
+		return Proc.new { self[key] }
+	end
+
+end # class Treequel::Schema::Table

data/lib/treequel/sequel_integration.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'treequel' 
+require 'treequel'
 require 'treequel/filter'
 
 begin
@@ -9,15 +9,15 @@ rescue LoadError => err
 	Treequel.logger.info "Sequel library didn't load: %s: %s" % [ err.class.name, err.message ]
 	Treequel.logger.debug "  " + err.backtrace.join( "\n  " )
 end
-	
 
-# Provide a dummy Sequel::SQL::Expression class for when the Sequel library
-# isn't installed.
-unless defined?( Sequel ) && 
-	Sequel.const_defined?( :SQL ) && 
+
+unless defined?( Sequel ) &&
+	Sequel.const_defined?( :SQL ) &&
 	Sequel::SQL.const_defined?( :Expression )
 
-	module Sequel # :nodoc: all
+	# Provide a dummy Sequel::SQL::Expression class for when the Sequel library
+	# isn't installed.
+	module Sequel
 		module SQL
 			class Expression; end
 		end

data/lib/treequel/utils.rb

@@ -9,30 +9,10 @@ require 'treequel'
 require 'treequel/mixins'
 
 
-module Treequel # :nodoc:
+module Treequel
 
-	# 
 	# A alternate formatter for Logger instances.
-	# 
-	# == Usage
-	# 
-	#   require 'treequel/utils'
-	#   Treequel.logger.formatter = Treequel::LogFormatter.new( Treequel.logger )
-	# 
-	# == Version
-	#
-	#  $Id$
-	#
-	# == Authors
-	#
-	# * Michael Granger <ged@FaerieMUD.org>
-	#
-	# :include: LICENSE
-	#
-	#--
-	#
-	# Please see the file LICENSE in the 'docs' directory for licensing details.
-	#
+	# @private
 	class LogFormatter < Logger::Formatter
 
 		# The format to output unless debugging is turned on
@@ -87,28 +67,8 @@ module Treequel # :nodoc:
 	end # class LogFormatter
 
 
-	# 
 	# A ANSI-colorized formatter for Logger instances.
-	# 
-	# == Usage
-	# 
-	#   require 'treequel/utils'
-	#   Treequel.logger.formatter = Treequel::ColorLogFormatter.new( Treequel.logger )
-	# 
-	# == Version
-	#
-	#  $Id$
-	#
-	# == Authors
-	#
-	# * Michael Granger <ged@FaerieMUD.org>
-	#
-	# :include: LICENSE
-	#
-	#--
-	#
-	# Please see the file LICENSE in the 'docs' directory for licensing details.
-	#
+	# @private
 	class ColorLogFormatter < Logger::Formatter
 		extend Treequel::ANSIColorUtilities
 
@@ -160,31 +120,9 @@ module Treequel # :nodoc:
 	end # class LogFormatter
 
 
-	
-
-	# 
 	# An alternate formatter for Logger instances that outputs +div+ HTML
 	# fragments.
-	# 
-	# == Usage
-	# 
-	#   require 'treequel/utils'
-	#   Treequel.logger.formatter = Treequel::HtmlLogFormatter.new( Treequel.logger )
-	# 
-	# == Version
-	#
-	#  $Id$
-	#
-	# == Authors
-	#
-	# * Michael Granger <ged@FaerieMUD.org>
-	#
-	# :include: LICENSE
-	#
-	#--
-	#
-	# Please see the file LICENSE in the 'docs' directory for licensing details.
-	#
+	# @private
 	class HtmlLogFormatter < Logger::Formatter
 		include ERB::Util  # for html_escape()
 

data/rake/documentation.rb

@@ -0,0 +1,89 @@
+# 
+# Documentation Rake tasks
+# 
+
+require 'rake/clean'
+
+
+# Append docs/lib to the load path if it exists for documentation
+# helpers.
+DOCSLIB = DOCSDIR + 'lib'
+$LOAD_PATH.unshift( DOCSLIB.to_s ) if DOCSLIB.exist?
+
+# Make relative string paths of all the stuff we need to generate docs for
+DOCFILES = Rake::FileList[ LIB_FILES + EXT_FILES + GEMSPEC.extra_rdoc_files ]
+
+# Documentation coverage constants
+COVERAGE_DIR    = BASEDIR + 'coverage'
+COVERAGE_REPORT = COVERAGE_DIR + 'documentation.txt'
+
+
+# Prefer YARD, fallback to RDoc
+begin
+	require 'yard'
+	require 'yard/rake/yardoc_task'
+
+	# Undo the lazy-assed monkeypatch yard/globals.rb installs and
+	# re-install them as mixins as they should have been from the
+	# start
+	# <metamonkeypatch>
+	class Object
+		remove_method :log
+		remove_method :P
+	end
+
+	module YardGlobals
+		def P(namespace, name = nil)
+			namespace, name = nil, namespace if name.nil?
+			YARD::Registry.resolve(namespace, name, false, true)
+		end
+
+		def log
+			YARD::Logger.instance
+		end
+	end
+
+	class YARD::CLI::Base; include YardGlobals; end
+	class YARD::Parser::SourceParser; extend YardGlobals; include YardGlobals; end
+	class YARD::Parser::CParser; include YardGlobals; end
+	class YARD::CodeObjects::Base; include YardGlobals; end
+	class YARD::Handlers::Base; include YardGlobals; end
+	class YARD::Handlers::Processor; include YardGlobals; end
+	class YARD::Serializers::Base; include YardGlobals; end
+	class YARD::RegistryStore; include YardGlobals; end
+	class YARD::Docstring; include YardGlobals; end
+	module YARD::Templates::Helpers::ModuleHelper; include YardGlobals; end
+	# </metamonkeypatch>
+
+	YARD_OPTIONS = [] unless defined?( YARD_OPTIONS )
+
+	yardoctask = YARD::Rake::YardocTask.new( :apidocs ) do |task|
+		task.files   = DOCFILES
+		task.options = YARD_OPTIONS
+		task.options << '--debug' << '--verbose' if $trace
+	end
+	yardoctask.before = lambda {
+		trace "Calling yardoc like:",
+			"  yardoc %s" % [ quotelist(yardoctask.options + yardoctask.files).join(' ') ]
+	}
+
+	YARDOC_CACHE = BASEDIR + '.yardoc'
+	CLOBBER.include( YARDOC_CACHE.to_s )
+
+rescue LoadError
+	require 'rdoc/task'
+
+	desc "Build API documentation in #{API_DOCSDIR}"
+	RDoc::Task.new( :apidocs ) do |task|
+		task.main     = "README"
+		task.rdoc_files.include( DOCFILES )
+		task.rdoc_dir = API_DOCSDIR.to_s
+		task.options  = RDOC_OPTIONS
+	end
+end
+
+# Need the DOCFILES to exist to build the API docs
+task :apidocs => DOCFILES
+
+CLEAN.include( API_DOCSDIR.to_s )
+