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

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

@@ -1,78 +1,80 @@
 require_relative '../input'
 
-module CCS::Components
-  module GovUK
-    class Field < Base
-      class Input < Field
-        # = GOV.UK Select
-        #
-        # This is used for generating the select component from the
-        # {https://design-system.service.gov.uk/components/select GDS - Components - Select}
-        #
-        # @!attribute [r] items
-        #   @return [Array<Hash>] The select items
-        # @!attribute [r] selected
-        #   @return [String] The selected option
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Select
+          #
+          # This is used for generating the select component from the
+          # {https://design-system.service.gov.uk/components/select GDS - Components - Select}
+          #
+          # @!attribute [r] items
+          #   @return [Array<Hash>] The select items
+          # @!attribute [r] selected
+          #   @return [String] The selected option
 
-        class Select < Input
-          private
+          class Select < Input
+            private
 
-          attr_reader :items, :selected
+            attr_reader :items, :selected
 
-          public
+            public
 
-          # @param (see CCS::Components::GovUK::Field::Input#initialize)
-          # @param items [Array<Hash>] array of options for select.
-          #                            The options are:
-          #                            - +:text+ the text of the option item. If this is blank the value is used
-          #                            - +:value+ the value of the option item
-          #                            - +:attributes+ any additional attributes that will added as part of the option HTML
-          # @param selected [String] the selected option
-          #
-          # @option (see CCS::Components::GovUK::Field::Input#initialize)
+            # @param (see CCS::Components::GovUK::Field::Input#initialize)
+            # @param items [Array<Hash>] array of options for select.
+            #                            The options are:
+            #                            - +:text+ the text of the option item. If this is blank the value is used
+            #                            - +:value+ the value of the option item
+            #                            - +:attributes+ any additional attributes that will added as part of the option HTML
+            # @param selected [String] the selected option
+            #
+            # @option (see CCS::Components::GovUK::Field::Input#initialize)
 
-          def initialize(attribute:, items:, selected: nil, **options)
-            super(attribute: attribute, **options)
+            def initialize(attribute:, items:, selected: nil, **options)
+              super(attribute: attribute, **options)
 
-            @items = items.map do |item|
-              [
-                item[:text] || item[:value],
-                item[:value],
-                (item[:attributes] || {})
-              ]
+              @items = items.map do |item|
+                [
+                  item[:text] || item[:value],
+                  item[:value],
+                  (item[:attributes] || {})
+                ]
+              end
+              @selected = @options[:model] ? @options[:model].send(attribute) : selected
             end
-            @selected = @options[:model] ? @options[:model].send(attribute) : selected
-          end
 
-          # Generates the HTML for the GOV.UK Select component
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # Generates the HTML for the GOV.UK Select component
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          def render
-            super() do
-              if options[:form]
-                options[:form].select(
-                  attribute,
-                  items,
-                  {},
-                  **options[:attributes]
-                )
-              else
-                context.select_tag(
-                  attribute,
-                  context.options_for_select(
+            def render
+              super() do
+                if options[:form]
+                  options[:form].select(
+                    attribute,
                     items,
-                    selected
-                  ),
-                  **options[:attributes]
-                )
+                    {},
+                    **options[:attributes]
+                  )
+                else
+                  context.select_tag(
+                    attribute,
+                    context.options_for_select(
+                      items,
+                      selected
+                    ),
+                    **options[:attributes]
+                  )
+                end
               end
             end
-          end
 
-          # The default attributes for the select
+            # The default attributes for the select
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-select' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-select' }.freeze
+          end
         end
       end
     end

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

@@ -1,49 +1,51 @@
 require_relative '../text_input'
 
-module CCS::Components
-  module GovUK
-    class Field < Base
-      class Input < Field
-        class TextInput < Input
-          # = GOV.UK Text Input prefix/suffix
-          #
-          # This is used to generate the prefix/suffix HTML for a text input
-          #
-          # @!attribute [r] text
-          #   @return [String] Text for the prefix/suffix
-
-          class Fix < Base
-            private
-
-            attr_reader :text
-
-            public
-
-            # @param text [String] the text for the prefix/suffix
-            # @param fix [String] either +"pre"+ or +"suf"+
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          class TextInput < Input
+            # = GOV.UK Text Input prefix/suffix
             #
