cpp_dependency_graph 0.1.1 → 0.1.2

data/lib/cpp_dependency_graph/project.rb

@@ -2,12 +2,14 @@
 
 require 'find'
 
+require_relative 'include_to_component_resolver'
 require_relative 'source_component'
 
 # Parses all components of a project
 class Project
   def initialize(path)
     @path = path
+    @include_resolver = IncludeToComponentResolver.new(source_components)
   end
 
   def source_components
@@ -15,15 +17,17 @@ class Project
   end
 
   def source_component(name)
-    source_components.detect { |c| c.name == name }
+    return SourceComponent.new('NULL') unless source_components.key?(name)
+    source_components[name]
   end
 
   def dependencies(component)
-    external_includes(component).map { |include| component_for_include(include) }.reject(&:empty?).uniq
+    # TODO: This is repeating the same work twice! component_for_include is called when calling external_includes
+    external_includes(component).map { |include| @include_resolver.component_for_include(include) }.reject(&:empty?).uniq
   end
 
   def external_includes(component)
-    filter_internal_includes(component)
+    @include_resolver.external_includes(component)
   end
 
   private
@@ -31,33 +35,11 @@ class Project
   def build_source_components
     # TODO: Dealing with source components with same dir name?
     dirs = fetch_all_dirs(@path)
-    source_components = dirs.map { |dir| SourceComponent.new(dir) }
-    source_components.reject { |c| c.source_files.size.zero? }
-  end
-
-  def filter_internal_includes(component)
-    # TODO: This is super inefficient, refactor it
-    source_file_basenames = component.source_files.map(&:basename)
-    include_components = component.includes.map { |inc| [inc, component_for_include(inc)] }.to_h
-    filter = include_components.reject { |_, c| c == component.name }
-    filter.keys
-  end
-
-  def component_for_include(include)
-    header_file = source_files.find { |file| file.basename == include }
-    parent_component(header_file)
-  end
-
-  def source_files
-    @source_files ||= source_components.flat_map(&:source_files)
-  end
-
-  def parent_component(header_file)
-    return '' if header_file.nil?
-    files = source_files.select { |file| file.basename_no_extension == header_file.basename_no_extension }
-    corresponding_files = files.reject { |file| file.basename == header_file.basename }
-    return header_file.parent_component if corresponding_files.size == 0
-    corresponding_files[0].parent_component
+    components = dirs.map do |dir|
+      c = SourceComponent.new(dir)
+      [c.name, c]
+    end.to_h
+    components.delete_if { |_, v| v.source_files.size.zero? }
   end
 
   def fetch_all_dirs(source_dir)

data/lib/cpp_dependency_graph/source_component.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
+require_relative 'config'
 require_relative 'source_file'
 
+# Abstracts a source directory containing source files
 class SourceComponent
+  include Config
+
+  attr_reader :path
+
   def initialize(path)
     @path = path
   end
 
-  def path
-    @path
-  end
-
   def name
     @name ||= File.basename(@path)
   end
 
   def source_files
-    @source_files ||= parse_source_files('.{h,hpp,hxx,c,cpp,cxx,cc}')
+    @source_files ||= parse_source_files(source_file_extensions)
   end
 
   def includes
@@ -31,7 +33,6 @@ class SourceComponent
 
   def parse_source_files(extensions)
     path = File.join(@path, File::SEPARATOR) + '*' + extensions
-    files = Dir.glob(path).select { |e| File.file?(e) }
-    files.map { |file| SourceFile.new(file) }
+    Dir.glob(path).map { |e| SourceFile.new(e) if File.file?(e) }.compact
   end
 end

data/lib/cpp_dependency_graph/source_file.rb

@@ -19,7 +19,7 @@ class SourceFile
   end
 
   def header?
-    false     # TODO: Implement check extension
+    false # TODO: Implement check extension
   end
 
   def parent_component
@@ -41,8 +41,9 @@ class SourceFile
   end
 
   def scan_includes
