govuk_tech_docs 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b9d4a186f0bd8cc5f21f4af532c4af40a8151ba
-  data.tar.gz: 5ca815110a5ffe5dcf14e51a230d47745f2c14b2
+  metadata.gz: 3cf2bab991925ed0fabb60ab0476495ab90c800d
+  data.tar.gz: dc103fe59f818f8a4e8409428bd5c10c3868c885
 SHA512:
-  metadata.gz: 8c055c974e0b83cb30347a310ce3eeaaf646b5ab421fb1f8572d5b7edc1bb26f6051c21943966cb287ce68ec5a03ab754c915516ec3f818b1f38bbfd5d3fb957
-  data.tar.gz: c4a41a135993f461faddf1ef0f09513a0c7672f9e78213a0b34cc3ceec903fe47bb49b7572522041960b292fad553850c4f2d47528aa321691f50e953c58d4da
+  metadata.gz: f93a374fb0a35604b6832a3935a86f9dc9c4a1afc2663cd0ac5a20a7e5aa66cd7b10052c721a15c6eca1f956bad104b8de125f80a3f3b20368855ec0eac050e5
+  data.tar.gz: 970bfd4b026cce535b52bf7602fc9086e02e993875c99b11a37f2c94abd2f7fba82e0120f36965eaa3b757a93f07629fc16a4792c8a8b8895f165f399bc13ebe

data/.travis.yml

@@ -1,11 +1,4 @@
 language: ruby
