govuk_publishing_components 45.6.1 → 45.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b7e677ebcf4bc8ae065476415230279eacde3aff30b4f673a682e9e340a90f4
-  data.tar.gz: e8edaf344a5ebd5dd6e88c5edfdd0f013785daeb54dd031da6c41e9a97d8ffbd
+  metadata.gz: 1f666e85d9ff44b241dd92ecedaac2816dffcfd44c50b85f206bc5a0c209529b
+  data.tar.gz: c87b274a6e3bb1170ab2144ad3cfe21f22602381406edad542f03fbde9caa00c
 SHA512:
-  metadata.gz: 3efebe93517bb33fbe07f055c063108ce045db6de8d808706a4e474041d4b5bf0774d620aa804a31af2897751f76f8fdfb8e7f6033f2a904e1aed7fda4383615
-  data.tar.gz: f395017aded3b8d3e224aaa5c1442b58cec4c357e632f2d157ec305cd5605a734e988770f6849667d1a9569e11831fc5bb767428447dc3de78e864b5c07ecfc2
+  metadata.gz: 7062f9f8179dabef8ce3d70b4aca757f257c62e69a19486d095ae8fcfcddd8cce3b3405fddc663bce7e368d2272b89b80a921fa777c9adca32e3624c4d989953
+  data.tar.gz: ec90e23e9b1c953bc687b1abd5b5850336053a86c5f03a251eef0d05aab6747a280888f4c65672eddb965355e22a73402590e78844d6b0d0e3ce71b5cfe59d3b

data/app/views/govuk_publishing_components/components/_chart.html.erb

@@ -5,28 +5,23 @@
   add_gem_component_stylesheet("heading")
   add_gem_component_stylesheet("skip-link")
 
-  chart_heading ||= nil
   chart_heading_level ||= 2
   table_direction ||= "horizontal"
-  h_axis_title ||= nil
-  v_axis_title ||= nil
   rows ||= []
   keys ||= []
   chart_overview ||= nil
+  chart_type ||= "line"
   minimal ||= false
   hide_heading ||= minimal
-  hide_legend ||= minimal
   link ||= false
-  height ||= 400
   padding ||= false
-  point_size ||= 10
-  y_axis_auto_adjust ||= false
 
   chart_id = "chart-id-#{SecureRandom.hex(4)}"
   table_id = "table-id-#{SecureRandom.hex(4)}"
   @external_script ||= OpenStruct.new(loaded: 0)
   @external_script[:loaded] += 1
 
+  chart_helper = GovukPublishingComponents::Presenters::ChartHelper.new(local_assigns)
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
   component_helper.add_class("gem-c-chart")
@@ -36,58 +31,10 @@
 
   require "chartkick"
   Chartkick.options[:html] = '<div id="%{id}"><noscript><p class="govuk-body">Our charts are built using JavaScript but all the data is also available in the table below.</p></noscript></div>'
-  # config options are here: https://developers.google.com/chart/interactive/docs/gallery/linechart
-  font_16 = { color: '#000', fontName: 'GDS Transport', fontSize: '16', italic: false }
-  font_19 = { color: '#000', fontName: 'GDS Transport', fontSize: '19', italic: false }
-  legend = 'none'
-  legend = { position: 'top', textStyle: font_16 } unless hide_legend
-  point_size = 0 if minimal
-  enableInteractivity = true
-  enableInteractivity = false if minimal
-  textPosition = nil
-  textPosition = 'none' if minimal
-  y_axis_view_window_min = 0
-  y_axis_view_window_min = "auto" if y_axis_auto_adjust
 
   if !minimal && !chart_heading
     raise ArgumentError, "A chart heading must be provided for accessibility purposes."
   end
-
-  chart_library_options = {
-    chartArea: { width: '80%', height: '60%' },
-    crosshair: { orientation: 'vertical', trigger: 'both', color: '#ccc' },
-    curveType: 'none',
-    enableInteractivity: enableInteractivity,
-    legend: legend,
-    pointSize: point_size,
-    height: height,
-    tooltip: { isHtml: true },
-    hAxis: {
-      textStyle: font_16,
-      title: h_axis_title,
-      titleTextStyle: font_19,
-      textPosition: textPosition,
-    },
-    vAxis: {
-      textStyle: font_16,
-      title: v_axis_title,
-      titleTextStyle: font_19,
-      textPosition: textPosition,
-      viewWindow: {
-        min: y_axis_view_window_min
-      }
-    },
-  }
-
-  if rows.length > 0 && keys.length > 0
-    chart_format_data = rows.map do |row|
-      {
-        name: row[:label],
-        linewidth: 10,
-        data: keys.zip(row[:values])
-      }
-    end
-  end
 %>
 <% if rows.length > 0 && keys.length > 0 %>
   <%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" if @external_script[:loaded] == 1 %>
