DepGraph 0.8.0

data/History.txt

@@ -0,0 +1 @@
+

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 DepGraph - Daniel Cadenas Ni�n
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/depgraph
+config/hoe.rb
+config/requirements.rb
+lib/DepGraph/version.rb
+lib/dependable_filter_manager.rb
+lib/dependency_types.yaml
+lib/dependent.rb
+lib/file_system_dependent_finder.rb
+lib/graph.rb
+lib/graph_creator.rb
+script/destroy
+script/destroy.cmd
+script/generate
+script/generate.cmd
+script/txt2html
+script/txt2html.cmd
+setup.rb
+spec/dependable_filter_manager_spec.rb
+spec/dependent_spec.rb
+spec/depgraph_spec.rb
+spec/file_system_dependent_finder_spec.rb
+spec/graph_creator_spec.rb
+spec/graph_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+todo.txt

data/README.txt

@@ -0,0 +1 @@
+README

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/depgraph

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-3-9.
+#  Copyright (c) 2008. Daniel Cadenas. All rights reserved.
+#  http://depgraph.rubyforge.org
+
+begin
+  require 'rubygems'
+  gem 'optiflag'
+  gem 'ruby-graphviz'
+  require 'optiflag'
+  require 'graphviz'
+rescue LoadError
+  puts "depgraph requires the optiflag RubyGem."
+  puts "Installation: gem install optiflag -y"
+  exit
+end
+
+require 'dependable_filter_manager'
+require 'graph_creator'
+
+module CommandLineParameters extend OptiFlagSet
+  flag "type" do
+    dependency_types = DepGraph::DependableFilterManager.types    
+    description "Type of dependencies to analyze: #{dependency_types.join(', ')}"
+    value_in_set dependency_types
+  end
+  
+  optional_flag "output" do
+    description "The file name of the image."
+  end
+
+
+  optional_flag "from" do
+    description "Regular expresion that must be met by the dependency source."
+  end
+  
+  optional_flag "to" do
+    description "Regular expresion that must be met by the dependency target."
+  end
+  
+  optional_flag "dirs" do
+    description "Directories to traverse for dependency files. Use double quotes and commas for more than one directory."
+  end
+  
+  usage_flag "h","help","?"
+
+  
+  and_process!
+end 
+
+type = CommandLineParameters.flags.type
+output = CommandLineParameters.flags.output || 'dependency_graph.png'
+dirs = CommandLineParameters.flags.dirs || '.'
+from = CommandLineParameters.flags.from if CommandLineParameters.flags.from?
+to = CommandLineParameters.flags.to if CommandLineParameters.flags.to?
+
+puts "Creating #{type} dependency graph. Please wait..."
+
+dep_grapher = DepGraph::GraphCreator.new(type)
+dep_grapher.dirs = dirs.split(',')
+dep_grapher.from= from
+dep_grapher.to = to
+
+if dep_grapher.create_image(output)
+  puts "Created #{output}.\nDone."
+else
+  puts "No dependency graph image created."
+end

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'DepGraph/version'
+
+AUTHOR = 'Daniel Cadenas Ni�n'  # can also be an array of Authors
+EMAIL = "depgraph-devel@rubyforge.org"
+DESCRIPTION = "A tool to create dependency graph images from source code directories"
+GEM_NAME = 'DepGraph' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'DepGraph' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "dcadenas"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = DepGraph::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'DepGraph documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["spec/**/*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen filetesthelper spec optiflag graphviz].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    req_gem = 'rspec' if req_gem == 'spec'
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+

data/lib/DepGraph/version.rb

@@ -0,0 +1,9 @@
+module DepGraph #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/dependable_filter_manager.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+
+module DepGraph
+  class DependableFilterManager
+    def self.dependency_types_file
+      File.join(File.dirname(__FILE__), 'dependency_types.yaml')
+    end
+    
+    begin
+      @@dependable_dependency_types = YAML.load_file(dependency_types_file)
+    rescue => e
+      fail "Could not load file #{dependency_types_file}: #{e.message}"
+    end
+      
+    def self.types
+      @@dependable_dependency_types.map {|type, _| type.to_sym}
+    end
+    
+    def initialize(dependent_type = :anything)
+      @dependent_type = dependent_type.to_s
+    end
+    
+    def dependable_regexp
+      get_dependent_type_parameters(@dependent_type)['dependable_regexp']
+    end
+        
+    def dependable_regexp_capture_group_index
+      get_dependent_type_parameters(@dependent_type)['capture_group_index']
+    end
+    
+    def file_name_pattern
+      get_dependent_type_parameters(@dependent_type)['file_name_pattern']
+    end
+    
+    def get_dependent_type_parameters(dependent_type)
+      dependent_type_parameters = @@dependable_dependency_types[dependent_type]
+      
+      if dependent_type_parameters
+        return dependent_type_parameters
+      else
+        return default_parameters = {
+          'dependable_regexp' => /.+/,
+          'capture_group_index' => 0,
+          'file_name_pattern' => '*'
+        }
+      end
+    end
+  end
+end