-            # @param options [Hash] options that will be used in customising the HTML
+            # This is used to generate the prefix/suffix HTML for a text input
             #
-            # @option options [String] :classes additional CSS classes for the prefix/suffix HTML
-            # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+            # @!attribute [r] text
+            #   @return [String] Text for the prefix/suffix
 
-            def initialize(text:, fix:, **options)
-              super(**options)
+            class Fix < Base
+              private
 
-              @options[:attributes][:class] = "govuk-input__#{fix}fix #{@options[:attributes][:class]}".rstrip
-              (@options[:attributes][:aria] ||= {})[:hidden] = true
+              attr_reader :text
 
-              @text = text
-            end
+              public
 
-            # Generates the HTML for the GOV.UK Text Input prefix/suffix
-            #
-            # @yield (see CCS::Components::GovUK::Field#render)
-            #
-            # @return [ActiveSupport::SafeBuffer]
+              # @param text [String] the text for the prefix/suffix
+              # @param fix [String] either +"pre"+ or +"suf"+
+              #
+              # @param options [Hash] options that will be used in customising the HTML
+              #
+              # @option options [String] :classes additional CSS classes for the prefix/suffix HTML
+              # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+              def initialize(text:, fix:, **options)
+                super(**options)
+
+                @options[:attributes][:class] = "govuk-input__#{fix}fix #{@options[:attributes][:class]}".rstrip
+                (@options[:attributes][:aria] ||= {})[:hidden] = true
+
+                @text = text
+              end
+
+              # Generates the HTML for the GOV.UK Text Input prefix/suffix
+              #
+              # @yield (see CCS::Components::GovUK::Field#render)
+              #
+              # @return [ActiveSupport::SafeBuffer]
 
-            def render
-              tag.div(text, **options[:attributes])
+              def render
+                tag.div(text, **options[:attributes])
+              end
             end
           end
         end

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

@@ -1,91 +1,93 @@
 require_relative '../input'
 require_relative 'text_input/fix'
 
-module CCS::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.
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Input
           #
-          # @option (see CCS::Components::GovUK::Field::Input#initialize)
+          # 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
 
-          def initialize(attribute:, field_type: :text, value: nil, prefix: nil, suffix: nil, **options)
-            super(attribute: attribute, **options)
+            # rubocop:enable Metrics/ParameterLists
 
-            @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
+            # Generates the HTML for the GOV.UK Text Input component
+            #
+            # @return [ActiveSupport::SafeBuffer]
 
-          # 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])
+            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
-          end
 
-          # The default attributes for the text input
+            # The default attributes for the text input
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-input' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-input' }.freeze
 
-          private
+            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
+            # 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
-            else
-              yield
             end
           end
         end

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

@@ -1,55 +1,57 @@
 require_relative '../input'
 
-module CCS::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
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Input < Field
+          # = GOV.UK Textarea
           #
-          # @option (see CCS::Components::GovUK::Field::Input#initialize)
+          # 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
 
-          def initialize(attribute:, content: nil, rows: 5, **options)
-            super(attribute: attribute, **options)
+          class Textarea < Input
+            private
 
-            @options[:attributes][:rows] ||= rows
+            attr_reader :content
 
-            @content = @options[:model] ? @options[:model].send(attribute) : content
-          end
+            public
 
-          # 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])
+            # @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
-          end
 
-          # The default attributes for the textarea
+            # The default attributes for the textarea
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-textarea' }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-textarea' }.freeze
+          end
         end
       end
     end

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

@@ -1,57 +1,59 @@
 require_relative '../field'
 require_relative '../label'
 
-module CCS::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.
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        # = GOV.UK Field Input
         #
-        # @option (see CCS::Components::GovUK::Field#initialize)
+        # 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
 
-        def initialize(attribute:, label:, **options)
-          super(attribute: attribute, **options)
+        class Input < Field
+          private
 
-          set_described_by(@options, @attribute, @error_message, options[:hint])
+          attr_reader :label
 
-          @options[:attributes][:class] << " #{self.class::DEFAULT_ATTRIBUTES[:class]}--error" if @error_message
+          public
 
-          field_id = @options.dig(:attributes, :id)
-          (label[:attributes] ||= {})[:for] = field_id if field_id
+          # @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)
 
-          @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
-        end
+          def initialize(attribute:, label:, **options)
+            super(attribute: attribute, **options)
 
-        # 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)
+            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