webpacker-pnpm 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e0c39889bfdad4a14a2fc35250e7eaa33fd49bf48ecc082c44d1985884fbe89
-  data.tar.gz: 8f27fae2d742a2b4c27e0fa675480dda85771bfd120e283fa706c80ce7414fa5
+  metadata.gz: 5e158c9136e7684be56fce973c9272ec8ab16ff20d6c08c5949e0c9f13f2c0e3
+  data.tar.gz: bf02dcac8a0165359548569f6fd73c44decd31a9cd05393d35ae0a81377f7bdf
 SHA512:
-  metadata.gz: 8715f49514245b10d8ed85169c5edadcb2ab8905880f9afdd273121835336c175dec087f05b639179024eeea4fc1745ca24c73d00c24fc92d06bbb85ab591d02
-  data.tar.gz: fd7a0f6cc602c9a7d4ba0a2689fc87feae4d7f93c470c9c5fc8b7f62cfd364fd3152839448150a58c523a0e516aa229eed3d9d07cc1083ed0b4ecaeb9938a5b8
+  metadata.gz: '058a4834ac5ff8dd02fdc5dfab8253888500c06d0420dfe1643dab0cfc1cb7e50c3157556c34eb8b71b720f5a97e55b2f712be2f0d1d5a7125924024d0ebe885'
+  data.tar.gz: 6ced6827e35f59e42f1f979dbadddb54d2eb54f039c7aff2fc25a0de2b0450c7149fe39c6f7a98abc224fb54245d001443280982f82020e163a00bc362cc0e49

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: thearchitector

data/.github/workflows/ci.yaml

