cpp_dependency_graph 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49dbf00badc862586088263651f5b0eeb26b9953fae870baa86e14e9d96dee36
-  data.tar.gz: e935e59934e696511cde583c8b89b60b201cafc84e65e3dab487829769f3f9ad
+  metadata.gz: bab309d43e6015c06bf3836941534efe150bd78759d81f0e4ff538b4f33a054f
+  data.tar.gz: 46b1aadfe5915a147b9c89090c4cc7d047cdad269d9ec70a11c12567b56e8eb0
 SHA512:
-  metadata.gz: 203cf7a07370d1fde0cb90e376d1b45ec605aa7332dff34247e99463099b1e496d3f05c831589df73c03c50c776a3838db201acd759468062db49c87560de48f
-  data.tar.gz: 4e122ad96022ba802effbc94c9ac9c185810838ed762514380444d2227ede7f25a97c66eafd7f8436a59d984f5816dad39fc35379dc2131ff8b0012a5d2e8ce8
+  metadata.gz: 4ef9120a1d26f432cfc26e9906412391fa03aadbd34ebc5a110e3dfc674e22a6258f9f453044428da590d8ea51c873307345f09116b847c384ecc3f5787dddd0
+  data.tar.gz: 99995d31dce112db4b38fd9a4e71c4cb4d012829d727a260a396d0dd1def7008af60d0fcd3febe717c224582dd499c36c4ccfec5574c7166629daa72564dd8b2

data/cpp_dependency_graph.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '3.1.2'
 
   s.add_runtime_dependency 'docopt', '~> 0.6'
-  s.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
   s.add_runtime_dependency 'json', '~> 2.3.0'
+  s.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
 
   s.add_development_dependency 'bundler', '~> 2.1'
   s.add_development_dependency 'debase', '~> 0.2'

data/lib/cpp_dependency_graph/bidirectional_hash.rb

@@ -25,6 +25,7 @@ class BidirectionalHash
 
   def fetch_from(hash, key)
     return nil unless hash.key?(key)
+
     v = hash[key]
     v.length == 1 ? v.first : v.dup
   end

data/lib/cpp_dependency_graph/component_dependency_graph.rb

@@ -20,6 +20,7 @@ class ComponentDependencyGraph
 
   def links(name)
     return {} unless all_links.key?(name)
+
     links = incoming_links(name)
     links.merge!(outgoing_links(name))
     links

data/lib/cpp_dependency_graph/dir_tree.rb

@@ -11,7 +11,7 @@ class DirTree
   attr_reader :tree
 
   def initialize(path)
-    @tree ||= File.directory?(path) ? parse_dirs(path) : {}
+    @tree = File.directory?(path) ? parse_dirs(path) : {}
   end
 
   private
@@ -22,9 +22,12 @@ class DirTree
     # 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)
+
       next unless source_files_present?(full_path)
+
       data[:children] << parse_dirs(full_path, entry)
     end
     data

data/lib/cpp_dependency_graph/directory_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Utility methods for parsing directories
+module DirectoryParser
+  def fetch_all_dirs(root_dir)
+    Find.find(root_dir).select { |e| File.directory?(e) && e != root_dir }
+  end
+
+  def glob_files(path, extensions)
+    path = File.join(path, File::SEPARATOR, '**', File::SEPARATOR, '*' + extensions)
+    Dir.glob(path).select { |entry| File.file?(entry) }.compact
+  end
+end

data/lib/cpp_dependency_graph/file_dependency_graph.rb

@@ -20,6 +20,7 @@ class FileDependencyGraph
 
   def links(name)
     return {} unless all_links.key?(name)
+
     links = incoming_links(name)
     links.merge!(outgoing_links(name))
     links

data/lib/cpp_dependency_graph/graph_to_dot_visualiser.rb

@@ -6,9 +6,9 @@ require 'ruby-graphviz'
 class GraphToDotVisualiser
   def generate(deps, file)
     @g = GraphViz.new('dependency_graph')
-    nodes = create_nodes(deps)
-    connect_nodes(deps, nodes)
-    @g.output(:dot => file)
+    create_nodes(deps)
+    connect_nodes(deps)
+    @g.output(dot: file)
   end
 
   private
@@ -17,20 +17,20 @@ class GraphToDotVisualiser
     node_names = deps.flat_map do |_, links|
       links.map { |link| [link.source, link.target] }.flatten
     end.uniq
-    nodes = node_names.map { |name| [name, create_node(name)] }.to_h
-    nodes
+    node_names.each do |name|
+      add_node(name)
+    end
   end
 
-  def create_node(name)
-    node = @g.add_node(name, :shape => 'box3d')
-    node
+  def add_node(name)
+    @g.add_node(name, shape: 'box3d')
   end
 
