importmap-rails 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fd79cf4031e5503a22e3013a53a35fb7ae5c3e11b1ace5791dd36429a6e5237
-  data.tar.gz: 3f993fba70aa37b5f80c4133c3e1a8aa64fc1b3d29096cf2d1bff823e5c9add5
+  metadata.gz: 88dca9c2f87f4777a70f6d6e95bf7212c4f7392b04da6571f479c46b65805e28
+  data.tar.gz: c93c502ef9a4f739fe630bc24052ea4df3e17ce37ee5323a513ad5d302e0d7e1
 SHA512:
-  metadata.gz: cd7593f33ed2ff9c74b6c669f10a948cf2ee750ec136f269ff8d311c7851b7a3f2dbb81bb93c44ad505417a341c72169efdf6daf294f521a32179abdd4c2447f
-  data.tar.gz: 6e1f7fa74597f4407e03999433a20f1470fb2cb7cfa876b1d3e457cac14dffa08bdefe99110a42761ea736c13f356f50eeebfbaf5b4460d266fbd958ff99a837
+  metadata.gz: e058a2747e3a884535312eed0f21235d6ac98c5e7d8ba2c8cf702f52952b634cca93ec8c66f102168d60d696ab160d3ff9b08945f0419de627e58ae8a5f64633
+  data.tar.gz: bda6354071b0610aba6e1f7347b533d26a3a624b87038c19b0c8404ec347a37b7e1cffe41b36c4bedd4aa058f4981e359093982ea97b099cb8a1f9c57fd0657c

data/README.md

@@ -1,6 +1,6 @@
 # Importmap for Rails
 
-[Import maps](https://github.com/WICG/import-maps) let you import JavaScript modules using logical names that map to versioned/digested files – directly from the browser. So you can [build modern JavaScript applications using JavaScript libraries made for ESM without the need for transpiling or bundling](https://world.hey.com/dhh/modern-web-apps-without-javascript-bundling-or-transpiling-a20f2755).This frees you from needing Webpack, Yarn, npm, or any other part of the JavaScript toolchain. All you need is the asset pipeline that's already included in Rails.
+[Import maps](https://github.com/WICG/import-maps) let you import JavaScript modules using logical names that map to versioned/digested files – directly from the browser. So you can [build modern JavaScript applications using JavaScript libraries made for ES modules (ESM) without the need for transpiling or bundling](https://world.hey.com/dhh/modern-web-apps-without-javascript-bundling-or-transpiling-a20f2755). This frees you from needing Webpack, Yarn, npm, or any other part of the JavaScript toolchain. All you need is the asset pipeline that's already included in Rails.
 
 With this approach you'll ship many small JavaScript files instead of one big JavaScript file. Thanks to HTTP/2 that no longer carries a material performance penalty during the initial transport, and in fact offers substantial benefits over the long run due to better caching dynamics. Whereas before any change to any JavaScript file included in your big bundle would invalidate the cache for the the whole bundle, now only the cache for that single file is invalidated.
 
@@ -42,7 +42,7 @@ to 1 of the 3 viable ways of loading ES Module javascript packages.
 For example:
 
 ```rb
-# config/importmaps.rb
+# config/importmap.rb
 pin "react", to: "https://ga.jspm.io/npm:react@17.0.2/index.js"
 ```
 

data/lib/importmap/map.rb

@@ -32,14 +32,23 @@ class Importmap::Map
     @directories[dir] = MappedDir.new(dir: dir, under: under, path: to, preload: preload)
   end
 
-  def preloaded_module_paths(resolver:)
-    cache_as(:preloaded_module_paths) do
+  # Returns an array of all the resolved module paths of the pinned packages. The `resolver` must respond to `asset_path`,
+  # such as `ActionController::Base.helpers` or `ApplicationController.helpers`. You'll want to use the 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)
+    cache_as(cache_key) do
       resolve_asset_paths(expanded_preloading_packages_and_directories, resolver: resolver).values
     end
   end
 
-  def to_json(resolver:)
-    cache_as(:json) do
+  # Returns a JSON hash (as a string) of all the resolved module paths of the pinned packages in the import map format.
+  # The `resolver` must respond to `asset_path`, such as `ActionController::Base.helpers` or `ApplicationController.helpers`.
+  # You'll want to use the 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 to_json(resolver:, cache_key: :json)
+    cache_as(cache_key) do
       JSON.pretty_generate({ "imports" => resolve_asset_paths(expanded_packages_and_directories, resolver: resolver) })
     end
   end
@@ -78,13 +87,21 @@ class Importmap::Map
       if result = instance_variable_get("@cached_#{name}")
         result
       else
+        remember_cache_key(name)
         instance_variable_set("@cached_#{name}", yield)
       end
     end
 
+    def remember_cache_key(name)
+      @cache_keys ||= Set.new
+      @cache_keys.add name
+    end
+
+
     def clear_cache
-      @cached_json = nil
-      @cached_preloaded_module_paths = nil
+      @cache_keys&.each do |name|
+        instance_variable_set("@cached_#{name}", nil)
+      end
     end
 
     def rescuable_asset_error?(error)

data/lib/importmap/version.rb

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties