govuk_elements_form_builder 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b788800d15d8ae1a07b12e3582f03a1b5a6f5cba
+  data.tar.gz: 97aea32625fa53528d7650eb02438e3370855dce
+SHA512:
+  metadata.gz: 427bb61c76c85ccdfd06771bd0bd7165591cba1cd3bc5f8d69fb74cf0eb9bf9a7d25793b4fd9f76986625ef66ff55776eb1f446071a529c2713c6df29a3e69ac
+  data.tar.gz: b7a125879ee2b133bf44b56c236455826b6b81d534964e9f64ed972272d5e126b91afc13192f79ada47218f4a5e3ed5f12d9de804a351c3a9f47f99e548aeba2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Alistair Laing
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GovukElementsFormBuilder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/helpers/govuk_elements_errors_helper.rb

@@ -0,0 +1,161 @@
+module GovukElementsErrorsHelper
+
+  class << self
+    include ActionView::Context
+    include ActionView::Helpers::TagHelper
+  end
+
+  def self.error_summary object, heading, description
+    return unless errors_exist? object
+    error_summary_div do
+      error_summary_heading(heading) +
+      error_summary_description(description) +
+      error_summary_list(object)
+    end
+  end
+
+  def self.errors_exist? object
+    errors_present?(object) || child_errors_present?(object)
+  end
+
+  def self.child_errors_present? object
+    attributes(object).any? { |child| errors_exist?(child) }
+  end
+
+  def self.attributes object
+    child_objects = attribute_objects object
+    nested_child_objects = child_objects.map { |o| attributes(o) }
+    (child_objects + nested_child_objects).flatten
+  end
+
+  def self.attribute_objects object
+    object.
+      instance_variables.
+      map { |var| instance_variable(object, var) }.
+      compact
+  end
+
+  def self.child_to_parent object, parents={}
+    attribute_objects(object).each do |child|
+      parents[child] = object
+      child_to_parent child, parents
+    end
+    parents
+  end
+
+  def self.instance_variable object, var
+    field = var.to_s.sub('@','').to_sym
+    object.send(field) if object.respond_to?(field)
+  end
+
+  def self.errors_present? object
+    object && object.respond_to?(:errors) && object.errors.present?
+  end
+
+  def self.children_with_errors object
+    attributes(object).select { |child| errors_present?(child) }
+  end
+
+  def self.error_summary_div &block
+    content_tag(:div,
+        class: 'error-summary',
+        role: 'group',
+        aria: {
+          labelledby: 'error-summary-heading'
+        },
+        tabindex: '-1') do
+      yield block
+    end
+  end
+
+  def self.error_summary_heading text
+    content_tag :h1,
+      text,
+      id: 'error-summary-heading',
+      class: 'heading-medium error-summary-heading'
+  end
+
+  def self.error_summary_description text
+    content_tag :p, text
+  end
+
+  def self.error_summary_list object
+    content_tag(:ul, class: 'error-summary-list') do
+      child_to_parents = child_to_parent(object)
+      messages = error_summary_messages(object, child_to_parents)
+
+      messages << children_with_errors(object).map do |child|
+        error_summary_messages(child, child_to_parents)
+      end
+
+      messages.flatten.join('').html_safe
+    end
+  end
+
+  def self.error_summary_messages object, child_to_parents
+    object.errors.keys.map do |attribute|
+      error_summary_message object, attribute, child_to_parents
+    end
+  end
+
+  def self.error_summary_message object, attribute, child_to_parents
+    messages = object.errors.full_messages_for attribute
+    messages.map do |message|
+      object_prefixes = object_prefixes object, child_to_parents
+      link = link_to_error(object_prefixes, attribute)
+      message.sub! default_label(attribute), localized_label(object_prefixes, attribute)
+      content_tag(:li, content_tag(:a, message, href: link))
+    end
+  end
+
+  def self.link_to_error object_prefixes, attribute
+    ['#error', *object_prefixes, attribute].join('_')
+  end
+
+  def self.default_label attribute
+    attribute.to_s.humanize.capitalize
+  end
+
+  def self.localized_label object_prefixes, attribute
+    object_key = object_prefixes.shift
+    object_prefixes.each { |prefix| object_key += "[#{prefix}]" }
+    key = "#{object_key}.#{attribute}"
+    I18n.t(key,
+      default: default_label(attribute),
+      scope: 'helpers.label').presence
+  end
+
+  def self.parents_list object, child_to_parents
+    if parent = child_to_parents[object]
+      [].tap do |parents|
+        while parent
+          parents.unshift parent
+          parent = child_to_parents[parent]
+        end
+      end
+    end
+  end
+
+  def self.object_prefixes object, child_to_parents
+    parents = parents_list object, child_to_parents
+
+    if parents.present?
+      root = parents.shift
+      prefixes = [underscore_name(root)]
+      parents.each { |p| prefixes << "#{underscore_name p}_attributes" }
+      prefixes << "#{underscore_name object}_attributes"
+    else
+      prefixes = [underscore_name(object)]
+    end
+  end
+
+  def self.underscore_name object
+    object.class.name.underscore
+  end
+
+  private_class_method :error_summary_div
+  private_class_method :error_summary_heading
+  private_class_method :error_summary_description
+  private_class_method :error_summary_messages
+
+end

