fixup! fixup! fixup! fixup! fixup! Blah

Author: shreyasbharath

README.md

@@ -37,8 +37,6 @@ A huge shout out to the people behind these projects.
 
 ### dep-matrix
 
-
-
 ## Usage
 
 ### Installation
@@ -89,6 +87,18 @@ Here's a component include dependency visualisation generated for the `queue` co
 
 ![Queue include graph d3](docs/examples/rethinkdb_queue_include_d3.svg)
 
+### File include dependency graph
+
+This will highlight include dependencies of files globally within the project
+
+`cpp_dependency_graph visualise_includes -r spec\test\example_project\ -c Engine`
+
+Here's a component include dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)
+
+![Queue include graph dot](docs/examples/rethinkdb_queue_include.svg)
+
+![Queue include graph d3](docs/examples/rethinkdb_queue_include_d3.svg)
+
 ### Cyclic dependencies only graph
 
 This will highlight cyclic dependencies between components within a project. This is especially useful for targeted refactoring activities to reduce coupling between components.

exe/cpp_dependency_graph

@@ -37,8 +37,11 @@ doc = <<DOCOPT
   Cpp Dependency Graph
 
   Usage:
-    cpp_dependency_graph visualise --root_dir <argument> [--component <component>] [--output_file <file>] [--output_format <format>]
-    cpp_dependency_graph visualise_includes --root_dir <argument> [--file <file>] [--component <component>] [--output_file <file>] [--output_format <format>]
+    cpp_dependency_graph visualise_component --root_dir <argument> --component <component> [--output_file <file>] [--output_format <format>]
+    cpp_dependency_graph visualise_project --root_dir <argument> [--output_file <file>] [--output_format <format>]
+    cpp_dependency_graph visualise_component_includes --root_dir <argument> --component <component> [--output_file <file>] [--output_format <format>]
+    cpp_dependency_graph visualise_header_includes --root_dir <argument> --header <header> [--output_file <file>] [--output_format <format>]
+    cpp_dependency_graph visualise_project_includes --root_dir <argument> [--output_file <file>] [--output_format <format>]
     cpp_dependency_graph visualise_components --root_dir <argument> [--output_file <file>] [--output_format <format>]
     cpp_dependency_graph visualise_cyclic_deps --root_dir <argument> [--component <component>] [--output_file <file>] [--output_format <format>]
     cpp_dependency_graph -h | --help | -v | --version
@@ -47,9 +50,10 @@ doc = <<DOCOPT
     -h --help                   show this help message and exit
     -v --version                show version and exit
     -r --root_dir dir           top level root directory of C/C++ project
-    -c --component component    component generate visualisation for (case sensitive!)
     -o --output_file file       name of output file to be generated [default: deps.html]
     -f --output_format format   format of output file (dot, html, graphml, json) [default: html]
+    --component component       component generate visualisation for (case sensitive!)
+    --header file               header file to generate visualisation for (case sensitive!)
 DOCOPT
 
 begin
@@ -67,20 +71,16 @@ begin
     Kernel.exit(1)
   end
 
-  if args['visualise']
-    if args['--component']
-      generate_component_graph(project_dir, args['--component'], args['--output_format'], args['--output_file'])
-    else
-      generate_project_graph(project_dir, args['--output_format'], args['--output_file'])
-    end
-  elsif args['visualise_includes']
-    if args['--component']
-      generate_component_include_graph(project_dir, args['--component'], args['--output_format'], args['--output_file'])
-    elsif args['--file']
-      generate_file_include_graph(project_dir, args['--file'], args['--output_format'], args['--output_file'])
-    else
-      generate_project_include_graph(project_dir, args['--output_format'], args['--output_file'])
-    end
+  if args['visualise_component']
+    generate_component_graph(project_dir, args['--component'], args['--output_format'], args['--output_file'])
+  elsif args['visualise_project']
+    generate_project_graph(project_dir, args['--output_format'], args['--output_file'])
+  elsif args['visualise_component_includes']
+    generate_component_include_graph(project_dir, args['--component'], args['--output_format'], args['--output_file'])
+  elsif args['visualise_header_includes']
+    generate_file_include_graph(project_dir, args['--header'], args['--output_format'], args['--output_file'])
+  elsif args['visualise_project_includes']
+    generate_project_include_graph(project_dir, args['--output_format'], args['--output_file'])
   elsif args['visualise_components']
     generate_enclosure_diagram(project_dir, args['--output_file'])
   elsif args['visualise_cyclic_deps']

lib/cpp_dependency_graph.rb

@@ -29,7 +29,7 @@ def generate_component_graph(project_dir, component, format, output_file)
   def generate_file_include_graph(project_dir, file_name, format, output_file)
     project = Project.new(project_dir)
     graph = IncludeFileDependencyGraph.new(project)
-    deps = graph.file_links(component_name)
+    deps = graph.links(file_name)
     generate_visualisation(deps, format, output_file)
   end
 

lib/cpp_dependency_graph/graph_to_dot_visualiser.rb

@@ -8,7 +8,7 @@ def generate(deps, file)
     @g = GraphViz.new('dependency_graph')
     nodes = create_nodes(deps)
     connect_nodes(deps, nodes)
-    File.write(file, @g.to_dot)
+    @g.output(:dot => file)
   end
 
   private

lib/cpp_dependency_graph/include_file_dependency_graph.rb

@@ -4,8 +4,6 @@
 require_relative 'link'
 require_relative 'cycle_detector'
 
-require 'pp'
-
 # Returns a hash of individual file include links
 class IncludeFileDependencyGraph
   def initialize(project)

lib/cpp_dependency_graph/version.rb

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