govuk_design_system_formbuilder 1.1.10 → 1.2.0

data/lib/govuk_design_system_formbuilder/elements/text_area.rb

@@ -1,15 +1,18 @@
 module GOVUKDesignSystemFormBuilder
   module Elements
     class TextArea < Base
+      using PrefixableArray
+
       include Traits::Error
       include Traits::Hint
       include Traits::Label
       include Traits::Supplemental
 
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, rows:, max_words:, max_chars:, threshold:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, rows:, max_words:, max_chars:, threshold:, **extra_args, &block)
         super(builder, object_name, attribute_name, &block)
 
         @label      = label
+        @caption    = caption
         @hint_text  = hint_text
         @extra_args = extra_args
         @max_words  = max_words
@@ -48,9 +51,9 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def govuk_textarea_classes
-        %w(govuk-textarea).tap do |classes|
-          classes.push('govuk-textarea--error') if has_errors?
-          classes.push('govuk-js-character-count') if limit?
+        %w(textarea).prefix(brand).tap do |classes|
+          classes.push(%(#{brand}-textarea--error)) if has_errors?
+          classes.push(%(#{brand}-js-character-count)) if limit?
         end
       end
 
@@ -69,11 +72,15 @@ module GOVUKDesignSystemFormBuilder
       def limit_description
         return nil unless limit?
 
-        content_tag('span', id: limit_id, class: %w(govuk-hint govuk-character-count__message), aria: { live: 'polite' }) do
+        content_tag('span', id: limit_id, class: limit_description_classes, aria: { live: 'polite' }) do
           "You can enter up to #{limit_quantity} #{limit_type}"
         end
       end
 
+      def limit_description_classes
+        %w(hint character-count__message).prefix(brand)
+      end
+
       def limit_quantity
         @max_words || @max_chars
       end

data/lib/govuk_design_system_formbuilder/traits/caption.rb

@@ -0,0 +1,24 @@
+module GOVUKDesignSystemFormBuilder
+  module Traits
+    module Caption
+    private
+
+      def caption_element
+        @caption_element ||= Elements::Caption.new(
+          @builder,
+          @object_name,
+          @attribute_name,
+          **{ text: nil }.merge({ text: caption_text, size: caption_size }.compact)
+        )
+      end
+
+      def caption_text
+        @caption&.dig(:text)
+      end
+
+      def caption_size
+        @caption&.dig(:size)
+      end
+    end
+  end
+end

data/lib/govuk_design_system_formbuilder/traits/input.rb

@@ -1,12 +1,13 @@
 module GOVUKDesignSystemFormBuilder
   module Traits
     module Input
-      def initialize(builder, object_name, attribute_name, hint_text:, label:, width:, **extra_args, &block)
+      def initialize(builder, object_name, attribute_name, hint_text:, label:, caption:, width:, **extra_args, &block)
         super(builder, object_name, attribute_name, &block)
 
         @width          = width
         @extra_args     = extra_args
         @label          = label
+        @caption        = caption
         @hint_text      = hint_text
       end
 
@@ -40,34 +41,33 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def input_classes
-        %w(govuk-input).push(width_classes, error_classes).compact
+        [%(#{brand}-input)].push(width_classes, error_classes).compact
       end
 
       def error_classes
-        'govuk-input--error' if has_errors?
+        %(#{brand}-input--error) if has_errors?
       end
 
       def width_classes
         return if @width.blank?
 
         case @width
-        when nil then nil
 
           # fixed (character) widths
-        when 20 then 'govuk-input--width-20'
-        when 10 then 'govuk-input--width-10'
-        when 5  then 'govuk-input--width-5'
-        when 4  then 'govuk-input--width-4'
-        when 3  then 'govuk-input--width-3'
-        when 2  then 'govuk-input--width-2'
+        when 20 then %(#{brand}-input--width-20)
+        when 10 then %(#{brand}-input--width-10)
+        when 5  then %(#{brand}-input--width-5)
+        when 4  then %(#{brand}-input--width-4)
+        when 3  then %(#{brand}-input--width-3)
+        when 2  then %(#{brand}-input--width-2)
 
           # fluid widths
-        when 'full'           then 'govuk-!-width-full'
-        when 'three-quarters' then 'govuk-!-width-three-quarters'
-        when 'two-thirds'     then 'govuk-!-width-two-thirds'
-        when 'one-half'       then 'govuk-!-width-one-half'
-        when 'one-third'      then 'govuk-!-width-one-third'
-        when 'one-quarter'    then 'govuk-!-width-one-quarter'
+        when 'full'           then %(#{brand}-!-width-full)
+        when 'three-quarters' then %(#{brand}-!-width-three-quarters)
+        when 'two-thirds'     then %(#{brand}-!-width-two-thirds)
+        when 'one-half'       then %(#{brand}-!-width-one-half)
+        when 'one-third'      then %(#{brand}-!-width-one-third)
+        when 'one-quarter'    then %(#{brand}-!-width-one-quarter)
 
         else fail(ArgumentError, "invalid width '#{@width}'")
         end

data/lib/govuk_design_system_formbuilder/traits/label.rb

@@ -4,7 +4,18 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def label_element
-        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, **@label)
+        @label_element ||= Elements::Label.new(@builder, @object_name, @attribute_name, caption: @caption, **label_args)
+      end
+
+      def label_args
+        case @label
+        when Hash
+          @label
+        when Proc
+          { content: @label }
+        else
+          fail(ArgumentError, %(label must be a Proc or Hash))
+        end
       end
     end
   end

data/lib/govuk_design_system_formbuilder/traits/localisation.rb

@@ -4,28 +4,34 @@ module GOVUKDesignSystemFormBuilder
     private
 
       def localised_text(context)
-        key = localisation_key(context)
+        return unless @object_name.present? && @attribute_name.present?
 
-        # `I18n.exists?(nil)` returns true when `config.i18n.fallbacks` is
-        # enabled, so only proceed if the key is present too
-        return nil unless key.present? && I18n.exists?(key)
-
-        I18n.translate(key)
+        localise(context) || localise_html(context)
       end
 
-      def localisation_key(context)
-        return nil unless @object_name.present? && @attribute_name.present?
+      def localise(context)
+        I18n.translate(schema(context), default: nil)
+      end
 
-        schema(context)
+      def localise_html(context)
+        I18n.translate("#{schema(context)}_html", default: nil).try(:html_safe)
       end
 
       def schema(context)
         schema_root(context)
-          .push(@object_name, @attribute_name)
+          .push(*schema_path)
           .map { |e| e == :__context__ ? context : e }
           .join('.')
       end
 
+      def schema_path
+        if @value.present?
+          [@object_name, "#{@attribute_name}_options", @value]
+        else
+          [@object_name, @attribute_name]
+        end
+      end
+
       def schema_root(context)
         contextual_schema = case context
                             when :legend
@@ -34,6 +40,8 @@ module GOVUKDesignSystemFormBuilder
                               config.localisation_schema_hint
                             when :label
                               config.localisation_schema_label
+                            when :caption
+                              config.localisation_schema_caption
                             end
 
         (contextual_schema || config.localisation_schema_fallback).dup

data/lib/govuk_design_system_formbuilder/version.rb

@@ -1,3 +1,3 @@
 module GOVUKDesignSystemFormBuilder
-  VERSION = '1.1.10'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_design_system_formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.0
 platform: ruby
 authors:
 - Peter Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -134,42 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: adsf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-- !ruby/object:Gem::Dependency
-  name: adsf-live
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.17.0
+        version: 3.19.0
 - !ruby/object:Gem::Dependency
   name: rubypants
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -260,14 +232,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.1.0
 description: A Rails form builder that generates form inputs adhering to the GOV.UK
   Design System
 email:
@@ -288,10 +260,10 @@ files:
 - lib/govuk_design_system_formbuilder/containers/radio_buttons_fieldset.rb
 - lib/govuk_design_system_formbuilder/containers/radios.rb
 - lib/govuk_design_system_formbuilder/containers/supplemental.rb
+- lib/govuk_design_system_formbuilder/elements/caption.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/collection_check_box.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/fieldset_check_box.rb
-- lib/govuk_design_system_formbuilder/elements/check_boxes/hint.rb
 - lib/govuk_design_system_formbuilder/elements/check_boxes/label.rb
 - lib/govuk_design_system_formbuilder/elements/date.rb
 - lib/govuk_design_system_formbuilder/elements/error_message.rb
@@ -311,6 +283,7 @@ files:
 - lib/govuk_design_system_formbuilder/elements/select.rb
 - lib/govuk_design_system_formbuilder/elements/submit.rb
 - lib/govuk_design_system_formbuilder/elements/text_area.rb
+- lib/govuk_design_system_formbuilder/traits/caption.rb
 - lib/govuk_design_system_formbuilder/traits/collection_item.rb
 - lib/govuk_design_system_formbuilder/traits/conditional.rb
 - lib/govuk_design_system_formbuilder/traits/error.rb

data/lib/govuk_design_system_formbuilder/elements/check_boxes/hint.rb

@@ -1,32 +0,0 @@
-module GOVUKDesignSystemFormBuilder
-  module Elements
-    module CheckBoxes
-      class Hint < Base
-        include Traits::Hint
-
-        def initialize(builder, object_name, attribute_name, hint_text, value:)
-          super(builder, object_name, attribute_name)
-
-          @value     = value
-          @hint_text = hint_text
-        end
-
-        def html
-          return nil if @hint_text.blank?
-
-          tag.span(@hint_text, class: hint_classes, id: id)
-        end
-
-        def id
-          hint_id
-        end
-
-      private
-
-        def hint_classes
-          %w(govuk-hint govuk-checkboxes__hint)
-        end
-      end
-    end
-  end
-end