govuk_tech_docs 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53bc02bac11f6ebf954c41005afaa42e17b050ef
-  data.tar.gz: 48781c829d952afb37402f50cfbfc4d12b0f10f3
+  metadata.gz: ac50514097b631f4d275bd75e7db6fcf61085c22
+  data.tar.gz: 23bdb8b1962b066f4ed1fd96a1290c0a7178a145
 SHA512:
-  metadata.gz: 1098aa8ced88e70aa73bb431c356198a1e4b88213922abbf2b6712ffe085dc177079b73f755e9ba801fdd358d85d04add18f4cf1de412ebfb508c5a9f5f0ee94
-  data.tar.gz: b0895964d9e9e15c3096669a89aee2635c999c0cde3bfaa7c44b3e0c58991655e4613bbb7e60d42fba5fde22820aa1ceb07ae42051cf36034f4375e1348b2755
+  metadata.gz: '0091de68c7a21ed1fd0f174206ea9c7b6b303d17a3063c2f888d2f5b07882ee3e3063f7a5b0e30cefe80325299cdbff798e62130e8d2eaf6e73438db1eb8d581'
+  data.tar.gz: bbe21355416d729a9333c589b10a08f34a2910bc78b3b7aedeccde77b2af6670f7ea846c65fd4181d49b650395a5d1d90e59f4caaa4df644728beacfdd4ab7ee

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
-## Unreleased
+## 1.6.2
+
+This version fixes an issue with Middleman hanging (PR #54). It also allows the API reference page to include multiple servers and their descriptions (PR #53).
 
 ## 1.6.1
 

data/example/source/pets.yml

@@ -6,7 +6,10 @@ info:
   license:
     name: MIT
 servers:
-  - url: http://petstore.swagger.io/v1
+  - description: Production
+    url: http://petstore.swagger.io/v1
+  - description: Development
+    url: http://dev.petstore.swagger.io
 paths:
   /pets:
     get:

data/govuk_tech_docs.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "govuk-lint", "~> 3.7.0"
   spec.add_development_dependency "jasmine", "~> 3.1.0"
   spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "byebug"
 end

data/lib/govuk_tech_docs/api_reference/api_reference_extension.rb

@@ -67,7 +67,7 @@ module GovukTechDocs
             text = text.strip
 
             if text == 'api>'
-              @render.api_full(api_info, api_server)
+              @render.api_full(api_info, api_servers)
             elsif type == 'default'
               output = @render.path(text)
               # Render any schemas referenced in the above path
@@ -91,8 +91,8 @@ module GovukTechDocs
         @document.info
       end
 
-      def api_server
-        @document.servers[0]
+      def api_servers
+        @document.servers
       end
     end
   end

data/lib/govuk_tech_docs/api_reference/api_reference_renderer.rb

@@ -17,7 +17,7 @@ module GovukTechDocs
         @template_responses = get_renderer('responses.html.erb')
       end
 
-      def api_full(info, server)
+      def api_full(info, servers)
         paths = ''
         paths_data = @document.paths
         paths_data.each do |path_data|

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

@@ -1,9 +1,19 @@
 <h1 id="<%=  info.title.parameterize %>"><%= info.title %> v<%= info.version %></h1>
 <%= markdown(info.description) %>
-<% if server %>
-<h2 id="base-url">Base URL</h2>
-<p><strong><%= server.url %></strong></p>
+
+<% unless servers.empty? %>
+  <h2 id="servers">Servers</h2>
+  <div id="server-list">  
+    <% servers.each do |server| %>
+    <% if server.description %>
+    <p><strong><%= server.description %></strong></p>
+    <% end %>
+    <a href="<%= server.url %>"><%= server.url %></a>
+  <% end %>
+  </div>
 <% end %>
+
 <%= paths %>
+
 <h2 id="schemas">Schemas</h2>
 <%= schemas %>

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.6.1".freeze
+  VERSION = "1.6.2".freeze
 end

data/lib/govuk_tech_docs.rb

@@ -29,7 +29,6 @@ module GovukTechDocs
   # @option options [Hash] livereload Options to pass to the `livereload`
   #   extension. Hash with symbols as keys.
   def self.configure(context, options = {})
-    context.activate :autoprefixer
     context.activate :sprockets
     context.activate :syntax
 
@@ -52,6 +51,7 @@ module GovukTechDocs
     end
 
     context.configure :build do
+      activate :autoprefixer
       activate :minify_css
       activate :minify_javascript
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -276,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.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: Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem
   for the project.
 email: