Add show_review_banner configuration option

CHANGELOG.md

@@ -6,6 +6,8 @@ Selectively include only the CSS for the GOV.UK Frontend components that we are
 
 Fix service name to link to the configured `service_link`, rather than being hardcoded to `/` ([#119](https://github.com/alphagov/tech-docs-gem/issues/119))
 
+Add the `show_review_banner` global configuration option allowing users to hide the page review banner.
+
 ## 2.0.4
 
 Adds `footer_links` option for displaying links in the footer and ability to hide pages from left hand navigation.

docs/configuration.md

@@ -214,3 +214,15 @@ If set to `false`, the red banner will not appear when the page needs to be revi
 See the separate [documentation for page expiry][expiry] for more details.
 
 [expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+
+## `show_review_banner`
+
+Decides whether or not to display the page review banner, regardless of whether the page needs to be reviewed or not.
+
+If not present or set to `true`, the banner will be displayed on the page. This is the default behaviour.
+
+If set to `false`, the banner will not be displayed.
+
+See the separate [documentation for page expiry][expiry] for more details.
+
+[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review

docs/page-expiry.md

@@ -24,14 +24,13 @@ Setting `show_expiry: false` generates a blue banner with the last reviewed date
 This feature relies on JavaScript being enabled on the user's browser to
 display the relevant notices.
 
-If you want to disable the banners, but keep the review dates in the frontmatter, add the following to `source/javascripts/application.js`
+If you want to disable the banners, but keep the review dates in the frontmatter, add the following to your global configuration file:
 
-```js
-// Disable page expiry banner
-window.GOVUK.Modules.PageExpiry = null;
+```yaml
+show_review_banner: false
 ```
 
-For example if you do not want any page expiry banner at the bottom of the page, but want to have the review dates in the frontmatter for Daniel the Manual Spaniel to pick up.
+The page review banner will no longer appear at the bottom of the page, but Daniel the Manual Spaniel will still notify you about expired pages.
 
 ## Frontmatter configuration
 

lib/govuk_tech_docs/page_review.rb

@@ -40,6 +40,10 @@ def show_expiry?
       @config[:tech_docs].fetch(:show_expiry, true)
     end
 
+    def show_review_banner?
+      @config[:tech_docs].fetch(:show_review_banner, true)
+    end
+
   private
 
     def default_owner_slack

lib/source/layouts/_page_review.erb

@@ -1,4 +1,4 @@
-<% if current_page_review.under_review? %>
+<% if current_page_review.under_review? && current_page_review.show_review_banner? %>
   <div data-module='page-expiry' data-last-reviewed-on="<%= current_page_review.review_by %>">
     <div class='page-expiry--<%= current_page_review.show_expiry? ? "not-expired" : "default" %>'>
       This page was last reviewed on <%= format_date current_page_review.last_reviewed_on %>.

spec/features/page_expiration_spec.rb

@@ -20,12 +20,24 @@
     then_i_dont_see_review_date
   end
 
+  it "hides the review banner when show_review_banner is false" do
+    when_the_site_is_created_hiding_review_banner
+    and_i_visit_an_expired_page
+    then_i_dont_see_the_review_banner
+    and_i_visit_a_not_expired_page
+    then_i_dont_see_the_review_banner
+  end
+
   def when_the_site_is_created
     rebuild_site!
   end
 
   def when_the_site_is_created_hiding_expiry
-    rebuild_site!(config: "config/hide-expiry.yml")
+    rebuild_site!(overrides: { 'show_expiry' => false })
+  end
+
+  def when_the_site_is_created_hiding_review_banner
+    rebuild_site!(overrides: { 'show_review_banner' => false })
   end
 
   def and_i_visit_an_expired_page
@@ -47,4 +59,8 @@ def then_i_dont_see_the_page_has_expired
   def then_i_dont_see_review_date
     expect(page).to have_no_content "It needs to be reviewed again on"
   end
+
+  def then_i_dont_see_the_review_banner
+    expect(page).to have_no_content "This page was last reviewed"
+  end
 end

spec/spec_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'govuk_tech_docs'
+require 'tempfile'
+require 'yaml'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -21,16 +23,25 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  def rebuild_site!(config: "config/tech-docs.yml")
-    command = [
-      "cd example",
-      "rm -rf build",
-      "bundle install --quiet",
-      "CONFIG_FILE=#{config} NO_CONTRACTS=true middleman build --bail --show-exceptions"
-    ].join(" && ")
+  def rebuild_site!(config: "config/tech-docs.yml", overrides: {})
+    config_file = Tempfile.new('tech_docs_config')
 
-    unless system(command)
-      raise "`middleman build` failed, see the log for more info"
+    begin
+      Dir.chdir('example') do
+        new_config = YAML.load_file(config).merge(overrides)
+        config_file.write(YAML.dump(new_config))
+        config_file.close
+        command = [
+          "rm -rf build",
+          "bundle install --quiet",
+          "CONFIG_FILE=#{config_file.path} NO_CONTRACTS=true middleman build --bail --show-exceptions"
+        ].join(" && ")
+        unless system(command)
+          raise "`middleman build` failed, see the log for more info"
+        end
+      end
+    ensure
+      config_file.unlink
     end
   end