eyemask 0.1.0

data/lib/eyemask/liquid.rb

@@ -0,0 +1,9 @@
+require "eyemask/liquid/blockquote"
+require "eyemask/liquid/indent"
+require "eyemask/liquid/markdown"
+require "eyemask/liquid/parse"
+require "eyemask/liquid/relevel"
+require "eyemask/liquid/strip"
+require "eyemask/liquid/uml"
+require "eyemask/liquid/highlight"
+require "eyemask/liquid/note"

data/lib/eyemask/liquid/blockquote.rb

@@ -0,0 +1,13 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    module Blockquote
+      def blockquote(input)
+        input.gsub(/^/, ">")
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::Blockquote)

data/lib/eyemask/liquid/highlight.rb

@@ -0,0 +1,22 @@
+require 'liquid'
+require 'rouge'
+
+module Eyemask
+  module Liquid
+    module Highlight
+
+      def highlight(input, lang)
+        formatter = Rouge::Formatters::HTML.new(inline_theme: "github")
+        lexer = Rouge::Lexer.find(lang)
+        unless lexer.nil?
+          formatter.format(lexer.lex(input))
+        else
+          "<pre class=\"docstring\">#{input}</pre>"
+        end
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::Highlight)

data/lib/eyemask/liquid/indent.rb

@@ -0,0 +1,21 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    class Indent < ::Liquid::Block
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @indentation = markup.to_i
+      end
+
+      def render(context)
+        prefix = " " * @indentation
+        super.gsub(/^/, prefix)
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('indent', Eyemask::Liquid::Indent)

data/lib/eyemask/liquid/markdown.rb

@@ -0,0 +1,22 @@
+require 'liquid'
+require 'redcarpet'
+require 'rouge/plugins/redcarpet'
+
+module Eyemask
+  module Liquid
+    module Markdown
+      class HTML < Redcarpet::Render::HTML
+        include Rouge::Plugins::Redcarpet
+        include Redcarpet::Render::SmartyPants
+      end 
+
+      MARKDOWN = Redcarpet::Markdown.new(HTML, autolink: true, tables: true, footnotes: false, fenced_code_blocks:true, no_intra_emphasis: true, superscript: true, underline: true, highlight: true)
+
+      def markdown(input)
+        MARKDOWN.render(input)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::Markdown)

data/lib/eyemask/liquid/note.rb

@@ -0,0 +1,25 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    class Note < ::Liquid::Block
+
+      MARKDOWN = Redcarpet::Markdown.new(Eyemask::Liquid::Markdown::HTML.new(hard_wrap: true), autolink: true, tables: true, footnotes: false, fenced_code_blocks:true, no_intra_emphasis: true, superscript: true, underline: true, highlight: true)
+
+      def initialize(tag_name, markup, tokens)
+        super
+        params = markup.split(" ")
+        @note_class = params.first
+        @note_data = params.drop(1).join(" ")
+      end
+
+      def render(context)
+        content = MARKDOWN.render(::Liquid::Template.parse(super).render(context.registers))
+        "<aside class=\"note note-#{@note_class}\" data-note=\"#{@note_data}\">#{content}</aside>"
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('note', Eyemask::Liquid::Note)

data/lib/eyemask/liquid/parse.rb

@@ -0,0 +1,15 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    module Parse
+
+      def parse(input)
+        ::Liquid::Template.parse(input).render(@context.registers)
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::Parse)

data/lib/eyemask/liquid/relevel.rb

