klenod-build 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c7b7667bd38de08f8f31ebb2aecf97bcbde81d8e189dae356ac64651dd340b
-  data.tar.gz: 55d2493b7d0047d97f9fb26766f7f6a1ed07867e1b1024c04d92dac3e04088e7
+  metadata.gz: f7515626d279801c2dfb15f6b0ff7d00b358c4dc20549f21b60730f1ef1307cf
+  data.tar.gz: ea285ea5d5d59188defafb4eced0c96ff316fbb67bd2d1cf0de7728f41cda927
 SHA512:
-  metadata.gz: ce9d72bdc5127d334c72baa154e6d16997081c3e3a7f016074ec41088a16007b4c35c93d4bfb96a220fd950539b0e3496d7b3c9b33439c6777d5760cad2e2715
-  data.tar.gz: 156d7564ff2e42c7831585790e906598510f5b27c74de16378f06870e792baa91f15101abe932212b6669a7a368d5b852c9f1be2cdeae5cc75ffa2f951eff46f
+  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/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/haml_plugin.rb

@@ -30,6 +30,7 @@ module Klenod
         DEFAULT_FACTORY = ComponentDefaults::DEFAULT_FACTORY
         DEFAULT_COMPONENT_CHILDREN = :eager
         COMPONENT_CHILDREN_MODES = %i[eager lazy].freeze
+        I18N_OPTIONS = %i[class constant].freeze
         HAML_HELPER_SPECIFIER = "virtual:klenod/haml_helper"
         HAML_HELPER_MODULE_ID = ModuleId.new("#{HAML_HELPER_SPECIFIER}.rb", nil)
         STATIC_CLASS_SOURCE_PATTERN = /^[ \t]*(?:%[-:\w]+)?(?:#[\w-]+)?\.[\w-]|[({][^)}\n]*\bclass\s*=/m
@@ -47,6 +48,7 @@ module Klenod
           DEFAULT_FACTORY = HamlPlugin::DEFAULT_FACTORY
           DEFAULT_COMPONENT_CHILDREN = HamlPlugin::DEFAULT_COMPONENT_CHILDREN
           COMPONENT_CHILDREN_MODES = HamlPlugin::COMPONENT_CHILDREN_MODES
+          I18N_OPTIONS = HamlPlugin::I18N_OPTIONS
           HAML_HELPER_SPECIFIER = HamlPlugin::HAML_HELPER_SPECIFIER
           HAML_HELPER_MODULE_ID = HamlPlugin::HAML_HELPER_MODULE_ID
           STATIC_CLASS_SOURCE_PATTERN = HamlPlugin::STATIC_CLASS_SOURCE_PATTERN
@@ -64,15 +66,14 @@ module Klenod
             factory: DEFAULT_FACTORY,
             component_children: DEFAULT_COMPONENT_CHILDREN,
             variables: nil,
-            i18n_class: nil,
-            i18n_constant: nil,
+            i18n: nil,
             cache_static_subtrees: false
           )
             @component_base_class = component_base_class
             @factory = factory
             @component_children = validate_component_children(component_children)
             @variables = validate_variables(variables)
-            @i18n_class, @i18n_constant = validate_i18n_options(i18n_class, i18n_constant)
+            @i18n_class, @i18n_constant = validate_i18n_options(i18n)
             @cache_static_subtrees = cache_static_subtrees
             @transformer = Transformer.new
           end
@@ -296,15 +297,23 @@ module Klenod
             raise ArgumentError, "variables[#{kind.inspect}] must be a Ruby expression"
           end
 
-          def validate_i18n_options(i18n_class, i18n_constant)
-            return [nil, nil] if i18n_class.nil? && i18n_constant.nil?
-            raise ArgumentError, "i18n_class must be configured when i18n_constant is configured" if i18n_class.nil?
+          def validate_i18n_options(i18n)
+            return [nil, nil] if i18n.nil?
+            raise ArgumentError, "i18n must be a Hash" unless i18n.is_a?(Hash)
 
-            i18n_constant = (i18n_constant || "I18n").to_s
-            raise ArgumentError, "i18n_constant must be a Ruby constant name" unless i18n_constant.match?(/\A[A-Z]\w*\z/)
+            unknown_options = i18n.keys - I18N_OPTIONS
+            unless unknown_options.empty?
+              raise ArgumentError, "i18n contains unknown options: #{unknown_options.map(&:inspect).join(", ")}"
+            end
+
+            i18n_class = i18n[:class]
+            raise ArgumentError, "i18n[:class] must be configured" if i18n_class.nil?
+
+            i18n_constant = (i18n[:constant] || "I18n").to_s
+            raise ArgumentError, "i18n[:constant] must be a Ruby constant name" unless i18n_constant.match?(/\A[A-Z]\w*\z/)
 
             [
-              Transformer::ConstPath.parse(i18n_class, name: "i18n_class").to_s,
+              Transformer::ConstPath.parse(i18n_class, name: "i18n[:class]").to_s,
               i18n_constant
             ]
           end

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

@@ -191,6 +191,8 @@ module Klenod
                     super(src:, width:, height:, content_type:, aspect_ratio:, variants: variants.dup.freeze)
                   end
 
+                  alias to_s src
+
                   def srcset
                     return nil if variants.empty?
 
@@ -205,7 +207,9 @@ module Klenod
                   end
                 end
 
-              ImageVariant = Data.define(:src, :width, :height, :content_type, :aspect_ratio, :format, :descriptor, :quality)
+              ImageVariant = Data.define(:src, :width, :height, :content_type, :aspect_ratio, :format, :descriptor, :quality) do
+                alias to_s src
+              end
             RUBY
           end
 

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

@@ -94,7 +94,9 @@ module Klenod
 
           def svg_runtime_source
             <<~RUBY
-              SvgMetadata = Data.define(:src, :width, :height, :content_type, :aspect_ratio)
+              SvgMetadata = Data.define(:src, :width, :height, :content_type, :aspect_ratio) do
+                alias to_s src
+              end
             RUBY
           end
 

data/lib/klenod/build/version.rb

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

data/lib/klenod/build/watcher.rb

@@ -53,10 +53,11 @@ module Klenod
         end
       end
 
-      def initialize(source_dir:, context:, debounce_interval: 0.1)
+      def initialize(source_dir:, context:, debounce_interval: 0.1, ignore: nil)
         @source_dir = source_dir
         @context = context
         @debounce_interval = debounce_interval
+        @ignore = ignore
         @graph_version = 0
         @pending_changes = PendingChanges.new
         @pending_mutex = Mutex.new
@@ -68,7 +69,7 @@ module Klenod
       def start
         @worker_thread = Thread.new { process_pending_updates }
         @listener =
-          Listen.to(@source_dir) do |modified, added, removed|
+          Listen.to(@source_dir, ignore: @ignore) do |modified, added, removed|
             enqueue_update(modified + added, removed)
           end
         @listener.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-build
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrés Alin
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement