chore: upgrade example rails app and demonstrate config/vite.rb

Author: ElMassimo

examples/rails/Gemfile.lock

@@ -99,7 +99,7 @@ GEM
     ffi (1.15.3)
     globalid (0.5.2)
       activesupport (>= 5.0)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     jbuilder (2.11.2)
       activesupport (>= 5.0.0)
@@ -108,7 +108,7 @@ GEM
     listen (3.6.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.12.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -117,7 +117,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.0)
     mini_portile2 (2.6.1)
-    minitest (5.14.4)
+    minitest (5.15.0)
     msgpack (1.4.2)
     nio4r (2.5.8)
     nokogiri (1.12.5)
@@ -209,12 +209,12 @@ GEM
     turbolinks-source (5.2.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    vite_plugin_legacy (3.0.0)
-      vite_ruby (~> 3.0)
-    vite_rails (3.0.1)
+    vite_plugin_legacy (3.0.2)
+      vite_ruby (~> 3.0, >= 3.0.4)
+    vite_rails (3.0.3)
       railties (>= 5.1, < 8)
       vite_ruby (~> 3.0)
-    vite_ruby (3.0.2)
+    vite_ruby (3.0.6)
       dry-cli (~> 0.7.0)
       rack-proxy (~> 0.6, >= 0.6.1)
       zeitwerk (~> 2.2)

examples/rails/app/frontend/entrypoints/application.ts

@@ -13,6 +13,9 @@ import '~/styles/theme.css'
 import '~/entrypoints/example_import.js'
 import '~/outer_import.js'
 
+// Example: Import from an aliased path.
+import '@administrator/timer'
+
 // Import all channels.
 import.meta.globEager('../channels/**/*_channel.js')
 

examples/rails/config/vite.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+ViteRuby.env['ADMINISTRATOR_ASSETS_PATH'] =
+  "#{ Gem.loaded_specs['administrator'].full_gem_path }/app/frontend"

examples/rails/example_engine/app/frontend/entrypoints/application.js

@@ -1,14 +1,6 @@
-function startTimer (timer, loadedAt = new Date().getTime()) {
-  function updateTimer () {
-    const millisEllapsed = new Date().getTime() - loadedAt
-    timer.innerHTML = Math.floor(millisEllapsed / 1000)
-  }
-
-  setInterval(updateTimer, 200)
-}
+import { startTimer } from '~/timer'
 
 document.addEventListener('DOMContentLoaded', () => {
   console.log('Vite ⚡️ Rails: Engine')
   startTimer(document.getElementById('timer'))
 })
-

examples/rails/example_engine/app/frontend/timer.js

@@ -0,0 +1,8 @@
+export function startTimer (timer, loadedAt = new Date().getTime()) {
+  function updateTimer () {
+    const millisEllapsed = new Date().getTime() - loadedAt
+    timer.innerHTML = Math.floor(millisEllapsed / 1000)
+  }
+
+  setInterval(updateTimer, 200)
+}

examples/rails/package.json

@@ -28,7 +28,7 @@
     "vite-plugin-bugsnag": "^1.0.2",
     "vite-plugin-environment": "^1.0.0",
     "vite-plugin-full-reload": "^0.2",
-    "vite-plugin-ruby": "^3.0.3",
+    "vite-plugin-ruby": "^3.0.5",
     "vite-plugin-windicss": "^0.9"
   }
 }

examples/rails/vite.config.ts

@@ -41,4 +41,15 @@ export default defineConfig({
       },
     }),
   ],
+  // Example: Importing assets from arbitrary paths.
+  resolve: {
+    alias: {
+      '@administrator/': `${process.env.ADMINISTRATOR_ASSETS_PATH}/`,
+    },
+  },
+  server: {
+    fs: {
+      allow: [process.env.ADMINISTRATOR_ASSETS_PATH!],
+    },
+  },
 })

examples/rails/yarn.lock

@@ -2244,10 +2244,10 @@ vite-plugin-full-reload@^0.2:
     chalk "^4.1"
     picomatch "^2.2.2"
 
-vite-plugin-ruby@^3.0.3:
-  version "3.0.3"
-  resolved "https://registry.yarnpkg.com/vite-plugin-ruby/-/vite-plugin-ruby-3.0.3.tgz#e5fcbeaafe28c4b2a448af3a20fcbaa44c81d6b9"
-  integrity sha512-RZMYOmhGwWwyDh00YIwKV2tO377Pqeke1bk3XJS5hBRGUnS5qgHLp6bqZH9yeLCxmlJ5kgWUzNkDmDDhV2BmNQ==
+vite-plugin-ruby@^3.0.5:
+  version "3.0.5"
+  resolved "https://registry.yarnpkg.com/vite-plugin-ruby/-/vite-plugin-ruby-3.0.5.tgz#b2601f832e043e023a07cea5a3bd87d24a8a1562"
+  integrity sha512-bFPnLxWxF1SyWtag24f48hYqLu0dydDs8tuIlvY60uHOY4yj6syCybZY21k3B9EgVtdGLve5twduj9bIoDuSug==
   dependencies:
     debug "^4.3.1"
     fast-glob "^3.2.4"