importmap-rails 0.5.3 → 0.6.3

data/app/helpers/importmap/importmap_tags_helper.rb

@@ -1,11 +1,11 @@
 module Importmap::ImportmapTagsHelper
   # Setup all script tags needed to use an importmap-powered entrypoint (which defaults to application.js)
-  def javascript_importmap_tags(entry_point = "application")
+  def javascript_importmap_tags(entry_point = "application", shim: true)
     safe_join [
       javascript_inline_importmap_tag,
       javascript_importmap_module_preload_tags,
-      javascript_importmap_shim_nonce_configuration_tag,
-      javascript_importmap_shim_tag,
+      (javascript_importmap_shim_nonce_configuration_tag if shim),
+      (javascript_importmap_shim_tag if shim),
       javascript_import_module_tag(entry_point)
     ].compact, "\n"
   end
@@ -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.3"
 end

data/lib/install/install.rb

@@ -14,8 +14,10 @@ create_file Rails.root.join("app/javascript/application.js") do <<-JS
 JS
 end
 
-say "Ensure JavaScript files are in the asset pipeline manifest"
-append_to_file Rails.root.join("app/assets/config/manifest.js"), %(//= link_tree ../../javascript .js\n)
+if (sprockets_manifest_path = Rails.root.join("app/assets/config/manifest.js")).exist?
+  say "Ensure JavaScript files are in the Sprocket manifest"
+  append_to_file sprockets_manifest_path, %(//= link_tree ../../javascript .js\n)
+end
 
 say "Configure importmap paths in config/importmap.rb"
 copy_file "#{__dir__}/config/importmap.rb", "config/importmap.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,7 +34,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/es-module-shims.js
-- app/assets/javascripts/es-module-shims@0.14.0.csp.js
 - app/helpers/importmap/importmap_tags_helper.rb
 - lib/importmap-rails.rb
 - lib/importmap/commands.rb