data/lib/govuk_elements_form_builder.rb

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

data/lib/govuk_elements_form_builder/form_builder.rb

@@ -0,0 +1,267 @@
+module GovukElementsFormBuilder
+  class FormBuilder < ActionView::Helpers::FormBuilder
+
+    ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
+      add_error_to_html_tag! html_tag, instance
+    end
+
+    delegate :content_tag, :tag, :safe_join, to: :@template
+    delegate :errors, to: :@object
+
+    # 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
+    end
+
+    %i[
+      email_field
+      password_field
+      number_field
+      phone_field
+      range_field
+      search_field
+      telephone_field
+      text_area
+      text_field
+      url_field
+    ].each do |method_name|
+      define_method(method_name) do |attribute, *args|
+        content_tag :div, class: form_group_classes(attribute), id: form_group_id(attribute) do
+          options = args.extract_options!
+          set_field_classes! options
+
+          label = label(attribute, class: "form-label")
+          add_hint :label, label, attribute
+          (label + super(attribute, options.except(:label)) ).html_safe
+        end
+      end
+    end
+
+    def radio_button_fieldset attribute, options={}
+      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)
+                    ], "\n")
+        end
+      end
+    end
+
+    def check_box_fieldset legend_key, attributes, options={}
+      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)
+                    ], "\n")
+        end
+      end
+    end
+
+    def collection_select method, collection, value_method, text_method, options = {}, *args
+
+      content_tag :div, class: form_group_classes(method), id: form_group_id(method) do
+
+        html_options = args.extract_options!
+        set_field_classes! html_options
+
+        label = label(method, class: "form-label")
+        add_hint :label, label, method
+
+        (label+ super(method, collection, value_method, text_method, options , html_options)).html_safe
+      end
+
+    end
+
+    private
+
+    def set_field_classes! options
+      text_field_class = "form-control"
+      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
+    end
+
+    def check_box_inputs attributes
+      attributes.map do |attribute|
+        label(attribute, class: 'block-label selection-button-checkbox') do |tag|
+          input = check_box(attribute)
+          input + localized_label("#{attribute}")
+        end
+      end
+    end
+
+    def radio_inputs attribute, options
+      choices = options[:choices] || [ :yes, :no ]
+      choices.map do |choice|
+        label(attribute, class: 'block-label selection-button-radio', value: choice) do |tag|
+          input = radio_button(attribute, choice)
+          input + localized_label("#{attribute}.#{choice}")
+        end
+      end
+    end
+
+    def fieldset_legend attribute
+      legend = content_tag(:legend) do
+        tags = [content_tag(
+                  :span,
+                  fieldset_text(attribute),
+                  class: 'form-label-bold'
+                )]
+
+        if error_for? attribute
+          tags << content_tag(
+            :span,
+            error_full_message_for(attribute),
+            class: 'error-message'
+          )
+        end
+
+        hint = hint_text attribute
+        tags << content_tag(:span, hint, class: 'form-hint') if hint
+
+        safe_join tags
+      end
+      legend.html_safe
+    end
+
+    def fieldset_options attributes, options
+      fieldset_options = {}
+      fieldset_options[:class] = 'inline' if options[:inline] == true
+      fieldset_options
+    end
+
+    private_class_method def self.add_error_to_html_tag! html_tag, instance
+      object_name = instance.instance_variable_get(:@object_name)
+      object = instance.instance_variable_get(:@object)
+
+      case html_tag
+      when /^<label/
+        add_error_to_label! html_tag, object_name, object
+      when /^<input/
+        add_error_to_input! html_tag, 'input'
+      when /^<textarea/
+        add_error_to_input! html_tag, 'textarea'
+      else
+        html_tag
+      end
+    end
+
+    def self.attribute_prefix object_name
+      object_name.to_s.tr('[]','_').squeeze('_').chomp('_')
+    end
+
+    def attribute_prefix
+      self.class.attribute_prefix(@object_name)
+    end
+
+    def form_group_id attribute
+      "error_#{attribute_prefix}_#{attribute}" if error_for? attribute
+    end
+
+    private_class_method def self.add_error_to_label! html_tag, object_name, object
+      field = html_tag[/for="([^"]+)"/, 1]
+      object_attribute = object_attribute_for field, object_name
+      message = error_full_message_for object_attribute, object_name, object
+      if message
+        html_tag.sub(
+          '</label',
+          %Q{<span class="error-message" id="error_message_#{field}">#{message}</span></label}
+        ).html_safe # sub() returns a String, not a SafeBuffer
+      else
+        html_tag
+      end
+    end
+
+    private_class_method def self.add_error_to_input! html_tag, element
+      field = html_tag[/id="([^"]+)"/, 1]
+      html_tag.sub(
+        element,
+        %Q{#{element} aria-describedby="error_message_#{field}"}
+      ).html_safe # sub() returns a String, not a SafeBuffer
+    end
+
+    def form_group_classes attributes
+      attributes = [attributes] if !attributes.respond_to? :count
+      classes = 'form-group'
+      classes += ' error' if attributes.find { |a| error_for? a }
+      classes
+    end
+
+    def self.error_full_message_for attribute, object_name, object
+      message = object.errors.full_messages_for(attribute).first
+      message&.sub default_label(attribute), localized_label(attribute, object_name)
+    end
+
+    def error_full_message_for attribute
+      self.class.error_full_message_for attribute, @object_name, @object
+    end
+
+    def error_for? attribute
+      errors.messages.key?(attribute) && !errors.messages[attribute].empty?
+    end
+
+    private_class_method def self.object_attribute_for field, object_name
+      field.to_s.
+        sub("#{attribute_prefix(object_name)}_", '').
+        to_sym
+    end
+
+    def add_hint tag, element, name
+      if hint = hint_text(name)
+        hint_span = content_tag(:span, hint, class: 'form-hint')
+        element.sub!("</#{tag}>", "#{hint_span}</#{tag}>".html_safe)
+      end
+    end
+
+    def fieldset_text attribute
+      localized 'helpers.fieldset', attribute, default_label(attribute)
+    end
+
+    def hint_text attribute
+      localized 'helpers.hint', attribute, ''
+    end
+
+    def self.default_label attribute
+      attribute.to_s.split('.').last.humanize.capitalize
+    end
+
+    def default_label attribute
+      self.class.default_label attribute
+    end
+
+    def self.localized_label attribute, object_name
+      localized 'helpers.label', attribute, default_label(attribute), object_name
+    end
+
+    def localized_label attribute
+      self.class.localized_label attribute, @object_name
+    end
+
+    def self.localized scope, attribute, default, object_name
+      key = "#{object_name}.#{attribute}"
+      translate key, default, scope
+    end
+
+    def self.translate key, default, scope
+      # Passes blank String as default because nil is interpreted as no default
+      I18n.translate(key, default: '', scope: scope).presence ||
+      I18n.translate("#{key}_html", default: default, scope: scope).html_safe.presence
+    end
+
+    def localized scope, attribute, default
+      self.class.localized scope, attribute, default, @object_name
+    end
+
+  end
+end

data/lib/govuk_elements_form_builder/version.rb

@@ -0,0 +1,3 @@
+module GovukElementsFormBuilder
+  VERSION = "0.0.2"
+end

data/lib/tasks/govuk_elements_form_builder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :govuk_elements_form_builder do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: govuk_elements_form_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alistair Laing
+- Rob McKinnon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    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: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    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: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Custom Ruby on Rails form builder that generates GOV.UK elements styled
+  markup for form inputs, including error validation messages.
+email:
+- Alistair.Laing@Digital.Justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/helpers/govuk_elements_errors_helper.rb
+- lib/govuk_elements_form_builder.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
+- lib/tasks/govuk_elements_form_builder_tasks.rake
+homepage: https://github.com/ministryofjustice/govuk_elements_form_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails form builder that generates GOV.UK elements styled markup for
+  forms.
+test_files: []