@@ -0,0 +1,50 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        gemfile: [ '5.2.x', '6.0.x' ]
+        exclude:
+          - ruby: '2.4'
+            gemfile: '6.0.x'
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/Gemfile-rails.${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Setup Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 14
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v2
+      id: pnpm-install
+      with:
+        version: 7
+        run_install: false
+    - name: Define pnpm cache
+      id: pnpm-cache
+      shell: bash
+      run: echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+    - uses: actions/cache@v3
+      with:
+        path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-
+    - run: pnpm install --frozen-lockfile
+      working-directory: ./test/test_app
+    - name: Check formatting and syntax
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rake test

data/.gitignore

@@ -1,3 +1,6 @@
 /tmp/
-/**/*.log
-Gemfile.lock
+**/log
+Gemfile.lock
+**/*.gem
+gemfiles/vendor
+.bundle

data/.rubocop.yml

@@ -1,91 +1,24 @@
-require: rubocop-rails
-AllCops:
-  Exclude:
-    - "node_modules/**/*"
-
-# disable length length checking, as it tends to make things worse in the majority
-# of cases. however, it is good practice keep lines <= 85 columns so they remain
-# readable.
-Layout/LineLength:
-  Enabled: false
-
-# disable documentation checking. many classes do not require top-level comments,
-# and their inclusion can actually obscure their function.
-Style/Documentation:
-  Enabled: false
-
-# functionalization is important, but the Rails' idiom for returning key-value
-# maps can raise a false alarm with the max line number (10). increase the value
-# to something more reasonable given the circumstances.
-Metrics/MethodLength:
-  Max: 20
-  ExcludedMethods:
-    - test_rake_tasks
-
-# if you're specifying access modifiers, it is likely intentional. force RuboCop
-# to trust your decision making.
-Lint/UselessAccessModifier:
-  Enabled: false
-
-# flag potential memory leaks, like when opening a file.
-Style/AutoResourceCleanup:
-  Enabled: true
-
-# single quotes are meant for single characters. double quotes are meant for
-# strings, which are arrays of multiple characters. there are a whole host of
-# other differences and functions; if you're creating a string, you nearly always
-# should use double quotes.
-#
-# https://en.wikipedia.org/wiki/Delimiter#Bracket_delimiters
-# Schwartz, Randal (2005). Learning Perl. ISBN 978-0-596-10105-3.
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-# flags methods that violate the default ABC magnitude (15). The ABC metric
-# quantizes the size of a method, and is calculated based on the number of
-# assignment operations, possible execution branches, and number of conditionals.
-#
-# https://en.wikipedia.org/wiki/ABC_Software_Metric
-Metrics/AbcSize:
-  Enabled: true
-  IgnoredMethods:
-    - test_rake_tasks
-    - chdir_concurrent
-
-# this simply doesn't work in a cross-platform development environment. Bit
-# flags across UNIX and Windows platforms are volatile, and thus there is no
-# way to ensure this passes besides explicitly granting execute permissions
-# in CI config (which would defeat the purpose).
-Lint/ScriptPermission:
-  Enabled: false
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
-  Enabled: true
-
-Style/ExponentialNotation:
-  Enabled: true
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Style/SlicingWithRange:
-  Enabled: true
-
-Style/RescueModifier:
-  Enabled: false
+#
+# RuboCop is a Ruby static code analyzer and code formatter that tries to enforce many
+# of the guidelines outlined in the community Ruby and Rails style guides.
+#
+# https://docs.rubocop.org/en/latest/
+# https://rubystyle.guide/
+# https://rails.rubystyle.guide/
+inherit_gem:
+  practical-pig: rubocop-base.yaml
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+    - IgnoredMethods
+    - AllowedMethods
+
+# cop-specific excludes are not inherited for some reason (likely a bug in RuboCop) so
+# we need to manually re-omit the intended files and directories.
+Layout/LineLength:
+  Exclude:
+    - "**/config/initializers/**/*"
+Style/MethodCallWithArgsParentheses:
+  Exclude:
+    - "**/Gemfile"

data/CHANGELOG.md

@@ -1,45 +1,69 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on Keep a Changelog (<https://keepachangelog.com/en/1.0.0/>). This project adheres to Semantic Versioning (<https://semver.org/spec/v2.0.0.html>).
-
-## [v1.2.0] - 2020-05-14
-
-### Added
-
-- Compatibility with Rails' Template API via command execution hooks and keyword substitution.
-- Support for existing Yarn Rake task dependence through task aliasing and redirection.
-- Additional Rake tasks to test injection and interception logic.
-- Utility method for concurrent and scoped `chdir` calls.
-
-### Changed
-
-- Gem dependencies to reflect up-to-date versions.
-- RuboCop formatting rules to support latest versions of Ruby.
-- Test application structure to allow application booting.
-- Rake task tests to utilize concurrent `chdir` calls.
-- Tests to support Rails <6.x `[bugfix]`.
-- Tests to support Ruby 2.4.9 `[bugfix]`.
-
-### Removed
-
-- Webpacker git submodule as method for replacing default Rails' rake tasks.
-- Dependence on a specific version of Webpacker.
-
-## [v1.1.0] - 2020-04-19
-
-### Changed
-
-- RuboCop formatting rules to more align with Rails' style guide.
-- TypeScript installation tasks based on Webpacker v5.1.0.
-- Rake tasks to extend ActiveSupport and utilize concurrent threading.
-
-## [v1.0.0] - 2020-04-17
-
-### Added
-
-- Gem specifications and foundational files, generated by Bundler v2.0.2, for defining a Ruby gem.
-- Hook into Rails' engine loader for conditional task loading.
-- Tasks replacing Yarn with pnpm for Webpacker v5.0.1, included as a submodule.
-- Test suite with dummy application.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog (<https://keepachangelog.com/en/1.0.0/>). This project adheres to Semantic Versioning (<https://semver.org/spec/v2.0.0.html>).
+
+## [v1.2.2] - 2023-01-13
+
+### Fixed
+
+- Watched paths for cross-version compatibility. (credit: [HipsterBrown](https://github.com/thearchitector/webpacker-pnpm/pull/4))
+
+## [v1.2.1] - 2020-05-16
+
+### Added
+
+- Informative error messages when pnpm is not installed.
+- Pessimistic gem dependency version specifications to avoid installation conflicts.
+- Full-length gem description.
+- Forced shameful hoisting of installed pnpm dependencies via `webpacker:pnpm_install`.
+- Practical Pig development dependency for external RuboCop linting.
+
+### Changed
+
+- Commented and adjusted RuboCop formatting rules to clarify design decisions.
+
+### Removed
+
+- Testing configs for bleeding-edge Rails.
+
+## [v1.2.0] - 2020-05-14
+
+### Added
+
+- Compatibility with Rails' Template API via command execution hooks and keyword substitution.
+- Support for existing Yarn Rake task dependence through task aliasing and redirection.
+- Additional Rake tasks to test injection and interception logic.
+- Utility method for concurrent and scoped `chdir` calls.
+
+### Changed
+
+- Gem dependencies to reflect up-to-date versions.
+- RuboCop formatting rules to support latest versions of Ruby.
+- Test application structure to allow application booting.
+- Rake task tests to utilize concurrent `chdir` calls.
+- Tests to support Rails <6.x `[bugfix]`.
+- Tests to support Ruby 2.4.9 `[bugfix]`.
+
+### Removed
+
+- Webpacker git submodule as method for replacing default Rails' rake tasks.
+- Dependence on a specific version of Webpacker.
+
+## [v1.1.0] - 2020-04-19
+
+### Changed
+
+- RuboCop formatting rules to more align with Rails' style guide.
+- TypeScript installation tasks based on Webpacker v5.1.0.
+- Rake tasks to extend ActiveSupport and utilize concurrent threading.
+
+## [v1.0.0] - 2020-04-17
+
+### Added
+
+- Gem specifications and foundational files, generated by Bundler v2.0.2, for defining a Ruby gem.
+- Hook into Rails' engine loader for conditional task loading.
+- Tasks replacing Yarn with pnpm for Webpacker v5.0.1, included as a submodule.
+- Test suite with dummy application.

data/Gemfile

@@ -1,17 +1,8 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-gem "rack-proxy", require: false
-gem "rails", ">= 5.2"
-gem "rake", ">= 12.3.3"
-gem "semantic_range", require: false
-
-install_if -> { Gem.win_platform? } do
-  gem "tzinfo-data"
-end
-
-group :test do
-  gem "minitest", ">= 5"
-end
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+install_if -> { Gem.win_platform? } do
+  gem "tzinfo-data"
+end

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Elias Gabriel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,35 +1,33 @@
-# webpacker-pnpm
-
-![version](https://img.shields.io/gem/v/webpacker-pnpm?label=version&style=flat-square)
-[![status](https://img.shields.io/travis/thearchitector/webpacker-pnpm?style=flat-square)](https://travis-ci.org/github/thearchitector/webpacker-pnpm)
-![downloads](https://img.shields.io/gem/dt/webpacker-pnpm?style=flat-square)
-[![license](https://img.shields.io/badge/license-CC--BY--NC--SA--4.0-green?style=flat-square)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
-
-`webpacker-pnpm` replaces Rails' Yarn environment with [pnpm](https://pnpm.js.org/), which is a much smarter, efficient, and faster alternative Node.js package manager. You can read about the philosophy and technology behind `pnpm` in [this convincing blog post](https://www.kochan.io/nodejs/why-should-we-use-pnpm.html) by Zoltan Kochan, but in essence it reduces dependency resolution times and `node_modules` folder sizes to within reasonable ranges (not 30 seconds and 10 GiB).
-
-## Features
-
-- Production-ready
-- Drop-in seamless replacement for Yarn, no config required
-- Supports Rails' Template API, including existing templates using Yarn
-- Independent of official Webpacker versions
-- Provides code sanity without the migraines
-- Gives you more disk space
-
-## Installation
-
-In order to use `webpacker-pnpm`, you must install `pnpm`. The official instructions are [here](https://pnpm.js.org/en/installation), but all they say is to run the following command:
-
-```sh
-$ curl -L https://raw.githubusercontent.com/pnpm/self-installer/master/install.js | node
-```
-
-After installing `pnpm`, simply add `webpacker-pnpm` to your app's `Gemfile`. There is no need to worry about your official Webpacker gem version, as this gem should be version-agnostic.
-
-```ruby
-gem "webpacker-pnpm"
-```
-
-## License
-
-This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. To view a copy of this license, visit <http://creativecommons.org/licenses/by-nc-sa/4.0/> or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+# webpacker-pnpm
+
+[![version](https://img.shields.io/gem/v/webpacker-pnpm?label=version&style=flat-square)](https://rubygems.org/gems/webpacker-pnpm)
+[![status](https://img.shields.io/github/actions/workflow/status/thearchitector/webpacker-pnpm/ci.yaml?label=tests&style=flat-square)](https://travis-ci.org/github/thearchitector/webpacker-pnpm)
+[![downloads](https://img.shields.io/gem/dt/webpacker-pnpm?style=flat-square)](https://rubygems.org/gems/webpacker-pnpm)
+[![license](https://img.shields.io/github/license/thearchitector/webpacker-pnpm?style=flat-square)](LICENSE)
+[![Buy a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square)](https://ecologi.com/eliasgabriel?r=6128126916bfab8bd051026c)
+
+`webpacker-pnpm` replaces Rails' Yarn environment with [pnpm](https://pnpm.io), a better, smarter, and more efficient Node.js package manager. As a result, applications become less prone to dependency hell, more functional, more stable, and more flexible. And as an added bonus, dependency resolution times and `node_modules` folder sizes reduce to within reasonable ranges (not 45 seconds and 10 GiB).
+
+You can read about the philosophy and technology behind `pnpm` in [this convincing blog post](https://www.kochan.io/nodejs/why-should-we-use-pnpm) by Zoltan Kochan (<https://www.kochan.io/nodejs/why-should-we-use-pnpm>).
+
+## Features
+
+- Production-ready
+- Drop-in seamless replacement for Yarn, no config required
+- Supports Rails' Template API, including existing templates using Yarn
+- Provides code sanity without the migraines
+- Gives you more disk space
+
+## Installation
+
+In order to use `webpacker-pnpm`, you must install `pnpm`. The official instructions are [here](https://pnpm.io/installation). After installing `pnpm`, simply add `webpacker-pnpm` to your app's `Gemfile`.
+
+```ruby
+gem "webpacker-pnpm"
+```
+
+## License
+
+This software is licensed under the [BSD 3-Clause License](LICENSE).
+
+This package is Treeware. If you use it in production, consider buying the world a tree to thank me for my work. By contributing to my forest, you’ll be creating employment for local families and restoring wildlife habitats.

data/Rakefile

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -1,15 +1,15 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "webpacker/pnpm"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "webpacker/pnpm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/webpacker/pnpm/patches.rb

@@ -1,53 +1,61 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-require "webpacker/runner"
-require "webpacker/compiler"
-
-module Webpacker
-  module PNPM
-    # remove Yarn's lockfile from and add pnpm's lockfile to the default list of
-    # watched paths
-    Webpacker::Compiler.class_eval do
-      def default_watched_paths
-        [
-          *config.resolved_paths_globbed,
-          config.source_path_globbed,
-          "pnpm-lock.yaml", "package.json",
-          "config/webpack/**/*"
-        ].freeze
-      end
-    end
-
-    # intercept command execution via Thor to replace yarn with pnpm. this exists in
-    # order to patch existing Webpacker installation templates that make direct
-    # calls to install Yarn dependencies. as a result, this isn't a robust patch
-    Rails::Generators::Actions.module_eval do
-      def run(command, config = {})
-        cmd = command.to_s
-
-        if cmd.include?("yarn")
-          cmd.gsub!("yarn", "pnpm")
-          cmd.gsub!("--dev", "--save-dev")
-        end
-
-        super(cmd, config)
-      end
-    end
-
-    # intercept generic task loading to clear and alias Yarn tasks
-    Rails::Engine.class_eval do
-      alias_method :unfiltered_tasks, :load_tasks
-
-      def load_tasks(_app = self)
-        unfiltered_tasks
-        # rather than clear the tasks, alias them to the new pnpm tasks so
-        # that any external code will still run
-        Rake::Task["webpacker:check_yarn"].clear.enhance(["webpacker:check_pnpm"])
-        Rake::Task["webpacker:yarn_install"].clear.enhance(["webpacker:pnpm_install"])
-        Rake::Task["webpacker:info"].clear.enhance(["webpacker:env"])
-        Rake::Task["yarn:install"].clear.enhance(["webpacker:pnpm_install"])
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "rails/generators"
+require "webpacker/runner"
+require "webpacker/compiler"
+
+module Webpacker
+  module PNPM
+    # remove Yarn's lockfile from and add pnpm's lockfile to the default list of
+    # watched paths
+    Webpacker::Compiler.class_eval do
+      def default_watched_paths
+        [
+          *configured_paths,
+          config.source_path_globbed,
+          "pnpm-lock.yaml", "package.json",
+          "config/webpack/**/*"
+        ].freeze
+      end
+
+      def configured_paths
+        if config.method_defined?(:additional_paths_globbed)
+          config.additional_paths_globbed
+        else
+          config.resolved_paths_globbed
+        end
+      end
+    end
+
+    # intercept command execution via Thor to replace yarn with pnpm. this exists in
+    # order to patch existing Webpacker installation templates that make direct
+    # calls to install Yarn dependencies. as a result, this isn't a robust patch
+    Rails::Generators::Actions.module_eval do
+      def run(command, config = {})
+        cmd = command.to_s
+
+        if cmd.include?("yarn")
+          cmd.gsub!("yarn", "pnpm")
+          cmd.gsub!("--dev", "--save-dev")
+        end
+
+        super(cmd, config)
+      end
+    end
+
+    # intercept generic task loading to clear and alias Yarn tasks
+    Rails::Engine.class_eval do
+      alias_method :unfiltered_tasks, :load_tasks
+
+      def load_tasks(_app = self)
+        unfiltered_tasks
+        # rather than clear the tasks, alias them to the new pnpm tasks so
+        # that any external code will still run
+        Rake::Task["webpacker:check_yarn"].clear.enhance(["webpacker:check_pnpm"])
+        Rake::Task["webpacker:yarn_install"].clear.enhance(["webpacker:pnpm_install"])
+        Rake::Task["webpacker:info"].clear.enhance(["webpacker:env"])
+        Rake::Task["yarn:install"].clear.enhance(["webpacker:pnpm_install"])
+      end
+    end
+  end
+end