govspeak 0.8.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ..gemspec
+gemspec
+
+gem 'simplecov'
+gem 'simplecov-rcov'

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+task :default => [:test_units]
+
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+}

data/lib/govspeak.rb

@@ -0,0 +1,118 @@
+require 'kramdown'
+
+module Govspeak
+
+  class Document
+
+    @@extensions = []
+
+    def self.to_html(source, options = {})
+      new(source, options).to_html
+    end
+
+    def initialize(source, options = {})
+      source ||= ""
+      options[:entity_output] ||= :symbolic
+      @doc = Kramdown::Document.new(preprocess(source), options)
+      super()
+    end
+
+    def to_html
+      @doc.to_html
+    end
+
+    def preprocess(source)
+      @@extensions.each do |title,regexp,block|
+        source.gsub!(regexp) {|match|
+          block.call($1)
+        }
+      end
+      source
+    end
+
+    def self.extension(title, regexp = nil, &block)
+      regexp ||= %r${::#{title}}(.*?){:/#{title}}$m
+      @@extensions << [title, regexp, block]
+    end
+
+    def self.surrounded_by(open, close=nil)
+      open = Regexp::escape(open)
+      if close
+        close = Regexp::escape(close)
+        %r+(?:\r|\n|^)#{open}(.*?)#{close}(\r|\n|$)?+m
+      else
+        %r+(?:\r|\n|^)#{open}(.*?)#{open}?(\r|\n|$)+m
+      end
+    end
+
+    def self.wrap_with_div(class_name, character, parser=Kramdown::Document)
+      extension(class_name, surrounded_by(character)) { |body|
+        content = parser ? parser.new("#{body.strip}\n").to_html : body.strip
+        %{<div class="#{class_name}">\n#{content}</div>\n}
+      }
+    end
+
+    extension('reverse') { |body|
+      body.reverse
+    }
+
+    extension('external', surrounded_by("x")) { |body|
+      Kramdown::Document.new("#{body.strip}{:rel='external'}").to_html
+    }
+
+    extension('informational', surrounded_by("^")) { |body|
+      %{\n\n<div class="application-notice info-notice">
+#{Kramdown::Document.new(body.strip).to_html}</div>\n}
+    }
+
+    extension('important', surrounded_by("@")) { |body|
+      %{\n\n<h3 class="advisory"><span>#{body.strip}</span></h3>\n}
+    }
+
+    extension('helpful', surrounded_by("%")) { |body|
+      %{\n\n<div class="application-notice help-notice">\n<p>#{body.strip}</p>\n</div>\n}
+    }
+
+    extension('map_link', surrounded_by("((", "))")) { |body|
+      %{<div class="map"><iframe width="200" height="200" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="#{body.strip}&output=embed"></iframe><br /><small><a href="#{body.strip}">View Larger Map</a></small></div>}
+    }
+
+    wrap_with_div('summary', '$!')
+    wrap_with_div('form-download', '$D')
+    wrap_with_div('contact', '$C')
+    wrap_with_div('place', '$P', Govspeak::Document)
+    wrap_with_div('information', '$I', Govspeak::Document)
+    wrap_with_div('additional-information', '$AI')
+    wrap_with_div('example', '$E', Govspeak::Document)
+
+    extension('address', surrounded_by("$A")) { |body|
+      %{<div class="address vcard"><div class="adr org fn"><p>\n#{body.sub("\n", "").gsub("\n", "<br />")}\n</p></div></div>\n}
+    }
+
+    extension("numbered list", /((s\d+\.\s.*(?:\n|$))+)/) do |body|
+      steps ||= 0
+      body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do |b|
+          "<li>#{Kramdown::Document.new($2.strip).to_html}</li>\n"
+      end
+      %{<ol class="steps">\n#{body}</ol>}
+    end
+
+    def self.devolved_options
+     { 'scotland' => 'Scotland',
+       'england' => 'England',
+       'england-wales' => 'England and Wales',
+       'northern-ireland' => 'Northern Ireland',
+       'wales' => 'Wales',
+       'london' => 'London' }
+    end
+
+   devolved_options.each do |k,v|
+     extension("devolved-#{k}",/:#{k}:(.*?):#{k}:/m) do |body|
+%{<div class="devolved-content #{k}">
+<p class="devolved-header">This section applies to #{v}</p>
+<div class="devolved-body">#{Kramdown::Document.new(body.strip).to_html}</div>
+</div>\n}
+     end
+   end
+  end
+end

data/test/govspeak_test.rb

@@ -0,0 +1,171 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.start
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+
+require 'test_helper'
+
+class GovspeakTest < Test::Unit::TestCase
+
+  test "simple smoke-test" do
+    rendered =  Govspeak::Document.new("*this is markdown*").to_html
+    assert_equal "<p><em>this is markdown</em></p>\n", rendered
+  end
+
+  test "simple smoke-test for simplified API" do
+    rendered =  Govspeak::Document.to_html("*this is markdown*")
+    assert_equal "<p><em>this is markdown</em></p>\n", rendered
+  end
+
+  test "simple block extension" do
+    rendered =  Govspeak::Document.new("this \n{::reverse}\n*is*\n{:/reverse}\n markdown").to_html
+    assert_equal "<p>this </p>\n\n<p><em>si</em></p>\n\n<p>markdown</p>\n", rendered
+  end
+
+  test "govspark extensions" do
+    markdown_regression_tests = [
+{
+  input: "^ I am very informational ^",
+  output: %{<div class="application-notice info-notice">
+<p>I am very informational</p>
+</div>}
+}, {
+  input: "The following is very informational\n^ I am very informational ^",
+  output: %{<p>The following is very informational</p>
+
+<div class="application-notice info-notice">
+<p>I am very informational</p>
+</div>}
+}, {
+  input: "^ I am very informational",
+  output: %{<div class="application-notice info-notice">
+<p>I am very informational</p>
+</div>}
+}, {
+  input: "@ I am very important @",
+  output: %{<h3 class="advisory"><span>I am very important</span></h3>}
+}, {
+  input: "The following is very important
+@ I am very important @",
+  output: %{<p>The following is very important</p>
+
+<h3 class="advisory"><span>I am very important</span></h3>}
+}, {
+  input: "% I am very helpful %",
+  output:  %{<div class="application-notice help-notice">
+<p>I am very helpful</p>
+</div>}
+}, {
+  input: "The following is very helpful\n% I am very helpful %",
+  output:  %{<p>The following is very helpful</p>
+
+<div class="application-notice help-notice">
+<p>I am very helpful</p>
+</div>}
+}, {
+  input: "## Hello ##\n\n% I am very helpful %\r\n### Young Workers ###\n\n",
+  output:  %{<h2 id="hello">Hello</h2>
+
+<div class="application-notice help-notice">
+<p>I am very helpful</p>
+</div>
+
+<h3 id="young-workers">Young Workers</h3>}
+}, {
+  input: "% I am very helpful",
+  output: %{<div class="application-notice help-notice">
+<p>I am very helpful</p>
+</div>}
+}, {
+  input: "This is a [link](http://www.google.com) isn't it?",
+  output: '<p>This is a <a href="http://www.google.com">link</a> isn&rsquo;t it?</p>'
+}, {
+  input: "This is a [link with an at sign in it](http://www.google.com/@dg/@this) isn't it?",
+  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>'
+}, {
+  input: "HTML
+
+  *[HTML]: Hyper Text Markup Language",
+  output: %{<p><abbr title="Hyper Text Markup Language">HTML</abbr></p>}
+}, {
+  input: "x[a link](http://rubyforge.org)x",
+  output: '<p><a href="http://rubyforge.org" rel="external">a link</a></p>'
+}, {
+  input: "$!
+rainbow
+$!",
+  output: %{<div class="summary">
+<p>rainbow</p>
+</div>}
+}, {
+  input: "$C help, send cake $C",
+  output: %{<div class="contact">
+<p>help, send cake</p>
+</div>}
+}, {
+  input: "$A
+street
+road
+$A",
+  output: %{<div class="address vcard"><div class="adr org fn"><p>
+street<br />road<br />
+</p></div></div>}
+}, {
+  input: "$P
+$I
+help
+$I
+$P",
+  output: %{<div class="place">\n<div class="information">\n<p>help</p>\n</div>\n</div>}
+}, {
+  input: "$D
+can you tell me how to get to...
+$D",
+  output: %{<div class="form-download">
+<p>can you tell me how to get to&hellip;</p>
+</div>}
+}, {
+  input: "1. rod
+2. jane
+3. freddy",
+  output: "<ol>\n  <li>rod</li>\n  <li>jane</li>\n  <li>freddy</li>\n</ol>"
+}, {
+  input: "
+((http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&hl=en&sll=53.800651,-4.064941&sspn=17.759517,42.055664&vpsrc=0&z=14))
+",
+  output: %{<div class="map"><iframe width="200" height="200" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14&amp;output=embed"></iframe><br /><small><a href="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14">View Larger Map</a></small></div>}
+}, {
+  input: "s1. zippy
+s2. bungle
+s3. george
+",
+  output: %{<ol class="steps">
+<li><p>zippy</p>\n</li>
+<li><p>bungle</p>\n</li>
+<li><p>george</p>\n</li>
+</ol>}
+}
+]
+
+markdown_regression_tests.each do |t|
+  rendered = Govspeak::Document.new(t[:input]).to_html
+  assert_equal t[:output].strip, rendered.strip
+end
+
+end
+
+test "devolved markdown sections" do
+    input =  ":scotland: I am very devolved \n and very scottish \n:scotland:"
+    output = '<div class="devolved-content scotland">
+<p class="devolved-header">This section applies to Scotland</p>
+<div class="devolved-body"><p>I am very devolved 
+ and very scottish</p>
+</div>
+</div>
+'
+
+  assert_equal output, Govspeak::Document.new(input).to_html
+end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.expand_path("../lib")) unless $:.include?(File.expand_path("../lib"))
+
+require 'bundler'
+Bundler.setup :default, :development, :test
+
+require 'test/unit'
+
+class Test::Unit::TestCase
+  class << self
+    def test(name, &block)
+     clean_name = name.gsub(/\s+/,'_')
+     method = "test_#{clean_name.gsub(/\s+/,'_')}".to_sym
+     already_defined = instance_method(method) rescue false
+     raise "#{method} exists" if already_defined   
+     define_method(method, &block)
+    end
+  end
+end
+
+require 'govspeak'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: govspeak
+version: !ruby/object:Gem::Version
+  version: 0.8.4
+  prerelease: 
+platform: ruby
+authors:
+- Ben Griffiths
+- James Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: &70159122835620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70159122835620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70159122835160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70159122835160
+description: ! "A set of extensions to markdown layered on top of the kramdown \nlibrary
+  for use in the UK Government Single Domain project"
+email:
+- ben@alphagov.co.uk
+- james.stewart@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/govspeak.rb
+- Gemfile
+- Rakefile
+- test/govspeak_test.rb
+- test/test_helper.rb
+homepage: http://github.com/alphagov/govspeak
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Markup language for single domain
+test_files:
+- test/govspeak_test.rb
+- test/test_helper.rb