govuk_navigation_helpers 8.2.2 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1816b8fab85ec2930fcf6753fa2e004fe569dd4
-  data.tar.gz: 508d10c31eaf9a154fe4438cb1fb8dde4c8b00cd
+  metadata.gz: 6f8820828e39de3f4448cd51867ab33863f33171
+  data.tar.gz: ccc32400f50f9c8b52942861d56baea10cd5e745
 SHA512:
-  metadata.gz: d5ae309f9940333528a216fee3115c4bbcd7bb05767ffcf864221a958b87aae9c4668b178e9756094c99ca896a2fc722420419b2fd04808569f0809602261097
-  data.tar.gz: 4e494d267493f9f33db3fe46abe91685822d763a4acaad9bc18969a4b8f078042666c8a196ec47590b0c2f0a93b30969cdf864484ccd5a8f3ac372609082a66a
+  metadata.gz: 8b81687bb032f4b4811572a6b2c52339acfd28f635faa49ecd327f1fc17a36dec0277383ce238ca04c4e330d32e7650eb5c29b9f5223f7dbc27c9cf9f1cb717a
+  data.tar.gz: 3bbc43ff6e987c2a4295d9f249ba8fae74a704363c2a7b9157aa8bc60dbc89e804ea22f0591abc87d13d5e529bda9a45d0636da0ca3d0ee1e3b27f9cf60ebf6d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 9.0.0
+* Task lists are now called "step by step navigation".  Things have been renamed to support this
+* The (now) step nav component has an updated data format.  Updated /learn-to-drive-a-car to support this
+* Remove tasklist AB test code as we don't currently need to use this.
+
 ## 8.2.2
 * Remove get-a-divorce and end-a-civil-partnership content.  The schema is changing and these aren't live at the moment
 * Update secondary content list for learn-to-drive-a-car after performance analysis on which nav works better for these pages.

data/Rakefile

@@ -4,7 +4,7 @@ require "gem_publisher"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: [:spec, :lint]
+task default: %i(spec lint)
 
 desc "Publish gem to RubyGems"
 task :publish_gem do |_t|

data/config/step_navs/learn-to-drive-a-car.json

