Enable all cops

Author: shreyasbharath

.gitattributes

@@ -0,0 +1,2 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto

.rubocop.yml

@@ -1,54 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.5
-  DisabledByDefault: true
+  DisabledByDefault: false
 
 Metrics/LineLength:
-  Enabled: true
   Max: 140
-
-Style/HashSyntax:
-  Enabled: true
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/MultilineIfThen:
-  Enabled: true
-
-Style/MethodDefParentheses:
-  Enabled: true
-
-Style/BracesAroundHashParameters:
-  Enabled: true
-
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/Tab:
-  Enabled: true
-
-Layout/EmptyLines:
-  Enabled: true
-
-Layout/TrailingBlankLines:
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Enabled: true
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/CaseIndentation:
-  Enabled: true
-
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable

.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-04-08 15:14:25 +1200 using RuboCop version 0.54.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 32
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'exe/cpp_dependency_graph'

.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", "--root_dir", "../protobuf/src"]
+      "args": ["visualise", "-r", "../TileDB", "-f", "dot"]
     },
     {
       "name": "Listen for rdebug-ide",

Gemfile

@@ -2,6 +2,6 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| 'https://github.com/shreyasbharath/cpp_dependency_graph' }
+git_source(:github) { |_| 'https://github.com/shreyasbharath/cpp_dependency_graph' }
 
 gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

TODO.md

@@ -5,6 +5,7 @@
   - [ ] Create a github.io homepage
   - [ ] Add interactive `html` or `svg` examples to homepage
   - [ ] Add a [CONTRIBUTING.md](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md)
+  - [ ] Ruby gem docs
 - [ ] Progress messages
   - [ ] Progress bar?
 - [x] Allow user to specify a single component and the tool should print only that component
@@ -32,6 +33,8 @@
 - [ ] Visualisation
   - [ ] Highlight strongly coupled components (i.e. have lots of outgoing/incoming dependencies). How to visualise strongly coupled components?
   - [ ] Interface vs implementation coupling (interface is worse!). Highlighting interface vs implementation coupling between components on graph?
+  - [ ] Hierarchy diagram for components with no cycles? (https://bl.ocks.org/mbostock/4339184)
+  - [ ] Pack diagram for just visualising components (https://bl.ocks.org/mbostock/ca5b03a33affa4160321)
   - [ ] Look at using subgraphs of the dot/svg language to cluster component dependencies in the graph
   - [ ] Create a d3 donut graph with relative sizes of components in project? This'll probably show which components need to be further split up (something like this https://blog.kathyreid.id.au/2016/12/29/linux-australia-expense-breakdown-a-data-visualisation-in-d3-js/)
   - [ ] Node size - base it on how many source files (or lines of code) or how many connections going in/out of node?

bin/console

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'cpp_dependency_graph'
 

cpp_dependency_graph.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'cpp_dependency_graph/version'
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.name = 'cpp_dependency_graph'
   s.version = CppDependencyGraph::VERSION
   s.authors = ['Shreyas Balakrishna']
-  s.email = ['shreyasbharath@users.noreply.github.com>']
+  s.email = ['shreyasbharath@gmail.com']
   s.summary = <<-SUMMARY
   CppDependencyGraph is a program that generates dependency visualisations (dot, d3.js) to study the architecture of C/C++ projects
   SUMMARY
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/shreyasbharath/cpp_dependency_graph'
   s.licenses = ['MIT']
 
-  s.files = %x[git ls-files -z].split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } -
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } -
             %w[.rubocop.yml .travis.yml appveyor.yml]
   s.bindir = 'exe'
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -39,6 +39,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 12.3'
   s.add_development_dependency 'rspec', '~> 3.7'
   s.add_development_dependency 'rubocop', '~> 0.54'
-  s.add_development_dependency 'ruby-prof', '~> 0.17'
   s.add_development_dependency 'ruby-debug-ide', '~> 0.6'
+  s.add_development_dependency 'ruby-prof', '~> 0.17'
 end

exe/cpp_dependency_graph

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 #--
 # Copyright (c) 2018 Shreyas Balakrishna
 
@@ -53,12 +55,12 @@ DOCOPT
 begin
   args = Docopt.docopt(doc)
 
-  if (args['--version'])
+  if args['--version']
     puts VERSION
     Kernel.exit(0)
   end
 
-  project_dir = args['--root_dir'].gsub(/\\/,'/')
+  project_dir = args['--root_dir'].tr('\\', '/')
 
   unless File.directory?(project_dir)
     puts('Not a valid project source directory')

lib/cpp_dependency_graph.rb

@@ -3,7 +3,8 @@
 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/graph_visualiser'
+require_relative 'cpp_dependency_graph/graph_to_dot_visualiser'
+require_relative 'cpp_dependency_graph/graph_to_html_visualiser'
 require_relative 'cpp_dependency_graph/version'
 
 # Generates dependency graphs of a project in various output forms
@@ -39,9 +40,9 @@ def generate_cyclic_dependencies(project_dir, format, file)
   def generate_visualisation(deps, format, file)
     case format
     when 'dot'
-      GraphVisualiser.new.generate_dot_file(deps, file)
+      GraphToDotVisualiser.new.generate(deps, file)
     when 'html'
-      GraphVisualiser.new.generate_html_file(deps, file)
+      GraphToHtmlVisualiser.new.generate(deps, file)
     when 'json'
       File.write(file, JSON.pretty_generate(deps))
     end

lib/cpp_dependency_graph/bidirectional_hash.rb

@@ -1,30 +1,31 @@
 # frozen_string_literal: true
 
+# Hash that allows lookup by key and value
 class BidirectionalHash
   def initialize
-    @forward = Hash.new { |h, k| h[k] = [ ] }
-    @reverse = Hash.new { |h, k| h[k] = [ ] }
+    @forward = Hash.new { |h, k| h[k] = [] }
+    @reverse = Hash.new { |h, k| h[k] = [] }
   end
 
-  def insert(k, v)
-    @forward[k].push(v)
-    @reverse[v].push(k)
-    v
+  def insert(key, value)
+    @forward[key].push(value)
+    @reverse[value].push(key)
+    value
   end
 
-  def fetch(k)
-    fetch_from(@forward, k)
+  def fetch(key)
+    fetch_from(@forward, key)
   end
 
-  def rfetch(v)
-    fetch_from(@reverse, v)
+  def rfetch(value)
+    fetch_from(@reverse, value)
   end
 
   protected
 
-  def fetch_from(h, k)
-    return nil if(!h.has_key?(k))
-    v = h[k]
+  def fetch_from(hash, key)
+    return nil unless hash.key?(key)
+    v = hash[key]
     v.length == 1 ? v.first : v.dup
   end
 end

lib/cpp_dependency_graph/component_link.rb

@@ -2,28 +2,24 @@
 
 require 'json'
 
+# Represents a link between two entities, a source and a target
 class ComponentLink
+  attr_reader :source
+  attr_reader :target
+
   def initialize(source, target, cyclic = false)
     @source = source
     @target = target
     @cyclic = cyclic
   end
 
-  def source
-    @source
-  end
-
-  def target
-    @target
-  end
-
   def cyclic?
     @cyclic
   end
 
   def ==(other)
     (source == other.source && target == other.target && cyclic? == other.cyclic?) ||
-    (source == other.target && target == other.source && cyclic? == other.cyclic?)
+      (source == other.target && target == other.source && cyclic? == other.cyclic?)
   end
 
   def hash
@@ -38,9 +34,8 @@ def to_s
     end
   end
 
-  def to_json(*a)
+  def to_json(*options)
     { json_class: self.class.name,
-      source: source, target: target, cyclic: cyclic?
-    }.to_json(*a)
+      source: source, target: target, cyclic: cyclic? }.to_json(*options)
   end
 end

lib/cpp_dependency_graph/cycle_detector.rb

@@ -6,10 +6,10 @@
 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|
-                        [CyclicLink.new(source, target), true]
-                      end
-                    end.to_h
+      links.select { |target| component_links[target].include?(source) }.map do |target|
+        [CyclicLink.new(source, target), true]
+      end
+    end.to_h
   end
 
   def cyclic?(source, target)

lib/cpp_dependency_graph/cyclic_link.rb

@@ -2,29 +2,24 @@
 
 # A special class designed to be used as a key in a hash
 class CyclicLink
-  def initialize(nodeA, nodeB)
-    @nodeA = nodeA
-    @nodeB = nodeB
-  end
-
-  def nodeA
-    @nodeA
-  end
+  attr_reader :node_a
+  attr_reader :node_b
 
-  def nodeB
-    @nodeB
+  def initialize(node_a, node_b)
+    @node_a = node_a
+    @node_b = node_b
   end
 
   def eql?(other)
-    (@nodeA == other.nodeA && @nodeB == other.nodeB) ||
-    (@nodeA == other.nodeB && @nodeB == other.nodeA)
+    (@node_a == other.node_a && @node_b == other.node_b) ||
+      (@node_a == other.node_b && @node_b == other.node_a)
   end
 
   def hash
-    [@nodeA, @nodeB].to_set.hash
+    [@node_a, @node_b].to_set.hash
   end
 
   def to_s
-    "#{nodeA} <-> #{nodeB}"
+    "#{node_a} <-> #{node_b}"
   end
 end