ccs-frontend_helpers 0.1.0.rc.1 → 0.1.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 688e4ab0ddc41179157be55abb6a1afe720c55e027305e840d009cfbdad580c9
-  data.tar.gz: c8aa5d34f38f99b2e70f4eea14d0614075bd2c6d58ed7ba1fdb92683594ad65e
+  metadata.gz: 675c60c51c25d5cd22e26b1e92a579053d1340200bc4a33e9a4e36e65b6790ca
+  data.tar.gz: b90658aa1deadfa04ee5dd2d12be7f8a62b83656017a0fc557812fced67a789f
 SHA512:
-  metadata.gz: 7a3f14a98c028b451ba6d39962923eac034b9a0619adb3722d40f7f3230dd860f5ca8bffc4eb1f94292b1c6d87772df96c272a946e0c00d78fdc681f16cb3cc4
-  data.tar.gz: 89519f4a8a15e9a2d4517a03562e2c001635f5b79fbb1020474393f45b32f7b8f0cf22d3c1541e711e945425542416791cb4cc6c9e4608faf336e14af668277a
+  metadata.gz: d5ec2d542ec51558264bfd069546b59969ff401fc1c49c0b332ea547ce7504e477d8dd01ae50f16a7b322d1e80b3d5e584d540259c398090b5aba10af240cd33
+  data.tar.gz: 93ed922f0db520239e8d27bf422ebf9badaad94cd014f7af431e6009d5d1ba4b9ffb96cfca565e7e7ff1ed2d4912a2f7189d03c9ec4f4a8f1dfe2650a4cc7b1b

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-rspec
   - rubocop-rails
   - rubocop-rake
+  - rubocop-capybara
 
 AllCops:
     NewCops: enable
@@ -86,6 +87,7 @@ RSpec/ContextWording:
 Metrics/ModuleLength:
     Exclude:
         - 'spec/ccs/frontend_helpers/**/*'
+        - 'spec/ccs/components/**/*'
 
 RSpec/MultipleMemoizedHelpers:
     Enabled: false
@@ -113,7 +115,8 @@ RSpec/NestedGroups:
 
 RSpec/ExampleLength:
     Exclude:
-         - 'spec/ccs/frontend_helpers/**/*'
+        - 'spec/ccs/frontend_helpers/**/*'
+        - 'spec/ccs/components/**/*'
 
 Rails/DynamicFindBy:
   Whitelist:
@@ -125,3 +128,4 @@ RSpec/MultipleExpectations:
 RSpec/FilePath:
     CustomTransform:
         GovUKFrontend: govuk_frontend
+        GovUK: govuk

data/.ruby-version

@@ -0,0 +1 @@
+2.7.7

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [0.1.0.rc.1] - 2023-02-22
+## [0.1.0.rc.3] - 2023-04-05
 
 Initial release of CCS Frontend Helpers.
 This release contains view helpers that are used to create GOV.UK and CCS components.
@@ -19,7 +19,9 @@ The following GOV.UK helpers have been added:
 - Fieldset
 - File upload
 - Footer
+- Form group
 - Header
+- Hint
 - Inset text
 - Notification banner
 - Pagination
@@ -28,6 +30,7 @@ The following GOV.UK helpers have been added:
 - Radios
 - Select
 - Skip link
+- Step by step navigation
 - Summary list
 - Table
 - Tabs

data/Gemfile.lock

@@ -1,73 +1,73 @@
 PATH
   remote: .
   specs:
-    ccs-frontend_helpers (0.1.0.rc.1)
+    ccs-frontend_helpers (0.1.0.rc.3)
       rails (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -85,7 +85,7 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    concurrent-ruby (1.2.0)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
     diff-lcs (1.5.0)
@@ -108,7 +108,7 @@ GEM
     matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.17.0)
+    minitest (5.18.0)
     net-imap (0.3.4)
       date
       net-protocol
