class Importmap::Map
Constants
- MappedDir
- MappedFile
Attributes
directories[R]
packages[R]
Public Class Methods
new()
click to toggle source
# File lib/importmap/map.rb, line 6 def initialize @packages, @directories = {}, {} end
Public Instance Methods
cache_sweeper(watches: nil)
click to toggle source
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.
# File lib/importmap/map.rb, line 62 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
digest(resolver:)
click to toggle source
Returns a SHA1 digest of the import map json that can be used as a part of a page etag to ensure that a html cache is invalidated when the import map is changed.
Example:
class ApplicationController < ActionController::Base etag { Rails.application.importmap.digest(resolver: helpers) if request.format&.html? } end
# File lib/importmap/map.rb, line 55 def digest(resolver:) Digest::SHA1.hexdigest(to_json(resolver: resolver).to_s) end
draw(path = nil, &block)
click to toggle source
# File lib/importmap/map.rb, line 10 def draw(path = nil, &block) if path && File.exist?(path) begin instance_eval(File.read(path), path.to_s) rescue Exception => e Rails.logger.error "Unable to parse import map from #{path}: #{e.message}" raise "Unable to parse import map from #{path}: #{e.message}" end elsif block_given? instance_eval(&block) end self end
pin(name, to: nil, preload: false)
click to toggle source
# File lib/importmap/map.rb, line 25 def pin(name, to: nil, preload: false) clear_cache @packages[name] = MappedFile.new(name: name, path: to || "#{name}.js", preload: preload) end
pin_all_from(dir, under: nil, to: nil, preload: false)
click to toggle source
# File lib/importmap/map.rb, line 30 def pin_all_from(dir, under: nil, to: nil, preload: false) clear_cache @directories[dir] = MappedDir.new(dir: dir, under: under, path: to, preload: preload) end
preloaded_module_paths(resolver:)
click to toggle source
# File lib/importmap/map.rb, line 35 def preloaded_module_paths(resolver:) cache_as(:preloaded_module_paths) do resolve_asset_paths(expanded_preloading_packages_and_directories, resolver: resolver).values end end
to_json(resolver:)
click to toggle source
# File lib/importmap/map.rb, line 41 def to_json(resolver:) cache_as(:json) do JSON.pretty_generate({ "imports" => resolve_asset_paths(expanded_packages_and_directories, resolver: resolver) }) end end
Private Instance Methods
absolute_root_of(path)
click to toggle source
# File lib/importmap/map.rb, line 143 def absolute_root_of(path) (pathname = Pathname.new(path)).absolute? ? pathname : Rails.root.join(path) end
cache_as(name) { || ... }
click to toggle source
# File lib/importmap/map.rb, line 77 def cache_as(name) if result = instance_variable_get("@cached_#{name}") result else instance_variable_set("@cached_#{name}", yield) end end
clear_cache()
click to toggle source
# File lib/importmap/map.rb, line 85 def clear_cache @cached_json = nil @cached_preloaded_module_paths = nil end
expand_directories_into(paths)
click to toggle source
# File lib/importmap/map.rb, line 117 def expand_directories_into(paths) @directories.values.each do |mapping| if (absolute_path = absolute_root_of(mapping.dir)).exist? find_javascript_files_in_tree(absolute_path).each do |filename| module_filename = filename.relative_path_from(absolute_path) module_name = module_name_from(module_filename, mapping) module_path = module_path_from(module_filename, mapping) paths[module_name] = MappedFile.new(name: module_name, path: module_path, preload: mapping.preload) end end end end
expanded_packages_and_directories()
click to toggle source
# File lib/importmap/map.rb, line 113 def expanded_packages_and_directories @packages.dup.tap { |expanded| expand_directories_into expanded } end
expanded_preloading_packages_and_directories()
click to toggle source
# File lib/importmap/map.rb, line 109 def expanded_preloading_packages_and_directories expanded_packages_and_directories.select { |name, mapping| mapping.preload } end
find_javascript_files_in_tree(path)
click to toggle source
# File lib/importmap/map.rb, line 139 def find_javascript_files_in_tree(path) Dir[path.join("**/*.js{,m}")].collect { |file| Pathname.new(file) }.select(&:file?) end
module_name_from(filename, mapping)
click to toggle source
# File lib/importmap/map.rb, line 131 def module_name_from(filename, mapping) [ mapping.under, filename.to_s.remove(filename.extname).remove(/\/?index$/).presence ].compact.join("/") end
module_path_from(filename, mapping)
click to toggle source
# File lib/importmap/map.rb, line 135 def module_path_from(filename, mapping) [ mapping.path || mapping.under, filename.to_s ].compact.join("/") end
rescuable_asset_error?(error)
click to toggle source
# File lib/importmap/map.rb, line 90 def rescuable_asset_error?(error) Rails.application.config.importmap.rescuable_asset_errors.any? { |e| error.is_a?(e) } end
resolve_asset_paths(paths, resolver:)
click to toggle source
# File lib/importmap/map.rb, line 94 def resolve_asset_paths(paths, resolver:) paths.transform_values do |mapping| begin resolver.asset_path(mapping.path) rescue => e if rescuable_asset_error?(e) Rails.logger.warn "Importmap skipped missing path: #{mapping.path}" nil else raise e end end end.compact end