ClassBrowser 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2212f8e9247ef7b04d813d71cec1e7a6d86d1d1f
-  data.tar.gz: bf29e15f87efe4cbdce77fc103890beeabe6f6f6
+  metadata.gz: 170630389503dadbd207003e5886dd06af6df094
+  data.tar.gz: 2272dbe3b246fc93fa22f0aaa5c70b65f4aa52e3
 SHA512:
-  metadata.gz: ab6d006238797bb1b703829bb4ab3833407bb334e4f8a3fedf35d72740a13dee9f663f1a6510d21ddca6f6bd6be5b700070d81111a6cc22438ccbaeafe8fc5dd
-  data.tar.gz: 14815e27cefe3a983179a11c927470641d1510a9e976d61c6f4c20b781be522b1ad5c9fad1d0826ae23446cbc485926bfd93f983a5525e13c590d1714ddd274b
+  metadata.gz: 4b8c380fdc955225981e230b92c43de7c02170d7dc25306c8fee260382af3ad1f03bd699eae5a3ec8778c99046c3a6d6a2b60de78f4bb8e2c00b0e6e31309102
+  data.tar.gz: 8b7dfc565e50d41017c4c32c401fad923dd36e510036043f92186fcc2ee511af10b1ed35c35ceb84c5bea00b12c1d0f947c874ef5be02ccac97dd37976bdd0a8

data/lib/ClassBrowser.rb

@@ -3,33 +3,121 @@ require_relative 'HierarchyWriter'
 
 class ClassBrowser
 	attr_reader :class_root_node
+	attr_reader :show_help
 	attr_reader :depth
+	attr_reader :show_modules
+	attr_reader :show_methods
 
 	def initialize root_class = Object
 		@class_root_node = ClassNode.new root_class
+		@show_help = false
 		@depth = :depth_immediate
+		@show_modules = false
+		@show_methods = :methods_none
 	end
 
 	def dump_hierarchy
 		HierarchyWriter::dump_hierarchy_of @class_root_node, @depth
 	end
 
-	def parse_arguments argv
-		if argv.include? "-di"
-			@depth = :depth_immediate
+	def pretty_print prefix, methods, suffix = ""
+		methods.sort_by { |m| m.to_s }
+		width = ENV['COLUMNS'].to_i
+		col = 0
+		methods.each do |m|
+			msg = '%-24.24s' % "#{prefix}#{m.to_s}#{suffix}"
+			col += msg.length
+			if col >= width
+				print "\n"
+				col = msg.length
+			end
+			print msg
+		end
+		print "\n"
+	end
+
+	def dump_modules
+		if @class_root_node.klass && @show_modules
+
+			modules = @class_root_node.klass.ancestors.select { |a| a.class == Module }
+			pretty_print "[", modules, "]"
+		end
+	end
+
+	def dump_methods
+		if @class_root_node.klass && @show_methods != :methods_none
+			if @show_methods == :methods_all || @show_methods == :methods_class
+				methods = @class_root_node.klass.singleton_methods
+				pretty_print "::", methods
+			end
+			if @show_methods == :methods_all || @show_methods == :methods_instance
+				methods = @class_root_node.klass.instance_methods(false)
+				pretty_print "#", methods
+			end
+		end
+	end
+
+	def show_help
+		if @show_help
+			puts "Usage: ClassBrowser [class] [switches]
+Where:
+class is a Class or Module name
+switches may be:
+  -h:   show this message
+  -da:  show the all descendants of this class
+  -di:  show the immediate descendants of this class
+  -dn:  do not show the descendants of this class
+  -m:   show the Modules included by this Class or Module
+  -ma:  show all methods of this Class or Module
+  -mi:  show the instance methods of this Class
+  -mc:  show the class methods of this Class
+  -mn:  do not show any methods of this Class or Module
+ClassBrowser with no arguments enters interactive mode
+"
+			true
+		else
+			false
 		end
