govuk_web_banners 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82716ff793fe171809d1ddef0e06de382ddcd923c33e3e563b7a7b870a19eb2
-  data.tar.gz: 88bb6ac90018c9f77f9b948542b2efa5a325fe219c9c1f30f66758b6560e8736
+  metadata.gz: 72390441ea030c79a304774d614bafeea76076f348a7a18f1c91a0550d3b5e06
+  data.tar.gz: bb60e3fec30d355df9e3c2202f895b43ca96cd313c75703b16cf19d423e3c276
 SHA512:
-  metadata.gz: 290ab6c009769ace09e30135b865810d4bd92ced7d6093ac28bca5c03f97bdc4a1394a1e2acfb5f7fa2f83c59830d2e186a4d1f7fb0fd3b97d4c603ebf19b063
-  data.tar.gz: d12209e9cbf9002ed091fb505caa8b536d266be6253269aac7d15ba4393ca59112e97f80a2eaf013a6faad2ec3d27e9eb07d18a2fb5a6bdbbc4685ac0d30fb5e
+  metadata.gz: af4a88e99f13d25dd2ded6f765633771c709396690ebff903ad48dfc743f54e093555fbb55daa96f14937b51753e010234c43ffbdea46125a03e0b160383df9d
+  data.tar.gz: 004ae46414c0af964d0663c3a2a1bee921a6f7200cd545a9ca36f62695a77870d6fad34b9f8408a0198a6c5c574f316b495a123b5aa9a5543475dcea7b5e5308

data/README.md

@@ -206,17 +206,22 @@ banners:
   - /foreign-travel-advice
   start_date: 2024/10/21
   end_date: 2024/11/18
+  image: hmrc
 ```
 
 The required keys are `suggestion_text`, `suggestion_link_text`, and
 `survey_url` (the values to appear in the banner), and `page_paths` (an array of
 paths on which the banner should be shown).
 
-Optional keys are `name` (an identifying name for this banner, not rendered
-anywhere), and `start_date` / `end_date` (the banner becomes active at the start
-of the day specified as `start_date`, and stops at the *start* of the day
-specified as `end_date`). Start and end dates must be in the YYYY/MM/DD format
-parsable as a YAML -> Date.
+Optional keys are:
+- `name` (an identifying name for this banner, not rendered
+  anywhere)
+- `start_date` the banner becomes active at the *start* of the day specified.
+  Must be in the YYYY/MM/DD format parsable as a YAML -> Date.
+- `end_date` (the banner stops being active at the *start* of the day
+  specified). Must be in the YYYY/MM/DD format parsable as a YAML -> Date.
+- `image` an image name supported by the [interaction banner image option](https://components.publishing.service.gov.uk/component-guide/intervention#with_image)
+  Currently the only allowable value is `hmrc`.
 
 ### Validations on the recruitment banners config file
 

data/app/views/govuk_web_banners/_recruitment_banner.html.erb

@@ -6,6 +6,7 @@
       suggestion_text: recruitment_banner.suggestion_text,
       suggestion_link_text: recruitment_banner.suggestion_link_text,
       suggestion_link_url: recruitment_banner.survey_url,
+      image: recruitment_banner.image,
     } %>
   </div>
 <% end %>

data/config/govuk_web_banners/recruitment_banners.yml

@@ -1,17 +1,5 @@
 # Check README.md for how to format this file
 banners:
-- name: HMRC Comms & Guidance banner - Manual 2025/02/18
-  suggestion_text: "Help improve GOV.UK"
-  suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"
-  survey_url: https://survey.take-part-in-research.service.gov.uk/jfe/form/SV_74GjifgnGv6GsMC?Source=BannerList_HMRC_CT-Manual_TAD
-  page_paths:
-    # government-frontend
-    - /hmrc-internal-manuals/business-income-manual/bim30000
-    - /hmrc-internal-manuals/business-income-manual/bim37000
-    - /hmrc-internal-manuals/property-income-manual/pim1900
-    - /hmrc-internal-manuals/property-income-manual/pim2010
-  start_date: 2025/05/29
-  end_date: 2025/07/11
 - name: HMRC banner - Register VAT 2025/07/04
   suggestion_text: "Help improve GOV.UK"
   suggestion_link_text: "Sign up to take part in user research (opens in a new tab)"

data/lib/govuk_web_banners/recruitment_banner.rb

@@ -18,7 +18,7 @@ module GovukWebBanners
       recruitment_banners_data["banners"].map { |attributes| RecruitmentBanner.new(attributes:) }
     end
 
-    attr_reader :name, :suggestion_text, :suggestion_link_text, :survey_url, :page_paths, :start_date, :end_date
+    attr_reader :name, :suggestion_text, :suggestion_link_text, :survey_url, :page_paths, :start_date, :end_date, :image
 
     def initialize(attributes:)
       @name = attributes["name"]
@@ -28,6 +28,7 @@ module GovukWebBanners
       @page_paths = attributes["page_paths"]
       @start_date = attributes["start_date"] ? ActiveSupport::TimeZone[GovukWebBanners::TIME_ZONE].parse(attributes["start_date"]) : Time.at(0)
       @end_date = attributes["end_date"] ? ActiveSupport::TimeZone[GovukWebBanners::TIME_ZONE].parse(attributes["end_date"]) : Time.now + 10.years
+      @image = attributes["image"]
     end
 
     # NB: .between? is inclusive. To make it exclude the end date, we set the end range as

data/lib/govuk_web_banners/version.rb

@@ -1,3 +1,3 @@
 module GovukWebBanners
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_web_banners
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - GOV.UK Dev