ember-cli-rails-assets 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b0e51245621258b937d06d80ec8a579a0a79757d82ca48543c6140a831a557
-  data.tar.gz: c3e66e4300881a1627db2ef33e89cd4814a3cb9aaba1f664113bd3dd5caf3ba0
+  metadata.gz: a14199abf9cfa5f0faf079ea10fbc134cf701d48d016da69f7d43ed64256fbdf
+  data.tar.gz: b5d351892f33578fcae89ccdb77966393b2682f634dfe5f3d0ee384e42e095b3
 SHA512:
-  metadata.gz: e11ac7ab0892ee54e8c6de2e0bf410db8596de9e45efd40658bd6c5c2803ddb3a9eee354730327644f9445063e041f502415280d1ac93fd0de54eb697cfb07a1
-  data.tar.gz: 6d5cbfadca8796f9596eaa67d5c8c3a9a6c36a45ea3f5751606ac617ea025064861210cebd97f04bf2ff14b65d202c049645577c08220da5bd3acf476f06a535
+  metadata.gz: 52c74aa8f6993613dd16c7e762260ce2818654d043ac80b1627392ac2fbd3cdcbcc3231a9b67125f107b1de4b0aab97f52aaa7f6f9f9fa34025a7fb92a160244
+  data.tar.gz: 4c639e39672b4cbc07281153c20e3a27d68f233e20a0abd3ab2b03ae130c71c807db7a91acbbcb05121d130fb8f4484e9baedfa1d386da0cf5eca171013c70d7

data/README.md

@@ -33,8 +33,9 @@ $ bundle install
 To configure your project to use `ember-cli-rails`, follow the instructions
 listed in the [`ember-cli-rails` README][README].
 
-To configure your project to user `ember-cli-rails-assets`, ensure each Ember
-application's `ember-cli-build.js` includes the following values:
+To configure a classic (Broccoli-based) Ember application to use
+`ember-cli-rails-assets`, ensure its `ember-cli-build.js` includes the
+following values:
 
 ```js
 // frontend/ember-cli-build.js
@@ -54,6 +55,27 @@ module.exports = function(defaults) {
 
 [README]: https://github.com/tricknotes/ember-cli-rails#readme
 
+### Vite-based applications
+
+Vite-based applications (generated with `ember-cli >= 6.8`) require no build
+configuration. For them, use `include_ember_script_tags` on its own: it emits
+everything the application needs to boot — the configuration `<meta>` tag, the
+stylesheet and `modulepreload` links, and the ES module script tags —
+extracted from the generated `index.html`:
+
+```erb
+<%= include_ember_script_tags :frontend %>
+```
+
+When ember-cli-rails serves the application from Vite's development server in
+`development`, `include_ember_script_tags` reads `index.html` from the server
+instead of a build directory, and emits the startup tags with absolute URLs
+pointing at the server. Nothing is built, so changes to the application are
+picked up by reloading the page.
+
+`include_ember_stylesheet_tags` only supports classic applications, and raises
+an error when called for a Vite-based application.
+
 ## Mount
 
 Mount the Ember application (in this example, the `frontend` application) to the
@@ -114,19 +136,22 @@ To render the asset elements without using a `<base>` element, pass the URL or
 path to prepend:
 
 ```erb
-<-- assuming Ember's assets are mounted to `"/"` -->
+<!-- assuming Ember's assets are mounted to `"/"` -->
 <%= include_ember_script_tags :frontend, prepend: "/" %>
 <%= include_ember_stylesheet_tags :frontend, prepend: "/" %>
 
