ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

data/lib/ccs/components/govuk/field/input/text_input.rb

@@ -0,0 +1,97 @@
+require_relative '../input'
+require_relative 'text_input/fix'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Input
+          #
+          # This is used for generating the input component from the
+          # {https://design-system.service.gov.uk/components/text-input GDS - Components - Text Input}
+          #
+          # @!attribute [r] field_type
+          #   @return [Symbol,String] The input field type
+          # @!attribute [r] value
+          #   @return [String] The value of the text input
+          # @!attribute [r] prefix
+          #   @return [Fix] The initialised prefix
+          # @!attribute [r] suffix
+          #   @return [Fix] The initialised suffix
+
+          class TextInput < Input
+            private
+
+            attr_reader :field_type, :value, :prefix, :suffix
+
+            public
+
+            # rubocop:disable Metrics/ParameterLists
+
+            # @param (see CCS::Components::GovUK::Field::Input#initialize)
+            # @param field_type [Symbol,String] (:text) the input field type
+            # @param value [String] the value if the input
+            # @param prefix [Hash] optional prefix for the input field,
+            #                      see {CCS::Components::GovUK::Field::Input::TextInput::Fix#initialize Fix#initialize} for more details.
+            # @param suffix [Hash] optional suffix for the input field,
+            #                      see {CCS::Components::GovUK::Field::Input::TextInput::Fix#initialize Fix#initialize} for more details.
+            #
+            # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+            def initialize(attribute:, field_type: :text, value: nil, prefix: nil, suffix: nil, **options)
+              super(attribute: attribute, **options)
+
+              @field_type = :"#{field_type}_field"
+              @value = @options[:model] ? @options[:model].send(attribute) : value
+              @prefix = Fix.new(fix: 'pre', context: @context, **prefix) if prefix
+              @suffix = Fix.new(fix: 'suf', context: @context, **suffix) if suffix
+            end
+
+            # rubocop:enable Metrics/ParameterLists
+
+            # Generates the HTML for the GOV.UK Text Input component
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              super() do
+                text_input_wrapper do
+                  if options[:form]
+                    options[:form].send(field_type, attribute, **options[:attributes])
+                  else
+                    context.send("#{field_type}_tag", attribute, value, **options[:attributes])
+                  end
+                end
+              end
+            end
+
+            # The default attributes for the text input
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-input' }.freeze
+
+            private
+
+            # Wrapper method used by {render} to wrap the text input with a prefix or suffix if they exist
+            #
+            # @yield the text input HTML
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def text_input_wrapper
+              if prefix || suffix
+                tag.div(class: 'govuk-input__wrapper') do
+                  concat(prefix.render) if prefix
+                  concat(yield)
+                  concat(suffix.render) if suffix
+                end
+              else
+                yield
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input/textarea.rb

@@ -0,0 +1,59 @@
+require_relative '../input'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Textarea
+          #
+          # This helper is used for generating the textarea component from the
+          # {https://design-system.service.gov.uk/components/textarea GDS - Components - Textarea}
+          #
+          # @!attribute [r] content
+          #   @return [String] The content of the textarea
+
+          class Textarea < Input
+            private
+
+            attr_reader :content
+
+            public
+
+            # @param (see CCS::Components::GovUK::Field::Input#initialize)
+            # @param content [String] the content of the textarea
+            # @param rows [Integer] the number of rows for the text area
+            #
+            # @option (see CCS::Components::GovUK::Field::Input#initialize)
+
+            def initialize(attribute:, content: nil, rows: 5, **options)
+              super(attribute: attribute, **options)
+
+              @options[:attributes][:rows] ||= rows
+
+              @content = @options[:model] ? @options[:model].send(attribute) : content
+            end
+
+            # Generates the HTML for the GOV.UK Textarea component
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              super() do
+                if options[:form]
+                  options[:form].text_area(attribute, **options[:attributes])
+                else
+                  context.text_area_tag(attribute, content, **options[:attributes])
+                end
+              end
+            end
+
+            # The default attributes for the textarea
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-textarea' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/field/input.rb

@@ -0,0 +1,62 @@
+require_relative '../field'
+require_relative '../label'
+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        # = GOV.UK Field Input
+        #
+        # This class is used to create a form for an individual field, e.g. text input or select.
+        # It will wrap the input in the form group and:
+        # - display the label
+        # - display the hint (if there is one)
+        # - find and display the error message (if there is one)
+        #
+        # @!attribute [r] label
+        #   @return [Label] The initialised label
+
+        class Input < Field
+          private
+
+          attr_reader :label
+
+          public
+
+          # @param (see CCS::Components::GovUK::Field#initialize)
+          # @param label [Hash] attributes for the label, see {CCS::Components::GovUK::Label#initialize Label#initialize} for more details.
+          #
+          # @option (see CCS::Components::GovUK::Field#initialize)
+
+          def initialize(attribute:, label:, **options)
+            super(attribute: attribute, **options)
+
+            set_described_by(@options, @attribute, @error_message, options[:hint])
+
+            @options[:attributes][:class] << " #{self.class::DEFAULT_ATTRIBUTES[:class]}--error" if @error_message
+
+            field_id = @options.dig(:attributes, :id)
+            (label[:attributes] ||= {})[:for] = field_id if field_id
+
+            @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
+          end
+
+          # Generates the HTML to wrap arround a GDS form component
+          #
+          # @yield (see CCS::Components::GovUK::Field#render)
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            super() do |display_error_message|
+              concat(label.render)
+              concat(hint.render) if hint
+              concat(display_error_message)
+              concat(yield)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,65 @@
+require_relative '../date_input'
+require_relative '../../input/text_input'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,89 @@
+require_relative '../input'
+require_relative 'date_input/item'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,47 @@
+require_relative '../checkbox'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,43 @@
+require_relative '../checkbox'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,50 @@
+require_relative '../item'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,50 @@
+require 'action_view'
+
+module CCS
+  module 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
+end

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

@@ -0,0 +1,44 @@
+require_relative '../radio'
+
+module CCS
+  module 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
+end