treequel 1.5.2 → 1.5.3

data.tar.gz.sig

@@ -1 +1,3 @@
-&xSq�e���Z.�s����^�(�ʫ��Evm�D리��W�[���6��~�L�U�\�S�Ll4�W��L`W~��.y��<<���^_��ZI�<�2j2�}qCM�+V�n�>i-
��g���L`�i�G��+����K �šʺ[(g�?R���`�8i�I,�x�#���U����yo�I�!���R!���{��'��F����\n�!vOUk�����.��yG��}��Hc���guP�۷3�)���:�N�5.(��]1
+,�D�P�(�
��$i���
+�f�V/6_�T�O�m�)����=�f@$��9����.@ڲZ#z�o
+��e�=��N�Vp��,����Ԟ�����눣�nj1V�0�uK��c��4)���C�s�	�����ٕ�/��-���i�)�E��Y��4�g�.�(Z%m?{�:<8�&��-A_$.k׼!�g�MJ�RV��b]��ZMv��
��_ǚ��$5�u�o�9a8�RE������;ê

data/History.md

@@ -1,3 +1,13 @@
+## 1.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
+* Updated the 'treewhat' schema tool.
+* Show additional details for some schema objects.
+* Adding schema artifacts to the treewhat command
+* 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>
 
 * Manual updates

data/Rakefile

@@ -4,6 +4,7 @@ require 'hoe'
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
+Hoe.plugin :yard
 Hoe.plugin :manualgen
 
 Hoe.plugins.delete :rubyforge
@@ -58,45 +59,3 @@ ENV['VERSION'] ||= hoespec.spec.version.to_s
 # Tests use RSpec
 task :test => :spec
 
-begin
-	include Hoe::MercurialHelpers
-
-	task 'hg:precheckin' => :spec
-
-	### Task: prerelease
-	desc "Append the package build number to package versions"
-	task :pre do
-		rev = get_numeric_rev()
-		trace "Current rev is: %p" % [ rev ]
-		hoespec.spec.version.version << "pre#{rev}"
-		Rake::Task[:gem].clear
-
-		Gem::PackageTask.new( hoespec.spec ) do |pkg|
-			pkg.need_zip = true
-			pkg.need_tar = true
-		end
-	end
-
-	### 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'
-
-rescue NameError => err
-	task :no_hg_helpers do
-		fail "Couldn't define the :pre task: %s: %s" % [ err.class.name, err.message ]
-	end
-
-	task :pre => :no_hg_helpers
-	task 'ChangeLog' => :no_hg_helpers
-
-end
-

data/bin/treequel

@@ -42,7 +42,7 @@ module IRB # :nodoc:
 	def self.start_session( obj )
 		unless @__initialized
 			args = ARGV
-			ARGV.replace( ARGV.dup )
+			ARGV.replace( [] )
 			IRB.setup( nil )
 			ARGV.replace( args )
 			@__initialized = true
@@ -116,10 +116,12 @@ class Treequel::Shell
 	### Run the shell.
 	def self::run( args )
 		Treequel.logger.formatter = Treequel::ColorLogFormatter.new( Treequel.logger )
-		bind_as, uri = self.parse_options( args )
+		bind_as, plaintext, uri = self.parse_options( args )
+
+		connect_type = plaintext ? :plain : :tls
 
 		directory = if uri
-			Treequel.directory( uri )
+			Treequel.directory( uri, :connect_type => connect_type )
 		else
 			Treequel.directory_from_config
 		end
@@ -137,6 +139,7 @@ class Treequel::Shell
 			collect {|name,lvl| name.to_s }.
 			join(', ')
 		bind_as = nil
+		plaintext = false
 
 		oparser = OptionParser.new( "Usage: #{progname} [OPTIONS] [LDAPURL]" ) do |oparser|
 			oparser.separator ' '
@@ -145,6 +148,11 @@ class Treequel::Shell
 				bind_as = dn
 			end
 
+			oparser.on( '--no-tls', FalseClass, "Use a plaintext (unencrypted) connection.",
+			 	"If you don't specify a connection URL, this option is ignored." ) do
+				plaintext = true
+			end
+
 			oparser.on( '--loglevel=LEVEL', '-l LEVEL', Treequel::LOG_LEVELS.keys,
 				"Set the logging level. Should be one of:", loglevels ) do |lvl|
 				Treequel.logger.level = Treequel::LOG_LEVELS[ lvl ] or
@@ -165,7 +173,7 @@ class Treequel::Shell
 
 		remaining_args = oparser.parse( argv )
 
-		return bind_as, *remaining_args
+		return bind_as, plaintext, *remaining_args
 	end
 
 
@@ -338,21 +346,6 @@ class Treequel::Shell
 	protected
 	#########
 
-	### Fetch a Treequel::Directory object for the directory at the given +uri+, or
-	### quit with an error if unable to do so.
-	def get_ldap_directory( uri, options )
-		if uri.port == LDAP::LDAP_PORT
-			if options.try_tls
-				return Treequel.directory( uri, :connect_type => :tls )
-			else
-				return Treequel.directory( uri, :connect_type => :plain )
-			end
-		else
-			return Treequel.directory( uri, :connect_type => :ssl )
-		end
-	end
-
-
 	### Set up Readline completion
 	def setup_completion
 		Readline.completion_proc = self.method( :completion_callback ).to_proc

data/bin/treewhat

@@ -79,9 +79,21 @@ class Treequel::What
 			     %{output instead.}
 			text ''
 
-			text 'Options:'
+			text 'Connection Options:'
 			opt :ldapurl, "Specify the directory to connect to.",
 				:default => default_directory.uri.to_s
+			text ''
+
+			text 'Display Options:'
+			opt :attrtypes, "Show attribute types for objects that have them."
+			opt :objectclasses, "Show objectclasses for objects that have them."
+			opt :syntaxes, "Show syntaxes for objects that have them."
+			opt :matching_rules, "Show matching rules for objects that have them."
+			opt :matching_rule_uses, "Show matching rule uses for objects that have them."
+			opt :all, "Show any of the above that are applicable."
+			text ''
+
+			text 'Other Options:'
 			opt :debug, "Turn debugging on. Also sets the --loglevel to 'debug'."
 			opt :loglevel, "Set the logging level. Must be one of: #{loglevels}",
 				:default => Treequel::LOG_LEVEL_NAMES[ Treequel.logger.level ]
@@ -109,8 +121,19 @@ class Treequel::What
 		end
 
 		@options   = options
-		@prompt    = HighLine.new
+		if @options.all?
+			@options[:attrtypes] =
+				@options[:objectclasses] =
+				@options[:syntaxes] =
+				@options[:matching_rules] =
+				@options[:matching_rule_uses] =
+				true
+		end
+
 		@directory = Treequel.directory( options.ldapurl )
+		@prompt    = HighLine.new
+
+		@prompt.wrap_at = @prompt.output_cols - 10
 
 		self.log.debug "Created new treewhat command object for %s" % [ @directory ]
 	end
@@ -136,7 +159,6 @@ class Treequel::What
 	end
 
 
-
 	### Run the command with the specified +pattern+.
 	def run( pattern=nil )
 		self.log.debug "Running with pattern = %p" % [ pattern ]
@@ -188,9 +210,35 @@ class Treequel::What
 		pr.say( "\n" )
 		pr.say( dir.schema.to_s )
 
+		self.show_column_list( dir.schema.attribute_types.values, 'Attribute Types' ) if
+			self.options.attrtypes
+		self.show_column_list( dir.schema.object_classes.values, "Object Classes" ) if 
+			self.options.objectclasses
+		self.show_column_list( dir.schema.ldap_syntaxes.values, "Syntaxes" ) if 
+			self.options.syntaxes
+		self.show_column_list( dir.schema.matching_rules.values, "Matching Rules" ) if 
+			self.options.matching_rules
+		self.show_column_list( dir.schema.matching_rule_uses.values, "Matching Rule Uses" ) if 
+			self.options.matching_rule_uses
 	end
 
 
+	### Show the items from the given +enum+ under the specified +subheading+ in a columnized list.
+	def show_column_list( enum, subheading )
+		pr = self.prompt
+		items = nil
+
+		if enum.first.respond_to?( :name )
+			items = enum.map( &:name ).map( &:to_s ).uniq
+		else
+			items = enum.map( &:oid ).uniq
+		end
+
+		pr.say( "\n" )
+		pr.say( pr.color(subheading, :subheader) )
+		pr.say( pr.list(items.sort_by(&:downcase), :columns_across) )
+	end
+
 
 	#
 	# 'Show entry' mode
@@ -280,8 +328,34 @@ class Treequel::What
 
 	### Display a schema artifact in a readable way.
 	def display_schema_artifact( artifact )
-		self.prompt.say( artifact.class.name.sub(/.*::/, '') + ' ' )
-		self.prompt.say( artifact.to_s )
+		self.prompt.say( self.prompt.color(artifact.class.name.sub(/.*::/, ''), :header) + ' ' )
+		self.prompt.say( self.prompt.color(artifact.to_s, :subheader) )
+
+		# Display some other stuff depending on what kind of thing it is
+		case artifact
+		when Treequel::Schema::AttributeType
+			self.display_attrtype_details( artifact )
+		end
+	end
+
+
+	### Display additional details for the specified +attrtype+.
+	### @param [Treequel::Schema::AttributeType] attrtype  the attribute type object to display
+	def display_attrtype_details( attrtype )
+		ocs = self.directory.schema.object_classes.values.find_all do |oc|
+			( oc.must_oids | oc.may_oids ).include?( attrtype.name.to_sym )
+		end
+
+		if ocs.empty?
+			self.prompt.say "No objectClasses with the '%s' attribute are in the current schema." %
+				[ attrtype.name ]
+		else
+			ocnames = ocs.uniq.map( &:name ).map( &:to_s ).sort
+
+			self.prompt.say "objectClasses with the '%s' attribute in the current schema:" %
+				[ attrtype.name ]
+			self.prompt.say( self.prompt.list(ocnames, :columns_across) )
+		end
 	end
 
 

data/lib/treequel.rb

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

data/lib/treequel/directory.rb

@@ -189,7 +189,7 @@ class Treequel::Directory
 
 	### Fetch the root DSE as a Treequel::Branch.
 	def root_dse
-		return self.search( '', :base, '(objectClass=*)', :selectattrs => ['+'] ).first
+		return self.search( '', :base, '(objectClass=*)', :selectattrs => ['+', '*'] ).first
 	end
 
 

data/spec/lib/helpers.rb

@@ -129,7 +129,7 @@ module Treequel::SpecHelpers
 	def get_fixtured_directory( conn )
 		LDAP::SSLConn.stub( :new ).and_return( conn )
 		conn.stub( :search_ext2 ).
-			with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+			with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 			and_return( TEST_DSE )
 		conn.stub( :set_option )
 

data/spec/treequel/directory_spec.rb

@@ -53,7 +53,7 @@ describe Treequel::Directory do
 
 	it "is created with reasonable default options if none are specified" do
 		@conn.stub( :search_ext2 ).
-			with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+			with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 			and_return( TEST_DSE )
 
 		dir = Treequel::Directory.new
@@ -87,7 +87,7 @@ describe Treequel::Directory do
 	it "uses the first namingContext from the Root DSE if no base is specified" do
 		LDAP::Conn.stub( :new ).and_return( @conn )
 		@conn.stub( :search_ext2 ).
-			with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+			with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 			and_return( TEST_DSE )
 
 		dir = Treequel::Directory.new( @options.merge(:base_dn => nil) )
@@ -606,7 +606,7 @@ describe Treequel::Directory do
 			before( :each ) do
 				@control = Module.new { include Treequel::Control }
 				@conn.stub( :search_ext2 ).
-					with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+					with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 					and_return( TEST_DSE )
 			end
 
@@ -647,7 +647,7 @@ describe Treequel::Directory do
 		describe "to a server that supports extensions introspection" do
 			before( :each ) do
 				@conn.stub( :search_ext2 ).
-					with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+					with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 					and_return( TEST_DSE )
 			end
 
@@ -667,7 +667,7 @@ describe Treequel::Directory do
 		describe "to a server that supports features introspection" do
 			before( :each ) do
 				@conn.stub( :search_ext2 ).
-					with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+					with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 					and_return( TEST_DSE )
 			end
 
@@ -686,7 +686,7 @@ describe Treequel::Directory do
 		describe "to a server that doesn't support features introspection" do
 			before( :each ) do
 				@conn.stub( :search_ext2 ).
-					with( "", 0, "(objectClass=*)", ["+"], false, nil, nil, 0, 0, 0, "", nil ).
+					with( "", 0, "(objectClass=*)", ["+", '*'], false, nil, nil, 0, 0, 0, "", nil ).
 					and_return( TEST_DSE )
 			end
 

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: treequel
 version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: 
-  version: 1.5.2
+  segments: 
+  - 1
+  - 5
+  - 3
+  version: 1.5.3
 platform: ruby
 authors: 
 - Michael Granger
@@ -31,29 +36,37 @@ cert_chain:
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
   -----END CERTIFICATE-----
 
-date: 2011-03-17 00:00:00 -07:00
+date: 2011-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ruby-ldap
+  name: diff-lcs
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.9"
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: diff-lcs
+  name: ruby-ldap
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.1"
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -64,40 +77,60 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
         version: 1.2.1
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: hoe-yard
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "2.4"
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: ruby-termios
+  name: hoe-manualgen
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.9"
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: ruby-terminfo
+  name: hoe-yard
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.1"
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
@@ -108,42 +141,104 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
         version: "0.3"
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: sysexits
+  name: ruby-termios
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.0"
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: sequel
+  name: ruby-terminfo
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "3.20"
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rspec
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.9.1
+        hash: 11
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
   type: :development
   version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 3
+        - 20
+        version: "3.20"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: sysexits
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 9
+        - 4
+        version: 2.9.4
+  type: :development
+  version_requirements: *id013
 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,
@@ -162,6 +257,7 @@ extensions: []
 
 extra_rdoc_files: 
 - Manifest.txt
+- History.md
 files: 
 - .gemtest
 - ChangeLog
@@ -248,8 +344,9 @@ post_install_message: |-
   You can install them automatically if you use the --development flag when
   installing Treequel.
 rdoc_options: 
-- --main
-- README.md
+- --title
+- Treequel Documentation
+- --quiet
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -257,17 +354,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: treequel
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Treequel is an LDAP toolkit for Ruby