govuk_publishing_components 2.0.0 → 3.0.0

data/app/views/components/docs/task_list_header.yml

@@ -0,0 +1,33 @@
+name: Task list header
+description: Shows that a content page is part of a task list.
+body: |
+  The component indicates to the user that the current page is part of a [task list](/component-guide/task_list), and can provide a link to that task list.
+accessibility_criteria: |
+  The component is designed to go into the top of an existing content page and should not interfere with the heading structure of the page, so therefore should not contain a heading tag.
+
+  The component must:
+
+  - provide a skip link to the task list on the page, if that task list is present
+shared_accessibility_criteria:
+  - link
+examples:
+  default:
+    data:
+      title: 'Learn to drive a car: step by step'
+  with_a_link:
+    data:
+      title: 'Having children: step by step'
+      path: /childcare-parenting/pregnancy-and-birth
+  with_a_skip_link:
+    description: This option allows the insertion of a skip link to a task list elsewhere on the page. This aids navigation when using a keyboard or screen reader. The skip link is visually hidden until it receives focus.
+    data:
+      title: 'Separating from a spouse or civil partner: step by step'
+      path: /divorce
+      skip_link: '#task-list-wrapper'
+  with_a_skip_link_with_custom_text:
+    description: It's hard to think of good text to put in a skip link, so this option lets you customise it.
+    data:
+      title: 'Buying and renting a property: step by step'
+      path: /buy-sell-your-home
+      skip_link: '#task-list-steps'
+      skip_link_text: Skip to steps

data/app/views/components/docs/task_list_related.yml

@@ -0,0 +1,54 @@
+name: Task list related links
+description: Links to task lists that a page is part of
+body: |
+  The component is designed to go on a content page to accompany a small task list in a sidebar. It provides links to the main task list page.
+
+  The component has two uses:
+
+  - above the task list, it provides a link to the main task list page
+  - below the task list, it shows and links to any other task lists that this page belongs to
+
+  In the first use case, only one link should be present and the entire text of the component should be contained in a heading. In the second use case, if more than one link is provided, the links should be shown in a list, separate from the heading.
+accessibility_criteria: |
+  The component must:
+
+  - display a single link as part of a heading
+  - display multiple links outside of a heading in a separate list
+shared_accessibility_criteria:
+  - link
+examples:
+  default:
+    data:
+      links: [
+        {
+          href: '/learn-to-drive-a-car',
+          text: 'Learn to drive a car: step by step'
+        }
+      ]
+  with_more_than_one_link:
+    description: If more than one link is passed to the component it should output them as a list outside of the heading.
+    data:
+      links: [
+        {
+          href: '/learn-to-drive-a-car',
+          text: 'Learn to drive a car: step by step'
+        },
+        {
+          href: '/learn-to-drive-a-motorbike',
+          text: 'Learn to drive a motorbike: step by step'
+        }
+      ]
+  with_a_different_title:
+    description: The default title 'Part of' can be replaced if required.
+    data:
+      pretitle: 'Also part of'
+      links: [
+        {
+          href: '/learn-to-drive-a-car',
+          text: 'Learn to drive a car: step by step'
+        },
+        {
+          href: '/learn-to-drive-a-motorbike',
+          text: 'Learn to drive a motorbike: step by step'
+        }
+      ]

data/app/views/govuk_publishing_components/component_guide/index.html.erb

@@ -15,9 +15,20 @@
 <ul class="component-list">
   <% @component_docs.each do |component_doc| %>
     <li>
-      <h2>
-        <%= link_to component_doc.name, component_doc_path(component_doc.id) %>
-      </h2>
+      <%= link_to component_doc.name, component_doc_path(component_doc.id) %>
+      <p>
+        <%= component_doc.description %>
+      </p>
+    </li>
+  <% end %>
+</ul>
+
+<h2 class="component-doc-h2">Components in the gem</h2>
+
+<ul class="component-list">
+  <% @gem_component_docs.each do |component_doc| %>
+    <li>
+      <%= link_to component_doc.name, component_doc_path(component_doc.id) %>
       <p>
         <%= component_doc.description %>
       </p>

data/app/views/govuk_publishing_components/component_guide/show.html.erb

@@ -1,5 +1,5 @@
 <% content_for :title, "#{@component_doc.name} component" %>
