govuk_navigation_helpers 8.2.2 → 9.0.0

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

@@ -1,261 +0,0 @@
-{
-  "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"}
-    ]
-  },
-  "ab_test_prefix": "",
-  "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"
-  ],
-  "tasklist": {
-    "groups": [
-      [
-        {
-          "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",
-          "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",
-              "style": "required",
-              "contents": [
-                {
-                  "href": "/pass-plus",
-                  "text": "Find out about Pass Plus training courses"
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    ]
-  }
-}

data/lib/govuk_navigation_helpers/current_tasklist_ab_test.rb

@@ -1,65 +0,0 @@
-module GovukNavigationHelpers
-  class CurrentTasklistAbTest
-    TASKLIST_HEADER_DIMENSION = 44
-    TASKLIST_SIDEBAR_DIMENSION = 66
-
-    def initialize(current_tasklist:, request:)
-      @current_tasklist = current_tasklist
-      @ab_test_prefix = current_tasklist.ab_test_prefix if current_tasklist
-      @request = request
-    end
-
-    def eligible?
-      !! current_tasklist
-    end
-
-    def header
-      @header ||= set_ab_test(
-        name: "#{ab_test_prefix}TaskListHeader",
-        dimension: TASKLIST_HEADER_DIMENSION
-      )
-    end
-
-    def sidebar
-      @sidebar ||= set_ab_test(
-        name: "#{ab_test_prefix}TaskListSidebar",
-        dimension: TASKLIST_SIDEBAR_DIMENSION
-      )
-    end
-
-    def sidebar_variant
-      @sidebar_variant ||=
-        sidebar.requested_variant(request.headers)
-    end
-
-    def header_variant
-      @header_variant ||=
-        header.requested_variant(request.headers)
-    end
-
-    def show_tasklist_sidebar?
-      sidebar_variant.variant?('B') && is_tested_page?
-    end
-
-    def show_tasklist_header?
-      header_variant.variant?('B') && is_tested_page?
-    end
-
-    def is_tested_page?
-      return current_tasklist.is_page_included_in_ab_test? if current_tasklist
-    end
-
-    def set_response_header(response)
-      sidebar_variant.configure_response(response) if is_tested_page?
-      header_variant.configure_response(response) if is_tested_page?
-    end
-
-  private
-
-    attr_reader :current_tasklist, :ab_test_prefix, :request
-
-    def set_ab_test(name:, dimension:)
-      GovukAbTesting::AbTest.new(name, dimension: dimension)
-    end
-  end
-end

data/lib/govuk_navigation_helpers/tasklist_content.rb

@@ -1,118 +0,0 @@
-module GovukNavigationHelpers
-  class TasklistContent
-    TASKLIST_NAMES = %w(
-      learn-to-drive-a-car
-    ).freeze
-
-    def self.current_tasklist(path)
-      TASKLIST_NAMES.each do |tasklist_name|
-        tasklist = new(file_name: tasklist_name, path: path)
-        return tasklist if tasklist.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 tasklist
-      parsed_file.dig(:tasklist)
-    end
-
-    def ab_test_prefix
-      parsed_file.dig(:ab_test_prefix)
-    end
-
-    def skip_link
-      "##{groups.flatten.first[:title].downcase.tr(' ', '-')}"
-    end
-
-    def primary_paths
-      primary_content.map { |content|
-        content[:href] unless content[:href].start_with?('http')
-      }.select(&:present?)
-    end
-
-    def groups
-      tasklist.dig(:groups)
-    end
-
-    def related_paths
-      parsed_file.dig(:related_paths)
-    end
-
-    def set_current_task
-      set_task_as_active_if_current_page
-    end
-
-    def is_page_included_in_ab_test?
-      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_task_as_active_if_current_page
-      counter = 0
-
-      groups.each_with_index.each do |grouped_steps, group_index|
-        grouped_steps.each do |step|
-          counter += 1
-
-          step[:contents].each do |content|
-            next unless content[:contents]
-
-            content[:contents].each do |link|
-              if link[:href] == path
-                link[:active] = true
-                tasklist[:show_step] = counter
-                tasklist[:highlight_group] = group_index + 1
-                return tasklist
-              end
-            end
-          end
-        end
-      end
-
-      tasklist
-    end
-
-    def primary_content
-      primary_content = groups.flat_map do |grouped_steps|
-        grouped_steps.flat_map do |group|
-          group[:contents].select { |content| content[:contents] }
-        end
-      end
-
-      primary_content.flat_map { |hash| hash[:contents] }
-    end
-
-    def parsed_file
-      @parsed_file ||=
-        JSON.parse(
-          File.read(
-            File.join(File.dirname(__FILE__), "../../", "config", "tasklists", "#{file_name}.json")
-          )
-        ).deep_symbolize_keys.tap do |json_file|
-          json_file[:tasklist].merge!(small: true, heading_level: 3)
-        end
-    end
-  end
-end

data/spec/current_tasklist_ab_test_spec.rb

@@ -1,64 +0,0 @@
-require 'spec_helper'
-
-module GovukNavigationHelpers
-  RSpec.describe CurrentTasklistAbTest do
-    let(:tasklist) { TasklistContent.current_tasklist('/vehicles-can-drive') }
-
-    it "indicates when to show the task list components" do
-      request = double('request', headers: {
-        'HTTP_GOVUK_ABTEST_TASKLISTSIDEBAR' => 'B',
-        'HTTP_GOVUK_ABTEST_TASKLISTHEADER' => 'B'
-        })
-      ab_test = described_class.new(current_tasklist: tasklist, request: request)
-      expect(ab_test.show_tasklist_sidebar?).to be true
-      expect(ab_test.show_tasklist_header?).to be true
-    end
-
-    it "indicates when to not show the task list components" do
-      request = double('request', headers: {
-        'HTTP_GOVUK_ABTEST_TASKLISTSIDEBAR' => 'A',
-        'HTTP_GOVUK_ABTEST_TASKLISTHEADER' => 'A'
-        })
-      ab_test = described_class.new(current_tasklist: tasklist, request: request)
-      expect(ab_test.show_tasklist_sidebar?).to be false
-      expect(ab_test.show_tasklist_header?).to be false
-    end
-
-    it "copes with a mixture when to not show the task list components" do
-      request = double('request', headers: {
-        'HTTP_GOVUK_ABTEST_TASKLISTSIDEBAR' => 'B',
-        'HTTP_GOVUK_ABTEST_TASKLISTHEADER' => 'A'
-        })
-      ab_test = described_class.new(current_tasklist: tasklist, request: request)
-      expect(ab_test.show_tasklist_sidebar?).to be true
-      expect(ab_test.show_tasklist_header?).to be false
-    end
-
-    it "configures the response vary header correctly " do
-      request = double('request', headers: {
-        'HTTP_GOVUK_ABTEST_TASKLISTSIDEBAR' => 'A',
-        'HTTP_GOVUK_ABTEST_TASKLISTHEADER' => 'B'
-        })
-      response = double('response', headers: {})
-      ab_test = described_class.new(current_tasklist: tasklist, request: request)
-
-      ab_test.set_response_header(response)
-
-      expect(response.headers["Vary"]).to eq("GOVUK-ABTest-TaskListSidebar, GOVUK-ABTest-TaskListHeader")
-    end
-
-    it "configures the response vary header correctly when the page is not under test" do
-      request = double('request', headers: {
-        'HTTP_GOVUK_ABTEST_TASKLISTSIDEBAR' => 'A',
-        'HTTP_GOVUK_ABTEST_TASKLISTHEADER' => 'B'
-        })
-      response = double('response', headers: {})
-      tasklist = TasklistContent.current_tasklist("/not_under_test")
-      ab_test = described_class.new(current_tasklist: tasklist, request: request)
-
-      ab_test.set_response_header(response)
-
-      expect(response.headers["Vary"]).to be nil
-    end
-  end
-end