@@ -0,0 +1,248 @@
+{
+  "title": "Learn to drive a car: step by step",
+  "base_path": "/learn-to-drive-a-car",
+  "description": "<p>Check what you need to do to learn to drive.</p>",
+  "links": {
+    "breadcrumbs": [
+      { "title": "Home", "url": "/" },
+      { "title": "Driving and transport", "url": "/browse/driving"},
+      { "title": "Learning to drive", "url": "/browse/driving/learning-to-drive"}
+    ]
+  },
+  "related_paths": [
+    "/apply-for-your-full-driving-licence",
+    "/automatic-driving-licence-to-manual",
+    "/complain-about-a-driving-instructor",
+    "/driving-licence-fees",
+    "/driving-test-cost",
+    "/dvlaforms",
+    "/find-theory-test-pass-number",
+    "/government/publications/application-for-refunding-out-of-pocket-expenses",
+    "/government/publications/drivers-record-for-learner-drivers",
+    "/government/publications/driving-instructor-grades-explained",
+    "/government/publications/know-your-traffic-signs",
+    "/government/publications/l-plate-size-rules",
+    "/guidance/rules-for-observing-driving-tests",
+    "/report-an-illegal-driving-instructor",
+    "/report-driving-test-impersonation",
+    "/track-your-driving-licence-application",
+    "/driving-lessons-learning-to-drive/practising-with-family-or-friends",
+    "/driving-lessons-learning-to-drive/taking-driving-lessons",
+    "/driving-lessons-learning-to-drive/using-l-and-p-plates",
+    "/driving-test",
+    "/driving-test/changes-december-2017",
+    "/driving-test/disability-health-condition-or-learning-difficulty",
+    "/driving-test/driving-test-faults-result",
+    "/driving-test/test-cancelled-bad-weather",
+    "/driving-test/using-your-own-car",
+    "/driving-test/what-happens-during-test",
+    "/pass-plus/apply-for-a-pass-plus-certificate",
+    "/pass-plus/booking-pass-plus",
+    "/pass-plus/car-insurance-discounts",
+    "/pass-plus/local-councils-offering-discounts",
+    "/pass-plus/how-pass-plus-training-works",
+    "/theory-test",
+    "/theory-test/hazard-perception-test",
+    "/theory-test/if-you-have-safe-road-user-award",
+    "/theory-test/multiple-choice-questions",
+    "/theory-test/pass-mark-and-result",
+    "/theory-test/reading-difficulty-disability-or-health-condition"
+  ],
+  "step_by_step_nav": {
+    "steps": [
+      {
+        "title": "Check you're allowed to drive",
+        "contents": [
+          {
+            "type": "paragraph",
+            "text": "Most people can start learning to drive when they’re 17."
+          },
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/vehicles-can-drive",
+                "text": "Check what age you can drive"
+              },
+              {
+                "href": "/legal-obligations-drivers-riders",
+                "text": "Requirements for driving legally"
+              },
+              {
+                "href": "/driving-eyesight-rules",
+                "text": "Driving eyesight rules"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "Get a provisional driving licence",
+        "contents": [
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/apply-first-provisional-driving-licence",
+                "text": "Apply for your first provisional driving licence",
+                "context": "£34"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "Driving lessons and practice",
+        "contents": [
+          {
+            "type": "paragraph",
+            "text": "You need a provisional driving licence to take lessons or practice."
+          },
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/guidance/the-highway-code",
+                "text": "The Highway Code"
+              },
+              {
+                "href": "/driving-lessons-learning-to-drive",
+                "text": "Taking driving lessons"
+              },
+              {
+                "href": "/find-driving-schools-and-lessons",
+                "text": "Find driving schools, lessons and instructors"
+              },
+              {
+                "href": "/government/publications/car-show-me-tell-me-vehicle-safety-questions",
+                "text": "Practise vehicle safety questions"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "Prepare for your theory test",
+        "logic": "and",
+        "contents": [
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/theory-test/revision-and-practice",
+                "text": "Theory test revision and practice"
+              },
+              {
+                "href": "/take-practice-theory-test",
+                "text": "Take a practice theory test"
+              },
+              {
+                "href": "https://www.safedrivingforlife.info/shop/product/official-dvsa-theory-test-kit-app-app",
+                "text": "Theory and hazard perception test app"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "Book and manage your theory test",
+        "contents": [
+          {
+            "type": "paragraph",
+            "text": "You need a provisional driving licence to book your theory test."
+          },
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/book-theory-test",
+                "text": "Book your theory test",
+                "context": "£23"
+              },
+              {
+                "href": "/theory-test/what-to-take",
+                "text": "What to take to your test"
+              },
+              {
+                "href": "/change-theory-test",
+                "text": "Change your theory test appointment"
+              },
+              {
+                "href": "/check-theory-test",
+                "text": "Check your theory test appointment details"
+              },
+              {
+                "href": "/cancel-theory-test",
+                "text": "Cancel your theory test"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "Book and manage your driving test",
+        "contents": [
+          {
+            "type": "paragraph",
+            "text": "You must pass your theory test before you can book your driving test."
+          },
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/book-driving-test",
+                "text": "Book your driving test",
+                "context": "£62"
+              },
+              {
+                "href": "/driving-test/what-to-take",
+                "text": "What to take to your test"
+              },
+              {
+                "href": "/change-driving-test",
+                "text": "Change your driving test appointment"
+              },
+              {
+                "href": "/check-driving-test",
+                "text": "Check your driving test appointment details"
+              },
+              {
+                "href": "/cancel-driving-test",
+                "text": "Cancel your driving test"
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "title": "When you pass",
+        "contents": [
+          {
+            "type": "paragraph",
+            "text": "You can start driving as soon as you pass your driving test."
+          },
+          {
+            "type": "paragraph",
+            "text": "You must have an insurance policy that allows you to drive without supervision."
+          },
+          {
+            "type": "list",
+            "style": "required",
+            "contents": [
+              {
+                "href": "/pass-plus",
+                "text": "Find out about Pass Plus training courses"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}

data/govuk_navigation_helpers.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'govuk_navigation_helpers/version'
@@ -18,19 +19,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "gds-api-adapters", ">= 43.0"
-  spec.add_runtime_dependency 'govuk_ab_testing', '~> 2.4'
   spec.add_runtime_dependency 'activesupport', '~> 5.1'
+  spec.add_runtime_dependency 'gds-api-adapters', '>= 43.0'
+  spec.add_runtime_dependency 'govuk_ab_testing', '~> 2.4'
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "gem_publisher", "~> 1.5.0"
-  spec.add_development_dependency "govuk-lint", "~> 1.2.1"
-  spec.add_development_dependency "pry-byebug", "~> 3.4"
-  spec.add_development_dependency "yard", "~> 0.9.12"
+  spec.add_development_dependency "govuk-lint", "~> 3.6.0"
   spec.add_development_dependency "govuk_schemas", "~> 1.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "webmock", "~> 2.3"
+  spec.add_development_dependency "yard", "~> 0.9.12"
 
   spec.required_ruby_version = ">= 2.3.1"
 end

data/lib/govuk_navigation_helpers.rb

@@ -13,8 +13,7 @@ require_relative "govuk_navigation_helpers/related_navigation_sidebar"
 require_relative "govuk_navigation_helpers/rummager_taxonomy_sidebar_links"
 require_relative "govuk_navigation_helpers/curated_taxonomy_sidebar_links"
 
-require_relative "govuk_navigation_helpers/tasklist_content"
-require_relative "govuk_navigation_helpers/current_tasklist_ab_test"
+require_relative "govuk_navigation_helpers/step_nav_content"
 
 module GovukNavigationHelpers
   class NavigationHelper

data/lib/govuk_navigation_helpers/configuration.rb

@@ -19,8 +19,7 @@ module GovukNavigationHelpers
     end
 
     class NoStatsd
-      def increment(*)
-      end
+      def increment(*); end
 
       def time(*)
         yield

data/lib/govuk_navigation_helpers/step_nav_content.rb

@@ -0,0 +1,107 @@
+module GovukNavigationHelpers
+  class StepNavContent
+    STEP_NAV_NAMES = %w(
+      learn-to-drive-a-car
+    ).freeze
+
+    def self.current_step_nav(path)
+      STEP_NAV_NAMES.each do |step_nav_name|
+        step_nav = new(file_name: step_nav_name, path: path)
+        return step_nav if step_nav.current?
+      end
+      nil
+    end
+
+    def initialize(file_name: nil, path: nil)
+      @file_name = file_name
+      @path = path
+    end
+
+    def title
+      parsed_file.dig(:title)
+    end
+
+    def base_path
+      parsed_file.dig(:base_path)
+    end
+
+    def step_nav
+      parsed_file.dig(:step_by_step_nav)
+    end
+
+    def skip_link
+      "##{steps.first[:title].downcase.tr(' ', '-')}"
+    end
+
+    def primary_paths
+      primary_content.reject { |href|
+        href.start_with?('http')
+      }.select(&:present?)
+    end
+
+    def steps
+      step_nav.dig(:steps)
+    end
+
+    def related_paths
+      parsed_file.dig(:related_paths)
+    end
+
+    def set_current_step
+      set_step_as_active_if_current_page
+    end
+
+    def show_step_nav?
+      primary_paths.include?(path) ||
+        related_paths.include?(path)
+    end
+
+    def current?
+      primary_paths.include?(path) ||
+        related_paths.include?(path)
+    end
+
+  private
+
+    attr_reader :file_name, :file, :path
+
+    def set_step_as_active_if_current_page
+      steps.each_with_index do |step, step_index|
+        step[:contents].each do |content|
+          next unless content[:contents]
+
+          content[:contents].each do |link|
+            if link[:href] == path
+              link[:active] = true
+              step_nav[:show_step] = step_index + 1
+              step_nav[:highlight_step] = step_index + 1
+              return step_nav
+            end
+          end
+        end
+      end
+
+      step_nav
+    end
+
+    def primary_content
+      list_content = steps.flat_map do |step|
+        step[:contents].select { |item| item[:type] == "list" }
+        .flat_map { |item| item[:contents] }
+      end
+
+      list_content.map { |list_item| list_item[:href] }
+    end
+
+    def parsed_file
+      @parsed_file ||=
+        JSON.parse(
+          File.read(
+            File.join(File.dirname(__FILE__), "../../", "config", "step_navs", "#{file_name}.json")
+          )
+        ).deep_symbolize_keys.tap do |json_file|
+          json_file[:step_by_step_nav].merge!(small: true, heading_level: 3)
+        end
+    end
+  end
+end

data/lib/govuk_navigation_helpers/taxon_breadcrumbs.rb

@@ -9,14 +9,15 @@ module GovukNavigationHelpers
         {
           title: parent.title,
           url: parent.base_path,
-          is_page_parent: index == 0
+          is_page_parent: index.zero?
         }
       end
 
       ordered_parents << {
         title: "Home",
         url: "/",
-        is_page_parent: ordered_parents.empty? }
+        is_page_parent: ordered_parents.empty?
+}
 
       ordered_breadcrumbs = ordered_parents.reverse
       ordered_breadcrumbs << { title: content_item.title, is_current_page: true }