defra_ruby_template 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44a6552ed7efbac194e9ad18ca3b89790962a374e138038b963cc3612242f14
-  data.tar.gz: c54f85edbb5c6f44c01b236ba5ff25858df2f2607573a0738a60206e33cb5427
+  metadata.gz: 42e02e87fae59b0d67acc88406a2d4505cb4a426bc04628ef7dacdb64fe87fcc
+  data.tar.gz: ef0fdc6b77bd8705ce78e87eafb34ab6490a83b552f776e9ee56fad049db301d
 SHA512:
-  metadata.gz: ea3b66c2cdcfc820e4b75f502fe4fe4c5af7af10bfcd2a161bed5b7d6fa017a38f471028df605059d146dcfcfc1c58b0404e756aabbc2964d1a48bb0880b30c2
-  data.tar.gz: fd08b5eac1fb61b6b43302837ecbab4b364f7fc2eefa9b1035b33a39d7982329e48bd3d7421f1661c0e22a6f764b18ea6625e74b74671f7b659c5bbeb8c763e0
+  metadata.gz: f421d6f36948c6ed6d2b8fcd536ed45ad6d70503b7b7388b77fa8f850afe073bde4b7091f1861c5e798a1d027c07c0706cd8a0d94351b5607d5effceaae20f49
+  data.tar.gz: 422abfcd9c4f675fc454e8569f46adeb933ff78715e7693db336afb11b11abd46fc4594a6f6d51d7b6f2470cc7a5a18a12793da3be44907fe832db1314bc9850

data/README.md

