govuk_publishing_components 66.6.1 → 66.7.0

data/lib/govuk_publishing_components/presenters/chart_helper.rb

@@ -0,0 +1,123 @@
+module GovukPublishingComponents
+  module Presenters
+    class ChartHelper
+      def initialize(options)
+        @rows = options[:rows]
+        @keys = options[:keys]
+        @enable_interactivity = true
+        @hide_legend = options[:hide_legend]
+        if @rows && (@rows.length > 1)
+          @hide_legend = false
+        end
+        @point_size = 8
+        @height = options[:height] || 400
+        @h_axis_title = options[:h_axis_title]
+        @v_axis_title = options[:v_axis_title]
+        @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"
+        @h_axis_format = "£#" if options[:h_axis_format] == "currency"
+        @h_axis_format = "#'\%'" if options[:h_axis_format] == "percent"
+
+        @v_axis_format = "YYYY-MM-dd" if options[:v_axis_format] == "date"
+        @v_axis_format = "£#" if options[:v_axis_format] == "currency"
+        @v_axis_format = "#'\%'" if options[:v_axis_format] == "percent"
+      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,
+            format: @h_axis_format,
+          },
+          vAxis: {
+            textStyle: set_font_16,
+            title: @v_axis_title,
+            titleTextStyle: set_font_19,
+            format: @v_axis_format,
+            viewWindow: {
+              min: @y_axis_view_window_min,
+            },
+          },
+        }
+      end
+
+      def brand_colours
+        # The following accessible colour palette has been developed to meet the colour contrast requirements for adjacent colours (as set out in WCAG 2.1)
+        # For charts, the palette should be used instead of the GOV.UK colour palette - https://design-system.service.gov.uk/styles/colour/
+        # https://gss.civilservice.gov.uk/policy-store/data-visualisation-colours-in-charts/#section-5
+
+        gss_colour_dark_blue = "#12436d"
+        gss_colour_turquoise = "#1bbbaf"
+        gss_colour_dark_pink = "#801650"
+        gss_colour_orange = "#f46a25"
+        gss_colour_dark_grey = "#3d3d3d"
+        gss_colour_plum = "#a285d1"
+
+        [gss_colour_dark_blue, gss_colour_turquoise, gss_colour_dark_pink, gss_colour_orange, gss_colour_dark_grey, gss_colour_plum]
+      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/select_helper.rb

@@ -3,7 +3,7 @@ module GovukPublishingComponents
     class SelectHelper
       include ActionView::Helpers::FormOptionsHelper
 
-      attr_reader :options, :options_markup, :error_items, :error_id, :hint, :hint_id, :describedby
+      attr_reader :options_markup, :error_items, :error_id, :hint, :hint_id, :describedby
 
       def initialize(local_assigns)
         @options = local_assigns[:options] || []
@@ -40,9 +40,9 @@ module GovukPublishingComponents
     private
 
       def get_options
-        return if options.nil?
+        return if @options.nil?
 
-        options.map do |option|
+        @options.map do |option|
           @selected_option = option[:value] if option[:selected]
           [
             option[:text],

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "66.6.1".freeze
+  VERSION = "66.7.0".freeze
 end

data/lib/govuk_publishing_components.rb

@@ -14,6 +14,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"

data/node_modules/chartkick/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2023 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.