Task: Release Candidate v1.7.7

.gitignore

@@ -4,21 +4,51 @@
 # or operating system, you probably want to add a global ignore instead:
 #   git config --global core.excludesfile '~/.gitignore_global'
 
+# Ignore vscode config
+.vscode
+
+## Ignore bundler configuration:
+/.bundle
+/vendor/bundle
+/lib/bundler/man/
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
 !/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
 .byebug_history
-.github-token
-.tags
-/.bundle
-/db/*.sqlite3
-/db/*.sqlite3-journal
-/log/*.log
-/tmp
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
 /public/packs
 /public/packs-test
-/public/assets/
-coverage/
+/public/assets
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+/public/uploads
+
+### Rails specific ###
+.byebug_history
+/public/system
+/coverage/
+tmp
+
+# Ignore files specific to the development environment
 fc.json
 fc_simple.json
 index-names.txt
 index.json
 tags
+
+# Ignore dot files used by environment or IDE tools
+.tags
+.tool-versions
+.github-token
+.npmrc

.rubocop.yml

@@ -13,33 +13,42 @@ Layout/LineLength:
     - config/**/*
     - test/**/*
 
-Metrics/ClassLength:
+Lint/ConstantDefinitionInBlock:
   Exclude:
     - test/**/*
 
+Lint/DuplicateBranch:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+  Exclude:
+    - test/**/*
+    - lib/tasks/**/*
+
 Metrics/BlockLength:
   Max: 30
   Exclude:
     - test/**/*
     - lib/tasks/**/*
 
+Metrics/ClassLength:
+  CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
+  Exclude:
+    - test/**/*
+
 Metrics/MethodLength:
+  CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
   Exclude:
+    - test/**/*
     - lib/tasks/location.rake
 
-Style/FormatStringToken:
-  Enabled: false
-
 Style/Documentation:
   Exclude:
     - test/**/*
 
-Style/OptionalBooleanParameter:
+Style/FormatStringToken:
   Enabled: false
 
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - test/**/*
-
-Lint/DuplicateBranch:
+Style/OptionalBooleanParameter:
   Enabled: false

CHANGELOG.md

@@ -4,6 +4,42 @@ This app allows the user to explore HMLR price-paid open linked data.
 
 ## Changelog
 
