RubyGems - importmap-rails - Versions diffs - 0.1.3 → 0.2.0 - Mend

importmap-rails 0.1.3 → 0.2.0

Files changed (8) hide show

checksums.yaml +4 -4
data/README.md +4 -4
data/app/helpers/importmap/importmap_tags_helper.rb +4 -4
data/lib/importmap/engine.rb +9 -4
data/lib/importmap/{paths.rb → map.rb} +12 -9
data/lib/importmap/version.rb +1 -1
data/lib/install/install.rb +13 -10
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9569cf8ada42f3b40596da6bbb24565237a45f3f49108b91470d18715d6fe55
-  data.tar.gz: 682592d777e3fffa178e4b0f74fc97c83564f4222a881532376a26890faa12da
+  metadata.gz: d90db013f0d628f59edd7b9b17892aae92033dea65298c03351d1ae75b9a782a
+  data.tar.gz: 3d8212059da5f5e4dc1ca241385132633dd7e6bd1a700087af8a18e38ae62456
 SHA512:
-  metadata.gz: 6ff7b0f6d2f5510281a6f540096b03dd7dc760927edf229425c1b5032b93e88ae17276fc9b348c7777cff0eacf39b58e944db26169d11db44c35c75185b89384
-  data.tar.gz: 9456a86bc8264595860b0e0e03690c82f9fb739f1a5a4ea7850f59f7570daec22c42ba18d6fde9fd5bc5cc76d4b310c6d4e172c4a5dfe8b18ef98d0a7e597dae
+  metadata.gz: 9f0b4a69a02f52d8a20be1235dadda2b9412b76677ef4897558822ed0244c5226428930891386bf830ac0fa93887ecaa71e3a4a69000afad926462bee2b9fc2b
+  data.tar.gz: 4c9da92a7e433445db8d9ea9b1db049996eb0b3943a229163985d0b17b6e31f7d5b0fc5fc013104330511d3d473c976fc3d4751a8b4ccfbbaad6644fac75b690

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 configured programmatically through the `Rails.application.config.importmap.paths` assignment, which by default is setup in `config/initializers/assets.rb` after running the installer. (Note that since this is a config initializer, you must restart your development server after making any changes.)
+The import map is configured programmatically through the `Rails.application.config.importmap` assignment, which by default is setup in `config/initializers/assets.rb` after running the installer. (Note that since this is a config initializer, you must restart your development server after making any changes.)
 This programmatically configured 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/assets/javascripts/application.js`, which is copied and digested by the asset pipeline.
@@ -44,9 +44,9 @@ import "@hotwired/stimulus-autoloader"
 Instead of mapping JavaScript modules to files in your application's path, you can also reference them directly from JavaScript CDNs like Skypack. Simply add them to the `config/initializers/assets.rb` with the URL instead of the local path:
 ```ruby
