rails_node_module_linker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa0c86a806e4d35422ea07120daf7f367abca2d6c73cbcde246998105b9a1cc
-  data.tar.gz: fdbe50d3ffc2172e9e3af29de662c2e0967a6de86402c87e9e5203327a28d1fb
+  metadata.gz: a715e5efda2b9c74f8b0148969279ef882137cfbd2099e4c4f8dbab139ad703c
+  data.tar.gz: ec17edf684bc7ee2e471f46cc09c4c14aa1872de15b5ab2eccc69e1ef0a4f41f
 SHA512:
-  metadata.gz: f70181d3e52b413fe3296dc4da448bb0a09a5aa0119048a234bcfc90a2770cba9b39445fa455ca5f295bf231109dde43bf22230382d3a4d815319b30605c60e1
-  data.tar.gz: e3b076fdc840c1b944ab829b989c2303832fb6e8a8ec711e37a78e7e4b38afbef8f205abbf086d0aa260daffe283be201a971f32fd3e1db67c63002193bf6ea1
+  metadata.gz: 35db5fd4280b252f45f8e0e2556d2b0fc37667d9430aec7566a7a42e4b80b6f01bef25f191eb32f3dfd69be30f9a17969919b0f3cf253d6f187882c9afca0015
+  data.tar.gz: a6553ee7db4b1fc3adc47c88936eb2e89ee00a0787b07598c814407a24c9ad578de120cd15a9458634d46782b9b98691e7835618f4b805a654bb38b1c77baa98

data/.rubocop.yml

@@ -7,10 +7,14 @@ AllCops:
   SuggestExtensions: true
   NewCops: 'enable'
 
+
+# ################################################ * Layout * ################################################# #
 Layout/LineLength:
   Enabled: true
   Max: 250
 
+
+# ################################################ * Metrics * ################################################# #
 Metrics/AbcSize:
   Enabled: false # * Keeping these off due to complexity of refactoring existing code
 
@@ -25,9 +29,11 @@ Metrics/MethodLength:
   CountAsOne: ["array", "heredoc", "method_call"]
   Max: 50
 
-Style/Documentation:
-  Enabled: false
 
+# ################################################ * Metrics * ################################################# #
 Style/ClassAndModuleChildren:
   Enabled: true
   EnforcedStyle: 'compact'
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## [0.1.0] - 2025-04-24
+## [0.2.0] - 2025-05-17
+
+- Adds ability to change the `destination_path`
+- renames config_file_path to symlinked_node_modules_config
+- BREAKING removes need to add Rails.root.join in the config
+
+## [0.1.1] - 2025-05-07
+
+- Fixes precompile hook
+
+## [0.1.0] - 2025-05-06
 
 - Initial release
 - Links selected node_modules to `public/` for use with Propshaft

data/README.md

@@ -22,7 +22,8 @@ gem install rails_node_module_linker
 # config/initializers/rails_node_module_linker.rb
 
 Rails.application.config.to_prepare do
