govspeak 0.8.15 → 0.8.16

data/README.md

@@ -106,7 +106,7 @@ creates an contact box
 
 creates an address box
 
-    <div class="address vcard"><div class="adr org fn"><p>
+    <div class="address"><div class="adr org fn"><p>
     Hercules House
     <br>Hercules Road
     <br>London SE1 7DU

data/lib/govspeak.rb

@@ -1,11 +1,15 @@
 require 'kramdown'
 require 'govspeak/header_extractor'
+require 'kramdown/parser/kramdown_with_automatic_external_links'
 require 'htmlentities'
 
 module Govspeak
 
   class Document
 
+    Parser = Kramdown::Parser::KramdownWithAutomaticExternalLinks
+    PARSER_CLASS_NAME = Parser.name.split("::").last
+
     @@extensions = []
 
     attr_accessor :images
@@ -16,7 +20,8 @@ module Govspeak
 
     def initialize(source, options = {})
       @source = source ? source.dup : ""
-      @options = options.merge(entity_output: :symbolic)
+      Parser.document_domains = options.delete(:document_domains)
+      @options = {input: PARSER_CLASS_NAME, entity_output: :symbolic}.merge(options)
       @images = []
       super()
     end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "0.8.15"
+  VERSION = "0.8.16"
 end

data/lib/kramdown/parser/kramdown_with_automatic_external_links.rb

@@ -0,0 +1,27 @@
+require "uri"
+
+module Kramdown
+  module Parser
+    class KramdownWithAutomaticExternalLinks < Kramdown::Parser::Kramdown
+      class << self
+        attr_writer :document_domains
+        def document_domains
+          @document_domains || %w(www.gov.uk)
+        end
+      end
+
+      def add_link(el, href, title, alt_text = nil)
+        begin
+          host = URI.parse(href).host
+          unless host.nil? || (self.class.document_domains.compact.include?(host))
+            el.attr['rel'] = 'external'
+          end
+        rescue URI::InvalidURIError, URI::InvalidComponentError
+          # it's safe to ignore these very *specific* exceptions
+        end
+        super
+      end
+    end
+  end
+end
+

data/test/govspeak_test.rb

@@ -9,6 +9,8 @@ SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 require 'test_helper'
 require 'govspeak_test_helper'
 
+require 'ostruct'
+
 class GovspeakTest < Test::Unit::TestCase
   include GovspeakTestHelper
 
@@ -160,13 +162,13 @@ Teston
     assert_text_output "I am very helpful"
   end
 
-  test_given_govspeak "This is a [link](http://www.google.com) isn't it?" do
-    assert_html_output '<p>This is a <a href="http://www.google.com">link</a> isn&rsquo;t it?</p>'
+  test_given_govspeak "This is a [link](http://www.gov.uk) isn't it?" do
+    assert_html_output '<p>This is a <a href="http://www.gov.uk">link</a> isn&rsquo;t it?</p>'
     assert_text_output "This is a link isn’t it?"
   end
 
-  test_given_govspeak "This is a [link with an at sign in it](http://www.google.com/@dg/@this) isn't it?" do
-    assert_html_output '<p>This is a <a href="http://www.google.com/@dg/@this">link with an at sign in it</a> isn&rsquo;t it?</p>'
+  test_given_govspeak "This is a [link with an at sign in it](http://www.gov.uk/@dg/@this) isn't it?" do
+    assert_html_output '<p>This is a <a href="http://www.gov.uk/@dg/@this">link with an at sign in it</a> isn&rsquo;t it?</p>'
     assert_text_output "This is a link with an at sign in it isn’t it?"
   end
 
@@ -187,6 +189,68 @@ Teston
     assert_html_output '<p><a href="http://x.com" rel="external">an xx link</a></p>'
   end
 
+  test_given_govspeak "[internal link](http://www.gov.uk)" do
+    assert_html_output '<p><a href="http://www.gov.uk">internal link</a></p>'
+  end
+
+  test_given_govspeak "[link with no host is assumed to be internal](/)" do
+    assert_html_output '<p><a href="/">link with no host is assumed to be internal</a></p>'
+  end
+
+  test_given_govspeak "[internal link with rel attribute keeps it](http://www.gov.uk){:rel='next'}" do
+    assert_html_output '<p><a href="http://www.gov.uk" rel="next">internal link with rel attribute keeps it</a></p>'
+  end
+
+  test_given_govspeak "[external link without x markers](http://www.google.com)" do
+    assert_html_output '<p><a rel="external" href="http://www.google.com">external link without x markers</a></p>'
+  end
+
+  test_given_govspeak "[external link with rel attribute](http://www.google.com){:rel='next'}" do
+    assert_html_output '<p><a rel="next" href="http://www.google.com">external link with rel attribute</a></p>'
+  end
+
+  test_given_govspeak "Text before [an external link](http://www.google.com)" do
+    assert_html_output '<p>Text before <a rel="external" href="http://www.google.com">an external link</a></p>'
+  end
+
+  test_given_govspeak "[An external link](http://www.google.com) with text afterwards" do
+    assert_html_output '<p><a rel="external" href="http://www.google.com">An external link</a> with text afterwards</p>'
+  end
+
+  test_given_govspeak "Text before [an external link](http://www.google.com) and text afterwards" do
+    assert_html_output '<p>Text before <a rel="external" href="http://www.google.com">an external link</a> and text afterwards</p>'
+  end
+
+  test "should be able to override default 'document_domains' option" do
+    html = Govspeak::Document.new("[internal link](http://www.not-external.com)", document_domains: %w(www.not-external.com)).to_html
+    refute html.include?('rel="external"'), "should not consider www.not-external.com as an external url"
+  end
+
+  test "should be able to supply multiple domains for 'document_domains' option" do
+    html = Govspeak::Document.new("[internal link](http://www.not-external-either.com)", document_domains: %w(www.not-external.com www.not-external-either.com)).to_html
+    refute html.include?('rel="external"'), "should not consider www.not-external-either.com as an external url"
+  end
+
+  test "should be able to override default 'input' option" do
+    html = Govspeak::Document.new("[external link](http://www.external.com)", input: "kramdown").to_html
+    refute html.include?('rel="external"'), "should not automatically add rel external attribute"
+  end
+
+  test "should be able to override default 'entity output' option" do
+    html = Govspeak::Document.new("&amp;", entity_output: :numeric).to_html
+    assert html.include?("&#38;")
+  end
+
+  test "should be assume link with invalid uri is internal" do
+    html = Govspeak::Document.new("[link](:invalid-uri)").to_html
+    refute html.include?('rel="external"')
+  end
+
+  test "should be assume link with invalid uri component is internal" do
+    html = Govspeak::Document.new("[link](mailto://www.example.com)").to_html
+    refute html.include?('rel="external"')
+  end
+
   # Regression test - the surrounded_by helper doesn't require the closing x
   # so 'xaa' was getting picked up by the external link helper above
   # TODO: review whether we should require closing symbols for these extensions

metadata

@@ -2,7 +2,7 @@
 name: govspeak
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.15
+  version: 0.8.16
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-18 00:00:00 Z
+date: 2012-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: kramdown
@@ -71,6 +71,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/govspeak.rb
+- lib/kramdown/parser/kramdown_with_automatic_external_links.rb
 - lib/govspeak/header_extractor.rb
 - lib/govspeak/version.rb
 - README.md
@@ -92,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4415467989565136347
+      hash: -3802672710997913836
       segments: 
       - 0
       version: "0"
@@ -101,14 +102,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4415467989565136347
+      hash: -3802672710997913836
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Markup language for single domain