@@ -0,0 +1,29 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    module RelevelFilter
+      def relevel(input, markup)
+        hash_prefix = "\#" * markup.to_i
+        input.gsub(/^(#+) (.*)$/, "#{hash_prefix}\\1 \\2")
+      end
+    end
+
+    class Relevel < ::Liquid::Block
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @num_up = markup.to_i
+      end
+
+      def render(context)
+        hash_prefix = "\#" * @num_up
+        super.gsub(/^(#+) (.*)$/, "#{hash_prefix}\\1 \\2")
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::RelevelFilter)
+Liquid::Template.register_tag('relevel', Eyemask::Liquid::Relevel)

data/lib/eyemask/liquid/strip.rb

@@ -0,0 +1,13 @@
+require 'liquid'
+
+module Eyemask
+  module Liquid
+    module Strip
+      def strip(input)
+        input.strip
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Eyemask::Liquid::Strip)

data/lib/eyemask/liquid/uml.rb

@@ -0,0 +1,72 @@
+require 'liquid'
+require 'base64'
+
+module Eyemask
+
+  module Liquid
+
+    class Uml < ::Liquid::Block
+
+      def initialize(tag_name, markup, tokens)
+        @tag_name = tag_name
+        super
+      end
+
+      def render(context)
+        "\n\n<figure><img class=\"resolution-#{resolution}\" src=\"#{get_data_uri_for_diagram(super)}\"></figure>\n\n"
+      end
+
+      def get_data_uri_for_diagram(diagram)
+        data = parse_diagram(diagram)
+        "data:image/png;base64,#{Base64.encode64(data)}"
+      end
+
+      def parse_diagram(diagram)
+        output = ""
+        IO.popen(["plantuml", "-pipe"], 'r+') do |f|
+          f.puts("@start#{diagram_type}")
+          case diagram_type
+          when "uml"
+            f.puts("skinparam backgroundColor transparent")
+            f.puts("skinparam shadowing false")
+            f.puts("skinparam dpi 300")
+          end
+          f.puts(diagram)
+          f.puts("@end#{diagram_type}")
+          f.close_write
+          output = f.read
+        end
+        output
+      end
+
+      def resolution
+        case diagram_type
+        when "uml"
+          "print"
+        else
+          "normal"
+        end
+      end
+
+      def diagram_type
+        case @tag_name
+        when "uml"
+          "uml"
+        when "ditaa"
+          "ditaa"
+        when "salt"
+          "salt"
+        else
+          "uml"
+        end
+      end
+
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('uml', Eyemask::Liquid::Uml)
+Liquid::Template.register_tag('ditaa', Eyemask::Liquid::Uml)
+Liquid::Template.register_tag('salt', Eyemask::Liquid::Uml)
+Liquid::Template.register_tag('dot', Eyemask::Liquid::Uml)

data/lib/eyemask/version.rb

@@ -0,0 +1,3 @@
+module Eyemask
+  VERSION = "0.1.0"
+end

data/templates/markdown.md

@@ -0,0 +1,41 @@
+---
+title: {{title}}
+{%if subtitle %}subtitle: {{subtitle}} {% endif %}
+{%unless authors.empty %}author: {% for author in authors %}{{author}}{%unless forloop.last %}, {% endunless %}{% endfor %} {% endunless %}
+---
+
+# Features
+
+{% if contents == empty %}
+No features have been specified.
+{% endif %}
+
+{% for feature in contents %}
+## {{feature.name}}
+
+{% relevel 2 %}
+{{feature.description | uml }}
+{% endrelevel %}
+
+{% for scenario in feature.elements %}
+### {{ scenario.name }}
+
+{% relevel 3 %}
+{{scenario.description | uml }}
+{% endrelevel %}
+
+{% for step in scenario.steps %}
+  - **{{step.keyword | strip}}** {{step.name}}
+{% if step.doc_string %}{% indent 4 %}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+{{ step.doc_string.value }}
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+{% endindent %}{% endif %}
+{% if step.rows %}{% indent 4 %}{% for row in step.rows %}
+  | {% for cell in row.cells %}{{ cell }} | {% endfor %}{% if forloop.first %}
+  |{% for i in row.cells %}---|{% endfor %}{% endif %}{% endfor %}{% endindent %}{% endif %}
+{% endfor %}
+
+{% endfor %}
+
+{% endfor %}

data/templates/princexml.html

@@ -0,0 +1,574 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>{{title}}: {{subtitle}}</title>
+  <link href='http://fonts.googleapis.com/css?family=Merriweather:400,300,300italic,700,400italic,700italic,900,900italic&subset=latin,latin-ext' rel='stylesheet' type='text/css'>
+  <link href='http://fonts.googleapis.com/css?family=Source+Code+Pro:200,300,400,500,600,700,900' rel='stylesheet' type='text/css'>
+  <style>
+    /***** BASELINE *****/
+      html {
+        font-size: 11pt;
+      }
+
+      body {
+        font-family: 'Merriweather', serif;
+        font-size: 2.4rem;
+        line-height: 1.6875;
+      }
+
+      h1,h2,h3,h4 {
+        font-family: 'Merriweather', serif;
+        margin: 0 0 16.875pt 0;
+      }
+
+      h1 {
+        font-size: 37.125pt;
+        font-weight: normal;
+      }
+
+      h2 {
+        font-size: 24.75pt;
+        font-weight: normal;
+      }
+
+      h3 {
+        font-size: 16.5pt;
+        font-weight: normal;
+      }
+
+      h4 {
+        font-size: 11pt;
+      }
+
+    title {
+      string-set: title content();
+    }
+
+    .resolution-print {
+      prince-image-resolution: 300dpi;
+    }
+
+    /***** COVER *****/
+
+    #cover {
+      padding-top: 33.75pt;
+    }
+
+    #cover .client {
+      border-bottom: 1pt solid #999;
+      margin-bottom: 0 !important;
+      letter-spacing: 0.2em;
+      font-family: 'Merriweather', serif;
+      font-size: 24.75pt;
+      font-variant: small-caps;
+    }
+
+    .doctitle {
+      font-family: 'Merriweather', serif;
+      font-size: 37.125pt;
+      font-weight: normal;
+      border-bottom: 1pt solid #999;
+      margin-top: 0 !important;
+    }
+
+    .version {
+      font-family: 'Merriweather', serif;
+      font-size: 16.875pt;
+      font-variant: small-caps;
+      font-weight: normal;
+    }
+
+    .authors::before {
+      display: block;
+      content: "Compiled by:";
+      font-size: 7.26pt;
+      font-weight: 200;
+      font-variant: small-caps;
+      letter-spacing: 0.2em;
+    }
+    .authors {
+      font-family: 'Merriweather', serif;
+      font-size: 11pt;
+      list-style: none;
+      padding: 0;
+      margin: 0;
+    }
+
+    .authors li {
+      padding-bottom: 2.6pt;
+      font-weight: 600;
+    }
+
+    .logo {
+      position: absolute;
+      bottom: 0;
+    }
+
+    /***** TABLE OF CONTENTS *****/
+
+    #frontmatter .chapter h2 {
+      string-set: header content();
+    }
+
+    .toc ol {
+      list-style: none;
+    }
+
+    .toc a {
+      text-decoration: none;
+    }
+
+    .toc a[href]::after { 
+      content: leader(".") target-counter(attr(href), page) 
+    }
+
+    .toc ol a[href]::before {
+      content: target-counter(attr(href), feature) ". ";
+    }
+
+    .toc ol ol a[href]::before {
+      content: target-counter(attr(href), feature) "." target-counter(attr(href), scenario) ". ";
+    }
+
+    /***** PARTS *****/
+
+    .part {
+      counter-increment: part;
+      counter-reset: feature 1 scenario;
+    }
+    .part h1 {
+      text-align: center;
+      margin-top: 88mm;
+      font-weight: normal;
+      font-variant: small-caps;
+    }
+
+    .part h1::before {
+      display: block;
+      margin: 0 auto;
+      font-size: 24.75pt;
+      font-weight: 200;
+      content: counter(part, upper-roman);
+    }
+
+    /***** FEATURES *****/
+
+    .feature + .feature {
+      counter-increment: feature;
+      counter-reset: scenario;
+    }
+
+    .feature header h2 {
+      page-break-after: avoid;
+      margin-top: 33.75pt;
+      font-weight: normal;
+      string-set: header "Feature " counter(feature) ". " content();
+    }
+
+    .feature h2::before {
+      page-break-after: avoid;
+      display: block;
+      margin: 0 auto;
+      font-size: 16.5pt;
+      font-variant: small-caps;
+      content: "Feature " counter(feature) "." ;
+      letter-spacing: 0.2em;
+    }
+
+    .scenario {
+      counter-increment: scenario;
+      margin-bottom: 16.875pt;
+    }
+    .scenario h3 {
+      page-break-after: avoid;
+      font-weight: normal;
+    }
+
+    .scenario h3::before {
+      page-break-after: avoid;
+      display: block;
+      margin: 0 auto;
+      font-size: 11pt;
+      font-variant: small-caps;
+      content: "Scenario " counter(feature) "." counter(scenario) ". ";
+      letter-spacing: 0.2em;
+    }
+
+    .steps ol {
+      margin-left: 0;
+      list-style: lower-roman;
+    }
+
+    .steps ol li p {
+      margin-top: 0 !important;
+    }
+
+    .steps ol li p:only-child {
+      margin: 0;
+    }
+
+    .highlight {
+      page-break-before: avoid;
+    }
+    .docstring {
+      page-break-before: avoid;
+    }
+
+    .steptable {
+      page-break-before: avoid;
+    }
+
+    /***** MATTER *****/
+
+    #cover {
+      page: blank;
+    }
+
+    #frontmatter {
+      page: frontmatter;
+      page-break-before: right;
+    }
+
+    #mainmatter {
+      page: auto;
+      counter-reset: page 1;
+    }
+
+    /***** SECTIONS *****/
+      .part {
+        page-break-before: right;
+        page: blank;
+      }
+      .feature {
+        page-break-before: right;
+        page: auto;
+      }
+
+    /***** SYNTAX HIGHLIGHTING *****/
+
+    .highlight table {
+      border: none;
+      margin: 0;
+    }
+
+    .highlight tr {
+      border: none;
+    }
+
+    .highlight pre {
+      background: none;
+      border: none;
+      margin: 0;
+    }
+
+    /***** PAGES *****/
+
+    @page {
+      size: a4;
+      margin: 33mm 23.33mm 66mm 46.66mm;
+    }
+
+    @page :left {
+      margin: 33mm 23.33mm 66mm 46.66mm;
+      @top-left {
+        font: 11pt 'Merriweather', serif;
+        content: string(title);
+        font-variant: small-caps;
+        vertical-align: bottom;
+        padding-bottom: 2em;
+      }
+
+      @bottom-left {
+        font: 11pt 'Merriweather', serif;
+        content: counter(page);
+        padding-top: 2em;
+        vertical-align: top;
+      }
+    }
+
+    @page :right {
+      margin: 33mm 46.66mm 66mm 23.33mm;
+      @top-right {
+        font: 11pt 'Merriweather', serif;
+        font-variant: small-caps;
+        content: string(header, first); 
+        vertical-align: bottom;
+        padding-bottom: 2em; 
+      }
+
+      @bottom-right {
+        font: 11pt 'Merriweather', serif;
+        content: counter(page);
+        text-align: right;
+        vertical-align: top;
+        padding-top: 2em;
+      }
+    }
+
+    @page frontmatter :left {
+      @top-left {
+        font: 11pt 'Merriweather', serif;
+        font-variant: small-caps;
+        content: string(title);
+        vertical-align: bottom;
+        padding-bottom: 2em;
+      }
+
+      @bottom-left {
+        font: 11pt 'Merriweather', serif;
+        content: counter(page, lower-roman);
+        padding-top: 2em;
+        vertical-align: top;
+      }
+    }
+
+    @page frontmatter :right {
+      @top-right {
+        font: 11pt 'Merriweather', serif;
+        font-variant: small-caps;
+        content: string(header, first); 
+        vertical-align: bottom;
+        padding-bottom: 2em; 
+      }
+
+      @bottom-right {
+        font: 11pt 'Merriweather', serif;
+        content: counter(page, lower-roman);
+        text-align: right;
+        vertical-align: top;
+        padding-top: 2em;
+      }
+    }
+
+    @page blank :left {
+      @top-left { content: normal }
+      @bottom-left { content: normal }
+    }
+
+    @page blank :right {
+      @top-right { content: normal }
+      @bottom-right { content: normal }
+    }
+
+    /***** OTHER *****/
+    /* ---- Tables ---- */
+ 
+      /*  A clean textbook-like style with horizontal lines above and below and under 
+          the header. Rows highlight on hover to help scanning the table on screen.
+      */
+       
+      table
+          {
+          border-collapse: collapse;
+          border-spacing: 0; /* IE 6 */
+       
+          border-bottom: 2pt solid #000;
+          border-top: 2pt solid #000; /* The caption on top will not have a bottom-border */
+       
+          /* Center */
+          margin-left: auto;
+          margin-right: auto;
+          margin-bottom: 16.875pt;
+          }
+          
+      thead /* Entire table header */
+          {
+          border-bottom: 1pt solid #000;
+          background-color: #ccc; /* Does this BG print well? */
+          }
+       
+      tr.header /* Each header row */
+          {
+          } 
+       
+      tbody /* Entire table  body */
+          {
+          }
+       
+      /* Table body rows */
+       
+      tr  {
+        border-bottom: 0.5pt solid #000;
+          }
+      .steptable tbody tr:nth-child(2n)
+          {
+          /*background-color: #eee;*/
+          }
+          
+       
+      td, th /* Table cells and table header cells */
+          { 
+          vertical-align: top; /* Word */
+          vertical-align: baseline; /* Others */
+          padding-left:   0.5em;
+          padding-right:  0.5em;
+          padding-top:    0.2em;
+          padding-bottom: 0.2em;
+          }
+
+      /* Code */
+
+      /* code {
+        display: block;
+        padding: 0.5em;
+        background-color: #ccc;
+      } */
+
+      pre,code,.highlight {
+        font-family: "Source Code Pro";
+        background-color: #eee;
+      }
+
+      pre, code 
+    {
+    /* BEGIN word wrap */
+    /* Need all the following to word wrap instead of scroll box */
+    /* This will override the overflow:auto if present */
+    white-space: pre-wrap; /* css-3 */
+    white-space: -moz-pre-wrap !important; /* Mozilla, since 1999 */
+    white-space: -pre-wrap; /* Opera 4-6 */
+    white-space: -o-pre-wrap; /* Opera 7 */
+    word-wrap: break-word; /* Internet Explorer 5.5+ */
+    /* END word wrap */
+    }
+ 
+pre, .highlight /* Code blocks */
+    {
+    /* Distinguish pre blocks from other text by more than the font with a background tint. */
+    padding: 0.5em; /* Since we have a background color */
+    border-radius: 5px; /* Softens it */
+    /* Give it a some definition */
+    border: 1px solid #ccc;
+    /* Set it off left and right, seems to look a bit nicer when we have a background */
+    margin-left:  0.5em;
+    margin-right: 0.5em;
+    }
+
+    figure img {
+        display: block;
+        margin-left: auto;
+        margin-right: auto;
+      }
+  </style>
+</head>
+<body>
+  <section id="cover">
+    <p class="client">{{title}}</p>
+    <h1 class="doctitle">{{subtitle}}</h1>
+    {% unless authors.empty %}<ul class="authors">
+      {% for author in authors %}<li>{{author}}</li>
+      {% endfor %}
+    </ul>{% endunless %}
+
+    {% if logo %}<div class="logo">
+      <img alt="" src="{{logo}}">
+    </div>{% endif %}
+
+  </section>
+  
+  <section id="frontmatter">
+    <section class="chapter no-toc">
+      <header>
+        <h2>Table of Features</h2>
+      </header>
+
+      <nav class="toc table-of-features">
+        <ol class="features-list">
+          {% for feature in contents %}
+          <li><a href="#{{feature.id}}">{{feature.name}}</a>
+            <ol class="scenarios-list">
+              {% for scenario in feature.elements %}
+              <li><a href="#{{scenario.id}}">{{scenario.name}}</a></li>
+              {% endfor %}
+            </ol>
+          </li>
+          {% endfor %}
+        </ol>
+      </nav>
+
+  </section>
+
+  <section id="mainmatter">
+    <section class="part" id="features">
+      <header>
+        <h1>Features</h1>
+      </header>
+
+      {% for feature in contents %}
+      <section class="feature" id="{{feature.id}}">
+        <header>
+          <h2>{{feature.name}}</h2>
+        </header>
+
+        <div class="description">
+          {{ feature.description | parse | relevel:2 | markdown }}
+        </div>
+
+        {% for scenario in feature.elements %}
+        <section class="scenario" id="{{scenario.id}}">
+          <header>
+            <h3>{{scenario.name}}</h3>
+          </header>
+
+          <div class="description">
+            {{ scenario.description | parse | relevel:3 | markdown }}
+          </div>
+
+          {% unless scenario.steps.empty %}
+          <section class="steps">
+            {% unless scenario.description=="" %}
+              <header>
+                <h4>Steps</h4>
+              </header>
+            {% endunless %}
+            <ol>
+              {% for step in scenario.steps %}
+                <li class="step {{step.keyword | strip | downcase}}">
+                  <p>
+                    <strong class="keyword">{{step.keyword | strip}}</strong> {{step.name}}
+                  </p>
+
+                  {% if step.doc_string %}
+{{ step.doc_string.value | highlight: step.doc_string.content_type }}
+                  {% endif %}
+
+                  {% if step.rows %}
+                  <table class="steptable">
+                    <thead>
+                      <tr>
+                        {% for cell in step.rows[0].cells %}
+                        <th>{{ cell }}</th>
+                        {% endfor %}
+                      </tr>
+                    </thead>
+                    <tbody>
+                      {% for row in step.rows %}
+                      {% unless forloop.first %}
+                      <tr>
+                        {% for cell in row.cells %}
+                        <td>{{ cell | escape_once }}</td>
+                        {% endfor %}
+                      </tr>
+                      {% endunless %}
+                      {% endfor %}
+                    </tbody>
+                  </table>
+                  {% endif %}
+
+                </li>
+              {% endfor %}
+            </ol>
+          </section> <!-- Steps -->
+          {% endunless %}
+
+        </section> <!-- Scenario -->
+        {% endfor %}
+
+      </section> <!-- Feature -->
+      {% endfor %}
+
+    </section> <!-- Part -->
+  
+  </section>
+</body>
+</html>