govuk_tech_docs 6.2.2 → 6.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea5b48a595e28d761a1c50fcfb4533eeba24c00b5fcaa0dd2a00b03b46dc026
-  data.tar.gz: 1e41564f09c3e49afd2683f68e99b58f00f31037527f04786e0ac98c728660c7
+  metadata.gz: 74dc4c44fa70d8f29bb050007da7bfc8740e690f3dda8b4220fc1cbf6246d08d
+  data.tar.gz: 972e4b78381b8a0d07384fd65dc8a40889b56458d31e3bfca60098a053e5b794
 SHA512:
-  metadata.gz: 6fd2247414abdada48e407277b7c03521f8810662bd0c6699ee8615363ab09b3a6e657a2a865dbc4d963fadf3763719f8d34de10b3074ef35ead7d949d471b91
-  data.tar.gz: 0a580c8cf43aaecaa36281dda8adfa6687cd22589334f6cc43e1f0cbd7ccc58e28d322fe99adcc482d883df373dd5270425a02de778b0deec1865031decf2567
+  metadata.gz: c9289ca8f68a4b0327d71355929f319dea91d1a8a72dcbb10a7190a51e6cf59f06ed5df79ed7acf3efa7989c180c29c43727931e64b8045741df4a6fa7b25495
+  data.tar.gz: 7e02307c317a55e7075c71d537fa0e11c60c7250af9c6851f2e45e6068cb8f8fde3236f9202811049e557047c078a5bd9a48e324ff6f19ae57ae651b4f556dae

data/.github/workflows/dependency-review.yaml

@@ -15,7 +15,7 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 #4.9.0
+        uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 #5.0.0
         with:
           # If it's a PR, use the target branch. If it's a push, use 'main'.
           base-ref: ${{ github.event.pull_request.base.ref || 'main' }}

data/.github/workflows/publish.yaml

@@ -20,7 +20,7 @@ jobs:
         with:
           show-progress: false
 
-      - uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
+      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
         with:
           ruby-version: '3'
 
@@ -57,7 +57,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
+      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
         with:
           ruby-version: '3'
           bundler-cache: true

data/.github/workflows/test.yaml

@@ -7,6 +7,11 @@ on:
     branches: [ "main" ]
   workflow_dispatch:
 
+permissions:
+  contents: read          # Allows the action to check out your repository code
+  pull-requests: write    # Allows the action to comment on or update the Dependabot PR
+  statuses: write         # Allows the action to post pass/fail build statuses
+
 jobs:
   test:
     name: Test
@@ -26,7 +31,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
+      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 6.2.4
+
+- Support non-JSON response content types in OpenAPI renderer.
+
+## 6.2.3
+
+- [Fix TOC sidebar not scrolling to active item on page load](https://github.com/alphagov/tech-docs-gem/pull/480)
+
 ## 6.2.2
 
 - Update [govuk_tech_docs.gemspec](govuk_tech_docs.gemspec) to only run `npm` if `npm` is installed.  Allows gem versions scans to complete properly.

data/example/source/pets.yml

@@ -33,6 +33,10 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Pets"
+            text/plain:
+              schema:
+                type: string
+              example: "1: Fido, 2: Buddy, 3: Max"
         default:
           description: unexpected error
           content:

data/govuk_tech_docs.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "chronic"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "csv" # TODO: remove once tilt declares this itself.
-  spec.add_dependency "haml", "~> 6.0" # middleman-core (4.6.3) depends on haml (>= 4.0.5, < 7)
+  spec.add_dependency "haml", ">= 6", "< 8" # middleman-core (4.6.3) depends on haml (>= 4.0.5, < 7)
   spec.add_dependency "middleman"
   spec.add_dependency "middleman-autoprefixer"
   spec.add_dependency "middleman-compass"

data/lib/assets/javascripts/_modules/in-page-navigation.js

@@ -2,13 +2,11 @@
   'use strict'
 
   Modules.InPageNavigation = function InPageNavigation () {
-    var $tocPane
-    var $contentPane
-    var $tocItems
-    var $targets
+    let $contentPane
+    let $tocItems
+    let $targets
 
     this.start = function start ($element) {
-      $tocPane = $element.find('.app-pane__toc')
       $contentPane = $element.find('.app-pane__content')
       $tocItems = $('.js-toc-list').find('a')
       $targets = $contentPane.find('[id]')
@@ -29,7 +27,7 @@
         } else {
           // Store the initial position so that we can restore it even if we
           // never scroll.
-          handleInitialLoadEvent()
+          window.requestAnimationFrame(handleInitialLoadEvent)
         }
       }
     }
