load_tracer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeeeceacbdb0493b22b4bc6555f8132aca31920261fc2aa2a17d96627c972a63
-  data.tar.gz: 844f00b03f9f2d871bce7e0705c1bac12c99923838ff047dec41127a0ccd54c5
+  metadata.gz: 54faee11fca635fb5444d731ba08da06967dd8b26f6164282ae8fe748149840a
+  data.tar.gz: c759a241b21b3c04f34b83274a67abce0a6a3c3c56a6ec92df1c201848859872
 SHA512:
-  metadata.gz: b389012cc1aee3159a000c86675095529401e8761db4dbfb5db79d574bce7794857509d8e29fa7014d41a2521a279834923ef92bc3a6d0c12b69df645755033c
-  data.tar.gz: 43bfbda30363e9ca0e686b378d6f551f1897460c4794d18272158e51125e43e8612e3954b017dc7bdca76e70d2db2632da6bcc20fc381d68f5d3ac6ebd89811d
+  metadata.gz: 2c48aca3dbca0cafe40c9aedf1b97c37c9dd325b77fb6c1be41fa7804fb9625d46c8d375a97e1a7cc08ffd53c224ffc6eb994a76a3cfce52e41a0d11cdd09d34
+  data.tar.gz: 2b980c8f85959c33b4fc98eb3a7717a1e25ab1af8062ab285633003ec745de0ce9fa4340f3d5b91954a947994426c635b2175e8b1494ed600b787f58999acbf1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    load_tracer (0.1.0)
+    load_tracer (0.2.0)
       binding_of_caller (~> 0.8.0)
 
 GEM

data/README.md

@@ -38,6 +38,18 @@ end
 pp report
 ```
 
+### dot format
+
+```ruby
+require 'load_tracer'
+
+puts LoadTracer.trace(format: :dot) { require 'prime' }
+```
+
+```
+ruby example.rb | dot -Tpng -o example.png | open example.png
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/load_tracer/formatter/default.rb

@@ -0,0 +1,36 @@
+class LoadTracer
+  class DefaultFormatter
+    def self.export(dependencies:, reverse_dependencies:)
+      report = dependencies.map do |path, deps|
+        FileSpec.new(
+          name: File.basename(path),
+          path: path,
+          dependencies: deps,
+          reverse_dependencies: [],
+        )
+      end
+
+      reverse_dependencies.each do |path, rdeps|
+        fs = report.find { |fs| fs.path == path }
+
+        if fs.nil?
+          report << FileSpec.new(
+            name: File.basename(path),
+            path: path,
+            dependencies: [],
+            reverse_dependencies: rdeps,
+          )
+        else
+          fs.reverse_dependencies = rdeps
+        end
+      end
+
+      report.each do |fs|
+        fs.dependencies.sort!.uniq!
+        fs.reverse_dependencies.sort!.uniq!
+      end
+
+      report.sort_by(&:name)
+    end
+  end
+end

data/lib/load_tracer/formatter/dot.rb

@@ -0,0 +1,65 @@
+require 'erb'
+require 'pathname'
+
+class LoadTracer
+  class DotFormatter
+    def self.export(dependencies:)
+      new(dependencies: dependencies).export
+    end
+
+    def initialize(dependencies:)
+      @dependencies = dependencies
+      @template = File.read(File.expand_path('templates/default.dot.erb', __dir__))
+    end
+
+    def export
+      graph_data = ERB.new(@template, nil, '-').result(binding)
+
+      graph_data.lines.map(&:rstrip).join("\n")
+    end
+
+    private
+
+    def graph_edges
+      @dependencies.flat_map do |from, deps|
+        label1 = File.basename(from)
+
+        deps.map do |to|
+          label2 = File.basename(to)
+
+          [
+            duplicated_label_names.include?(label1) ? node_label(from) : label1,
+            duplicated_label_names.include?(label2) ? node_label(to) : label2,
+          ]
+        end
+      end.sort_by(&:first).uniq
+    end
+
+    def duplicated_label_names
+      return @_duplicate_names if @_duplicate_names
+
+      checked = Hash.new
+      @_duplicate_names = []
+
+      @dependencies.each do |from, deps|
+        label1 = File.basename(from)
+        @_duplicate_names << label1 if checked[label1]
+        checked[label1] = true
+
+        deps.each do |to|
+          label2 = File.basename(to)
+
+          @_duplicate_names << label2 if label1 == label2
+        end
+      end
+
+      @_duplicate_names.uniq!
+      @_duplicate_names
+    end
+
+    def node_label(absolute_path)
+      s, _, t = Pathname.new(absolute_path).ascend.take(3)
+      s.relative_path_from(t).to_s
+    end
+  end
+end

data/lib/load_tracer/formatter/templates/default.dot.erb

@@ -0,0 +1,6 @@
+digraph file_dependencies {
+  graph [ dpi = 200 ]
+<%- graph_edges.each do |edge| %>
+  <%= %Q("#{edge.first}" -> "#{edge.last}") -%>
+<% end %>
+}

data/lib/load_tracer/version.rb

@@ -1,3 +1,3 @@
 class LoadTracer
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/load_tracer.rb

@@ -1,25 +1,23 @@
 require 'binding_of_caller'
+require 'load_tracer/formatter/default'
+require 'load_tracer/formatter/dot'
 require 'load_tracer/version'
 
 module Kernel
   unless defined?(__original_require__)
     alias __original_require__ require
-    private :__original_require__
   end
 
   unless defined?(__original_require_relative__)
     alias __original_require_relative__ require_relative
-    private :__original_require_relative__
   end
 
   unless defined?(__original_load__)
     alias __original_load__ load
-    private :__original_load__
   end
 
   unless defined?(__original_autoload__)
     alias __original_autoload__ autoload
-    private :__original_autoload__
   end
 
   def require(feature)
@@ -44,63 +42,58 @@ class LoadTracer
 
   LOAD_METHODS = %i(require require_relative load autoload)
 
-  def self.trace
+  def self.trace(format: nil)
     instance = new
     instance.tracer.enable { yield }
-    instance.report
+    instance.report(format: format)
   end
 
   def initialize
     @dependencies = Hash.new { |hash, key| hash[key] = [] }
     @reverse_dependencies = Hash.new { |hash, key| hash[key] = [] }
+    @not_found_features = []
   end
 
   def tracer
-    TracePoint.new(:call) do |tp|
+    TracePoint.new(:return) do |tp|
       next unless LOAD_METHODS.include?(tp.method_id)
       next if tp.defined_class != ::Kernel
       next if tp.path != __FILE__
 
       case tp.event
-      when :call
+      when :return
         bl = caller_locations[1]
-
         feature = get_feature(tp)
+
+        if bl.absolute_path.nil?
+          bl = find_caller_of_internal_library(feature)
+        end
+
         path = find_path(feature) || find_path(File.expand_path(feature, File.dirname(bl.path)))
 
-        raise LoadError.new("cannot load such file -- #{feature}") if path.nil?
+        if path.nil?
+          @not_found_features << feature
+          next
+        end
 
-        @dependencies[bl.path] << path
-        @reverse_dependencies[path] << bl.path
+        @dependencies[bl.absolute_path] << path
+        @reverse_dependencies[path] << bl.absolute_path
       end
     end
   end
 
-  def report
-    file_specs = @dependencies.map do |path, deps|
-      FileSpec.new(
-        name: File.basename(path),
-        path: path,
-        dependencies: deps,
+  def report(format:)
+    case format
+    when :dot
+      DotFormatter.export(
+        dependencies: @dependencies
+      )
+    else
+      DefaultFormatter.export(
+        dependencies: @dependencies,
+        reverse_dependencies: @reverse_dependencies
       )
     end
-
-    @reverse_dependencies.each do |path, rdeps|
-      fs = file_specs.find { |fs| fs.path == path }
-
-      if fs.nil?
-        file_specs << FileSpec.new(
-          name: File.basename(path),
-          path: path,
-          dependencies: [],
-          reverse_dependencies: rdeps
-        )
-      else
-        fs.reverse_dependencies = rdeps
-      end
-    end
-
-    file_specs
   end
 
   private
@@ -121,4 +114,9 @@ class LoadTracer
   rescue LoadError
     nil
   end
+
+  def find_caller_of_internal_library(feature)
+    index = caller_locations.find_index { |bl| bl.base_label == feature && bl.path == '<internal:prelude>' }
+    caller_locations[index + 1]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: load_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shuichi Tamayose
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -85,6 +85,9 @@ files:
 - bin/console
 - bin/setup
 - lib/load_tracer.rb
+- lib/load_tracer/formatter/default.rb
+- lib/load_tracer/formatter/dot.rb
+- lib/load_tracer/formatter/templates/default.dot.erb
 - lib/load_tracer/version.rb
 - load_tracer.gemspec
 homepage: https://github.com/siman-man/load_tracer