jsbundling-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0ef32480b80f6c274f0bb59e0785cf22aa157b19e688fcbebbe4544d195c81e
+  data.tar.gz: 131dffe9aa231f4a456452a3b9ba67f0d91d2079ebd3102a43c30c63bdc5f2a0
+SHA512:
+  metadata.gz: 22aa53c9b71baa3704f447ea717f9ccd2d7b489dbb17eb0885dd65fb94bb3d678ec15a5d74589c4c5c5ec8bbc89603cc2963b978f38047d28ba02b15b45d9638
+  data.tar.gz: db1a29cb7d04cf0e61cfdc0b03f44ffe766d12936ef7c5147cd704297726724f7317fa7aa89737b6978c628b157c0454675b98e4530e3067ec14d54ee0f755f0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 David Heinemeier Hansson
+
+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,29 @@
+# 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).
+
+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" %>`.
+
+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.
+
+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`).
+
+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).
+
+
+## Installation
+
+You must already have node and yarn installed on your system. 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`
+
+Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp -j [rollup|esbuild|webpack]`.
+
+
+## License
+
+rollup.js for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/application.js

@@ -0,0 +1 @@
+// Entry point for the build script in your package.json

data/lib/install/esbuild/install.rb

@@ -0,0 +1,3 @@
+say "Create default package.json and install esbuild"
+copy_file "#{__dir__}/package.json", "package.json"
+run "yarn add esbuild"

data/lib/install/esbuild/package.json

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

data/lib/install/install.rb

@@ -0,0 +1,23 @@
+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)
+
+if Rails.root.join(".gitignore").exist?
+  append_to_file ".gitignore", %(/app/assets/builds\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>/
+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.)
+end
+
+unless (app_js_entrypoint_path = Rails.root.join("app/javascript/application.js")).exist?
+  say "Create default entrypoint in app/javascript/application.js"
+  empty_directory app_js_entrypoint_path.parent.to_s
+  copy_file "#{__dir__}/application.js", app_js_entrypoint_path
+end

data/lib/install/rollup/install.rb

@@ -0,0 +1,4 @@
+say "Create default package.json and install rollup with config"
+copy_file "#{__dir__}/package.json", "package.json"
+copy_file "#{__dir__}/rollup.config.js", "rollup.config.js"
+run "yarn add rollup @rollup/plugin-node-resolve"

data/lib/install/rollup/package.json

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

data/lib/install/rollup/rollup.config.js

@@ -0,0 +1,13 @@
+import resolve from "@rollup/plugin-node-resolve"
+
+export default {
+  input: "app/javascript/application.js",
+  output: {
+    file: "app/assets/builds/application.js",
+    format: "es",
+    inlineDynamicImports: true
+  },
+  plugins: [
+    resolve()
+  ]
+}

data/lib/install/webpack/install.rb

@@ -0,0 +1,4 @@
+say "Create default package.json and install Webpack with config"
+copy_file "#{__dir__}/package.json", "package.json"
+copy_file "#{__dir__}/webpack.config.js", "webpack.config.js"
+run "yarn add webpack webpack-cli"

data/lib/install/webpack/package.json

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

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

@@ -0,0 +1,16 @@
+const path    = require("path")
+const webpack = require('webpack')
+
+module.exports = {
+  mode: "production",
+  entry: "./app/javascript/application.js",
+  output: {
+    filename: "application.js",
+    path: path.resolve(__dirname, "app/assets/builds"),
+  },
+  plugins: [
+    new webpack.optimize.LimitChunkCountPlugin({
+      maxChunks: 1
+    })
+  ]
+}

data/lib/jsbundling/engine.rb

@@ -0,0 +1,4 @@
+module Jsbundling
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/jsbundling/version.rb

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

data/lib/jsbundling-rails.rb

@@ -0,0 +1,5 @@
+module Jsbundling
+end
+
+require "jsbundling/version"
+require "jsbundling/engine"

data/lib/tasks/jsbundling/build.rake

@@ -0,0 +1,9 @@
+namespace :javascript do
+  desc "Build your JavaScript bundle"
+  task :build do
+    system "yarn install && yarn build"
+  end
+end
+
+Rake::Task["assets:precompile"].enhance(["javascript:build"])
+Rake::Task["test:prepare"].enhance(["javascript:build"])

data/lib/tasks/jsbundling/install.rake

@@ -0,0 +1,23 @@
+namespace :javascript do
+  namespace :install do
+    desc "Install shared elements for all bundlers"
+    task :shared do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/install.rb",  __dir__)}"
+    end
+
+    desc "Install esbuild"
+    task esbuild: "javascript:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/esbuild/install.rb",  __dir__)}"
+    end
+
+    desc "Install rollup.js"
+    task rollup: "javascript:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/rollup/install.rb",  __dir__)}"
+    end
+
+    desc "Install Webpack"
+    task webpack: "javascript:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/webpack/install.rb",  __dir__)}"
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jsbundling-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/install/application.js
+- lib/install/esbuild/install.rb
+- lib/install/esbuild/package.json
+- lib/install/install.rb
+- 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
+- lib/jsbundling/version.rb
+- lib/tasks/jsbundling/build.rake
+- lib/tasks/jsbundling/install.rake
+homepage: https://github.com/rails/jsbundling-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Bundle and transpile JavaScript in Rails with esbuild, rollup.js, or Webpack.
+test_files: []