antoinette 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 795388e48b4799e7b321bc12ce0050797fee44d3bc6008f289c7367efe839dbd
-  data.tar.gz: 788964274ce4ed2c0061017aee248dd58e93864d86ce56eefe65b9d13f2a115a
+  metadata.gz: 993d24ce2af00ab04f836fefdecc77510733c8f4ca905b396f63eaa4bb578bbc
+  data.tar.gz: ff2cb5009b0a07f05afb5055ff3a7547368effe0a0577913d6394bfbe16f9303
 SHA512:
-  metadata.gz: 329ab030c6192c1af402741a0050c67059a353e8a16c3f445a99343b600666d6c1c9062d7a78ccddbf0fbc8f751c63c835d4953d9b855dd3da84b7b6458217b2
-  data.tar.gz: 778cd2d85170e35ef3ff5a6ffe987eef2d6c728a2072466336e13307847b1ba9eec6d0b2a89fa19dc44227529d065482a9801deeb7b6b4235abb3905c7b00d8a
+  metadata.gz: 611a4278897c3ee934884453547a96dfeec11855732f5596dcb71c7028fd70e32caf588af64c6746a6f5f89e08a5b69f8c04a63ccfdd5f14a1310b853b3bb861
+  data.tar.gz: 18bb190a09f1ef55effc1c8b79597e89fb50bd84c9e8d81cc66a7d9cc170c8b80ab57069ebd3bee868fe44bfd3f5dea3bb2030d37ae2e245d59249507888b8a5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.2.0] - 2026
+
+- Layout-aware bundling for SitePress YAML frontmatter
+- Remove SHA1 digests from template marker comments
+- Optional `--width` and `--height` flags for BundleGraph
+
 ## [0.1.0] - 2024
 
 - Initial extraction from Gridular Mod

data/README.md

@@ -18,7 +18,19 @@ This is the problem Antoinette solves.
 Antoinette is a lightweight JS bundler which weaves Elm apps into JavaScript
 bundles, and weaves JavaScript bundles into Rails templates.
 
-The name comes from mansion weave, a style of flooring based on woven elm wood,
+It looks at `app/views` to make a hash which maps every Elm app referenced in
+the templates to every template which references them. It uses that mapping to
+create a set of JS bundles such that every Rails template will download all of
+the Elm apps it needs, but no Rails template will download any Elm app it
+doesn't need. Antoinette also creates a visualizer, as an Elm app in a Rails
+view, which you can use to understand its output.
+
+Here's an example screenshot. In the actual Elm app, you can hover over any
+given bundle to see which Elm apps it places within which Rails templates.
+
+![Example of Antoinette's admin visualizer](images/example.png)
+
+The name was inspired by mansion weave, a style of flooring based on woven elm,
 which was popular in French mansions from the 16th century onwards.
 
 ## Installation
@@ -49,7 +61,8 @@ It also adds a route for `/antoinette` admin page, and adds
 
 ### Configuration
 
-Generate bundle configuration by analyzing which Elm apps are used in your Rails views:
+Generate bundle configuration by analyzing which Elm programs your Rails
+views use:
 
 ```bash
 bin/antoinette config
@@ -94,23 +107,26 @@ flow into bundles and then into Rails templates.
 
 1. **Analysis**: Scans Rails views for `Elm.AppName.init` patterns
 2. **Grouping**: Groups templates that use the same combination of Elm apps
-3. **Bundling**: Compiles each group into a single JavaScript bundle (with a haiku-styled name like `holy-waterfall-8432`)
-4. **Injection**: Adds `javascript_include_tag` to templates with SHA1 digest comments for idempotent updates
+3. **Bundling**: Compiles each group into a single JavaScript bundle (with a
+haiku-styled name like `holy-waterfall-8432`)
+4. **Injection**: Adds `javascript_include_tag` to templates with a marker
+comment for idempotent updates
 
 ### Script Tag Format
 
 Antoinette injects script tags like:
 
 ```erb
-<%= javascript_include_tag "antoinette/holy-waterfall-8432" %> <!-- antoinette a1b2c3d4... -->
+<%= javascript_include_tag "antoinette/holy-waterfall-8432" %> <!-- antoinette -->
 ```
 
-Embedding a hash in the comment ensures that tags only get updated when bundle content changes.
+The `<!-- antoinette -->` comment marks the line so it can be found and replaced
+on subsequent builds.
 
 ## Requirements
 
 - Rails 7.0+
-- Elm (customize via `elm_path` in `config/antoinette.json`)
+- Elm (customizable via `elm_path` in `config/antoinette.json`)
 
 ## Configuration
 
@@ -130,6 +146,14 @@ The `config/antoinette.json` file structure:
 }
 ```
 
+## SitePress Support and Layout Awareness
+
+`custom_view_paths` exists because Antoinette has a limited layout awareness
+tied into SitePress. Antoinette looks for layouts in `app/views/layouts` and in
+the YAML frontmatter in SitePress content templates. It can't currently tell
+which Rails templates use which Rails layouts, but it can tell which SitePress
+templates use which SitePress layouts.
+
 ## Rake Integration
 
 The `antoinette:build` task runs automatically before `assets:precompile`:

data/lib/antoinette/cli/commands.rb

@@ -17,8 +17,9 @@ module Antoinette
 
         option :stdout, type: :boolean, default: false, desc: "Output to stdout instead of file"
         option :custom_views, type: :array, default: [], desc: "Additional view directories to scan"
+        option :layout_dirs, type: :array, default: [], desc: "Additional layout directories to scan"
 
-        def call(stdout:, custom_views: [], **)
+        def call(stdout:, custom_views: [], layout_dirs: [], **)
           out = Antoinette::CLI.output
           config_path = Rails.root.join("config", "antoinette.json")
 
@@ -29,19 +30,27 @@ module Antoinette
           end
           existing_custom = existing_config["custom_view_paths"] || []
           existing_elm_path = existing_config["elm_path"] || "elm"
+          existing_layout_dirs = existing_config["layout_dirs"] || []
           all_custom_views = (existing_custom + custom_views).uniq
+          all_layout_dirs = (["app/views/layouts"] + existing_layout_dirs + layout_dirs).uniq
 
           analyzer = Antoinette::ElmAppUsageAnalyzer.new(
-            skip: "layouts/",
+            layout_dirs: all_layout_dirs,
             custom_view_paths: all_custom_views
           )
+          layout_resolver = Antoinette::LayoutResolver.new(
+            layout_dirs: all_layout_dirs
+          )
           weaver = Antoinette::Weaver.new(
             elm_analyzer: analyzer,
+            layout_resolver: layout_resolver,
             custom_view_paths: all_custom_views
           )
 
           output = JSON.parse(weaver.generate_json)
           output["elm_path"] = existing_elm_path
+          extra_layout_dirs = all_layout_dirs - ["app/views/layouts"]
+          output["layout_dirs"] = extra_layout_dirs if extra_layout_dirs.any?
           json_output = JSON.pretty_generate(output)
 
           if stdout

data/lib/antoinette/services/clear_script_tag.rb

@@ -10,9 +10,9 @@ module Antoinette
       full_path = resolve_template_path(template_path)
       content = File.read(full_path)
 
-      return unless content.match?(/<!-- antoinette [a-f0-9]+ -->/)
+      return unless content.match?(InjectScriptTag::MARKER)
 
-      updated_content = content.gsub(/^.*<!-- antoinette [a-f0-9]+ -->.*\n?/, "")
+      updated_content = content.gsub(/^.*#{InjectScriptTag::MARKER}.*\n?/o, "")
 
       File.write(full_path, updated_content)
     end

data/lib/antoinette/services/elm_app_usage_analyzer.rb

@@ -8,8 +8,8 @@ module Antoinette
     ElmApp = Struct.new(:name)
     class Matrix < Hash; end
 
-    def initialize(skip: nil, custom_view_paths: [])
-      @skip = skip
+    def initialize(layout_dirs: ["app/views/layouts"], custom_view_paths: [])
+      @layout_dirs = layout_dirs
       @custom_view_paths = custom_view_paths
     end
 
@@ -21,7 +21,7 @@ module Antoinette
           next if apps.empty?
 
           relative_path = file_path.sub("#{Rails.root}/", "")
-          next if @skip && relative_path.include?("app/views/#{@skip}")
+          next if in_layout_dir?(relative_path)
 
           app_names = apps.map(&:name)
           result << ViewFile.new(relative_path, app_names)
@@ -60,14 +60,6 @@ module Antoinette
       @all_app_names ||= views.flat_map(&:elm_apps).uniq.sort
     end
 
-    def layout_apps
-      @layout_apps ||= Dir.glob(Rails.root.join("app", "views", "layouts", "*.html.erb"))
-        .flat_map do |file_path|
-          content = File.read(file_path)
-          elm_apps(content).map(&:name)
-        end.uniq
-    end
-
     def per_file
       @per_file ||= views.sort_by { |vf| -vf.elm_apps.count }
         .each_with_object({}) do |view_file, result|
@@ -96,5 +88,11 @@ module Antoinette
         end
       end
     end
+
+    private
+
+    def in_layout_dir?(relative_path)
+      @layout_dirs.any? { |dir| relative_path.start_with?(dir) }
+    end
   end
 end

data/lib/antoinette/services/inject_script_tag.rb

@@ -1,25 +1,17 @@
 # frozen_string_literal: true
 
-require "digest"
-
 module Antoinette
   class InjectScriptTag
-    def initialize(
-      assets_path: Rails.root.join("app", "assets", "javascripts", "antoinette")
-    )
-      @assets_path = assets_path
-    end
+    MARKER = /<!-- antoinette( [a-f0-9]+)? -->/
 
     def inject(template_path:, bundle_name:)
       full_path = Rails.root.join(template_path)
       content = File.read(full_path)
 
-      bundle_path = @assets_path.join("#{bundle_name}.js")
-      digest = Digest::SHA1.hexdigest(File.read(bundle_path))
-      script_tag = "<%= javascript_include_tag \"antoinette/#{bundle_name}\" %> <!-- antoinette #{digest} -->"
+      script_tag = "<%= javascript_include_tag \"antoinette/#{bundle_name}\" %> <!-- antoinette -->"
 
-      updated_content = if content.match?(/<!-- antoinette [a-f0-9]+ -->/)
-        content.gsub(/^.*<!-- antoinette [a-f0-9]+ -->.*$/, script_tag)
+      updated_content = if content.match?(MARKER)
+        content.gsub(/^.*#{MARKER}.*$/o, script_tag)
       else
         content + "\n" + script_tag
       end

data/lib/antoinette/services/layout_resolver.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Antoinette
+  class LayoutResolver
+    def initialize(layout_dirs: ["app/views/layouts"], default_layout: "application")
+      @layout_dirs = layout_dirs
+      @default_layout = default_layout
+    end
+
+    def layout_apps_map
+      @layout_apps_map ||= @layout_dirs.each_with_object({}) do |dir, result|
+        Dir.glob(Rails.root.join(dir, "*.html.erb")).each do |file_path|
+          content = File.read(file_path)
+          apps = content.scan(/Elm\.(\w+)\.init/).flatten.uniq
+          name = File.basename(file_path, ".html.erb")
+          result[name] = ((result[name] || []) + apps).uniq
+        end
+      end
+    end
+
+    def layout_for(template_path)
+      full_path = if Pathname.new(template_path).absolute?
+        template_path
+      else
+        Rails.root.join(template_path).to_s
+      end
+
+      return @default_layout unless File.exist?(full_path)
+
+      content = File.read(full_path)
+      return @default_layout unless content.start_with?("---")
+
+      frontmatter = content.match(/\A---\s*\n(.*?\n)---/m)
+      return @default_layout unless frontmatter
+
+      yaml = YAML.safe_load(frontmatter[1])
+      yaml&.fetch("layout", @default_layout) || @default_layout
+    end
+
+    def apps_for(template_path)
+      layout = layout_for(template_path)
+      layout_apps_map[layout] || []
+    end
+  end
+end

data/lib/antoinette/services/weaver.rb

@@ -10,24 +10,27 @@ module Antoinette
     def initialize(
       elm_analyzer: ElmAppUsageAnalyzer.new,
       partial_resolver: PartialResolver.new,
+      layout_resolver: LayoutResolver.new,
       custom_view_paths: []
     )
       @elm_analyzer = elm_analyzer
       @partial_resolver = partial_resolver
+      @layout_resolver = layout_resolver
       @custom_view_paths = custom_view_paths
     end
 
     def bundles
-      @bundles ||= @elm_analyzer.layout_apps.then do |layout_apps|
-        @elm_analyzer.mappings.map do |apps, templates|
-          resolved_templates = resolve_templates_from_partials(templates)
-          merged_apps = (apps + layout_apps).uniq.sort
-          Bundle.new(
-            Haikunator.haikunate,
-            merged_apps,
-            resolved_templates.sort
-          )
-        end.sort_by { |bundle| -bundle.elm_apps.count }
+      @bundles ||= begin
+        result = []
+        @elm_analyzer.mappings.each do |page_apps, templates|
+          resolved = resolve_templates_from_partials(templates)
+          groups = resolved.group_by { |t| @layout_resolver.apps_for(t) }
+          groups.each do |layout_apps, group_templates|
+            merged = (page_apps + layout_apps).uniq.sort
+            result << Bundle.new(Haikunator.haikunate, merged, group_templates.sort)
+          end
+        end
+        result.sort_by { |b| -b.elm_apps.count }
       end
     end
 

data/lib/antoinette/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Antoinette
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/antoinette.rb

@@ -2,6 +2,7 @@
 
 require_relative "antoinette/version"
 require_relative "antoinette/services/partial_resolver"
+require_relative "antoinette/services/layout_resolver"
 require_relative "antoinette/services/elm_app_usage_analyzer"
 require_relative "antoinette/services/weaver"
 require_relative "antoinette/services/compile_elm"

data/lib/generators/antoinette/templates/BundleGraph.elm

@@ -13,6 +13,8 @@ type alias Model =
     { bundles : List Bundle
     , selectedNodeId : Maybe String
     , lockedNodeIds : List String
+    , width : Maybe Int
+    , height : Maybe Int
     }
 
 
@@ -25,6 +27,8 @@ type alias Bundle =
 
 type alias Flags =
     { bundles : List Bundle
+    , width : Maybe Int
+    , height : Maybe Int
     }
 
 
@@ -59,6 +63,8 @@ init flags =
             ( { bundles = decoded.bundles
               , selectedNodeId = Nothing
               , lockedNodeIds = []
+              , width = decoded.width
+              , height = decoded.height
               }
             , Cmd.none
             )
@@ -67,6 +73,8 @@ init flags =
             ( { bundles = []
               , selectedNodeId = Nothing
               , lockedNodeIds = []
+              , width = Nothing
+              , height = Nothing
               }
             , Cmd.none
             )
@@ -125,8 +133,8 @@ view model =
                     model.lockedNodeIds
 
         sankeyModel =
-            { svgWidth = 1100
-            , svgHeight = totalHeight model.bundles
+            { svgWidth = toFloat (Maybe.withDefault 1100 model.width)
+            , svgHeight = toFloat (Maybe.withDefault (totalHeightInt model.bundles) model.height)
             , columnWidths = columnWidths
             , nodePadding = 8
             , columnSpacing = 350
@@ -162,7 +170,7 @@ view model =
                 , style "border" "1px solid #d1d5db"
                 ]
     in
-    div []
+    div [ Html.Attributes.class "bundle-graph" ]
         [ div [ style "display" "flex", style "align-items" "center", style "gap" "16px" ]
             [ h1
                 [ style "font-family" "system-ui, sans-serif"
@@ -187,8 +195,8 @@ view model =
         ]
 
 
-totalHeight : List Bundle -> Float
-totalHeight bundles =
+totalHeightInt : List Bundle -> Int
+totalHeightInt bundles =
     let
         elmApps =
             uniqueElmApps bundles
@@ -202,7 +210,7 @@ totalHeight bundles =
         rowHeight =
             27
     in
-    toFloat (maxItems * rowHeight + 100)
+    maxItems * rowHeight + 100
 
 
 buildColumnWidths : List LabelNode -> Dict.Dict Int Float
@@ -332,8 +340,10 @@ unique list =
 
 flagsDecoder : Decoder Flags
 flagsDecoder =
-    Decode.map Flags
+    Decode.map3 Flags
         (Decode.field "bundles" (Decode.list bundleDecoder))
+        (Decode.maybe (Decode.field "width" Decode.int))
+        (Decode.maybe (Decode.field "height" Decode.int))
 
 
 bundleDecoder : Decoder Bundle

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: antoinette
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Giles Bowkett
@@ -99,6 +99,7 @@ files:
 - lib/antoinette/services/concat_bundle.rb
 - lib/antoinette/services/elm_app_usage_analyzer.rb
 - lib/antoinette/services/inject_script_tag.rb
+- lib/antoinette/services/layout_resolver.rb
 - lib/antoinette/services/partial_resolver.rb
 - lib/antoinette/services/weaver.rb
 - lib/antoinette/version.rb