depgraph 0.11.0

data/spec/UnitTests/graph_image_creator_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'graph_image_creator'
+include DepGraph
+
+describe GraphImageCreator do
+  
+  it "should start with no nodes" do
+    create_empty_graph.node_count.should == 0
+  end
+  
+  it "should be possible to add nodes" do
+    graph = create_graph_with_2_nodes_and_0_edges
+    
+    graph.node_count.should == 2
+    graph.edge_count.should == 0
+  end
+  
+  it "should not be allowed to add a node without a name" do
+    lambda {create_empty_graph.add_node('')}.should raise_error
+  end
+  
+  it "should start with no edges" do
+    create_empty_graph.edge_count.should == 0
+  end
+  
+  it "should be possible to add an edge" do
+    graph = create_graph_with_2_nodes_and_1_edge
+    
+    graph.node_count.should == 2
+    graph.edge_count.should == 1
+  end
+  
+  it "can be reset" do
+    graph = create_graph_with_2_nodes_and_1_edge
+    
+    graph.reset
+    graph.node_count.should == 0
+    graph.edge_count.should == 0
+  end
+    
+  it "should not be allowed to add edges between non existent nodes" do
+    lambda {create_empty_graph.add_edge('no node 1', 'no node 2')}.should raise_error
+  end
+  
+  it "should return true when a new image file is created" do
+    graph = create_graph_with_2_nodes_and_1_edge    
+    graph.output_generation = no_output_generation
+    graph.create_image('graph.png').should be_true
+  end
+  
+  it "should return false when trying to create an empty graph" do
+    graph = create_empty_graph
+    graph.output_generation = no_output_generation
+    graph.create_image('graph.png').should be_false
+  end
+end

data/spec/UnitTests/node_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'stringio'
+require 'node' 
+include DepGraph
+
+describe Node do
+  it 'should not accept empty uris in the constructor' do
+    lambda{Node.new('')}.should raise_error
+  end
+  
+  it 'should have a non empty name' do
+    node = Node.new('a')
+    node.name.should_not be_empty
+  end
+
+  it 'should be equal to another node with the same name' do
+    node1 = Node.new('abc')
+    node2 = Node.new('abc')
+    node3 = Node.new('abd')
+    
+    node1.should == node2
+    node1.should be_eql(node2)
+
+    node1.should_not == node3
+    node1.should_not be_eql(node3)
+    
+    node2.should_not == node3
+    node2.should_not be_eql(node3)
+  end
+  
+  it 'should allow setting node dependencies' do
+    node = Node.new('a')
+    node.depends_on('b')
+    
+    node.dependencies.size.should == 1
+  end
+  
+  it 'should allow querying for a node' do
+    node = Node.new('a')
+    node.depends_on('b')
+    
+    node.depends_on?('b').should be_true
+    node.depends_on?('c').should be_false
+  end
+end

data/spec/integration_spec.opts

@@ -0,0 +1,4 @@
+--format
+specdoc
+--timeout
+20

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--format
+specdoc
+--format
+html:specs.html
+--timeout
+20

data/spec/spec_helper.rb

