govuk_web_banners 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2da0fba12530084268d64be469b06f46454697dc78de6fc5bfb13ed6141ba85d
-  data.tar.gz: b7da4f881cac8b62d1d44532059eb824649a896c6709f29fbfd47aa364b4c612
+  metadata.gz: 6a3571d68045883e5fdf60e17b2f461bafc37f49bce4b3c6415390eb971fb950
+  data.tar.gz: 03bf2bc4754740f9ae7f283f8fd4e8c5bb08a88645650a6d12c05788e3311e1c
 SHA512:
-  metadata.gz: f2b2a447dd4a38e7520af02a6e746cb5ae7671bd9c9ea8c1ade5f61566a7ed3f0c18f1cc4376d7bbfb227331c230f86bd3165014c5f7781a97400b4f7fed47fb
-  data.tar.gz: 215a49ec9b7f56db225428273e42b727bfe799f4defb3162119e7930725ab2658bfd232b3a7491e425df49a4c22f84d844ba9035e5614a6f5e3302a133e6f532
+  metadata.gz: 853e1c08455a797dbc02aaae5ff8b12a1d159176a947b1088d0262a7bb06e8d3d02b8f41c9f686de9185464f79bddf95f2b0cc5b16e082b2053ff0fb868cfeb7
+  data.tar.gz: 44da1a1b01a5a894d2b6e18c1c5732509b60483ac93606c7f13f5f1d4090efa940d157cd2c09bad54caac7b2273ba2e94fcccbb8c7e496bd9e57e8428811e816

data/Rakefile

@@ -14,6 +14,7 @@ RSpec::Core::RakeTask.new
 
 require "govuk_web_banners/validators/global_banner"
 require "govuk_web_banners/validators/recruitment_banner"
+require "govuk_web_banners/validators/uprating_banner"
 require "rainbow"
 
 def output_validator_info(validator, name)
@@ -57,4 +58,14 @@ rescue StandardError => e
   exit(1)
 end
 
-task default: %i[check_global_config check_recruitment_config rubocop spec]
+desc "show errors in the live uprating banner config"
+task :check_uprating_config do
+  validator = GovukWebBanners::Validators::UpratingBanner.new(GovukWebBanners::UpratingBanner.all_banners)
+  output_validator_info(validator, "uprating banner")
+rescue StandardError => e
+  puts(e)
+  puts Rainbow("Live uprating banner config could not be read (if there are no banners, check banner key is marked as an empty array - banners: [])").red
+  exit(1)
+end
+
+task default: %i[check_global_config check_recruitment_config check_uprating_config rubocop spec]

data/app/assets/stylesheets/govuk_web_banners/dependencies.scss

@@ -1,3 +1,4 @@
 @import 'govuk_publishing_components/components/emergency-banner';
 @import 'govuk_publishing_components/components/global-banner';
 @import 'govuk_publishing_components/components/intervention';
+@import 'govuk_publishing_components/components/notice';

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

@@ -0,0 +1,9 @@
+<% uprating_banner = GovukWebBanners::UpratingBanner.for_path(request.path) %>
+<% if uprating_banner.present? %>
+  <div class="govuk-!-margin-top-4">
+    <%= render "govuk_publishing_components/components/notice", {
+      title: uprating_banner.text,
+      show_banner_title: true
+    } %>
+  </div>
+<% end %>

data/config/govuk_web_banners/uprating_banners.yml

@@ -0,0 +1 @@
+banners: []

data/lib/govuk_web_banners/uprating_banner.rb

@@ -0,0 +1,37 @@
+module GovukWebBanners
+  class UpratingBanner
+    BANNER_CONFIG_FILE = "../../config/govuk_web_banners/uprating_banners.yml".freeze
+
+    def self.for_path(path)
+      active_banners.find do |banner|
+        return banner if banner.page_paths.include?(path)
+      end
+    end
+
+    def self.active_banners
+      all_banners.select(&:active?)
+    end
+
+    def self.all_banners
+      uprating_banners_urls_file_path = Rails.root.join(__dir__, BANNER_CONFIG_FILE)
+      uprating_banners_data = YAML.load_file(uprating_banners_urls_file_path)
+      uprating_banners_data["banners"].map { |attributes| UpratingBanner.new(attributes:) }
+    end
+
+    attr_reader :name, :text, :page_paths, :start_date, :end_date
+
+    def initialize(attributes:)
+      @name = attributes["name"]
+      @text = attributes["text"]
+      @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
+    end
+
+    # NB: .between? is inclusive. To make it exclude the end date, we set the end range as
+    #     1 second earlier.
+    def active?
+      Time.zone.now.between?(start_date, end_date - 1.second)
+    end
+  end
+end

data/lib/govuk_web_banners/version.rb

@@ -1,3 +1,3 @@
 module GovukWebBanners
-  VERSION = "1.31.0".freeze
+  VERSION = "1.32.0".freeze
 end

data/lib/govuk_web_banners.rb

@@ -4,6 +4,7 @@ require "govuk_web_banners/global_banner"
 require "govuk_web_banners/emergency_banner"
 require "govuk_web_banners/engine"
 require "govuk_web_banners/recruitment_banner"
+require "govuk_web_banners/uprating_banner"
 require "govuk_web_banners/version"
 
 module GovukWebBanners

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_web_banners
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -179,13 +179,16 @@ files:
 - app/views/govuk_web_banners/_emergency_banner.html.erb
 - app/views/govuk_web_banners/_global_banner.html.erb
 - app/views/govuk_web_banners/_recruitment_banner.html.erb
+- app/views/govuk_web_banners/_uprating_banner.html.erb
 - config/govuk_web_banners/global_banners.yml
 - config/govuk_web_banners/recruitment_banners.yml
+- config/govuk_web_banners/uprating_banners.yml
 - lib/govuk_web_banners.rb
 - lib/govuk_web_banners/emergency_banner.rb
 - lib/govuk_web_banners/engine.rb
 - lib/govuk_web_banners/global_banner.rb
 - lib/govuk_web_banners/recruitment_banner.rb
+- lib/govuk_web_banners/uprating_banner.rb
 - lib/govuk_web_banners/version.rb
 homepage: https://github.com/alphagov/govuk_web_banners
 licenses:
@@ -208,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.9
 specification_version: 4
 summary: A gem to support banners on GOV.UK frontend applications
 test_files: []