-  def connect_nodes(deps, nodes)
+  def connect_nodes(deps)
     deps.each do |source, links|
       links.each do |link|
         if link.cyclic?
-          @g.add_edges(source, link.target, :color => 'red')
+          @g.add_edges(source, link.target, color: 'red')
         else
           @g.add_edges(source, link.target)
         end

data/lib/cpp_dependency_graph/include_component_dependency_graph.rb

@@ -11,9 +11,7 @@ class IncludeComponentDependencyGraph
   end
 
   def all_links
-    components = @project.source_components
-    all_source_files = components.values.flat_map(&:source_files)
-    all_source_files.map do |file|
+    @project.source_files.map do |file|
       links = file.includes.map { |inc| Link.new(file.basename, inc, false) }
       [file.basename, links]
     end.to_h

data/lib/cpp_dependency_graph/include_file_dependency_graph.rb

@@ -10,22 +10,15 @@ class IncludeFileDependencyGraph
     @project = project
   end
 
-  def all_links
-    # TODO: Implement
-    {}
-  end
-
   def all_cyclic_links
     # TODO: Implement
   end
 
   def links(file_name)
-    components = @project.source_components
-    all_source_files = components.values.flat_map(&:source_files)
-    files = all_source_files.select do |file|
+    files = @project.source_files.select do |_, file|
       file.includes.include?(file_name)
     end
-    files.map do |file|
+    files.map do |_, file|
       links = [Link.new(file.basename, file_name, false)]
       [file.basename, links]
     end.to_h

data/lib/cpp_dependency_graph/include_to_component_resolver.rb

@@ -19,6 +19,7 @@ class IncludeToComponentResolver
 
   def component_for_include(include)
     return '' unless source_files.key?(include)
+
     @component_include_map_cache[include] = component_for_include_private(include) unless @component_include_map_cache.key?(include)
     @component_include_map_cache[include]
   end
@@ -35,6 +36,7 @@ class IncludeToComponentResolver
     header_file = source_files[include]
     implementation_files = implementation_files(header_file)
     return header_file.parent_component if implementation_files.empty?
+
     implementation_files[0].parent_component
   end
 

data/lib/cpp_dependency_graph/project.rb

@@ -2,11 +2,14 @@
 
 require 'find'
 
+require_relative 'directory_parser'
 require_relative 'include_to_component_resolver'
 require_relative 'source_component'
 
 # Parses all components of a project
 class Project
+  include DirectoryParser
+
   def initialize(path)
     @path = path
     @include_resolver = IncludeToComponentResolver.new(source_components)
@@ -18,9 +21,18 @@ class Project
 
   def source_component(name)
     return SourceComponent.new('NULL') unless source_components.key?(name)
+
     source_components[name]
   end
 
+  def project_component
+    @project_component ||= build_project_component
+  end
+
+  def source_files
+    @source_files ||= build_source_files
+  end
+
   def dependencies(component)
     # 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
@@ -32,6 +44,19 @@ class Project
 
   private
 
+  def build_source_files
+    # TODO: Breaking Demeter's law here
+    files = project_component.values.flat_map(&:source_files)
+    files.map do |file|
+      [file.path, file]
+    end.to_h
+  end
+
+  def build_project_component
+    c = SourceComponent.new(@path)
+    { c.name => c }
+  end
+
   def build_source_components
     # TODO: Dealing with source components with same dir name?
     dirs = fetch_all_dirs(@path)
@@ -41,8 +66,4 @@ class Project
     end.to_h
     components.delete_if { |_, v| v.source_files.size.zero? }
   end
-
-  def fetch_all_dirs(source_dir)
-    Find.find(source_dir).select { |e| File.directory?(e) }
-  end
 end

data/lib/cpp_dependency_graph/source_component.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'config'
+require_relative 'directory_parser'
 require_relative 'source_file'
 
 # Abstracts a source directory containing source files
 class SourceComponent
   include Config
+  include DirectoryParser
 
   attr_reader :path
 
@@ -32,7 +34,6 @@ class SourceComponent
   private
 
   def parse_source_files(extensions)
-    path = File.join(@path, File::SEPARATOR) + '*' + extensions
-    Dir.glob(path).map { |e| SourceFile.new(e) if File.file?(e) }.compact
+    glob_files(@path, extensions).map { |e| SourceFile.new(e) }.compact
   end
 end

data/lib/cpp_dependency_graph/source_file.rb

@@ -53,6 +53,7 @@ class SourceFile
   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.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpp_dependency_graph
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shreyas Balakrishna
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +231,7 @@ files:
 - lib/cpp_dependency_graph/cycle_detector.rb
 - lib/cpp_dependency_graph/cyclic_link.rb
 - lib/cpp_dependency_graph/dir_tree.rb
+- lib/cpp_dependency_graph/directory_parser.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