importmap-rails 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c7d66e249679156d7602787f9edd58abbabee35a8e8b75ee88b87cd729ac3b
-  data.tar.gz: a1af718e58dc8d15865c7e6ebd1c0f0508b237a6fbd83db710c5fb38c869cbb8
+  metadata.gz: 446689178bd41da319ca7d85a90090d8aaaebcda8ba79fb8216fc42a1948af4b
+  data.tar.gz: d856a84a0acf723fe91b75ccb4e3f67727a5e1f64bde871a8604a79892cdc79c
 SHA512:
-  metadata.gz: db464f8246d2b23941b7841224e857f134c23fe7da5a5750005f17a32bf345e0d0355ef8a849ca3570c38ab213cc3ed31e9a42f9eabd0ce1bb585d0636b340ec
-  data.tar.gz: 5992e6f9db39cf53ba3ae0078db871fab936de376655717d7acdd74419ae230ab360a9765890e9adf15f21d560016c617989d777fe1f6be4f537241ebd17b6a9
+  metadata.gz: cf025187c8d441b30e2c2d685c114063ef768132952a42038e94d99d42016af8e094586fe5939840cb42c99b449e91070c1b6666e0ed9d3167123a80a097c51c
+  data.tar.gz: 1594f8e3c0bb824fbfd33bb04688a101330af87c91ad2bf3df3fd4531f0821d3b2f457e53a63ff03544307e0bd7199e2208718dda712ff50db1a5350535d4f60

data/README.md

@@ -168,11 +168,6 @@ And pinning JavaScript modules from the engine:
 pin_all_from File.expand_path("../app/assets/javascripts", __dir__)
 ```
 
-## Caching the import map and preload modules
-
-The import map should be cached in production, and is so by default via the `config.importmap.cached` option that will be set to the same value as `config.action_controller.perform_caching`, unless explicitly set differently.
-
-
 ## Expected errors from using the es-module-shim
 
 While import maps are native in Chrome and Edge, they need a shim in other browsers that'll produce a JavaScript console error like `TypeError: Module specifier, 'application' does not start with "/", "./", or "../".`. This error is normal and does not have any user-facing consequences.

data/app/helpers/importmap/importmap_tags_helper.rb

@@ -20,13 +20,15 @@ module Importmap::ImportmapTagsHelper
   # Configure es-modules-shim with nonce support if the application is using a content security policy.
   def javascript_importmap_shim_nonce_configuration_tag
     if content_security_policy?
-      tag.script({ nonce: content_security_policy_nonce }.to_json.html_safe, type: "esms-options")
+      tag.script({ nonce: content_security_policy_nonce }.to_json.html_safe, 
+        type: "esms-options", nonce: content_security_policy_nonce)
     end
   end
 
   # Include the es-modules-shim needed to make importmaps work in browsers without native support (like Firefox + Safari).
   def javascript_importmap_shim_tag
-    javascript_include_tag "es-module-shims", async: true, "data-turbo-track": "reload"
+    javascript_include_tag "es-module-shims", async: true, "data-turbo-track": "reload",
+      nonce: content_security_policy_nonce
   end
 
   # Import a named JavaScript module(s) using a script-module tag.
@@ -45,6 +47,8 @@ module Importmap::ImportmapTagsHelper
 
   # Link tag(s) for preloading the JavaScript module residing in `*paths`. Will return one link tag per path element.
   def javascript_module_preload_tag(*paths)
-    safe_join(Array(paths).collect { |path| tag.link rel: "modulepreload", href: path }, "\n")
+    safe_join(Array(paths).collect { |path|
+      tag.link rel: "modulepreload", href: path, nonce: content_security_policy_nonce
+    }, "\n")
   end
 end

data/lib/importmap/engine.rb

@@ -27,11 +27,5 @@ module Importmap
         helper Importmap::ImportmapTagsHelper
       end
     end
-
-    initializer "importmap.caching" do |app|
-      if Rails.application.config.importmap.cached.nil?
-        Rails.application.config.importmap.cached = app.config.action_controller.perform_caching
-      end
-    end
   end
 end

data/lib/importmap/map.rb

@@ -2,7 +2,6 @@ require "pathname"
 
 class Importmap::Map
   attr_reader :packages, :directories
-  attr_accessor :cached
 
   def initialize
     @packages, @directories = {}, {}
@@ -24,10 +23,12 @@ class Importmap::Map
   end
 
   def pin(name, to: nil, preload: true)
+    clear_cache
     @packages[name] = MappedFile.new(name: name, path: to || "#{name}.js", preload: preload)
   end
 
   def pin_all_from(dir, under: nil, to: nil, preload: true)
+    clear_cache
     @directories[dir] = MappedDir.new(dir: dir, under: under, path: to, preload: preload)
   end
 
@@ -43,18 +44,35 @@ class Importmap::Map
     end
   end
 
+  # Returns a SHA1 digest of the import map json that can be used as a part of a page etag to
+  # ensure that a html cache is invalidated when the import map is changed.
+  #
+  # Example:
+  #
+  #   class ApplicationController < ActionController::Base
+  #     etag { Rails.application.config.importmap.digest(resolver: helpers) if request.format&.html? }
+  #   end
+  def digest(resolver:)
+    Digest::SHA1.hexdigest(to_json(resolver: resolver).to_s)
+  end
+
   private
     MappedDir  = Struct.new(:dir, :path, :under, :preload, keyword_init: true)
     MappedFile = Struct.new(:name, :path, :preload, keyword_init: true)
 
     def cache_as(name)
-      if (cached && result = instance_variable_get("@cached_#{name}"))
+      if result = instance_variable_get("@cached_#{name}")
         result
       else
         instance_variable_set("@cached_#{name}", yield)
       end
     end
 
+    def clear_cache
+      @cached_json = nil
+      @cached_preloaded_module_paths = nil
+    end
+
     def resolve_asset_paths(paths, resolver:)
       paths.transform_values do |mapping|
         begin

data/lib/importmap/version.rb

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails