cpp_dependency_graph 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feac9cd85c6b1df61ad89cb9b292d4fd927c2256a1b9cb42a816065b87c3012f
-  data.tar.gz: c055532215dd55a1e04e5e27a679aa805797f714f5b697e23317729802b8740f
+  metadata.gz: f5439e5df96869f8e42239ae1dd7963b1c8f12bb72f66b9931e19ffa7ba8f48f
+  data.tar.gz: 7793b519e5fd0915479f6181b84954cd06525da8b59bc6e1e67d3bb8eb053c5e
 SHA512:
-  metadata.gz: 381fef815402ed98ab960277a0ed0bfb06a52c89c8029696453940306e309356aab7867b6c20e8af7189e647203a3dc0e4721249ccf200acae8d7abecc56dc44
-  data.tar.gz: 3354743837ae6ac501d7b5809c330fa2a9e3e0f9a1686f2409e8ac6f10bfba0de1abd7ef26a640b1986c79c3ddabb24fb251e38a11cf17650b178fa245348dfe
+  metadata.gz: 834d2e3aa16613a92bc308b726d32bed789fa770e0562cee8aee8ce308bbee69888698ebc276b315c74f62207c0bf7f66163f365eb407170044c865dadc60233
+  data.tar.gz: 0a83134a6ce392d0f582354f21c8a641e0d58fb70b810b136defb0e92236c68db4d4e46cbf12366f2ab07202784936a0750148a36e6c35cb77e1a117967863bf

data/README.md

@@ -51,17 +51,17 @@ A huge shout out to the people behind these projects.
 
 ### Overall component dependency graph
 
-To generate the overall component depenency graph for a project, use it like so -
+To generate the overall component dependency graph for a project, use it like so -
 
 `cpp_dependency_graph visualise -r spec\test\example_project\ -o deps.dot -f dot`
 
 Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)
 
-![Dot](examples/leveldb_overall.svg)
+![Dot](docs/examples/leveldb_overall.svg)
 
-![d3.js visualisation of leveldb](examples/leveldb_overall_d3.svg)
+![d3.js visualisation of leveldb](docs/examples/leveldb_overall_d3.svg)
 
-![d3.js visualisation of rocksdb](examples/rocksdb_overall_d3.svg)
+![d3.js visualisation of rocksdb](docs/examples/rocksdb_overall_d3.svg)
 
 **NOTE** - If your project has a large number of components (> 100 and lots of connections between them), then generation (and subsequent rendering) may take some time.
 
@@ -73,9 +73,9 @@ This will highlight the dependencies coming in and going out of a specific compo
 
 Here's a component dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)
 
-![Queue component dot visualisation](examples/rethinkdb_queue_component.svg)
+![Queue component dot visualisation](docs/examples/rethinkdb_queue_component.svg)
 
-![Queue component d3 visualisation](examples/rethinkdb_queue_component_d3.svg)
+![Queue component d3 visualisation](docs/examples/rethinkdb_queue_component_d3.svg)
 
 ### Component include dependency graph
 
@@ -85,9 +85,9 @@ This will highlight dependencies of includes within a specific component
 
 Here's a component include dependency visualisation generated for the `queue` component in [rethinkdb](https://github.com/rethinkdb/rethinkdb)
 
-![Queue include graph dot](examples/rethinkdb_queue_include.svg)
+![Queue include graph dot](docs/examples/rethinkdb_queue_include.svg)
 
-![Queue include graph d3](examples/rethinkdb_queue_include_d3.svg)
+![Queue include graph d3](docs/examples/rethinkdb_queue_include_d3.svg)
 
 ### Cyclic dependencies only graph
 
@@ -97,9 +97,9 @@ This will highlight cyclic dependencies between components within a project. Thi
 
 Here's the cyclic dependencies only visualisation generated for [rethinkdb](https://github.com/rethinkdb/rethinkdb) and [leveldb](https://github.com/google/leveldb)
 
-![rethinkdb](examples/rethinkdb_cyclic_deps.svg)
+![rethinkdb](docs/examples/rethinkdb_cyclic_deps.svg)
 
-![leveldb](examples/leveldb_cyclic_deps.svg)
+![leveldb](docs/examples/leveldb_cyclic_deps.svg)
 
 ## Development
 

data/docs/README.md

@@ -3,10 +3,24 @@ layout: home
 title: "Github Pages for Non-Developers: Build Web Portfolios From Scratch"
 ---
 
