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

data/lib/ccs/components/govuk/field/inputs/date_input/item.rb

@@ -0,0 +1,63 @@
+require_relative '../date_input'
+require_relative '../../input/text_input'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class DateInput < Inputs
+          # = GOV.UK Date Inputs item
+          #
+          # This is used to generate an individual date input item
+          #
+          # @!attribute [r] input
+          #   @return [TextInput] The initialised text input for the date item
+
+          class Item
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :input
+
+            public
+
+            # rubocop:disable Metrics/ParameterLists
+
+            # @param attribute [String,Symbol] the attribute for the date inputs
+            # @param name [String] the name of the date input item
+            # @param input [Hash] options for the input of the date input item, see {CCS::Components::GovUK::Field::Input::TextInput#initialize TextInput#initialize} for more details.
+            # @param label [Hash] options for the label of the date input item, see {CCS::Components::GovUK::Label#initialize Label#initialize} for more details.
+            # @param context [ActionView::Base] the view context
+            #
+            # @option options [Hash] error_message used as a flag to add the error classes to the item
+            # @option options [ActiveModel] :model (nil) optional model used to create the field
+            # @option options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create the field
+
+            def initialize(attribute:, name:, context:, input: {}, label: {}, **options)
+              input[:classes] = "govuk-date-input__input #{input[:classes]}".rstrip
+              input[:classes] << ' govuk-input--error' if options[:error_message]
+              (input[:attributes] ||= {})[:inputmode] ||= 'numeric'
+
+              label[:text] ||= name.capitalize
+              label[:classes] = 'govuk-date-input__label'
+
+              @input = Input::TextInput.new(attribute: "#{attribute}_#{name}", label: label, model: options[:model], form: options[:form], context: context, **input)
+            end
+
+            # rubocop:enable Metrics/ParameterLists
+
+            # Generates the HTML for the date input item
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(input.render, class: 'govuk-date-input__item')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/date_input.rb

