importmap-rails 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bec8044eff12e2d9ad0a16b077c6aca6c1fd365ebcb218815910c778407f7f91
-  data.tar.gz: c6b5ba9bb3b4e80762c1bdf49030d54504e6c865bab7dd8dda0e6df964ac3637
+  metadata.gz: 24bbd66810fcdeffe321841aa86a4308b0fa76749e9ec20105f8d74475634aa7
+  data.tar.gz: ea19b79e7701a7aafd6fe546edc88880aa5e68858999959d8e52005ce0be5a34
 SHA512:
-  metadata.gz: 1f76fcb0a38faba63a48c59c4735d3dc33cc6e24d30e55b689e33e2fb75285461bc7ec7c6684a4325666b3405956069a16c778ad09f26aa40b29d0e05b3fecf3
-  data.tar.gz: 878c7a4bf22f8b130aaa6cd2f14ef84db3cda9924278a825ff7be98e9c3f0c50aa44adf1d87c207dd51239782470a2ca05c9964c00ecd01e0730a3dff169c6f8
+  metadata.gz: 741aab3cb6747eba7daf39dd5d311c126dfccfb55132c68d1e1cdaafe2b84a9e2596ea4746446cf6f1702d851a109cae3413b97a233889cd8855e347098ee592
+  data.tar.gz: 3b9ed94a737134bbfcd8be54f95fa5094539b2b6d56b7365362bdf7ac961bb1e727cef396eca0001629d45e2c50578c3af819559a521829f41b4e875733d3e80

data/README.md

@@ -226,14 +226,16 @@ Import your module on the specific page. Note: you'll likely want to use a `cont
 
 ## Include a digest of the import map in your ETag
 
-If you're using [ETags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) generated by Rails helpers like `stale?` or `fresh_when`, you need to include the digest of the import map into this calculation. Otherwise your application will return [304](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304) cache responses even when your JavaScript assets have changed. You can avoid this with something like:
+If you're using [ETags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) generated by Rails helpers like `stale?` or `fresh_when`, you need to include the digest of the import map into this calculation. Otherwise your application will return [304](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304) cache responses even when your JavaScript assets have changed. You can avoid this using the `stale_when_importmap_changes` method:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
+  stale_when_importmap_changes
 end
 ```
 
+This will add the digest of the importmap to the etag calculation when the request format is HTML.
+
 
 ## Sweeping the cache in development and test
 

data/app/controllers/importmap/freshness.rb

@@ -0,0 +1,5 @@
+module Importmap::Freshness
+  def stale_when_importmap_changes
+    etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
+  end
+end

data/app/helpers/importmap/importmap_tags_helper.rb

@@ -3,7 +3,7 @@ module Importmap::ImportmapTagsHelper
   def javascript_importmap_tags(entry_point = "application", importmap: Rails.application.importmap)
     safe_join [
       javascript_inline_importmap_tag(importmap.to_json(resolver: self)),
-      javascript_importmap_module_preload_tags(importmap, entry_point: entry_point),
+      javascript_importmap_module_preload_tags(importmap, entry_point:),
       javascript_import_module_tag(entry_point)
     ], "\n"
   end
@@ -25,7 +25,7 @@ module Importmap::ImportmapTagsHelper
   # (defaults to Rails.application.importmap), such that they'll be fetched
   # in advance by browsers supporting this link type (https://caniuse.com/?search=modulepreload).
   def javascript_importmap_module_preload_tags(importmap = Rails.application.importmap, entry_point: "application")
-    javascript_module_preload_tag(*importmap.preloaded_module_paths(resolver: self, entry_point: entry_point, cache_key: entry_point))
+    javascript_module_preload_tag(*importmap.preloaded_module_paths(resolver: self, entry_point:, cache_key: entry_point))
   end
 
   # Link tag(s) for preloading the JavaScript module residing in `*paths`. Will return one link tag per path element.

data/lib/importmap/commands.rb

@@ -46,6 +46,24 @@ class Importmap::Commands < Thor
     end
   end
 
+  desc "pristine", "Redownload all pinned packages"
+  option :env, type: :string, aliases: :e, default: "production"
+  option :from, type: :string, aliases: :f, default: "jspm"
+  def pristine
+    packages = npm.packages_with_versions.map do |p, v|
+      v.blank? ? p : [p, v].join("@")
+    end
+
+    if imports = packager.import(*packages, env: options[:env], from: options[:from])
+      imports.each do |package, url|
+        puts %(Downloading "#{package}" to #{packager.vendor_path}/#{package}.js from #{url})
+        packager.download(package, url)
+      end
+    else
+      puts "Couldn't find any packages in #{packages.inspect} on #{options[:from]}"
+    end
+  end
+
   desc "json", "Show the full importmap in json"
   def json
     require Rails.root.join("config/environment")

data/lib/importmap/engine.rb

@@ -11,7 +11,7 @@ module Importmap
     config.importmap.cache_sweepers = []
     config.importmap.rescuable_asset_errors = []
 
-    config.autoload_once_paths = %W( #{root}/app/helpers )
+    config.autoload_once_paths = %W( #{root}/app/helpers #{root}/app/controllers )
 
     initializer "importmap" do |app|
       app.importmap = Importmap::Map.new
@@ -48,6 +48,12 @@ module Importmap
       end
     end
 
+    initializer "importmap.concerns" do
+      ActiveSupport.on_load(:action_controller_base) do
+        extend Importmap::Freshness
+      end
+    end
+
     initializer "importmap.helpers" do
       ActiveSupport.on_load(:action_controller_base) do
         helper Importmap::ImportmapTagsHelper

data/lib/importmap/map.rb

@@ -42,7 +42,7 @@ class Importmap::Map
   # the different cases.
   def preloaded_module_paths(resolver:, entry_point: "application", cache_key: :preloaded_module_paths)
     cache_as(cache_key) do
-      resolve_asset_paths(expanded_preloading_packages_and_directories(entry_point: entry_point), resolver: resolver).values
+      resolve_asset_paths(expanded_preloading_packages_and_directories(entry_point:), resolver:).values
     end
   end
 

data/lib/importmap/version.rb

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "2.0.3"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -61,6 +61,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/importmap/freshness.rb
 - app/helpers/importmap/importmap_tags_helper.rb
 - lib/importmap-rails.rb
 - lib/importmap/commands.rb
@@ -88,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Use ESM with importmap to manage modern JavaScript in Rails without transpiling