govspeak 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a6fee8680d3b04ed7c86d26efcfdd73fa58f5b
-  data.tar.gz: f3102b0907209a598118940cf7fc1b81258be172
+  metadata.gz: dec9f9ee71166be1a0eead7618adabb81efd51f4
+  data.tar.gz: cdc03d5927dac0271c21d8bba7dddbb565cccf27
 SHA512:
-  metadata.gz: 62b7674a6488a733859c07147734a663a9e0217d9ee7527a1d79cf9d8f04d0bfc50cb3c3d57736e3e87bcd2547a481d31cd5f91e6c923f134c7932a46a7fdd8b
-  data.tar.gz: 56c16ff2616269cd93089a480fa373ba6b6251f66cda4f725e354359a6d7d8141f604e7765304425bd93ff9d0ed6df4fcc5fd6a3bc90bdb6053dd81b9aa73682
+  metadata.gz: 02d24aa502bf2dbb098d03f07fe991b978f272e479ee2beaaab52bb7a4c6fd0927f9e52d40339ec8fd48c432eb316657ae1557f46d0bc8cb44bf9b06eab69844
+  data.tar.gz: 3cfbf2cc7011d73d4f35f223eb7c83946e7f1efba721a2a4f40e03ee1b5ffb75763a0a9671ae32e5c7a001d69c6437b5002ed8e0285ed3cd65f79583c8a65b31

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.2.1
+* Fix validation to make sure buttons are considered valid
+* Only allow buttons to be used on new lines, not when indented or inline within text (useful for guides) [#116](https://github.com/alphagov/govspeak/pull/116)
+
 ## 5.2.0
 * Add button component for govspeak [#114](https://github.com/alphagov/govspeak/pull/114) see README for usage
 

data/lib/govspeak/html_sanitizer.rb

@@ -59,7 +59,7 @@ class Govspeak::HtmlSanitizer
 
   def button_sanitize_config
     [
-      "data-module='cross-domain-tracking'",
+      "data-module",
       "data-tracking-code",
       "data-tracking-name"
     ]

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "5.2.0".freeze
+  VERSION = "5.2.1".freeze
 end

data/lib/govspeak.rb

@@ -136,6 +136,7 @@ module Govspeak
     end
 
     extension('button', %r{
+      ^ # Match start of line only, allows for indenting code examples
       {button(.*?)} # match opening bracket and capture attributes
         \s* # any whitespace between opening bracket and link
         \[ # match start of link markdown
@@ -146,6 +147,7 @@ module Govspeak
         \) # match end of link text markdown
         \s*  # any whitespace between opening bracket and link
       {\/button} # match ending bracket
+      $ # Match end of line only, allows for indenting code examples
     }x) { |attributes, text, href|
       button_classes = "button"
       button_classes << " button-start" if attributes =~ /start/

data/test/govspeak_button_test.rb

@@ -45,17 +45,6 @@ class GovspeakTest < Minitest::Test
     assert_html_output '<p>{button}I shouldn’t render a button{/button}</p>'
   end
 
-  test_given_govspeak "Text before the button {button}[Start Now](http://www.gov.uk){/button} test after the button" do
-    # rubocop:disable Layout/TrailingWhitespace
-    assert_html_output %{
-      <p>Text before the button 
-      <a role="button" class="button" href="http://www.gov.uk">Start Now</a>
-       test after the button</p>
-    }
-    # rubocop:enable Layout/TrailingWhitespace
-    assert_text_output "Text before the button Start Now test after the button"
-  end
-
   test_given_govspeak "Text before the button with line breaks \n\n\n{button}[Start Now](http://www.gov.uk){/button}\n\n\n test after the button" do
     assert_html_output %{
       <p>Text before the button with line breaks</p>
@@ -82,4 +71,12 @@ class GovspeakTest < Minitest::Test
     assert_html_output '<p><a role="button" class="button button-start" href="https://example.com/external-service/start-now" data-module="cross-domain-tracking" data-tracking-code="UA-XXXXXX-Y" data-tracking-name="govspeakButtonTracker">Start Now</a></p>'
     assert_text_output "Start Now"
   end
+
+  # Test indenting button govspeak results in no render, useful in guides
+  test_given_govspeak "    {button start cross-domain-tracking:UA-XXXXXX-Y}[Example](https://example.com/external-service/start-now){/button}" do
+    assert_html_output %{
+      <pre><code>{button start cross-domain-tracking:UA-XXXXXX-Y}[Example](https://example.com/external-service/start-now){/button}
+      </code></pre>
+    }
+  end
 end

data/test/html_sanitizer_test.rb

@@ -28,6 +28,14 @@ class HtmlSanitizerTest < Minitest::Test
     assert_equal "Fortnum &amp; Mason", Govspeak::HtmlSanitizer.new(html).sanitize
   end
 
+  test "allow govspeak button markup" do
+    html = "<a href='#' data-module='cross-domain-tracking' data-tracking-code='UA-XXXXXX-Y' data-tracking-name='govspeakButtonTracker'></a>"
+    assert_equal(
+      "<a href=\"#\" data-module=\"cross-domain-tracking\" data-tracking-code=\"UA-XXXXXX-Y\" data-tracking-name=\"govspeakButtonTracker\"></a>",
+      Govspeak::HtmlSanitizer.new(html).sanitize
+    )
+  end
+
   test "allows images on whitelisted domains" do
     html = "<img src='http://allowed.com/image.jgp'>"
     sanitized_html = Govspeak::HtmlSanitizer.new(html, allowed_image_hosts: ['allowed.com']).sanitize

data/test/html_validator_test.rb

@@ -95,4 +95,10 @@ class HtmlValidatorTest < Minitest::Test
     html = "<div class=\"govspeak\"><h2 id=\"some-title\">\n<span class=\"number\">1. </span> Some title</h2>\n\n<p>Some text</p>\n</div>"
     assert Govspeak::HtmlValidator.new(html).valid?
   end
+
+  test "allow govspeak button" do
+    assert Govspeak::HtmlValidator.new("{button}[Start now](https://gov.uk){/button}").valid?
+    assert Govspeak::HtmlValidator.new("{button start}[Start now](https://gov.uk){/button}").valid?
+    assert Govspeak::HtmlValidator.new("{button start cross-domain-tracking:UA-XXXXXX-Y}[Start now](https://gov.uk){/button}").valid?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Ben Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -320,18 +320,18 @@ signing_key:
 specification_version: 4
 summary: Markup language for single domain
 test_files:
-- test/blockquote_extra_quote_remover_test.rb
 - test/govspeak_test_helper.rb
-- test/govspeak_structured_headers_test.rb
+- test/govspeak_test.rb
 - test/govspeak_attachments_image_test.rb
-- test/govspeak_attachments_test.rb
+- test/with_deep_merge_test.rb
+- test/govspeak_link_test.rb
 - test/test_helper.rb
-- test/govspeak_attachments_inline_test.rb
+- test/html_validator_test.rb
+- test/blockquote_extra_quote_remover_test.rb
 - test/html_sanitizer_test.rb
+- test/govspeak_attachments_test.rb
 - test/govspeak_button_test.rb
-- test/with_deep_merge_test.rb
-- test/html_validator_test.rb
-- test/govspeak_test.rb
-- test/govspeak_link_test.rb
-- test/govspeak_contacts_test.rb
+- test/govspeak_structured_headers_test.rb
 - test/presenters/h_card_presenter_test.rb
+- test/govspeak_contacts_test.rb
+- test/govspeak_attachments_inline_test.rb