govuk_elements_form_builder 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b43d881f552b63310176c72eaa304ed53e5b89de
-  data.tar.gz: 2b0086ffaabcbf31e15311ffee4eddae8ad62cb1
+  metadata.gz: 09e273646a0e9edb0788ac45e25409e98a8a815f
+  data.tar.gz: aa0abb864b6b38852ac96005461c204ab031e9c6
 SHA512:
-  metadata.gz: e94aa32b4bcaefa3020fe6797fcb7eb6acb2ed484bf70deec782908678c53fe21a2c4d9befac3f3d9370631f0f51ee05d883dca1c622ec5298cf9eb5253e0ce4
-  data.tar.gz: 7633c157a26792fdc1ae018b649b16ecf0bfc50b3d505c6afd71a9b0369c86a99d99b961ddd6d302b7ac3b223668e611bce81b88f5189a61d4ce0583adaa6282
+  metadata.gz: 59ad72a527811abca00667b6f8457d790310b3e8d230509f56883b0b60c6218a87356ed2618a48f8fc324fca78e13e65102e16035c7bf62ae28afe87a367b31b
+  data.tar.gz: 1fdea4d35a4ce12392e26eeedef890d07261422d995bf43236d30a40bd27b24e6023a142c8077b857687cbaddce846da0c8543841282f0b3a1ad550eab1d0699

data/lib/govuk_elements_form_builder.rb

@@ -1,5 +1,6 @@
 require 'govuk_elements_form_builder/version'
 require 'govuk_elements_form_builder/form_builder'
+require 'govuk_elements_form_builder/block_buffer'
 require_relative '../app/helpers/govuk_elements_errors_helper'
 
 module GovukElementsFormBuilder

data/lib/govuk_elements_form_builder/block_buffer.rb

@@ -0,0 +1,29 @@
+module GovukElementsFormBuilder
+  #
+  # This class is intended to be a proxy for a FormBuilder object, and accumulate
+  # multiple form elements rendered inside a block. Its main reason for existence is
+  # to enable the following syntax when rendering revealing panels:
+  #
+  # f.radio_button_fieldset :asked_for_help do |fieldset|
+  #   fieldset.radio_input(GenericYesNo::YES) do |radio|
+  #     # Here, `radio` is a `BlockBuffer` instance, delegating all methods to
+  #     # a `FormBuilder` instance, but doing the accumulation/concatenation.
+  #     radio.text_field(:help_party)
+  #     radio.text_field(:another_field)
+  #     [...]
+  #   end
+  #   fieldset.radio_input(GenericYesNo::NO)
+  # end
+  #
+  class BlockBuffer
+    delegate :safe_concat, :send, to: :@form_object
+
+    def initialize(form_object)
+      @form_object = form_object
+    end
+
+    def method_missing(method, *args, &block)
+      safe_concat send(method, *args, &block)
+    end
+  end
+end

data/lib/govuk_elements_form_builder/form_builder.rb

@@ -5,9 +5,12 @@ module GovukElementsFormBuilder
       add_error_to_html_tag! html_tag, instance
     end
 
-    delegate :content_tag, :tag, :safe_join, to: :@template
+    delegate :content_tag, :tag, :safe_join, :safe_concat, :capture, to: :@template
     delegate :errors, to: :@object
 
+    # Used to propagate the fieldset outer element attribute to the inner elements
+    attr_accessor :current_fieldset_attribute
+
     # Ensure fields_for yields a GovukElementsFormBuilder.
     def fields_for record_name, record_object = nil, fields_options = {}, &block
       super record_name, record_object, fields_options.merge(builder: self.class), &block
@@ -41,27 +44,27 @@ module GovukElementsFormBuilder
       end
     end
 
-    def radio_button_fieldset attribute, options={}
+    def radio_button_fieldset attribute, options={}, &block
       content_tag :div,
                   class: form_group_classes(attribute),
                   id: form_group_id(attribute) do
         content_tag :fieldset, fieldset_options(attribute, options) do
           safe_join([
-                      fieldset_legend(attribute),
-                      radio_inputs(attribute, options)
+                      fieldset_legend(attribute, options),
+                      block_given? ? capture(self, &block) : radio_inputs(attribute, options)
                     ], "\n")
         end
       end
     end
 
-    def check_box_fieldset legend_key, attributes, options={}
+    def check_box_fieldset legend_key, attributes, options={}, &block
       content_tag :div,
                   class: form_group_classes(attributes),
                   id: form_group_id(attributes) do
         content_tag :fieldset, fieldset_options(attributes, options) do
           safe_join([
-                      fieldset_legend(legend_key),
-                      check_box_inputs(attributes)
+                      fieldset_legend(legend_key, options),
+                      block_given? ? capture(self, &block) : check_box_inputs(attributes, options)
                     ], "\n")
         end
       end
@@ -82,48 +85,88 @@ module GovukElementsFormBuilder
 
     end
 
+    # The following method will generate revealing panel markup and internally call the
+    # `radio_inputs` private method. It is not intended to be used outside a
+    # fieldset tag (at the moment, `radio_button_fieldset`).
+    #
+    def radio_input choice, options = {}, &block
+      fieldset_attribute = self.current_fieldset_attribute
+
+      panel = if block_given? || options.key?(:panel_id)
+        panel_id = options.delete(:panel_id) { [fieldset_attribute, choice, 'panel'].join('_') }
+        options.merge!('data-target': panel_id)
+        revealing_panel(panel_id, flush: false, &block) if block_given?
+      end
+
+      option = radio_inputs(
+        fieldset_attribute,
+        options.merge(choices: [choice])
+      ).first + "\n"
+
+      safe_concat([option, panel].join)
+    end
+
+    # The following method will generate revealing panel markup and internally call the
+    # `check_box_inputs` private method. It is not intended to be used outside a
+    # fieldset tag (at the moment, `check_box_fieldset`).
+    #
+    def check_box_input attribute, options = {}, &block
+      panel = if block_given? || options.key?(:panel_id)
+                panel_id = options.delete(:panel_id) { [attribute, 'panel'].join('_') }
+                options.merge!('data-target': panel_id)
+                revealing_panel(panel_id, flush: false, &block) if block_given?
+              end
+
+      checkbox = check_box_inputs([attribute], options).first + "\n"
+
+      safe_concat([checkbox, panel].join)
+    end
+
+    def revealing_panel panel_id, options = {}, &block
+      panel = content_tag(
+        :div, class: 'panel panel-border-narrow js-hidden', id: panel_id
+      ) { block.call(BlockBuffer.new(self)) } + "\n"
+
+      options.fetch(:flush, true) ? safe_concat(panel) : panel
+    end
+
     private
 
+    # Given an attributes hash that could include any number of arbitrary keys, this method
+    # ensure we merge one or more 'default' attributes into the hash, creating the keys if
+    # don't exist, or merging the defaults if the keys already exists.
+    # It supports strings or arrays as values.
+    #
+    def merge_attributes attributes, default:
+      hash = attributes || {}
+      hash.merge(default) { |_key, oldval, newval| Array(newval) + Array(oldval) }
+    end
+
     def set_field_classes! options, attribute
-      text_field_class = "form-control"
-      text_field_class = [text_field_class, 'form-control-error'] if error_for? attribute
-      options[:class] = case options[:class]
-                        when String
-                          [text_field_class, options[:class]]
-                        when Array
-                          options[:class].unshift text_field_class
-                        else
-                          options[:class] = text_field_class
-                        end
+      default_classes = ['form-control']
+      default_classes << 'form-control-error' if error_for?(attribute)
+
+      options ||= {}
+      options.merge!(
+        merge_attributes(options, default: {class: default_classes})
+      )
     end
 
     def set_label_classes! options
-      text_field_class = "form-label"
-
-      if options.present? && options[:label_options].present?
-        options[:label_options][:class] = case options[:label_options][:class]
-                                            when String
-                                              [text_field_class, options[:label_options][:class]]
-                                            when Array
-                                              options[:label_options][:class].unshift text_field_class
-                                            else
-                                              options[:label_options][:class] = text_field_class
-                                          end
-      else
-        options ||= {}
-        options[:label_options] ||= {}
-        options[:label_options][:class] = text_field_class
-      end
-
+      options ||= {}
+      options[:label_options] ||= {}
+      options[:label_options].merge!(
+        merge_attributes(options[:label_options], default: {class: 'form-label'})
+      )
     end
 
-    def check_box_inputs attributes
+    def check_box_inputs attributes, options
       attributes.map do |attribute|
         input = check_box(attribute)
         label = label(attribute) do |tag|
           localized_label("#{attribute}")
         end
-        content_tag :div, class: "multiple-choice" do
+        content_tag :div, {class: 'multiple-choice'}.merge(options.slice(:class, :'data-target')) do
           input + label
         end
       end
@@ -142,18 +185,18 @@ module GovukElementsFormBuilder
                       end
                 text
         end
-        content_tag :div, class: "multiple-choice" do
+        content_tag :div, {class: 'multiple-choice'}.merge(options.slice(:class, :'data-target')) do
           input + label
         end
       end
     end
 
-    def fieldset_legend attribute
+    def fieldset_legend attribute, options
       legend = content_tag(:legend) do
         tags = [content_tag(
                   :span,
                   fieldset_text(attribute),
-                  class: 'form-label-bold'
+                  merge_attributes(options[:legend_options], default: {class: 'form-label-bold'})
                 )]
 
         if error_for? attribute
@@ -172,7 +215,9 @@ module GovukElementsFormBuilder
       legend.html_safe
     end
 
-    def fieldset_options attributes, options
+    def fieldset_options attribute, options
+      self.current_fieldset_attribute = attribute
+
       fieldset_options = {}
       fieldset_options[:class] = 'inline' if options[:inline] == true
       fieldset_options

data/lib/govuk_elements_form_builder/version.rb

@@ -1,3 +1,3 @@
 module GovukElementsFormBuilder
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_elements_form_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alistair Laing
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-21 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -163,6 +163,7 @@ files:
 - Rakefile
 - app/helpers/govuk_elements_errors_helper.rb
 - lib/govuk_elements_form_builder.rb
+- lib/govuk_elements_form_builder/block_buffer.rb
 - lib/govuk_elements_form_builder/components/error_summary.rb
 - lib/govuk_elements_form_builder/form_builder.rb
 - lib/govuk_elements_form_builder/version.rb