@@ -0,0 +1,87 @@
+require_relative '../input'
+require_relative 'date_input/item'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        # = GOV.UK Date Input
+        #
+        # This is used for generating the date input component from the
+        # {https://design-system.service.gov.uk/components/date-input GDS - Components -  Date Input}
+        #
+        # @!attribute [r] date_input_items
+        #   @return [Array<DateInput::Item>] An array of the initialised date input items
+
+        class DateInput < Inputs
+          private
+
+          attr_reader :date_input_items
+
+          public
+
+          # @param (see CCS::Components::GovUK::Field::Inputs#initialize)
+          # @param date_items [Array<Hash>] an array of options for the date items.
+          #                                 See {Components::GovUK::Field::Inputs::DateInput::Item#initialize Item#initialize} for details of the items in the array.
+          #
+          # @option (see CCS::Components::GovUK::Field::Inputs#initialize)
+
+          def initialize(attribute:, date_items: default_date_items, **options)
+            (options[:fieldset][:attributes] ||= {})[:role] = 'group'
+
+            super(attribute: attribute, **options)
+
+            # date_items ||= default_date_items
+
+            @date_input_items = date_items.map { |date_input_item| Item.new(attribute: attribute, error_message: @error_message, model: @options[:model], form: @options[:form], context: @context, **date_input_item) }
+          end
+
+          # Generates the HTML for the GOV.UK date input component
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do
+              tag.div(**options[:attributes]) do
+                date_input_items.each { |date_input_item| concat(date_input_item.render) }
+              end
+            end
+          end
+
+          # The default attributes for the date input
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-date-input' }.freeze
+
+          private
+
+          # The default date items used if no date items are provided
+          #
+          # @return [Array<Hash>]
+
+          def default_date_items
+            [
+              {
+                name: 'day',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'month',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'year',
+                input: {
+                  classes: 'govuk-input--width-4'
+                }
+              }
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/checkbox/form.rb

@@ -0,0 +1,45 @@
+require_relative '../checkbox'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          class Checkbox < Item
+            # = GOV.UK Field Inputs Checkbox form tag
+            #
+            # This is used to generate an individual checkbox item using +form.check_box+
+
+            class Form < Checkbox
+              # @param (see CCS::Components::GovUK::Field::Items::Item::Checkbox#initialize)
+              #
+              # @option (see CCS::Components::GovUK::Field::Items::Item::Checkbox#initialize)
+
+              def initialize(attribute:, label:, **options)
+                super(attribute: attribute, label: label, **options)
+
+                (label[:attributes] ||= {})[:value] = @value
+                label[:attributes][:for] = @options[:attributes][:id] if @options[:attributes][:id]
+
+                @options[:attributes][:multiple] = true
+                @options[:attributes][:include_hidden] = false
+
+                @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
+              end
+
+              # Generates the HTML for the checkbox input
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                super() do
+                  @options[:form].check_box(@attribute, @options[:attributes], @value)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/checkbox/tag.rb

@@ -0,0 +1,41 @@
+require_relative '../checkbox'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          class Checkbox < Item
+            # = GOV.UK Field Inputs Checkbox tag
+            #
+            # This is used to generate an individual checkbox item using +check_box_tag+
+
+            class Tag < Checkbox
+              # @param (see CCS::Components::GovUK::Field::Items::Item::Checkbox#initialize)
+              #
+              # @option (see CCS::Components::GovUK::Field::Items::Item::Checkbox#initialize)
+
+              def initialize(attribute:, label:, **options)
+                super(attribute: attribute, label: label, **options)
+
+                @options[:attributes][:id] ||= "#{sanitize_to_id(@attribute)}_#{sanitize_to_id(@value)}"
+
+                @label = Label.new(attribute: @options[:attributes][:id], context: @context, **label)
+              end
+
+              # Generates the HTML for the checkbox input
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                super() do
+                  context.check_box_tag("#{@attribute}[]", @value, @options[:checked], **@options[:attributes])
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/checkbox.rb

@@ -0,0 +1,48 @@
+require_relative '../item'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          # = GOV.UK Field Inputs Checkbox
+          #
+          # This is used to generate an individual checkbox item
+
+          class Checkbox < Item
+            # @param (see CCS::Components::GovUK::Field::Items::Item#initialize)
+            # label [Hash] attributes for the checkbox label, see {CCS::Components::GovUK::Label#initialize Label#initialize} for more details.
+            #
+            # @option (see CCS::Components::GovUK::Field::Items::Item#initialize))
+
+            def initialize(attribute:, label:, **options)
+              super(attribute: attribute, **options)
+
+              label[:classes] = "govuk-checkboxes__label #{label[:classes]}".rstrip
+            end
+
+            # Generates the HTML to wrap arround a checkbox input
+            #
+            # @yield the checkbox item input HTML
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render(&block)
+              tag.div(class: 'govuk-checkboxes__item') do
+                super(&block)
+              end
+            end
+
+            # The default attributes for the checkbox
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-checkboxes__input' }.freeze
+
+            # The type of the input item
+
+            ITEM_TYPE = 'checkboxes'.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/divider.rb

@@ -0,0 +1,48 @@
+require 'action_view'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          # = GOV.UK Field Inputs item divider
+          #
+          # The divider for input items e.g. {CCS::Components::GovUK::Field::Inputs::Checkboxes Checkboxes} or {CCS::Components::GovUK::Field::Inputs::Radios Radios}
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the divider
+          # @!attribute [r] type
+          #   @return [String] The type of the item
+
+          class Divider
+            include ActionView::Context
+            include ActionView::Helpers
+
+            private
+
+            attr_reader :text, :type
+
+            public
+
+            # @param divider [String] the text for the divider
+            # @param type [String] the type of the item divider.
+            #                      One of +'checkboxes'+ or +'radios'+
+
+            def initialize(divider:, type:)
+              @text = divider
+              @type = type
+            end
+
+            # Generates the HTML for an item divider
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(text, class: "govuk-#{type}__divider")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/radio/form.rb

@@ -0,0 +1,42 @@
+require_relative '../radio'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          class Radio < Item
+            # = GOV.UK Field Inputs Radio form tag
+            #
+            # This is used to generate an individual radio item using +form.check_box+
+
+            class Form < Radio
+              # @param (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+              #
+              # @option (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+
+              def initialize(attribute:, label:, **options)
+                super(attribute: attribute, label: label, **options)
+
+                (label[:attributes] ||= {})[:value] = @value
+                label[:attributes][:for] = @options[:attributes][:id] if @options[:attributes][:id]
+
+                @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
+              end
+
+              # Generates the HTML for the radio input
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                super() do
+                  @options[:form].radio_button(@attribute, @value, **@options[:attributes])
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/radio/tag.rb

@@ -0,0 +1,41 @@
+require_relative '../radio'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          class Radio < Item
+            # = GOV.UK Field Inputs Radio tag
+            #
+            # This is used to generate an individual radio item using +radio_button_tag+
+
+            class Tag < Radio
+              # @param (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+              #
+              # @option (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+
+              def initialize(attribute:, label:, **options)
+                super(attribute: attribute, label: label, **options)
+
+                @options[:attributes][:id] ||= "#{sanitize_to_id(@attribute)}_#{sanitize_to_id(@value)}"
+
+                @label = Label.new(attribute: @options[:attributes][:id], context: @context, **label)
+              end
+
+              # Generates the HTML for the radio input
+              #
+              # @return [ActiveSupport::SafeBuffer]
+
+              def render
+                super() do
+                  context.radio_button_tag(@attribute, @value, @options[:checked], **@options[:attributes])
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item/radio.rb

@@ -0,0 +1,48 @@
+require_relative '../item'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        class Item < Base
+          # = GOV.UK Field Inputs Radio
+          #
+          # This is used to generate an individual radio item
+
+          class Radio < Item
+            # @param (see CCS::Components::GovUK::Field::Items::Item#initialize)
+            # label [Hash] attributes for the radio label, see {CCS::Components::GovUK::Label#initialize Label#initialize} for more details.
+            #
+            # @option (see CCS::Components::GovUK::Field::Items::Item#initialize))
+
+            def initialize(attribute:, label:, **options)
+              super(attribute: attribute, **options)
+
+              label[:classes] = "govuk-radios__label #{label[:classes]}".rstrip
+            end
+
+            # Generates the HTML to wrap arround a radio input
+            #
+            # @yield the radio item input HTML
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render(&block)
+              tag.div(class: 'govuk-radios__item') do
+                super(&block)
+              end
+            end
+
+            # The default attributes for the radio
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-radios__input' }.freeze
+
+            # The type of the input item
+
+            ITEM_TYPE = 'radios'.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/item.rb

@@ -0,0 +1,109 @@
+require_relative '../inputs'
+require_relative '../../label'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        # = GOV.UK Field Inputs Item
+        #
+        # This class is used to provided the shared HTML for a
+        # {Components::GovUK::Field::Inputs::Item::Checkbox checkbox item} or {Components::GovUK::Field::Inputs::Item::Radio radio item}.
+        # It wraps these items with the following:
+        # - Item label
+        # - Item hint
+        # - Item conditional content
+        #
+        # @!attribute [r] attribute
+        #   @return [String,Symbol] The attribute of the item
+        # @!attribute [r] value
+        #   @return [String] The value of the item
+        # @!attribute [r] label
+        #   @return [Label] The initialised item label
+        # @!attribute [r] hint
+        #   @return [Hint] The initialised item hint
+        # @!attribute [r] conditional_content
+        #   @return [ActiveSupport::SafeBuffer] The conditional HTML
+
+        class Item < Base
+          private
+
+          attr_reader :attribute, :value, :label, :hint, :conditional_content
+
+          public
+
+          # @param attribute [String,Symbol] the attribute of the item
+          # @param value [String] the value of the item
+          # @param hint [Hash] options for an item hint see {CCS::Components::GovUK::Hint#initialize Hint#initialize} for more details.
+          #                    If no hint is given then no hint will be rendered
+          # @param conditional [Hash] content that will appear if the item is checked.
+          #                           If no conditional is given then no conditional content will be rendered
+          #
+          # @option options [String] :classes additional CSS classes for the item HTML
+          # @option options [Boolean] :checked flag to indicate if the item is checked
+          # @option options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create item HTML
+          # @option options [Hash] :attributes ({}) any additional attributes that will be added as part of the item HTML
+          #
+          # @option conditional [ActiveSupport::SafeBuffer] content the HTML content
+          # @option conditional [Hash] attributes[:id] the id of the conditional section
+
+          def initialize(attribute:, value:, hint: nil, conditional: nil, **options)
+            super(**options)
+
+            initialise_item_hint(attribute, value, hint) if hint
+            initialize_item_conditional(attribute, value, conditional) if conditional
+            @attribute = attribute
+            @value = value
+          end
+
+          # Generates the HTML to wrap arround a input
+          #
+          # @yield the item input HTML
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            concat(yield)
+            concat(label.render)
+            concat(hint.render) if hint
+            concat(conditional_content) if conditional_content
+          end
+
+          private
+
+          # Initialises the item hint and adds the aira-describedby attribute for the item
+          #
+          # @param attribute [String, Symbol] the attribute of the item
+          # @param value [String] the value of the item
+          # @param hint [Hash] the options for the hint
+
+          def initialise_item_hint(attribute, value, hint)
+            hint[:attributes] ||= {}
+            hint[:classes] = "govuk-#{self.class::ITEM_TYPE}__hint #{hint[:classes]}".rstrip
+            hint[:attributes][:id] ||= "#{attribute}_#{value}-item-hint"
+
+            (@options[:attributes][:aria] ||= {})[:describedby] = hint[:attributes][:id]
+
+            @hint = Hint.new(context: @context, **hint)
+          end
+
+          # Generate the item conditional HTML and adds the data-aira-controls attribute for the item
+          #
+          # @param attribute [String, Symbol] the attribute of the item
+          # @param value [String] the value of the item
+          # @param conditional [Hash] the options for the conditional
+
+          def initialize_item_conditional(attribute, value, conditional)
+            conditional[:attributes] ||= {}
+            conditional[:attributes][:class] = "govuk-#{self.class::ITEM_TYPE}__conditional #{"govuk-#{self.class::ITEM_TYPE}__conditional--hidden" unless @options[:checked]}".rstrip
+            conditional[:attributes][:id] ||= sanitize_to_id("#{attribute}_#{value}_conditional")
+
+            (@options[:attributes][:data] ||= {})[:'aria-controls'] = conditional[:attributes][:id]
+
+            @conditional_content = tag.div(conditional[:content], class: conditional[:attributes][:class], id: conditional[:attributes][:id])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/inputs/radios.rb

@@ -0,0 +1,67 @@
+require_relative '../input'
+require_relative 'item/divider'
+require_relative 'item/radio/form'
+require_relative 'item/radio/tag'
+
+module CCS::Components
+  module GovUK
+    class Field < Base
+      class Inputs < Field
+        # = GOV.UK Radios
+        #
+        # This is used for generating the radios component from the
+        # {https://design-system.service.gov.uk/components/radios GDS - Components - Radios}
+        #
+        # @!attribute [r] radio_items
+        #   @return [Array<Item::Divider|Item::Radio|Item::Radio>] An array of the initialised radio items
+
+        class Radios < Inputs
+          private
+
+          attr_reader :radio_items
+
+          public
+
+          # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # @param (see CCS::Components::GovUK::Field::Inputs#initialize)
+          # @param radio_items [Array<Hash>] an array of options for the radios.
+          #                                  See {Components::GovUK::Field::Inputs::Item::Radio#initialize Radio#initialize} for details of the items in the array.
+          #
+          # @option (see CCS::Components::GovUK::Field::Inputs#initialize)
+
+          def initialize(attribute:, radio_items:, **options)
+            super(attribute: attribute, **options)
+
+            if @options[:model] || @options[:form]
+              values = (@options[:model] || @options[:form].object).send(attribute) || []
+              radio_items.each { |radio_item| radio_item[:checked] = values.include?(radio_item[:value]) }
+            end
+
+            radio_item_class = @options[:form] ? Item::Radio::Form : Inputs::Item::Radio::Tag
+
+            @radio_items = radio_items.map { |radio_item| radio_item[:divider] ? Item::Divider.new(divider: radio_item[:divider], type: 'radios') : radio_item_class.new(attribute: attribute, form: @options[:form], context: @context, **radio_item) }
+          end
+
+          # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+          # Generates the HTML for the GOV.UK Radios component
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do
+              tag.div(**options[:attributes]) do
+                radio_items.each { |radio_item| concat(radio_item.render) }
+              end
+            end
+          end
+
+          # The default attributes for the radios
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-radios', data: { module: 'govuk-radios' } }.freeze
+        end
+      end
+    end
+  end
+end