data/lib/dependency_types.yaml

@@ -0,0 +1,11 @@
+--- 
+csproj: 
+  file_name_pattern: "*.csproj"
+  dependable_regexp: !ruby/regexp /"([^"]*\\)?([^\\"]+?)\.(csproj|dll)"/
+  capture_group_index: 1
+ruby_requires: 
+  file_name_pattern: "*.rb"
+  dependable_regexp: !ruby/regexp /[\s]*require[\s]+["'](.*\/)?([^\s\/]+?)(\.rb)?["']/
+  capture_group_index: 1
+
+

data/lib/dependent.rb

@@ -0,0 +1,73 @@
+module DepGraph
+
+  #A Dependent knows its dependables and knows how to get them from a string
+  class Dependent
+    include Comparable
+    attr_reader :name
+
+    def initialize(dependent_uri, dependent_type = :anything)
+      fail 'Empty uris are not allowed' if dependent_uri.empty?
+      @name = remove_extension dependent_uri
+      @dependencies = []
+
+      load_filter_type(dependent_type)
+    end
+    
+    def load_filter_type(dependent_type)
+      dependable_filter_manager = DependableFilterManager.new dependent_type
+      @dependable_filter = dependable_filter_manager.dependable_regexp
+      @dependable_filter_capture_group_index = dependable_filter_manager.dependable_regexp_capture_group_index
+    end
+    
+    def to_str
+      @name
+    end
+    
+    def <=> other_dependent
+      @name <=> other_dependent.to_str
+    end
+    
+    def eql? other_dependent
+      (self <=> other_dependent) == 0
+    end
+    
+    def hash
+      @name.hash
+    end
+    
+    def remove_extension file_path
+      file_extension_regexp = /\.[^\.]+$/
+      return File.basename(file_path).gsub(file_extension_regexp, '')
+    end
+    
+    def depends_on dependent
+      @dependencies << dependent
+    end
+    
+    def depends_on? dependent
+      @dependencies.include? dependent
+    end
+
+    def dependencies
+      @dependencies
+    end
+    
+    def dependable_filter= filter
+      @dependable_filter = filter
+      @dependable_filter_capture_group_index = 0
+    end
+    
+    def dependable_filter_capture_group_index= group_index
+      @dependable_filter_capture_group_index = group_index
+    end
+    
+    def load_dependencies_from_string(dependencies_string)
+      fail 'The dependable finder Regexp was not set' unless @dependable_filter
+
+      dependencies_string.scan(@dependable_filter).each do |matches|
+        dependable = (matches.respond_to? :to_ary) ? matches[@dependable_filter_capture_group_index] : matches
+        depends_on(dependable) unless depends_on? dependable
+      end
+    end
+  end
+end

data/lib/file_system_dependent_finder.rb

@@ -0,0 +1,44 @@
+require 'dependent'
+require 'dependable_filter_manager'
+
+module DepGraph
+  class FileSystemDependentFinder
+    attr_reader :dependent_filter, :dependable_filter, :dependable_filter_capture_group_index
+    attr_writer :dirs
+    
+    def initialize(dependent_type)
+      
+      dependable_filter_manager = DependableFilterManager.new dependent_type
+      @file_name_pattern = dependable_filter_manager.file_name_pattern
+      @dependable_filter = dependable_filter_manager.dependable_regexp
+      @dependable_filter_capture_group_index = dependable_filter_manager.dependable_regexp_capture_group_index
+      @dirs = ['.']
+    end 
+    
+    def get_dependents
+      files = []
+      @dirs.each do |dir|
+        files += Dir.glob(dir.strip + '/**/' + @file_name_pattern)
+      end
+      
+      dependents = []
+      files.each { |file| dependents << create_dependent_from_file(file) }
+      return dependents
+    end
+    
+    private
+    def create_dependent_from_file file
+      dependent = Dependent.new file
+      dependent.dependable_filter = @dependable_filter
+      dependent.dependable_filter_capture_group_index = @dependable_filter_capture_group_index 
+      
+      File.open(file) do |f|
+        f.each_line do |line|
+          dependent.load_dependencies_from_string(line)
+        end
+      end
+      
+      return dependent
+    end
+  end
+end

data/lib/graph.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'graphviz'
+
+module DepGraph
+  class Graph
+    def initialize
+      @nodes = []
+      @edges = []
+    end
+
+    def node_count
+      @nodes.size
+    end
+    
+    def add_node(node_name)
+      fail 'Node name not specified' if node_name.to_str.empty?
+      @nodes << node_name.to_str
+    end
+    
+    def has_node?(node_name)
+      @nodes.include? node_name
+    end
+
+    def edge_count
+      @edges.size
+    end
+
+    def add_edge(source_node_name, target_node_name)
+      fail "Cannot create a dependency to the unregistered node #{target_node_name}" unless @nodes.include?(target_node_name.to_str)
+      fail "Cannot create a dependency from the unregistered node #{source_node_name}" unless @nodes.include?(source_node_name.to_str) 
+      
+      @edges << [source_node_name.to_str, target_node_name.to_str]
+    end
+    
+    def has_edge?(node1, node2)
+      @edges.include? [node1, node2]
+    end
+    
+    def reset
+      @nodes.clear
+      @edges.clear
+    end
+    
+    def create_image(image_file_name)
+      begin
+        return false if @nodes.size == 0 or @edges.size == 0
+        
+        set_default_output_generation_unless_is_set
+        
+        return @output_generation.call(@nodes, @edges, image_file_name)
+        
+      rescue => e
+        puts e.message
+        puts e.backtrace
+        return false
+      end
+    end
+    
+    def output_generation= output_generation_lambda
+      @output_generation = output_generation_lambda
+    end
+    
+    private
+    def quotify(a_string)
+      '"' + a_string + '"'
+    end
+    
+    def set_default_output_generation_unless_is_set
+      unless @output_generation 
+        @output_generation = lambda {|nodes, edges, image_file_name|
+          #TODO: Could we catch Graphviz errors that the wrapper couldn't catch?        
+          g = GraphViz::new( "G", :use => 'dot', :mode => 'major', :rankdir => 'LR', :concentrate => 'true', :fontname => 'Arial', :file => image_file_name)      
+
+        
+          nodes.each do |node|
+            g.add_node(quotify(node))
+          end
+      
+          edges.each do |from, to|
+            g.add_edge(quotify(from), quotify(to))
+          end
+      
+          g.output( :output => "png")
+          return true
+        }
+      end
+    end
+  end
+end

data/lib/graph_creator.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'dependent'
+require 'graph'
+require 'file_system_dependent_finder'
+
+module DepGraph
+  class GraphCreator
+    attr_accessor :dependent_finder 
+    
+    def initialize(dependent_type = :none)
+      @dependent_finder = FileSystemDependentFinder.new(dependent_type)
+      @graph_class = Graph
+    end
+    
+    def graph_class= the_graph_class
+      @graph_class = the_graph_class
+    end
+    
+    def dirs=(directories)
+      @dependent_finder.dirs = directories
+    end
+    
+    def from=(from_filter)
+      @from_filter = from_filter
+    end
+    
+    def to=(to_filter)
+      @to_filter = to_filter
+    end
+
+    
+    def create_graph
+      nodes = @dependent_finder.get_dependents.uniq
+      return nil if nodes.size < 2
+      
+      dependents = apply_from_filter(nodes)
+      dependents = apply_to_filter(dependents)
+      
+      graph = @graph_class.new
+      
+      dependents.each do |dependent|
+        graph.add_node dependent
+      end
+      
+      dependents.each do |dependent|
+        dependent.dependencies.each do |dependable|
+          graph.add_edge(dependent, dependable) if dependents.include? dependable
+        end
+      end
+      
+      return graph
+    end
+    
+    def apply_from_filter(nodes)
+      return nodes unless @from_filter
+      
+      selected_dependents = nodes.select do |node|
+        node.name.match(@from_filter) or nodes.any?{|dependent| dependent.name.match(@from_filter) and dependent.depends_on?(node)}
+      end
+      
+      return selected_dependents
+    end
+    
+    def apply_to_filter(nodes)
+      return nodes unless @to_filter
+      
+      selected_dependents = nodes.select do |node|
+        node.name.match(@to_filter) or nodes.any?{|dependable| node.depends_on?(dependable) and dependable.name.match(@to_filter)}
+      end
+      
+      return selected_dependents
+    end
+
+    
+    def create_image(image_file_name = 'dependency_graph.png')
+      graph = create_graph
+      
+      if graph
+        return graph.create_image(image_file_name) 
+      else
+        return false
+      end
+    end
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/destroy.cmd

@@ -0,0 +1 @@
+@ruby script/destroy %*

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/generate.cmd

@@ -0,0 +1 @@
+@ruby script/generate %*