importmap-rails 0.7.6 → 0.9.0

data/lib/importmap/packager.rb

@@ -10,8 +10,11 @@ class Importmap::Packager
   singleton_class.attr_accessor :endpoint
   self.endpoint = URI("https://api.jspm.io/generate")
 
-  def initialize(importmap_path = "config/importmap.rb")
-    @importmap_path = importmap_path
+  attr_reader :vendor_path
+
+  def initialize(importmap_path = "config/importmap.rb", vendor_path: "vendor/javascript")
+    @importmap_path = Pathname.new(importmap_path)
+    @vendor_path    = Pathname.new(vendor_path)
   end
 
   def import(*packages, env: "production", from: "jspm")
@@ -33,15 +36,43 @@ class Importmap::Packager
     %(pin "#{package}", to: "#{url}")
   end
 
+  def vendored_pin_for(package, url)
+    filename = package_filename(package)
+    version  = extract_package_version_from(url)
+
+    if "#{package}.js" == filename
+      %(pin "#{package}" # #{version})
+    else
+      %(pin "#{package}", to: "#{filename}" # #{version})
+    end
+  end
+
   def packaged?(package)
     importmap.match(/^pin "#{package}".*$/)
   end
 
+  def download(package, url)
+    ensure_vendor_directory_exists
+    remove_existing_package_file(package)
+    download_package_file(package, url)
+  end
+
+  def remove(package)
+    remove_existing_package_file(package)
+    remove_package_from_importmap(package)
+  end
+
   private
+    def post_json(body)
+      Net::HTTP.post(self.class.endpoint, body.to_json, "Content-Type" => "application/json")
+    rescue => error
+      raise HTTPError, "Unexpected transport error (#{error.class}: #{error.message})"
+    end
+
     def extract_parsed_imports(response)
       JSON.parse(response.body).dig("map", "imports")
     end
-      
+
     def handle_failure_response(response)
       if error_message = parse_service_error(response)
         raise ServiceError, error_message
@@ -56,13 +87,57 @@ class Importmap::Packager
       nil
     end
 
-    def post_json(body)
-      Net::HTTP.post(self.class.endpoint, body.to_json, { "Content-Type" => "application/json" })
-    rescue => error
-      raise HTTPError, "Unexpected transport error (#{error.class}: #{error.message})"
-    end
-
     def importmap
       @importmap ||= File.read(@importmap_path)
     end
+
+
+    def ensure_vendor_directory_exists
+      FileUtils.mkdir_p @vendor_path
+    end
+
+    def remove_existing_package_file(package)
+      FileUtils.rm_rf vendored_package_path(package)
+    end
+
+    def remove_package_from_importmap(package)
+      all_lines = File.readlines(@importmap_path)
+      with_lines_removed = all_lines.select { |line| line !~ /pin "#{package}"/ }
+
+      File.open(@importmap_path, "w") do |file|
+        with_lines_removed.each { |line| file.write(line) }
+      end
+    end
+
+    def download_package_file(package, url)
+      response = Net::HTTP.get_response(URI(url))
+
+      if response.code == "200"
+        save_vendored_package(package, response.body)
+      else
+        handle_failure_response(response)
+      end
+    end
+
+    def save_vendored_package(package, source)
+      File.open(vendored_package_path(package), "w+") do |vendored_package|
+        vendored_package.write remove_sourcemap_comment_from(source).force_encoding("UTF-8")
+      end
+    end
+
+    def remove_sourcemap_comment_from(source)
+      source.gsub(/^\/\/# sourceMappingURL=.*/, "")
+    end
+
+    def vendored_package_path(package)
+      @vendor_path.join(package_filename(package))
+    end
+
+    def package_filename(package)
+      package.gsub("/", "--") + ".js"
+    end
+
+    def extract_package_version_from(url)
+      url.match(/@\d+\.\d+\.\d+/)&.to_a&.first
+    end
 end

data/lib/importmap/reloader.rb

@@ -11,7 +11,7 @@ class Importmap::Reloader
     end
 
     def import_map_paths
-      config.paths["config/importmap.rb"].existent
+      config.importmap.paths
     end
 
     def config

data/lib/importmap/version.rb

@@ -1,3 +1,3 @@
 module Importmap
-  VERSION = "0.7.6"
+  VERSION = "0.9.0"
 end

data/lib/install/config/importmap.rb

@@ -1,6 +1,3 @@
-# Use direct uploads for Active Storage (remember to import "@rails/activestorage" in your application.js)
-# pin "@rails/activestorage", to: "activestorage.esm.js"
+# Pin npm packages by running ./bin/importmap
 
-# Use npm packages from a JavaScript CDN by running ./bin/importmap
-
-pin "application"
+pin "application", preload: true

data/lib/install/install.rb

@@ -14,9 +14,14 @@ create_file Rails.root.join("app/javascript/application.js") do <<-JS
 JS
 end
 
+say "Use vendor/javascript for downloaded pins"
+empty_directory "vendor/javascript"
+keep_file "vendor/javascript"
+
 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)
+  append_to_file sprockets_manifest_path,
+    %(//= link_tree ../../javascript .js\n//= link_tree ../../../vendor/javascript .js\n)
 end
 
 say "Configure importmap paths in config/importmap.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: importmap-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.9.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: 
+description:
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -34,6 +34,8 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/es-module-shims.js
+- app/assets/javascripts/es-module-shims.js.map
+- app/assets/javascripts/es-module-shims.min.js
 - app/helpers/importmap/importmap_tags_helper.rb
 - lib/importmap-rails.rb
 - lib/importmap/commands.rb
@@ -53,7 +55,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/rails/importmap-rails
   source_code_uri: https://github.com/rails/importmap-rails
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,15 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Use ESM with importmap to manage modern JavaScript in Rails without transpiling
   or bundling.