katalyst-google-apis 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b20f30239ff09170beb094e155676df9da9a96f7693d90aed8bac756b693e77
-  data.tar.gz: d3ab4d196dacb58ed7c1c9b2a04715bd08f6c8871918bc1359c5054839e923d4
+  metadata.gz: 91607481f87f73f9f4e17f687e6f9f98c6005ec7b25b90f2e16f3a96dd2f8286
+  data.tar.gz: 9663f5605e940f362fb2b7e9d7294890960c6666dfe0ae595e83c700c5e559be
 SHA512:
-  metadata.gz: afb1e05bc0bdea960d8a572da3d5448fea590830440f97f753cc99ac2361109268b502f8d90375db938657e201e892bc02312d8f8cbfae624e85124197838a4e
-  data.tar.gz: 69fcfce31104540742fd9c23eb8da530695f3eef9137d80ae2aab06340c67f27196dcaad73d5caac374b58e28e93b455e811f5f0345fee674fa3503bde848c62
+  metadata.gz: 77b2105dd910de97aaf9c0eb80999d76f3e0f972bd9e8b29699c8daf33504166ceef279f07c601dd8ea19e6337d642a8e439ee50b55dc816251e617f4a1cc735
+  data.tar.gz: a2d8a5ed4d6f19fcf58380084400c355b1a013b71aa62e5eb5964b2a7fe32158b0e41a8233b0a8f718120d16cdade6ba4df856cbfdccea782cacc75d9d4329d9

data/app/helpers/katalyst/google_apis/form_builder.rb

@@ -2,28 +2,33 @@
 
 module Katalyst
   module GoogleApis
+    # rubocop:disable Rails/HelperInstanceVariable
     module FormBuilder
-      def recaptcha_field(attribute = :recaptcha_token, action: object_name,
-                          site_key: GoogleApis.config.recaptcha.site_key)
-        safe_join([
-                    RecaptchaField.new(action:, attribute:, site_key:).render(self),
-                    hidden_field(attribute),
-                  ])
+      ##
+      # :method: recaptcha_field
+      #
+      # :call-seq: recaptcha_field(method = :recaptcha_token, options = {})
+      #
+      #   <%= form_with model: @contact do |f| %>
+      #     <%= f.recaptcha_field %>
+      #   <% end %>
+      #
+      # Please refer to the documentation of the base helper for details.
+      def recaptcha_field(attribute = :recaptcha_token, site_key: GoogleApis.config.recaptcha.site_key, **)
+        RecaptchaField.new(@object_name, attribute, site_key:, **).render(@template)
       end
 
       class RecaptchaField
-        attr_reader :action, :attribute, :site_key
-
-        def initialize(action:, attribute:, site_key:)
-          # rubocop:disable Rails/HelperInstanceVariable
-          @action    = action
-          @attribute = attribute
-          @site_key  = site_key
-          # rubocop:enable Rails/HelperInstanceVariable
+        def initialize(object_name, attribute, site_key:, **html_attributes)
+          @object_name     = object_name
+          @attribute       = attribute
+          @site_key        = site_key
+          @html_attributes = html_attributes
         end
 
         def render(template)
-          template.tag.div(data:)
+          template.safe_join([template.tag.div(**@html_attributes, data:),
+                              template.hidden_field(@object_name, @attribute)])
         end
 
         private
@@ -32,11 +37,12 @@ module Katalyst
           {
             controller:               "recaptcha",
             action:                   "turbo:before-morph-element->recaptcha#morph",
-            recaptcha_action_value:   action,
-            recaptcha_site_key_value: site_key,
+            recaptcha_action_value:   @object_name,
+            recaptcha_site_key_value: @site_key,
           }
         end
       end
     end
+    # rubocop:enable Rails/HelperInstanceVariable
   end
 end

data/app/helpers/katalyst/google_apis/govuk_form_builder.rb

@@ -3,13 +3,73 @@
 module Katalyst
   module GoogleApis
     module GOVUKFormBuilder
-      def govuk_recaptcha_field(attribute = :recaptcha_token, **)
-        GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(self, object_name, attribute).html do
+      # Generates a Google recaptcha input that shows errors.
+      #
+      # @param attribute_name [Symbol] The name of the attribute
+      # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
+      # @param form_group [Hash] configures the form group
+      # @option form_group kwargs [Hash] additional attributes added to the form group
+      # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+      # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
+      # @return [ActiveSupport::SafeBuffer] HTML output
+      #
+      # @example A google recaptcha input
+      #   = f.govuk_recaptcha_field
+      #
+      def govuk_recaptcha_field(attribute_name = :recaptcha_token,
+                                form_group: {}, before_input: nil, after_input: nil, **)
+        Recaptcha.new(self, object_name, attribute_name, form_group:, before_input:, after_input:, **).html
+      end
+
+      class Recaptcha < GOVUKDesignSystemFormBuilder::Base
+        include GOVUKDesignSystemFormBuilder::Traits::Error
+        include GOVUKDesignSystemFormBuilder::Traits::HTMLAttributes
+        include GOVUKDesignSystemFormBuilder::Traits::ContentBeforeAndAfter
+
+        def initialize(builder, object_name, attribute_name, form_group:, before_input:, after_input:, **kwargs)
+          super(builder, object_name, attribute_name)
+
+          @html_attributes      = kwargs
+          @form_group           = form_group
+          @before_input         = before_input
+          @after_input          = after_input
+        end
+
+        def html
+          GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(*bound, **@form_group).html do
+            safe_join([error_element, content])
+          end
+        end
+
+        private
+
+        def content
           safe_join([
-                      GOVUKDesignSystemFormBuilder::Elements::ErrorMessage.new(self, object_name, attribute),
-                      recaptcha_field(attribute, **),
+                      before_input_content,
+                      input,
+                      after_input_content,
                     ])
         end
+
+        def input
+          @builder.send(:recaptcha_field, @attribute_name, **attributes(@html_attributes))
+        end
+
+        def options
+          {
+            id:    field_id(link_errors: true),
+            class: classes,
+            aria:  { describedby: combine_references(error_id) },
+          }
+        end
+
+        def classes
+          [%(#{brand}-recaptcha)].push(error_classes).compact
+        end
+
+        def error_classes
+          %(#{brand}-recaptcha--error) if has_errors?
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-google-apis
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Katalyst Interactive