+## 1.7.8 - 2024-09
+
+- (Jon) Moved all mirrored configuration settings from individual environments
+  into the application configuration to reduce the need to manage multiple
+  sources of truth
+- (Jon) Implemented improved boilerplate metrics integration to offer analysis
+  of current application usage stats
+- (Jon) Additional metrics from the Puma server to be exposed in the /metrics
+  endpoint via the puma-metrics gem
+- (Jon) Tweaked the application controller to improve error handling and
+  ensuring additional filtering for specific errors completes when able
+- (Jon) Reorganised makefile targets alphabetically as well as mirrored other
+  improvements from the other applications in the suite
+- (Jon) Updated .gitignore file to mirror the current approach in the other HMLR
+  apps
+- (Jon) Updated .rubocop.yml file with rules to reduce the need to set overrides
+  inline
+- (Jon) Updated the `lr_common_styles` gem to the latest 1.9.6 patch release.
+- (Dan) Fixes the bug search results not displaying
+  [232](https://github.com/epimorphics/ppd-explorer/issues/232)
+- (Dan) Adds page titles to download page and error page. Improves code dryness
+  [220](https://github.com/epimorphics/ppd-explorer/issues/220)
+- (Dan) Updates gemfile to use v1.9.5 lr_common_styles
+- (Dan) Adds more descriptive page titles
+  [220](https://github.com/epimorphics/ppd-explorer/issues/220)
+- (Dan) Adds search actions buttons to the top of the page
+  [226](https://github.com/epimorphics/ppd-explorer/issues/226)
+- (Dan) Increases target size of clickable elements to meet accessibility
+  requirments [GH-225](https://github.com/epimorphics/ppd-explorer/issues/225)
+- (Dan) updates the search results modal focus flow to meet accessibility
+  requirments [GH-216](https://github.com/epimorphics/ppd-explorer/issues/216)
+- (Dan) updates the form to meet various accessibility requirments
+  [GH-217](https://github.com/epimorphics/ppd-explorer/issues/217)
+- (Dan) updates the help modal focus flow to meet accessibility requirments
+  [GH-218](https://github.com/epimorphics/ppd-explorer/issues/218)
+
 ## 1.7.7 - 2024-09
 
 - (Jon) Updated search query processing and rendering to santise supplied input
@@ -31,7 +67,8 @@ This app allows the user to explore HMLR price-paid open linked data.
 
 - (Jon) Updated the `app/controllers/application_controller.rb` to include the
   `before_action` for the `change_default_caching_policy` method to ensure the
-  default `Cache-Control` header for all requests is set to 5 minutes (300 seconds).
+  default `Cache-Control` header for all requests is set to 5 minutes (300
+  seconds).
 
 ## 1.7.3 - 2023-06-07
 
@@ -58,8 +95,8 @@ This app allows the user to explore HMLR price-paid open linked data.
   Epimorphics specific gems locally during the development of those gems.
 - (Jon) Updated the production `data_services_api` gem version to be at least
   the current version`~>1.3.3` (this is to cover out of sync release versions)
-- (Jon) Updated the production `json_rails_logger` gem version to be at least the
-  current version `~>1.3.5` (this is to cover out of sync release versions)
+- (Jon) Updated the production `json_rails_logger` gem version to be at least
+  the current version `~>1.3.5` (this is to cover out of sync release versions)
 - (Jon) Updated the production `lr_common_styles` gem version to be at least the
   current version `~>1.9.1` (this is to cover out of sync release versions)
 - (Jon) Refactored better guards in `entrypoint.sh` to ensure the required env

Gemfile

@@ -72,17 +72,20 @@ gem 'prometheus-client', '~> 4.0'
 gem 'sentry-rails', '~> 5.2'
 gem 'yajl-ruby', require: 'yajl'
 
+gem 'puma-metrics'
+
+
 # rubocop:disable Layout/LineLength
 # TODO: While running the rails app locally for testing you can set gems to your local path
 # ! These "local" paths do not work with a docker image - use the repo instead
 # gem 'data_services_api', '~> 1.3.3', path: '~/Epimorphics/shared/data_services_api/'
 # gem 'json_rails_logger', '~>1.0.0', path: '~/Epimorphics/shared/json-rails-logger/'
-# gem 'lr_common_styles', '~> 1.9.3', path: '~/Epimorphics/clients/land-registry/projects/lr_common_styles/'
+# gem 'lr_common_styles', '~> 1.9.0', path: '~/Epimorphics/clients/land-registry/projects/lr_common_styles/'
 # rubocop:enable Layout/LineLength
 
 # TODO: In production you want to set this to the gem from the epimorphics package repo
 source 'https://rubygems.pkg.github.com/epimorphics' do
   gem 'data_services_api', '~> 1.3.3'
   gem 'json_rails_logger', '~>1.0.0'
-  gem 'lr_common_styles', '~> 1.9.3'
+  gem 'lr_common_styles', '~> 1.9.0' # set as this version as bundler breaks otherwise
 end

Gemfile.lock

@@ -210,6 +210,9 @@ GEM
     public_suffix (5.0.0)
     puma (5.6.7)
       nio4r (~> 2.0)
+    puma-metrics (1.2.5)
+      prometheus-client (>= 0.10)
+      puma (>= 5.0)
     racc (1.6.2)
     rack (2.2.8)
     rack-test (1.1.0)
@@ -345,14 +348,14 @@ GEM
       json
       lograge
       railties
-    lr_common_styles (1.9.3)
+    lr_common_styles (1.9.8)
       bootstrap-sass (~> 3.4.0)
       font-awesome-rails (~> 4.7.0.1)
       govuk_elements_rails (~> 2.0.0)
       govuk_frontend_toolkit (~> 4.18.1)
       govuk_template (~> 0.18.1)
       haml-rails (~> 2.0.0)
-      jquery-rails (~> 4.3.5)
+      jquery-rails (>= 4.3.5, < 4.7.0)
       lodash-rails (~> 4.17.14)
       modernizr-rails (~> 2.7.1)
       modulejs-rails (~> 2.2.0.0)
@@ -386,7 +389,7 @@ DEPENDENCIES
   json_expressions
   json_rails_logger (~> 1.0.0)!
   libv8-node (>= 16.10.0.0)
-  lr_common_styles (~> 1.9.3)!
+  lr_common_styles (~> 1.9.0)!
   memory_profiler
   minitest-rails
   minitest-reporters
@@ -395,6 +398,7 @@ DEPENDENCIES
   mocha
   prometheus-client (~> 4.0)
   puma
+  puma-metrics
   rails (< 6.0.0)
   rb-readline
   rubocop

Makefile

@@ -7,7 +7,6 @@ BUNDLER_VERSION?=$(shell tail -1 Gemfile.lock | tr -d ' ')
 ECR?=${ACCOUNT}.dkr.ecr.eu-west-1.amazonaws.com
 GPR_OWNER?=epimorphics
 NAME?=$(shell awk -F: '$$1=="name" {print $$2}' deployment.yaml | sed -e 's/[[:blank:]]//g')
-SHORTNAME?=$(shell echo ${NAME} | cut -f2 -d/)
 PAT?=$(shell read -p 'Github access token:' TOKEN; echo $$TOKEN)
 PORT?=3001
 RUBY_VERSION?=$(shell cat .ruby-version)
@@ -29,14 +28,14 @@ REPO?=${ECR}/${IMAGE}
 GITHUB_TOKEN=.github-token
 BUNDLE_CFG=.bundle/config
 
-all: image
-
 ${BUNDLE_CFG}: ${GITHUB_TOKEN}
 	@./bin/bundle config set --local rubygems.pkg.github.com ${GPR_OWNER}:`cat ${GITHUB_TOKEN}`
 
 ${GITHUB_TOKEN}:
 	@echo ${PAT} > ${GITHUB_TOKEN}
 
+all: image
+
 assets: auth
 	@./bin/bundle config set --local without 'development test'
 	@./bin/bundle install
@@ -49,6 +48,7 @@ check: lint test
 
 clean:
 	@[ -d public/assets ] && ./bin/rails assets:clobber || :
+	@@ rm -rf bundle coverage log node_modules
 
 image: auth
 	@echo Building ${REPO}:${TAG} ...
@@ -112,7 +112,6 @@ vars:
 	@echo "ECR = ${ECR}"
 	@echo "GPR_OWNER = ${GPR_OWNER}"
 	@echo "NAME = ${NAME}"
-	@echo "SHORTNAME = ${SHORTNAME}"
 	@echo "RUBY_VERSION = ${RUBY_VERSION}"
 	@echo "SHORTNAME = ${SHORTNAME}"
 	@echo "STAGE = ${STAGE}"

README.md

@@ -132,6 +132,36 @@ required configuration is captured in the `Makefile`.
 
 ### Locally
 
+Create a .bundle directory in the root of the application
+
+```sh
+mkdir .bundle
+
+cd bundle
+```
+
+Add a config file to the .bundle directory
+
+```sh
+touch config
+```
+
+Then edit the config file
+
+```sh
+nano config
+```
+
+In the config file add the following details
+
+BUNDLE_RUBYGEMS__PKG__GITHUB__COM: "epimorphics:< your git hub personal access token >"
+
+Then run
+
+```sh
+bundle install
+```
+
 For developing rails applications you can start the server locally using the
 following command:
 

app/assets/javascripts/modal.js

@@ -0,0 +1,61 @@
+document.addEventListener("DOMContentLoaded", function () {
+  function handleModal(
+    modalSelector,
+    focusableElementsSelector,
+    openButtonsSelector,
+    focusOnOpenIndex
+  ) {
+    if (focusOnOpenIndex === undefined) focusOnOpenIndex = 0
+
+    var modal = document.querySelector(modalSelector)
+    var focusableElements = modal.querySelectorAll(focusableElementsSelector)
+    var firstFocusableElement = focusableElements[0]
+    var lastFocusableElement = focusableElements[focusableElements.length - 1]
+    var focusOnOpenElement = focusableElements[focusOnOpenIndex]
+    var openButtons = document.querySelectorAll(openButtonsSelector)
+
+    function onModalOpen() {
+      if (modalSelector === "#help-dialog") {
+        setTimeout(function () {
+          focusOnOpenElement.focus()
+        }, 10)
+      }
+
+      document.addEventListener("keydown", function (e) {
+        var isTabPressed = e.key === "Tab"
+
+        if (!isTabPressed) {
+          return
+        }
+
+        if (e.shiftKey) {
+          if (document.activeElement === firstFocusableElement) {
+            lastFocusableElement.focus()
+            e.preventDefault()
+          }
+        } else {
+          if (document.activeElement === lastFocusableElement) {
+            firstFocusableElement.focus()
+            e.preventDefault()
+          }
+        }
+      })
+    }
+
+    openButtons.forEach(function (button) {
+      button.addEventListener("click", function (event) {
+        event.preventDefault()
+        onModalOpen()
+      })
+    })
+  }
+
+  handleModal("#bookmark-dialog", "input, .btn, .close", ".action-bookmark")
+
+  handleModal(
+    "#help-dialog",
+    ".close, .trouble-shooting, .email-address, .btn",
+    ".action-help",
+    1
+  )
+})