-rvm:
-  - 2.4.2
-script:
-  - bundle exec rake
-before_install:
-  - rvm @global do gem uninstall bundler -a -x
-  - rvm @global do gem install bundler -v 1.17.3
 deploy:
   provider: rubygems
   gem: govuk_tech_docs

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.8.1
+
+This release fixes a bug (#79 - reported in
+[alphagov/tech-docs-template#183][tdt-183]) which prevented a multipage site
+from being generated when a custom `http_prefix` was configured.
+
+[tdt-183]: https://github.com/alphagov/tech-docs-template/issues/183
+
 ## 1.8.0
 
 🎉 Our first contributor from outside of GDS. Thanks [@timja](https://github.com/timja) from [HMCTS](https://hmcts.github.io)! 🤝

data/CONTRIBUTING.md

@@ -4,6 +4,6 @@ Everybody who uses this project is encouraged to contribute to this project. If
 
 - Before adding your feature, [check the backlog to see if someone is already talking about it](https://github.com/alphagov/tech-docs-template/issues)
 - If you add a new option to `config/tech-docs.yml`, make sure you [document the option in docs/configuration.md](docs/configuration.md)
-- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/configuration.md)
+- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/frontmatter.md)
 - You can test your contribution using [unit tests](spec/govuk_tech_docs), [javascript tests](spec/javascripts) or [integration tests](spec/features)
 - If your change is relevant to the users of the gem, add something to [CHANGELOG](CHANGELOG.md). You don't have to do this if it's just refactoring. Make sure that you include any upgrade instructions.

data/README.md

@@ -1,50 +1,69 @@
 # Tech Docs Template - gem
 
-This repo is part of the GOV.UK Tech docs project. This repo contains the Ruby
-gem that is used to distribute most of code that is used to generate the site.
+This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that
+you can use to build technical documentation using a GOV.UK style.
 
-👉 [See alphagov.github.io/tech-docs-manual](https://alphagov.github.io/tech-docs-manual)
+👉 Find out more about the template and its features from the [Tech Docs Template documentation][tdt-docs].
 
 ## Usage
 
-To [generate a new site with the template](https://alphagov.github.io/tech-docs-manual/#create-a-new-site), see the manual.
+👉 Find out how to [generate a new website with the Tech Docs Template][tdt-readme].
 
 ## Contributing
 
-👉 [See CONTRIBUTING.md](CONTRIBUTING.md)
+Everybody who uses this project is encouraged to contribute.
+
+👉 [See CONTRIBUTING.md](CONTRIBUTING.md) for guidance on making changes.
 
 ## Developing locally
 
-There are 2 ways to develop with this gem.
+There are 2 ways to develop with this gem. You can see your changes on either:
+
+- your own Tech Docs Template website
+- the example in this repository
+
+### Use your own Tech Docs Template website
 
-The first is to point your site's Gemfile to your local checkout, and use it normally. This is good for if you want to see what effect your changes have to the actual site.
+If you want to see how your changes to the gem affect your website, you have to point your site's Gemfile to your local checkout:
 
 ```rb
 gem 'govuk_tech_docs', path: '../tech-docs-gem'
 ```
 
-The second is to use the example app in this repo. You can start it by
+To view your changes locally run:
 
+```sh
+bundle exec middleman server
 ```
+
+See your website on `http://localhost:4567` in your browser.
+
+### Use the example in this repo
+
+To start the example in this repo, run:
+
+```sh
 cd example
 bundle install
-bundle exec middleman serve
+bundle exec middleman server
 ```
 
-Your site will appear on <http://localhost:4567>.
+See your website on `http://localhost:4567` in your browser.
 
 ## Tests
 
-We have some automated JavaScript tests that use [Jasmine][jas] as a test
-framework.
+The repository contains automated JavaScript tests that use [Jasmine][jas] test framework.
+
+To run the tests and see the results in your browser:
 
-To run the tests on your machine:
+1. Run `bundle exec rake jasmine`
+2. Go to `http://localhost:8888` in your browser
 
-- Run `bundle exec rake jasmine`
-- Navigate to `http://localhost:8888` in a browser of your choosing
-- Peruse the output of your tests
+To run the tests and see the results in your terminal, run:
 
-Or, on the command line, run `bundle exec rake jasmine:ci`.
+```
+bundle exec rake jasmine:ci
+```
 
 ## Releasing new versions
 
@@ -52,8 +71,19 @@ To release a new version, create a new Pull Request that updates [version.rb](li
 
 Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
 
-## License
+## Licence
+
+Unless stated otherwise, the codebase is released under [the MIT License][mit].
+This covers both the codebase and any sample code in the documentation.
+
+The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.
 
-The gem is available as open source under the terms of the [MIT License](LICENSE).
+[mit]: LICENCE
+[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/
+[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
+[tdt-docs]: https://tdt-documentation.london.cloudapps.digital
+[tdt-template]: https://github.com/alphagov/tech-docs-template
+[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/master/README.md
+[mmt]: https://middlemanapp.com/advanced/project_templates/
 
 [jas]: https://jasmine.github.io/

data/docs/configuration.md

@@ -157,6 +157,18 @@ show_contribution_banner: true
 github_repo: alphagov/example-repo
 ```
 
+## `source_urls`
+
+Customise the URLs that the contribution banner links to. Only useful if
+[show_contribution_banner](#show_contribution_banner) is turned on. By default, "Report issue" links
+to raising a GitHub issue but by modifying the `report_issue_url` it can link to an email address
+or another page.
+
+```yaml
+source_urls:
+  report_issue_url: mailto:support@example.com
+```
+
 ## `show_govuk_logo`
 
 Whether to show the GOV.UK crown logo.

data/govuk_tech_docs.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pry"
 
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.0.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "capybara", "~> 2.18.0"
   spec.add_development_dependency "govuk-lint", "~> 3.7.0"

data/lib/assets/stylesheets/_core.scss

@@ -31,6 +31,7 @@ $desktop-breakpoint: 992px !default;
 @import "modules/contribution-banner";
 @import "modules/technical-documentation";
 @import "modules/toc";
+@import "modules/warning-text";
 @import "modules/collapsible";
 
 @import "accessibility";

data/lib/assets/stylesheets/modules/_warning-text.scss

@@ -0,0 +1,73 @@
+.govuk-warning-text {
+  font-family: nta,Arial,sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  font-weight: 400;
+  font-size: 16px;
+  font-size: 1rem;
+  line-height: 1.25;
+  color: #0b0c0c;
+  position: relative;
+  margin-bottom: 20px;
+  padding: 10px 0; }
+
+@media print {
+  .govuk-warning-text {
+    font-family: sans-serif; } }
+@media (min-width: 40.0625em) {
+  .govuk-warning-text {
+    font-size: 19px;
+    font-size: 1.1875rem;
+    line-height: 1.31579; } }
+@media print {
+  .govuk-warning-text {
+    font-size: 14pt;
+    line-height: 1.15;
+    color: #000; } }
+@media (min-width: 40.0625em) {
+  .govuk-warning-text {
+    margin-bottom: 30px; } }
+.govuk-warning-text__assistive {
+  position: absolute !important;
+  width: 1px !important;
+  height: 1px !important;
+  margin: 0 !important;
+  padding: 0 !important;
+  overflow: hidden !important;
+  clip: rect(0 0 0 0) !important;
+  -webkit-clip-path: inset(50%) !important;
+  clip-path: inset(50%) !important;
+  border: 0 !important;
+  white-space: nowrap !important; }
+
+.govuk-warning-text__icon {
+  font-family: nta,Arial,sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  font-weight: 700;
+  display: inline-block;
+  position: absolute;
+  top: 50%;
+  left: 0;
+  min-width: 32px;
+  min-height: 29px;
+  margin-top: -20px;
+  padding-top: 3px;
+  border: 3px solid #0b0c0c;
+  border-radius: 50%;
+  color: #fff;
+  background: #0b0c0c;
+  font-size: 1.6em;
+  line-height: 29px;
+  text-align: center;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none; }
+
+@media print {
+  .govuk-warning-text__icon {
+    font-family: sans-serif; } }
+.govuk-warning-text__text {
+  display: block;
+  padding-left: 50px; }

data/lib/govuk_tech_docs.rb

@@ -20,6 +20,7 @@ require 'govuk_tech_docs/pages'
 require 'govuk_tech_docs/tech_docs_html_renderer'
 require 'govuk_tech_docs/unique_identifier_extension'
 require 'govuk_tech_docs/unique_identifier_generator'
+require 'govuk_tech_docs/warning_text_extension'
 require 'govuk_tech_docs/api_reference/api_reference_extension'
 
 module GovukTechDocs
@@ -58,7 +59,7 @@ module GovukTechDocs
 
     context.config[:tech_docs] = YAML.load_file('config/tech-docs.yml').with_indifferent_access
     context.activate :unique_identifier
-
+    context.activate :warning_text
     context.activate :api_reference
 
     context.helpers do

data/lib/govuk_tech_docs/contribution_banner.rb

@@ -19,7 +19,13 @@ module GovukTechDocs
     end
 
     def report_issue_url
-      "#{repo_url}/issues/new?labels=bug&title=Re: '#{current_page.data.title}'&body=Problem with '#{current_page.data.title}' (#{config[:tech_docs][:host]}#{current_page.url})"
+      url = config[:source_urls]&.[](:report_issue_url)
+
+      if url.nil?
+        "#{repo_url}/issues/new?labels=bug&title=Re: '#{current_page.data.title}'&body=Problem with '#{current_page.data.title}' (#{config[:tech_docs][:host]}#{current_page.url})"
+      else
+        "#{url}?subject=Re: '#{current_page.data.title}'&body=Problem with '#{current_page.data.title}' (#{config[:tech_docs][:host]}#{current_page.url})"
+      end
     end
 
     def repo_url

data/lib/govuk_tech_docs/table_of_contents/helpers.rb

@@ -45,11 +45,21 @@ module GovukTechDocs
           # Avoid redirect pages
           next if content.include? "http-equiv=refresh"
           # If this page has children, just print the title and recursively
-          # render the children.
-          # If not, print the heading structure.
+          # render the children. If not, print the heading structure.
+
           # We avoid printing the children of the root index.html as it is the
-          # parent of every other top level file.
-          if resource.children.any? && resource.url != "/"
+          # parent of every other top level file.  We need to take any custom
+          # prefix in to consideration when checking for the root index.html.
+          # The prefix may be set with or without a trailing slash: make sure
+          # it has one for this comparison check.
+          home_url =
+            if config[:http_prefix].end_with?("/")
+              config[:http_prefix]
+            else
+              config[:http_prefix] + "/"
+            end
+
+          if resource.children.any? && resource.url != home_url
             output += %{<ul><li><a href="#{resource.url}">#{resource.data.title}</a>\n}
             output += render_page_tree(resource.children, current_page, config, current_page_html)
             output += '</li></ul>'

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.8.0".freeze
+  VERSION = "1.8.1".freeze
 end

data/lib/govuk_tech_docs/warning_text_extension.rb

@@ -0,0 +1,23 @@
+module GovukTechDocs
+  class WarningTextExtension < Middleman::Extension
+    def initialize(app, options_hash = {}, &block)
+      super
+    end
+
+    helpers do
+      def warning_text(text)
+        <<~EOS
+        <div class="govuk-warning-text">
+          <span class="govuk-warning-text__icon" aria-hidden="true">!</span>
+          <strong class="govuk-warning-text__text">
+            <span class="govuk-warning-text__assistive">Warning</span>
+            #{text}
+          </strong>
+        </div>
+        EOS
+      end
+    end
+  end
+end
+
+::Middleman::Extensions.register(:warning_text, GovukTechDocs::WarningTextExtension)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -307,7 +307,7 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- LICENSE
+- LICENCE
 - README.md
 - Rakefile
 - docs/configuration.md
@@ -390,6 +390,7 @@ files:
 - lib/assets/stylesheets/modules/_skip-link.scss
 - lib/assets/stylesheets/modules/_technical-documentation.scss
 - lib/assets/stylesheets/modules/_toc.scss
+- lib/assets/stylesheets/modules/_warning-text.scss
 - lib/assets/stylesheets/palette/_syntax-highlighting.scss
 - lib/assets/stylesheets/utilities/_fonts.scss
 - lib/assets/stylesheets/utilities/_printable.scss
@@ -418,6 +419,7 @@ files:
 - lib/govuk_tech_docs/unique_identifier_extension.rb
 - lib/govuk_tech_docs/unique_identifier_generator.rb
 - lib/govuk_tech_docs/version.rb
+- lib/govuk_tech_docs/warning_text_extension.rb
 - lib/source/api/pages.json.erb
 - lib/source/favicon.ico
 - lib/source/images/anchored-heading-icon-2x.png