PLATUI-2526 add wrapper around deprecated HmrcLayout to surface depre…

…cation warning (#254)
hmrc · Oct 5, 2023 · e6131c6 · e6131c6
1 parent fe0226f
commit e6131c6
Show file tree

Hide file tree

Showing 3 changed files with 108 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 For compatibility information see `govukFrontendVersion` and `hmrcFrontendVersion` in
 [LibDependencies](project/LibDependencies.scala)
 
+## [7.22.0] - 2023-10-05
+
+### Changed
+
+- Added wrapper around deprecated HmrcLayout to surface deprecation warning that was being swallowed by Play
+
+### Compatible with
+
+- [hmrc/hmrc-frontend v5.49.0](https://github.com/hmrc/hmrc-frontend/releases/tag/v5.49.0)
+- [alphagov/govuk-frontend v4.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v4.7.0)
+
+
 ## [7.21.0] - 2023-09-29
 
 ### Changed

diff --git a/src/main/scala/uk/gov/hmrc/hmrcfrontend/views/html/helpers/HmrcLayout.scala b/src/main/scala/uk/gov/hmrc/hmrcfrontend/views/html/helpers/HmrcLayout.scala
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2023 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.hmrcfrontend.views.html.helpers
+
+import play.api.i18n.Messages
+import play.api.mvc.RequestHeader
+import play.twirl.api.{Html, HtmlFormat}
+import uk.gov.hmrc.govukfrontend.views.Aliases.{BackLink, PageLayout, PhaseBanner}
+import uk.gov.hmrc.govukfrontend.views.html.components.{FixedWidthPageLayout, TwoThirdsMainContent}
+import uk.gov.hmrc.hmrcfrontend.views.Aliases.Header
+
+import javax.inject.Inject
+
+class HmrcLayout @Inject() (
+  deprecatedHmrcLayout: DeprecatedHmrcLayout,
+  twoThirdsMainContent: TwoThirdsMainContent,
+  fixedWidthPageLayout: FixedWidthPageLayout
+) {
+  @deprecated(
+    "Use HmrcStandardPage template instead - see DeprecatedHmrcLayout for details of how HmrcLayout parameters map to HmrcStandardPage",
+    "6.3.0"
+  )
+  def apply(
+    serviceName: Option[String] = None,
+    pageTitle: Option[String] = None,
+    isWelshTranslationAvailable: Boolean = false,
+    signOutUrl: Option[String] = None,
+    serviceUrl: Option[String] = None,
+    userResearchBannerUrl: Option[String] = None,
+    accessibilityStatementUrl: Option[String] = None,
+    backLinkUrl: Option[String] = None,
+    displayHmrcBanner: Boolean = false,
+    phaseBanner: Option[PhaseBanner] = None,
+    additionalHeadBlock: Option[Html] = None,
+    additionalScriptsBlock: Option[Html] = None,
+    beforeContentBlock: Option[Html] = None,
+    mainContentLayout: Option[Html => Html] = Some(twoThirdsMainContent(_)),
+    additionalBannersBlock: Option[Html] = None,
+    pageLayout: Option[PageLayout => Html] = Some(fixedWidthPageLayout(_)),
+    headerContainerClasses: String = Header.defaultObject.containerClasses,
+    backLink: Option[BackLink] = None
+  )(contentBlock: Html)(implicit request: RequestHeader, messages: Messages): HtmlFormat.Appendable =
+    deprecatedHmrcLayout(
+      serviceName = serviceName,
+      pageTitle = pageTitle,
+      isWelshTranslationAvailable = isWelshTranslationAvailable,
+      signOutUrl = signOutUrl,
+      serviceUrl = serviceUrl,
+      userResearchBannerUrl = userResearchBannerUrl,
+      accessibilityStatementUrl = accessibilityStatementUrl,
+      backLinkUrl = backLinkUrl,
+      displayHmrcBanner = displayHmrcBanner,
+      phaseBanner = phaseBanner,
+      additionalHeadBlock = additionalHeadBlock,
+      additionalScriptsBlock = additionalScriptsBlock,
+      beforeContentBlock = beforeContentBlock,
+      mainContentLayout = mainContentLayout,
+      additionalBannersBlock = additionalBannersBlock,
+      pageLayout = pageLayout,
+      headerContainerClasses = headerContainerClasses,
+      backLink = backLink
+    )(contentBlock)
+}
diff --git a/...ntend/views/helpers/HmrcLayout.scala.html → ...s/helpers/DeprecatedHmrcLayout.scala.html b/...ntend/views/helpers/HmrcLayout.scala.html → ...s/helpers/DeprecatedHmrcLayout.scala.html
@@ -23,7 +23,6 @@
 @import uk.gov.hmrc.govukfrontend.views.viewmodels.pagelayout.PageLayout
 @import uk.gov.hmrc.hmrcfrontend.views.viewmodels.hmrcstandardpage._
 @import uk.gov.hmrc.govukfrontend.views.html.components.FixedWidthPageLayout
-@import uk.gov.hmrc.hmrcfrontend.views.Aliases.Header
 
 @this(
         hmrcStandardPage: HmrcStandardPage,
@@ -32,25 +31,25 @@
 )
 
 @(
-        serviceName: Option[String] = None,
-        pageTitle: Option[String] = None,
-        isWelshTranslationAvailable: Boolean = false,
-        signOutUrl: Option[String] = None,
-        serviceUrl: Option[String] = None,
-        userResearchBannerUrl: Option[String] = None,
-        accessibilityStatementUrl: Option[String] = None,
-        backLinkUrl: Option[String] = None,
-        displayHmrcBanner: Boolean = false,
-        phaseBanner: Option[PhaseBanner] = None,
-        additionalHeadBlock: Option[Html] = None,
-        additionalScriptsBlock: Option[Html] = None,
-        beforeContentBlock: Option[Html] = None,
-        mainContentLayout: Option[Html => Html] = Some(defaultMainContent(_)),
-        additionalBannersBlock: Option[Html] = None,
-        pageLayout: Option[PageLayout => Html] = Some(fixedWidthPageLayout(_)),
-        headerContainerClasses: String = Header.defaultObject.containerClasses,
-        backLink: Option[BackLink] = None
-)(@deprecated("HmrcLayout is deprecated, use HmrcStandardPage instead", "6.3.0") contentBlock: Html)(implicit request: RequestHeader, messages: Messages)
+        serviceName: Option[String],
+        pageTitle: Option[String],
+        isWelshTranslationAvailable: Boolean,
+        signOutUrl: Option[String],
+        serviceUrl: Option[String],
+        userResearchBannerUrl: Option[String],
+        accessibilityStatementUrl: Option[String],
+        backLinkUrl: Option[String],
+        displayHmrcBanner: Boolean,
+        phaseBanner: Option[PhaseBanner],
+        additionalHeadBlock: Option[Html],
+        additionalScriptsBlock: Option[Html],
+        beforeContentBlock: Option[Html],
+        mainContentLayout: Option[Html => Html],
+        additionalBannersBlock: Option[Html],
+        pageLayout: Option[PageLayout => Html],
+        headerContainerClasses: String,
+        backLink: Option[BackLink]
+)(contentBlock: Html)(implicit request: RequestHeader, messages: Messages)
 
 @require(!(backLinkUrl.isDefined && backLink.isDefined), "Use backLink or backLinkUrl, but not both")