@@ -41,7 +39,7 @@
     }
 
     function handleInitialLoadEvent () {
-      var fragment = fragmentForTargetElement()
+      let fragment = fragmentForTargetElement()
 
       if (!fragment) {
         fragment = fragmentForFirstElementInView()
@@ -51,7 +49,7 @@
     }
 
     function handleScrollEvent () {
-      var fragment = fragmentForFirstElementInView()
+      const fragment = fragmentForFirstElementInView()
 
       storeCurrentPositionInHistoryApi(fragment)
       highlightActiveItemInToc(fragment)
@@ -70,8 +68,8 @@
     function highlightActiveItemInToc (fragment) {
       // Navigation items for single page navigation don't necessarily include the path name, but
       // navigation items for multipage navigation items do include it. This checks for either case.
-      var $activeTocItem = $tocItems.filter(function (_) {
-        var url = new URL($(this).attr('href'), window.location.href)
+      let $activeTocItem = $tocItems.filter(function (_) {
+        const url = new URL($(this).attr('href'), window.location.href)
         return url.href === window.location.href
       })
 
@@ -79,35 +77,19 @@
       // Check to see if any nav items contain just the path name.
       if (!$activeTocItem.get(0)) {
         $activeTocItem = $tocItems.filter(function (_) {
-          var url = new URL($(this).attr('href'), window.location.href)
+          const url = new URL($(this).attr('href'), window.location.href)
           return url.hash === '' && url.pathname === window.location.pathname
         })
       }
       if ($activeTocItem.get(0)) {
         $tocItems.removeClass('toc-link--in-view')
         $activeTocItem.addClass('toc-link--in-view')
-        scrollTocToActiveItem($activeTocItem)
+        scrollTocToActiveItem($activeTocItem.get(0))
       }
     }
 
-    function scrollTocToActiveItem ($activeTocItem) {
-      var paneHeight = $tocPane.height()
-      var linkTop = $activeTocItem.position().top
-      var linkBottom = linkTop + $activeTocItem.outerHeight()
-
-      var offset = null
-
-      if (linkTop < 0) {
-        offset = linkTop
-      } else if (linkBottom >= paneHeight) {
-        offset = -(paneHeight - linkBottom)
-      } else {
-        return
-      }
-
-      var newScrollTop = $tocPane.scrollTop() + offset
-
-      $tocPane.scrollTop(newScrollTop)
+    function scrollTocToActiveItem (activeTocElement) {
+      activeTocElement.scrollIntoView({ block: 'nearest', inline: 'nearest' })
     }
 
     function fragmentForTargetElement () {
@@ -115,14 +97,14 @@
     }
 
     function fragmentForFirstElementInView () {
-      var result = null
+      let result = null
 
       $($targets.get().reverse()).each(function checkIfInView (index) {
         if (result) {
           return
         }
 
-        var $this = $(this)
+        const $this = $(this)
 
         if (Math.floor($this.position().top) <= 0) {
           result = $this

data/lib/govuk_tech_docs/api_reference/api_reference_renderer.rb

@@ -58,12 +58,13 @@ module GovukTechDocs
         operations = get_operations(@document.paths[text])
         schemas = operations.flat_map do |_, operation|
           operation.responses.inject([]) do |memo, (_, response)|
-            next memo unless response.content["application/json"]
+            next memo unless response.content
 
-            schema = response.content["application/json"].schema
-
-            memo << schema.name if schema.name
-            memo + schemas_from_schema(schema)
+            response.content.values.inject(memo) do |inner_memo, media_type|
+              schema = media_type.schema
+              inner_memo << schema.name if schema.name
+              inner_memo + schemas_from_schema(schema)
+            end
           end
         end
 

data/lib/govuk_tech_docs/api_reference/templates/responses.html.erb

@@ -10,21 +10,31 @@
 <td><%= key %></td>
 <td>
 <%= render_markdown(response.description) %>
-<% if response.content['application/json']
-if response.content['application/json']["example"]
-  request_body = json_prettyprint(response.content['application/json']["example"])
-else
-  request_body = json_output(response.content['application/json'].schema)
-end
+<% if response.content %>
+<% response.content.each do |content_type, media_type| %>
+<% request_body = nil
+if content_type.include?("json")
+  if media_type["example"]
+    request_body = json_prettyprint(media_type["example"])
+  else
+    request_body = json_output(media_type.schema)
+  end
+elsif media_type["example"]
+  request_body = media_type["example"].to_s
 end %>
 <% if !request_body.blank? %>
-<pre><code><%= request_body %></code></pre>
+<p><em><%= content_type %></em></p>
+<pre><code><%= ERB::Util.html_escape(request_body) %></code></pre>
+<% end %>
+<% end %>
 <% end %>
 </td>
 <td>
-<%= if response.content['application/json']
-  get_schema_link(response.content['application/json'].schema)
-end %>
+<% if response.content %>
+<% response.content.each do |content_type, media_type| %>
+<%= get_schema_link(media_type.schema) %>
+<% end %>
+<% end %>
 </td>
 </tr>
 <% end %>

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.2.2".freeze
+  VERSION = "6.2.4".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 6.2.2
+  version: 6.2.4
 platform: ruby
 authors:
 - Government Digital Service
@@ -69,16 +69,22 @@ dependencies:
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement