govuk_admin_template 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da51806c92ecf192e1e86588976fdfff18ba48f8
-  data.tar.gz: 9f7cfd6b015eda2f45d667af4e4a3c880a80dc28
+  metadata.gz: 2c56ebc64084872a0154fa55966b9a1d03693533
+  data.tar.gz: 10700fabdcf062fe7cb012fc503dab55eea24897
 SHA512:
-  metadata.gz: 1488d3bf3e4058e4d38d233e407640e919a5954095d5bc3dd98a4aa1b00ee546ac3f1257f303e8dae720d27a8212fe9da4fe2bcfcf58da32ac2867aee774867a
-  data.tar.gz: 8407e2e16bbe1702dc33d5c324eabfca39b6ec26233122a023fed63e5e79bf3b9b29530b79bddc7c0752375b4c424d653447480bf41e5abe1aa62dfae868f774
+  metadata.gz: 778b339983aa3c70e7e695f2fe7ec7d3420b59ce89f32e6ade5b6cb2488e91c7e1245dfe50a70815ae6a45362f6f350e3faa669c45fb64c67b73f7b46e89ab63
+  data.tar.gz: 031bff6de0929be3b955784d3bdf420df310ef6582e724ebd7070ec6fe99d51c3f406bb7568e5f0201f55bae9cc67d1983683ff1298b53c487652813bd4533c0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.4.0
+
+* Include optional `simple_form` configuration and locale files
+
 # 4.3.0
 
 * Add Rails 5 compatibility

data/README.md

@@ -73,7 +73,7 @@ in your `spec/javascripts/support/jasmine.yml` like this:
 ```yaml
 src_files:
   - assets/govuk-admin-template.js
- ```
+```
 
 It is recommended that the style guide is also made available within your app at the route `/style-guide`. Add this to your `config/routes.rb` file:
 
@@ -101,6 +101,29 @@ GovukAdminTemplate.configure do |c|
 end
 ```
 
+### Forms
+
+Some GOV.UK admin apps use the [Simple
+Form](https://github.com/plataformatec/simple_form) library for writing form
+markup. This repo contains a recommended configuration in
+`lib/govuk_admin_template/simple_form.rb`.
+
+To use this configuration:
+
+0. Add `simple_form` to your Gemfile.
+0. Add an initializer in `config/initializers/simple_form.rb` containing the
+   following:
+
+```
+SimpleForm.setup do |config|
+  GovukAdminTemplate.setup_simple_form(config)
+end
+```
+
+This gem also provides an i18n file in `config/locales/simple_form.en.yml`.
+This removes the need for this file to be present in the host project unless
+specific customisations are required.
+
 ### Content blocks
 
 The gem [uses nested layouts](http://guides.rubyonrails.org/layouts_and_rendering.html#using-nested-layouts) for customisation.

data/config/locales/simple_form.en.yml

@@ -0,0 +1,31 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Examples
+    labels:
+      defaults:
+        title: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

data/lib/govuk_admin_template.rb

@@ -2,6 +2,7 @@ require "govuk_admin_template/version"
 require "govuk_admin_template/engine"
 require "govuk_admin_template/config"
 require "govuk_admin_template/view_helpers"
+require "govuk_admin_template/simple_form"
 
 module GovukAdminTemplate
   mattr_accessor :environment_style, :environment_label

data/lib/govuk_admin_template/simple_form.rb

@@ -0,0 +1,100 @@
+module GovukAdminTemplate
+  def self.setup_simple_form(config)
+    # Wrappers are used by the form builder to generate a complete input.
+    # You can remove any component from the wrapper, change the order or
+    # even add your own to the stack.
+
+    # The options given below are used to wrap the whole input.
+    config.wrappers :default, class: :input, hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+      # Determines whether to use HTML5 (:email, :url, ...)
+      # and required attributes
+      b.use :html5
+
+      # Calculates placeholders automatically from I18n
+      # You can also pass a string as f.input placeholder: "Placeholder"
+      b.use :placeholder
+
+      ## Optional extensions
+      # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
+      # to the input. If so, they will retrieve the values from the model
+      # if any exists. If you want to enable the lookup for any of those
+      # extensions by default, you can change `b.optional` to `b.use`.
+
+      # Calculates maxlength from length validations for string inputs
+      b.optional :maxlength
+
+      # Calculates pattern from format validations for string inputs
+      b.optional :pattern
+
+      # Calculates min and max from length validations for numeric inputs
+      b.optional :min_max
+
+      # Calculates readonly automatically from readonly attributes
+      b.optional :readonly
+
+      ## Inputs
+      b.use :label_input
+      b.use :hint,  wrap_with: { tag: :span, class: :hint }
+      b.use :error, wrap_with: { tag: :span, class: :error }
+    end
+
+    config.wrappers :bootstrap, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+      b.use :html5
+      b.use :placeholder
+      b.use :label, class: 'control-label'
+      b.wrapper tag: 'div' do |ba|
+        ba.use :input
+        ba.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+        ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+      end
+    end
+
+    config.wrappers :prepend, tag: 'div', class: "form-group", error_class: 'has-error' do |b|
+      b.use :html5
+      b.use :placeholder
+      b.use :label
+      b.wrapper tag: 'div', class: 'controls' do |input|
+        input.wrapper tag: 'div', class: 'input-prepend' do |prepend|
+          prepend.use :input
+        end
+        input.use :hint,  wrap_with: { tag: 'span', class: 'help-block' }
+        input.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+      end
+    end
+
+    config.wrappers :append, tag: 'div', class: "form-group", error_class: 'has-error' do |b|
+      b.use :html5
+      b.use :placeholder
+      b.use :label
+      b.wrapper tag: 'div', class: 'controls' do |input|
+        input.wrapper tag: 'div', class: 'input-append' do |append|
+          append.use :input
+        end
+        input.use :hint,  wrap_with: { tag: 'span', class: 'help-block' }
+        input.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+      end
+    end
+
+    # The default wrapper to be used by the FormBuilder.
+    config.default_wrapper = :bootstrap
+
+    # Define the way to render check boxes / radio buttons with labels.
+    # Defaults to :nested for bootstrap config.
+    #   inline: input + label
+    #   nested: label > input
+    config.boolean_style = :inline
+
+    # Default class for buttons
+    config.button_class = 'btn'
+
+    # Default tag used for error notification helper.
+    config.error_notification_tag = :div
+
+    # CSS class to add for error notification helper.
+    config.error_notification_class = 'alert alert-danger'
+
+    # Tell browsers whether to use default HTML5 validations (novalidate option).
+    # Default is enabled.
+    config.browser_validations = false
+  end
+end

data/lib/govuk_admin_template/version.rb

@@ -1,3 +1,3 @@
 module GovukAdminTemplate
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_admin_template
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -175,10 +175,12 @@ files:
 - app/views/govuk_admin_template/_table_filter.html.erb
 - app/views/govuk_admin_template/style_guide/index.html.erb
 - app/views/layouts/govuk_admin_template.html.erb
+- config/locales/simple_form.en.yml
 - config/routes.rb
 - lib/govuk_admin_template.rb
 - lib/govuk_admin_template/config.rb
 - lib/govuk_admin_template/engine.rb
+- lib/govuk_admin_template/simple_form.rb
 - lib/govuk_admin_template/version.rb
 - lib/govuk_admin_template/view_helpers.rb
 homepage: https://github.com/alphagov/govuk_admin_template