importmap-rails 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1409421a79c426cb82404b0c910dedb0c5ec2dc733304e5f907f92067cfb208
-  data.tar.gz: 138353eac33ffcbbe8a80ce4a8202485792e4609122409478bc5dc9fa324650d
+  metadata.gz: 24bbd66810fcdeffe321841aa86a4308b0fa76749e9ec20105f8d74475634aa7
+  data.tar.gz: ea19b79e7701a7aafd6fe546edc88880aa5e68858999959d8e52005ce0be5a34
 SHA512:
-  metadata.gz: 3f248fc4722407b75d81d533c52b368a8a12fceaf10ba9cd7d103c10a103d0722013910eaecdc824cd5076a0fd073fefa6c08020bd97a5a5d9948fb696091416
-  data.tar.gz: 56ca2998ed2b6e73b50d691da2894593dbf31f2092cc16db5c26cb7aea46ebb71995660ee75945daaf5a32e355fe953d3d141b4612ab87e56744ce70e4cbcc65
+  metadata.gz: 741aab3cb6747eba7daf39dd5d311c126dfccfb55132c68d1e1cdaafe2b84a9e2596ea4746446cf6f1702d851a109cae3413b97a233889cd8855e347098ee592
+  data.tar.gz: 3b9ed94a737134bbfcd8be54f95fa5094539b2b6d56b7365362bdf7ac961bb1e727cef396eca0001629d45e2c50578c3af819559a521829f41b4e875733d3e80

data/README.md