@@ -117,7 +64,13 @@
         </span>
       <% end %>
 
-      <%= line_chart(chart_format_data, library: chart_library_options) %>
+      <% if chart_type == "column" %>
+        <%= column_chart(chart_helper.chart_format_data, library: chart_helper.chart_options) %>
+      <% elsif chart_type == "bar" %>
+        <%= bar_chart(chart_helper.chart_format_data, library: chart_helper.chart_options) %>
+      <% else %>
+        <%= line_chart(chart_helper.chart_format_data, library: chart_helper.chart_options) %>
+      <% end %>
     <% end %>
 
     <% unless minimal %>

data/app/views/govuk_publishing_components/components/docs/chart.yml

@@ -22,7 +22,6 @@ examples:
       h_axis_title: Day
       v_axis_title: Views
       chart_overview: This chart shows page views for January 2015.
-      hide_legend: true
       keys:
         - "2015-01-01"
         - "2015-01-02"
@@ -102,6 +101,136 @@ examples:
             - 27
             - 18
             - 34
+  hide_legend:
+    data:
+      chart_heading: Page views chart
+      h_axis_title: Day
+      v_axis_title: Views
+      chart_overview: This chart shows page views for January 2015.
+      hide_legend: true
+      keys:
+        - "2015-01-01"
+        - "2015-01-02"
+        - "2015-01-03"
+        - "2015-01-04"
+        - "2015-01-05"
+        - "2015-01-06"
+        - "2015-01-07"
+        - "2015-01-08"
+        - "2015-01-09"
+        - "2015-01-10"
+      rows:
+        - label: January 2015
+          values:
+            - 500
+            - 1190
+            - 740
+            - 820
+            - 270
+            - 450
+            - 110
+            - 210
+            - 670
+            - 430
+  with_line_colours_and_styles:
+    description: Note that line styles and colours currently only work on line charts.
+    data:
+      chart_heading: Page views chart
+      h_axis_title: Day
+      v_axis_title: Views
+      chart_overview: This chart shows page views for January in different years.
+      line_colours:
+        - orange
+        - blue
+        - "#88AA11"
+      line_styles:
+        - solid
+        - dotted
+        - solid
+      keys:
+        - 1st
+        - 2nd
+        - 3rd
+      rows:
+        - label: January 2015
+          values:
+            - 110
+            - 119
+            - 105
+        - label: January 2016
+          values:
+            - 71
+            - 68
+            - 75
+        - label: January 2017
+          values:
+            - 21
+            - 42
+            - 18
+  bar_chart:
+    data:
+      chart_heading: Hats owned
+      h_axis_title: Day
+      v_axis_title: Views
+      chart_overview: This chart shows page views for January 2015.
+      chart_type: "bar"
+      hide_legend: true
+      keys:
+        - Jon
+        - Ash
+        - James
+        - Phil
+      rows:
+        - label: Hats owned
+          values:
+            - 3
+            - 1
+            - 1
+            - 2
+  column_chart:
+    data:
+      chart_heading: Hats owned
+      h_axis_title: Day
+      v_axis_title: Views
+      chart_overview: This chart shows page views for January 2015.
+      chart_type: "column"
+      hide_legend: true
+      keys:
+        - Jon
+        - Ash
+        - James
+        - Phil
+      rows:
+        - label: Hats owned
+          values:
+            - 3
+            - 1
+            - 1
+            - 2
+  format_axis_labels:
+    description: Sometimes if there are a lot of labels on the axes the chart can do strange truncation on the labels. If they are meant to be dates, the `h_axis_format` and `v_axis_format` will force a familiar date format to get around this problem.
+    data:
+      chart_heading: Page views chart
+      h_axis_title: Day
+      v_axis_title: Views
+      chart_overview: This chart shows page views for January.
+      h_axis_format: date
+      keys:
+        - 2024 Jan 1
+        - 2024 Jan 2
+        - 2024 Jan 3
+        - 2024 Jan 4
+        - 2024 Jan 5
+        - 2024 Jan 6
+      rows:
+        - label: January 2015
+          values:
+            - 110
+            - 119
+            - 105
+            - 109
+            - 130
+            - 131
   vertical table:
     description: Reorient the table to better suit the output of some data sets.
     data:

