importmap-rails-assets 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67b596d323bc11732f89708c18e07718a128aed399be33850fedd93f95dc5eb6
+  data.tar.gz: b313e73217930ca3971c100d8a07e3cd898d6640ca9e69ea4788441427b6e652
+SHA512:
+  metadata.gz: 60c612edb6cb19a60ad77aa543098931facf0a575bfc9f1379e1a785d6c6882c5edfe0d8a2ca2892789ccaca8392e46dc87215a21021873932f96076e2793862
+  data.tar.gz: 3e5e557203d8fc9d99775df1c93e4e8305025520e135782a32638720d951d03b6736091ded614135c4b30a0fdab366d8754a85a0954fb828b34e1b41b6751e5e

data/README.md

@@ -0,0 +1,43 @@
+# importmap-rails-assets
+
+Vendor arbitrary assets (CSS, fonts, images, etc.) from packages pinned with [importmap-rails](https://github.com/rails/importmap-rails).
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'importmap-rails-assets'
+```
+
+## Usage
+
+Define asset mappings in `config/assets.yml`. Each key is an npm package name (as pinned in your importmap), and the value is a hash of source paths within the package to local destination paths:
+
+```yaml
+tom-select:
+  dist/css/tom-select.bootstrap5.css: vendor/assets/stylesheets/tom-select.css
+
+flatpickr:
+  dist/flatpickr.css: vendor/assets/stylesheets/flatpickr.css
+  dist/themes/dark.css: vendor/assets/stylesheets/flatpickr-dark.css
+```
+
+Then pin the package as usual:
+
+```
+$ bin/importmap pin flatpickr
+Pinning "flatpickr" to vendor/javascript/flatpickr.js via download from https://ga.jspm.io/npm:flatpickr@4.6.13/dist/flatpickr.js
+Downloading "flatpickr/dist/flatpickr.css" to vendor/assets/stylesheets/flatpickr.css
+Downloading "flatpickr/dist/themes/dark.css" to vendor/assets/stylesheets/flatpickr-dark.css
+```
+
+`bin/importmap update` and `bin/importmap pristine` also download assets in the same way.
+
+`bin/importmap unpin` removes the corresponding asset files as well.
+
+Packages without an entry in `config/assets.yml` are silently skipped.
+
+## License
+
+MIT

data/lib/importmap-rails-assets.rb

@@ -0,0 +1,7 @@
+require 'importmap-rails'
+require 'importmap/packager'
+
+require_relative 'importmap_rails_assets/version'
+require_relative 'importmap_rails_assets/packager_extension'
+
+Importmap::Packager.prepend ImportmapRailsAssets::PackagerExtension

data/lib/importmap_rails_assets/packager_extension.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'yaml'
+require 'fileutils'
+
+module ImportmapRailsAssets
+  module PackagerExtension
+    def download(package, url)
+      super
+
+      version = extract_package_version_from(url)&.delete_prefix('@')
+      return unless version
+
+      asset_mappings = load_asset_mappings(package)
+      return if asset_mappings.empty?
+
+      asset_mappings.each do |source, dest|
+        download_asset(package, version, source, dest)
+      end
+    end
+
+    def remove(package)
+      super
+
+      load_asset_mappings(package).each_value do |dest|
+        path = Pathname.new(dest)
+        FileUtils.rm_f(path)
+      end
+    end
+
+    private
+
+    def load_asset_mappings(package)
+      config_path = Pathname.new('config/assets.yml')
+      return {} unless config_path.exist?
+
+      config = YAML.safe_load_file(config_path) || {}
+      config[package] || {}
+    end
+
+    def download_asset(package, version, source, dest)
+      uri = URI("https://cdn.jsdelivr.net/npm/#{package}@#{version}/#{source}")
+
+      response = Net::HTTP.get_response(uri)
+      return unless response.is_a?(Net::HTTPSuccess)
+
+      dest_path = Pathname.new(dest)
+      FileUtils.mkdir_p dest_path.dirname
+
+      File.binwrite(dest_path, response.body)
+
+      puts %(Downloading "#{package}/#{source}" to #{dest})
+    end
+  end
+end

data/lib/importmap_rails_assets/version.rb

@@ -0,0 +1,3 @@
+module ImportmapRailsAssets
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: importmap-rails-assets
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ursm
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/importmap-rails-assets.rb
+- lib/importmap_rails_assets/packager_extension.rb
+- lib/importmap_rails_assets/version.rb
+homepage: https://github.com/ursm/importmap-rails-assets
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Vendor arbitrary assets from pinned importmap packages
+test_files: []