RubyGems - deps_grapher - Versions diffs - 1.0.0 - Mend

deps_grapher 1.0.0

Files changed (60) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +3 -0
data/Gemfile +16 -0
data/LICENSE.txt +21 -0
data/README.md +327 -0
data/Rakefile +12 -0
data/bin/console +15 -0
data/bin/deps_grapher +96 -0
data/bin/setup +8 -0
data/deps_grapher.gemspec +34 -0
data/lefthook.yml +14 -0
data/lib/deps_grapher/ast_processor.rb +211 -0
data/lib/deps_grapher/ast_processor_policy.rb +45 -0
data/lib/deps_grapher/cache_file.rb +48 -0
data/lib/deps_grapher/cli.rb +29 -0
data/lib/deps_grapher/command/analyzer.rb +89 -0
data/lib/deps_grapher/command/init.rb +49 -0
data/lib/deps_grapher/configuration.rb +99 -0
data/lib/deps_grapher/context.rb +48 -0
data/lib/deps_grapher/cytoscape/cose.rb +36 -0
data/lib/deps_grapher/cytoscape/fcose.rb +36 -0
data/lib/deps_grapher/cytoscape/klay.rb +27 -0
data/lib/deps_grapher/cytoscape/template.erb +61 -0
data/lib/deps_grapher/cytoscape.rb +88 -0
data/lib/deps_grapher/dsl.rb +50 -0
data/lib/deps_grapher/edge.rb +58 -0
data/lib/deps_grapher/errors.rb +8 -0
data/lib/deps_grapher/event.rb +63 -0
data/lib/deps_grapher/graph.rb +71 -0
data/lib/deps_grapher/graphile/generator.rb +42 -0
data/lib/deps_grapher/graphile/graphile.erb +119 -0
data/lib/deps_grapher/graphile/graphile.temp.erb +23 -0
data/lib/deps_grapher/html_writer.rb +16 -0
data/lib/deps_grapher/input.rb +40 -0
data/lib/deps_grapher/layer/registry.rb +32 -0
data/lib/deps_grapher/layer.rb +75 -0
data/lib/deps_grapher/logging.rb +21 -0
data/lib/deps_grapher/matcher.rb +28 -0
data/lib/deps_grapher/node.rb +65 -0
data/lib/deps_grapher/plugin_dsl.rb +12 -0
data/lib/deps_grapher/plugin_loader.rb +29 -0
data/lib/deps_grapher/source.rb +51 -0
data/lib/deps_grapher/source_cache/class_name_extractor.rb +60 -0
data/lib/deps_grapher/source_cache/registry.rb +64 -0
data/lib/deps_grapher/source_cache.rb +49 -0
data/lib/deps_grapher/version.rb +5 -0
data/lib/deps_grapher/vis/box.rb +21 -0
data/lib/deps_grapher/vis/dot.rb +17 -0
data/lib/deps_grapher/vis/template.erb +36 -0
data/lib/deps_grapher/vis.rb +69 -0
data/lib/deps_grapher/visualizer/base.rb +74 -0
data/lib/deps_grapher/visualizer/color/registry.rb +30 -0
data/lib/deps_grapher/visualizer/color.rb +62 -0
data/lib/deps_grapher/visualizer/command_option.rb +22 -0
data/lib/deps_grapher/visualizer/downloader.rb +42 -0
data/lib/deps_grapher/visualizer/js_option.rb +39 -0
data/lib/deps_grapher/visualizer/registry.rb +37 -0
data/lib/deps_grapher/visualizer.rb +11 -0
data/lib/deps_grapher.rb +42 -0
metadata +135 -0

data/lib/deps_grapher/cytoscape/klay.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require_relative "../cytoscape"
+module DepsGrapher
+  class Cytoscape
+    class Klay < self
+      command_option "cy:klay", default: true
+      private
+      def required_js
+        super.tap do |js|
+          js << "https://unpkg.com/klayjs/klay.js"
+          js << "https://raw.githubusercontent.com/cytoscape/cytoscape.js-klay/master/cytoscape-klay.js"
+        end
+      end
+      def layout_options
+        Visualizer::JsOption.new(
+          name: :klay,
+          nodeDimensionsIncludeLabels: true
+        )
+      end
+    end
+  end
+end

data/lib/deps_grapher/cytoscape/template.erb ADDED Viewed

@@ -0,0 +1,61 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Cytoscape</title>
+    <meta name=”viewport” content=”width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no″>
+    <% required_js.each do |js| -%>
+      <script src="<%= File.basename js %>"></script>
+    <% end -%>
+    <style>
+      #cy {
+        width:  100vw;
+        height: 100vh;
+      }
+    </style>
+    <script>
+      const backgroundColorMap = <%= color_map(:background).to_json %>;
+      document.addEventListener('DOMContentLoaded', function () {
+        const cy = cytoscape({
+          container: document.getElementById('cy'),
+          elements: <%= data.to_json %>,
+          layout: <%= layout_options %>,
+          style: [
+            {
+              selector: 'node',
+              style: {
+                'background-color': function(ele) {
+                  return backgroundColorMap[ele.data('layer')];
+                },
+                'label': 'data(label)',
+                'font-size': '6%',
+                'width': function(ele) {
+                  return Math.max(<%= min_width %>, ele.data('deps_count') * <%= coefficient %>);
+                },
+                'height': function(ele) {
+                  return Math.max(<%= min_height %>, ele.data('deps_count') * <%= coefficient %>);
+                }
+              }
+            },
+            <% Layer.names.each do |layer_name| -%>
+            {
+              selector: 'edge[layer="<%= layer_name %>"]',
+              style: {
+                  'width': 1,
+                  'line-color': '<%= arrow_color(layer_name) %>',
+                  'target-arrow-color': '<%= arrow_color(layer_name) %>',
+                  'target-arrow-shape': 'triangle',
+                  'curve-style': 'bezier'
+              }
+            },
+            <% end -%>
+          ],
+        });
+        <%= advanced_render %>
+      });
+    </script>
+  </head>
+  <body>
+    <div id="cy"></div>
+  </body>
+</html>

data/lib/deps_grapher/cytoscape.rb ADDED Viewed

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require_relative "visualizer/base"
+module DepsGrapher
+  class Cytoscape < Visualizer::Base
+    def required_js
+      [
+        "https://unpkg.com/cytoscape/dist/cytoscape.min.js",
+        "https://unpkg.com/layout-base/layout-base.js"
+      ]
+    end
+    private
+    def template_path
+      File.expand_path File.join("cytoscape", "template.erb"), __dir__
+    end
+    def min_width
+      "10"
+    end
+    def min_height
+      "10"
+    end
+    def coefficient
+      "0.2 * 10"
+    end
+    def layout_options
+      raise NotImplementedError
+    end
+    def advanced_render
+      ""
+    end
+    def data
+      [].tap do |array|
+        @nodes.each do |node|
+          next if skip_node?(node)
+          array << convert_node(node)
+        end
+        @edges.each do |edge|
+          next if skip_edge?(edge)
+          array << convert_edge(edge)
+        end
+      end
+    end
+    def convert_node(node)
+      {
+        group: :nodes,
+        data: {
+          id: node.id,
+          layer: node.layer,
+          label: node.label,
+          deps_count: node.deps_count
+        }
+      }
+    end
+    def convert_edge(edge)
+      {
+        group: :edges,
+        data: {
+          id: edge.id,
+          source: edge.from.id,
+          target: edge.to.id,
+          layer: edge.from.layer
+        }
+      }
+    end
+    def skip_node?(node)
+      options[:layers].present? && !options[:layers].include?(node.layer)
+    end
+    def skip_edge?(edge)
+      skip_node?(edge.from) || skip_node?(edge.to)
+    end
+  end
+end

data/lib/deps_grapher/dsl.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class DSL
+    def initialize(obj)
+      @obj = obj
+    end
+    def respond_to_missing?(symbol, include_private = false)
+      ["#{symbol}=", symbol].each do |method_name|
+        return true if @obj.respond_to?(method_name)
+      end
+      super
+    end
+    private
+    def method_missing(symbol, *args, &block)
+      ["#{symbol}=", symbol].each do |method_name|
+        next unless @obj.respond_to?(method_name)
+        parameters = @obj.method(method_name).parameters
+        return @obj.send(method_name) if parameters.empty?
+        if parameters.size == 1
+          parameter = parameters.first
+          case parameter[0]
+          when :req, :opt
+            return @obj.send(method_name, args.first.freeze)
+          when :block
+            return @obj.send(method_name, &block)
+          else
+            raise ArgumentError, "unsupported parameter type: #{parameter[0]}"
+          end
+        end
+        next unless parameters.size == 2
+        arg_type_1st, arg_type_2nd = parameters.flat_map(&:first)
+        return @obj.send(method_name, args.first.freeze, &block) if %i[req opt].include?(arg_type_1st) && arg_type_2nd == :block
+        raise ArgumentError, "unsupported parameter types: #{arg_type_1st}, #{arg_type_2nd}"
+      end
+      super
+    end
+  end
+end

data/lib/deps_grapher/edge.rb ADDED Viewed

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class Edge
+    class << self
+      def fetch(from, to)
+        id = generate_id from, to
+        registry.fetch id
+      end
+      def add(from, to)
+        return nil if from.nil? || to.nil?
+        id = generate_id from, to
+        return nil if registry.key?(id) || from.id == to.id
+        to.parent = from.id
+        to.increment_deps_count!
+        registry[id] = new id, from, to
+      end
+      def all
+        registry.values
+      end
+      private
+      def generate_id(from, to)
+        "e:#{from.id}:#{to.id}"
+      end
+      def registry
+        @registry ||= {}
+      end
+    end
+    private_class_method :new
+    attr_accessor :id, :from, :to
+    def initialize(id, from, to)
+      @id = id
+      @from = from
+      @to = to
+    end
+    def eql?(other)
+      other.is_a?(self.class) && id == other.id
+    end
+    alias == eql?
+    def hash
+      id.hash
+    end
+  end
+end

data/lib/deps_grapher/errors.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class Error < StandardError; end
+  class TargetNodeNotFound < Error; end
+  class SourceCacheNotFound < Error; end
+  class SourceLocationNotFound < Error; end
+end

data/lib/deps_grapher/event.rb ADDED Viewed

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class Event
+    class << self
+      def generate_key(name, const_name, method)
+        return nil if const_name.nil? && method.nil?
+        key = name.to_s.dup
+        key << ".#{const_name}" if const_name
+        key << ".#{method}" if method
+        key
+      end
+      def add(name:, const_name:, location:, method: nil)
+        key = generate_key name, const_name, method
+        return nil if key.nil?
+        registry[key] ||= new(
+          name: name,
+          const_name: const_name,
+          location: location,
+          method: method
+        )
+      end
+      private
+      def registry
+        @registry ||= {}
+      end
+    end
+    private_class_method :new
+    attr_accessor :name, :const_name, :location, :method
+    def initialize(name:, const_name:, location:, method:)
+      @name = name
+      @const_name = const_name
+      @location = location
+      @method = method
+      @skip_processing = false
+    end
+    def key
+      self.class.generate_key name, const_name, method
+    end
+    def processing!
+      @skip_processing = false
+    end
+    def skip_processing!
+      @skip_processing = true
+    end
+    def processing?
+      !@skip_processing
+    end
+  end
+end

data/lib/deps_grapher/graph.rb ADDED Viewed

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class NullGraph
+    def add_edge(_); end
+  end
+  class Graph
+    def initialize
+      @graph = {}
+    end
+    def add_edge(edge)
+      @graph[edge.from] ||= []
+      @graph[edge.from] << edge.to
+    end
+    def find_path(source_path_matcher, target_path_matcher)
+      paths = []
+      visited = {}
+      @graph.each_key do |start_node|
+        next if source_path_matcher && !source_path_matcher.match?(start_node.class_name)
+        dfs start_node, target_path_matcher, visited, [start_node], paths
+      end
+      nodes = Set.new
+      edges = Set.new
+      paths.each do |path|
+        collect! path, nodes, edges
+      end
+      [nodes, edges]
+    end
+    private
+    def dfs(current, target_path_matcher, visited, path, paths)
+      return if visited[current]
+      visited[current] = true
+      if target_path_matcher.match?(current.class_name)
+        paths << path
+      else
+        @graph[current]&.each do |node|
+          dfs node, target_path_matcher, visited, path + [node], paths
+        end
+      end
+      visited[current] = false
+    end
+    def collect!(path, nodes, edges)
+      current_node = nil
+      path.each do |node|
+        nodes << node
+        if current_node.nil?
+          current_node = node
+          next
+        end
+        edges << Edge.fetch(current_node, node)
+        current_node = node
+      end
+    end
+  end
+end

data/lib/deps_grapher/graphile/generator.rb ADDED Viewed

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module DepsGrapher
+  module Graphile
+    class Generator
+      def initialize(config)
+        @config = config
+      end
+      def call(dest)
+        if dest
+          File.write dest, read_template(temp: false)
+          return dest
+        end
+        path = nil
+        # unlink this temp file by GC
+        Tempfile.open("graphile_generator", config.cache_dir) do |f|
+          f.write read_template(temp: true)
+          path = f.path
+        end
+        path
+      end
+      private
+      attr_reader :config
+      def read_template(temp:)
+        b = config.instance_eval { binding }
+        ERB.new(File.read(resolve_path(temp)), trim_mode: "-").result(b)
+      end
+      def resolve_path(temp)
+        file_name = temp ? "graphile.temp.erb" : "graphile.erb"
+        File.expand_path(file_name, __dir__)
+      end
+    end
+  end
+end

data/lib/deps_grapher/graphile/graphile.erb ADDED Viewed

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+# directory settings
+# customize for your project
+output_dir File.expand_path File.join("tmp", "deps_grapher", "graph")
+cache_dir File.expand_path File.join("tmp", "deps_grapher", "cache")
+root_dir = "<%= root_dir %>"
+lib_root_dir = File.join(root_dir, "lib")
+layer_root_dir = File.join(lib_root_dir, "deps_grapher")
+# default visualizer setting
+visualizer "<%= visualizer %>"
+ast_processor_policy do
+  exclude_const /\ADepsGrapher\z/
+  # advanced_const_resolver do |ast_node|
+  #   # some advanced logic using ast_node of parser gem
+  #   # this block should return a string of const name or nil
+  #   # if return nil, the const name will be resolved by default logic
+  # end
+end
+layer do
+  name :deps_grapher
+  visible true
+  source do
+    root lib_root_dir
+    exclude_pattern %r{/(command|cytoscape|vis|visualizer)}
+  end
+  color do
+    background "#FF5252"
+    border "#EF5350"
+    font "#FF5252"
+  end
+end
+layer do
+  name :command
+  visible true
+  source do
+    root File.join(layer_root_dir, "command")
+  end
+  color do
+    background "#512DA8"
+    border "#673AB7"
+    font "#512DA8"
+  end
+end
+layer do
+  name :cytoscape
+  visible true
+  source do
+    root layer_root_dir
+    glob_pattern ["cytoscape.rb", "cytoscape/**/*.rb"]
+  end
+  color do
+    background "#448AFF"
+    border "#42A5F5"
+    font "#448AFF"
+  end
+end
+layer do
+  name :vis
+  visible true
+  source do
+    root layer_root_dir
+    glob_pattern ["vis.rb", "vis/**/*.rb"]
+  end
+  color do
+    background "#00B8D4"
+    border "#00ACC1"
+    font "#00B8D4"
+  end
+end
+layer do
+  name :visualizer
+  visible true
+  source do
+    root layer_root_dir
+    glob_pattern ["visualizer.rb", "visualizer/**/*.rb"]
+  end
+  color do
+    background "#00C853"
+    border "#4CAF50"
+    font "#00C853"
+  end
+end
+with_plugin do |plugin_dir|
+  layer do
+    name :plugin
+    visible true
+    source do
+      root plugin_dir
+    end
+    color do
+      background "#607D8B"
+      border "#78909C"
+      font "#607D8B"
+    end
+  end
+end

data/lib/deps_grapher/graphile/graphile.temp.erb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+output_dir File.join(Dir.home, ".deps_grapher", "graph")
+cache_dir File.join(Dir.home, ".deps_grapher", "cache")
+cache_ttl 60 * 5 # 5 minutes
+root_dir = "<%= root_dir %>"
+layer do
+  name :<%= File.basename(root_dir) %>
+  visible true
+  source do
+    root root_dir
+    exclude_pattern %r{/(?:vendor|spec)/}
+  end
+  color do
+    background "#448AFF"
+    border "#42A5F5"
+    font "#448AFF"
+  end
+end

data/lib/deps_grapher/html_writer.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class HtmlWriter
+    attr_reader :path
+    def initialize(output_dir)
+      FileUtils.mkdir_p output_dir
+      @path = File.join output_dir, "index.html"
+    end
+    def write(content)
+      File.write path, content
+    end
+  end
+end

data/lib/deps_grapher/input.rb ADDED Viewed

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class Input
+    def initialize(config)
+      @config = config
+    end
+    def files
+      FileUtils.rm_rf File.dirname(config.cache_dir) if config.clean
+      set_layers_visibility!
+      extract_files_from_layers
+    end
+    private
+    attr_reader :config
+    def set_layers_visibility!
+      layer_visibility = config.visualizer_options[:layers]
+      config.layers.each_value do |layer|
+        layer.visible = layer_visibility.include? layer.name
+      end
+    end
+    def extract_files_from_layers
+      config.layers.values.select(&:visible).each_with_object([]) do |layer, files|
+        source = layer.source
+        source.files.each do |file|
+          next if file == config.path
+          files << file
+        end
+      end
+    end
+  end
+end

data/lib/deps_grapher/layer/registry.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module DepsGrapher
+  class Layer
+    module Registry
+      class << self
+        def fetch(file_path)
+          registry[file_path] || Layer::Default
+        end
+        alias [] fetch
+        def register(file_path, layer)
+          registry[file_path] ||= layer
+        end
+        def exist?(file_path)
+          registry.key? file_path
+        end
+        def all
+          registry.values
+        end
+        private
+        def registry
+          @registry ||= {}
+        end
+      end
+    end
+  end
+end