mastalk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 469ccc6e66622dc8192693e3c965bc027d07eaf1
-  data.tar.gz: 52e67b6fd78a9332452b5dd78ac2eddca10cab88
+  metadata.gz: 220cf96953a354bbaf66f95e548280ea2f50608b
+  data.tar.gz: bedca3b3cbdaa206841548a6f419dc92ce54cc38
 SHA512:
-  metadata.gz: b3fbae435c5646d1fc37da7864c955362b51b5055bf1ac826f914780d34b2c2bfedef7d4f5d0b1bdcadd8670dfdd97a54d88fa0a8f1caab477a09973e08256e6
-  data.tar.gz: 8d5eab4f6c577485cb1eaeac6773a39eeb3a272945415c7a7104d867270548814852deccd5cbe57b2d2f2b292b792ee0f2220aeb9809256cf0255da516c5c663
+  metadata.gz: bc5650ba5306081a15c26257ac9b9c6c717e9580f3977414220a61766b56dfed9ad6fa549faae5ef5f95220d738881f49d80c09d914a64e5d1a40eb989f64c8c
+  data.tar.gz: e268d79c98be558d3f0aa2f5da4f75a9bc67d08bb3f918a688904a552b8171d7e5addddf5ecab6f0b290fe9f819148ff6c845b2adc38bce39a11352d745605ec

data/.gitignore

@@ -0,0 +1,2 @@
+*.DS_Store
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,174 @@
+# MAStalk [![Build Status](https://travis-ci.org/moneyadviceservice/mastalk.svg)](https://travis-ci.org/moneyadviceservice/mastalk)
+
+The Money Advice Service's Markdown extension language.
+
+## Usage
+
+```
+gem install mastalk
+```
+
+```
+Mastalk::Document.new("markdown").to_html
+```
+
+## Components
+
+### Add Action
+`.add-action` box
+
+```
+^[Help to Buy schemes FAQs](/en/articles/help-to-buy-schemes-faqs)^
+```
+
+Outputs:
+
+```
+<div class="add-action">
+ <p><a href="/en/articles/help-to-buy-schemes-faqs">Help to Buy schemes FAQs</a></p>
+</div>
+```
+
+
+### Callout
+
+`.callout`
+
+```
+$=callout
+# Budgeting tips
+In 1985, average first-time buyers needed a deposit of 5% to buy a home - in 2012, this had increased to 20%
+*Source: HMS Treasury*
+=$
+```
+
+Outputs:
+
+```
+<div class="callout">
+  <h3>Budgeting tips</h3>
+  <p>In 1985, average first-time buyers needed a deposit of 5% to buy a home - in 2012, this had increased to 20%
+    <br><strong>Source: HM Treasury </strong>
+  </p>
+</div>
+```
+
+### Collapsible header
+
+```
+$=
+# Before you borrow
+=$
+
+$-
+Find out if you need to borrow money and whether you can afford it. Learn how to work out the true cost of borrowing.
+
+Taking control of debt
+
+Where to get free debt advice, how to speak to the people you owe money to, and tips to help you pay back your debts in the right order.
+-$
+```
+
+Outputs:
+
+```
+<div class="collapsible is-on">
+  <button class="unstyled-button">
+    <span class="icon icon--toggle"></span>
+    <span class="visually-hidden js-collapsable-hidden">hide </span>
+    Before you borrow
+  </button>
+</div>
+
+<div class="collapsible-section is-on" aria-hidden="false">
+  <p>Find out if you need to borrow money and whether you can afford it. Learn how to work out the true cost of borrowing.</p>
+  <p>Taking control of debt</p>
+  <p>Where to get free debt advice, how to speak to the people you owe money to, and tips to help you pay back your debts in the right order.</p>
+</div>
+
+```
+
+### Ticks
+
+```
+$yes-no
+[y] You should do this
+[y] and then do this
+[y] and finally this
+[n] You should not do this
+[n] or this
+[n] and definitely not do this
+$end
+```
+
+Outputs:
+
+```
+<ul class="yes-no">
+  <li class="yes">You should do this</li>
+  <li class="yes">and then do this</li>
+  <li class="yes">and finally this</li>
+  <li class="no">You should not do this</li>
+  <li class="no">or this</li>
+  <li class="no">and definitely not do this</li>
+</ul>
+```
+
+### Video
+
+`.video-wrapper`
+
+```
+({5n1nixLSrQI})
+
+```
+
+Outputs:
+
+```
+<iframe
+  frameborder="0"
+  height="413"
+  width="680"
+  src= "https://www.youtube.com/embed/5n1nixLSrQI"
+  title="Video">
+</iframe>
+```
+
+### Action Item
+
+`.action-item`
+
+```
+$action
+## Header
+$collapsable
+$why
+  ### Why?
+  Your 'Cash ISA allowance
+$why
+$how
+  ### How?
+  If you already have an ISA
+$how
+$collapsable
+$item
+```
+
+Outputs:
+```
+<div class="action-item">
+  <h2 id="header" role="heading" aria-level="2">Header</h2>
+  <div class="collapsable">
+    <div class="why">
+      <h3 id="why" role="heading" aria-level="3">Why?</h3>
+      <p>Your ‘Cash ISA allowance</p>
+    </div>
+    <div class="how">
+      <h3 id="how" role="heading" aria-level="3">How?</h3>
+      <p>If you already have an ISA</p>
+    </div>
+  </div>
+</div>
+```
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/mastalk/extensions.rb