-Rails.application.config.importmap.paths.tap do |paths|
-  paths.asset "trix", path: "https://cdn.skypack.dev/trix"
-  paths.asset "md5", path: "https://cdn.skypack.dev/md5"
+Rails.application.config.importmap.draw do
+  pin "trix", to: "https://cdn.skypack.dev/trix"
+  pin "md5", to: "https://cdn.skypack.dev/md5"
 end
 ```

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

@@ -8,10 +8,10 @@ module Importmap::ImportmapTagsHelper
     ], "\n"
   end
-  # Generate an inline importmap tag using the passed `importmap_paths` object to produce the JSON map.
-  # By default, `Rails.application.config.importmap.paths` is used for this object,
-  def javascript_inline_importmap_tag(importmap_paths = Rails.application.config.importmap.paths)
-    tag.script(importmap_paths.to_json(self).html_safe, type: "importmap", "data-turbo-track": "reload")
+  # Generate an inline importmap tag using the passed `importmap` object to produce the JSON map.
+  # By default, `Rails.application.config.importmap` is used for this object.
+  def javascript_inline_importmap_tag(importmap = Rails.application.config.importmap)
+    tag.script(importmap.to_json(self).html_safe, type: "importmap", "data-turbo-track": "reload")
   end
   # Include the es-module-shim needed to make importmaps work in browsers without native support (like Firefox + Safari).

data/lib/importmap/engine.rb CHANGED Viewed

@@ -1,15 +1,14 @@
-require "importmap/paths"
+require "importmap/map"
 module Importmap
   class Engine < ::Rails::Engine
-    config.importmap = ActiveSupport::OrderedOptions.new
-    config.importmap.paths = Importmap::Paths.new.tap { |paths| paths.assets_in "app/assets/javascripts" }
+    config.importmap = Importmap::Map.new
     config.autoload_once_paths = %W( #{root}/app/helpers )
     initializer "importmap.assets" do
       if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( es-module-shims )
+        Rails.application.config.assets.precompile += %w( es-module-shims.js )
       end
     end
@@ -18,5 +17,11 @@ module Importmap
         helper Importmap::ImportmapTagsHelper
       end
     end
+    initializer "importmap.map" do
+      Rails.application.config.to_prepare do
+        load Rails.root.join("config/importmap.rb")
+      end
+    end
   end
 end

data/lib/importmap/{paths.rb → map.rb} RENAMED Viewed

@@ -1,30 +1,33 @@
-class Importmap::Paths
+class Importmap::Map
   attr_reader :files, :directories
   def initialize
-    @files = {}
-    @directories = {}
+    @files, @directories = {}, {}
   end
-  def asset(name, path: nil)
-    @files[name] = path || "#{name}.js"
+  def draw(&block)
+    instance_eval(&block)
   end
-  def assets_in(path, append_base_path: false)
+  def pin(name, to:)
+    @files[name] = to
+  end
+  def pin_all_from(path, append_base_path: false)
     @directories[path] = append_base_path
   end
   def to_json(resolver)
-    { "imports" => map_to_asset_paths(resolver) }.to_json
+    { "imports" => resolve_asset_paths(resolver) }.to_json
   end
   private
-    def map_to_asset_paths(resolver)
+    def resolve_asset_paths(resolver)
       expanded_files_and_directories.transform_values do |path|
         begin
           resolver.asset_path(path)
         rescue Sprockets::Rails::Helper::AssetNotFound
-          Rails.logger.warn "Importmap skipped missing asset: #{path}"
+          Rails.logger.warn "Importmap skipped missing path: #{path}"
           nil
         end
       end.compact

data/lib/importmap/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/install/install.rb CHANGED Viewed

@@ -23,22 +23,25 @@ append_to_file Rails.root.join("app/assets/config/manifest.js"), %(//= link_tree
 say "Configure importmap paths in config/initializers/assets.rb"
 append_to_file Rails.root.join("config/initializers/assets.rb") do <<-RUBY
-# Configure import map beyond the default of having all files in app/assets/javascripts mapped.
-Rails.application.config.importmap.paths.tap do |paths|
+# Configure import map to be used for ESM
+Rails.application.config.importmap.draw do
+  # All JavaScript files in the tree are mapped to their name
+  pin_all_from "app/assets/javascripts"
   # Match libraries with their NPM package names for possibility of later porting.
   # Ensure that libraries listed in the path have been linked in the asset pipeline manifest or precompiled.
-  paths.asset "@rails/actioncable", path: "actioncable.esm.js"
-  paths.asset "@rails/activestorage", path: "activestorage.esm.js"
-  paths.asset "@rails/actiontext", path: "actiontext.js"
-  paths.asset "trix"
+  pin "@rails/actioncable", to: "actioncable.esm.js"
+  pin "@rails/activestorage", to: "activestorage.esm.js"
+  pin "@rails/actiontext", to: "actiontext.js"
+  pin "trix", to: "trix.js"
   # Use libraries directly from JavaScript CDNs
-  # paths.asset "vue", path: "https://cdn.jsdelivr.net/npm/vue@2.6.14/dist/vue.esm.browser.js"
-  # paths.asset "d3", path: "https://cdn.skypack.dev/pin/d3@v7.0.0-03vFl9bie0TSesDkWTJV/mode=imports/optimized/d3.js"
+  # pin "vue", to: "https://cdn.jsdelivr.net/npm/vue@2.6.14/dist/vue.esm.browser.js"
+  # pin "d3", to: "https://cdn.skypack.dev/pin/d3@v7.0.0-03vFl9bie0TSesDkWTJV/mode=imports/optimized/d3.js"
-  # Map vendored modules by first adding the following to app/assets/config/manifest.js:
+  # Pin vendored modules by first adding the following to app/assets/config/manifest.js:
   # //= link_tree ../../../vendor/assets/javascripts .js
-  # paths.assets_in "vendor/assets/javascripts"
+  # pin_all_from "vendor/assets/javascripts"
 end
 RUBY
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -38,7 +38,7 @@ files:
 - app/helpers/importmap/importmap_tags_helper.rb
 - lib/importmap-rails.rb
 - lib/importmap/engine.rb
-- lib/importmap/paths.rb
+- lib/importmap/map.rb
 - lib/importmap/version.rb
 - lib/install/install.rb
 - lib/shim.js