paperwork 0.2.0

data/lib/paperwork/tasks/middleman_template/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "middleman", "~> 4.2"
+gem "middleman-autoprefixer", "~> 2.7"
+gem "middleman-livereload"
+gem "middleman-syntax"
+gem "redcarpet"
+gem "tzinfo-data", platforms: [:mswin, :mingw, :jruby, :x64_mingw]
+gem "wdm", "~> 0.1", platforms: [:mswin, :mingw, :x64_mingw]

data/lib/paperwork/tasks/middleman_template/Gemfile.lock

@@ -0,0 +1,131 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autoprefixer-rails (9.8.6.5)
+      execjs
+    backports (3.20.2)
+    byebug (11.1.3)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.1.8)
+    contracts (0.13.0)
+    dotenv (2.7.6)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    erubis (2.7.0)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    fast_blank (1.0.0)
+    fastimage (2.2.2)
+    ffi (1.14.2)
+    haml (5.2.1)
+      temple (>= 0.8.0)
+      tilt
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashie (3.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    kramdown (2.3.0)
+      rexml
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    memoist (0.16.2)
+    middleman (4.3.11)
+      coffee-script (~> 2.2)
+      haml (>= 4.0.5)
+      kramdown (>= 2.3.0)
+      middleman-cli (= 4.3.11)
+      middleman-core (= 4.3.11)
+    middleman-autoprefixer (2.10.1)
+      autoprefixer-rails (~> 9.1)
+      middleman-core (>= 3.3.3)
+    middleman-cli (4.3.11)
+      thor (>= 0.17.0, < 2.0)
+    middleman-core (4.3.11)
+      activesupport (>= 4.2, < 6.0)
+      addressable (~> 2.3)
+      backports (~> 3.6)
+      bundler
+      contracts (~> 0.13.0)
+      dotenv
+      erubis
+      execjs (~> 2.0)
+      fast_blank
+      fastimage (~> 2.0)
+      hamster (~> 3.0)
+      hashie (~> 3.4)
+      i18n (~> 0.9.0)
+      listen (~> 3.0.0)
+      memoist (~> 0.14)
+      padrino-helpers (~> 0.13.0)
+      parallel
+      rack (>= 1.4.5, < 3)
+      sassc (~> 2.0)
+      servolux
+      tilt (~> 2.0.9)
+      uglifier (~> 3.0)
+    middleman-livereload (3.4.6)
+      em-websocket (~> 0.5.1)
+      middleman-core (>= 3.3)
+      rack-livereload (~> 0.3.15)
+    middleman-syntax (3.2.0)
+      middleman-core (>= 3.2)
+      rouge (~> 3.2)
+    minitest (5.14.3)
+    padrino-helpers (0.13.3.4)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.13.3.4)
+      tilt (>= 1.4.1, < 3)
+    padrino-support (0.13.3.4)
+      activesupport (>= 3.1)
+    parallel (1.20.1)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-livereload (0.3.17)
+      rack
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    redcarpet (3.5.1)
+    rexml (3.2.4)
+    rouge (3.26.0)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    servolux (0.13.0)
+    temple (0.8.2)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  middleman (~> 4.2)
+  middleman-autoprefixer (~> 2.7)
+  middleman-livereload
+  middleman-syntax
+  redcarpet
+  tzinfo-data
+  wdm (~> 0.1)
+
+BUNDLED WITH
+   2.1.4

data/lib/paperwork/tasks/middleman_template/config.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "lib/root_helpers"
+helpers RootHelpers
+
+require "lib/info_helpers"
+helpers InfoHelpers
+
+# Activate and configure extensions
+# https://middlemanapp.com/advanced/configuration/#configuring-extensions
+
+activate :autoprefixer do |prefix|
+    prefix.browsers = "last 2 versions"
+end
+
+# Layouts
+# https://middlemanapp.com/basics/layouts/
+
+# Per-page layout changes
+page "/*.xml", layout: false
+page "/*.json", layout: false
+page "/*.txt", layout: false
+
+# With alternative layout
+# page '/path/to/file.html', layout: 'other_layout'
+
+# Proxy pages
+# https://middlemanapp.com/advanced/dynamic-pages/
+
+# proxy(
+#   '/this-page-has-no-template.html',
+#   '/template-file.html',
+#   locals: {
+#     which_fake_page: 'Rendering a fake page with a local variable'
+#   },
+# )
+
+# Helpers
+# Methods defined in the helpers block are available in templates
+# https://middlemanapp.com/basics/helper-methods/
+
+# Build-specific configuration
+# https://middlemanapp.com/advanced/configuration/#environment-specific-settings
+
+# configure :build do
+#   activate :minify_css
+#   activate :minify_javascript
+# end
+set :relative_links, true
+activate :relative_assets
+activate :livereload
+activate :syntax, line_numbers: true
+# activate :directory_indexes
+
+
+require "lib/doc_renderer"
+helpers DocRenderer
+
+set :markdown_engine,
+    :redcarpet
+
+set :markdown,
+    fenced_code_blocks: true,
+    smartypants: true,
+    tables: true,
+    highlight: true,
+    superscript: true,
+    autolink: true,
+    underline: true,
+    renderer: DocRenderer::Base
+
+webpack_cmd = if build?
+                  "./node_modules/webpack/bin/webpack.js --bail"
+              else
+                  "./node_modules/webpack/bin/webpack.js --watch -d eval --color"
+              end
+
+activate  :external_pipeline,
+          name: :webpack,
+          command: webpack_cmd,
+          source: ".tmp/dist",
+          latency: 1

