RubyGems - importmap-rails - Versions diffs - 0.6.3 → 0.7.3 - Mend

importmap-rails 0.6.3 → 0.7.3

Files changed (11) hide show

checksums.yaml +4 -4
data/README.md +12 -4
data/app/assets/javascripts/es-module-shims.js +9 -21
data/app/helpers/importmap/importmap_tags_helper.rb +4 -4
data/lib/importmap/commands.rb +1 -1
data/lib/importmap/engine.rb +20 -1
data/lib/importmap/map.rb +15 -1
data/lib/importmap/reloader.rb +1 -1
data/lib/importmap/version.rb +1 -1
data/lib/tasks/importmap_tasks.rake +1 -1
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83ed6ee74e2b39acc314afedb47331aa6499f73cefd377813d35042c5edef99
-  data.tar.gz: 2892356151da356c2ca221d9cdb34742c7f258641481079f32c7e3a65b92155b
+  metadata.gz: a6bef1930a7817f62361604877196991706c6dd6ac589d41fb615bb3cd21cdb6
+  data.tar.gz: 7cd5da364f95e8ea04104e57d22c42e9fe1351451a51d22fa1247456dda6fa10
 SHA512:
-  metadata.gz: a31bde4420db119b939f660310262b2ce56bf9dc2dba8c6a255c565ce99d127361584917e378445b6a500675295a502912e49e772aec37a95d32b1d51d9def85
-  data.tar.gz: 79dbc56c9c96dd85ef65d9d0cca3baee1c1e0c8e80e25f99b3823dd1828a20297261ea7fb21f13c7dea980c13358c9872cb09b2217704c293f260b17d11a510f
+  metadata.gz: e3e7e6e12f99afc8d69756142f5c1fa8945d541489d5950cdf36adeb8b7f6dcf5c8b7924b64b8a4d003bcef16bf2522fb435da54b3c74afdd4d2db88c838c54e
+  data.tar.gz: b8c8b2ab0472abb4c7eac50ad4c2a858d4210939438e095b367608323ae72b08e514075e12846282020ae98f1664d61e2e826c214441d442cecfda9b6c10b765

data/README.md CHANGED Viewed

@@ -20,7 +20,7 @@ Note: In order to use JavaScript from Rails frameworks like Action Cable, Action
 ## Usage
