importmap-rails 0.6.0 → 0.7.0

data/app/helpers/importmap/importmap_tags_helper.rb

@@ -1,18 +1,18 @@
 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
 
   # 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

@@ -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

@@ -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

@@ -1,4 +1,5 @@
 require "pathname"
+require "active_support/evented_file_update_checker"
 
 class Importmap::Map
   attr_reader :packages, :directories
@@ -50,12 +51,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 =
+        ActiveSupport::EventedFileUpdateChecker.new([], Array(watches).collect { |dir| [ dir, "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

@@ -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

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 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"

data/lib/tasks/importmap_tasks.rake

@@ -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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-09-20 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