depgraph 0.11.0

data/History.txt

@@ -0,0 +1,28 @@
+0.10.1
+* Applied patch DepGraph-fix_sorting_assumption.patch by Diego Algorta Casamayou
+* Applied patch misleading_dependency_error_messages.patch by Trevor Fountain
+* Fixed some bugs in the tests
+
+0.10.0
+* Now you can create the dependency graph of all the installed gems.
+* Fixed the missing dependencies to optiflag and ruby-graphviz to the deployed gem.
+
+0.9.0
+
+* Added dynamic loading of node finders from directory lib/nodefinders.
+ Example:
+   see 'lib/nodefinders/TestNodeFinder.rb' which can be used like this:
+   depgraph -type test
+* Added functionality to exclude the nodes the user is not interested in.
+ Example:
+   depgraph -type ruby_requires -exc "client, server"
+* A transitive reduction can be applied to the graph.
+ Example:
+   depgraph -type csproj -trans
+* Disconnected nodes don't show up anymore.
+* The type of output can be selected by changing the file extension. 
+ Example:
+   depgraph -type test -output test.dot
+* Separated unit tests and integration tests in different folders.
+* Renamed option -dirs to -location
+* Some more refactorings.

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/README.rdoc

@@ -0,0 +1,40 @@
+= DepGraph
+
+* http://depgraph.rubyforge.org
+
+== DESCRIPTION:
+
+A Ruby tool to create dependency graph images from any kind of file
+
+== REQUIREMENTS:
+
+* Graphviz, ruby-graphviz and optiflag
+
+== INSTALL:
+
+* gem install dcadenas-DepGraph
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Daniel Cadenas
+
+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/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+
+spec = Gem::Specification.new do |s|
+  s.name = "depgraph"
+  s.summary = "A tool to create dependency graph images from source code directories"
+  s.description =  "A tool to create dependency graph images from source code directories"
+  s.email = "dcadenas@gmail.com"
+  s.homepage = "http://github.com/dcadenas/depgraph"
+  s.authors = ["Daniel Cadenas"]
+  s.executables = ["depgraph"]
+
+  s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+  s.add_dependency(%q<ruby-graphviz>, ["~> 1.0.8"])
+  s.add_dependency(%q<optiflag>, [">= 0.6.5"])
+
+  s.version = File.read("VERSION")
+  s.files = `git ls-files`.split
+end
+
+require 'rake/extensiontask'
+Gem::PackageTask.new(spec) do |pkg|
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-f progress", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.11.0

data/bin/depgraph

@@ -0,0 +1,89 @@
+#!/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'
+  require 'optiflag'
+rescue LoadError
+  puts "depgraph requires the optiflag RubyGem."
+  puts "Installation: gem install optiflag -y"
+  exit
+end
+
+begin
+  gem 'ruby-graphviz'
+  require 'graphviz'
+rescue LoadError
+  puts "depgraph requires the ruby-graphviz."
+  puts "Installation: gem install ruby-graphviz"
+  exit
+end
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'graph_creator'
+
+
+module CommandLineParameters extend OptiFlagSet
+  flag "type" do
+    dependency_types = DepGraph::GraphCreator.types    
+    description "Type of dependencies to analyze: #{dependency_types.join(', ')}"
+    value_in_set dependency_types
+  end
+  
+  optional_flag "exc" do
+    description "The node names to be excluded.\nUse double quotes and commas for multiple nodes."
+  end
+  
+  optional_flag "output" do
+    description "The file name of the graph image."
+  end
+
+  optional_flag "from" do
+    description "Regular expression that must be met by the dependency source."
+  end
+  
+  optional_flag "to" do
+    description "Regular expression that must be met by the dependency target."
+  end
+  
+  optional_flag "location" do
+    description "A string defining the place where the nodes to analyse are found.\nThis are directories for most dependency types.\n
+Use double quotes and commas for more than one directory."
+  end
+  
+  optional_switch_flag "trans" do
+    description "Applies a transitive reduction to the graph"
+  end
+  
+  usage_flag "h","help","?"
+  
+  and_process!
+end 
+
+type = CommandLineParameters.flags.type
+output = CommandLineParameters.flags.output || 'dependency_graph.png'
+location = CommandLineParameters.flags.location
+from = CommandLineParameters.flags.from if CommandLineParameters.flags.from?
+to = CommandLineParameters.flags.to if CommandLineParameters.flags.to?
+exc = CommandLineParameters.flags.exc || ''
+trans = CommandLineParameters.flags.trans?
+
+puts "Creating #{type} dependency graph. Please wait..."
+
+dep_grapher = DepGraph::GraphCreator.new(type)
+dep_grapher.location = location.split(',') if location
+dep_grapher.from = from
+dep_grapher.to = to
+dep_grapher.trans = trans
+dep_grapher.excluded_nodes = exc.split(',')
+
+if dep_grapher.create_image(output)
+  puts "Done.\nResults in #{output}."
+else
+  puts "No dependency graph image created."
+end

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'DepGraph/version'
+
+AUTHOR = 'Daniel Cadenas Ni�n'  # can also be an array of Authors
+EMAIL = "dcadenas@gmail.com"
+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.downcase}"
+
+@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.extra_deps = [['ruby-graphviz', '>=0.8.0'], ['optiflag', '>=0.6.5']]
+  
+  #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,19 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen filetesthelper spec optiflag graphviz rcov].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    req_gem = 'rspec' if req_gem == 'spec'
+    req_gem = 'ruby-graphviz' if req_gem == 'graphviz'
+
+    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 = 10
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  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/dependency_types_manager.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+
+module DepGraph
+  class DependencyTypesManager
+    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(node_type = :anything)
+      @node_type = node_type.to_s
+    end
+    
+    def dependable_regexp
+      get_node_type_parameters(@node_type)['dependable_regexp']
+    end
+        
+    def dependable_regexp_capture_group_index
+      get_node_type_parameters(@node_type)['capture_group_index']
+    end
+    
+    def file_name_pattern
+      get_node_type_parameters(@node_type)['file_name_pattern']
+    end
+    
+    def get_node_type_parameters(node_type)
+      node_type_parameters = @@dependable_dependency_types[node_type]
+      
+      if node_type_parameters
+        return node_type_parameters
+      else
+        return default_parameters = {
+          'dependable_regexp' => /.+/,
+          'capture_group_index' => 0,
+          'file_name_pattern' => '*'
+        }
+      end
+    end
+  end
+end

data/lib/file_system_node_finder.rb

@@ -0,0 +1,64 @@
+require 'node'
+require 'dependency_types_manager'
+
+module DepGraph
+  class FileSystemNodeFinder
+    attr_accessor :dependable_filter, :dependable_filter_capture_group_index, :file_name_pattern
+    attr_writer :location
+    
+    def initialize(node_type)
+      
+      dependable_filter_manager = DependencyTypesManager.new node_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
+      @location = ['.']
+    end 
+    
+    def location=(locs)
+      if locs
+        @location = locs.map {|d| d.strip}
+      else
+        @location = ['.']
+      end
+    end
+    
+    def get_nodes
+      files = []
+      @location.each do |dir|
+        files += Dir.glob(dir.strip + '/**/' + @file_name_pattern)
+      end
+      
+      nodes = []
+      files.each { |file| nodes << create_node_from_file(file) }
+      return nodes
+    end
+    
+    def load_dependencies_from_string(node, 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
+        node.depends_on(dependable) unless node.depends_on? dependable
+      end
+    end
+    
+    private
+    def create_node_from_file file
+      node = Node.new remove_extension(file)
+      
+      File.open(file) do |f|
+        f.each_line do |line|
+          load_dependencies_from_string(node, line)
+        end
+      end
+      
+      return node
+    end
+    
+    def remove_extension file_path
+      file_extension_regexp = /\.[^\.]+$/
+      return File.basename(file_path).gsub(file_extension_regexp, '')
+    end
+  end
+end