DepGraph 0.8.0 → 0.9.0

data/spec/spec_helper.rb

@@ -11,10 +11,10 @@ dir = File.expand_path(File.dirname(__FILE__))
 $LOAD_PATH.unshift("#{dir}/") 
 $LOAD_PATH.unshift("#{dir}/../lib") 
 
-require 'dependable_filter_manager'
-require 'graph'
+require 'dependency_types_manager'
+require 'graph_image_creator'
 def dependency_types
-  DepGraph::DependableFilterManager.types
+  DepGraph::DependencyTypesManager.types
 end
 
 def non_empty_file_created(file_name)
@@ -22,102 +22,164 @@ def non_empty_file_created(file_name)
 end
 
 def non_existent_filter_type
-  DependableFilterManager.types.join + 'thisdoesntexist'
+  DependencyTypesManager.types.join + 'thisdoesntexist'
 end
 
 ########## Stubs ###########
-class MockDependentFinder
-  def initialize(dependents)
-    @dependents = dependents
+class MockNodeFinder
+  def initialize(nodes)
+    @nodes = nodes
   end
     
-  def get_dependents
-    @dependents
+  def get_nodes
+    @nodes
   end
 end
   
-class NoOutputGraph < DepGraph::Graph
+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 {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_dependents
+def create_graph_creator_with_no_nodes
   graph_creator = GraphCreator.new
-  graph_creator.dependent_finder = MockDependentFinder.new([])
+  graph_creator.node_finder = MockNodeFinder.new([])
   
   return graph_creator
 end
 
-def create_graph_creator_with_only_one_dependent
+def create_graph_creator_with_only_one_node
   graph_creator = GraphCreator.new
-  graph_creator.dependent_finder = MockDependentFinder.new([Dependent.new('dependent/path')])  
+  graph_creator.node_finder = MockNodeFinder.new([Node.new('node/path')])  
   
   return graph_creator
 end
 
-def create_graph_creator_with_three_dependents_that_are_equal
-  dependent1 = Dependent.new('directory/path')
-  dependent2 = Dependent.new('directory/path')
-  dependent3 = Dependent.new('directory/anotherdir/path')
+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.dependent_finder = MockDependentFinder.new([dependent1, dependent2, dependent3])
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2, node3])
 
   return graph_creator
 end
 
-def create_graph_creator_with_two_dependents_and_no_dependencies
-  dependent1 = Dependent.new('dependent1/path1')
-  dependent2 = Dependent.new('dependent2/path2')
+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.dependent_finder = MockDependentFinder.new([dependent1, dependent2])
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2])
 
   return graph_creator
 end
 
-def create_dependency_chain_graph_creator(*nodes)
-  dependents = []
+def create_dependency_chain_graph_creator(*node_names)
+  nodes = []
 
-  nodes.each do |node|
-    dependents << Dependent.new(node)
+  node_names.each do |node|
+    nodes << Node.new(node)
   end
 
-  dependents.each_cons(2) do |dependent, dependable|
-    dependent.depends_on(dependable)
+  nodes.each_cons(2) do |node, dependable|
+    node.depends_on(dependable)
   end
     
   graph_creator = GraphCreator.new(:none)    