-<%= include_ember_script_tags :admin_panel, prepend: "/" %>
-<%= include_ember_stylesheet_tags :admin_panel, prepend: "/" %>
+<!-- assuming Ember's assets are mounted to `"/admin_panel/"` -->
+<%= include_ember_script_tags :admin_panel, prepend: "/admin_panel/" %>
+<%= include_ember_stylesheet_tags :admin_panel, prepend: "/admin_panel/" %>
 ```
 
 ## EmberCLI support
 
 This project supports:
 
-* EmberCLI versions `>= 1.13.13`
+* EmberCLI versions `>= 1.13.13` using the classic (Broccoli-based) build
+* EmberCLI versions `>= 6.8` using the Vite-based build, with
+  `include_ember_script_tags` only
 
 ## Ruby and Rails support
 

data/app/helpers/ember_cli_rails_assets_helper.rb

@@ -1,3 +1,4 @@
+require "ember_cli/assets/errors"
 require "ember_cli/assets/lookup"
 require "ember_cli/assets/paths"
 
@@ -6,19 +7,36 @@ module EmberCliRailsAssetsHelper
     app = EmberCli[name]
     app.build
 
-    paths = EmberCli::Assets::Paths.new(app)
-
-    if paths.vite?
-      vite_ember_script_tags(paths, prepend)
+    if dev_server?(app)
+      dev_server_ember_script_tags(app)
     else
-      classic_ember_script_tags(app, prepend)
+      paths = EmberCli::Assets::Paths.new(app)
+
+      if paths.vite?
+        vite_ember_script_tags(paths, prepend)
+      else
+        classic_ember_script_tags(app, prepend)
+      end
     end
   end
 
   def include_ember_stylesheet_tags(name, prepend: "")
-    EmberCli[name].build
+    app = EmberCli[name]
+    app.build
+
+    paths = EmberCli::Assets::Paths.new(app)
 
-    assets = EmberCli::Assets::Lookup.new(EmberCli[name])
+    if dev_server?(app) || paths.vite?
+      raise EmberCli::Assets::NotSupportedError, <<~MSG
+        `include_ember_stylesheet_tags` does not support Vite-based
+        applications (`ember-cli >= 6.8`).
+
+        `include_ember_script_tags` already emits their stylesheet tags,
+        so remove this call.
+      MSG
+    end
+
+    assets = EmberCli::Assets::Lookup.new(app)
 
     assets.stylesheet_assets.
       map { |src| [prepend, src].join }.
@@ -28,6 +46,22 @@ module EmberCliRailsAssetsHelper
 
   private
 
+  # Whether ember-cli-rails serves the application from Vite's development
+  # server. Older ember-cli-rails releases have no development server, so
+  # feature-detect the reader.
+  def dev_server?(app)
+    app.respond_to?(:dev_server?) && app.dev_server?
+  end
+
+  # The application is served by Vite's development server, so read
+  # `index.html` from the server instead of a build directory, and rewrite
+  # its root-relative URLs to absolute URLs on the server — the same way
+  # ember-cli-rails serves the document itself. `app.build` has already
+  # booted the server.
+  def dev_server_ember_script_tags(app)
+    vite_startup_tags(app.dev_server.index_html, prefix: app.dev_server.origin)
+  end
+
   # Classic builds ship a fixed set of scripts (vendor and app) resolved
   # through the asset map, so emit a plain script tag per JavaScript asset
   # with `prepend` joined onto each path.
@@ -44,15 +78,24 @@ module EmberCliRailsAssetsHelper
   # the tags required for startup (including the config meta tag and
   # stylesheets) and remap root-absolute paths onto the mount point.
   def vite_ember_script_tags(paths, prepend)
-    document = Nokogiri::HTML5(paths.index_html.read)
-    prefix = prepend.to_s.chomp("/")
+    vite_startup_tags(paths.index_html.read, prefix: prepend.to_s.chomp("/"))
+  end
+
+  # Extracts the tags a Vite-based application needs to boot from an
+  # `index.html` document, with `prefix` joined onto every root-relative
+  # URL. Protocol-relative URLs (`//`) are left alone.
+  def vite_startup_tags(html, prefix:)
+    document = Nokogiri::HTML5(html)
 
     tags = document.css(
       'meta[name$="/config/environment"], link[rel="stylesheet"], link[rel="modulepreload"], script'
     ).map do |tag|
       %w(href src).each do |attribute|
         value = tag[attribute]
-        tag[attribute] = "#{prefix}#{value}" if value&.start_with?("/")
+
+        if value&.start_with?("/") && !value.start_with?("//")
+          tag[attribute] = "#{prefix}#{value}"
+        end
       end
       tag.to_html.html_safe
     end

data/lib/ember_cli/assets/errors.rb

@@ -1,5 +1,6 @@
 module EmberCli
   module Assets
     class BuildError < StandardError; end
+    class NotSupportedError < StandardError; end
   end
 end

data/lib/ember_cli/assets/version.rb

@@ -1,5 +1,5 @@
 module EmberCli
   module Assets
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ember-cli-rails-assets
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Sean Doyle