ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a550b15fe6ba2415299994f716d842c129687e2c5fe8e124fbbf09332913d7
-  data.tar.gz: a9be14a1105948400e4445694e339981b9a1e51cdb9d9c8111a01f2f35dca9ab
+  metadata.gz: 47cea0efab0b2b500e61c298c3930110edfc8987433b014d6082094879fcb78e
+  data.tar.gz: 3a27eba61118d1fb93527a5974625aafbd8ce48b1afd0129739b83945006e0eb
 SHA512:
-  metadata.gz: b76a6b7e6f0051fd6a9edcf15389da8131d7a2b89688219129817e34418e9ed88de42af7d428e027685d8e53f1da1b85356e3a96e1a2073e2fd07fe4caec3724
-  data.tar.gz: e1ae5adbf67d42896182efeae3944bf6ac8fbbe5192acd425083c725257b2203bcbe78748856ddd74a4de93b8eda95712218a10019af6084b2c94bbd3ce32bb1
+  metadata.gz: beb74c7841592955c2e009db103968abf0c3a24c8fa374de5fcf972678f65df466b1be4a0d76ba04625302ecae99ca2e5ef46d10583f8220517529102574c783
+  data.tar.gz: 29d451b4b057b3387e82fd7db170f5f4450aeac37afeab81059593b0162a1e5834b40af79cb2cb131283d0f507a9111ff1c21e25d367ef6262745df44acad9b3

data/.rubocop.yml

@@ -3,10 +3,11 @@ require:
   - rubocop-rspec
   - rubocop-rails
   - rubocop-rake
+  - rubocop-capybara
 
 AllCops:
     NewCops: enable
-    TargetRubyVersion: 2.7
+    TargetRubyVersion: 3.0
     Exclude:
         - 'bin/**/*'
         - 'tmp/**/*'
@@ -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,9 @@ RSpec/MultipleExpectations:
 RSpec/FilePath:
     CustomTransform:
         GovUKFrontend: govuk_frontend
+        GovUK: govuk
+
+RSpec/SpecFilePathFormat:
+    CustomTransform:
+        GovUKFrontend: govuk_frontend
+        GovUK: govuk

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [0.1.0] - 2023-02-22
+## [0.1.1.rc.1] - 2023-10-25
 
 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

@@ -5,6 +5,20 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ccs-frontend_helpers.gemspec
 gemspec
 
+# Gems for building the package
+gem 'bundler', '~> 2.3'
 gem 'rake', '~> 13.0'
 
-gem 'rspec', '~> 3.0'
+# Gems for testing the package
+gem 'capybara', '~> 3.39.2'
+gem 'rspec', '~> 3.12'
+gem 'simplecov', '~> 0.21'
+
+# Gems for linting/formatting the package
+gem 'rubocop', '~> 1.57'
+gem 'rubocop-rails', '~> 2.21'
+gem 'rubocop-rake', '~> 0.6'
+gem 'rubocop-rspec', '~> 2.24'
+
+# Gems for documenting the package
+gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -1,82 +1,92 @@
 PATH
   remote: .
   specs:
-    ccs-frontend_helpers (0.1.0)
+    ccs-frontend_helpers (0.1.1.rc.1)
       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.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
       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)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
       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.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
       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)
-      rack (~> 2.0, >= 2.2.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       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)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.1)
+      actionpack (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
       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)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
       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.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activestorage (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activesupport (= 7.1.1)
       marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
     builder (3.2.4)
-    capybara (3.38.0)
+    capybara (3.39.2)
       addressable
       matrix
       mini_mime (>= 0.1.3)
@@ -85,20 +95,28 @@ 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)
+    connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    drb (2.1.1)
+      ruby2_keywords
     erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
     json (2.6.3)
-    loofah (2.19.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.4)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -106,61 +124,76 @@ GEM
       net-smtp
     marcel (1.0.2)
     matrix (0.4.2)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
-    minitest (5.17.0)
-    net-imap (0.3.4)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.2)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.1)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.4.0)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.1-x86_64-darwin)
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.1-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
+    psych (5.1.1.1)
+      stringio
     public_suffix (5.0.1)
-    racc (1.6.2)
-    rack (2.2.6.2)
-    rack-test (2.0.2)
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    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)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.1)
+      actioncable (= 7.1.1)
+      actionmailbox (= 7.1.1)
+      actionmailer (= 7.1.1)
+      actionpack (= 7.1.1)
+      actiontext (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activemodel (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.1.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       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)
-      method_source
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      irb
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.2)
+    reline (0.3.9)
+      io-console (~> 0.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -174,50 +207,56 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.57.1)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.4)
       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.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-rails (2.17.4)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rails (2.21.2)
       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.24.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.1)
-    timeout (0.3.1)
+    stringio (3.0.8)
+    thor (1.3.0)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    webrick (1.7.0)
-    websocket-driver (0.7.5)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.6)
+    yard (0.9.34)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-darwin-19
@@ -226,16 +265,16 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.3)
-  capybara (~> 3.38.0)
+  capybara (~> 3.39.2)
   ccs-frontend_helpers!
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.36)
-  rubocop-rails (~> 2.16)
+  rspec (~> 3.12)
+  rubocop (~> 1.57)
+  rubocop-rails (~> 2.21)
   rubocop-rake (~> 0.6)
-  rubocop-rspec (~> 2.13)
+  rubocop-rspec (~> 2.24)
   simplecov (~> 0.21)
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.3.12
+   2.3.24

data/ccs-frontend_helpers.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Gem containing view helpers for CCS Ruby on Rails projects'
   spec.homepage = 'https://github.com/tim-s-ccs/ccs-frontend_helpers'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
@@ -33,15 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rails', '>= 6.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.3'
-  spec.add_development_dependency 'capybara', '~> 3.38.0'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.36'
-  spec.add_development_dependency 'rubocop-rails', '~> 2.16'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.13'
-  spec.add_development_dependency 'simplecov', '~> 0.21'
-  spec.add_development_dependency 'yard', '~> 0.9'
-
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

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