jsbundling-rails 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0ef32480b80f6c274f0bb59e0785cf22aa157b19e688fcbebbe4544d195c81e
-  data.tar.gz: 131dffe9aa231f4a456452a3b9ba67f0d91d2079ebd3102a43c30c63bdc5f2a0
+  metadata.gz: 5b113c6e1687d0f4adf95e471b46bd54fc0096b3f999d62f11145f14253a656e
+  data.tar.gz: b59b92d84c86299b4ced4902c41f954e97131c5ea4a94edbc8390e65ba16ce31
 SHA512:
-  metadata.gz: 22aa53c9b71baa3704f447ea717f9ccd2d7b489dbb17eb0885dd65fb94bb3d678ec15a5d74589c4c5c5ec8bbc89603cc2963b978f38047d28ba02b15b45d9638
-  data.tar.gz: db1a29cb7d04cf0e61cfdc0b03f44ffe766d12936ef7c5147cd704297726724f7317fa7aa89737b6978c628b157c0454675b98e4530e3067ec14d54ee0f755f0
+  metadata.gz: d4d017b80b7a35e3bb10679dc4c996a484a19b3cd0083c2d0f16bb52caafe48ade12ab4d92eb06210526471cf784ee8b6476a4fee04a12223c95d8473971fba3
+  data.tar.gz: c72ec41731afdad48d9b2e5e852b2d3a3ea95a915b0e0a7ffcbbb20784625afcdd727fc3bf2687261cca0d0a70acd2d867f0dd2923598789f8e1a8354ec76a7e

data/README.md

@@ -1,29 +1,33 @@
 # JavaScript Bundling for Rails
 
-Use [esbuild](https://esbuild.github.io), [rollup.js](https://rollupjs.org), or [Webpack](https://webpack.js.org) to bundle your JavaScript, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/bundles` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
+Use [esbuild](https://esbuild.github.io), [rollup.js](https://rollupjs.org), or [Webpack](https://webpack.js.org) to bundle your JavaScript, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/builds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
 
-You develop using this approach by running the bundler in watch mode in a terminal with `yarn build --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/bundles/javascript.js` (and all other entry points placed in the root of `app/javascript`). You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application" %>`.
+You develop using this approach by running the bundler in watch mode in a terminal with `yarn build --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the JavaScript files in your project, it'll bundle `app/javascript/application.js` into `app/assets/builds/application.js` (and all other entry points configured). You can refer to the build output in your layout using the standard asset pipeline approach with `<%= javascript_include_tag "application", defer: true %>`.
 
-When you deploy your application to production, the bundler attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via npm, and then runs `yarn build` to process all the entry points, as it would in development. The latter files are then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
+When you deploy your application to production, the `javascript:build` task attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via yarn, and then runs `yarn build` to process all the entry points, as it would in development. The latter files are then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
 
 This also happens in testing where the bundler attaches to the `test:prepare` task to ensure the JavaScript has been bundled before testing commences. (Note that this currently only applies to rails `test:*` tasks (like `test:all` or `test:controllers`), not "rails test", as that doesn't load `test:prepare`).
 
+If your testing library of choice does not define a `test:prepare` Rake task, ensure that your test suite runs `javascript:build` to bundle JavaScript before testing commences.
+
 That's it!
 
-You can configure your bundler options in the `build` script in `package.json` or via the installer-generated rollup.config.js for rollup.js or webpack.config.json for Webpack (esbuild does not have a default configuration format).
+You can configure your bundler options in the `build` script in `package.json` or via the installer-generated `rollup.config.js` for rollup.js or `webpack.config.json` for Webpack (esbuild does not have a default configuration format).
+
+If you're already using [`webpacker`](https://github.com/rails/webpacker) and you're wondering if you should migrate to `jsbundling-rails`, have a look at [the high-level comparison](./docs/comparison_with_webpacker.md).
 
 
 ## Installation
 
-You must already have node and yarn installed on your system. Then:
+You must already have node and yarn installed on your system. You will also need npx version 7.1.0 or later. Then:
 
 1. Add `jsbundling-rails` to your Gemfile with `gem 'jsbundling-rails'`
 2. Run `./bin/bundle install`
-3. Run `./bin/rails javascript:[rollup|esbuild|webpack]:install`
+3. Run `./bin/rails javascript:install:[esbuild|rollup|webpack]`
 
-Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp -j [rollup|esbuild|webpack]`.
+Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp -j [esbuild|rollup|webpack]`.
 
 
 ## License
 
-rollup.js for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).
+JavaScript Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/Procfile.dev

@@ -0,0 +1,2 @@
+web: bin/rails server -p 3000
+js: yarn build --watch

data/lib/install/dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+foreman start -f Procfile.dev

data/lib/install/esbuild/install.rb

@@ -1,3 +1,5 @@
-say "Create default package.json and install esbuild"
-copy_file "#{__dir__}/package.json", "package.json"
+say "Install esbuild"
 run "yarn add esbuild"
+
+say "Add build script"
+run %(npm set-script build "esbuild app/javascript/*.* --bundle --outdir=app/assets/builds")

data/lib/install/install.rb

@@ -1,19 +1,19 @@
 say "Compile into app/assets/builds"
 empty_directory "app/assets/builds"
 keep_file "app/assets/builds"
-append_to_file "app/assets/config/manifest.js", %(//= link_tree ../builds .js\n)
+append_to_file "app/assets/config/manifest.js", %(//= link_tree ../builds\n)
 
 if Rails.root.join(".gitignore").exist?
-  append_to_file ".gitignore", %(/app/assets/builds\n)
+  append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n/node_modules\n))
 end
 
 if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
   say "Add JavaScript include tag in application layout"
-  insert_into_file app_layout_path.to_s, 
-    %(\n    <%= javascript_include_tag "application", "data-track-turbo": "true", defer: true %>), before: /\s*<\/head>/
+  insert_into_file app_layout_path.to_s,
+    %(\n    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>), before: /\s*<\/head>/
 else
   say "Default application.html.erb is missing!", :red
-  say %(        Add <%= javascript_include_tag "application", "data-track-turbo": "true", defer: true %> within the <head> tag in your custom layout.)
+  say %(        Add <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %> within the <head> tag in your custom layout.)
 end
 
 unless (app_js_entrypoint_path = Rails.root.join("app/javascript/application.js")).exist?
@@ -21,3 +21,22 @@ unless (app_js_entrypoint_path = Rails.root.join("app/javascript/application.js"
   empty_directory app_js_entrypoint_path.parent.to_s
   copy_file "#{__dir__}/application.js", app_js_entrypoint_path
 end
+
+unless Rails.root.join("package.json").exist?
+  say "Add default package.json"
+  copy_file "#{__dir__}/package.json", "package.json"
+end
+
+if Rails.root.join("Procfile.dev").exist?
+  append_to_file "Procfile.dev", "js: yarn build --watch"
+else
+  say "Add default Procfile.dev"
+  copy_file "#{__dir__}/Procfile.dev", "Procfile.dev"
+
+  say "Ensure foreman is installed"
+  run "gem install foreman"
+end
+
+say "Add bin/dev to start foreman"
+copy_file "#{__dir__}/dev", "bin/dev"
+chmod "bin/dev", 0755, verbose: false

data/lib/install/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "app",
+  "private": "true"
+}

data/lib/install/rollup/install.rb

@@ -1,4 +1,6 @@
-say "Create default package.json and install rollup with config"
-copy_file "#{__dir__}/package.json", "package.json"
+say "Install rollup with config"
 copy_file "#{__dir__}/rollup.config.js", "rollup.config.js"
 run "yarn add rollup @rollup/plugin-node-resolve"
+
+say "Add build script"
+run %(npm set-script build "rollup -c rollup.config.js")

data/lib/install/webpack/install.rb

@@ -1,4 +1,6 @@
-say "Create default package.json and install Webpack with config"
-copy_file "#{__dir__}/package.json", "package.json"
+say "Install Webpack with config"
 copy_file "#{__dir__}/webpack.config.js", "webpack.config.js"
 run "yarn add webpack webpack-cli"
+
+say "Add build script"
+run %(npm set-script build "webpack --config webpack.config.js")

data/lib/install/webpack/webpack.config.js

@@ -3,9 +3,11 @@ const webpack = require('webpack')
 
 module.exports = {
   mode: "production",
-  entry: "./app/javascript/application.js",
+  entry: {
+    application: "./app/javascript/application.js"
+  },
   output: {
-    filename: "application.js",
+    filename: "[name].js",
     path: path.resolve(__dirname, "app/assets/builds"),
   },
   plugins: [

data/lib/jsbundling/version.rb

@@ -1,3 +1,3 @@
 module Jsbundling
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/lib/tasks/jsbundling/build.rake

@@ -6,4 +6,9 @@ namespace :javascript do
 end
 
 Rake::Task["assets:precompile"].enhance(["javascript:build"])
-Rake::Task["test:prepare"].enhance(["javascript:build"])
+
+if Rake::Task.task_defined?("test:prepare")
+  Rake::Task["test:prepare"].enhance(["javascript:build"])
+elsif Rake::Task.task_defined?("db:test:prepare")
+  Rake::Task["db:test:prepare"].enhance(["javascript:build"])
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: jsbundling-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: 
 email: david@loudthinking.com
 executables: []
@@ -32,15 +46,15 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- lib/install/Procfile.dev
 - lib/install/application.js
+- lib/install/dev
 - lib/install/esbuild/install.rb
-- lib/install/esbuild/package.json
 - lib/install/install.rb
+- lib/install/package.json
 - lib/install/rollup/install.rb
-- lib/install/rollup/package.json
 - lib/install/rollup/rollup.config.js
 - lib/install/webpack/install.rb
-- lib/install/webpack/package.json
 - lib/install/webpack/webpack.config.js
 - lib/jsbundling-rails.rb
 - lib/jsbundling/engine.rb

data/lib/install/esbuild/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "app",
-  "private": "true",
-  "scripts": {
-    "build": "esbuild app/javascript/*.* --bundle --outdir=app/assets/builds"
-  }
-}

data/lib/install/rollup/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "app",
-  "private": "true",
-  "scripts": {
-    "build": "rollup -c rollup.config.js"
-  }
-}

data/lib/install/webpack/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "app",
-  "private": "true",
-  "scripts": {
-    "build": "webpack --config webpack.config.js"
-  }
-}