govspeak 10.3.0 → 10.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b86000c8998edfcccee37082c8779bc99ccbbfdbc9bf28a624a64444e45aa8
-  data.tar.gz: 965066276488ad504054c3251606ffee542e09c5958fe1dc94c2377a43d9beff
+  metadata.gz: 5a3bf8e18b1cfd9bb3c71bf3774e9232c0c3defa120fd60f983fa9acf47c0b51
+  data.tar.gz: 813f4543fa558f0394e29f06afcc52b6e95ed10714b25ae02607c7f185f78a8b
 SHA512:
-  metadata.gz: 04aee10a7928ad945b7c269f24c87301966a467b2c1131b205a810f2e13a0211ea5b44ae68c515c626ff10d349562c35cdd2f3389a70cca50ee4d27b2d621ea0
-  data.tar.gz: 983127e90594c5937a4178ee735d0f700e0f52025d6a1d2417fa0f5c0367ccb155e27a57fe6590627c6e23668d0942667931913d87afd74e4818f08a89b88a97
+  metadata.gz: 4aa85cc0a63094caaf65aef58851ece00cf9dd3cf32d2ff8c876758a07fb7d139ac7dc19a9b3446b73b8d31a8bef137c4b3b0e41ba1079223c4530fe95e212cf
+  data.tar.gz: ccaa75526e6f9e947f1a2409156a60ca16d904b29c1a877ce8b84264ea2c655dd2a6991c2b992608d992ee26bb0ceb2189e1bc6b12f698091b9956b154f1ac25

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 10.4.0
+
+* Support abbreviations in informationals
+
 ## 10.3.0
 
 * Add Welsh translations for various components: devolved content headings, footnote labels, and image credit labels ([#417](https://github.com/alphagov/govspeak/pull/417))

data/README.md

@@ -33,7 +33,17 @@ Also, consider if:
 Any pages that use govspeak to generate Content will need to *republished* in order for the new changes to be reflected.  
 
 - Data Labs can help identify which pages need updating by [submitting a request](https://gov-uk.atlassian.net/wiki/spaces/GOVUK/pages/1860075525/GOV.UK+Data+Labs#Submitting-a-data-science-request) and [#govuk-2ndline](https://docs.publishing.service.gov.uk/manual/2nd-line.html) can help with republishing
-  
+
+## Debugging
+
+If `log_snapshots: true` is provided as an option when initialising a
+`Govspeak::Document`, a few useful snapshots will be provided. This can help
+with understanding how the content transforms from source through:
+
+- preprocessing (our main Govspeak rendering point);
+- Kramdown processing (the Markdown rendering point); and
+- postprocessing (an additional Govspeak rendering point).
+
 # Extensions
 
 In addition to the [standard Markdown syntax](http://daringfireball.net/projects/markdown/syntax "Markdown syntax"), we have added our own extensions.

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "10.3.0".freeze
+  VERSION = "10.4.0".freeze
 end

data/lib/govspeak.rb

@@ -37,7 +37,7 @@ module Govspeak
     @extensions = []
 
     attr_accessor :images
-    attr_reader :attachments, :contacts, :links, :locale
+    attr_reader :attachments, :contacts, :links, :locale, :log_snapshots
 
     def self.to_html(source, options = {})
       new(source, options).to_html
@@ -51,6 +51,10 @@ module Govspeak
       options = options.dup.deep_symbolize_keys
       @source = source ? source.dup : ""
 
+      @log_snapshots = options.fetch(:log_snapshots, false)
+      log_snapshot("options", options)
+      log_snapshot("source", @source)
+
       @images = options.delete(:images) || []
       @allowed_elements = options.delete(:allowed_elements) || []
       @allowed_image_hosts = options.delete(:allowed_image_hosts) || []
@@ -73,7 +77,11 @@ module Govspeak
                  kramdown_doc.to_html
                end
 
-        Govspeak::PostProcessor.process(html, self)
+        log_snapshot("after Kramdown process", html)
+
+        Govspeak::PostProcessor.process(html, self).tap do
+          log_snapshot("after postprocess", _1)
+        end
       end
     end
 
@@ -117,7 +125,8 @@ module Govspeak
           instance_exec(*Regexp.last_match.captures, &block)
         end
       end
-      source
+
+      source.tap { log_snapshot("after preprocess", _1) }
     end
 
     def remove_forbidden_characters(source)
@@ -197,8 +206,11 @@ module Govspeak
     end
 
     extension("informational", surrounded_by("^")) do |body|
-      %(\n\n<div role="note" aria-label="Information" class="application-notice info-notice">
-#{Govspeak::Document.new(body.strip).to_html}</div>\n)
+      <<~BODY
+        \n\n<div role="note" aria-label="Information" class="application-notice info-notice" markdown="1">
+        #{body.strip}
+        </div>
+      BODY
     end
 
     extension("helpful", surrounded_by("%")) do |body|
@@ -390,6 +402,13 @@ module Govspeak
 
   private
 
+    def log_snapshot(description, *objects)
+      return unless log_snapshots
+
+      puts "===== #{description} ====="
+      !objects.empty? && objects.each { puts _1 }
+    end
+
     def kramdown_doc
       @kramdown_doc ||= Kramdown::Document.new(preprocess(@source), @options)
     end

data/test/govspeak_informational_test.rb

@@ -0,0 +1,100 @@
+require "test_helper"
+require "govspeak_test_helper"
+
+class GovspeakImagesTest < Minitest::Test
+  include GovspeakTestHelper
+  extend Minitest::Spec::DSL
+
+  test "renders okay with just an opening tag" do
+    given_govspeak "^ I am very informational" do
+      assert_html_output %(
+      <div role="note" aria-label="Information" class="application-notice info-notice">
+        <p>I am very informational</p>
+      </div>)
+      assert_text_output "I am very informational"
+    end
+  end
+
+  test "renders okay with opening and closing tags" do
+    given_govspeak("^ I am very informational ^") do
+      assert_html_output %(
+      <div role="note" aria-label="Information" class="application-notice info-notice">
+        <p>I am very informational</p>
+      </div>)
+      assert_text_output "I am very informational"
+    end
+  end
+
+  test "renders okay with no space after the opening tag" do
+    given_govspeak("^I am very informational") do
+      assert_html_output %(
+      <div role="note" aria-label="Information" class="application-notice info-notice">
+        <p>I am very informational</p>
+      </div>)
+      assert_text_output "I am very informational"
+    end
+  end
+
+  test "avoids combining into a single block with an immediately-preceding line" do
+    given_govspeak "The following is very informational\n^ I am very informational ^" do
+      assert_html_output %(
+        <p>The following is very informational</p>
+
+        <div role="note" aria-label="Information" class="application-notice info-notice">
+          <p>I am very informational</p>
+        </div>)
+      assert_text_output "The following is very informational I am very informational"
+    end
+  end
+
+  describe "support for nested Kramdown" do
+    test "supports headings" do
+      given_govspeak "^ ## I am an informational heading" do
+        assert_html_output %(
+        <div role="note" aria-label="Information" class="application-notice info-notice">
+          <h2 id="i-am-an-informational-heading">I am an informational heading</h2>
+        </div>)
+        assert_text_output "I am an informational heading"
+      end
+    end
+
+    test "supports abbreviations" do
+      given_govspeak "^ I am very informational
+
+  Live, love, informational
+
+  *[informational]: do with it what you will
+      " do
+        assert_html_output %(
+          <div role="note" aria-label="Information" class="application-notice info-notice">
+            <p>I am very <abbr title="do with it what you will">informational</abbr></p>
+          </div>
+
+          <p>Live, love, <abbr title="do with it what you will">informational</abbr></p>)
+        assert_text_output "I am very informational Live, love, informational"
+      end
+    end
+
+    test "supports links" do
+      given_govspeak "^ [My informational link](https://www.gov.uk)" do
+        assert_html_output %(
+          <div role="note" aria-label="Information" class="application-notice info-notice">
+            <p><a href="https://www.gov.uk">My informational link</a></p>
+          </div>
+        )
+        assert_text_output "My informational link"
+      end
+    end
+
+    test "supports bold emphasis" do
+      given_govspeak "^ I am **very** informational" do
+        assert_html_output %(
+          <div role="note" aria-label="Information" class="application-notice info-notice">
+            <p>I am <strong>very</strong> informational</p>
+          </div>
+        )
+        assert_text_output "I am very informational"
+      end
+    end
+  end
+end

data/test/govspeak_test.rb

@@ -177,38 +177,12 @@ Teston
     assert_equal %(<p>Paragraph1</p>\n\n<div class="address"><div class="adr org fn"><p>\n123 Test Street<br>Testcase Cliffs<br>Teston<br>0123 456 7890\n</p></div></div>\n), doc.to_html
   end
 
-  test_given_govspeak("^ I am very informational ^") do
-    assert_html_output %(
-      <div role="note" aria-label="Information" class="application-notice info-notice">
-      <p>I am very informational</p>
-      </div>)
-    assert_text_output "I am very informational"
-  end
-
   test "processing an extension does not modify the provided input" do
     input = "^ I am very informational"
     Govspeak::Document.new(input).to_html
     assert_equal "^ I am very informational", input
   end
 
-  test_given_govspeak "The following is very informational\n^ I am very informational ^" do
-    assert_html_output %(
-      <p>The following is very informational</p>
-
-      <div role="note" aria-label="Information" class="application-notice info-notice">
-      <p>I am very informational</p>
-      </div>)
-    assert_text_output "The following is very informational I am very informational"
-  end
-
-  test_given_govspeak "^ I am very informational" do
-    assert_html_output %(
-      <div role="note" aria-label="Information" class="application-notice info-notice">
-      <p>I am very informational</p>
-      </div>)
-    assert_text_output "I am very informational"
-  end
-
   test_given_govspeak "% I am very helpful %" do
     assert_html_output %(
       <div role="note" aria-label="Warning" class="application-notice help-notice">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 10.3.0
+  version: 10.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -213,14 +213,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.14
+        version: 5.1.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.14
+        version: 5.1.15
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -322,6 +322,7 @@ files:
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
 - test/govspeak_images_test.rb
+- test/govspeak_informational_test.rb
 - test/govspeak_link_extractor_test.rb
 - test/govspeak_link_test.rb
 - test/govspeak_structured_headers_test.rb
@@ -366,6 +367,7 @@ test_files:
 - test/govspeak_footnote_test.rb
 - test/govspeak_images_bang_test.rb
 - test/govspeak_images_test.rb
+- test/govspeak_informational_test.rb
 - test/govspeak_link_extractor_test.rb
 - test/govspeak_link_test.rb
 - test/govspeak_structured_headers_test.rb