govspeak 3.4.0 → 3.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56a1d2187e10b165f7f6872389a4bf16e48c1ba9
+  data.tar.gz: 04d622ee297eb5cbdd0284c42ecd2f8b0f8ef543
+SHA512:
+  metadata.gz: 63b8fb72f6f042920bca9e5b867101e2e03e1c46aac5ab32ce779fee79042ecf957f3c8311164308264ce8c36830bef951211275b37516b73318b88b8e13cff0
+  data.tar.gz: f6fd90f8a72f143aa865f3535463e0e9a7e1f8049ac92ebf6c2c6a2a5780800101ce97fb0713b1046428e17a301d7cab61133bc6fb2f56cc47aed400b216aa6a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.5.0
+
+* Add `{stat-headline}*10m* big numbers{/stat-headline}` markdown for HTML publications
+* `aside` elements are now allowed through the sanitization process.
+* Update Ruby from 1.9.3 to 2.1
+
 ## 3.4.0
 
 * Increase the version of Kramdown to `1.5.0`. This allows compatibility with Jekyll

data/README.md

@@ -74,12 +74,32 @@ highlights the enclosed text in yellow
     The VAT rate is *20%*
     {:/highlight-answer}
 
-creates a large pink highlight box with optional preamble text and giant text denoted with `**`
+creates a large highlight box with optional preamble text and giant text denoted with `**`
 
     <div class="highlight-answer">
     <p>The VAT rate is <em>20%</em></p>
     </div>
 
+### Statistic headline
+
+Used in HTML publications.
+
+Statistic headlines highlight important numbers in content. Displays a statistic as a large number with a description. The statistic and description must make sense when read aloud. The important number must be wrapped in `**`.
+
+```
+{stat-headline}
+*13.8bn* years since the big bang
+{/stat-headline}
+```
+
+Creates the following:
+
+```html
+<aside class="stat-headline">
+  <p><em>13.8bn</em> years since the big bang</p>
+</aside>
+```
+
 ## Points of Contact
 
 ### Contact
@@ -90,7 +110,7 @@ creates a large pink highlight box with optional preamble text and giant text de
     **Minicom:** 0845 604 44 34
     $C
 
-creates an contact box
+creates a contact box
 
     <div class="contact">
     <p><strong>Student Finance England</strong><br><strong>Telephone:</strong> 0845 300 50 90<br><strong>Minicom:</strong> 0845 604 44 34</p>

data/lib/govspeak.rb

@@ -36,7 +36,7 @@ module Govspeak
     def to_html
       kramdown_doc.to_html
     end
-    
+
     def to_liquid
       to_html
     end
@@ -114,6 +114,11 @@ module Govspeak
 #{Govspeak::Document.new(body.strip).to_html}</div>\n}
     }
 
+    extension('stat-headline', %r${stat-headline}(.*?){/stat-headline}$m) { |body|
+      %{\n\n<aside class="stat-headline">
+#{Govspeak::Document.new(body.strip).to_html}</aside>\n}
+    }
+
     # FIXME: these surrounded_by arguments look dodgy
     extension('external', surrounded_by("x[", ")x")) { |body|
       Kramdown::Document.new("[#{body.strip}){:rel='external'}").to_html

data/lib/govspeak/html_sanitizer.rb

@@ -45,7 +45,7 @@ class Govspeak::HtmlSanitizer
         :all => Sanitize::Config::RELAXED[:attributes][:all] + [ "id", "class", "role", "aria-label" ],
         "a"  => Sanitize::Config::RELAXED[:attributes]["a"] + [ "rel" ],
       },
-      elements: Sanitize::Config::RELAXED[:elements] + [ "div", "span" ],
+      elements: Sanitize::Config::RELAXED[:elements] + [ "div", "span", "aside" ],
     })
   end
 end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "3.4.0"
+  VERSION = "3.5.0"
 end

data/test/govspeak_test.rb

@@ -28,6 +28,11 @@ class GovspeakTest < Test::Unit::TestCase
     assert_equal %Q{<p>this </p>\n\n<div class="highlight-answer">\n<p>Lead in to <em>BIG TEXT</em></p>\n</div>\n}, rendered
   end
 
+  test "stat-headline block extension" do
+    rendered =  Govspeak::Document.new("this \n{stat-headline}*13.8bn* Age of the universe in years{/stat-headline}").to_html
+    assert_equal %Q{<p>this </p>\n\n<aside class="stat-headline">\n<p><em>13.8bn</em> Age of the universe in years</p>\n</aside>\n}, rendered
+  end
+
   test "extracts headers with text, level and generated id" do
     document =  Govspeak::Document.new %{
 # Big title

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 3.4.0
-  prerelease: 
+  version: 3.5.0
 platform: ruby
 authors:
 - Ben Griffiths
@@ -10,139 +9,123 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'A set of extensions to markdown layered on top of the kramdown
-
-  library for use in the UK Government Single Domain project'
+description: |-
+  A set of extensions to markdown layered on top of the kramdown
+  library for use in the UK Government Single Domain project
 email:
 - ben@alphagov.co.uk
 - james.stewart@digital.cabinet-office.gov.uk
@@ -150,55 +133,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/kramdown/parser/kramdown_with_automatic_external_links.rb
-- lib/with_deep_merge.rb
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
 - lib/govspeak.rb
-- lib/govspeak/html_sanitizer.rb
-- lib/govspeak/structured_header_extractor.rb
 - lib/govspeak/header_extractor.rb
+- lib/govspeak/html_sanitizer.rb
 - lib/govspeak/html_validator.rb
 - lib/govspeak/kramdown_overrides.rb
+- lib/govspeak/structured_header_extractor.rb
 - lib/govspeak/version.rb
-- README.md
-- CHANGELOG.md
-- Gemfile
-- Rakefile
-- test/govspeak_test_helper.rb
+- lib/kramdown/parser/kramdown_with_automatic_external_links.rb
+- lib/with_deep_merge.rb
+- test/govspeak_structured_headers_test.rb
 - test/govspeak_test.rb
-- test/test_helper.rb
-- test/with_deep_merge_test.rb
+- test/govspeak_test_helper.rb
 - test/html_sanitizer_test.rb
 - test/html_validator_test.rb
-- test/govspeak_structured_headers_test.rb
+- test/test_helper.rb
+- test/with_deep_merge_test.rb
 homepage: http://github.com/alphagov/govspeak
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -842764078508591390
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -842764078508591390
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Markup language for single domain
 test_files:
 - test/govspeak_test_helper.rb