data/lib/paperwork/tasks/middleman_template/lib/doc_renderer.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+
+##
+# this renderer is used to apply extensions to redcarpet
+#
+module DocRenderer
+    require "middleman-core/renderers/redcarpet"
+
+    # This is a basic renderer for transforming markdown to HTML
+    # inherit from this renderer to create more specific variants
+    class Base < Middleman::Renderers::MiddlemanRedcarpetHTML
+
+        # block level calls
+        def block_code(code, language)
+            if language == "mermaid"
+                %(<div class="mermaid">#{code}</div>)
+            else
+                super
+            end
+        end
+
+        def block_quote(quote)
+            %(<div class="alert alert-info">#{quote}</div>)
+        end
+
+        # def block_html(raw_html)
+        # end
+
+        # def footnotes(content)
+        # end
+
+        # def footnote_def(content, number)
+        # end
+
+        # def header(text, header_level)
+        # end
+
+        # def hrule()
+        # end
+
+        # def list(contents, list_type)
+        # end
+
+        # def list_item(text, list_type)
+        # end
+
+        def paragraph(text)
+            definition_list(text.strip)
+        end
+
+        def table(header, body)
+            <<~EOS_TABLE
+                <table class='table table-striped table-hover table-sm'>
+                    <thead>#{header}</thead>
+                    <tbody>#{body}</tbody>
+                </table>
+            EOS_TABLE
+        end
+
+        # def table_row(content)
+        # end
+
+        # def table_cell(content, alignment)
+        # end
+
+
+        # span level calls
+        # def autolink(link, link_type)
+        # end
+
+        # def codespan(code)
+        #     %(<code>#{ERB::Util.html_escape(code)}</code>)
+        # end
+
+        # def double_emphasis(text)
+        # end
+
+        # def emphasis(text)
+        # end
+
+        # def image(link, title, alt_text, default_class: "img-fluid")
+        #     <<~IMG
+        #         <img src="#{link}" alt="#{alt_text}" class="#{default_class}">
+        #     IMG
+        # end
+
+        # def linebreak()
+        # end
+
+        def link(link, title, content)
+            super(link.gsub(/\.md$/, ".html"), title, content)
+        end
+
+        # def raw_html(raw_html)
+        # end
+
+        # def triple_emphasis(text)
+        # end
+
+        # def strikethrough(text)
+        # end
+
+        # def superscript(text)
+        # end
+
+        # def underline(text)
+        # end
+
+        # def highlight(text)
+        # end
+
+        # def quote(text)
+        # end
+
+        # def footnote_ref(number)
+        # end
+
+        private
+
+        def definition_list(text)
+            str = ""
+            re = /^[^:].*?(?:\R: .*)+/
+            text.scan(re) do |match|
+                list = match.split(":")
+                str << "<dt>#{list[0]}</dt>"
+                str << "<dd>#{list[1..-1].join("</dd><dd>")}</dd>"
+            end
+
+            if str.empty?
+                text
+            else
+                "<dt>#{str}</dl>"
+            end
+        end
+    end
+end

data/lib/paperwork/tasks/middleman_template/lib/info_helpers.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+##
+# helpers for info fields in documents
+#
+module InfoHelpers
+    def text_for(**options)
+        options.keys.map do |key|
+            content_for key do
+                options[key].to_s
+            end
+        end
+    end
+
+    def page_info(**options)
+        content_for :page_infos do
+            options.keys.map do |name|
+                partial("layouts/info", locals: { name: name, value: options[name] })
+            end.join
+        end
+    end
+
+    def site?
+        data.respond_to?(:site)
+    end
+
+    def navbar?
+        site? && data.site.respond_to?(:navbar)
+    end
+
+    def navbar_links
+        nav = data.site.navbar.links if navbar?
+        nav || {}
+    end
+
+    def navbar_brand
+        data.site.navbar.brand if navbar?
+    end
+
+    def footer_text
+        data.site.footer if site?
+    end
+end

data/lib/paperwork/tasks/middleman_template/package.json

@@ -0,0 +1,12 @@
+{
+  "dependencies": {
+    "bootstrap": "^4.6.0",
+    "jquery": "^3.5.1",
+    "mermaid": "^8.9.0",
+    "popper.js": "^1.16.1",
+    "webpack": "^5.19.0"
+  },
+  "devDependencies": {
+    "webpack-cli": "^4.4.0"
+  }
+}

data/lib/paperwork/tasks/middleman_template/source/javascripts/site.js

@@ -0,0 +1,8 @@
+// This is where it all goes :)
+
+import $ from "jquery";
+import 'popper.js';
+import 'bootstrap';
+import mermaid from "mermaid";
+
+mermaid.initialize({startOnLoad:true});

data/lib/paperwork/tasks/middleman_template/source/layouts/_document.erb

@@ -0,0 +1,49 @@
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="x-ua-compatible" content="ie=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+        <!-- Use the title from a page's frontmatter if it has one -->
+        <title>
+            <%
+                subtitle = " / #{yield_content :subtitle}"
+            %>
+            <%= yield_content :title %><%= subtitle unless subtitle == " / " %>
+        </title>
+
+        <%= stylesheet_link_tag "rogue" %>
+        <%= stylesheet_link_tag "site" %>
+        <% custom_css.each do |css| %>
+            <%= stylesheet_link_tag css %>
+        <% end %>
+
+        <%= javascript_include_tag "main" %>
+        <% custom_js.each do |js| %>
+            <%= javascript_include_tag js %>
+        <% end %>
+
+        <%= yield_content :head %>
+    </head>
+
+    <body>
+        <%= partial "layouts/navbar" %>
+
+        <div class="container">
+            <%= partial "layouts/header" %>
+
+            <div class="row">
+                <div class="col">
+                    <%= body %>
+                </div>
+            </div>
+
+            <div class="row mt-5 pb-4">
+                <div class="col text-right small border-top">
+                    <%= footer_text %>
+                    <%= yield_content(:footer) %>
+                </div>
+            </div>
+        </div>
+    </body>
+</html>