data/app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml

@@ -4,11 +4,12 @@ body: |
   This is a complex component that calls other components. For more accurate
   preview with real data, see the [contextual navigation preview][preview].
 
-  There are 3 main variants of the component:
+  There are 4 main variants of the component:
 
   - Step by step, which uses the [step by step header][header]
   - Parent breadcrumb, which uses the `parent` link of the page with the [breadcrumbs component][breadcrumbs]
   - Taxon breadcrumb, which uses the `taxons` link of the page with the [breadcrumbs component][breadcrumbs]
+  - Organisation breadcrumb, which uses the `organisations` link of the page with the [breadcrumbs component][breadcrumbs]
 
   It must always used [together with the contextual sidebar][sidebar] and [footer].
 

data/config/locales/en.yml

@@ -33,7 +33,7 @@ en:
         characters: characters
         words: words
     chart:
-      table_dropdown: Data table
+      table_dropdown: View data as a table
       accessibility_html: This chart is a visual representation of the data available in the table.
       accessibility_link: Skip to "%{chart_heading}" data table
       accessibility_heading: Data table for "%{chart_heading}"

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -55,6 +55,11 @@ module GovukPublishingComponents
             step_by_step: false,
             breadcrumbs: navigation.breadcrumbs,
           }
+        elsif navigation.use_organisation_breadcrumbs?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.organisation_breadcrumbs,
+          }
         elsif navigation.use_taxon_breadcrumbs?
           {
             step_by_step: false,

data/lib/govuk_publishing_components/presenters/chart_helper.rb

@@ -0,0 +1,106 @@
+module GovukPublishingComponents
+  module Presenters
+    class ChartHelper
+      def initialize(options)
+        @rows = options[:rows]
+        @keys = options[:keys]
+        @minimal = options[:minimal]
+        @enable_interactivity = false
+        @enable_interactivity = true unless @minimal
+        @hide_legend = options[:hide_legend]
+        @hide_legend = true if @minimal
+        @point_size = options[:point_size] ||= 10
+        @point_size = 0 if @minimal
+        @height = options[:height] || 400
+        @h_axis_title = options[:h_axis_title]
+        @v_axis_title = options[:v_axis_title]
+        @text_position = "none" if @minimal
+        @y_axis_view_window_min = 0
+        @y_axis_view_window_min = "auto" if options[:y_axis_auto_adjust]
+        @line_colours = options[:line_colours]
+        @line_styles = options[:line_styles]
+        @h_axis_format = "YYYY-MM-dd" if options[:h_axis_format] == "date"
+        @v_axis_format = "YYYY-MM-dd" if options[:v_axis_format] == "date"
+      end
+
+      # config options are here: https://developers.google.com/chart/interactive/docs/gallery/linechart
+      def chart_options
+        {
+          chartArea: { width: "80%", height: "60%" },
+          crosshair: { orientation: "vertical", trigger: "both", color: "#ccc" },
+          curveType: "none",
+          enableInteractivity: @enable_interactivity,
+          legend: legend_options,
+          pointSize: @point_size,
+          height: @height,
+          tooltip: { isHtml: true },
+          series: series_options,
+          hAxis: {
+            textStyle: set_font_16,
+            title: @h_axis_title,
+            titleTextStyle: set_font_19,
+            textPosition: @text_position,
+            format: @h_axis_format,
+          },
+          vAxis: {
+            textStyle: set_font_16,
+            title: @v_axis_title,
+            titleTextStyle: set_font_19,
+            textPosition: @text_position,
+            format: @v_axis_format,
+            viewWindow: {
+              min: @y_axis_view_window_min,
+            },
+          },
+        }
+      end
+
+      def chart_format_data
+        if !@rows.empty? && !@keys.empty?
+          @rows.map do |row|
+            {
+              name: row[:label],
+              data: @keys.zip(row[:values]),
+            }
+          end
+        end
+      end
+
+    private
+
+      def legend_options
+        return { position: "top", textStyle: set_font_16 } unless @hide_legend
+
+        "none"
+      end
+
+      def set_font_16
+        { color: "#000", fontName: "GDS Transport", fontSize: "16", italic: false }
+      end
+
+      def set_font_19
+        { color: "#000", fontName: "GDS Transport", fontSize: "19", italic: false }
+      end
+
+      def series_options
+        series = {}
+        if @line_colours
+          @line_colours.each_with_index do |item, index|
+            series[index] = {} unless series[index]
+            series[index][:color] = item
+          end
+        end
+
+        if @line_styles
+          @line_styles.each_with_index do |item, index|
+            style = [2, 2] if item == "dotted"
+            series[index] = {} unless series[index]
+            series[index][:lineDashStyle] = style
+          end
+        end
+
+        series
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_organisations.rb

@@ -0,0 +1,36 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    class ContentBreadcrumbsBasedOnOrganisations
+      def self.call(content_item)
+        new(content_item).breadcrumbs
+      end
+
+      def initialize(content_item)
+        @content_item = ContentItem.new(content_item)
+      end
+
+      def breadcrumbs
+        [
+          { title: "Home", url: "/" },
+          { title: "Organisations", url: "/government/organisations" },
+          *organisation_breadcrumbs_items,
+        ]
+      end
+
+    private
+
+      attr_reader :content_item
+
+      def organisation_breadcrumbs_items
+        first_related_organisation = ContentItem.new(content_item.related_organisations.first)
+        return [] unless first_related_organisation.present?
+
+        [{
+          title: first_related_organisation.title,
+          url: first_related_organisation.base_path,
+        }]
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -33,6 +33,10 @@ module GovukPublishingComponents
         @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.call(content_item)
       end
 
+      def organisation_breadcrumbs
+        @organisation_breadcrumbs ||= ContentBreadcrumbsBasedOnOrganisations.call(content_item)
+      end
+
       def breadcrumbs
         breadcrumbs_based_on_ancestors
       end
@@ -56,6 +60,10 @@ module GovukPublishingComponents
         content_is_tagged_to_a_live_taxon? && !content_is_a_specialist_document?
       end
 
+      def use_organisation_breadcrumbs?
+        content_is_a_corporate_information_page? && content_has_related_organisations?
+      end
+
       def content_tagged_to_a_finder?
         content_item.dig("links", "finder").present?
       end
@@ -72,6 +80,10 @@ module GovukPublishingComponents
         content_item.dig("links", "ordered_related_items").present? && content_item.dig("links", "parent").present?
       end
 
+      def content_has_related_organisations?
+        ContentItem.new(content_item).related_organisations.present?
+      end
+
       def content_is_tagged_to_a_live_taxon?
         content_item.dig("links", "taxons").to_a.any? { |taxon| taxon["phase"] == "live" }
       end
@@ -80,6 +92,10 @@ module GovukPublishingComponents
         content_item["schema_name"] == "specialist_document"
       end
 
+      def content_is_a_corporate_information_page?
+        content_item["schema_name"] == "corporate_information_page"
+      end
+
       def content_is_a_html_publication?
         content_item["document_type"] == "html_publication"
       end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "45.6.1".freeze
+  VERSION = "45.7.0".freeze
 end

data/lib/govuk_publishing_components.rb

@@ -15,6 +15,7 @@ require "govuk_publishing_components/presenters/big_number_helper"
 require "govuk_publishing_components/presenters/breadcrumbs_helper"
 require "govuk_publishing_components/presenters/breadcrumb_selector"
 require "govuk_publishing_components/presenters/button_helper"
+require "govuk_publishing_components/presenters/chart_helper"
 require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/devolved_nations_helper"
 require "govuk_publishing_components/presenters/emergency_banner_helper"
@@ -24,6 +25,7 @@ require "govuk_publishing_components/presenters/step_by_step_nav_helper"
 require "govuk_publishing_components/presenters/page_with_step_by_step_navigation"
 require "govuk_publishing_components/presenters/public_layout_helper"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors"
+require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_organisations"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons"
 require "govuk_publishing_components/presenters/checkboxes_helper"
 require "govuk_publishing_components/presenters/select_helper"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 45.6.1
+  version: 45.7.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick
@@ -939,9 +939,11 @@ files:
 - lib/govuk_publishing_components/presenters/breadcrumb_selector.rb
 - lib/govuk_publishing_components/presenters/breadcrumbs_helper.rb
 - lib/govuk_publishing_components/presenters/button_helper.rb
+- lib/govuk_publishing_components/presenters/chart_helper.rb
 - lib/govuk_publishing_components/presenters/checkboxes_helper.rb
 - lib/govuk_publishing_components/presenters/component_wrapper_helper.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors.rb
+- lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_organisations.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb
 - lib/govuk_publishing_components/presenters/content_item.rb
 - lib/govuk_publishing_components/presenters/contents_list_helper.rb