ccs-frontend_helpers 0.1.0.rc.7 → 0.1.0

data/lib/ccs/components/govuk/phase_banner.rb

@@ -1,69 +0,0 @@
-require_relative '../base'
-require_relative 'tag'
-
-module CCS
-  module Components
-    module GovUK
-      # = GOV.UK Phase banner
-      #
-      # This is used to generate the phase banner component from the
-      # {https://design-system.service.gov.uk/components/phase-banner GDS - Components - Phase banner}
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the phase banner
-      # @!attribute [r] tag_options
-      #   @return [Hash] Options for the phase banner tag
-
-      class PhaseBanner < Base
-        private
-
-        attr_reader :text, :tag_options
-
-        public
-
-        # @param tag_options [Hash] paramters for the govuk tag (see {Components::GovUK::Tag Tag}).
-        #                           options are:
-        #                           - +text+
-        #                           - +colour+
-        #                           - +options+
-        # @param text [String] the text for the phase banner.
-        #                      If nil, then a block will be rendered
-        # @param options [Hash] options that will be used in customising the HTML
-        #
-        # @option options [String] :classes additional CSS classes for the phase banner HTML
-        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-        def initialize(tag_options:, text: nil, **options)
-          super(**options)
-
-          tag_options[:classes] = "govuk-phase-banner__content__tag #{tag_options[:classes]}".rstrip
-          tag_options[:context] = @context
-
-          @text = text
-          @tag_options = tag_options
-        end
-
-        # Generates the HTML for the GOV.UK Phase banner component
-        #
-        # @yield HTML that will be used in the phase banner. Ignored if text is passed.
-        #
-        # @return [ActiveSupport::SafeBuffer]
-
-        def render
-          tag.div(**options[:attributes]) do
-            tag.p(class: 'govuk-phase-banner__content') do
-              concat(Tag.new(**tag_options).render)
-              concat(tag.span(class: 'govuk-phase-banner__text') do
-                text || yield
-              end)
-            end
-          end
-        end
-
-        # The default attributes for the phase banner
-
-        DEFAULT_ATTRIBUTES = { class: 'govuk-phase-banner' }.freeze
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/skip_link.rb

@@ -1,51 +0,0 @@
-require_relative '../base'
-
-module CCS
-  module Components
-    module GovUK
-      # = GOV.UK Skip Link
-      #
-      # This is used to generate the skip link component from the
-      # {https://design-system.service.gov.uk/components/skip-link GDS - Components - Skip link}
-      #
-      # @!attribute [r] text
-      #   @return [String] Text for the skip link
-      # @!attribute [r] href
-      #   @return [String] The href for the skip link
-
-      class SkipLink < Base
-        private
-
-        attr_reader :text, :href
-
-        public
-
-        # @param text [String] the text for the skip link
-        # @param href [String] the href for the skip link
-        # @param options [Hash] options that will be used in customising the HTML
-        #
-        # @option options [String] :classes additional CSS classes for the skip link HTML
-        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-        def initialize(text:, href: nil, **options)
-          super(**options)
-
-          @text = text
-          @href = href || '#content'
-        end
-
-        # Generates the HTML for the GOV.UK Skip link component
-        #
-        # @return [ActiveSupport::SafeBuffer]
-
-        def render
-          link_to(text, href, **options[:attributes])
-        end
-
-        # The default attributes for the skip link
-
-        DEFAULT_ATTRIBUTES = { class: 'govuk-skip-link', data: { module: 'govuk-skip-link' } }.freeze
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/list/item.rb

@@ -1,53 +0,0 @@
-require 'action_view'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        class Section < Base
-          class Content
-            class List
-              # = GOV.UK Step by step navigation section content list item
-              #
-              # Generates the list item HTML for the step by step navigation section content
-              #
-              # @!attribute [r] text
-              #   @return [String] Text for the list item
-              # @!attribute [r] classes
-              #   @return [String] HTML classes for the list item
-
-              class Item
-                include ActionView::Context
-                include ActionView::Helpers
-
-                private
-
-                attr_reader :text, :classes
-
-                public
-
-                # @param text [String] the text for the list item
-                # @param no_marker [Boolean] flag to hide the bullet marker
-
-                def initialize(text:, no_marker: nil)
-                  @text = text
-                  @classes = "gem-c-step-nav__list-item js-list-item #{'gem-c-step-nav__list--no-marker' if no_marker}".rstrip
-                end
-
-                # Generates the HTML for an individual the GOV.UK Step by step navigation list item
-                #
-                # @return [ActiveSupport::SafeBuffer]
-
-                def render
-                  tag.li(class: classes) do
-                    tag.span(text)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/list.rb

@@ -1,50 +0,0 @@
-require 'action_view'
-
-require_relative 'list/item'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        class Section < Base
-          class Content
-            # = GOV.UK Step by step navigation section content list
-            #
-            # Generates the list HTML for the step by step navigation section content
-            #
-            # @!attribute [r] items
-            #   @return [Item] Array of initialised list items
-
-            class List
-              include ActionView::Context
-              include ActionView::Helpers
-
-              private
-
-              attr_reader :items
-
-              public
-
-              # @param items [Array<Hash>] An array of options for the list items
-              #                            See {Components::GovUK::StepByStepNavigation::Section::Content::List::Item#initialize Item#initialize} for details of the items in the array.
-
-              def initialize(items:)
-                @items = items.map { |item| Item.new(**item) }
-              end
-
-              # Generates the HTML for the GOV.UK Step by step navigation section content list
-              #
-              # @return [ActiveSupport::SafeBuffer]
-
-              def render
-                tag.ul(class: 'gem-c-step-nav__list gem-c-step-nav__list--choice', data: { length: items.length.to_s }) do
-                  items.each { |item| concat(item.render) }
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content/paragraph.rb

@@ -1,45 +0,0 @@
-require 'action_view'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        class Section < Base
-          class Content
-            # = GOV.UK Step by step navigation section content paragraph
-            #
-            # Generates the paragraph HTML for the step by step navigation section content
-            #
-            # @!attribute [r] text
-            #   @return [String] Text for the paragraph
-
-            class Paragraph
-              include ActionView::Context
-              include ActionView::Helpers
-
-              private
-
-              attr_reader :text
-
-              public
-
-              # @param text [String] the text for the paragraph
-
-              def initialize(text:)
-                @text = text
-              end
-
-              # Generates the HTML for the GOV.UK Step by step navigation section content paragraph
-              #
-              # @return [ActiveSupport::SafeBuffer]
-
-              def render
-                tag.p(text, class: 'gem-c-step-nav__paragraph')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section/content.rb

@@ -1,63 +0,0 @@
-require 'action_view'
-
-require_relative 'content/list'
-require_relative 'content/paragraph'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        class Section < Base
-          # = GOV.UK Step by step navigation section content
-          #
-          # The content for a navigation section
-          #
-          # @!attribute [r] section_id
-          #   @return [String] ID for the section content
-          # @!attribute [r] content_items
-          #   @return [Array<Paragraph|List>] An array of the initialised content items
-
-          class Content
-            include ActionView::Context
-            include ActionView::Helpers
-
-            private
-
-            attr_reader :section_id, :content_items
-
-            public
-
-            # @param content_items [Array<Hash>] array of content items.
-            #                                  If the type is +:paragraph+, see {Components::GovUK::StepByStepNavigation::Section::Content::Paragraph#initialize Paragraph#initialize}.
-            #                                  If the type is +:list+, see {Components::GovUK::StepByStepNavigation::Section::Content::List#initialize List#initialize}.
-            # @param index [String] the index of the section
-            # @param id [String] the id of the section
-
-            def initialize(content_items:, index:, id:)
-              @section_id = "step-panel-#{id}-#{index}"
-
-              @content_items = content_items.map do |content_item|
-                case content_item[:type]
-                when :paragraph
-                  Paragraph.new(text: content_item[:text])
-                when :list
-                  List.new(items: content_item[:items])
-                end
-              end
-            end
-
-            # Generates the HTML for the GOV.UK Step by step navigation section content
-            #
-            # @return [ActiveSupport::SafeBuffer]
-
-            def render
-              tag.div(class: 'gem-c-step-nav__panel js-panel', id: section_id) do
-                content_items.each { |content_item| concat(content_item.render) }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section/heading.rb

@@ -1,69 +0,0 @@
-require 'action_view'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        class Section < Base
-          # = GOV.UK Step by step navigation section heading
-          #
-          # The heading for a navigation section
-          #
-          # @!attribute [r] text
-          #   @return [String] Text for the section heading
-          # @!attribute [r] index
-          #   @return [String] Index of the section
-          # @!attribute [r] logic
-          #   @return [String] Optional text to show in the sidebar
-
-          class Heading
-            include ActionView::Context
-            include ActionView::Helpers
-
-            private
-
-            attr_reader :text, :index, :logic
-
-            public
-
-            # @param text [String] text for the section heading
-            # @param index [String] the index of the section
-            # @param logic [String] text to show instead of a number in the sidebar
-
-            def initialize(text:, index:, logic: nil)
-              @text = text
-              @index = index
-              @logic = logic
-            end
-
-            # rubocop:disable Metrics/AbcSize
-
-            # Generates the HTML for the GOV.UK Step by step navigation section heading
-            #
-            # @return [ActiveSupport::SafeBuffer]
-
-            def render
-              tag.div(class: 'gem-c-step-nav__header js-toggle-panel', data: { position: index }) do
-                tag.h2(class: 'gem-c-step-nav__title') do
-                  concat(tag.span(class: "gem-c-step-nav__circle gem-c-step-nav__circle--#{logic ? 'logic' : 'number'}") do
-                    tag.span(class: 'gem-c-step-nav__circle-inner') do
-                      tag.span(class: 'gem-c-step-nav__circle-background') do
-                        concat(tag.span('Step', class: 'govuk-visually-hidden'))
-                        concat(logic || index)
-                      end
-                    end
-                  end)
-                  concat(tag.span(class: 'js-step-title') do
-                    tag.span(text, class: 'js-step-title-text')
-                  end)
-                end
-              end
-            end
-
-            # rubocop:enable Metrics/AbcSize
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation/section.rb

@@ -1,56 +0,0 @@
-require_relative '../../base'
-require_relative 'section/heading'
-require_relative 'section/content'
-
-module CCS
-  module Components
-    module GovUK
-      class StepByStepNavigation < Base
-        # = GOV.UK Step by step navigation section
-        #
-        # The individual section for the step by step navigation
-        #
-        # @!attribute [r] heading
-        #   @return [Heading] Initialised heading for the section
-        # @!attribute [r] content
-        #   @return [Content] Initialised content for the section
-
-        class Section < Base
-          private
-
-          attr_reader :heading, :content
-
-          public
-
-          # @param heading [Hash] options for the section heading.
-          #                      See {Components::GovUK::StepByStepNavigation::Section::Heading#initialize Heading#initialize} for details of the options.
-          # @param content [Hash] options for the section content.
-          #                       See {Components::GovUK::StepByStepNavigation::Section::Content#initialize Content#initialize} for details of the options.
-          # @param index [String] the index of the section
-          # @param context [ActionView::Base] the view context
-
-          def initialize(heading:, content:, index:, context:)
-            super(context: context)
-
-            @options[:attributes][:class] = 'gem-c-step-nav__step js-step'
-            @options[:attributes][:id] = heading[:text].downcase.gsub(' ', '-').gsub('(', '').gsub(')', '')
-
-            @heading = Heading.new(index: index, **heading)
-            @content = Content.new(content_items: content, index: index, id: @options[:attributes][:id])
-          end
-
-          # Generates the HTML for the GOV.UK Step by step navigation section
-          #
-          # @return [ActiveSupport::SafeBuffer]
-
-          def render
-            tag.li(class: @options[:attributes][:class], id: @options[:attributes][:id]) do
-              concat(heading.render)
-              concat(content.render)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/step_by_step_navigation.rb

@@ -1,59 +0,0 @@
-require_relative '../base'
-require_relative 'step_by_step_navigation/section'
-
-module CCS
-  module Components
-    module GovUK
-      # = GOV.UK Step by step navigation
-      #
-      # This is used for generating the Step by step navigation component from the
-      # {https://design-system.service.gov.uk/patterns/step-by-step-navigation/ GDS - Pages - Step by step navigation}
-      #
-      # @!attribute [r] step_by_step_navigation_sections
-      #   @return [Array<Section>] An array of the initialised step by step navigation sections
-
-      class StepByStepNavigation < Base
-        private
-
-        attr_reader :step_by_step_navigation_sections
-
-        public
-
-        # @param step_by_step_navigation_sections [Array<Hash>] An array of options for the step by step navigation section.
-        #                                                       See {Components::GovUK::StepByStepNavigation::Section#initialize Section#initialize} for details of the items in the array.
-        # @param options [Hash] options that will be used in customising the HTML
-        #
-        # @option options [String] :classes additional CSS classes for the step by step navigation HTML
-        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-        def initialize(step_by_step_navigation_sections:, **options)
-          super(**options)
-
-          DEFAULT_SHOW_HIDE_TEXT.each { |key, value| @options[:attributes][:data][key] ||= value }
-
-          @step_by_step_navigation_sections = step_by_step_navigation_sections.map.with_index(1) { |step_by_step_section, index| Section.new(index: index.to_s, context: @context, **step_by_step_section) }
-        end
-
-        # Generates the HTML for the GOV.UK Step by step navigation component (experimental)
-        #
-        # @return [ActiveSupport::SafeBuffer]
-
-        def render
-          tag.div(**options[:attributes]) do
-            tag.ol(class: 'gem-c-step-nav__steps') do
-              step_by_step_navigation_sections.each { |step_by_step_navigation_section| concat(step_by_step_navigation_section.render) }
-            end
-          end
-        end
-
-        # The default attributes for the step byt step navigation
-
-        DEFAULT_ATTRIBUTES = { class: 'gem-c-step-nav gem-c-step-nav--large gem-c-step-nav--active', data: { module: 'govuk-step-by-step-navigation' } }.freeze
-
-        # Default text for the show and hide buttons which are part of each section
-
-        DEFAULT_SHOW_HIDE_TEXT = { 'show-text': 'Show', 'hide-text': 'Hide', 'show-all-text': 'Show all', 'hide-all-text': 'Hide all' }.freeze
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/summary_list/action/link.rb