-<section class="sec">
-This is a very narrowly focused tutorial about web development aimed at novices who have absolutely no web dev experience, nor have used [Github](https://github.com) or [Git](http://git-scm.com/), or even the command line.
+# Cpp Dependency Graph
 
-The end product is a web portfolio, built (mostly) from scratch, that is easy to edit and easy to publish _anywhere_ &ndash; Github merely provides an easy starting point.
+Generates useful component dependency visualisations (`dot` or `d3.js`) to study the architecture of C/C++ projects.
 
-(_This tutorial is in progress. [Feel free to fork it on Github](http://github.com/dannguyen/github-for-portfolios)_)
-</section>
+Why do all the other languages have awesome tools to analyse codebases but C/C++ does not?
+
+It's time to change that.
+
+This tool aims to -
+
+- provide multiple views into the architecture of a codebase
+- generate views at multiple levels of the architecture
+- make the resulting views genuinely useful, rich, dynamic and interactive (static views are boring)
+
+## Inspiration
+
+This tool is inspired by a number of projects [rubrowser](http://www.emadelsaid.com/rubrowser/), [cpp-dependencies](https://github.com/tomtom-international/cpp-dependencies) and [objc-dependency-visualizer](https://github.com/PaulTaykalo/objc-dependency-visualizer).
+
+The pretty `d3` visualisations are directly copied from `objc-dependency-visualiser`.
+
+A huge shout out to the people behind these projects.

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/docs/index.md

@@ -0,0 +1,43 @@
+---
+layout: page
+title: Cpp Dependency Graph
+tagline: Visualise C/C++ projects with amazing visualisations
+description: Tutorial on how to use Cpp Dependency Graph
+---
+
+# Cpp Dependency Graph
+
+Generates useful component dependency visualisations (`dot` or `d3.js`) to study the architecture of C/C++ projects.
+
+Why do all the other languages have awesome tools to analyse codebases but C/C++ does not?
+
+It's time to change that.
+
+This tool aims to -
+
+- provide multiple views into the architecture of a codebase
+- generate views at multiple levels of the architecture
+- make the resulting views genuinely useful, rich, dynamic and interactive (static views are boring)
+
+## Inspiration
+
+This tool is inspired by a number of projects [rubrowser](http://www.emadelsaid.com/rubrowser/), [cpp-dependencies](https://github.com/tomtom-international/cpp-dependencies) and [objc-dependency-visualizer](https://github.com/PaulTaykalo/objc-dependency-visualizer).
+
+The pretty `d3` visualisations are directly copied from `objc-dependency-visualiser`.
+
+A huge shout out to the people behind these projects.
+
+## Usage tutorial
+### Overall component dependency graph
+
+To generate the overall component dependency graph for a project, use it like so -
+
+`cpp_dependency_graph visualise -r spec\test\example_project\ -o deps.dot -f dot`
+
+Below is the overall `dot` and `d3` component dependency visualisations for [leveldb](https://github.com/google/leveldb)
+
+![Dot](examples/leveldb_overall.svg)
+
+![d3.js visualisation of leveldb](examples/leveldb_overall_d3.svg)
+
+![d3.js visualisation of rocksdb](examples/rocksdb_overall_d3.svg)

data/lib/cpp_dependency_graph/dir_tree.rb

@@ -17,7 +17,7 @@ class DirTree
   private
 
   def parse_dirs(path, name = nil)
-    data = Hash.new{|h, k| h[k] = []}
+    data = Hash.new { |h, k| h[k] = [] }
     data[:name] = (name || path)
     # TODO: Use Dir.map.compact|filter instead here
     Dir.foreach(path) do |entry|

data/lib/cpp_dependency_graph/source_file.rb

@@ -47,6 +47,12 @@ class SourceFile
   end
 
   def file_contents
-    @file_contents ||= File.read(@path)
+    @file_contents ||= sanitised_file_contents
+  end
+
+  def sanitised_file_contents
+    contents = File.read(@path)
+    return contents if contents.valid_encoding?
+    contents.encode('UTF-16be', invalid: :replace, replace: '?').encode('UTF-8')
   end
 end

data/lib/cpp_dependency_graph/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpp_dependency_graph
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shreyas Balakrishna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -217,22 +217,24 @@ files:
 - 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
-- examples/rethinkdb_queue_component_d3.svg
-- examples/rethinkdb_queue_include.png
-- examples/rethinkdb_queue_include.svg
-- examples/rethinkdb_queue_include_d3.png
-- examples/rethinkdb_queue_include_d3.svg
-- examples/rocksdb_overall_d3.svg
-- examples/rocksdb_table_component.png
+- docs/_config.yml
+- docs/examples/leveldb_cyclic_deps.svg
+- docs/examples/leveldb_overall.png
+- docs/examples/leveldb_overall.svg
+- docs/examples/leveldb_overall_d3.png
+- docs/examples/leveldb_overall_d3.svg
+- docs/examples/rethinkdb_cyclic_deps.svg
+- docs/examples/rethinkdb_queue_component.png
+- docs/examples/rethinkdb_queue_component.svg
+- docs/examples/rethinkdb_queue_component_d3.png
+- docs/examples/rethinkdb_queue_component_d3.svg
+- docs/examples/rethinkdb_queue_include.png
+- docs/examples/rethinkdb_queue_include.svg
+- docs/examples/rethinkdb_queue_include_d3.png
+- docs/examples/rethinkdb_queue_include_d3.svg
+- docs/examples/rocksdb_overall_d3.svg
+- docs/examples/rocksdb_table_component.png
+- docs/index.md
 - exe/cpp_dependency_graph
 - lib/cpp_dependency_graph.rb
 - lib/cpp_dependency_graph/bidirectional_hash.rb