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

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

@@ -1,44 +1,46 @@
 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
+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}
             #
-            # @return [ActiveSupport::SafeBuffer]
+            # @!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")
+              def render
+                tag.div(text, class: "govuk-#{type}__divider")
+              end
             end
           end
         end

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

@@ -1,36 +1,38 @@
 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)
+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
               #
-              # @option (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+              # This is used to generate an individual radio item using +form.check_box+
 
-              def initialize(attribute:, label:, **options)
-                super(attribute: attribute, label: label, **options)
+              class Form < Radio
+                # @param (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
+                #
+                # @option (see CCS::Components::GovUK::Field::Items::Item::Radio#initialize)
 
-                (label[:attributes] ||= {})[:value] = @value
-                label[:attributes][:for] = @options[:attributes][:id] if @options[:attributes][:id]
+                def initialize(attribute:, label:, **options)
+                  super(attribute: attribute, label: label, **options)
 
-                @label = Label.new(attribute: attribute, form: @options[:form], context: @context, **label)
-              end
+                  (label[:attributes] ||= {})[:value] = @value
+                  label[:attributes][:for] = @options[:attributes][:id] if @options[:attributes][:id]
 
-              # Generates the HTML for the radio input
-              #
-              # @return [ActiveSupport::SafeBuffer]
+                  @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])
+                def render
+                  super() do
+                    @options[:form].radio_button(@attribute, @value, **@options[:attributes])
+                  end
                 end
               end
             end

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

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

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

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

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

@@ -1,106 +1,108 @@
 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
+module CCS
+  module Components
+    module GovUK
+      class Field < Base
+        class Inputs < Field
+          # = GOV.UK Field Inputs Item
           #
-          # @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
+          # 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
           #
-          # @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])
+          # @!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

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

@@ -3,63 +3,65 @@ 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
+module CCS
+  module 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
+          class Radios < Inputs
+            private
 
-          attr_reader :radio_items
+            attr_reader :radio_items
 
-          public
+            public
 
-          # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+            # 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)
+            # @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)
+            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
+              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_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
+              @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
+            # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-          # Generates the HTML for the GOV.UK Radios component
-          #
-          # @return [ActiveSupport::SafeBuffer]
+            # 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) }
+            def render
+              super() do
+                tag.div(**options[:attributes]) do
+                  radio_items.each { |radio_item| concat(radio_item.render) }
+                end
               end
             end
-          end
 
-          # The default attributes for the radios
+            # The default attributes for the radios
 
-          DEFAULT_ATTRIBUTES = { class: 'govuk-radios', data: { module: 'govuk-radios' } }.freeze
+            DEFAULT_ATTRIBUTES = { class: 'govuk-radios', data: { module: 'govuk-radios' } }.freeze
+          end
         end
       end
     end