-  graph_creator.dependent_finder = MockDependentFinder.new(dependents)
+  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('dependent1/path1.csproj', 'dependent2/path2.dll')
+  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_graph_creator_with_two_nodes_and_one_orphan_dependency
-  dependent1 = Dependent.new('file1.csproj')
-  dependent2 = Dependent.new('file2.csproj')
-  dependent2.depends_on('file3')
+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.dependent_finder = MockDependentFinder.new([dependent1, dependent2])
+  graph_creator.node_finder = MockNodeFinder.new([node1, node2, node3])
   
   return graph_creator
 end
 
 def invalid_graph_creators
   {
-    'graph creator with no dependents' => create_graph_creator_with_no_dependents,
-    'graph creator with only one dependent' => create_graph_creator_with_only_one_dependent,
-    'graph creator with three dependents that are equal' => create_graph_creator_with_three_dependents_that_are_equal,
-    'graph creator with an orphan depencency' => create_graph_creator_with_two_nodes_and_one_orphan_dependency
+    '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,5 @@
+--format
+specdoc
+--timeout
+20
+--diff

data/tasks/deployment.rake

@@ -8,7 +8,7 @@ task :deploy => [:check_version, :website, :release] do
 end
 
 desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
-task :local_deploy => [:spec, :website_generate, :install_gem]
+task :local_deploy => [:allspec, :website_generate, :install_gem]
 
 task :check_version do
   unless ENV['VERSION']

data/tasks/rspec.rake

@@ -14,10 +14,22 @@ EOS
   exit(0)
 end
 
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/*_spec.rb']
+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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: DepGraph
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - "Daniel Cadenas Ni\xF3n"
@@ -9,13 +9,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-13 00:00:00 -03:00
+date: 2008-03-16 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
 description: A tool to create dependency graph images from source code directories
 email: 
-- depgraph-devel@rubyforge.org
+- dcadenas@gmail.com
 executables: 
 - depgraph
 extensions: []
@@ -25,7 +25,6 @@ extra_rdoc_files:
 - License.txt
 - Manifest.txt
 - README.txt
-- todo.txt
 files: 
 - History.txt
 - License.txt
@@ -36,12 +35,13 @@ files:
 - config/hoe.rb
 - config/requirements.rb
 - lib/DepGraph/version.rb
-- lib/dependable_filter_manager.rb
+- lib/dependency_types_manager.rb
 - lib/dependency_types.yaml
-- lib/dependent.rb
-- lib/file_system_dependent_finder.rb
-- lib/graph.rb
+- lib/node.rb
+- lib/file_system_node_finder.rb
+- lib/graph_image_creator.rb
 - lib/graph_creator.rb
+- lib/nodefinders/test_node_finder.rb
 - script/destroy
 - script/destroy.cmd
 - script/generate
@@ -49,19 +49,23 @@ files:
 - 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/IntegrationTests/depgraph_spec.rb
+- spec/IntegrationTests/file_system_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/node_spec.rb
+- spec/UnitTests/graph_creator_spec.rb
+- spec/UnitTests/graph_image_creator_spec.rb
+- spec/UnitTests/file_system_node_finder_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
 has_rdoc: true
 homepage: http://DepGraph.rubyforge.org
 post_install_message: 
@@ -90,10 +94,13 @@ signing_key:
 specification_version: 2
 summary: A tool to create dependency graph images from source code directories
 test_files: 
-- 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/IntegrationTests/depgraph_spec.rb
+- spec/IntegrationTests/file_system_node_finder_spec.rb
+- spec/IntegrationTests/graph_creator_spec.rb
+- spec/IntegrationTests/graph_image_creator_spec.rb
 - spec/spec_helper.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

data/lib/dependent.rb

@@ -1,73 +0,0 @@
-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

@@ -1,44 +0,0 @@
-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/spec/dependent_spec.rb

@@ -1,102 +0,0 @@
-require File.dirname(__FILE__) + "/spec_helper"
-require 'stringio'
-require 'dependent' 
-require 'rubygems'
-require 'spec'
-include DepGraph
-
-describe Dependent do
-  it 'should not accept empty uris in the constructor' do
-    lambda{Dependent.new('')}.should raise_error
-  end
-  
-  it 'should have a non empty name' do
-    dependent = Dependent.new('a')
-    dependent.name.should_not be_empty
-  end
-  
-  it 'should have the name of the file specified in the constructor excluding the extension' do
-    dependent = Dependent.new('/directory1/directory2/file.name.ext')
-    dependent.name.should == 'file.name'
-  end
-  
-  it 'should be equal to another dependent with the same name' do
-    dependent1 = Dependent.new('abc')
-    dependent2 = Dependent.new('abc')
-    dependent3 = Dependent.new('abd')
-    
-    dependent1.should == dependent2
-    dependent1.should be_eql(dependent2)
-
-    dependent1.should_not == dependent3
-    dependent1.should_not be_eql(dependent3)
-    
-    dependent2.should_not == dependent3
-    dependent2.should_not be_eql(dependent3)
-  end
-  
-  it 'should allow setting dependent dependents' do
-    dependent = Dependent.new('a')
-    dependent.depends_on('b')
-    
-    dependent.dependencies.size.should == 1
-  end
-  
-  it 'should allow querying for a dependent dependent' do
-    dependent = Dependent.new('a')
-    dependent.depends_on('b')
-    
-    dependent.depends_on?('b').should be_true
-    dependent.depends_on?('c').should be_false
-  end
-  
-  it 'should be able to get the dependencies to csproj and dll files from a string' do
-    dependent = Dependent.new('a', :csproj)
-    dependencies_string = 'from this string the dependable to "\\a.dir\\dependent1.csproj", \n"\\tgg.hyhy\\dependent2.dll" and "dependent3.csproj" should be found'
-    
-    dependent.load_dependencies_from_string(dependencies_string)
-
-    dependent.dependencies.should == ["dependent1", "dependent2", "dependent3"]
-  end
-  
-  it 'should be able to use a custom regexp filter to get the dependent dependencies from a string' do
-    dependent = Dependent.new('a')
-    dependencies_string = 'from this string the dependable to dependent.csproj \n and dependent1.dll should be found'
-    dependent.dependable_filter = /\s([^\s]+)\.(csproj|dll)[^\w]/
-    dependent.dependable_filter_capture_group_index = 0
-    
-    dependent.load_dependencies_from_string(dependencies_string)
-
-    dependent.dependencies.should == ["dependent", "dependent1"]
-  end
-  
-  it 'should be able to select the capture group that must be used in the dependable custom regexp filter' do
-    dependent = Dependent.new('a')
-    dependencies_string = 'from this string the dependable to prefix.dependent.csproj \n and prefix.dependent1.dll should be found'
-    dependent.dependable_filter = /\s(prefix\.)([^\s]+)\.(csproj|dll)[^\w]/
-    dependent.dependable_filter_capture_group_index = 1 
-    
-    dependent.load_dependencies_from_string(dependencies_string)
-
-    dependent.dependencies.should == ["dependent", "dependent1"]
-  end
-  
-  it 'should ignore repeated dependencies in the string' do
-    dependent = Dependent.new('a', :csproj)
-    dependencies_string = 'this string has only one dependable that is repeated 3 times: "\\a.dir\\dependent.csproj", \n"\\tgg.hyhy\\dependent.dll" and "dependent.csproj"'
-    
-    dependent.load_dependencies_from_string(dependencies_string)
-
-    dependent.dependencies.should == ["dependent"]
-  end
-  
-  it 'should ignore the capture group index if the dependable filter regexp has no capture groups' do
-    dependent = Dependent.new('a')
-    dependent.dependable_filter = /dep[0-9]/
-    dependent.dependable_filter_capture_group_index = 1 
-    
-    dependent.load_dependencies_from_string('dep1 is in the first line \n in the second dep2')
-    
-    dependent.dependencies.size.should == 2
-  end
-end

data/spec/file_system_dependent_finder_spec.rb

@@ -1,48 +0,0 @@
-require File.dirname(__FILE__) + "/spec_helper"
-require 'file_system_dependent_finder'
-require 'rubygems'
-gem 'filetesthelper'
-require 'filetesthelper'
-require 'spec'
-
-include FileTestHelper
-include DepGraph
-
-describe FileSystemDependentFinder, '(integration tests)' do
-  it 'should search only in the specified directories' do
-      with_files('good1/file1' => '', 'good2/file2' => '', 'bad/file3' => '') do
-        dependent_finder = FileSystemDependentFinder.new(non_existent_filter_type)
-        dependent_finder.dirs = ['good1', 'good2']
-        
-        dependents = dependent_finder.get_dependents
-        dependents.should == ['file1', 'file2']
-      end
-  end
-end
-
-#To setup the test files for each filter type, include three sample dependent files
-#and make the first file, named 'a' depend on the next two, named 'b' and 'c'
-test_set = {
-  :ruby_requires => {'a.rb' => 'require "b"\nrequire "c"', 'dir/b.rb' => '', 'dir/c.rb' => '', 'not_a_ruby_file' => ''},
-  :csproj => {'a.csproj' => '"b.csproj"\n"c.csproj"', 'dir/b.csproj' => '', 'dir/c.csproj' => '', 'not_a_csproj_file' => ''}
-}
-  
-dependency_types.each do |filter_type|
-  test_files = test_set[filter_type]
-  
-  describe FileSystemDependentFinder, "for #{filter_type.to_s} (integration tests)" do
-    it "should find the correct number of dependents" do
-      with_files(test_files) do
-        dependents = FileSystemDependentFinder.new(filter_type).get_dependents
-        dependents.should == ['a', 'b', 'c']
-      end
-    end
-    it "should correctly find the dependencies from each file" do
-      with_files(test_files) do
-        dependent = FileSystemDependentFinder.new(filter_type).get_dependents[0]
-        dependent.should_not be_nil
-        dependent.dependencies.should == ['b', 'c']
-      end
-    end
-  end
-end