pocky 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b57fd82dd4f61236c2f397da42b99fcc7c846781
-  data.tar.gz: ab8764520751d80799f31e119511d48ff551b718
+  metadata.gz: 71d72c460dac22e64ff793edb2ed726f95d9366d
+  data.tar.gz: 6bee607df4202ab4b3006a75b31ba67160ecf6cd
 SHA512:
-  metadata.gz: 788b55b8b0aa45b6416966024c755fd8eea2fa92be58b4fd9425ad20e2c37c4532b250f582f229247d0ee668447324d073a1fc416d3a5693f952cc37d479833b
-  data.tar.gz: 77bc52a31421d5aad82f2e90aff37a93ebe6c03d5869f78deca5d7611fd2b873f2dbfd37ce98ceefd87e0bf00baba6c7c7d874cb20a55b9a39048870da3bec66
+  metadata.gz: 778722784ba28b7d8943ffb13342faa81c6937f0a4931f854ffe0656653eca6bcbcf79f488c4224271e488c69842cbaf230d8e5a122c63e739448ffe8c4cc095
+  data.tar.gz: f61dc0bf0b1490d2eb4b43b495cc3de366d60c672a7925b4451cb610654ba54ff77d8f41938ebda5f7691780b96091cda427b5ce7023a19defaa2d3cd3920b9c

data/lib/pocky.rb

@@ -3,6 +3,7 @@
 require_relative 'pocky/version'
 require_relative 'pocky/ruby_file_size'
 require_relative 'pocky/package'
+require_relative 'pocky/packwerk_loader'
 require_relative 'pocky/packwerk'
 
 module Pocky

data/lib/pocky/package.rb

@@ -4,30 +4,43 @@ require 'yaml'
 
 module Pocky
   class Package
-    attr_reader :name, :dependencies, :enforce_privacy, :deprecated_references
+    DEPENDENCIES_FILENAME = 'package.yml'
+    DEPRECATED_REFERENCES_FILENAME = 'deprecated_references.yml'
 
-    def initialize(name:, filename: nil)
+    attr_reader :name, :dependencies, :enforce_privacy, :primary
+
+    def initialize(name:, path:, primary:)
       @name = name
-      @filename = filename
-      @dependencies = yml['dependencies'] || []
-      @enforce_privacy = yml['enforce_privacy'] || false
-      @deprecated_references = {}
+      @path = path
+      @primary = primary
+      @dependencies = dependencies_yml['dependencies'] || []
+      @enforce_privacy = dependencies_yml['enforce_privacy'] || false
     end
 
-    def add_deprecated_references(reference_filename)
-      @deprecated_references = YAML.load_file(reference_filename) || {}
+    def deprecated_references
+      @deprecated_references ||= load_yml(deprecated_references_filename)
     end
 
     private
 
-    def yml
-      @yml ||= begin
-        if @filename
-          YAML.load_file(@filename) || {}
-        else
-          {}
-        end
+    def load_yml(filename)
+      if File.file?(filename)
+        YAML.load_file(filename) || {}
+      else
+        {}
       end
     end
+
+    def dependencies_yml
+      @dependencies_yml ||= load_yml(dependecies_filename)
+    end
+
+    def dependecies_filename
+      File.join(@path, DEPENDENCIES_FILENAME)
+    end
+
+    def deprecated_references_filename
+      File.join(@path, DEPRECATED_REFERENCES_FILENAME)
+    end
   end
 end

data/lib/pocky/packwerk.rb

@@ -5,8 +5,6 @@ require 'ruby-graphviz'
 
 module Pocky
   class Packwerk
-    DEPENDENCIES_FILENAME = 'package.yml'
-    DEPRECATED_REFERENCES_FILENAME = 'deprecated_references.yml'
     MAX_EDGE_WIDTH = 5
 
     def self.generate(params = {})
@@ -35,7 +33,6 @@ module Pocky
       @dpi = dpi.to_i
       @secondary_package_color = secondary_package_color
 
-      @packages = {}
       @nodes = {}
 
       @node_options = {
@@ -59,14 +56,17 @@ module Pocky
     end
 
     def generate
-      load_dependencies
-      load_deprecated_references
-      load_uninitialized_dependencies
-      build_directed_graph
+      @graph = GraphViz.new(:G, type: :digraph, dpi: @dpi)
+      draw_packages
+      @graph.output(png: @filename)
     end
 
     private
 
+    def packages
+      @packages ||= PackwerkLoader.load(@root_path, @package_paths)
+    end
+
     def node_overrides(file_size)
       if file_size < 10
         { fontsize: 26 }
@@ -81,6 +81,20 @@ module Pocky
       end
     end
 
+    def draw_packages
+      packages.each do |_name, package|
+        @nodes[package.name] ||= draw_node(package)
+
+        package.dependencies.each do |dependency|
+          draw_dependency(package, dependency)
+        end
+
+        package.deprecated_references.each do |provider_name, invocations|
+          draw_dependency(package, provider_name, invocations)
+        end
+      end
+    end
+
     def draw_node(package)
       package_name = package_name_for_dependency(package.name)
       path = package.name == '.' ? @root_path : @root_path.join(package.name)
@@ -92,45 +106,34 @@ module Pocky
         label: node_label
       )
 
-      if @package_paths.present? && @package_paths.exclude?(package.name)
-        node_styles.merge!(fillcolor: @secondary_package_color)
+      if @package_paths.present? && !package.primary
+        node_styles.merge!(
+          fillcolor: @secondary_package_color,
+          color: @secondary_package_color
+        )
       end
 
       @graph.add_nodes(package_name, **node_styles)
     end
 
-    def build_directed_graph
-      @graph = GraphViz.new(:G, type: :digraph, dpi: @dpi)
-      draw_packages
-      @graph.output(png: @filename)
-    end
-
-    def draw_packages
-      @packages.each do |_name, package|
-        @nodes[package.name] ||= draw_node(package)
+    def draw_dependency(package, dependency, invocations = nil)
+      # Do not draw dependencies of secondary packages (depencies of primary packages)
+      # when visualizing partial system
+      return if !package.primary && !packages[dependency]
 
-        package.dependencies.each do |dependency|
-          @nodes[dependency] ||= draw_node(@packages[dependency])
+      @nodes[dependency] ||= draw_node(packages[dependency])
 
-          @graph.add_edges(
-            @nodes[package.name],
-            @nodes[dependency],
-            **@dependency_edge_options
-          )
-        end
+      edge_options = invocations ?
+        @deprecated_references_edge_options.merge(
+          penwidth: edge_width(invocations.length),
+        ) :
+        @dependency_edge_options
 
-        package.deprecated_references.each do |provider_name, invocations|
-          @nodes[provider_name] ||= draw_node(@packages[provider_name])
-
-          @graph.add_edges(
-            @nodes[package.name],
-            @nodes[provider_name],
-            **@deprecated_references_edge_options.merge(
-              penwidth: edge_width(invocations.length),
-            ),
-          )
-        end
-      end
+      @graph.add_edges(
+        @nodes[package.name],
+        @nodes[dependency],
+        **edge_options
+      )
     end
 
     def edge_width(count)
@@ -140,71 +143,6 @@ module Pocky
       ].min
     end
 
-    def deprecated_references_files
-      @deprecated_references_files ||= begin
-        return Dir[@root_path.join('**', DEPRECATED_REFERENCES_FILENAME).to_s] unless @package_paths
-
-        @package_paths.flat_map do |path|
-          Dir[@root_path.join(path, '**', DEPRECATED_REFERENCES_FILENAME).to_s]
-        end
-      end
-    end
-
-    def dependencies_files
-      @dependencies_files ||= begin
-        return Dir[@root_path.join('**', DEPENDENCIES_FILENAME).to_s] unless @package_paths
-
-        @package_paths.flat_map do |path|
-          Dir[@root_path.join(path, '**', DEPENDENCIES_FILENAME).to_s]
-        end
-      end
-    end
-
-    def load_dependencies
-      return if dependencies_files.empty?
-
-      dependencies_files.each do |filename|
-        package_name = parse_package_name(filename)
-        @packages[package_name] ||= Pocky::Package.new(name: package_name, filename: filename)
-      end
-    end
-
-    def load_deprecated_references
-      return if deprecated_references_files.empty?
-
-      deprecated_references_files.each do |filename|
-        package_name = parse_package_name(filename)
-        @packages[package_name] ||= Pocky::Package.new(name: package_name)
-        @packages[package_name].add_deprecated_references(filename)
-
-        # Walk the references to create referenced packages
-        @packages[package_name].deprecated_references.each do |provider_name, _violations|
-          @packages[provider_name] ||= Pocky::Package.new(name: provider_name)
-        end
-      end
-    end
-
-    # This must be run as the very last step of packages graph building because these won't have
-    # dependency filename reference.
-    def load_uninitialized_dependencies
-      return if dependencies_files.empty?
-
-      # When analyzing partial system, some packages may not be initialized as part of
-      # dependencies/deprecated references walk. So we take care of initializing them here
-      # before drawing.
-      dependencies_files.each do |filename|
-        package_name = parse_package_name(filename)
-        @packages[package_name].dependencies.each do |dependency|
-          @packages[dependency] ||= Pocky::Package.new(name: dependency)
-        end
-      end
-    end
-
-    def parse_package_name(filename)
-      name = File.dirname(filename).gsub(@root_path.to_s, '')
-      name == '' ? '.' : name.gsub(/^\//, '')
-    end
-
     def package_name_for_dependency(name)
       name == '.' ? @default_package : name
     end

data/lib/pocky/packwerk_loader.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Pocky
+  class PackwerkLoader
+    def self.load(root_path, package_paths)
+      new(root_path, package_paths).load
+    end
+
+    private_class_method :new
+    def initialize(root_path, package_paths)
+      @root_path = root_path
+      @package_paths = package_paths
+      @packages = {}
+    end
+
+    def load
+      load_primary_packages
+      load_secondary_packages
+
+      @packages
+    end
+
+    private
+
+    def deprecated_references_files
+      @deprecated_references_files ||= begin
+        return Dir[@root_path.join('**', Pocky::Package::DEPRECATED_REFERENCES_FILENAME).to_s] unless @package_paths
+
+        @package_paths.flat_map do |path|
+          Dir[@root_path.join(path, '**', Pocky::Package::DEPRECATED_REFERENCES_FILENAME).to_s]
+        end
+      end
+    end
+
+    def dependencies_files
+      @dependencies_files ||= begin
+        return Dir[@root_path.join('**', Pocky::Package::DEPENDENCIES_FILENAME).to_s] unless @package_paths
+
+        @package_paths.flat_map do |path|
+          Dir[@root_path.join(path, '**', Pocky::Package::DEPENDENCIES_FILENAME).to_s]
+        end
+      end
+    end
+
+    def init_package(package_name, primary)
+      Pocky::Package.new(
+        name: package_name,
+        path: @root_path.join(package_name).to_s,
+        primary: primary
+      )
+    end
+
+    def load_primary_packages
+      filenames = dependencies_files + deprecated_references_files
+      primary_package_names = filenames.map { |filename| parse_package_name(filename) }.uniq
+      primary_package_names.each do |name|
+        @packages[name] ||= init_package(name, true)
+      end
+    end
+
+    def load_secondary_packages
+      secondary_packages = {}
+      @packages.each do |_, package|
+        package.dependencies.each do |dependency|
+          secondary_packages[dependency] ||= init_package(dependency, false) unless @packages[dependency]
+        end
+
+        package.deprecated_references.each do |reference, _violations|
+          secondary_packages[reference] ||= init_package(reference, false) unless @packages[reference]
+        end
+      end
+
+      @packages.merge!(secondary_packages)
+    end
+
+    def parse_package_name(filename)
+      name = File.dirname(filename).gsub(@root_path.to_s, '')
+      name == '' ? '.' : name.gsub(/^\//, '')
+    end
+  end
+end

data/lib/pocky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pocky
-  VERSION = "2.7.0"
+  VERSION = "2.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pocky
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Quan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -44,6 +44,7 @@ files:
 - lib/pocky/Rakefile
 - lib/pocky/package.rb
 - lib/pocky/packwerk.rb
+- lib/pocky/packwerk_loader.rb
 - lib/pocky/railtie.rb
 - lib/pocky/ruby_file_size.rb
 - lib/pocky/tasks/generate.rake