Merge pull request #4821 from DFE-Digital/7833-install-turbo-rails

[7833] Install turbo-rails

Gemfile

@@ -8,6 +8,7 @@ ruby "3.3.5"
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem "rails", "~> 7.2"
 gem "sprockets-rails"
+gem "turbo-rails"
 
 # Use postgresql as the database for Active Record
 gem "pg", ">= 0.18", "< 2.0"

Gemfile.lock

@@ -706,6 +706,9 @@ GEM
     timecop (0.9.10)
     timeout (0.4.2)
     trailblazer-option (0.1.2)
+    turbo-rails (2.0.11)
+      actionpack (>= 6.0.0)
+      railties (>= 6.0.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uber (0.1.0)
@@ -858,6 +861,7 @@ DEPENDENCIES
   store_model (~> 4.1)
   strong_migrations
   timecop (~> 0.9.10)
+  turbo-rails
   tzinfo-data
   uk_postcode
   webmock

app/javascript/application.js

@@ -1,3 +1,5 @@
+import { Turbo } from '@hotwired/turbo-rails'
+
 import jQuery from 'jquery'
 
 import './scripts/global/nationality_select'
@@ -19,13 +21,17 @@ import CookieBanner from './scripts/cookie_banner'
 
 import { initAll } from 'govuk-frontend'
 
+Turbo.session.drive = false
+
 window.jQuery = jQuery
 window.$ = jQuery
 
-// Initialize GOV.UK Frontend components
-initAll()
+document.addEventListener('turbo:load', function () {
+  // Initialize GOV.UK Frontend components
+  initAll()
 
-// Initialize custom components
-LiveFilter.init()
-FilterToggle.init()
-CookieBanner.init()
+  // Initialize custom components
+  LiveFilter.init()
+  FilterToggle.init()
+  CookieBanner.init()
+})

app/javascript/scripts/components/form_components/lead_partners_autocomplete.js

@@ -13,8 +13,14 @@ const fetchLeadPartners = ({ query, populateResults }) => {
   window.fetch(`/autocomplete/lead_partners?query=${encodedQuery}`)
     .then(response => response.json())
     .then(guard)
-    .then((data) => data.lead_partners)
-    .then((data) => { if (data.length === 0) { statusMessage = 'No results found' } else { return data } })
+    .then(data => data.lead_partners)
+    .then((leadPartners) => {
+      if (leadPartners.length === 0) {
+        statusMessage = 'No results found'
+      }
+
+      return leadPartners
+    })
     .then(populateResults)
     .catch(console.log)
 }

app/views/layouts/application.html.erb

@@ -17,7 +17,7 @@
     <%= favicon_link_tag image_path('govuk-icon-180.png'), rel: 'apple-touch-icon', type: nil %>
 
     <%= stylesheet_link_tag "accessible-autocomplete/dist/accessible-autocomplete.min" %>
-    <%= stylesheet_link_tag "application" %>
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
 
     <% if google_analytics_allowed? %>
       <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':

app/views/trainees/employing_schools/details/edit.html.erb

@@ -6,9 +6,7 @@
 
 <div class="govuk-grid-row">
   <div class="govuk-grid-column-two-thirds-from-desktop">
-    <%= register_form_with model: @employing_school_form, url: trainee_employing_schools_details_path(@trainee), local: true,
-                           html: { data: { module: "app-schools-autocomplete" } } do |f| %>
-
+    <%= register_form_with model: @employing_school_form, url: trainee_employing_schools_details_path(@trainee) do |f| %>
       <%= f.govuk_error_summary %>
       <%= f.govuk_collection_radio_buttons :employing_school_not_applicable,
         @employing_school_form.employing_school_not_applicable_options,

app/views/trainees/lead_partners/details/edit.html.erb

@@ -6,8 +6,7 @@
 
 <div class="govuk-grid-row">
   <div class="govuk-grid-column-two-thirds-from-desktop">
-    <%= register_form_with model: @lead_partner_form, url: trainee_lead_partners_details_path(@trainee), local: true,
-                           html: { data: { module: "app-lead-partners-autocomplete" } } do |f| %>
+    <%= register_form_with model: @lead_partner_form, url: trainee_lead_partners_details_path(@trainee) do |f| %>
 
       <%= f.govuk_error_summary %>
       <%= f.govuk_collection_radio_buttons :lead_partner_not_applicable,

config/initializers/content_security_policy.rb

@@ -38,5 +38,6 @@
                     "https://www.googletagmanager.com",
                     "https://www.google-analytics.com",
                     "https://az416426.vo.msecnd.net") # needed for App Insights
+  policy.style_src(:self, "'sha256-WAyOw4V+FqDc35lQPyRADLBWbuNK8ahvYEaQIYF1+Ps='") # Turbo progress bar stylesheet https://github.com/hotwired/turbo/issues/809
   policy.font_src(:self, :data)
 end

package.json

