defra_ruby_template 3.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad9f467369f4c3257b5fcd8377979b9abe00379cc0301089e936449d82e67b84
+  data.tar.gz: a55c17283f7109eaf083d5950ef7674ce5c0d9a78598ad138a9aa7c3ea95fc26
+SHA512:
+  metadata.gz: eabaf004406d88814f2b9ef1a8f248e6e6f890198ecd4eb0d976a82c0c6dc17412631799fd192d27f651e584552fb4999f07b8b3e6a15ed1fc521b60d8e99695
+  data.tar.gz: 61a989ec0cff7c8b46941789582b4475682af4d06f6517c1e81c7528f3ff7859ff77e366a1217c8406f8f8d25436a3307eb4e1af6f5b2e3451e3a22e11e8c739

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in defra-ruby-template.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    defra_ruby_template (3.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  defra_ruby_template!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.2.20

data/README.md

@@ -0,0 +1,71 @@
+# Defra Ruby Template
+
+## About
+
+Adds a GOV.UK-ready layout template and the [govuk_frontend assets](https://github.com/alphagov/govuk-frontend) to a Rails application.
+
+## Installation
+
+Add this line to the application's Gemfile:
+
+```ruby
+gem 'defra-ruby-template'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The Rails application will need to have SCSS enabled (e.g. `sass-rails`).
+
+This gem includes the `defra_ruby_template` layout, and can be included  in a Rails project by adding the following to the default layout (e.g. `application.html.erb`)
+
+```
+
+<% content_for :page_title do %>
+    Page title or defaults to the i18n `global_proposition_header`
+<% end %>
+
+<% content_for :head do %>
+  Stylesheets, Analytics, etc.
+<% end %>
+
+<% content_for :header_content do %>
+ Application name and top-level links
+<% end %>
+
+<% content_for :phase_banner do %>
+  Phase banner, e.g Alpha, Beta, etc
+<% end %>
+
+<% content_for :back_link do %>
+    Link to go back
+<% end %>
+
+<% content_for :footer do %>
+  Application specific footer links
+<% end %>
+
+<%= render template: "layouts/defra_ruby_template" %>
+
+```
+
+
+## Updating the govuk-frontend
+
+To update to the latest govuk-frontend files:
+
+```
+$ npm install govuk-frontend --save
+$ rake
+```
+
+Then update the [`DefraRubyTemplate::Version`](https://github.com/DEFRA/defra-ruby-template/blob/main/lib/defra_ruby_template/version.rb) so that it matches the `govuk-frontend` [version](https://github.com/alphagov/govuk-frontend/tags).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DEFRA/defra-ruby-template.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'defra_ruby_template/version'
+
+task default: :assets
+
+task 'assets' do
+  Rake::Task['stylesheets'].execute
+  Rake::Task['fonts'].execute
+  Rake::Task['images'].execute
+  Rake::Task['javascripts'].execute
+end
+
+task 'stylesheets' do
+  Rake::FileList['node_modules/govuk-frontend/govuk/**/*.scss'].each do |source|
+    target = source.sub('node_modules/govuk-frontend/govuk', 'vendor/assets/stylesheets')
+    mkdir_p(File.dirname(target))
+    copy_file source, target
+  end
+end
+
+task 'fonts' do
+  Rake::FileList[
+     'node_modules/govuk-frontend/govuk/assets/fonts/*.{eot,woff,woff2,ico,svg}'
+   ].each do |source|
+     target = source.sub('node_modules/govuk-frontend/govuk', 'vendor')
+     mkdir_p(File.dirname(target))
+     copy_file source, target
+   end
+ end
+
+task 'images' do
+ Rake::FileList[
+    'node_modules/govuk-frontend/govuk/assets/images/*.{png,gif,jpg,ico,svg}'
+  ].each do |source|
+    target = source.sub('node_modules/govuk-frontend/govuk', 'vendor')
+    mkdir_p(File.dirname(target))
+    copy_file source, target
+  end
+end
+
+task 'javascripts' do
+  files = Rake::FileList['node_modules/govuk-frontend/govuk/all.js'].each do |source|
+    target = source.sub('node_modules/govuk-frontend/govuk', 'vendor/assets/javascripts')
+    target = target.sub('all.js', 'defra_ruby_template.js')
+    mkdir_p(File.dirname(target))
+    copy_file source, target
+  end
+end

data/app/views/layouts/defra_ruby_template.html.erb

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html lang="en" class="govuk-template ">
+<head>
+  <meta charset="utf-8">
+  <title><%= content_for?(:page_title) ? yield(:page_title) : t(:global_proposition_header) %></title>
+  <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
+  <meta name="theme-color" content="#0b0c0c">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+  <link rel="shortcut icon" href="<%= asset_path "favicon.ico" %>" type="image/x-icon" />
+  <link rel="mask-icon" href="<%= asset_path "govuk-logotype-crown.png" %>">
+  <link rel="apple-touch-icon" sizes="180x180" href="<%= asset_path "govuk-apple-touch-icon-180x180.png" %>">
+  <link rel="apple-touch-icon" sizes="167x167" href="<%= asset_path "govuk-apple-touch-icon-167x167.png" %>">
+  <link rel="apple-touch-icon" sizes="152x152" href="<%= asset_path "govuk-apple-touch-icon-152x152.png" %>">
+  <link rel="apple-touch-icon" href="<%= asset_path "govuk-apple-touch-icon.png" %>">
+
+  <%= yield :head %>
+  <meta property="og:image" content="<%= asset_path "govuk-opengraph-image.png" %>">
+</head>
+
+<body class="govuk-template__body ">
+  <script>
+    document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');
+  </script>
+
+  <%= yield :cookies_banner %>
+
+  <a href="#main-content" class="govuk-skip-link">Skip to main content</a>
+
+  <header class="govuk-header " role="banner" data-module="govuk-header">
+    <div class="govuk-header__container govuk-width-container">
+      <div class="govuk-header__logo">
+        <a href="https://www.gov.uk" class="govuk-header__link govuk-header__link--homepage" title="Go to the GOV.UK homepage">
+          <span class="govuk-header__logotype">
+            <svg aria-hidden="true" focusable="false" class="govuk-header__logotype-crown" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 132 97" height="30" width="36">
+              <path fill="currentColor" fill-rule="evenodd" d="M25 30.2c3.5 1.5 7.7-.2 9.1-3.7 1.5-3.6-.2-7.8-3.9-9.2-3.6-1.4-7.6.3-9.1 3.9-1.4 3.5.3 7.5 3.9 9zM9 39.5c3.6 1.5 7.8-.2 9.2-3.7 1.5-3.6-.2-7.8-3.9-9.1-3.6-1.5-7.6.2-9.1 3.8-1.4 3.5.3 7.5 3.8 9zM4.4 57.2c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.5-1.5-7.6.3-9.1 3.8-1.4 3.5.3 7.6 3.9 9.1zm38.3-21.4c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.6-1.5-7.6.3-9.1 3.8-1.3 3.6.4 7.7 3.9 9.1zm64.4-5.6c-3.6 1.5-7.8-.2-9.1-3.7-1.5-3.6.2-7.8 3.8-9.2 3.6-1.4 7.7.3 9.2 3.9 1.3 3.5-.4 7.5-3.9 9zm15.9 9.3c-3.6 1.5-7.7-.2-9.1-3.7-1.5-3.6.2-7.8 3.7-9.1 3.6-1.5 7.7.2 9.2 3.8 1.5 3.5-.3 7.5-3.8 9zm4.7 17.7c-3.6 1.5-7.8-.2-9.2-3.8-1.5-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.3 3.5-.4 7.6-3.9 9.1zM89.3 35.8c-3.6 1.5-7.8-.2-9.2-3.8-1.4-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.4 3.6-.3 7.7-3.9 9.1zM69.7 17.7l8.9 4.7V9.3l-8.9 2.8c-.2-.3-.5-.6-.9-.9L72.4 0H59.6l3.5 11.2c-.3.3-.6.5-.9.9l-8.8-2.8v13.1l8.8-4.7c.3.3.6.7.9.9l-5 15.4v.1c-.2.8-.4 1.6-.4 2.4 0 4.1 3.1 7.5 7 8.1h.2c.3 0 .7.1 1 .1.4 0 .7 0 1-.1h.2c4-.6 7.1-4.1 7.1-8.1 0-.8-.1-1.7-.4-2.4V34l-5.1-15.4c.4-.2.7-.6 1-.9zM66 92.8c16.9 0 32.8 1.1 47.1 3.2 4-16.9 8.9-26.7 14-33.5l-9.6-3.4c1 4.9 1.1 7.2 0 10.2-1.5-1.4-3-4.3-4.2-8.7L108.6 76c2.8-2 5-3.2 7.5-3.3-4.4 9.4-10 11.9-13.6 11.2-4.3-.8-6.3-4.6-5.6-7.9 1-4.7 5.7-5.9 8-.5 4.3-8.7-3-11.4-7.6-8.8 7.1-7.2 7.9-13.5 2.1-21.1-8 6.1-8.1 12.3-4.5 20.8-4.7-5.4-12.1-2.5-9.5 6.2 3.4-5.2 7.9-2 7.2 3.1-.6 4.3-6.4 7.8-13.5 7.2-10.3-.9-10.9-8-11.2-13.8 2.5-.5 7.1 1.8 11 7.3L80.2 60c-4.1 4.4-8 5.3-12.3 5.4 1.4-4.4 8-11.6 8-11.6H55.5s6.4 7.2 7.9 11.6c-4.2-.1-8-1-12.3-5.4l1.4 16.4c3.9-5.5 8.5-7.7 10.9-7.3-.3 5.8-.9 12.8-11.1 13.8-7.2.6-12.9-2.9-13.5-7.2-.7-5 3.8-8.3 7.1-3.1 2.7-8.7-4.6-11.6-9.4-6.2 3.7-8.5 3.6-14.7-4.6-20.8-5.8 7.6-5 13.9 2.2 21.1-4.7-2.6-11.9.1-7.7 8.8 2.3-5.5 7.1-4.2 8.1.5.7 3.3-1.3 7.1-5.7 7.9-3.5.7-9-1.8-13.5-11.2 2.5.1 4.7 1.3 7.5 3.3l-4.7-15.4c-1.2 4.4-2.7 7.2-4.3 8.7-1.1-3-.9-5.3 0-10.2l-9.5 3.4c5 6.9 9.9 16.7 14 33.5 14.8-2.1 30.8-3.2 47.7-3.2z"></path>
+            </svg>
+            <span class="govuk-header__logotype-text">
+              GOV.UK
+            </span>
+          </span>
+        </a>
+      </div>
+      <div class="govuk-header__content">
+        <%= yield :header_content %>
+      </div>
+    </div>
+  </header>
+
+  <div class="govuk-width-container app-width-container">
+    <%= yield :phase_banner %>
+
+    <%= yield :back_link %>
+
+    <main class="govuk-main-wrapper " id="main-content" role="main">
+      <%= yield %>
+    </main>
+  </div>
+
+  <footer class="govuk-footer " role="contentinfo">
+    <div class="govuk-width-container ">
+      <div class="govuk-footer__meta">
+        <div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
+
+          <%= yield :footer %>
+
+          <svg aria-hidden="true" class="govuk-footer__licence-logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 483.2 195.7" height="17" width="41">
+            <path fill="currentColor" d="M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145" />
+          </svg>
+          <span class="govuk-footer__licence-description">
+            All content is available under the
+            <a class="govuk-footer__link" href="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/" rel="license">Open Government Licence v3.0</a>, except where otherwise stated
+          </span>
+        </div>
+        <div class="govuk-footer__meta-item">
+          <a class="govuk-footer__link govuk-footer__copyright-logo" href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/">© Crown copyright</a>
+        </div>
+      </div>
+    </div>
+  </footer>
+  <%= javascript_include_tag "application" %>
+</body>
+</html>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "defra_ruby_template"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/defra_ruby_template.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/defra_ruby_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "defra_ruby_template"
+  spec.version       = DefraRubyTemplate::VERSION
+  spec.authors       = ["Toby Privett"]
+  spec.email         = ["toby@snaplab.co.uk"]
+
+  spec.summary       = "DEFRA Ruby Template"
+  spec.description   = "Adds the GOVUK frontend to a Rails application that uses the Asset Pipeline."
+  spec.homepage      = "https://github.com/DEFRA/defra-ruby-template"
+  spec.license       = "The Open Government Licence (OGL) Version 3"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/defra_ruby_template.rb

@@ -0,0 +1,23 @@
+require "defra_ruby_template/version"
+
+module DefraRubyTemplate
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'defra_ruby_template.assets.precompile' do |app|
+        app.config.assets.precompile <<
+          [
+            "favicon.ico",
+            "govuk-apple-touch-icon-152x152.png",
+            "govuk-apple-touch-icon-167x167.png",
+            "govuk-apple-touch-icon-180x180.png",
+            "govuk-apple-touch-icon.png",
+            "govuk-crest-2x.png",
+            "govuk-crest.png",
+            "govuk-logotype-crown.png",
+            "govuk-mask-icon.svg",
+            "govuk-opengraph-image.png",
+          ]
+      end
+    end
+  end
+end

data/lib/defra_ruby_template/version.rb

@@ -0,0 +1,3 @@
+module DefraRubyTemplate
+  VERSION = "3.13.0"
+end

data/node_modules/govuk-frontend/README.md

@@ -0,0 +1,91 @@
+# GOV.UK Frontend
+
+GOV.UK Frontend contains the code you need to start building a user interface
+for government platforms and services.
+
+See live examples of GOV.UK Frontend components, and guidance on when to use
+them in your service, in the [GOV.UK Design System](https://www.gov.uk/design-system).
+
+## Contact the team
+
+GOV.UK Frontend is maintained by a team at Government Digital Service. If you want to know more about GOV.UK Frontend, please email the [Design System
+team](mailto:govuk-design-system-support@digital.cabinet-office.gov.uk) or get in touch with them on [Slack](https://ukgovernmentdigital.slack.com/messages/govuk-design-system).
+
+## Quick start
+
+There are 2 ways to start using GOV.UK Frontend in your app.
+
+Once installed, you will be able to use the code from the examples in the
+[GOV.UK Design System](https://www.gov.uk/design-system) in your service.
+
+### 1. Install with npm (recommended)
+
+We recommend [installing GOV.UK Frontend using node package manager
+(npm)](https://frontend.design-system.service.gov.uk/installing-with-npm/).
+
+### 2. Install by using compiled files
+
+You can also [download the compiled and minified assets (CSS, JavaScript) from
+GitHub](https://frontend.design-system.service.gov.uk/installing-from-dist/).
+
+## Importing styles
+
+You need to import the GOV.UK Frontend styles into the main Sass file in your
+project. You should place the below code before your own Sass rules (or Sass
+imports) if you want to override GOV.UK Frontend with your own styles.
+
+To import add the below to your Sass file:
+
+  ```scss
+  @import "node_modules/govuk-frontend/govuk/all";
+  ```
+
+[More details on importing styles](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#css)
+
+## Importing JavaScript
+
+Some of the JavaScript included in GOV.UK Frontend improves the usability and
+accessibility of the components. You should make sure that you are importing and
+initialising Javascript in your application to ensure that all users can use it successfully.
+
+You can include Javascript for all components either by copying the `all.js` from `node_modules/govuk-frontend/govuk/` into your application or referencing the file directly:
+
+```html
+<script src="<path-to-govuk-frontend-all-file>/all.js"></script>
+```
+Next you need to initialise the script by adding:
+
+```html
+<script>window.GOVUKFrontend.initAll()</script>
+```
+
+[More details on importing Javascript and advanced options](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#javascript)
+
+
+## Importing assets
+
+In order to import GOV.UK Frontend images and fonts to your project, you should configure your application to reference or copy the relevant GOV.UK Frontend assets.
+
+[More details on importing assets](https://frontend.design-system.service.gov.uk/importing-css-assets-and-javascript/#font-and-image-assets)
+
+
+## Getting updates
+
+To be notified when there’s a new release, you can either:
+
+- [watch the govuk-frontend Github repository](https://help.github.com/en/articles/watching-and-unwatching-repositories)
+- join the [#govuk-design-system channel on cross-government Slack](https://ukgovernmentdigital.slack.com/app_redirect?channel=govuk-design-system)
+
+Find out how to [update with npm](https://frontend.design-system.service.gov.uk/updating-with-npm/).
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the MIT License. This
+covers both the codebase and any sample code in the documentation. The
+documentation is &copy; Crown copyright and available under the terms of the
+Open Government 3.0 licence.
+
+## Contribution guidelines
+
+If you want to help us build GOV.UK Frontend, view our [contribution
+guidelines](https://github.com/alphagov/govuk-frontend/blob/master/CONTRIBUTING.md).

data/node_modules/govuk-frontend/govuk-prototype-kit.config.json

@@ -0,0 +1,14 @@
+{
+  "nunjucksPaths": [
+    "/"
+  ],
+  "scripts": [
+    "/govuk/all.js"
+  ],
+  "assets": [
+    "/govuk/assets"
+  ],
+  "sass": [
+    "/govuk/all.scss"
+  ]
+}