rails_node_module_linker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efa0c86a806e4d35422ea07120daf7f367abca2d6c73cbcde246998105b9a1cc
+  data.tar.gz: fdbe50d3ffc2172e9e3af29de662c2e0967a6de86402c87e9e5203327a28d1fb
+SHA512:
+  metadata.gz: f70181d3e52b413fe3296dc4da448bb0a09a5aa0119048a234bcfc90a2770cba9b39445fa455ca5f295bf231109dde43bf22230382d3a4d815319b30605c60e1
+  data.tar.gz: e3b076fdc840c1b944ab829b989c2303832fb6e8a8ec711e37a78e7e4b38afbef8f205abbf086d0aa260daffe283be201a971f32fd3e1db67c63002193bf6ea1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-rake # * Rake-specific analysis. (Official)
+  - rubocop-rspec # * RSpec-specific analysis. (Official)
+
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: true
+  NewCops: 'enable'
+
+Layout/LineLength:
+  Enabled: true
+  Max: 250
+
+Metrics/AbcSize:
+  Enabled: false # * Keeping these off due to complexity of refactoring existing code
+
+Metrics/BlockLength:
+  Enabled: true
+  CountAsOne: ["array", "heredoc", "method_call"]
+  AllowedMethods: ["included"]
+  Max: 50
+
+Metrics/MethodLength:
+  Enabled: true
+  CountAsOne: ["array", "heredoc", "method_call"]
+  Max: 50
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: 'compact'