@@ -0,0 +1,179 @@
+require 'enumerator'
+require 'file_test_helper'
+
+dir = File.expand_path(File.dirname(__FILE__)) 
+$LOAD_PATH.unshift("#{dir}/") 
+$LOAD_PATH.unshift("#{dir}/../lib") 
+
+require 'dependency_types_manager'
+require 'graph_image_creator'
+def dependency_types
+  DepGraph::DependencyTypesManager.types
+end
+
+def non_empty_file_created(file_name)
+  File.exist?(file_name) and File.size(file_name) > 0
+end
+
+def non_existent_filter_type
+  DependencyTypesManager.types.join + 'thisdoesntexist'
+end
+
+########## Stubs ###########
+class MockNodeFinder
+  def initialize(nodes)
+    @nodes = nodes
+  end
+    
+  def get_nodes
+    @nodes
+  end
+end
+  
+class NoOutputGraph < DepGraph::GraphImageCreator
+  def initialize
+    super
+    output_generation = lambda { true }
+  end
+end
+
+########## graph helper methods
+
+def create_empty_graph
+  GraphImageCreator.new
+end
+
+def create_graph_with_2_nodes_and_1_edge
+  graph = create_empty_graph
+  graph.add_node('node 1')
+  graph.add_node('node 2')
+  graph.add_edge('node 1', 'node 2')
+  return graph
+end
+
+def create_graph_with_2_nodes_and_0_edges
+  graph = create_empty_graph
+  graph.add_node('node 1')
+  graph.add_node('node 2')
+  return graph
+end
+
+def no_output_generation
+  lambda {|*args| true}
+end
+
+def dependency_exists?(graph, from, to)
+  graph.has_node?(from) and graph.has_node?(to) and graph.has_edge?(from, to)
+end
+
+
+########## graph creator tests helper methods ###########
+def create_graph_creator_with_no_nodes
+  graph_creator = GraphCreator.new
+  graph_creator.node_finder = MockNodeFinder.new([])
+  
+  return graph_creator
+end
+
+def create_graph_creator_with_only_one_node
+  graph_creator = GraphCreator.new
+  graph_creator.node_finder = MockNodeFinder.new([Node.new('node/path')])  
+  
+  return graph_creator
+end
+
+def create_2_connected_plus_2_disconnected_nodes_graph_creator
+  node1 = Node.new('directory/path1')
+  node2 = Node.new('directory/path2')
+  node3 = Node.new('directory/anotherdir/path3')
+  node4 = Node.new('directory2/path4')
+  node5 = Node.new('directory2/anotherdir/path5')
+  node1.depends_on(node2)
+  node3.depends_on(node5)
+  node4.depends_on(node5)
+  
+  graph_creator = GraphCreator.new    
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2, node3, node4])
+
+  return graph_creator
+end
+
+def create_graph_creator_with_three_nodes_that_are_equal
+  node1 = Node.new('directory/path')
+  node2 = Node.new('directory/path')
+  node3 = Node.new('directory/anotherdir/path')
+    
+  graph_creator = GraphCreator.new    
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2, node3])
+
+  return graph_creator
+end
+
+def create_graph_creator_with_two_nodes_and_no_dependencies
+  node1 = Node.new('node1/path1')
+  node2 = Node.new('node2/path2')
+    
+  graph_creator = GraphCreator.new   
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2])
+
+  return graph_creator
+end
+
+def create_dependency_chain_graph_creator(*node_names)
+  nodes = []
+
+  node_names.each do |node|
+    nodes << Node.new(node)
+  end
+
+  nodes.each_cons(2) do |node, dependable|
+    node.depends_on(dependable)
+  end
+    
+  graph_creator = GraphCreator.new(:none)    
+  graph_creator.node_finder = MockNodeFinder.new(nodes)
+  
+  return graph_creator
+end
+
+def create_graph_creator_with_two_nodes_and_one_dependency
+  return create_dependency_chain_graph_creator('node1/path1.csproj', 'node2/path2.dll')
+end
+
+def create_2_node_graph_creator_with_1_normal_and_1_orphan_dependency
+  node1 = Node.new('file1.csproj')
+  node2 = Node.new('file2.csproj')
+  node1.depends_on(node2)
+  node2.depends_on('non existent file3')
+    
+  graph_creator = GraphCreator.new(:none)    
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2])
+  
+  return graph_creator
+end
+
+def create_2_connected_and_1_disconnected_node_with_an_orphan_dependency_graph_creator
+  node1 = Node.new('file1.csproj')
+  node2 = Node.new('file2.csproj')
+  node3 = Node.new('file3.csproj')
+  node4 = Node.new('file4.csproj')
+  
+  node1.depends_on(node2)
+  
+  #create an orphan dependency of disconnected node file3 because node4 will not be included in the graph
+  node3.depends_on(node4) 
+    
+  graph_creator = GraphCreator.new(:none)    
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2, node3])
+  
+  return graph_creator
+end
+
+def invalid_graph_creators
+  {
+    'graph creator with no nodes' => create_graph_creator_with_no_nodes,
+    'graph creator with only one node' => create_graph_creator_with_only_one_node,
+    'graph creator with three nodes that are equal' => create_graph_creator_with_three_nodes_that_are_equal,
+  }
+end
+

data/spec/unit_spec.opts

@@ -0,0 +1,4 @@
+--format
+specdoc
+--timeout
+20

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:allspec, :website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,35 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/unittests"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--options', "spec/unit_spec.opts"]
+  t.spec_files = FileList['spec/unittests/*_spec.rb']
+end
+
+desc "Run the specs under spec/integrationtests"
+Spec::Rake::SpecTask.new('ispec') do |t|
+  t.spec_opts = ['--options', "spec/integration_spec.opts"]
+  t.spec_files = FileList['spec/integrationtests/*_spec.rb']
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new('allspec') do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--text-summary']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/todo.txt

@@ -0,0 +1,4 @@
+-Separate integration tests form unit tests
+
+
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: depgraph
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.11.0
+platform: ruby
+authors: 
+- Daniel Cadenas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-graphviz
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: optiflag
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.5
+  type: :runtime
+  version_requirements: *id003
+description: A tool to create dependency graph images from source code directories
+email: dcadenas@gmail.com
+executables: 
+- depgraph
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- License.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/depgraph
+- config/hoe.rb
+- config/requirements.rb
+- lib/DepGraph/version.rb
+- lib/dependency_types.yaml
+- lib/dependency_types_manager.rb
+- lib/file_system_node_finder.rb
+- lib/graph_creator.rb
+- lib/graph_image_creator.rb
+- lib/node.rb
+- lib/nodefinders/gems_node_finder.rb
+- lib/nodefinders/test_node_finder.rb
+- script/destroy
+- script/destroy.cmd
+- script/generate
+- script/generate.cmd
+- script/txt2html
+- script/txt2html.cmd
+- setup.rb
+- spec/IntegrationTests/depgraph_spec.rb
+- spec/IntegrationTests/file_system_node_finder_spec.rb
+- spec/IntegrationTests/gems_node_finder_spec.rb
+- spec/IntegrationTests/graph_creator_spec.rb
+- spec/IntegrationTests/graph_image_creator_spec.rb
+- spec/UnitTests/dependency_types_manager_spec.rb
+- spec/UnitTests/file_system_node_finder_spec.rb
+- spec/UnitTests/graph_creator_spec.rb
+- spec/UnitTests/graph_image_creator_spec.rb
+- spec/UnitTests/node_spec.rb
+- spec/integration_spec.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit_spec.opts
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/rspec.rake
+- tasks/website.rake
+- todo.txt
+homepage: http://github.com/dcadenas/depgraph
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: A tool to create dependency graph images from source code directories
+test_files: []
+