-The import map is setup through `Rails.application.config.importmap` via the configuration in `config/importmap.rb`. This file is automatically reloaded in development upon changes, but note that you must restart the server if you remove pins and need them gone from the rendered importmap or list of preloads.
+The import map is setup through `Rails.application.importmap` via the configuration in `config/importmap.rb`. This file is automatically reloaded in development upon changes, but note that you must restart the server if you remove pins and need them gone from the rendered importmap or list of preloads.
 This import map is inlined in the `<head>` of your application layout using `<%= javascript_importmap_tags %>`, which will setup the JSON configuration inside a `<script type="importmap">` tag. After that, the [es-module-shim](https://github.com/guybedford/es-module-shims) is loaded, and then finally the application entrypoint is imported via `<script type="module">import "application"</script>`. That logical entrypoint, `application`, is mapped in the importmap script tag to the file `app/javascript/application.js`.
@@ -143,9 +143,9 @@ pin "md5", to: "https://cdn.jsdelivr.net/npm/md5@2.3.0/md5.js", preload: false
 ## 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.config.importmap`.
+By default, Rails loads import map definition from the application's `config/importmap.rb` to the `Importmap::Map` object available at `Rails.application.importmap`.
-You can combine multiple import maps by drawing their definitions onto the `Rails.application.config.importmap`. For example, appending import maps defined in Rails engines:
+You can combine multiple import maps by drawing their definitions onto the `Rails.application.importmap`. For example, appending import maps defined in Rails engines:
 ```ruby
 # my_engine/lib/my_engine/engine.rb
@@ -175,10 +175,16 @@ If you're using etags generated by Rails helpers like `stale?` or `fresh_when`,
 ```ruby
 class ApplicationController < ActionController::Base
-  etag { Rails.application.config.importmap.digest(resolver: helpers) if request.format&.html? }
+  etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
 end
 ```
+## Sweeping the cache in development and test
+Generating the import map json and modulepreloads may require resolving hundreds of assets. This can take a while, so these operations are cached, but in development and test, we watch for changes to both `config/importmap.rb` and files in `app/javascript` to clear this cache. This feature can be controlled in an environment configuration file via the boolean `config.importmap.sweep_cache`. If you're pinning local files from outside of `app/javascript`, you'll need to restart your development server upon changes.
 ## 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.
@@ -188,10 +194,12 @@ While import maps are native in Chrome and Edge, they need a shim in other brows
 Under certain circumstances, like running system tests using chromedriver under CI (which may be resource constrained and trigger errors in certain cases), you may want to explicitly turn off including the shim. If can do this by calling the bulk tag helper with `javascript_importmap_tags("application", shim: false)`. Thus you can pass in something like `shim: !ENV["CI"]`. If you want, and are sure you're not doing any full-page caching, you can also connect this directive to a user agent check (using a gem like `useragent`) to check whether the browser is chrome/edge 89+. But you really shouldn't have to, as the shim is designed to gracefully work with natively compatible drivers.
 ## A note about browser extensions
 Certain extensions that also load Javascript modules may block import maps from being loaded (for instance, the Apollo Client Devtools extension). If you see a console message like `An import map is added after module script load was triggered`, browser extensions are likely the culprit.
 ## License
 Importmap for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/javascripts/es-module-shims.js CHANGED Viewed

@@ -1,8 +1,6 @@
-/* ES Module Shims CSP 0.15.1 */
+/* ES Module Shims 1.0.0 */
 (function () {
-  Promise.resolve();
   const edge = navigator.userAgent.match(/Edge\/\d\d\.\d+$/);
   let baseUrl;
@@ -331,7 +329,7 @@
   let importMap = { imports: {}, scopes: {} };
   let importMapSrcOrLazy = false;
-  let importMapPromise = featureDetectionPromise;
+  let importMapPromise = featureDetectionPromise.then(() => undefined);
   let acceptingImportMaps = true;
   let nativeAcceptingImportMaps = true;
@@ -346,21 +344,20 @@
     }
     await importMapPromise;
     // early analysis opt-out - no need to even fetch if we have feature support
-    if (!shimMode && supportsDynamicImport && supportsImportMeta && supportsImportMaps && (!jsonModulesEnabled || supportsJsonAssertions) && (!cssModulesEnabled || supportsCssAssertions) && !importMapSrcOrLazy) {
+    if (!shimMode && supportsDynamicImport && supportsImportMeta && supportsImportMaps && (!jsonModulesEnabled || supportsJsonAssertions) && (!cssModulesEnabled || supportsCssAssertions) && !importMapSrcOrLazy && !false) {
       // for polyfill case, only dynamic import needs a return value here, and dynamic import will never pass nativelyLoaded
       if (nativelyLoaded)
         return null;
       await lastStaticLoadPromise;
       return dynamicImport(source ? createBlob(source) : url, { errUrl: url || source });
     }
-    await undefined;
     const load = getOrCreateLoad(url, fetchOpts, source);
     const seen = {};
     await loadAll(load, seen);
     lastLoad = undefined;
     resolveDeps(load, seen);
     await lastStaticLoadPromise;
-    if (source && !shimMode && !load.n) {
+    if (source && !shimMode && !load.n && !false) {
       const module = await dynamicImport(createBlob(source), { errUrl: source });
       if (revokeBlobURLs) revokeObjectURLs(Object.keys(seen));
       return module;
@@ -490,17 +487,11 @@
       resolvedSource += source.slice(lastIndex);
     }
-    resolvedSource = resolvedSource.replace(/\/\/# sourceMappingURL=(.*)\s*$/, (match, url) => {
-      return match.replace(url, new URL(url, load.r));
-    });
+    resolvedSource = resolvedSource.replace(/\/\/# sourceMappingURL=(.*)\s*$/, (match, url) => match.replace(url, () => new URL(url, load.r)));
     let hasSourceURL = false;
-    resolvedSource = resolvedSource.replace(/\/\/# sourceURL=(.*)\s*$/, (match, url) => {
-      hasSourceURL = true;
-      return match.replace(url, new URL(url, load.r));
-    });
-    if (!hasSourceURL) {
+    resolvedSource = resolvedSource.replace(/\/\/# sourceURL=(.*)\s*$/, (match, url) => (hasSourceURL = true, match.replace(url, () => new URL(url, load.r))));
+    if (!hasSourceURL)
       resolvedSource += '\n//# sourceURL=' + load.r;
-    }
     load.b = lastLoad = createBlob(resolvedSource);
     load.S = undefined;
@@ -627,13 +618,10 @@
     return load;
   }
-  const scriptQuery = 'script[type="module-shim"],script[type="importmap-shim"],script[type="module"],script[type="importmap"]';
-  const preloadQuery = 'link[rel="modulepreload"]';
   function processScripts () {
-    for (const link of document.querySelectorAll(preloadQuery))
+    for (const link of document.querySelectorAll('link[rel="modulepreload"]'))
       processPreload(link);
-    const scripts = document.querySelectorAll(scriptQuery);
+    const scripts = document.querySelectorAll('script[type="module-shim"],script[type="importmap-shim"],script[type="module"],script[type="importmap"]');
     // early shim mode opt-in
     if (!shimMode) {
       for (const script of scripts) {

data/app/helpers/importmap/importmap_tags_helper.rb CHANGED Viewed

@@ -11,8 +11,8 @@ module Importmap::ImportmapTagsHelper
   end
   # Generate an inline importmap tag using the passed `importmap_json` JSON string.
-  # By default, `Rails.application.config.importmap.to_json(resolver: self)` is used.
-  def javascript_inline_importmap_tag(importmap_json = Rails.application.config.importmap.to_json(resolver: self))
+  # By default, `Rails.application.importmap.to_json(resolver: self)` is used.
+  def javascript_inline_importmap_tag(importmap_json = Rails.application.importmap.to_json(resolver: self))
     tag.script importmap_json.html_safe,
       type: "importmap", "data-turbo-track": "reload", nonce: content_security_policy_nonce
   end
@@ -39,9 +39,9 @@ module Importmap::ImportmapTagsHelper
   end
   # Link tags for preloading all modules marked as preload: true in the `importmap`
-  # (defaults to Rails.application.config.importmap), such that they'll be fetched
+  # (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.config.importmap)
+  def javascript_importmap_module_preload_tags(importmap = Rails.application.importmap)
     javascript_module_preload_tag(*importmap.preloaded_module_paths(resolver: self))
   end

data/lib/importmap/commands.rb CHANGED Viewed

@@ -43,7 +43,7 @@ class Importmap::Commands < Thor
   desc "json", "Show the full importmap in json"
   def json
-    puts Rails.application.config.importmap.to_json(resolver: ActionController::Base.helpers)
+    puts Rails.application.importmap.to_json(resolver: ActionController::Base.helpers)
   end
   private

data/lib/importmap/engine.rb CHANGED Viewed

@@ -1,10 +1,19 @@
 require "importmap/map"
+# Use Rails.application.importmap to access the map
+Rails::Application.send(:attr_accessor, :importmap)
 module Importmap
   class Engine < ::Rails::Engine
-    config.importmap = Importmap::Map.new.draw("config/importmap.rb")
+    config.importmap = ActiveSupport::OrderedOptions.new
+    config.importmap.sweep_cache = Rails.env.development? || Rails.env.test?
     config.autoload_once_paths = %W( #{root}/app/helpers )
+    initializer "importmap" do |app|
+      app.importmap = Importmap::Map.new.draw("config/importmap.rb")
+    end
     initializer "importmap.reloader" do |app|
       app.config.paths.add "config/importmap.rb"
@@ -15,6 +24,16 @@ module Importmap
       end
     end
+    initializer "importmap.cache_sweeper" do |app|
+      if app.config.importmap.sweep_cache
+        app.importmap.cache_sweeper watches: app.root.join("app/javascript")
+        ActiveSupport.on_load(:action_controller_base) do
+          before_action { Rails.application.importmap.cache_sweeper.execute_if_updated }
+        end
+      end
+    end
     initializer "importmap.assets" do
       if Rails.application.config.respond_to?(:assets)
         Rails.application.config.assets.precompile += %w( es-module-shims.js )

data/lib/importmap/map.rb CHANGED Viewed

@@ -50,12 +50,26 @@ class Importmap::Map
   # Example:
   #
   #   class ApplicationController < ActionController::Base
-  #     etag { Rails.application.config.importmap.digest(resolver: helpers) if request.format&.html? }
+  #     etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? }
   #   end
   def digest(resolver:)
     Digest::SHA1.hexdigest(to_json(resolver: resolver).to_s)
   end
+  # Returns an instance ActiveSupport::EventedFileUpdateChecker configured to clear the cache of the map
+  # when the directories passed on initialization via `watches:` have changes. This is used in development
+  # and test to ensure the map caches are reset when javascript files are changed.
+  def cache_sweeper(watches: nil)
+    if watches
+      @cache_sweeper =
+        Rails.application.config.file_watcher.new([], Array(watches).collect { |dir| [ dir.to_s, "js"] }.to_h) do
+          clear_cache
+        end
+    else
+      @cache_sweeper
+    end
+  end
   private
     MappedDir  = Struct.new(:dir, :path, :under, :preload, keyword_init: true)
     MappedFile = Struct.new(:name, :path, :preload, keyword_init: true)

data/lib/importmap/reloader.rb CHANGED Viewed

@@ -2,7 +2,7 @@ class Importmap::Reloader
   delegate :execute_if_updated, :execute, :updated?, to: :updater
   def reload!
-    import_map_paths.each { |path| config.importmap.draw(path) }
+    import_map_paths.each { |path| Rails.application.importmap.draw(path) }
   end
   private

data/lib/importmap/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.6.3"
+  VERSION = "0.7.3"
 end

data/lib/tasks/importmap_tasks.rake CHANGED Viewed

@@ -7,6 +7,6 @@ namespace :importmap do
   desc "Show the importmap"
   task :pins do
     require Rails.root.join("config/environment")
-    puts Rails.application.config.importmap.to_json(resolver: ActionController::Base.helpers)
+    puts Rails.application.importmap.to_json(resolver: ActionController::Base.helpers)
   end
 end

metadata CHANGED Viewed

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