-<%= render 'govuk_component/title', title: @component_doc.name, context: 'Component' %>
+<%= render 'govuk_component/title', title: @component_doc.name, context: "Component" %>
 
 <div class="component-show">
   <div class="grid-row">

data/app/views/layouts/govuk_publishing_components/application.html.erb

@@ -11,11 +11,8 @@
     <%= yield :title %><% if content_for(:title) %> - <% end %><%= GovukPublishingComponents::Config.component_guide_title %>
   </title>
   <%= stylesheet_link_tag "govuk_publishing_components/application", media: "all" %>
+  <%= stylesheet_link_tag "govuk_publishing_components/print", media: "print" %>
   <%= stylesheet_link_tag "#{GovukPublishingComponents::Config.application_stylesheet}" %>
-  <% if GovukPublishingComponents::Config.application_print_stylesheet %>
-    <%= stylesheet_link_tag "#{GovukPublishingComponents::Config.application_print_stylesheet}", media: "print" %>
-  <% end %>
-
   <%= javascript_include_tag "govuk_publishing_components/application" %>
   <%= javascript_include_tag "#{GovukPublishingComponents::Config.application_javascript}" %>
   <%= csrf_meta_tags %>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w( govuk_publishing_components/print.css )

data/lib/govuk_publishing_components/config.rb

@@ -14,7 +14,7 @@ module GovukPublishingComponents
     self.application_stylesheet = "application"
 
     mattr_accessor :application_print_stylesheet
-    self.application_print_stylesheet = nil
+    self.application_print_stylesheet = "print"
 
     mattr_accessor :application_javascript
     self.application_javascript = "application"
@@ -25,5 +25,9 @@ module GovukPublishingComponents
     def self.component_directory_name
       static ? STATIC_COMPONENT_DIRECTORY : APP_COMPONENT_DIRECTORY
     end
+
+    def self.gem_directory
+      Gem::Specification.find_by_name("govuk_publishing_components").gem_dir
+    end
   end
 end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: govuk-content-schema-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -204,12 +218,21 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/govuk_publishing_components_manifest.js
+- app/assets/javascripts/components/task-list.js
+- app/assets/javascripts/current-location.js
 - app/assets/javascripts/govuk_publishing_components/accessibility-test.js
 - app/assets/javascripts/govuk_publishing_components/application.js
 - app/assets/javascripts/govuk_publishing_components/vendor/axe.min.js
 - app/assets/javascripts/govuk_publishing_components/vendor/matches-polyfill.min.js
 - app/assets/javascripts/govuk_publishing_components/visual-regression.js
+- app/assets/javascripts/history-support.js
+- app/assets/stylesheets/components/_task-list-header-print.scss
+- app/assets/stylesheets/components/_task-list-header.scss
+- app/assets/stylesheets/components/_task-list-print.scss
+- app/assets/stylesheets/components/_task-list-related.scss
+- app/assets/stylesheets/components/_task-list.scss
 - app/assets/stylesheets/govuk_publishing_components/application.scss
+- app/assets/stylesheets/govuk_publishing_components/print.scss
 - app/controllers/govuk_publishing_components/application_controller.rb
 - app/controllers/govuk_publishing_components/component_guide_controller.rb
 - app/helpers/govuk_publishing_components/application_helper.rb
@@ -217,6 +240,12 @@ files:
 - app/models/govuk_publishing_components/component_doc_resolver.rb
 - app/models/govuk_publishing_components/component_example.rb
 - app/models/govuk_publishing_components/shared_accessibility_criteria.rb
+- app/views/components/_task_list.html.erb
+- app/views/components/_task_list_header.html.erb
+- app/views/components/_task_list_related.html.erb
+- app/views/components/docs/task_list.yml
+- app/views/components/docs/task_list_header.yml
+- app/views/components/docs/task_list_related.yml
 - app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_component.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb
@@ -225,6 +254,7 @@ files:
 - app/views/govuk_publishing_components/component_guide/preview.html.erb
 - app/views/govuk_publishing_components/component_guide/show.html.erb
 - app/views/layouts/govuk_publishing_components/application.html.erb
+- config/initializers/assets.rb
 - config/routes.rb
 - lib/generators/govuk_publishing_components/USAGE
 - lib/generators/govuk_publishing_components/component_generator.rb