-		if argv.include? "-da"
-			@depth = :depth_all
+	end
+
+	def dump
+		if !show_help
+			dump_hierarchy
+			dump_modules
+			dump_methods
+		end
+	end
+
+
+	def parse_arguments argv
+		flags = {
+			"-h"  => lambda { @show_help = true },
+			"-di" => lambda { @depth = :depth_immediate },
+			"-da" => lambda { @depth = :depth_all },
+			"-dn" => lambda { @depth = :depth_none },
+			"-m"  => lambda { @show_modules = true },
+			"-mn" => lambda { @show_methods = :methods_none },
+			"-ma" => lambda { @show_methods = :methods_all },
+			"-mi" => lambda { @show_methods = :methods_instance },
+			"-mc" => lambda { @show_methods = :methods_class },
+		}
+
+		argv.each do |arg|
+			l = flags[arg]
+			if l
+				l.call
+			end
 		end
 
 		class_name_index = argv.index{ |o| !o.start_with?("-") }
 		if class_name_index
 			class_name = argv[class_name_index]
-			klass = Object
+			klass = nil
 			begin
 				klass = Object.const_get(class_name)
 			rescue
-				klass = Object
+				puts "Unknown class"
+				klass = nil
 			end
 			@class_root_node = ClassNode.new klass
 		end
@@ -40,25 +128,31 @@ class ClassBrowser
 		failsafe = 1
 
 		loop do
-			args = gets.split(" ")
+			print "\n#{@class_root_node.name}> "
+			args = gets.split(/\s+/)
 
 			if args == nil || args.length == 0
 				break
 			end
 
 			parse_arguments args
-			dump_hierarchy
+			dump
 
 			failsafe += 1
 			break if failsafe > 100
 		end 
 	end
 end
-
-#modules = cls.ancestors.select { |a| a.class == Module }.to_s
 	
 def main
 	browser = ClassBrowser.new
-	browser.parse_arguments ARGV
-	browser.dump_hierarchy
+	if ARGV.length > 0
+		browser.parse_arguments ARGV
+		browser.dump
+	else
+		browser.interactive
+		puts "Bye!"
+	end
 end
+
+main

data/lib/ClassNode.rb

@@ -6,40 +6,44 @@ class ClassNode
 	end
 
 	def name
-		@klass.name
+		if @klass
+			@klass.name
+		else
+			"*Unknown class*"
+		end
 	end
 
 	def ancestors
 		class_nodes = []
-		@klass.ancestors[1..-1].each do |c|
-			if c.class == Class 
-				class_node = ClassNode.new c
-				class_nodes.insert 0, class_node
+		if @klass
+			@klass.ancestors[1..-1].each do |c|
+				if c.class == Class 
+					class_node = ClassNode.new c
+					class_nodes.insert 0, class_node
+				end
 			end
 		end
 		class_nodes
 	end
 
 	def descendants
-		klass = @klass
-
-		klasses = ObjectSpace.each_object(Class).select do |c| 
-			c.superclass == klass 
-		end
-
-		klasses.reject! { |c| c.name == nil }
-
-		klasses.sort_by do |c|
-			c.name 
-		end
-	
 		class_nodes = []
+		if @klass
+			klasses = ObjectSpace.each_object(Class).select do |c| 
+				c.superclass == @klass 
+			end
 
-		klasses.each do |c|
-			class_node = ClassNode.new c
-			class_nodes << class_node
-		end
+			klasses.reject! { |c| c.name == nil }
 
+			klasses.sort_by do |c|
+				c.name 
+			end
+		
+			klasses.each do |c|
+				class_node = ClassNode.new c
+				class_nodes << class_node
+			end
+		end
 		class_nodes
 	end
 

data/lib/HierarchyWriter.rb

@@ -55,6 +55,7 @@ class HierarchyWriter
 		indent
 	end
 
+	# prints the ancestors and descendants of node
 	def self.dump_hierarchy_of node, depth = :depth_all
 		indent = HierarchyWriter::dump_ancestors_of node
 		HierarchyWriter::dump_descendants_of node, indent, depth

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ClassBrowser
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Tom Underhill