@@ -141,6 +141,25 @@ pin "md5", preload: false # file lives in vendor/javascript/md5.js
 ...
 ```
 
+You can also specify which entry points to preload a particular dependency in by providing `preload:` a string or array of strings.
+
+Example:
+
+```ruby
+# config/importmap.rb
+pin "@github/hotkey", to: "@github--hotkey.js", preload: 'application'
+pin "md5", preload: ['application', 'alternate']
+
+# app/views/layouts/application.html.erb
+<%= javascript_importmap_tags 'alternate' %>
+
+# will include the following link before the importmap is setup:
+<link rel="modulepreload" href="/assets/javascript/md5.js">
+...
+```
+
+
+
 ## Composing import maps
 
 By default, Rails loads import map definition from the application's `config/importmap.rb` to the `Importmap::Map` object available at `Rails.application.importmap`.
@@ -207,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 302 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
 
@@ -242,6 +263,15 @@ Importmap for Rails provides two commands to check your pinned packages:
 - `./bin/importmap outdated` checks the NPM registry for new versions
 - `./bin/importmap audit` checks the NPM registry for known security issues
 
+## Supporting legacy browsers such as Safari on iOS 15
+
+If you want to support [legacy browsers that do not support import maps](https://caniuse.com/import-maps) such as [iOS 15.8.1 released on 22 Jan 2024](https://support.apple.com/en-us/HT201222), insert [`es-module-shims`](https://github.com/guybedford/es-module-shims) before `javascript_importmap_tags` as below.
+
+```erb
+<script async src="https://ga.jspm.io/npm:es-module-shims@1.8.2/dist/es-module-shims.js" data-turbo-track="reload"></script>
+<%= javascript_importmap_tags %>
+```
+
 ## License
 
 Importmap for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

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),
+      javascript_importmap_module_preload_tags(importmap, entry_point:),
       javascript_import_module_tag(entry_point)
     ], "\n"
   end
@@ -24,8 +24,8 @@ module Importmap::ImportmapTagsHelper
   # Link tags for preloading all modules marked as preload: true in the `importmap`
   # (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)
-    javascript_module_preload_tag(*importmap.preloaded_module_paths(resolver: self))
+  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:, 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")
@@ -92,7 +110,7 @@ class Importmap::Commands < Thor
   desc "update", "Update outdated package pins"
   def update
     if (outdated_packages = npm.outdated_packages).any?
-      pin outdated_packages.map(&:name)
+      pin(*outdated_packages.map(&:name))
     else
       puts "No outdated packages found"
     end

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

@@ -40,9 +40,9 @@ class Importmap::Map
   # resolver that has been configured for the `asset_host` you want these resolved paths to use. In case you need to
   # resolve for different asset hosts, you can pass in a custom `cache_key` to vary the cache used by this method for
   # the different cases.
-  def preloaded_module_paths(resolver:, cache_key: :preloaded_module_paths)
+  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, resolver: resolver).values
+      resolve_asset_paths(expanded_preloading_packages_and_directories(entry_point:), resolver:).values
     end
   end
 
@@ -118,8 +118,8 @@ class Importmap::Map
       end.compact
     end
 
-    def expanded_preloading_packages_and_directories
-      expanded_packages_and_directories.select { |name, mapping| mapping.preload }
+    def expanded_preloading_packages_and_directories(entry_point:)
+      expanded_packages_and_directories.select { |name, mapping| mapping.preload.in?([true, false]) ? mapping.preload : (Array(mapping.preload) & Array(entry_point)).any? }
     end
 
     def expanded_packages_and_directories
@@ -141,7 +141,17 @@ class Importmap::Map
     end
 
     def module_name_from(filename, mapping)
-      [ mapping.under, filename.to_s.remove(filename.extname).remove(/\/?index$/).presence ].compact.join("/")
+      # Regex explanation:
+      # (?:\/|^) # Matches either / OR the start of the string
+      # index   # Matches the word index
+      # $       # Matches the end of the string
+      #
+      # Sample matches
+      # index
+      # folder/index
+      index_regex = /(?:\/|^)index$/
+
+      [ mapping.under, filename.to_s.remove(filename.extname).remove(index_regex).presence ].compact.join("/")
     end
 
     def module_path_from(filename, mapping)

data/lib/importmap/npm.rb

@@ -86,7 +86,7 @@ class Importmap::Npm
     end
 
     def find_latest_version(response)
-      latest_version = response.dig('dist-tags', 'latest')
+      latest_version = response.is_a?(String) ? response : response.dig('dist-tags', 'latest')
       return latest_version if latest_version
 
       return unless response['versions']

data/lib/importmap/packager.rb

@@ -19,10 +19,10 @@ class Importmap::Packager
 
   def import(*packages, env: "production", from: "jspm")
     response = post_json({
-      "install"      => Array(packages), 
+      "install"      => Array(packages),
       "flattenScope" => true,
       "env"          => [ "browser", "module", env ],
-      "provider"     => from.to_s,
+      "provider"     => normalize_provider(from)
     })
 
     case response.code
@@ -69,6 +69,10 @@ class Importmap::Packager
       raise HTTPError, "Unexpected transport error (#{error.class}: #{error.message})"
     end
 
+    def normalize_provider(name)
+      name.to_s == "jspm" ? "jspm.io" : name.to_s
+    end
+
     def extract_parsed_imports(response)
       JSON.parse(response.body).dig("map", "imports")
     end
@@ -80,7 +84,7 @@ class Importmap::Packager
         raise HTTPError, "Unexpected response code (#{response.code})"
       end
     end
-  
+
     def parse_service_error(response)
       JSON.parse(response.body.to_s)["error"]
     rescue JSON::ParserError
@@ -113,14 +117,16 @@ class Importmap::Packager
       response = Net::HTTP.get_response(URI(url))
 
       if response.code == "200"
-        save_vendored_package(package, response.body)
+        save_vendored_package(package, url, response.body)
       else
         handle_failure_response(response)
       end
     end
 
-    def save_vendored_package(package, source)
+    def save_vendored_package(package, url, source)
       File.open(vendored_package_path(package), "w+") do |vendored_package|
+        vendored_package.write "// #{package}#{extract_package_version_from(url)} downloaded from #{url}\n\n"
+
         vendored_package.write remove_sourcemap_comment_from(source).force_encoding("UTF-8")
       end
     end

data/lib/importmap/version.rb

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

data/lib/tasks/importmap_tasks.rake

@@ -1,6 +1,9 @@
 namespace :importmap do
   desc "Setup Importmap for the app"
   task :install do
-    system RbConfig.ruby, "./bin/rails", "app:template", "LOCATION=#{File.expand_path("../install/install.rb", __dir__)}"
+    previous_location = ENV["LOCATION"]
+    ENV["LOCATION"] = File.expand_path("../install/install.rb", __dir__)
+    Rake::Task["app:template"].invoke
+    ENV["LOCATION"] = previous_location
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-03 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.4.14
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Use ESM with importmap to manage modern JavaScript in Rails without transpiling