cs_sln_graph 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,6 +1,8 @@
 = cs_sln_graph
 
-cs_sln_graph is a small utility gem I wrote to generate dependency graphs for C# solution files using GraphViz.
+cs_sln_graph is a small utility gem I wrote to generate dependency graphs for 
+C# solution and project files using GraphViz.  It's not extremely robust, I just whipped it up real quick
+for some research at work.
 
 You will need to install GraphViz before using this gem.
 
@@ -10,13 +12,15 @@ To install, use gem
 	
 	% gem install cs_sln_graph
 	
-The -i argument specifies the path to your solution. 
+The -i argument specifies the path to your solution or project. 
 
 The -o argument specifies the path to your output file (it will default to the directory your solution is in).
 
 -f specifies the format the output file should be in (default is png).
 
 == History
+* 0.0.5 - Now can take project files as input.
+* 0.0.4 - OK, really fix it now
 * 0.0.3 - Fix dependencies on ruby-graphviz
 * 0.0.2 - Don't display System libraries, color external dependencies as green.
 * 0.0.1 - Initial version

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bin/cs_sln_graph

@@ -6,13 +6,13 @@ options = { :format => "png" }
 op = OptionParser.new do |x|
 	x.banner = "cs_sln_graph <options>"
 	x.separator ""
-	x.on("-i <sln_path>", String, "Solution file to generate a graph for.") do |i|
-		options[:sln_path] = i
+	x.on("-i <input>", String, "Solution or project file to generate a graph for.") do |i|
+		options[:input] = i
 	end
 	x.on("-o <output_path>", String, "Output path.") do |o|
 		options[:output] = o
 	end
-	x.on("-f <format>", String, "Format to output") do |f|
+	x.on("-f <format>", String, "Format to output (defaults to png)") do |f|
 		options[:format] = f
 	end
 	x.on("-h", "Show this message") do
@@ -32,15 +32,22 @@ end
 #	exit
 #end
 
-if not options.has_key?(:sln_path)
-	puts "No solution file given."
+if not options.has_key?(:input)
+	puts "No input file given."
 	exit
 end
 
 if not options.has_key?(:output)
-	puts "No output file given.  Defaulting to 'graph' in the solution path."
-	options[:output] = File.join(File.dirname(options[:sln_path]), "graph")
+	puts "No output file given.  Defaulting to 'graph' in the input path."
+	options[:output] = File.join(File.dirname(options[:input]), "graph." + options[:format])
 end
 
-g = Cs_Sln_Graph.new(options[:sln_path], options[:output], options[:format])
-g.graph
+g = Cs_Sln_Graph.new(options[:input], options[:output], options[:format])
+
+if options[:input].end_with?(".sln")
+	g.graph_sln
+elsif options[:input].end_with?("proj")
+	g.graph_proj
+else
+	puts "Invalid input file."
+end

data/cs_sln_graph.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cs_sln_graph}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris ONeal"]
-  s.date = %q{2011-06-23}
+  s.date = %q{2011-06-24}
   s.default_executable = %q{cs_sln_graph}
   s.description = %q{Generates dependency graphs using GraphViz from C# solution files}
   s.email = %q{ctoneal@gmail.com}

data/lib/cs_sln_graph.rb

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'graphviz'
 
 class Cs_Sln_Graph
+	# initialize the graph class
 	def initialize(input, output, format)
 		@input_path = input
 		@output_path = output
@@ -11,10 +12,9 @@ class Cs_Sln_Graph
 		@graph = GraphViz.new("G")
 		format_graph
 	end
-	
-	def format_graph
-		#@graph[:rankdir] = "LR"
 
+	# set up the default format for the graph
+	def format_graph
 		# set global node options
 		@graph.node[:color]    = "#ddaa66"
 		@graph.node[:style]    = "filled"
@@ -36,12 +36,49 @@ class Cs_Sln_Graph
 		@graph.edge[:arrowsize]= "0.5"
 	end
 	
-	def graph
+	# graph a solution file
+	def graph_sln
 		projects = VSFile_Reader.read_sln(@input_path)
 		projects.each do |project|
 			p_node = @graph.add_node(project.name)
-			path = File.join(File.dirname(@input_path), project.path)
-			dependencies = VSFile_Reader.read_proj(path)
+			dependencies = VSFile_Reader.read_proj(project.path)
+			dependencies.each do |dep|
+				if dep.class == Project
+					d_node = @graph.get_node(dep.name)
+					if d_node.nil?
+						d_node = @graph.add_node(dep.name)
+					end
+					@graph.add_edge(d_node, p_node)
+				else
+					if dep.start_with?("System.") || dep == "System"
+						next
+					end
+					d_node = @graph.get_node(dep)
+					if d_node.nil?
+						d_node = @graph.add_node(dep)
+						d_node[:color] = "#66ddaa"
+						d_node[:fillcolor] = "#ccffee"
+					end
+					@graph.add_edge(d_node, p_node)
+				end
+			end
+		end
+		@graph.output(@format => @output_path)
+	end
+	
+	# graph a project file
+	def graph_proj
+		projects = []
+		projects << Project.new(nil, File.basename(@input_path, File.extname(@input_path)), @input_path)
+		dependencies = VSFile_Reader.read_proj(@input_path)
+		dependencies.each do |dep|
+			if dep.class == Project
+				projects << dep
+			end
+		end
+		projects.each do |proj|
+			p_node = @graph.add_node(proj.name)
+			dependencies = VSFile_Reader.read_proj(proj.path)
 			dependencies.each do |dep|
 				if dep.class == Project
 					d_node = @graph.get_node(dep.name)

data/lib/vsfile_reader.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), "project.rb"))
 require 'rexml/document'
 
 class VSFile_Reader
+	# get a list of projects from the solution file
 	def self.read_sln(path)
 		lines = []
 		projects = []
@@ -9,7 +10,7 @@ class VSFile_Reader
 		file.each_line do |line|
 			match_data = line.match(/^\s*Project\s*\(\s*\"\{[A-F0-9\-]{36}\}\"\s*\)\s*=\s*\"(\S+)\"\s*,\s*\"(.*\.(vcproj|csproj))\"\s*,\s*\"\{([A-F0-9\-]{36})\}\"\s*$/i)
 			if not match_data.nil?
-				proj = Project.new(match_data[4], match_data[1], match_data[2])
+				proj = Project.new(match_data[4], match_data[1], File.join(File.dirname(path), match_data[2]))
 				projects << proj
 			end
 		end
@@ -19,6 +20,7 @@ class VSFile_Reader
 		return projects
 	end
 	
+	# get a list of dependencies for the given project
 	def self.read_proj(path)
 		dependencies = []
 		file = File.open(path) { |f| f.read }
@@ -31,7 +33,7 @@ class VSFile_Reader
 		end
 		# find project dependencies
 		document.elements.each('//Project/ItemGroup/ProjectReference') do |element|
-			path = element.attributes["Include"]
+			path = File.join(File.dirname(path), element.attributes["Include"])
 			name = ""
 			element.elements.each('Name') do |e|
 				name = e.text

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cs_sln_graph
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-23 00:00:00.000000000 -05:00
+date: 2011-06-24 00:00:00.000000000 -05:00
 default_executable: cs_sln_graph
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &5769192 !ruby/object:Gem::Requirement
+  requirement: &5798580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5769192
+  version_requirements: *5798580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &5768496 !ruby/object:Gem::Requirement
+  requirement: &5797356 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *5768496
+  version_requirements: *5797356
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &5767356 !ruby/object:Gem::Requirement
+  requirement: &5796336 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *5767356
+  version_requirements: *5796336
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &5766588 !ruby/object:Gem::Requirement
+  requirement: &5793384 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5766588
+  version_requirements: *5793384
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
-  requirement: &5765760 !ruby/object:Gem::Requirement
+  requirement: &5792412 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *5765760
+  version_requirements: *5792412
 description: Generates dependency graphs using GraphViz from C# solution files
 email: ctoneal@gmail.com
 executables:
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 93176879
+      hash: 270288659
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: