klenod-build 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 560774e128fafb845afbff51f556e3eb30d3a1b7d280b9fbdc7ac36b48c4b741
-  data.tar.gz: 559ce8134726f2fa31084811a9dcda01987a957c073370f5ac0595c8d7a3f703
+  metadata.gz: f7515626d279801c2dfb15f6b0ff7d00b358c4dc20549f21b60730f1ef1307cf
+  data.tar.gz: ea285ea5d5d59188defafb4eced0c96ff316fbb67bd2d1cf0de7728f41cda927
 SHA512:
-  metadata.gz: 77cb936bd77e35262827d9903124f1b37cec73bb11db28c1a5e497d02a20d9283e989a46524c2f674b7c0f49734632e3da02b324a4988dbccbe3fe244e591921
-  data.tar.gz: eccc054b80b674a4f304fb6ec2abbdaf3bdf244576dc0f9bfd7b0d23b7b35ac77f5a47a061ad013cd9743295606b7ca3526a50e8f2dff48cc86ba13d4dac6fc2
+  metadata.gz: 7480460dfbedd0e793ceed82b3142d6ea5750f9c11e6752193745248643c53ff8a804cd1c855b4ffb171c8cdd1872a7aae9e66f15b417f8bc5f15d3d3baa8da6
+  data.tar.gz: 743b1821300848721a9208b1e6f59fc2736dc89d99f6e9ff24bb01346e9701645c2c88dc75daf83424f6a1e6ad758f98db7877fbccac2a0670cbf3630f26b19f

data/README.md

@@ -27,3 +27,6 @@ The CLI can also generate a [Graphviz](https://graphviz.org/) DOT-file from a ge
 ```sh
 bundle exec klenod graph dist/klenod.bundle > graph.dot
 ```
+
+Klenod's internal virtual modules are hidden by default. Pass
+`--internal-virtual-modules` to include them in the graph.

data/lib/klenod/build/cli/application.rb

@@ -68,13 +68,19 @@ module Klenod
 
         options do
           option "--no-assets", "Hide generated asset nodes and edges."
+          option "--internal-virtual-modules", "Include Klenod's internal virtual modules."
         end
 
         one :bundle_path, "Path to a Klenod runtime bundle.", required: true
 
         def call
           bundle = Klenod::Runtime.load_bundle(@bundle_path)
-          dot = Klenod::Build::Graphviz.call(bundle, include_assets: !@options[:no_assets])
+          dot =
+            Klenod::Build::Graphviz.call(
+              bundle,
+              include_assets: !@options[:no_assets],
+              include_internal_virtual_modules: @options[:internal_virtual_modules]
+            )
           output.write(dot)
           dot
         end

data/lib/klenod/build/errors.rb

@@ -161,7 +161,6 @@ module Klenod
     end
 
     class DynamicImportError < Error; end
-    class TestImportError < ResolveError; end
     class UnsupportedFileError < Error; end
 
     class ImportCycleError < Error

data/lib/klenod/build/graphviz.rb

@@ -19,13 +19,18 @@ module Klenod
       ASSET_STYLE = {fillcolor: "#ffe4d6", color: "#e26d39"}.freeze
       DEFAULT_MODULE_STYLE = {fillcolor: "#f7f7f7", color: "#8a8a8a"}.freeze
 
-      def self.call(bundle, include_assets: true)
-        new(bundle, include_assets: include_assets).to_dot
+      def self.call(bundle, include_assets: true, include_internal_virtual_modules: false)
+        new(
+          bundle,
+          include_assets: include_assets,
+          include_internal_virtual_modules: include_internal_virtual_modules
+        ).to_dot
       end
 
-      def initialize(bundle, include_assets: true)
+      def initialize(bundle, include_assets: true, include_internal_virtual_modules: false)
         @bundle = bundle
         @include_assets = include_assets
+        @include_internal_virtual_modules = include_internal_virtual_modules
       end
 
       def to_dot
@@ -46,8 +51,15 @@ module Klenod
 
       private
 
+      def all_module_ids
+        @all_module_ids ||= @bundle.modules.keys.sort
+      end
+
       def module_ids
-        @bundle.modules.keys.sort
+        @module_ids ||=
+          all_module_ids.reject do |id|
+            internal_virtual_module?(id) && !entrypoint?(id) && !@include_internal_virtual_modules
+          end
       end
 
       def module_node(id)
@@ -75,7 +87,7 @@ module Klenod
         module_ids.flat_map do |id|
           @bundle.modules.fetch(id).imports.values.map do |import|
             import = import_spec(import)
-            next unless @bundle.modules.key?(import.target_id)
+            next unless visible_module?(import.target_id)
 
             attributes = {
               id: svg_edge_id(id, import.target_id),
@@ -91,25 +103,71 @@ module Klenod
       end
 
       def asset_edges
-        @bundle.assets.values.sort_by(&:output_path).filter_map do |asset|
-          owner = asset_owner(asset)
-          next unless owner
-
-          attributes = {
-            id: svg_edge_id(owner_node_name(owner), asset.output_path),
-            class: "edge edge-asset",
-            color: "#e26d39",
-            style: "dotted",
-            label: "asset"
-          }
-          "  #{owner_node_id(owner)} -> #{asset_node_id(asset)} [#{dot_attributes(attributes)}];"
+        @bundle.assets.values.sort_by(&:output_path).flat_map do |asset|
+          asset_owners(asset).map do |owner|
+            attributes = {
+              id: svg_edge_id(owner_node_name(owner), asset.output_path),
+              class: "edge edge-asset",
+              color: "#e26d39",
+              style: "dotted",
+              label: "asset"
+            }
+            "  #{owner_node_id(owner)} -> #{asset_node_id(asset)} [#{dot_attributes(attributes)}];"
+          end
         end
       end
 
-      def asset_owner(asset)
-        return [:module, asset.logical_name] if @bundle.modules.key?(asset.logical_name)
+      def asset_owners(asset)
+        module_id = module_id_for_asset(asset.logical_name)
+        return visible_module_owners(module_id) if module_id
 
-        google_fonts_css_asset_owner(asset) || query_module_id_for(asset.logical_name)
+        [google_fonts_css_asset_owner(asset), *asset_metadata_owners(asset)].compact
+      end
+
+      def visible_module_owners(module_id)
+        pending = [module_id]
+        seen = Set.new
+        owners = []
+
+        until pending.empty?
+          current_id = pending.shift
+          next unless seen.add?(current_id)
+
+          if visible_module?(current_id)
+            owners << [:module, current_id]
+          else
+            pending.concat(module_importers.fetch(current_id, []))
+          end
+        end
+
+        owners
+      end
+
+      def module_importers
+        @module_importers ||=
+          all_module_ids.each_with_object(Hash.new { |index, id| index[id] = [] }) do |id, index|
+            @bundle.modules.fetch(id).imports.each_value do |import|
+              target_id = import_spec(import).target_id
+              index[target_id] << id if @bundle.modules.key?(target_id)
+            end
+          end
+      end
+
+      def module_id_for_asset(logical_name)
+        return logical_name if @bundle.modules.key?(logical_name)
+
+        module_ids_by_source_path.fetch(logical_name, nil) || query_module_ids_by_path.fetch(logical_name, nil)
+      end
+
+      def module_ids_by_source_path
+        @module_ids_by_source_path ||=
+          all_module_ids.each_with_object({}) do |id, index|
+            source_path = @bundle.modules.fetch(id).source_path
+            next unless source_path
+
+            index[source_path] ||= id
+            index[display_path(source_path)] ||= id
+          end
       end
 
       def google_fonts_css_asset_owner(asset)
@@ -127,14 +185,18 @@ module Klenod
         asset.metadata[:source_url]
       end
 
-      def query_module_id_for(logical_name)
-        module_id = query_module_ids_by_path.fetch(logical_name, nil)
-        [:module, module_id] if module_id
+      def asset_metadata_owners(asset)
+        return [] unless asset.metadata[:javascript_runtime] == :asset_metadata
+
+        @bundle.assets.values
+          .select { it.metadata[:image_metadata] || it.metadata[:svg_metadata] }
+          .sort_by(&:output_path)
+          .map { [:asset, it] }
       end
 
       def query_module_ids_by_path
         @query_module_ids_by_path ||=
-          module_ids.each_with_object({}) do |id, index|
+          all_module_ids.each_with_object({}) do |id, index|
             path, query = id.split("?", 2)
             next unless query
 
@@ -218,6 +280,15 @@ module Klenod
         ["edge", import.eager ? "edge-import" : "edge-import edge-lazy"].join(" ")
       end
 
+      def internal_virtual_module?(id)
+        id.start_with?("virtual:/klenod/", "virtual:klenod/")
+      end
+
+      def visible_module?(id)
+        @visible_module_ids ||= module_ids.to_set
+        @visible_module_ids.include?(id)
+      end
+
       def entrypoint?(id)
         entrypoint_ids.include?(id)
       end

data/lib/klenod/build/plugins.rb

@@ -17,7 +17,6 @@ module Klenod
       autoload :TomlPlugin, File.expand_path("plugins/data_plugin", __dir__)
       autoload :TextPlugin, File.expand_path("plugins/data_plugin", __dir__)
       autoload :RouterPlugin, File.expand_path("plugins/router_plugin", __dir__)
-      autoload :TestPlugin, File.expand_path("plugins/test_plugin", __dir__)
     end
   end
 end

data/lib/klenod/build/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module Build
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/klenod/build.rb

@@ -9,8 +9,6 @@ module Klenod
 
   module Build
     autoload :Graphviz, "klenod/build/graphviz"
-    autoload :TestSelection, "klenod/build/test_suite"
-    autoload :TestSuite, "klenod/build/test_suite"
     autoload :UpdateEvent, "klenod/build/watcher"
     autoload :Watcher, "klenod/build/watcher"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-build
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrés Alin
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -272,7 +272,6 @@ files:
 - lib/klenod/build/plugins/router_plugin.rb
 - lib/klenod/build/plugins/ruby_plugin.rb
 - lib/klenod/build/plugins/svg_plugin.rb
-- lib/klenod/build/plugins/test_plugin.rb
 - lib/klenod/build/profiler.rb
 - lib/klenod/build/resolution_error_formatter.rb
 - lib/klenod/build/resolver.rb
@@ -281,7 +280,6 @@ files:
 - lib/klenod/build/source_map/editor.rb
 - lib/klenod/build/source_map/map.rb
 - lib/klenod/build/source_map/vlq.rb
-- lib/klenod/build/test_suite.rb
 - lib/klenod/build/transform_result.rb
 - lib/klenod/build/version.rb
 - lib/klenod/build/watched_pattern.rb

data/lib/klenod/build/plugins/test_plugin.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../errors"
-require_relative "../module_id"
-require_relative "../plugin"
-
-module Klenod
-  module Build
-    module Plugins
-      module TestPlugin
-        def self.new(...)
-          Plugin.new(...)
-        end
-
-        class Plugin < Klenod::Build::Plugin
-          DEFAULT_PATTERN = "**/*.test.rb"
-
-          def initialize(pattern: DEFAULT_PATTERN)
-            @pattern = pattern.to_s
-          end
-
-          attr_reader :pattern
-
-          def discover(source_dir:)
-            root = Pathname.new(source_dir).expand_path
-
-            root
-              .glob(pattern)
-              .select(&:file?)
-              .map { |path| ModuleId.new(path.relative_path_from(root).to_s.tr("\\", "/"), nil) }
-              .sort_by(&:to_s)
-          end
-
-          def test_module_id?(module_id)
-            module_id.scheme == :app && File.fnmatch?(pattern, module_id.relative_path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
-          end
-
-          def finalize(module_id, result, resolved_dependencies, _dependency_records, _context)
-            imported_test = resolved_dependencies.find { |dependency| test_module_id?(dependency.module_id) }
-            return result unless imported_test
-
-            error = TestImportError.new("Test file #{imported_test.module_id.path.inspect} cannot be imported")
-            raise error.with_resolution_context(dependency: imported_test.dependency, importer_id: module_id)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/klenod/build/test_suite.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module Klenod
-  module Build
-    TestSelection = Data.define(:test_paths, :removed_test_paths) do
-      def empty?
-        test_paths.empty? && removed_test_paths.empty?
-      end
-    end
-
-    class TestSuite
-      def initialize(context:, plugin:)
-        @context = context
-        @plugin = plugin
-        @dependency_ids = {}
-        @failed_test_ids = Set.new
-      end
-
-      def collect
-        test_ids = discover
-        test_ids.each { |test_id| index(test_id) }
-        selection(test_ids)
-      end
-
-      def update(event)
-        previous_test_ids = @dependency_ids.keys.to_set
-        current_test_ids = discover.to_set
-        removed_test_ids = previous_test_ids - current_test_ids
-        added_test_ids = current_test_ids - previous_test_ids
-        affected_module_ids = update_module_ids(event)
-        affected_test_ids =
-          @dependency_ids.filter_map do |test_id, dependency_ids|
-            test_id if current_test_ids.include?(test_id) && dependency_ids.intersect?(affected_module_ids)
-          end
-
-        test_ids = (added_test_ids + affected_test_ids + @failed_test_ids).select { |test_id| current_test_ids.include?(test_id) }
-        removed_test_ids.each { |test_id| remove(test_id) }
-        test_ids.each { |test_id| index(test_id) }
-
-        selection(test_ids, removed_test_ids)
-      end
-
-      private
-
-      attr_reader :context, :plugin
-
-      def discover
-        plugin.discover(source_dir: context.graph.source_dir)
-      end
-
-      def index(test_id)
-        dependency_ids = Set[test_id]
-        @dependency_ids[test_id] = dependency_ids
-        collect_dependencies(test_id, dependency_ids)
-        @failed_test_ids.delete(test_id)
-      rescue
-        @failed_test_ids << test_id
-      end
-
-      def collect_dependencies(module_id, dependency_ids)
-        record = context.graph.records[module_id] || context.graph.collect_module(module_id)
-
-        record.resolved_dependencies.each do |dependency|
-          dependency_id = dependency.module_id
-          next unless dependency_ids.add?(dependency_id)
-
-          collect_dependencies(dependency_id, dependency_ids)
-        end
-      end
-
-      def remove(test_id)
-        @dependency_ids.delete(test_id)
-        @failed_test_ids.delete(test_id)
-      end
-
-      def update_module_ids(event)
-        result = event.result
-        Set.new(
-          result.changed_module_ids +
-            result.removed_module_ids +
-            result.reloaded_module_ids +
-            result.reevaluated_module_ids
-        )
-      end
-
-      def selection(test_ids, removed_test_ids = [])
-        TestSelection.new(
-          test_ids.map(&:relative_path).sort.freeze,
-          removed_test_ids.map(&:relative_path).sort.freeze
-        )
-      end
-    end
-  end
-end