-  RailsNodeModuleLinker.config.config_file_path = Rails.root.join("config/symlinked_node_modules.yml")
+  RailsNodeModuleLinker.config.symlinked_node_modules_config = 'config/symlinked_node_modules.yml'
+  RailsNodeModuleLinker.config.destination_path = 'public/node_modules'
   RailsNodeModuleLinker.config.use_emojis = true
 end
 ```

data/lib/rails_node_module_linker/config.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 class RailsNodeModuleLinker::Config
-  attr_accessor :config_file_path, :use_emojis
+  attr_accessor :symlinked_node_modules_config, :destination_path, :use_emojis
 
   def initialize
     # * Default configuration values
-    @config_file_path = Rails.root.join('config/symlinked_node_modules.yml')
+    @symlinked_node_modules_config = 'config/symlinked_node_modules.yml'
+    @destination_path = 'public/node_modules'
     @use_emojis = true
 
-    # TODO: make desitination folder customizable
-    # TODO make source folder customizable
-    # TODO make middleware enablement configurable
+    # TODO: make source folder customizable
+    # TODO: make middleware enablement configurable
   end
 end

data/lib/rails_node_module_linker/middleware.rb

@@ -10,7 +10,9 @@ class RailsNodeModuleLinker::Middleware
   def call(env)
     path = env['PATH_INFO']
     Rack::Utils.parse_query(env['QUERY_STRING'])
-    config_file_path = RailsNodeModuleLinker.config.config_file_path
+    symlinked_node_modules_config = Rails.root.join(
+      RailsNodeModuleLinker.config.symlinked_node_modules_config
+    )
 
     if path.start_with?('/node_modules/')
       status, _headers, _body = @app.call(env)
@@ -18,16 +20,16 @@ class RailsNodeModuleLinker::Middleware
         package = extract_package(path)
 
         # * Ensure the config directory exists
-        FileUtils.mkdir_p(config_file_path.dirname)
+        FileUtils.mkdir_p(symlinked_node_modules_config.dirname)
 
         # * Load existing config or initialize a new one
-        config = File.exist?(config_file_path) ? YAML.load_file(config_file_path) : { 'packages' => [] }
+        config = File.exist?(symlinked_node_modules_config) ? YAML.load_file(symlinked_node_modules_config) : { 'packages' => [] }
 
         # * Add the package if not already listed
         config['packages'] = (config['packages'] | [package]).sort
 
         # * Save the updated config
-        File.write(config_file_path, config.to_yaml)
+        File.write(symlinked_node_modules_config, config.to_yaml)
 
         # * Call the rake task to create the symlink
         system('bin/rails rails_node_module_linker:link')

data/lib/rails_node_module_linker/railtie.rb

@@ -6,9 +6,24 @@ require 'rails_node_module_linker'
 class RailsNodeModuleLinker::Railtie < Rails::Railtie
   railtie_name :rails_node_module_linker
 
+  # TODO: make this changeable via setting
+  # * Hardcoded toggle for before/after
+  PRECOMPILE_HOOK_POSITION = :before # ? or :after
+
   rake_tasks do
     path = File.expand_path(__dir__)
     Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+
+    Rake::Task.define_task(:environment)
+
+    case PRECOMPILE_HOOK_POSITION
+    when :before
+      Rake::Task['assets:precompile'].enhance(['rails_node_module_linker:precompile_hook'])
+    when :after
+      Rake::Task['assets:precompile'].enhance do
+        Rake::Task['rails_node_module_linker:precompile_hook'].invoke
+      end
+    end
   end
 
   initializer 'rails_node_module_linker.insert_middleware' do |app|

data/lib/rails_node_module_linker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsNodeModuleLinker
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/rails_node_module_linker.rb

@@ -9,6 +9,8 @@ module RailsNodeModuleLinker
   # * Configuration accessor for users to access and modify settings
   mattr_accessor :config
 
+  self.config ||= Config.new
+
   class Engine < ::Rails::Engine
     # * Initialize default configuration
     initializer 'rails_node_module_linker.config' do

data/lib/tasks/rails_node_module_linker/link.rake

@@ -14,32 +14,34 @@ def log_with_emoji(message)
 end
 
 namespace :rails_node_module_linker do
-  desc 'Symlink full packages from node_modules to public/node_modules'
+  desc "Symlink full packages from node_modules to #{RailsNodeModuleLinker.config.destination_path}"
   task link: :environment do
-    config_file_path = RailsNodeModuleLinker.config.config_file_path
+    symlinked_node_modules_config = Rails.root.join(
+      RailsNodeModuleLinker.config.symlinked_node_modules_config
+    )
 
     # * Ensure the config file exists with a default structure
-    unless File.exist?(config_file_path)
-      log_with_emoji("🆕 Created missing config file at #{config_file_path}")
+    unless File.exist?(symlinked_node_modules_config)
+      log_with_emoji("🆕 Created missing config file at #{symlinked_node_modules_config}")
 
-      FileUtils.mkdir_p(config_file_path.dirname)
-      File.write(config_file_path, { 'packages' => [] }.to_yaml)
+      FileUtils.mkdir_p(symlinked_node_modules_config.dirname)
+      File.write(symlinked_node_modules_config, { 'packages' => [] }.to_yaml)
     end
 
-    config = YAML.load_file(config_file_path)
+    config = YAML.load_file(symlinked_node_modules_config)
     node_modules_to_link = config['packages'] || []
 
     log_with_emoji('📭 No node modules configured to link.') if node_modules_to_link.empty?
 
-    public_node_modules = Rails.root.join('public/node_modules')
-    FileUtils.mkdir_p(public_node_modules)
+    node_modules_destination_path = Rails.root.join(RailsNodeModuleLinker.config.destination_path)
+    FileUtils.mkdir_p(node_modules_destination_path)
 
     # * Clean up outdated symlinks
-    existing_symlinks = Dir.glob(public_node_modules.join('**/*'), File::FNM_DOTMATCH).select do |path|
+    existing_symlinks = Dir.glob(node_modules_destination_path.join('**/*'), File::FNM_DOTMATCH).select do |path|
       File.symlink?(path)
     end
     existing_symlinks.each do |symlink_path|
-      relative_path = Pathname.new(symlink_path).relative_path_from(public_node_modules).to_s
+      relative_path = Pathname.new(symlink_path).relative_path_from(node_modules_destination_path).to_s
       next if node_modules_to_link.include?(relative_path)
 
       log_with_emoji("🧹 Removing stale symlink: #{symlink_path}")
@@ -50,7 +52,7 @@ namespace :rails_node_module_linker do
     # * Add or update symlinks from config
     node_modules_to_link.each do |package|
       source = Rails.root.join('node_modules', package)
-      destination = public_node_modules.join(package)
+      destination = node_modules_destination_path.join(package)
 
       unless source.exist?
         log_with_emoji("🚫 Source does not exist: #{source} (skipping)")
@@ -80,5 +82,5 @@ namespace :rails_node_module_linker do
   end
 
   desc 'Link node module packages before asset precompilation'
-  task precompile: :link_node_module_packages
+  task precompile_hook: :link
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_node_module_linker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anthony Veaudry
 bindir: exe
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Exposees wanted node_modules to the public directory for Rails apps that
   have transitioned from Sprockets to Propshaft.
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Link node modules into the public folder of a Rails app using Propshaft
 test_files: []