ccs-frontend_helpers 0.1.0.rc.1

data/lib/ccs/frontend_helpers/govuk_frontend/tag.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+require_relative '../shared_methods'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Tag
+      #
+      # This helper is used for generating the tag component from the
+      # {https://design-system.service.gov.uk/components/tag GDS - Components - Tag}
+
+      module Tag
+        include SharedMethods
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+
+        # Generates the HTML for the GOV.UK Tag component
+        #
+        # @param text [String] the text for the tag
+        # @param colour [String] optional colour for the tag,
+        #                        see {https://design-system.service.gov.uk/components/tag/#additional-colours Tag - Additional colours}
+        #                        for available colours in GOV.UK Frontend
+        # @param govuk_tag_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_tag_options [String] :classes additional CSS classes for the tag HTML
+        # @option govuk_tag_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Tag
+        #                                     which can then be rendered on the page
+
+        def govuk_tag(text, colour = nil, **govuk_tag_options)
+          initialise_attributes_and_set_classes(govuk_tag_options, "govuk-tag #{"govuk-tag--#{colour}" if colour}".rstrip)
+
+          tag.strong(text, **govuk_tag_options[:attributes])
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend/warning_text.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+require_relative '../shared_methods'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Warning text
+      #
+      # This helper is used for generating the warning text component from the
+      # {https://design-system.service.gov.uk/components/warning-text GDS - Components - Warning text}
+
+      module WarningText
+        include SharedMethods
+        include ActionView::Context
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+
+        # Generates the HTML for the GOV.UK Warning text component
+        #
+        # @param text [String] (nil) the text for the warning
+        # @param govuk_warning_text_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_warning_text_options [String] :classes additional CSS classes for the tag HTML
+        # @option govuk_warning_text_options [String] :icon_fallback_text the fallback text for the icon (default: +'Warning'+)
+        # @option govuk_warning_text_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @yield HTML that will be used in the warning text. Ignored if text is passed.
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Warning text
+        #                                     which can then be rendered on the page
+
+        def govuk_warning_text(text = nil, **govuk_warning_text_options)
+          initialise_attributes_and_set_classes(govuk_warning_text_options, 'govuk-warning-text')
+
+          tag.div(**govuk_warning_text_options[:attributes]) do
+            concat(tag.span('!', class: 'govuk-warning-text__icon'))
+            concat(tag.strong(class: 'govuk-warning-text__text') do
+              concat(tag.span(govuk_warning_text_options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
+              if text
+                concat(text)
+              else
+                yield
+              end
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'govuk_frontend/accordion'
+require_relative 'govuk_frontend/back_link'
+require_relative 'govuk_frontend/breadcrumbs'
+require_relative 'govuk_frontend/button'
+require_relative 'govuk_frontend/cookie_banner'
+require_relative 'govuk_frontend/details'
+require_relative 'govuk_frontend/error_message'
+require_relative 'govuk_frontend/error_summary'
+require_relative 'govuk_frontend/field'
+require_relative 'govuk_frontend/field/character_count'
+require_relative 'govuk_frontend/field/checkboxes'
+require_relative 'govuk_frontend/field/date_input'
+require_relative 'govuk_frontend/field/file_upload'
+require_relative 'govuk_frontend/field/input'
+require_relative 'govuk_frontend/field/select'
+require_relative 'govuk_frontend/field/textarea'
+require_relative 'govuk_frontend/field/radios'
+require_relative 'govuk_frontend/fieldset'
+require_relative 'govuk_frontend/footer'
+require_relative 'govuk_frontend/form_group'
+require_relative 'govuk_frontend/header'
+require_relative 'govuk_frontend/hint'
+require_relative 'govuk_frontend/inset_text'
+require_relative 'govuk_frontend/label'
+require_relative 'govuk_frontend/notification_banner'
+require_relative 'govuk_frontend/pagination'
+require_relative 'govuk_frontend/panel'
+require_relative 'govuk_frontend/phase_banner'
+require_relative 'govuk_frontend/skip_link'
+require_relative 'govuk_frontend/step_by_step_navigation'
+require_relative 'govuk_frontend/summary_list'
+require_relative 'govuk_frontend/table'
+require_relative 'govuk_frontend/tabs'
+require_relative 'govuk_frontend/tag'
+require_relative 'govuk_frontend/warning_text'
+
+module CCS
+  module FrontendHelpers
+    # This module loads in all the GOV.UK Frontend Helper methods.
+    # These are a collection of view helpers to help render GOV.UK components
+
+    module GovUKFrontend
+      include Accordion
+      include BackLink
+      include Breadcrumbs
+      include Button
+      include CookieBanner
+      include Details
+      include ErrorMessage
+      include ErrorSummary
+      include Field
+      include Field::CharacterCount
+      include Field::Checkboxes
+      include Field::DateInput
+      include Field::FileUpload
+      include Field::Input
+      include Field::Radios
+      include Field::Select
+      include Field::Textarea
+      include Fieldset
+      include Footer
+      include FormGroup
+      include Header
+      include Hint
+      include InsetText
+      include Label
+      include NotificationBanner
+      include Pagination
+      include Panel
+      include PhaseBanner
+      include SkipLink
+      include StepByStepNavigation
+      include SummaryList
+      include Table
+      include Tabs
+      include Tag
+      include WarningText
+    end
+  end
+end

data/lib/ccs/frontend_helpers/shared_methods.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CCS
+  module FrontendHelpers
+    # This module contains methods that are shared between the helpers
+
+    module SharedMethods
+      # Initialises the attributes and sets the class attribute for a helper
+      #
+      # @param options [Hash] the options for a helper
+      # @param default_class [String] the default class for a helper
+
+      def initialise_attributes_and_set_classes(options, default_class)
+        (options[:attributes] ||= {})[:class] = "#{default_class} #{options[:classes]}".rstrip
+      end
+
+      # Initialises the data-module attribute for a helper
+      #
+      # @param options [Hash] the options for a helper
+      # @param data_module [String] the name of the data module
+
+      def set_data_module(options, data_module)
+        (options[:attributes][:data] ||= {})[:module] = data_module
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CCS
+  module FrontendHelpers
+    VERSION = '0.1.0.rc.1'
+  end
+end

data/lib/ccs/frontend_helpers.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'ccs/frontend_helpers/ccs_frontend'
+require 'ccs/frontend_helpers/govuk_frontend'
+
+require_relative 'frontend_helpers/version'
+
+module CCS
+  # = CCS Frontend Helpers
+  #
+  # The CCS Frontend Helperss module contains view helpers based on:
+  # - {https://design-system.service.gov.uk/components GDS components}
+  # - {https://github.com/tim-s-ccs/ts-ccs-frontend CCS components}
+  # that can be used in Ruby on Rails projects within CCS.
+
+  module FrontendHelpers
+    include CCSFrontend
+    include GovUKFrontend
+  end
+end

data/sig/ccs/frontend_helpers.rbs

@@ -0,0 +1,6 @@
+module CCS
+  module FrontendHelpers
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: ccs-frontend_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc.1
+platform: ruby
+authors:
+- tim-s-ccs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.38.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Gem containing view helpers for CCS Ruby on Rails projects
+email:
+- timothy.south@crowncommercial.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ccs-frontend_helpers.gemspec
+- lib/ccs/frontend_helpers.rb
+- lib/ccs/frontend_helpers/ccs_frontend.rb
+- lib/ccs/frontend_helpers/ccs_frontend/dashboard_panels.rb
+- lib/ccs/frontend_helpers/ccs_frontend/footer.rb
+- lib/ccs/frontend_helpers/ccs_frontend/header.rb
+- lib/ccs/frontend_helpers/ccs_frontend/logo.rb
+- lib/ccs/frontend_helpers/govuk_frontend.rb
+- lib/ccs/frontend_helpers/govuk_frontend/accordion.rb
+- lib/ccs/frontend_helpers/govuk_frontend/back_link.rb
+- lib/ccs/frontend_helpers/govuk_frontend/breadcrumbs.rb
+- lib/ccs/frontend_helpers/govuk_frontend/button.rb
+- lib/ccs/frontend_helpers/govuk_frontend/cookie_banner.rb
+- lib/ccs/frontend_helpers/govuk_frontend/details.rb
+- lib/ccs/frontend_helpers/govuk_frontend/error_message.rb
+- lib/ccs/frontend_helpers/govuk_frontend/error_summary.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/character_count.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/checkboxes.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/date_input.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/file_upload.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/input.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/radios.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/select.rb
+- lib/ccs/frontend_helpers/govuk_frontend/field/textarea.rb
+- lib/ccs/frontend_helpers/govuk_frontend/fieldset.rb
+- lib/ccs/frontend_helpers/govuk_frontend/footer.rb
+- lib/ccs/frontend_helpers/govuk_frontend/form_group.rb
+- lib/ccs/frontend_helpers/govuk_frontend/header.rb
+- lib/ccs/frontend_helpers/govuk_frontend/hint.rb
+- lib/ccs/frontend_helpers/govuk_frontend/inset_text.rb
+- lib/ccs/frontend_helpers/govuk_frontend/label.rb
+- lib/ccs/frontend_helpers/govuk_frontend/notification_banner.rb
+- lib/ccs/frontend_helpers/govuk_frontend/pagination.rb
+- lib/ccs/frontend_helpers/govuk_frontend/panel.rb
+- lib/ccs/frontend_helpers/govuk_frontend/phase_banner.rb
+- lib/ccs/frontend_helpers/govuk_frontend/skip_link.rb
+- lib/ccs/frontend_helpers/govuk_frontend/step_by_step_navigation.rb
+- lib/ccs/frontend_helpers/govuk_frontend/summary_list.rb
+- lib/ccs/frontend_helpers/govuk_frontend/table.rb
+- lib/ccs/frontend_helpers/govuk_frontend/tabs.rb
+- lib/ccs/frontend_helpers/govuk_frontend/tag.rb
+- lib/ccs/frontend_helpers/govuk_frontend/warning_text.rb
+- lib/ccs/frontend_helpers/shared_methods.rb
+- lib/ccs/frontend_helpers/version.rb
+- sig/ccs/frontend_helpers.rbs
+homepage: https://github.com/tim-s-ccs/ccs-frontend_helpers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tim-s-ccs/ccs-frontend_helpers
+  source_code_uri: https://github.com/tim-s-ccs/ccs-frontend_helpers
+  changelog_uri: https://github.com/tim-s-ccs/ccs-frontend_helpers/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Gem containing view helpers for CCS Ruby on Rails projects
+test_files: []