@@ -1,59 +0,0 @@
-require_relative '../../../base'
-
-module CCS
-  module Components
-    module GovUK
-      class SummaryList < Base
-        class Action
-          # = GOV.UK Summary list action link
-          #
-          # @!attribute [r] text
-          #   @return [String] Text for the action link
-          # @!attribute [r] href
-          #   @return [String] The href for the action link
-          # @!attribute [r] visually_hidden_text
-          #   @return [String] Visually hidden text for the action link
-
-          class Link < Base
-            private
-
-            attr_reader :text, :href, :visually_hidden_text
-
-            public
-
-            # @param text [String] the text for the action link
-            # @param href [String] the href for the action link
-            # @param visually_hidden_text [String] optional visually hidden text for the action link
-            # @param options [Hash] options that will be used in customising the HTML
-            #
-            # @option options [String] :classes additional CSS classes for the summary list action link HTML
-            # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
-
-            def initialize(text:, href:, visually_hidden_text: nil, **options)
-              super(**options)
-
-              @text = text
-              @href = href
-              @visually_hidden_text = visually_hidden_text
-            end
-
-            # Generates the HTML for the GOV.UK Summary list action link
-            #
-            # @return [ActiveSupport::SafeBuffer]
-
-            def render
-              link_to(href, **@options[:attributes]) do
-                concat(text)
-                concat(tag.span(visually_hidden_text, class: 'govuk-visually-hidden')) if visually_hidden_text
-              end
-            end
-
-            # The default attributes for the summary list action link
-
-            DEFAULT_ATTRIBUTES = { class: 'govuk-link' }.freeze
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/summary_list/card/actions.rb

@@ -1,59 +0,0 @@
-require_relative '../../../base'
-require_relative '../action/link'
-
-module CCS
-  module Components
-    module GovUK
-      class SummaryList < Base
-        class Card < Base
-          # = GOV.UK Summary list card actions
-          #
-          # @!attribute [r] action_links
-          #   @return [Array<Action::Link>] An array of the initialised aummary list card action links
-
-          class Actions < Base
-            private
-
-            attr_reader :action_links
-
-            public
-
-            # @param items [Array<Hash>] An array of attributes for the action links.
-            #                            See {Components::GovUK::SummaryList::Action::Link#initialize Action::Link#initialize} for details of the items in the array.
-            # @param options [Hash] options that will be used in customising the HTML
-            #
-            # @option options [String] :classes additional CSS classes for the summary list card actions HTML
-
-            def initialize(items:, **options)
-              super(**options)
-
-              @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
-            end
-
-            # Generates the HTML for the GOV.UK Summary list card actions
-            #
-            # @return [ActiveSupport::SafeBuffer]
-
-            def render
-              if action_links.length == 1
-                tag.div(class: @options[:attributes][:class]) do
-                  action_links.first.render
-                end
-              else
-                tag.ul(class: @options[:attributes][:class]) do
-                  action_links.each do |action_link|
-                    concat(tag.li(action_link.render, class: 'govuk-summary-card__action'))
-                  end
-                end
-              end
-            end
-
-            # The default attributes for the summary list card actions
-
-            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__actions' }.freeze
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ccs/components/govuk/summary_list/card/title.rb

@@ -1,51 +0,0 @@
-require_relative '../../../base'
-
-module CCS
-  module Components
-    module GovUK
-      class SummaryList < Base
-        class Card < Base
-          # = GOV.UK Summary list card title
-          #
-          # @!attribute [r] text
-          #   @return [String] Text for the title
-          # @!attribute [r] heading_level
-          #   @return [String] Heading level for the title
-
-          class Title < Base
-            private
-
-            attr_reader :text, :heading_level
-
-            public
-
-            # @param text [String] the text for the title
-            # @param heading_level [String] heading level, from 1 to 6
-            # @param options [Hash] options that will be used in customising the HTML
-            #
-            # @option options [String] :classes additional CSS classes for the summary list card title HTML
-
-            def initialize(text:, heading_level: '2', **options)
-              super(**options)
-
-              @text = text
-              @heading_level = heading_level
-            end
-
-            # Generates the HTML for the GOV.UK Summary list card title
-            #
-            # @return [ActiveSupport::SafeBuffer]
-
-            def render
-              tag.send("h#{heading_level}", text, class: @options[:attributes][:class])
-            end
-
-            # The default attributes for the summary list card title
-
-            DEFAULT_ATTRIBUTES = { class: 'govuk-summary-card__title' }.freeze
-          end
-        end
-      end
-    end
-  end
-end