@@ -9,8 +9,9 @@
 
 Adds a GOV.UK-ready layout template and the [govuk_frontend assets](https://github.com/alphagov/govuk-frontend) to a Rails application.
 
-The gem's version tracks the version of govuk-frontend it vendors, so 6.4.0 of
-this gem ships govuk-frontend 6.4.0.
+The gem's major and minor version track the version of govuk-frontend it
+vendors, so 6.6.x of this gem ships govuk-frontend 6.6.0. Patch releases are
+changes to the gem itself.
 
 ## Installation
 
@@ -62,6 +63,31 @@ provides with `content_for`, then render it:
 <%= render template: "layouts/defra_ruby_template" %>
 ```
 
+### Stylesheets
+
+The gem's stylesheet entry point is a Sass module. Load it from the
+application's own stylesheet with `@use`:
+
+```scss
+@use "defra_ruby_template" as *;
+```
+
+That emits govuk-frontend's CSS and makes its settings, tools and helpers
+available unprefixed, the way `@import` did - `govuk-colour`, `govuk-font`,
+`$govuk-text-colour` and so on. The same rule configures govuk-frontend's own
+settings:
+
+```scss
+@use "defra_ruby_template" as * with (
+  $govuk-assets-path: "/custom-assets/"
+);
+```
+
+Unlike `@import`, a `@use` applies only to the file it appears in, and it has
+to come before any other rule in that file. A partial that is still
+`@import`ed is pulled into the importing file's scope, so it keeps working
+untouched - only a partial loaded with `@use` needs its own `@use` line.
+
 ## Requirements
 
 ### Dart Sass
@@ -88,29 +114,23 @@ to the Gemfile:
 gem "dartsass-sprockets"
 ```
 
-`dartsass-rails` is the other option. It compiles outside Sprockets, which means
-the Rails asset helpers are not available as Sass functions - this gem's
-stylesheet detects that and falls back to govuk-frontend's own
-`$govuk-assets-path`, but any application stylesheet calling `image-url` or
-`font-url` would need rewriting. Serving the prebuilt
+`dartsass-rails` will not work. It compiles outside Sprockets, so the Rails
+asset helpers are not registered as Sass functions and this gem's stylesheet
+fails to compile. Serving the prebuilt
 `vendor/assets/stylesheets/govuk-frontend.min.css` and dropping SCSS compilation
-altogether is a third option, but it gives up the settings, tools and helpers
+altogether is the other option, but it gives up the settings, tools and helpers
 that application stylesheets use.
 
-Dart Sass warns that `@import` is deprecated. Sprockets stylesheets are built on
-`@import`, so until Rails' asset pipeline moves to `@use` these warnings are
-expected. Silence them per application with:
-
-```ruby
-config.sass.silence_deprecations = ["import"]
-```
+Dart Sass warns that `@import` is deprecated. Nothing the gem ships uses it, so
+an application that loads the gem with `@use` and has converted its own
+partials does not need `config.sass.silence_deprecations = ["import"]`.
 
 [dartsass-sprockets]: https://github.com/tablecheck/dartsass-sprockets
 
 ### govuk_design_system_formbuilder
 
-Pin `govuk_design_system_formbuilder` to `~> 6.4.0`. That is the release that
-tracks govuk-frontend 6.4.0; earlier 6.x releases target earlier govuk-frontend
+Pin `govuk_design_system_formbuilder` to `~> 6.6.0`. That is the release that
+tracks govuk-frontend 6.6.0; earlier 6.x releases target earlier govuk-frontend
 6.x versions, and 5.x emits govuk-frontend 5 markup.
 
 ### Content Security Policy
@@ -125,10 +145,44 @@ This gem instead ships that one statement as an asset,
 `<body>`. No inline script is used, so no `unsafe-inline` or nonce is needed for
 it.
 
+## Upgrading from 6.4.0
+
+6.6.0 vendors govuk-frontend 6.6.0, and turns the stylesheet entry point from
+an `@import` shim into a Sass module so that neither Sass nor govuk-frontend
+emits a deprecation warning. The gem now only compiles under Sprockets, which
+is what registers the Rails asset helpers as Sass functions.
+
+In each application:
+
+1. Pin `govuk_design_system_formbuilder` to `~> 6.6.0`.
+2. Replace `@import "defra_ruby_template"` with `@use "defra_ruby_template" as *`
+   at the top of the stylesheet. Partials it `@import`s keep working as they are.
+3. Convert those `@import`s to `@use` too, giving each partial that uses
+   govuk-frontend's settings, tools or helpers its own `@use` line.
+4. Drop `config.sass.silence_deprecations = ["import"]`.
+
+`@import "defra_ruby_template"` still works, so the steps can be taken
+separately, but it keeps the deprecation warning.
+
+govuk-frontend 6.5 and 6.6 carry no breaking changes. They add the Language
+navigation and Feedback components, both in trial status, and deprecate three
+organisation colours following the July 2026 machinery of government changes.
+
+### Deprecated colour names
+
+govuk-frontend 6 renamed the colour palette. The old names still resolve, but
+each one warns - replace them with the name the warning gives, for example
+`govuk-colour("black", $variant: "tint-95")` for `govuk-colour("light-grey")`.
+
+Adding `pre-brand-colour` to `$govuk-suppressed-warnings` does not silence it:
+govuk-frontend 6.6.0 calls an undefined `_should-warn()` in
+`helpers/_colour.scss`, which Sass falls back to treating as a plain CSS
+function, so the suppression check is always true.
+
 ## Upgrading from 5.x
 
 1. Move the application to a Dart Sass pipeline (see above).
-2. Update `govuk_design_system_formbuilder` to `~> 6.4.0`.
+2. Update `govuk_design_system_formbuilder` to `~> 6.6.0`.
 3. Replace the contents of the `:header_content` slot (see below).
 4. Check any application stylesheet or markup using classes govuk-frontend 6
    removed - `govuk-template--rebranded`, `govuk-header__content`,
@@ -183,7 +237,7 @@ writes three files that are generated rather than copied:
 
 | File | Generated from |
 |------|----------------|
-| `vendor/assets/stylesheets/defra_ruby_template.scss` | the entry point applications import |
+| `vendor/assets/stylesheets/defra_ruby_template.scss` | the entry point applications load |
 | `vendor/assets/javascripts/defra_ruby_template_supported.js` | the inline script in govuk-frontend's `template.njk` |
 | `vendor/assets/assets/manifest.json.erb` | govuk-frontend's `manifest.json`, with its icon paths rewritten to `asset_path` |
 

data/Rakefile

@@ -121,46 +121,23 @@ end
 # @use/@forward and ships sibling *.import.scss shims for @import callers. Both
 # need Dart Sass - LibSass does not implement the module system and quietly
 # emits the @use rules as literal CSS, producing a stylesheet with no styles in
-# it. Consuming apps import this file, so all it does is point the asset URL
-# helpers at Sprockets (when Sprockets is what is compiling it) and hand over to
-# govuk-frontend.
+# it. Consuming apps load this file, so all it does is point the asset URL
+# helpers at Sprockets and hand over to govuk-frontend.
 #
 # It deliberately no longer wraps govuk-frontend's all.scss, which exists only
 # to emit an "Importing using 'govuk/all' is deprecated" warning on every
 # compile.
 SCSS_ENTRY_POINT = <<~SCSS
-  // Compiled through Sprockets (sassc-rails, dartsass-sprockets) the Rails
-  // asset helpers are registered as Sass functions, so hand govuk-frontend
-  // their names and asset URLs resolve to digest paths. Compiled standalone
-  // (dartsass-rails, a plain `sass` run) they do not exist, and govuk-frontend
-  // falls back to $govuk-images-path / $govuk-fonts-path.
-  //
-  // The variables are declared before the @if so that the assignment inside it
-  // updates the global rather than creating one scoped to the @if.
+  // The gem is compiled through Sprockets (dartsass-sprockets), which registers
+  // the Rails asset helpers as Sass functions. Handing govuk-frontend references
+  // to them is what makes asset URLs come out as digest paths. Compiling this
+  // file outside Sprockets is not supported - meta.get-function raises there.
   @use "sass:meta";
 
-  $govuk-image-url-function: null;
-  $govuk-font-url-function: null;
-
-  @if meta.function-exists("image-url") {
-    $govuk-image-url-function: "image-url";
-  }
-
-  @if meta.function-exists("font-url") {
-    $govuk-font-url-function: "font-url";
-  }
-
-  // Passing the helpers by name is the only form available to @import users,
-  // and govuk-frontend deprecates it in favour of meta.get-function, which
-  // needs @use. Silence the warning until this file can be migrated.
-  $govuk-suppressed-warnings: ("image-url-string", "font-url-string");
-
-  // index.import rather than index: Dart Sass maps `@import "index"` onto
-  // index.import.scss itself, but Sprockets-based pipelines supply their own
-  // importer and resolve `index` to index.scss - the module entry point, which
-  // silently ignores the settings above and emits undigested asset URLs.
-  // Naming the shim explicitly makes both routes behave the same.
-  @import "index.import";
+  @forward "index" with (
+    $govuk-image-url-function: meta.get-function("image-url"),
+    $govuk-font-url-function: meta.get-function("font-url")
+  );
 SCSS
 
 def create_scss_file

data/lib/defra_ruby_template/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DefraRubyTemplate
-  VERSION = "6.4.0"
+  VERSION = "6.6.0"
 end