data/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "cSpell.words": [
+    "mattr",
+    "popen",
+    "racc",
+    "rubocop",
+    "Veaudry",
+    "yardoc"
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## [0.1.0] - 2025-04-24
+
+- Initial release
+- Links selected node_modules to `public/` for use with Propshaft

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Anthony Veaudry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# RailsNodeModuleLinker
+
+Helps expose selected node_modules into the public directory for use in Rails apps that have transitioned from Sprockets to Propshaft.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rails_node_module_linker
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rails_node_module_linker
+```
+
+## Usage
+
+```ruby
+# 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.use_emojis = true
+end
+```
+
+```yaml
+# config/symlinked_node_modules.yml
+
+---
+packages:
+- "@melloware/coloris"
+- bootstrap
+- flag-icons
+- intl-tel-input
+- mapbox-gl
+```
+
+### Rake Tasks
+
+#### Link Node Modules
+
+Run the following command to link selected node_modules to the public directory:
+
+```bash
+rails rails_node_module_linker:link
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub [here](https://github.com/anthony0030/rails_node_module_linker). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/anthony0030/rails_node_module_linker/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsNodeModuleLinker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anthony0030/rails_node_module_linker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rails_node_module_linker/config.rb

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

data/lib/rails_node_module_linker/middleware.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'rails_node_module_linker/config'
+
+class RailsNodeModuleLinker::Middleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    path = env['PATH_INFO']
+    Rack::Utils.parse_query(env['QUERY_STRING'])
+    config_file_path = RailsNodeModuleLinker.config.config_file_path
+
+    if path.start_with?('/node_modules/')
+      status, _headers, _body = @app.call(env)
+      if status == 404
+        package = extract_package(path)
+
+        # * Ensure the config directory exists
+        FileUtils.mkdir_p(config_file_path.dirname)
+
+        # * Load existing config or initialize a new one
+        config = File.exist?(config_file_path) ? YAML.load_file(config_file_path) : { '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)
+
+        # * Call the rake task to create the symlink
+        system('bin/rails rails_node_module_linker:link')
+
+        return redirect_to_newly_linked_module(path)
+      end
+    end
+
+    @app.call(env)
+  end
+
+  private
+
+  def extract_package(path)
+    segments = path.split('/')
+
+    return nil unless segments[1] == 'node_modules'
+
+    if segments[2].start_with?('@')
+      "#{segments[2]}/#{segments[3]}"
+    else
+      segments[2]
+    end
+  end
+
+  def redirect_to_newly_linked_module(path)
+    [
+      302,
+      { 'Location' => path },
+      []
+    ]
+  end
+end

data/lib/rails_node_module_linker/railtie.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'rails_node_module_linker'
+
+class RailsNodeModuleLinker::Railtie < Rails::Railtie
+  railtie_name :rails_node_module_linker
+
+  rake_tasks do
+    path = File.expand_path(__dir__)
+    Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+  end
+
+  initializer 'rails_node_module_linker.insert_middleware' do |app|
+    if Rails.env.development?
+      app.middleware.insert_before ActionDispatch::Static, RailsNodeModuleLinker::Middleware
+      Rails.logger.info '[rails_node_module_linker] Middleware inserted'
+    else
+      Rails.logger.info '[rails_node_module_linker] Middleware skipped'
+    end
+  end
+end

data/lib/rails_node_module_linker/version.rb

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

data/lib/rails_node_module_linker.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'rails_node_module_linker/version'
+require_relative 'rails_node_module_linker/config'
+require_relative 'rails_node_module_linker/middleware'
+require_relative 'rails_node_module_linker/railtie'
+
+module RailsNodeModuleLinker
+  # * Configuration accessor for users to access and modify settings
+  mattr_accessor :config
+
+  class Engine < ::Rails::Engine
+    # * Initialize default configuration
+    initializer 'rails_node_module_linker.config' do
+      RailsNodeModuleLinker.config ||= RailsNodeModuleLinker::Config.new
+    end
+  end
+end

data/lib/tasks/rails_node_module_linker/link.rake

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require 'rails_node_module_linker/config'
+
+def log_with_emoji(message)
+  if RailsNodeModuleLinker.config.use_emojis
+    puts message
+  else
+    # * Removes non-ASCII characters, which includes emojis and the space from the beggining
+    puts message.gsub(/[[:^ascii:]]/, '').strip
+  end
+end
+
+namespace :rails_node_module_linker do
+  desc 'Symlink full packages from node_modules to public/node_modules'
+  task link: :environment do
+    config_file_path = RailsNodeModuleLinker.config.config_file_path
+
+    # * 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}")
+
+      FileUtils.mkdir_p(config_file_path.dirname)
+      File.write(config_file_path, { 'packages' => [] }.to_yaml)
+    end
+
+    config = YAML.load_file(config_file_path)
+    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)
+
+    # * Clean up outdated symlinks
+    existing_symlinks = Dir.glob(public_node_modules.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
+      next if node_modules_to_link.include?(relative_path)
+
+      log_with_emoji("🧹 Removing stale symlink: #{symlink_path}")
+
+      FileUtils.rm(symlink_path)
+    end
+
+    # * 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)
+
+      unless source.exist?
+        log_with_emoji("🚫 Source does not exist: #{source} (skipping)")
+
+        next
+      end
+
+      if destination.symlink?
+        if File.exist?(destination.readlink)
+          log_with_emoji("✅ Already linked: #{destination}")
+          next
+        else
+          log_with_emoji("⚠ Broken symlink detected: #{destination} (removing)")
+
+          FileUtils.rm(destination)
+        end
+      elsif destination.exist?
+        log_with_emoji("❌ Destination exists but is not a symlink: #{destination} (skipping)")
+        next
+      end
+
+      FileUtils.mkdir_p(destination.parent)
+      FileUtils.ln_sf(source, destination)
+
+      log_with_emoji("🔗 Linked: #{source} -> #{destination}")
+    end
+  end
+
+  desc 'Link node module packages before asset precompilation'
+  task precompile: :link_node_module_packages
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rails_node_module_linker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Veaudry
+bindir: exe
+cert_chain: []
+date: 2025-05-06 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.
+email:
+- anthony@veaudry.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_node_module_linker.rb
+- lib/rails_node_module_linker/config.rb
+- lib/rails_node_module_linker/middleware.rb
+- lib/rails_node_module_linker/railtie.rb
+- lib/rails_node_module_linker/version.rb
+- lib/tasks/rails_node_module_linker/link.rake
+homepage: https://github.com/anthony0030/rails_node_module_linker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/anthony0030/rails_node_module_linker/wiki
+  source_code_uri: https://github.com/anthony0030/rails_node_module_linker
+  changelog_uri: https://github.com/anthony0030/rails_node_module_linker/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Link node modules into the public folder of a Rails app using Propshaft
+test_files: []