@@ -1,47 +1,48 @@
-  {
-    "engines": {
-      "node": "20.x"
-    },
-    "scripts": {
-      "js:lint": "standard",
-      "js:lint:fix": "standard --fix",
-      "scss:lint": "stylelint 'app/assets/stylesheets/**/*.scss'",
-      "scss:lint:fix": "stylelint 'app/assets/stylesheets/**/*.scss' --fix",
-      "test": "jest",
-      "test:ci": "jest --ci --runInBand --coverage",
-      "build": "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds",
-      "build:css": "sass ./app/assets/stylesheets/application.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules --load-path=. --quiet-deps"
-    },
-    "dependencies": {
-      "@ministryofjustice/frontend": "^3.0.3",
-      "accessible-autocomplete": "^3.0.1",
-      "govuk-country-and-territory-autocomplete": "^2.0.0",
-      "govuk-frontend": "^5.7.1",
-      "jquery": "^3.7.1",
-      "rails-ujs": "^5.2.8",
-      "sass": "^1.81.0",
-      "turbolinks": "^5.2.0"
-    },
-    "devDependencies": {
-      "esbuild": "^0.24.0",
-      "esbuild-jest-transform": "^2.0.1",
-      "jest": "^29.7.0",
-      "jest-environment-jsdom": "^29.7.0",
-      "postcss": "^8.4.49",
-      "standard": "^17.1.2",
-      "stylelint": "^15.11.0",
-      "stylelint-config-gds": "^1.1.1",
-      "stylelint-config-standard-scss": "^11.1.0",
-      "stylelint-scss": "^5.3.2"
-    },
-    "standard": {
-      "env": [
-        "jest"
-      ]
-    },
-    "stylelint": {
-      "extends": "stylelint-config-gds/scss"
-    },
-    "license": "MIT",
-    "packageManager": "[email protected]"
-  }
+{
+  "engines": {
+    "node": "20.x"
+  },
+  "scripts": {
+    "js:lint": "standard",
+    "js:lint:fix": "standard --fix",
+    "scss:lint": "stylelint 'app/assets/stylesheets/**/*.scss'",
+    "scss:lint:fix": "stylelint 'app/assets/stylesheets/**/*.scss' --fix",
+    "test": "jest",
+    "test:ci": "jest --ci --runInBand --coverage",
+    "build": "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds",
+    "build:css": "sass ./app/assets/stylesheets/application.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules --load-path=. --quiet-deps"
+  },
+  "dependencies": {
+    "@hotwired/turbo-rails": "^8.0.12",
+    "@ministryofjustice/frontend": "^3.0.3",
+    "accessible-autocomplete": "^3.0.1",
+    "govuk-country-and-territory-autocomplete": "^2.0.0",
+    "govuk-frontend": "^5.7.1",
+    "jquery": "^3.7.1",
+    "rails-ujs": "^5.2.8",
+    "sass": "^1.81.0",
+    "turbolinks": "^5.2.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.24.0",
+    "esbuild-jest-transform": "^2.0.1",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "postcss": "^8.4.49",
+    "standard": "^17.1.2",
+    "stylelint": "^15.11.0",
+    "stylelint-config-gds": "^1.1.1",
+    "stylelint-config-standard-scss": "^11.1.0",
+    "stylelint-scss": "^5.3.2"
+  },
+  "standard": {
+    "env": [
+      "jest"
+    ]
+  },
+  "stylelint": {
+    "extends": "stylelint-config-gds/scss"
+  },
+  "license": "MIT",
+  "packageManager": "[email protected]"
+}

yarn.lock

@@ -474,6 +474,19 @@
   resolved "https://registry.yarnpkg.com/@eslint/js/-/js-8.55.0.tgz#b721d52060f369aa259cf97392403cb9ce892ec6"
   integrity sha512-qQfo2mxH5yVom1kacMtZZJFVdW+E70mqHMJvVg6WTLo+VBuQJ4TojZlfWBjK0ve5BdEeNAVxOsl/nvNMpJOaJA==
 
+"@hotwired/turbo-rails@^8.0.12":
+  version "8.0.12"
+  resolved "https://registry.yarnpkg.com/@hotwired/turbo-rails/-/turbo-rails-8.0.12.tgz#6f1a2661122c0a2bf717f3bc68b5106638798c89"
+  integrity sha512-ZXwu9ez+Gd4RQNeHIitqOQgi/LyqY8J4JqsUN0nnYiZDBRq7IreeFdMbz29VdJpIsmYqwooE4cFzPU7QvJkQkA==
+  dependencies:
+    "@hotwired/turbo" "^8.0.12"
+    "@rails/actioncable" "^7.0"
+
+"@hotwired/turbo@^8.0.12":
+  version "8.0.12"
+  resolved "https://registry.yarnpkg.com/@hotwired/turbo/-/turbo-8.0.12.tgz#50aa8345d7f62402680c6d2d9814660761837001"
+  integrity sha512-l3BiQRkD7qrnQv6ms6sqPLczvwbQpXt5iAVwjDvX0iumrz6yEonQkNAzNjeDX25/OJMFDTxpHjkJZHGpM9ikWw==
+
 "@humanwhocodes/config-array@^0.11.13":
   version "0.11.13"
   resolved "https://registry.yarnpkg.com/@humanwhocodes/config-array/-/config-array-0.11.13.tgz#075dc9684f40a531d9b26b0822153c1e832ee297"
@@ -845,6 +858,11 @@
     "@parcel/watcher-win32-ia32" "2.4.1"
     "@parcel/watcher-win32-x64" "2.4.1"
 
+"@rails/actioncable@^7.0":
+  version "7.2.200"
+  resolved "https://registry.yarnpkg.com/@rails/actioncable/-/actioncable-7.2.200.tgz#7f56b3313762dbb85b64490aa33c5f431419aafd"
+  integrity sha512-gVmi3MabEa+Bkatvw0/k1Y3WTidcIf3qNbb9L8qc+AmT2UmkVqUZhJpSLvKmH10twCYIGzn7yySW/lOpg81Duw==
+
 "@sinclair/typebox@^0.27.8":
   version "0.27.8"
   resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e"