importmap-node 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c5646881534b9345ec18f89096877bdf2997a54eff2ca7d398a11e7031c6cac
+  data.tar.gz: b3fb276ee1463143206de177a6b3913377980be5c4bde3e26e9da7f92b07aadb
+SHA512:
+  metadata.gz: 63a5f385846268bb9a4c059b2cd35371e9bd87d28f599993da8976c9de9971506e4591fda0f2680e87671e0602771b88d6d5141faa967cab8529eb1f0c8fbe60
+  data.tar.gz: fa5b2dacbd647fa39e5860ac179ecc9e92eb2b1a06c225c3bd2e3709230ac1e5ecb4cba87733797c2adb25ed40931a831471f5fb80afaf4842ef67b530cf57c2

data/lib/importmap/node/installer.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+
+module Importmap
+  module Node
+    class Installer
+      JS_DEST = 'vendor/javascript'
+      CONFIG_FILE = 'config/importmap_node.json'
+
+      def initialize(root: Rails.root)
+        @root         = Pathname.new(root)
+        @node_modules = @root.join('node_modules')
+        @importmap    = @root.join('config', 'importmap.rb')
+        @config_file  = @root.join(CONFIG_FILE)
+      end
+
+      def install(package)
+        yarn_add(package)
+
+        pkg_name = resolve_package_name(package)
+        pkg_meta = read_package_meta(pkg_name)
+        js_files = vendor_js(pkg_name, pkg_meta)
+        pin_importmap(pkg_name, js_files)
+        record_package(package)
+
+        summarize(pkg_name, js_files)
+      end
+
+      def uninstall(package)
+        pkg_name = resolve_package_name(package)
+        pkg_meta = read_package_meta(pkg_name)
+        js_files = vendored_js_files(pkg_name, pkg_meta)
+
+        yarn_remove(pkg_name)
+        delete_files(JS_DEST, js_files)
+        unpin_importmap(pkg_name)
+        unrecord_package(package)
+
+        summarize_removal(pkg_name, js_files)
+      end
+
+      def update
+        packages = load_packages
+        if packages.empty?
+          puts "No packages tracked in #{CONFIG_FILE}."
+          return
+        end
+        yarn_up_dependencies
+        puts "Re-vendoring #{packages.size} package(s)..."
+        packages.each { |pkg| revendor(pkg) }
+      end
+
+      private
+
+      def yarn_add(package)
+        yarn_arg = if package.start_with?('file:')
+                     path = package.sub(/^file:/, '')
+                     local_pkg_json = File.expand_path(File.join(path, 'package.json'), @root.to_s)
+                     name = JSON.parse(File.read(local_pkg_json))['name']
+                     "#{name}@#{package}"
+                   else
+                     package
+                   end
+
+        puts "Running: yarn add #{yarn_arg}"
+        system("yarn add #{yarn_arg}", chdir: @root.to_s) or raise "yarn add failed for #{package}"
+      end
+
+      def yarn_remove(pkg_name)
+        puts "Running: yarn remove #{pkg_name}"
+        system("yarn remove #{pkg_name}", chdir: @root.to_s) or raise "yarn remove failed for #{pkg_name}"
+      end
+
+      def yarn_up_dependencies
+        pkg_json = @root.join('package.json')
+        deps     = JSON.parse(pkg_json.read).fetch('dependencies', {}).keys
+        return if deps.empty?
+
+        puts "Running: yarn up #{deps.join(' ')}"
+        system("yarn up #{deps.join(' ')}", chdir: @root.to_s) or raise 'yarn up failed'
+      end
+
+      def revendor(package)
+        pkg_name = resolve_package_name(package)
+        pkg_meta = read_package_meta(pkg_name)
+        js_files = vendor_js(pkg_name, pkg_meta)
+        pin_importmap(pkg_name, js_files)
+        summarize(pkg_name, js_files)
+      end
+
+      def resolve_package_name(package)
+        if package.start_with?('file:')
+          path = package.sub(/^file:/, '')
+          local_pkg_json = File.expand_path(File.join(path, 'package.json'), @root.to_s)
+          JSON.parse(File.read(local_pkg_json))['name']
+        else
+          package
+        end
+      end
+
+      def read_package_meta(pkg_name)
+        path = @node_modules.join(pkg_name, 'package.json')
+        raise "Cannot find #{path}. Did yarn add succeed?" unless path.exist?
+
+        JSON.parse(path.read)
+      end
+
+      def vendor_js(pkg_name, meta)
+        file = meta['module'] || meta['main'] || 'index.js'
+        src  = @node_modules.join(pkg_name, file)
+        return [] unless src.exist?
+
+        dest_dir = @root.join(JS_DEST)
+        FileUtils.mkdir_p(dest_dir)
+        dest = dest_dir.join(src.basename)
+        FileUtils.cp(src, dest)
+        [dest.basename.to_s]
+      end
+
+      def vendored_js_files(pkg_name, meta)
+        file = meta['module'] || meta['main'] || 'index.js'
+        src  = @node_modules.join(pkg_name, file)
+        src.exist? ? [src.basename.to_s] : []
+      end
+
+      def delete_files(dest, filenames)
+        filenames.each do |name|
+          path = @root.join(dest, name)
+          if path.exist?
+            path.delete
+            puts "  Deleted: #{dest}/#{name}"
+          end
+        end
+      end
+
+      def pin_importmap(pkg_name, js_files)
+        return if js_files.empty? || !@importmap.exist?
+
+        content  = @importmap.read
+        pin_line = "pin \"#{pkg_name}\", to: \"#{js_files.first}\""
+
+        if content.match?(/pin ['"]#{Regexp.escape(pkg_name)}['"]/)
+          new_content = content.gsub(/pin ['"]#{Regexp.escape(pkg_name)}['"][^\n]*/, pin_line)
+          @importmap.write(new_content)
+          puts "  Updated pin: #{pin_line}"
+        else
+          @importmap.open('a') { |f| f.puts pin_line }
+          puts "  Added pin: #{pin_line}"
+        end
+      end
+
+      def unpin_importmap(pkg_name)
+        return unless @importmap.exist?
+
+        content     = @importmap.read
+        new_content = content.gsub(/\n?pin ['"]#{Regexp.escape(pkg_name)}['"][^\n]*/, '')
+        return unless content != new_content
+
+        @importmap.write(new_content)
+        puts "  Removed pin for #{pkg_name} from config/importmap.rb"
+      end
+
+      def summarize(pkg_name, js_files)
+        puts "\n#{pkg_name} installed:"
+        js_files.each { |f| puts "  JS: vendor/javascript/#{f}" }
+        puts '  Pinned in config/importmap.rb' unless js_files.empty?
+      end
+
+      def summarize_removal(pkg_name, js_files)
+        puts "\n#{pkg_name} removed:"
+        js_files.each { |f| puts "  JS: #{JS_DEST}/#{f}" }
+      end
+
+      def load_packages
+        return [] unless @config_file.exist?
+
+        JSON.parse(@config_file.read)['packages'] || []
+      end
+
+      def record_package(package)
+        packages = load_packages
+        return if packages.include?(package)
+
+        packages << package
+        @config_file.write(JSON.pretty_generate('packages' => packages))
+      end
+
+      def unrecord_package(package)
+        packages = load_packages
+        return unless packages.delete(package)
+
+        @config_file.write(JSON.pretty_generate('packages' => packages))
+      end
+    end
+  end
+end

data/lib/importmap/node/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Importmap
+  module Node
+    class Railtie < Rails::Railtie
+      railtie_name :importmap_node
+
+      rake_tasks do
+        load File.join(__dir__, '..', '..', 'tasks', 'importmap_node.rake')
+      end
+    end
+  end
+end

data/lib/importmap/node/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Importmap
+  module Node
+    VERSION = '0.1.0'
+  end
+end

data/lib/importmap-node.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'importmap/node/version'
+require 'importmap/node/installer'
+require 'importmap/node/railtie' if defined?(Rails::Railtie)

data/lib/tasks/importmap_node.rake

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+namespace :importmap do
+  namespace :node do
+    desc 'Install a node package and vendor its JS/CSS files. Usage: rails importmap:node:install[package-name-or-url]'
+    task :install, [:package] => :environment do |_t, args|
+      package = args[:package]
+      abort 'Usage: rails importmap:node:install[package-name-or-url]' if package.blank?
+
+      Importmap::Node::Installer.new.install(package)
+    end
+
+    desc 'Remove a node package and delete its vendored JS files. Usage: rails importmap:node:remove[package-name]'
+    task :remove, [:package] => :environment do |_t, args|
+      package = args[:package]
+      abort 'Usage: rails importmap:node:remove[package-name]' if package.blank?
+
+      Importmap::Node::Installer.new.uninstall(package)
+    end
+
+    desc 'Re-vendor all packages tracked in config/importmap_node.json'
+    task update: :environment do
+      Importmap::Node::Installer.new.update
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: importmap-node
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tien
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+email:
+- tieeeeen1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/importmap-node.rb
+- lib/importmap/node/installer.rb
+- lib/importmap/node/railtie.rb
+- lib/importmap/node/version.rb
+- lib/tasks/importmap_node.rake
+homepage: https://github.com/tieeeeen1994/importmap-node
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.7
+specification_version: 4
+summary: Install node packages as vendored assets in Rails via yarn
+test_files: []