@@ -119,40 +119,40 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.8)
-    nokogiri (1.14.1-x86_64-darwin)
+    nokogiri (1.14.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.1-x86_64-linux)
+    nokogiri (1.14.2-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.2.1.0)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     racc (1.6.2)
-    rack (2.2.6.2)
-    rack-test (2.0.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
+      railties (= 7.0.4.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -174,30 +174,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
-    rubocop-rails (2.17.4)
+    rubocop-rails (2.18.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.18.1)
+    rubocop-rspec (2.19.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -205,7 +205,7 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     thor (1.2.1)
-    timeout (0.3.1)
+    timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
@@ -217,7 +217,7 @@ GEM
       nokogiri (~> 1.8)
     yard (0.9.28)
       webrick (~> 1.7.0)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   x86_64-darwin-19
@@ -238,4 +238,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.3.12
+   2.3.24

data/lib/ccs/components/base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module CCS
+  # Components for the GOV.UK Frontend and CCS Frontend using an Object Oriented pattern
+  # These are then used in the {CCS::FrontendHelpers FrontendHelpers}
+  # to create view helpers that can be used in a Ruby on Rails project
+
+  module Components
+    # Component base class that all components will inherit from.
+    #
+    # It's main purpose is to handle the initialisation of the options
+    # which is very similar between components
+    #
+    # @!attribute [r] options
+    #   @return [Hash] Options for the component which defaults to +{ attributes: {} }+
+    #                  where +attributes+ are HTML attributes
+    # @!attribute [r] context
+    #   @return [ActionView::Base] View context where the components are being rendered
+
+    class Base
+      private
+
+      attr_accessor :options, :context
+
+      public
+
+      delegate :button_tag, :concat, :label_tag, :link_to, :tag, to: :context
+
+      # @param context [ActionView::Base] the view context where the components are being rendered
+      # @param options [Hash] options for the component
+
+      def initialize(context:, **options)
+        options[:attributes] ||= {}
+        options[:attributes][:class] = "#{default_attributes[:class]} #{options[:classes]}".strip if default_attributes[:class] || options[:classes]
+        (options[:attributes][:data] ||= {})[:module] = default_attributes[:data][:module] if default_attributes.dig(:data, :module)
+
+        @context = context
+        @options = options
+      end
+
+      # The default attributes for the component
+
+      DEFAULT_ATTRIBUTES = {}.freeze
+
+      private
+
+      # The default attributes for the component
+      #
+      # @return [Hash]
+
+      def default_attributes
+        self.class::DEFAULT_ATTRIBUTES
+      end
+
+      # Sanitizes string used as HTML tag id
+      #
+      # @return [String]
+
+      def sanitize_to_id(...)
+        @context.send(:sanitize_to_id, ...)
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/dashboard_section/panel.rb

@@ -0,0 +1,57 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module CCS
+      class DashboardSection < Base
+        # = CCS Dashboard Section Panel
+        #
+        # The individual panel within a dashboard section
+        #
+        # @!attribute [r] title
+        #   @return [String] Text for the panel title
+        # @!attribute [r] href
+        #   @return [String] The href for the panel
+        # @!attribute [r] description
+        #   @return [String] Description text for the panel
+
+        class Panel < Base
+          private
+
+          attr_reader :title, :href, :description
+
+          public
+
+          # @param title [String] the text for the panel title
+          # @param href [String] the href for the panel
+          # @param description [String] the description text for the panel
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :width (default: 'one-third') the width of the panel
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML.
+
+          def initialize(title:, href:, description:, **options)
+            super(**options)
+
+            @options[:attributes][:class] = "ccs-dashboard-section__panel govuk-grid-column-#{@options[:width] || 'one-third'}"
+
+            @title = title
+            @href = href
+            @description = description
+          end
+
+          # Generates the HTML for the CCS Dashboard Section Panel
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(**options[:attributes]) do
+              concat(link_to(title, href, class: 'ccs-dashboard-section__panel-title'))
+              concat(tag.p(description, class: 'ccs-dashboard-section__panel-description'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/dashboard_section.rb

@@ -0,0 +1,73 @@
+require_relative '../base'
+require_relative 'dashboard_section/panel'
+
+module CCS
+  module Components
+    module CCS
+      # = CCS Dashboard Section
+      #
+      # This is used for generating the dashboard section component
+      #
+      # @!attribute [r] dashboard_section_panels
+      #   @return [Array<Link>] An array of the initialised dashboard section panels
+      # @!attribute [r] title_text
+      #   @return [String] Text for the title of a dashboard section
+
+      class DashboardSection < Base
+        private
+
+        attr_reader :dashboard_section_panels, :title_text
+
+        public
+
+        # @param dashboard_section_panels [Array<Hash>] An array of options for the dashboard section panels,
+        #                                               See {Components::CCS::DashboardSection::Panel#initialize Panel#initialize} for details of the items in the array.
+        # @param title_text [String] text for the title of a dashboard section
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the dashboard section HTML
+        # @option options [String] :width (default: 'full') the width of the dashboard section
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(dashboard_section_panels:, title_text: nil, **options)
+          super(**options)
+
+          @options[:width] ||= 'full'
+
+          @dashboard_section_panels = dashboard_section_panels.map { |dashboard_section_panel| Panel.new(context: @context, **dashboard_section_panel) }
+          @title_text = title_text
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the CCS dashboard section component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            tag.div(class: 'govuk-grid-row') do
+              tag.div(class: "govuk-grid-column-#{options[:width]}") do
+                if title_text
+                  concat(tag.h2(title_text, class: 'ccs-dashboard-section__heading govuk-heading-m'))
+                  concat(tag.hr(class: 'ccs-dashboard-section__heading-section-break govuk-section-break govuk-section-break--visible'))
+                end
+                concat(tag.div(class: 'ccs-dashboard-section__container') do
+                  tag.div(class: 'govuk-grid-row') do
+                    dashboard_section_panels.each { |dashboard_section_panel| concat(dashboard_section_panel.render) }
+                  end
+                end)
+              end
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the dashboard section
+
+        DEFAULT_ATTRIBUTES = { class: 'ccs-dashboard-section' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer/link.rb

@@ -0,0 +1,55 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer link
+        #
+        # The individual footer footer link item
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the footer link
+        # @!attribute [r] href
+        #   @return [String] The href for the footer link
+        # @!attribute [r] li_class
+        #   @return [String] The class for the li elements
+
+        class Link < Base
+          private
+
+          attr_reader :text, :href, :li_class
+
+          public
+
+          # @param text [String] the text for the footer link
+          # @param href [String] the href for the footer link
+          # @param li_class [String] class for the li elements
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(text:, href:, li_class:, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+            @li_class = li_class
+          end
+
+          # Generates the HTML for the CCS Footer link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li(class: li_class) do
+              options[:attributes][:class] = 'ccs-footer__link'
+
+              link_to(text, href, **options[:attributes])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/ccs/footer/meta.rb

@@ -0,0 +1,59 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module CCS
+      class Footer < Base
+        # = CCS Footer Meta
+        #
+        # The footer meta section
+        #
+        # @!attribute [r] meta_links
+        #   @return [Array<Link>] An array of the initialised meta links
+        # @!attribute [r] visually_hidden_title
+        #   @return [String] Title for the meta section
+        # @!attribute [r] text
+        #   @return [String] Text to add to the meta section of the footer
+
+        class Meta
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :meta_links, :visually_hidden_title, :text
+
+          public
+
+          # @param items [Array<Hash>] an array of links for the meta section.
+          #                            See {Components::CCS::Footer::Link#initialize Link#initialize} for details of the items in the array.
+          # @param visually_hidden_title [String] ('Support links') title for the meta section
+          # @param text [String] text to add to the meta section of the footer
+          # @param context [ActionView::Base] the view context
+
+          def initialize(context:, items: nil, visually_hidden_title: nil, text: nil)
+            @meta_links = items&.map { |meta_link| Link.new(li_class: 'ccs-footer__inline-list-item', context: context, **meta_link) }
+            @visually_hidden_title = visually_hidden_title || 'Support links'
+            @text = text
+          end
+
+          # Generates the HTML for the CCS Footer Meta sections
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            capture do
+              concat(tag.h2(visually_hidden_title, class: 'govuk-visually-hidden'))
+              if meta_links
+                concat(tag.ul(class: 'ccs-footer__inline-list') do
+                  meta_links.each { |meta_link| concat(meta_link.render) }
+                end)
+              end
+              concat(tag.div(text, class: 'ccs-footer__meta-custom')) if text
+            end
+          end
+        end
+      end
+    end
+  end
+end