@@ -0,0 +1,45 @@
+require 'erb'
+
+module Mastalk
+  # Extension DSL for adding new
+  # mastalk snippets.
+  #
+  # Add new snippets in the form:
+  # # start_tag, end_tag, new_line_ending
+  #
+  # <p>replacement html <%= body %></p>
+  module Extensions
+    SNIPPETS_FOLDER=File.join(File.dirname(__FILE__), 'snippets')
+    @@extensions = []
+
+    def extension(start, stop = nil, new_line = false, &block)
+      re_start = Regexp.escape(start)
+      re_stop = stop == '$' ? stop : Regexp.escape(stop || start)
+      regex = Regexp.new("#{re_start}(.*)(#{re_stop})", new_line ? 0 : Regexp::MULTILINE)
+      @@extensions << [regex, block]
+    end
+
+    def extensions
+      return @@extensions unless @@extensions.empty?
+
+      Dir.foreach(SNIPPETS_FOLDER) do |file|
+        next if file == '.' || file == '..'
+        content = File.read(File.join(SNIPPETS_FOLDER, file))
+        start, stop, new_line = args(content)
+        extension(start, stop, new_line == 'false') do |body|
+          ERB.new(remove_syntax_from(content)).result(binding)
+        end
+      end
+
+      @@extensions
+    end
+
+    def args(content)
+      content.match(/#(.*)\n\n/m).captures.first.split(',').map(&:strip)
+    end
+
+    def remove_syntax_from(content)
+      content.split(/#(.*)\n\n/).last
+    end
+  end
+end

data/lib/mastalk/snippets/action_item.html.erb

@@ -0,0 +1,5 @@
+# $action, $item
+
+<div class='action-item'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/add_action.html.erb

@@ -0,0 +1,5 @@
+# ^
+
+<div class='add-action'>
+ <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/callout.html.erb

@@ -0,0 +1,5 @@
+# $=callout, =$
+
+<div class='callout'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/collabsible_section.html.erb

@@ -0,0 +1,5 @@
+# $-, -$
+
+<div class='collapsible-section'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/collapsable.html.erb

@@ -0,0 +1,5 @@
+# $collapsable
+
+<div class='collapsable'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/collapsible_header.html.erb

@@ -0,0 +1,9 @@
+# $=, =$
+
+<div class="collapsible">
+  <button class="unstyled-button">
+    <span class="icon icon--toggle"></span>
+    <span class="visually-hidden js-collapsable-hidden"></span>
+    <%= Mastalk::Document.new(body).to_html %>
+  </button>
+</div>

data/lib/mastalk/snippets/how.html.erb

@@ -0,0 +1,5 @@
+# $how
+
+<div class='how'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/no.html.erb

@@ -0,0 +1,3 @@
+# [n], $, false
+
+<li class='no'><%= body.strip.gsub("\n", '') %></li>

data/lib/mastalk/snippets/ticks.html.erb

@@ -0,0 +1,5 @@
+# $yes-no, $end
+
+<ul class='yes-no'>
+  <%= Mastalk::Document.new(body).to_html %>
+</ul>

data/lib/mastalk/snippets/video.html.erb

@@ -0,0 +1,9 @@
+# ({, })
+
+<iframe
+  frameborder="0"
+  height="413"
+  width="680"
+  src= "<%= "https://www.youtube.com/embed/#{body}" %>"
+  title="Video">
+</iframe>

data/lib/mastalk/snippets/why.html.erb

@@ -0,0 +1,5 @@
+# $why
+
+<div class='why'>
+  <%= Mastalk::Document.new(body.strip).to_html %>
+</div>

data/lib/mastalk/snippets/yes.html.erb

@@ -0,0 +1,3 @@
+# [y], $, false
+
+<li class='yes'><%= body.strip.gsub("\n", '') %></li>

data/mastalk.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = 'mastalk'
+  s.version     = '0.1.2'
+  s.date        = '2014-10-31'
+  s.summary     = 'mastalk'
+  s.description = 'Mastalk markdown extension language'
+  s.authors     = ['Douglas Roper']
+  s.email       = 'dougdroper@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/moneyadviceservice/mastalk'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'kramdown', '~> 1.5.0', '>= 1.5.0'
+  s.add_development_dependency 'rspec', '~> 3.1.0', '>= 3.1.0'
+  s.add_development_dependency 'rake', '~> 10.3.2', '>= 10.3.2'
+end

data/spec/mastalk_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Mastalk::Document do
+
+  context 'Without mastalk syntax' do
+    let(:context) { "###test\nwith markdown" }
+    let(:expected) { "<h3 id=\"test\">test</h3>\n<p>with markdown</p>\n" }
+
+    subject { Mastalk::Document.new(context) }
+
+    it 'kramdown behaviour with no tags' do
+      expect(Mastalk::Document.new('test').to_html).to eq("<p>test</p>\n")
+    end
+
+    it 'converts to html' do
+      expect(subject.to_html).to eq(expected)
+    end
+
+    context 'multiline' do
+      let(:expected) { "<h3 id=\"test\">TEST</h3>\n\n<p>with other stuff</p>\n\n" }
+      let(:context) { "### TEST\r\n\r\nwith other stuff\r\n\r\n " }
+
+      it 'converts to html' do
+        expect(subject.to_html).to eq(expected)
+      end
+    end
+  end
+
+  subject { Mastalk::Document.new(source) }
+
+  let(:expected) { "<div class=\"test\">test</div>\n" }
+
+  context 'custom extension' do
+    let(:source) { '$Etest$E' }
+
+    it 'pre-processes custom tags' do
+      subject.extension('$E') { |body| "<div class='test'>#{body}</div>" }
+      expect(subject.to_html).to eq(expected)
+    end
+
+    context 'multi line' do
+      let(:source) { '$Etest$E$Shello$FIN' }
+      let(:expected) { "<div class=\"test\">test</div>\n<div class=\"test2\">hello</div>\n" }
+
+      it 'processes multi line' do
+        subject.extension('$E') { |body| "<div class='test'>#{body}</div>" }
+        subject.extension('$S', '$FIN') { |body| "<div class='test2'>#{body}</div>" }
+        expect(subject.to_html).to eq(expected)
+      end
+    end
+  end
+
+  context 'extension with start and stop' do
+    let(:source) { '$STARTtest$END' }
+
+    it 'pre-processes custom tags' do
+      subject.extension('$START', '$END') { |body| "<div class='test'>#{body}</div>" }
+      expect(subject.to_html).to eq(expected)
+    end
+  end
+
+  context 'extension with other extensions inside' do
+    let(:source) { "$why\n###header\nbody\n$why" }
+
+    let(:expected) { "<div class=\"why\">\n  <h3 id=\"header\">header</h3>\n<p>body</p>\n\n</div>\n" }
+
+    it 'parses nested structures' do
+      expect(subject.to_html).to eq(expected)
+    end
+  end
+
+  context 'with newline as end' do
+    let(:source) { "$yes-no\n [y] yes \n [n] no \n $end $why\n###header\nbody\n$why" }
+
+    let(:expected) do
+      "<ul class=\"yes-no\">\n  \n<li class=\"yes\">yes</li>\n\n<li class=\"no\">no</li>\n\n\n</ul>\n<div class=\"why\">
+  <h3 id=\"header\">header</h3>\n<p>body</p>\n\n</div>\n"
+    end
+
+    it 'pre-processes custom tags' do
+      expect(subject.to_html).to eq(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/mastalk'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mastalk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Douglas Roper
@@ -76,8 +76,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
 - lib/mastalk.rb
-homepage: http://rubygems.org/
+- lib/mastalk/extensions.rb
+- lib/mastalk/snippets/action_item.html.erb
+- lib/mastalk/snippets/add_action.html.erb
+- lib/mastalk/snippets/callout.html.erb
+- lib/mastalk/snippets/collabsible_section.html.erb
+- lib/mastalk/snippets/collapsable.html.erb
+- lib/mastalk/snippets/collapsible_header.html.erb
+- lib/mastalk/snippets/how.html.erb
+- lib/mastalk/snippets/no.html.erb
+- lib/mastalk/snippets/ticks.html.erb
+- lib/mastalk/snippets/video.html.erb
+- lib/mastalk/snippets/why.html.erb
+- lib/mastalk/snippets/yes.html.erb
+- mastalk.gemspec
+- spec/mastalk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/moneyadviceservice/mastalk
 licenses:
 - MIT
 metadata: {}