-    # file_contents.scan(/#include "([^"]+)"/).uniq.flatten
-    file_contents.scan(/#include ["|<](.+)["|>]/).uniq.flatten   # TODO: use compiler lib to scan includes? llvm/clang?
+    includes = file_contents.scan(/#include ["|<](.+)["|>]/) # TODO: use compiler lib to scan includes? llvm/clang?
+    includes.uniq!
+    includes.flatten
   end
 
   def file_contents

data/lib/cpp_dependency_graph/tsortable_hash.rb

@@ -2,6 +2,7 @@
 
 require 'tsort'
 
+# Hash that topologically sorts itself upon insertion of a key
 class TsortableHash < Hash
   include TSort
 

data/lib/cpp_dependency_graph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CppDependencyGraph
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/views/circle_packing.html.template

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<style>
+
+.node {
+  cursor: pointer;
+}
+
+.node:hover {
+  stroke: #000;
+  stroke-width: 1.5px;
+}
+
+.node--leaf {
+  fill: white;
+}
+
+.label {
+  font: 11px "Helvetica Neue", Helvetica, Arial, sans-serif;
+  text-anchor: middle;
+  text-shadow: 0 1px 0 #fff, 1px 0 0 #fff, -1px 0 0 #fff, 0 -1px 0 #fff;
+}
+
+.label,
+.node--root,
+.node--leaf {
+  pointer-events: none;
+}
+
+</style>
+<svg width="960" height="960"></svg>
+<script src="https://d3js.org/d3.v4.min.js"></script>
+<script>
+
+var svg = d3.select("svg"),
+    margin = 20,
+    diameter = +svg.attr("width"),
+    g = svg.append("g").attr("transform", "translate(" + diameter / 2 + "," + diameter / 2 + ")");
+
+var color = d3.scaleLinear()
+    .domain([-1, 5])
+    .range(["hsl(152,80%%,80%%)", "hsl(228,30%%,40%%)"])
+    .interpolate(d3.interpolateHcl);
+
+var pack = d3.pack()
+    .size([diameter - margin, diameter - margin])
+    .padding(2);
+
+var root = %{tree};
+
+root = d3.hierarchy(root)
+    .sum(function(d) { return d.size; })
+    .sort(function(a, b) { return b.value - a.value; });
+
+var focus = root,
+    nodes = pack(root).descendants(),
+    view;
+
+var circle = g.selectAll("circle")
+  .data(nodes)
+  .enter().append("circle")
+    .attr("class", function(d) { return d.parent ? d.children ? "node" : "node node--leaf" : "node node--root"; })
+    .style("fill", function(d) { return d.children ? color(d.depth) : null; })
+    .on("click", function(d) { if (focus !== d) zoom(d), d3.event.stopPropagation(); });
+
+var text = g.selectAll("text")
+  .data(nodes)
+  .enter().append("text")
+    .attr("class", "label")
+    .style("fill-opacity", function(d) { return d.parent === root ? 1 : 0; })
+    .style("display", function(d) { return d.parent === root ? "inline" : "none"; })
+    .text(function(d) { return d.data.name; });
+
+var node = g.selectAll("circle,text");
+
+svg
+    .style("background", color(-1))
+    .on("click", function() { zoom(root); });
+
+zoomTo([root.x, root.y, root.r * 2 + margin]);
+
+function zoom(d) {
+  var focus0 = focus; focus = d;
+
+  var transition = d3.transition()
+      .duration(d3.event.altKey ? 7500 : 750)
+      .tween("zoom", function(d) {
+        var i = d3.interpolateZoom(view, [focus.x, focus.y, focus.r * 2 + margin]);
+        return function(t) { zoomTo(i(t)); };
+      });
+
+  transition.selectAll("text")
+    .filter(function(d) { return d.parent === focus || this.style.display === "inline"; })
+      .style("fill-opacity", function(d) { return d.parent === focus ? 1 : 0; })
+      .on("start", function(d) { if (d.parent === focus) this.style.display = "inline"; })
+      .on("end", function(d) { if (d.parent !== focus) this.style.display = "none"; });
+}
+
+function zoomTo(v) {
+  var k = diameter / v[2]; view = v;
+  node.attr("transform", function(d) { return "translate(" + (d.x - v[0]) * k + "," + (d.y - v[1]) * k + ")"; });
+  circle.attr("r", function(d) { return d.r * k; });
+}
+
+</script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpp_dependency_graph
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Shreyas Balakrishna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -81,75 +81,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: debase
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: debase
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.55'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.55'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.54'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -165,30 +165,46 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.17'
 - !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: "  Generates interactive dependency visualisations (dot, d3.js) to study
   the architecture of C/C++ projects in detail\n"
 email:
-- shreyasbharath@users.noreply.github.com>
+- shreyasbharath@gmail.com
 executables:
 - cpp_dependency_graph
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".gitignore"
 - ".rspec"
+- ".rubocop_todo.yml"
 - ".vscode/launch.json"
 - ".vscode/tasks.json"
 - CODE_OF_CONDUCT.md
@@ -200,10 +216,13 @@ files:
 - bin/console
 - bin/setup
 - cpp_dependency_graph.gemspec
+- docs/README.md
+- examples/leveldb_cyclic_deps.svg
 - examples/leveldb_overall.png
 - examples/leveldb_overall.svg
 - examples/leveldb_overall_d3.png
 - examples/leveldb_overall_d3.svg
+- examples/rethinkdb_cyclic_deps.svg
 - examples/rethinkdb_queue_component.png
 - examples/rethinkdb_queue_component.svg
 - examples/rethinkdb_queue_component_d3.png
@@ -217,18 +236,25 @@ files:
 - exe/cpp_dependency_graph
 - lib/cpp_dependency_graph.rb
 - lib/cpp_dependency_graph/bidirectional_hash.rb
-- lib/cpp_dependency_graph/component_link.rb
+- lib/cpp_dependency_graph/circle_packing_visualiser.rb
+- lib/cpp_dependency_graph/component_dependency_graph.rb
+- lib/cpp_dependency_graph/config.rb
 - lib/cpp_dependency_graph/cycle_detector.rb
 - lib/cpp_dependency_graph/cyclic_link.rb
-- lib/cpp_dependency_graph/dependency_graph.rb
-- lib/cpp_dependency_graph/graph_to_html_converter.rb
-- lib/cpp_dependency_graph/graph_visualiser.rb
+- lib/cpp_dependency_graph/dir_tree.rb
+- lib/cpp_dependency_graph/file_dependency_graph.rb
+- lib/cpp_dependency_graph/graph_to_dot_visualiser.rb
+- lib/cpp_dependency_graph/graph_to_graphml_visualiser.rb
+- lib/cpp_dependency_graph/graph_to_html_visualiser.rb
 - lib/cpp_dependency_graph/include_dependency_graph.rb
+- lib/cpp_dependency_graph/include_to_component_resolver.rb
+- lib/cpp_dependency_graph/link.rb
 - lib/cpp_dependency_graph/project.rb
 - lib/cpp_dependency_graph/source_component.rb
 - lib/cpp_dependency_graph/source_file.rb
 - lib/cpp_dependency_graph/tsortable_hash.rb
 - lib/cpp_dependency_graph/version.rb
+- views/circle_packing.html.template
 - views/index.html.template
 homepage: https://github.com/shreyasbharath/cpp_dependency_graph
 licenses: