Add template for component d3 circle packing view

Author: shreyasbharath

Diff for: .travis.yml

@@ -3,6 +3,7 @@ dist: trusty
 cache: bundler
 sudo: false
 rvm:
+  - 2.4
   - 2.5
 before_install:
   - gem update --system

Diff for: .vscode/launch.json

@@ -24,7 +24,7 @@
       "pathToBundler": "C:/tools/ruby25/bin/bundle.bat",
       "pathToRDebugIDE": "C:/tools/ruby25/bin/rdebug-ide.bat",
       "showDebuggerOutput": true,
-      "args": ["visualise", "-r", "../TileDB", "-f", "dot"]
+      "args": ["visualise_components", "-r", "../TileDB"]
     },
     {
       "name": "Listen for rdebug-ide",

Diff for: README.md

@@ -29,6 +29,16 @@ The pretty `d3` visualisations are directly copied from `objc-dependency-visuali
 
 A huge shout out to the people behind these projects.
 
+## Comparison With Other Tools
+
+### cpp-dependencies
+
+### cinclude2dot
+
+### dep-matrix
+
+
+
 ## Usage
 
 ### Installation

Diff for: TODO.md

@@ -12,6 +12,8 @@
 - [x] Allow user to specify a single component and the tool should print only that component
 - [x] Print out dependency graphs for all components by default if no single component is specified
 - [ ] Use a compiler to get the includes for a file rather than manually scanning the contents
+  - [ ] Command to generate overall file/class dependency graph if a project doesn't have many components
+  - [ ] Command to generate individual file/class dependency graph
   - [ ] Manual scanning does not work when #includes are #ifdefed out for example
   - [ ] <system> include vs "project" include (how will this work for third party sources that are not part of the codebase?)
   - [ ] Work with any type of include relative includes ('blah.h') vs absolute includes ('/path/blah.h') vs relative with path includes ('blah/blah.h')

Diff for: exe/cpp_dependency_graph

@@ -76,7 +76,7 @@ begin
   elsif args['visualise_includes']
     generate_component_include_graph(project_dir, args['--component'], args['--output_format'], args['--output_file'])
   elsif args['visualise_components']
-    # TODO: Output components
+    generate_enclosure_diagram(project_dir, args['--output_file'])
   elsif args['visualise_cyclic_deps']
     generate_cyclic_dependencies(project_dir, args['--output_format'], args['--output_file'])
   end

Diff for: lib/cpp_dependency_graph.rb

@@ -1,38 +1,46 @@
 # frozen_string_literal: true
 
-require_relative 'cpp_dependency_graph/project'
-require_relative 'cpp_dependency_graph/dependency_graph'
-require_relative 'cpp_dependency_graph/include_dependency_graph'
+require_relative 'cpp_dependency_graph/circle_packing_visualiser'
+require_relative 'cpp_dependency_graph/component_dependency_graph'
+require_relative 'cpp_dependency_graph/dir_tree'
 require_relative 'cpp_dependency_graph/graph_to_dot_visualiser'
 require_relative 'cpp_dependency_graph/graph_to_html_visualiser'
+require_relative 'cpp_dependency_graph/include_dependency_graph'
+require_relative 'cpp_dependency_graph/project'
 require_relative 'cpp_dependency_graph/version'
 
 # Generates dependency graphs of a project in various output forms
 module CppDependencyGraph
   def generate_project_graph(project_dir, format, output_file)
     project = Project.new(project_dir)
-    graph = DependencyGraph.new(project)
-    deps = graph.all_component_links
+    graph = ComponentDependencyGraph.new(project)
+    deps = graph.all_links
     generate_visualisation(deps, format, output_file)
   end
 
   def generate_component_graph(project_dir, component, format, output_file)
     project = Project.new(project_dir)
-    graph = DependencyGraph.new(project)
-    deps = graph.component_links(component)
+    graph = ComponentDependencyGraph.new(project)
+    deps = graph.links(component)
     generate_visualisation(deps, format, output_file)
   end
 
   def generate_component_include_graph(project_dir, component_name, format, output_file)
     project = Project.new(project_dir)
     graph = IncludeDependencyGraph.new(project)
-    deps = graph.include_links(component_name)
+    deps = graph.links(component_name)
     generate_visualisation(deps, format, output_file)
   end
 
+  def generate_enclosure_diagram(project_dir, output_file)
+    dir_tree = DirTree.new(project_dir)
+    tree = dir_tree.tree
+    CirclePackingVisualiser.new.generate(tree, output_file)
+  end
+
   def generate_cyclic_dependencies(project_dir, format, file)
     project = Project.new(project_dir)
-    graph = DependencyGraph.new(project)
+    graph = ComponentDependencyGraph.new(project)
     deps = graph.all_cyclic_links
     generate_visualisation(deps, format, file)
   end

Diff for: lib/cpp_dependency_graph/circle_packing_visualiser.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# Outputs a `d3 force graph layout` equipped HTML representation of a dependency graph
+class CirclePackingVisualiser
+  def generate(tree, file)
+    json_tree = JSON.pretty_generate(tree)
+    template_file = resolve_file_path('views/circle_packing.html.template')
+    template = File.read(template_file)
+    contents = format(template, tree: json_tree)
+    File.write(file, contents)
+  end
+
+  private
+
+  def resolve_file_path(path)
+    File.expand_path("../../../#{path}", __FILE__)
+  end
+end

Diff for: lib/cpp_dependency_graph/component_dependency_graph.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'project'
+require_relative 'link'
+require_relative 'cycle_detector'
+
+# Dependency tree/graph of entire project
+class ComponentDependencyGraph
+  def initialize(project)
+    @project = project
+  end
+
+  def all_links
+    @all_links ||= build_hash_links
+  end
+
+  def all_cyclic_links
+    @all_cyclic_links ||= build_cyclic_links
+  end
+
+  def links(name)
+    return {} unless all_links.key?(name)
+    links = incoming_links(name)
+    links.merge!(outgoing_links(name))
+    links
+  end
+
+  private
+
+  def build_hash_links
+    raw_links = @project.source_components.values.map { |c| [c.name, @project.dependencies(c)] }.to_h
+    @cycle_detector ||= CycleDetector.new(raw_links)
+    links = raw_links.map do |source, source_links|
+      c_links = source_links.map { |target| Link.new(source, target, @cycle_detector.cyclic?(source, target)) }
+      [source, c_links]
+    end.to_h
+    links
+  end
+
+  def build_cyclic_links
+    cyclic_links = all_links.select { |_, links| links.any?(&:cyclic?) }
+    cyclic_links.each_value { |links| links.select!(&:cyclic?) }
+  end
+
+  def outgoing_links(name)
+    all_links.slice(name)
+  end
+
+  def incoming_links(target)
+    incoming_c_links = all_links.select { |_, c_links| c_links.any? { |link| link.target == target } }
+    incoming_c_links.map do |source, _|
+      link = Link.new(source, target, @cycle_detector.cyclic?(source, target))
+      [source, [link]]
+    end.to_h
+  end
+end

Diff for: lib/cpp_dependency_graph/cycle_detector.rb

@@ -2,11 +2,11 @@
 
 require_relative 'cyclic_link'
 
-# Detects cycles between components
+# Detects cycles between nodes
 class CycleDetector
-  def initialize(component_links)
-    @cyclic_links = component_links.flat_map do |source, links|
-      links.select { |target| component_links[target].include?(source) }.map do |target|
+  def initialize(links)
+    @cyclic_links = links.flat_map do |source, source_links|
+      source_links.select { |target| links[target].include?(source) }.map do |target|
         [CyclicLink.new(source, target), true]
       end
     end.to_h

Diff for: lib/cpp_dependency_graph/cyclic_link.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-# A special class designed to be used as a key in a hash
+require 'set'
+
+# Represents a cyclic link betwee two nodes, it is special in the sense it is designed to be used as a key in a hash
 class CyclicLink
   attr_reader :node_a
   attr_reader :node_b

Diff for: lib/cpp_dependency_graph/dependency_graph.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# Returns a root directory as a tree of directories
+class DirTree
+  attr_reader :tree
+
+  def initialize(path)
+    @tree ||= File.directory?(path) ? parse_dirs(path) : {}
+  end
+
+  private
+
+  def parse_dirs(path, name = nil)
+    data = {}
+    data[:name] = (name || path)
+    data[:children] = children = []
+    # TODO: Use Dir.map.compact|filter instead here
+    Dir.foreach(path) do |entry|
+      next if ['..', '.'].include?(entry)
+      full_path = File.join(path, entry)
+      next unless File.directory?(full_path)
+      children << parse_dirs(full_path, entry)
+    end
+    data
+  end
+
+  def to_s
+    @tree.to_json
+  end
+end

Diff for: lib/cpp_dependency_graph/dir_tree.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'project'
+require_relative 'link'
+require_relative 'cycle_detector'
+
+# Dependency tree/graph of entire project
+class FileDependencyGraph
+  def initialize(project)
+    @project = project
+  end
+
+  def all_links
+    @all_links ||= build_hash_links
+  end
+
+  def all_cyclic_links
+    @all_cyclic_links ||= build_cyclic_links
+  end
+
+  def links(name)
+    return {} unless all_links.key?(name)
+    links = incoming_links(name)
+    links.merge!(outgoing_links(name))
+    links
+  end
+
+  private
+
+  def build_hash_links
+    raw_links = @project.source_components.values.map { |c| [c.name, @project.dependencies(c)] }.to_h
+    @cycle_detector ||= CycleDetector.new(raw_links)
+    links = raw_links.map do |source, source_links|
+      c_links = source_links.map { |target| Link.new(source, target, @cycle_detector.cyclic?(source, target)) }
+      [source, c_links]
+    end.to_h
+    links
+  end
+
+  def build_cyclic_links
+    cyclic_links = all_links.select { |_, links| links.any?(&:cyclic?) }
+    cyclic_links.each_value { |links| links.select!(&:cyclic?) }
+  end
+
+  def outgoing_links(name)
+    all_links.slice(name)
+  end
+
+  def incoming_links(target)
+    incoming_c_links = all_links.select { |_, c_links| c_links.any? { |link| link.target == target } }
+    incoming_c_links.map do |source, _|
+      link = Link.new(source, target, @cycle_detector.cyclic?(source, target))
+      [source, [link]]
+    end.to_h
+  end
+end

Diff for: lib/cpp_dependency_graph/file_dependency_graph.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Outputs a `graphml` langugage representation of a dependency graph
+class GraphToGraphmlVisualiser
+  def generate(deps, file)
+    # TODO: Implement
+  end
+end