Add logging support

Author: shreyasbharath

cpp_dependency_graph.gemspec

@@ -25,20 +25,20 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
-  s.rubygems_version = '3.1.2'
+  s.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
+  s.rubygems_version = '3.3.4'
 
-  s.add_runtime_dependency 'docopt', '~> 0.6'
-  s.add_runtime_dependency 'json', '~> 2.3.0'
-  s.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
+  s.add_runtime_dependency 'docopt'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'ruby-graphviz'
 
-  s.add_development_dependency 'bundler', '~> 2.1'
-  s.add_development_dependency 'debase', '~> 0.2'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3.9'
-  s.add_development_dependency 'rubocop', '~> 0.81'
-  s.add_development_dependency 'ruby-debug-ide', '~> 0.7'
-  s.add_development_dependency 'ruby-prof', '~> 0.18'
-  s.add_development_dependency 'simplecov', '~> 0.18'
-  s.add_development_dependency 'simplecov-console', '~> 0.4'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rufo'
+  s.add_development_dependency 'ruby-debug-ide'
+  s.add_development_dependency 'ruby-prof'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'simplecov-console'
 end

lib/cpp_dependency_graph.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
-require_relative 'cpp_dependency_graph/circle_packing_visualiser'
-require_relative 'cpp_dependency_graph/component_dependency_graph'
-require_relative 'cpp_dependency_graph/dir_tree'
-require_relative 'cpp_dependency_graph/graph_to_html_visualiser'
-require_relative 'cpp_dependency_graph/graph_to_svg_visualiser'
-require_relative 'cpp_dependency_graph/include_component_dependency_graph'
-require_relative 'cpp_dependency_graph/include_file_dependency_graph'
-require_relative 'cpp_dependency_graph/project'
-require_relative 'cpp_dependency_graph/version'
+require_relative "cpp_dependency_graph/circle_packing_visualiser"
+require_relative "cpp_dependency_graph/component_dependency_graph"
+require_relative "cpp_dependency_graph/dir_tree"
+require_relative "cpp_dependency_graph/graph_to_html_visualiser"
+require_relative "cpp_dependency_graph/graph_to_svg_visualiser"
+require_relative "cpp_dependency_graph/include_component_dependency_graph"
+require_relative "cpp_dependency_graph/include_file_dependency_graph"
+require_relative "cpp_dependency_graph/project"
+require_relative "cpp_dependency_graph/version"
+require_relative "cpp_dependency_graph/logging"
 
 # Generates dependency graphs of a project in various output forms
 module CppDependencyGraph
+  include Logging
+
   def generate_project_graph(project_dir, format, output_file)
+    logger.info "Resolving source directories in project..."
     project = Project.new(project_dir)
+    logger.info "Resolving dependencies between components..."
     graph = ComponentDependencyGraph.new(project)
+    logger.info "Generating graph..."
     deps = graph.all_links
+    logger.info "Generating visualisation..."
     generate_visualisation(deps, format, output_file)
   end
 
@@ -63,11 +70,11 @@ def generate_cyclic_dependencies(project_dir, format, file)
 
   def generate_visualisation(deps, format, file)
     case format
-    when 'svg'
+    when "svg"
       GraphToSvgVisualiser.new.generate(deps, file)
-    when 'html'
+    when "html"
       GraphToHtmlVisualiser.new.generate(deps, file)
-    when 'json'
+    when "json"
       File.write(file, JSON.pretty_generate(deps))
     end
   end

lib/cpp_dependency_graph/component_dependency_graph.rb

@@ -29,7 +29,7 @@ def links(name)
   private
 
   def build_hash_links
-    raw_links = @project.source_components.values.map { |c| [c.name, @project.dependencies(c)] }.to_h
+    raw_links = @project.source_components.values.map { |c| [c.name, @project.dependencies(c) || [] ] }.to_h
     @cycle_detector ||= CycleDetector.new(raw_links)
     links = raw_links.map do |source, source_links|
       c_links = source_links.map { |target| Link.new(source, target, @cycle_detector.cyclic?(source, target)) }

lib/cpp_dependency_graph/cycle_detector.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'cyclic_link'
+require_relative "cyclic_link"
+require_relative "logging"
 
 # Detects cycles between nodes
 class CycleDetector
+  include Logging
+
   def initialize(links)
+    logger.debug "Resolving cyclic dependendencies..."
     @cyclic_links = links.flat_map do |source, source_links|
-      source_links.select { |target| links[target].include?(source) }.map do |target|
+      logger.debug "#{source}, #{source_links}"
+      source_links.select { |target| links.fetch(target, []).include?(source) }.map do |target|
         [CyclicLink.new(source, target), true]
       end
     end.to_h

lib/cpp_dependency_graph/directory_parser.rb

@@ -3,7 +3,7 @@
 # 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 }
+    Find.find(root_dir).select { |e| File.directory?(e) && e != root_dir}
   end
 
   def glob_files(path, extensions)

lib/cpp_dependency_graph/logging.rb

@@ -0,0 +1,20 @@
+require "logger"
+
+module Logging
+  def logger
+    Logging.logger
+  end
+
+  def self.logger
+    @logger ||= initialise_logger
+  end
+
+  def self.initialise_logger
+    logger = Logger.new(STDOUT, level: :info)
+    logger.formatter = proc do |severity, datetime, progname, msg|
+      date_format = datetime.strftime("%Y-%m-%d %H:%M:%S.%L")
+      "[#{date_format}] #{severity}: #{msg}\n"
+    end
+    logger
+  end
+end

lib/cpp_dependency_graph/project.rb

@@ -5,10 +5,12 @@
 require_relative 'directory_parser'
 require_relative 'include_to_component_resolver'
 require_relative 'source_component'
+require_relative 'logging'
 
 # Parses all components of a project
 class Project
   include DirectoryParser
+  include Logging
 
   def initialize(path)
     @path = path
@@ -61,6 +63,7 @@ def build_source_components
     # TODO: Dealing with source components with same dir name?
     dirs = fetch_all_dirs(@path)
     components = dirs.map do |dir|
+      logger.debug "Parsing #{dir}"
       c = SourceComponent.new(dir)
       [c.name, c]
     end.to_h