RubyGems - marko - Versions diffs - 0.3.0 → 0.4.0 - Mend

marko 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (119) hide show

checksums.yaml +4 -4
data/.dockerignore +12 -0
data/.rubocop.yml +45 -0
data/CHANGELOG.md +10 -4
data/Dockerfile +11 -0
data/LICENSE.txt +21 -0
data/README.md +17 -31
data/Rakefile +2 -11
data/exe/marko +4 -22
data/lib/basic.rb +27 -0
data/lib/marko/chain.rb +44 -0
data/lib/marko/cli.rb +119 -129
data/lib/marko/config.rb +30 -20
data/lib/marko/errors.rb +38 -0
data/lib/marko/model/markup.rb +33 -0
data/lib/marko/model/topic.rb +126 -0
data/lib/marko/model/tree_node.rb +34 -0
data/lib/marko/model.rb +10 -0
data/lib/marko/parser/metadata.rb +28 -0
data/lib/marko/parser/source.rb +52 -0
data/lib/marko/parser/topic.rb +33 -0
data/lib/marko/parser.rb +8 -19
data/lib/marko/renderers/artifact.rb +29 -0
data/lib/marko/renderers/content.rb +37 -0
data/lib/marko/renderers/link.rb +19 -0
data/lib/marko/renderers/metadata.rb +34 -0
data/lib/marko/renderers/nested_list.rb +21 -0
data/lib/marko/renderers/nested_tree.rb +22 -0
data/lib/marko/renderers/renderer.rb +17 -0
data/lib/marko/renderers/title.rb +16 -0
data/lib/marko/renderers/topic.rb +24 -0
data/lib/marko/renderers/url.rb +16 -0
data/lib/marko/renderers.rb +17 -0
data/lib/marko/scanner.rb +39 -0
data/lib/marko/tasks/assemble.rb +52 -0
data/lib/marko/tasks/compile.rb +19 -0
data/lib/marko/tasks/load.rb +13 -0
data/lib/marko/tasks/parse.rb +27 -0
data/lib/marko/tasks/scan.rb +18 -0
data/lib/marko/tasks/validate.rb +32 -0
data/lib/marko/tasks.rb +13 -0
data/lib/marko/validators/lost_index.rb +21 -0
data/lib/marko/validators/lost_links.rb +25 -0
data/lib/marko/validators/lost_parent.rb +21 -0
data/lib/marko/validators/non_unique_id.rb +23 -0
data/lib/marko/validators.rb +11 -0
data/lib/marko/version.rb +1 -3
data/lib/marko.rb +11 -43
metadata +47 -85
data/Gemfile +0 -10
data/Gemfile.lock +0 -23
data/STORY.md +0 -44
data/_layouts/footer.md +0 -4
data/_layouts/header.md +0 -3
data/_layouts/layout.html +0 -73
data/_layouts/robots.txt.erb +0 -4
data/_layouts/sitemap.xml.erb +0 -20
data/_layouts/styles.css +0 -92
data/docs/changelog.html +0 -74
data/docs/css/styles.css +0 -92
data/docs/index.html +0 -297
data/docs/readme.html +0 -297
data/docs/robots.txt +0 -4
data/docs/sitemap.xml +0 -30
data/docs/story.html +0 -132
data/lib/assets/demo/README.md +0 -13
data/lib/assets/demo/src/fr/assemble.md +0 -27
data/lib/assets/demo/src/fr/compile.md +0 -25
data/lib/assets/demo/src/fr/markup.md +0 -111
data/lib/assets/demo/src/fr/storage.md +0 -16
data/lib/assets/demo/src/fr/treenode.md +0 -34
data/lib/assets/demo/src/index.md +0 -34
data/lib/assets/demo/src/intro.md +0 -98
data/lib/assets/demo/src/ui/cli.md +0 -26
data/lib/assets/demo/src/ui/gem.md +0 -14
data/lib/assets/demo/src/ur/uc.create.project.md +0 -8
data/lib/assets/demo/src/ur/uc.general.flow.md +0 -14
data/lib/assets/init/README.md +0 -61
data/lib/assets/init/Rakefile +0 -100
data/lib/assets/init/tt/custom.md.tt +0 -19
data/lib/assets/init/tt/default.md.tt +0 -4
data/lib/assets/samples/0_index.md +0 -14
data/lib/assets/samples/1_intro.md +0 -55
data/lib/assets/samples/2_stakh.md +0 -21
data/lib/assets/samples/3_actors.md +0 -10
data/lib/assets/samples/4_cases.md +0 -53
data/lib/assets/samples/5_entities.md +0 -18
data/lib/assets/samples/6_concerns.md +0 -60
data/lib/assets/samples/SRS-IEEE-830-1998.md +0 -293
data/lib/assets/samples/SRS-RUP.md +0 -283
data/lib/assets/samples/business-case.md +0 -116
data/lib/assets/samples/ears.md +0 -112
data/lib/assets/samples/gen_punch_domain.rb +0 -183
data/lib/assets/samples/requirements.md +0 -105
data/lib/assets/samples/stakeholders.png +0 -0
data/lib/assets/samples/vision.md +0 -191
data/lib/marko/artifact.rb +0 -5
data/lib/marko/assembler.rb +0 -83
data/lib/marko/compiler.rb +0 -16
data/lib/marko/gadgets/pluggable.rb +0 -55
data/lib/marko/gadgets/sentry.rb +0 -66
data/lib/marko/gadgets/service.rb +0 -52
data/lib/marko/gadgets.rb +0 -3
data/lib/marko/loader.rb +0 -38
data/lib/marko/markup/compiler.rb +0 -30
data/lib/marko/markup/decorator.rb +0 -80
data/lib/marko/markup/macro.rb +0 -176
data/lib/marko/markup/parser.rb +0 -122
data/lib/marko/markup/storage.rb +0 -118
data/lib/marko/markup/validator.rb +0 -101
data/lib/marko/markup.rb +0 -24
data/lib/marko/services/assemble.rb +0 -16
data/lib/marko/services/compile.rb +0 -30
data/lib/marko/services.rb +0 -2
data/lib/marko/storage.rb +0 -36
data/lib/marko/tree_node.rb +0 -129
data/lib/marko/validator.rb +0 -19
data/marko.gemspec +0 -44
data/sancho.yml +0 -6

data/docs/readme.html DELETED Viewed

@@ -1,297 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
-<head>
-  <meta charset="utf-8" />
-  <meta name="generator" content="pandoc" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
-  <meta name="keywords" content="ruby, markup-compiler" />
-  <title>Marko Readme</title>
-  <style>
-    code{white-space: pre-wrap;}
-    span.smallcaps{font-variant: small-caps;}
-    div.columns{display: flex; gap: min(4vw, 1.5em);}
-    div.column{flex: auto; overflow-x: auto;}
-    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
-    ul.task-list{list-style: none;}
-    ul.task-list li input[type="checkbox"] {
-      width: 0.8em;
-      margin: 0 0.8em 0.2em -1.6em;
-      vertical-align: middle;
-    }
-    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
-    /* CSS for syntax highlighting */
-    pre > code.sourceCode { white-space: pre; position: relative; }
-    pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
-    pre > code.sourceCode > span:empty { height: 1.2em; }
-    .sourceCode { overflow: visible; }
-    code.sourceCode > span { color: inherit; text-decoration: inherit; }
-    div.sourceCode { margin: 1em 0; }
-    pre.sourceCode { margin: 0; }
-    @media screen {
-    div.sourceCode { overflow: auto; }
-    }
-    @media print {
-    pre > code.sourceCode { white-space: pre-wrap; }
-    pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
-    }
-    pre.numberSource code
-      { counter-reset: source-line 0; }
-    pre.numberSource code > span
-      { position: relative; left: -4em; counter-increment: source-line; }
-    pre.numberSource code > span > a:first-child::before
-      { content: counter(source-line);
-        position: relative; left: -1em; text-align: right; vertical-align: baseline;
-        border: none; display: inline-block;
-        -webkit-touch-callout: none; -webkit-user-select: none;
-        -khtml-user-select: none; -moz-user-select: none;
-        -ms-user-select: none; user-select: none;
-        padding: 0 4px; width: 4em;
-        color: #aaaaaa;
-      }
-    pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa;  padding-left: 4px; }
-    div.sourceCode
-      {   }
-    @media screen {
-    pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
-    }
-    code span.al { color: #ff0000; font-weight: bold; } /* Alert */
-    code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
-    code span.at { color: #7d9029; } /* Attribute */
-    code span.bn { color: #40a070; } /* BaseN */
-    code span.bu { color: #008000; } /* BuiltIn */
-    code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
-    code span.ch { color: #4070a0; } /* Char */
-    code span.cn { color: #880000; } /* Constant */
-    code span.co { color: #60a0b0; font-style: italic; } /* Comment */
-    code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
-    code span.do { color: #ba2121; font-style: italic; } /* Documentation */
-    code span.dt { color: #902000; } /* DataType */
-    code span.dv { color: #40a070; } /* DecVal */
-    code span.er { color: #ff0000; font-weight: bold; } /* Error */
-    code span.ex { } /* Extension */
-    code span.fl { color: #40a070; } /* Float */
-    code span.fu { color: #06287e; } /* Function */
-    code span.im { color: #008000; font-weight: bold; } /* Import */
-    code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
-    code span.kw { color: #007020; font-weight: bold; } /* Keyword */
-    code span.op { color: #666666; } /* Operator */
-    code span.ot { color: #007020; } /* Other */
-    code span.pp { color: #bc7a00; } /* Preprocessor */
-    code span.sc { color: #4070a0; } /* SpecialChar */
-    code span.ss { color: #bb6688; } /* SpecialString */
-    code span.st { color: #4070a0; } /* String */
-    code span.va { color: #19177c; } /* Variable */
-    code span.vs { color: #4070a0; } /* VerbatimString */
-    code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
-  </style>
-  <link rel="stylesheet" href="css/styles.css" />
-  <!--[if lt IE 9]>
-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-  <![endif]-->
-</head>
-<body>
-<p class="navbar">
-<span class="smallcaps">= <strong>“Marko” Markup Compiler</strong> = <a
-href="readme.html">Readme</a> ~ <a href="changelog.html">Changelog</a> ~
-<a href="story.html">Story</a> ~ <a
-href="https://github.com/nvoynov/sancho">Github</a></span>
-</p>
-<header id="title-block-header">
-<h1 class="title">Marko Readme</h1>
-</header>
-<nav id="TOC" role="doc-toc">
-<ul>
-<li><a href="#installation" id="toc-installation">Installation</a></li>
-<li><a href="#usage" id="toc-usage">Usage</a>
-<ul>
-<li><a href="#interface" id="toc-interface">Interface</a></li>
-<li><a href="#structure" id="toc-structure">Structure</a></li>
-<li><a href="#markup" id="toc-markup">Markup</a></li>
-<li><a href="#metadata" id="toc-metadata">Metadata</a></li>
-<li><a href="#tree-ids" id="toc-tree-ids">Tree, IDs</a></li>
-<li><a href="#macros" id="toc-macros">Macros</a></li>
-<li><a href="#templates" id="toc-templates">Templates</a></li>
-<li><a href="#automation" id="toc-automation">Automation</a></li>
-</ul></li>
-<li><a href="#development" id="toc-development">Development</a></li>
-<li><a href="#contributing" id="toc-contributing">Contributing</a></li>
-</ul>
-</nav>
-<p>Marko is a markup compiler that builds a tree from separated sources
-and compiles it into a single deliverable artifact.</p>
-<p>Marko supplies a “docs-as-code” approach for compiling bulky software
-artifacts by providing source storage, original plain text markup,
-compiler templates, Ruby- and a command-line interface for assembling
-and compiling.</p>
-<p>Having assembled the artifact, it can be analyzed, enriched by extra
-data, etc.; it can serve as a source for deriving subdued artifacts.</p>
-<p>I’ve applied the approach for dozens of artifacts for the last six
-years, mainly writing requirements in Markdown, analyzing quality,
-deriving estimation sheets, exporting deliverables with Pandoc, and
-automating some parts of my everyday work.</p>
-<h2 id="installation">Installation</h2>
-<p>Install the gem by executing:</p>
-<pre><code>$ gem install marko</code></pre>
-<h2 id="usage">Usage</h2>
-<h3 id="interface">Interface</h3>
-<p>Marko provides just basic command-line interface for creating new
-projects and assembling artifacts - run <code>$ marko</code> to see the
-details.</p>
-<p>In addition to the standard CLI, Marko supplies you with Rakefile,
-that also serves as custom automation example. You can run
-<code>rake -T</code> to see available commands.</p>
-<p>To help you with task automation, Marko provides
-<code>Marko.assemble</code> for assembling and
-<code>Marko.compile</code> for compiling artifacts (you could already
-spot it inside Rakefile.) See <a href="#automation">Automation</a>
-section for examples.</p>
-<h3 id="structure">Structure</h3>
-<p><code>marko new PROJECT</code> command will create a new marko
-project inside the <code>PROJECT</code> directory with following
-structure:</p>
-<ul>
-<li><a href="bin/">bin/</a> - output folder for <code>build</code></li>
-<li><a href="bin/assets/">bin/assets/</a> - assets folder</li>
-<li><a href="src/">src/</a> - markup sources</li>
-<li><a href="tt/">tt/</a> - templates for <code>build</code></li>
-<li><a href="marko.yml">marko.yml</a> - project configuration</li>
-<li><a href="Rakefile">Rakefile</a> - Rake automation file</li>
-<li><a href="README.md">README.md</a> - this file</li>
-</ul>
-<h3 id="markup">Markup</h3>
-<p>The basic and the only Marko entity is <a
-href="#github-link">TreeNode</a> with <code>id</code>,
-<code>meta</code>, <code>body</code>, and <code>items</code>
-properties.</p>
-<p>And the primary activity is just writing source files consisting of
-the TreeNode, where the source actually just a regular Markdown with an
-optional metadata excerpt. All lines from <code>#</code> until the next
-<code>#</code> are considered TreeNode.</p>
-<p>Let’s see it by example and assume one has a few separate sources
-<code>content.md</code>, <code>uc.signup.md</code>, and
-<code>uc.signin.md</code>. <code>content.md</code></p>
-<div class="sourceCode" id="cb2"><pre
-class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu"># Overview</span></span>
-<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu"># User Requirements</span></span>
-<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">## Use Cases</span></span>
-<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>{{id: uc, order_index: .signup .signin}}</span>
-<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="fu"># Functional requirements</span></span></code></pre></div>
-<p><code>uc.signup.md</code></p>
-<div class="sourceCode" id="cb3"><pre
-class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu"># Sign-Up</span></span>
-<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>{{id: .signup, parent: uc}}</span>
-<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a>body markup</span></code></pre></div>
-<p><code>uc.signin.md</code></p>
-<div class="sourceCode" id="cb4"><pre
-class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="fu"># Sign-In</span></span>
-<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a>{{id: .signin, parent: uc}}</span>
-<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a>body markup</span></code></pre></div>
-<p>These sources will be assembled in a single hierarchy as follows</p>
-<div class="sourceCode" id="cb5"><pre
-class="sourceCode markdown"><code class="sourceCode markdown"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu"># Overview</span></span>
-<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="fu"># User Requirements</span></span>
-<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="fu">## Use Cases</span></span>
-<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a>{{id: uc, order_index: .signup .signin}}</span>
-<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="fu">### Sign-Up</span></span>
-<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a>{{id: .signup, parent: uc}}</span>
-<span id="cb5-7"><a href="#cb5-7" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb5-8"><a href="#cb5-8" aria-hidden="true" tabindex="-1"></a>body markup</span>
-<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a><span class="fu">### Sign-In</span></span>
-<span id="cb5-10"><a href="#cb5-10" aria-hidden="true" tabindex="-1"></a>{{id: .signin, parent: uc}}</span>
-<span id="cb5-11"><a href="#cb5-11" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb5-12"><a href="#cb5-12" aria-hidden="true" tabindex="-1"></a>body markup</span>
-<span id="cb5-13"><a href="#cb5-13" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb5-14"><a href="#cb5-14" aria-hidden="true" tabindex="-1"></a><span class="fu"># Functional requirements</span></span></code></pre></div>
-<p>So all the assemblage magic is just linking TreeNode by using
-<code>id</code>, <code>parent</code>, and <code>order_index</code>
-attributes; where <code>id</code> and <code>parent</code> are just nodes
-identifiers, and <code>order_index</code> is just an array of
-identifiers that point out the order of getting <code>items</code>.</p>
-<h3 id="metadata">Metadata</h3>
-<p>It was shown above how to provide hierarchy attributes by metadata
-excerpt <code>{{}}</code>. But you can also use the excerpt to provide
-your own attributes, like <code>source: John Doe</code>,
-<code>affects: some.other.thing</code>, etc.</p>
-<h3 id="tree-ids">Tree, IDs</h3>
-<p>When you deal with trees in separated sources, to reference nodes you
-need identifiers. So when you write <code>id</code>, <code>parent</code>
-and <code>order_index</code> metadata - you actually deal with TreeNode
-Id, and it must be unique.</p>
-<p>When one works on a simple parent -&gt; child relationship,
-identifiers can be shortened by starting from <code>.</code>. In the
-example above <code>{{order_index: .signup .signin}}</code>, the parent
-will find its children by <code>/.signup$/</code> and
-<code>/.signin$/</code>; and besides, during the assembling phase those
-relative identifiers will be turned to full - <code>uc.signup</code> and
-<code>uc.signin</code>.</p>
-<p>Marko will generate a unique Id for each TreeNode when Id was not
-provided by the author.</p>
-<h3 id="macros">Macros</h3>
-<p>The TreeNode.body can include macros. The most helpful one is
-<code>[[reference.id]]</code> that will be substituted by well-formed
-markdown link <code>[&lt;node.title&gt;](#&lt;node.url&gt;)</code>.
-There are also <code>@@tree</code>, <code>@@list</code>,
-<code>@@todo</code>, and <code>@@skip</code> standard macros; and this
-list could be extended or shortened through building templates.</p>
-<ul>
-<li><code>@@tree</code> substituted by the tree of references to all
-descendants of the current node, might be used for the table of
-contents;</li>
-<li><code>@@list</code> substituted by the list of references to node
-items;</li>
-<li><code>@@todo</code> will will skip text with the macro till the end
-of the line</li>
-<li><code>@@skip</code> will skip the text after the macro</li>
-</ul>
-<h3 id="templates">Templates</h3>
-<p>Marko uses templates placed under the <code>tt</code> folder to
-compile sources into artifacts. You can use and customize the default
-one or design your own for particular purposes. It’s just pure ERB,
-where Marko enumerates TreeNodes and renders the node output.</p>
-<pre><code>&lt;%= @node.header %&gt;
-&lt;%= @node.meta   %&gt;
-&lt;%= @node.body   %&gt;</code></pre>
-<p>The <code>marko.yml</code> configuration file sets the building
-process’s default template and other default values.</p>
-<div class="sourceCode" id="cb7"><pre
-class="sourceCode yml"><code class="sourceCode yaml"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="pp">--- !ruby/struct:Marko::Artifact</span></span>
-<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="fu">id</span><span class="kw">:</span><span class="at"> ed863484-243f-4d46-8012-4b148f8c2910</span></span>
-<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="fu">title</span><span class="kw">:</span><span class="at"> Marko Artifact</span></span>
-<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="fu">template</span><span class="kw">:</span><span class="at"> tt/artifact.md.tt</span></span>
-<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="fu">filename</span><span class="kw">:</span><span class="at"> tt/marko-artifact.md</span></span></code></pre></div>
-<h3 id="automation">Automation</h3>
-<p>Following quick example will assemble tree, remove TreeNode with id
-== ‘hint’, and compile the tree. You can also see Rakefile for other
-examples.</p>
-<div class="sourceCode" id="cb8"><pre
-class="sourceCode ruby"><code class="sourceCode ruby"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">require</span> <span class="vs">&#39;marko&#39;</span></span>
-<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="cf">def</span> do_remove_hint</span>
-<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a>  tree <span class="kw">=</span> <span class="dt">Marko</span><span class="at">.assemble</span></span>
-<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a>  hint <span class="kw">=</span> tree<span class="at">.find_node</span>(<span class="vs">&#39;hint&#39;</span>)</span>
-<span id="cb8-6"><a href="#cb8-6" aria-hidden="true" tabindex="-1"></a>  hint<span class="at">.orphan!</span></span>
-<span id="cb8-7"><a href="#cb8-7" aria-hidden="true" tabindex="-1"></a>  <span class="dt">Marko</span><span class="at">.compile</span>(<span class="wa">tree: </span>tree)  </span>
-<span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a><span class="cf">end</span></span></code></pre></div>
-<h2 id="development">Development</h2>
-<p>After checking out the repo, run <code>bin/setup</code> to install
-dependencies. Then, run <code>rake test</code> to run the tests. You can
-also run <code>bin/console</code> for an interactive prompt that will
-allow you to experiment.</p>
-<p>To install this gem onto your local machine, run
-<code>bundle exec rake install</code>. To release a new version, update
-the version number in <code>version.rb</code>, and then run
-<code>bundle exec rake release</code>, which will create a git tag for
-the version, push git commits and the created tag, and push the
-<code>.gem</code> file to <a
-href="https://rubygems.org">rubygems.org</a>.</p>
-<h2 id="contributing">Contributing</h2>
-<p>Bug reports and pull requests are welcome on GitHub at
-https://github.com/[USERNAME]/marko.</p>
-<div id="footer">
-<hr />
-<p>© 2022-2023 <a href="http://nvoynov.github.io/">nvoynov</a></p>
-</div>
-</body>
-</html>

data/docs/robots.txt DELETED Viewed

@@ -1,4 +0,0 @@
-User-agent: *
-Allow: /
-Sitemap: https://nvoynov.github.io/marko/sitemap.xml

data/docs/sitemap.xml DELETED Viewed

@@ -1,30 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"
-    xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-  <url>
-    <loc>nvoynov.github.io/marko/</loc>
-    <lastmod>2023-02-11</lastmod>
-    <changefreq>weekly</changefreq>
-    <priority>1.0</priority>
-  </url>
-  <url>
-    <loc>nvoynov.github.io/marko/readme.html</loc>
-    <lastmod>2023-02-11</lastmod>
-    <changefreq>weekly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>nvoynov.github.io/marko/changelog.html</loc>
-    <lastmod>2023-02-11</lastmod>
-    <changefreq>weekly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>nvoynov.github.io/marko/story.html</loc>
-    <lastmod>2023-01-30</lastmod>
-    <changefreq>weekly</changefreq>
-    <priority>0.8</priority>
-  </url>
-</urlset>

data/docs/story.html DELETED Viewed

@@ -1,132 +0,0 @@
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
-<head>
-  <meta charset="utf-8" />
-  <meta name="generator" content="pandoc" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
-  <meta name="dcterms.date" content="2023-01-26" />
-  <title>Marko Story</title>
-  <style>
-    code{white-space: pre-wrap;}
-    span.smallcaps{font-variant: small-caps;}
-    div.columns{display: flex; gap: min(4vw, 1.5em);}
-    div.column{flex: auto; overflow-x: auto;}
-    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
-    ul.task-list{list-style: none;}
-    ul.task-list li input[type="checkbox"] {
-      width: 0.8em;
-      margin: 0 0.8em 0.2em -1.6em;
-      vertical-align: middle;
-    }
-    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
-  </style>
-  <link rel="stylesheet" href="css/styles.css" />
-  <!--[if lt IE 9]>
-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-  <![endif]-->
-</head>
-<body>
-<p class="navbar">
-<span class="smallcaps">= <strong>“Marko” Markup Compiler</strong> = <a
-href="readme.html">Readme</a> ~ <a href="changelog.html">Changelog</a> ~
-<a href="story.html">Story</a> ~ <a
-href="https://github.com/nvoynov/sancho">Github</a></span>
-</p>
-<header id="title-block-header">
-<h1 class="title">Marko Story</h1>
-<p class="date">2023-01-26</p>
-</header>
-<nav id="TOC" role="doc-toc">
-<ul>
-<li><a href="#childhood-2012" id="toc-childhood-2012">Childhood,
-2012</a></li>
-<li><a href="#adolescence-2014---2015"
-id="toc-adolescence-2014---2015">Adolescence, 2014 - 2015</a></li>
-<li><a href="#youth-since-2015" id="toc-youth-since-2015">Youth, since
-2015</a></li>
-<li><a href="#marko-2022" id="toc-marko-2022">Marko, 2022</a></li>
-</ul>
-</nav>
-<p><a href="https://github.com/nvoynov/marko">Marko</a> is the result of
-my ten-year journey with Ruby playing the Business Analyst role.</p>
-<h2 id="childhood-2012">Childhood, 2012</h2>
-<p>Somewhere in between 2011 and 2014 I was playing Software Engineer
-role in some BigKnownCo where my first and foremost working tool was
-Microsoft Word 2007. Requirements specifications and Architecture design
-documents Artifacts that I was mainly working on often consisted of one
-and more hundreds of pages and it was such a pain to deal with in MS
-Word which was the corporate standard.</p>
-<p>In simple words it just gone crazy on large documents, the program
-consumed all my RAM, document navigation was slow, the program simply
-stopped responding, which entailed restarting the process with a loss of
-changes; or even worse, the loss of style formatting that is invisible
-to the eye when you simply cannot see it that the formatting was lost
-somewhere on the 225th page.</p>
-<blockquote>
-<p>So problem was clear “<strong>The problem of</strong> the lack of
-simple reliable tools and approaches for writing software artifacts
-<strong>affects</strong> technical writers who develop and manage the
-artifacts <strong>the impact of which is</strong> they tend to
-choose..”</p>
-</blockquote>
-<p>And I come up with the idea to create something light, simple and
-reliable to eliminate the MS Word from my work experience once and for
-all. This time I was curious about using YAML for storing requirements
-just inside file system. And I regularly done some estimations and
-prioritization for requirements, so I decided that FPA, PERT, and
-Risk-Value prioritization will be valuable features here.</p>
-<p>It was my first serious diving into Ruby for few weeks. I succeeded
-in reading / writing YAML and even provided estimations algorithms. I
-fall in love with Ruby. But from user perspective (I was the user) it
-was complete failure. Writing YAML manually was just unforgivable but
-that time I was obsessed with the format.</p>
-<blockquote>
-<p>YAML was chosen just because this days I dramatically reduced time
-for load configuration of my target service provisioning system, that
-stored its configuration tree in RDBMS that causes ~5 000 000 selects
-for reading and about the same number insert/update for writing. It just
-reduced to 20 000 instead of 5 000 000.</p>
-</blockquote>
-<h2 id="adolescence-2014---2015">Adolescence, 2014 - 2015</h2>
-<p>It took two years to return to the subject, I left that job in 2014
-and got haft year off. This time I discovered Markdown and static site
-generators, and I decided on Markdown as my primary markup format, where
-each source is just a plain markdown file with some metadata
-excerpt.</p>
-<p>Things were going well and in a few months, I got something quite
-usable. Estimations algorithms were thrown out; markup sources were
-assembled in one artifact that was translated into HTML by Kramdown. I
-named it “Creq” for “console requirements” and since then I assembled
-all software artifacts in my own tool.</p>
-<h2 id="youth-since-2015">Youth, since 2015</h2>
-<p>Using my tool daily on a regular basis I discovered Pandoc and then
-can translate my artifact into any supported format; provided more
-advanced artifact templates, and provided a few templates for different
-purposes (draft, customer deliverable, etc.), added macros for tree node
-body.</p>
-<p>This time I named my tool Clerq because it just was my regular tool -
-I started my day from <code>$ git checkout -b new_feature</code> and
-finished with merging the branch, assembling new requirements increment,
-and pushing into git for my development team.</p>
-<p>In 2018 I have read The Clean Architecture I took my first clumsy
-attempts to apply it for Clerq.</p>
-<h2 id="marko-2022">Marko, 2022</h2>
-<p>The last time I used Clerq for two months in July 2022. I noticed
-that time that I use only “create a new project” and “build the
-artifact” commands. And I realized that there is nothing about
-requirements - just about artifact assembling.</p>
-<p>So I took two weeks and finished 2022 with a git commit on Dec 31,
-2022 :)</p>
-<p>The Marko purpose is assembling markup artifact from separated markup
-sources. Its interfaces are simple and clear. It could be naturally
-extended through Rakefile for any specific purpose related to visiting
-artifacts tree nodes.</p>
-<p>This is the first time I feel for a product that there are nothing I
-want to take or change. Just “Right Product, Done Right, Managed
-Messy”</p>
-<div id="footer">
-<hr />
-<p>© 2022-2023 <a href="http://nvoynov.github.io/">nvoynov</a></p>
-</div>
-</body>
-</html>

data/lib/assets/demo/README.md DELETED Viewed

@@ -1,13 +0,0 @@
-% Marko Demo Project
-# Overview
-This project is an example of developing a technical artifacts with Marko. The artifact is Marko Requirements Specification that also servers as Marko Sandbox for testing and features development.
-# Usage
-Run `$ marko` to see command-line interface
-Run `$ rake marko:publish` to publish the artifact
-Run `$ rake -T` to see other custom interface

data/lib/assets/demo/src/fr/assemble.md DELETED Viewed

@@ -1,27 +0,0 @@
-# Assemble artifact
-{{id: .assemble, parent: fr}}
-The system shall provide the function to assemble artifact.
-__Input__
-* NO
-__Output__
-Parameter Type     0..* Description
---------- -------- ---- --------------
-tree      TreeNode 1    assembled tree
-__Flow__
-@@todo provide id for required functions and change steps with appropriate links
-1. get list of project sources
-2. parse sources buffering nodes and errors
-3. fail "parsing errors" if errors.any?
-4. assemble artifact from buffer of nodes
-5. generate and inject auto ids
-6. validate artifact buffering errors
-7. fail "tree errors" if errors.any?
-8. return artifact

data/lib/assets/demo/src/fr/compile.md DELETED Viewed

@@ -1,25 +0,0 @@
-# Compile artifact
-{{id: .compile, parent: fr}}
-The system shall provide the function to create deliverable artifact.
-__Input__
-Parameter Type     0..* Description
---------- -------- ---- --------------
-tree      TreeNode 1    assembled tree
-template  String   1    ERB template
-filename  String   1    filename
-__Output__
-The output of the function must be well-formed deliverable with `filename` built on `template` parameter.
-__Flow__
-@@todo provide id for required functions and change steps with appropriate links
-1. `tree` = [[fr.assemble]] unless `tree`
-2. load template body from `template`
-3. backup `filename` to `<filename>~`
-4. render `template` for each node of `tree` into `filename`

data/lib/assets/demo/src/fr/markup.md DELETED Viewed

@@ -1,111 +0,0 @@
-# Source Markup
-{{id: .markup, parent: fr}}
-The main and only entity in the system is [[fr.treenode]]. The system shall provide the following abilities for the entity:
-@@list
-## Node Markup
-{{id: .node}}
-The system shall support the following node markup.
-```markdown
-# <title>
-{{\<meta\>}}
-\<body\>
-```
-Where:
-- Each node starts from Markdown header mark `#`.
-- The header mark can be followed by node title.
-- The next line _might_ contain metadata block:
-   - that starts from `{{` and finishes with `}}`;
-   - that can be one or multiline string.
-- The next lines tile the end of file or next header mark `#` are considered as node body.
-## Get Sources
-The system shall provide function to getting all sources files from project repository.
-@@todo define project repository
-## Parse Source
-The system shall provide the function to parse source file.
-During the parsing process the system must record source information within the node parsed, such as origin file name and the number of line inside the origin where the node begins. This information must be stored inside metadata as [[fr.treenode.orig]].
-__Input__
-Parameter Type   0..* Description
---------- ------ ---- -----------
-filename  String 1    filename
-__Output__
-Parameter Type   0..* Description
---------- ------ ---- -----------
-node      Node   0..n node parsed
-## Assemble Tree
-The system shall provide the function to assemble the artifact tree. The artifact tree is assembled based on [[fr.treenode.tree]].
-@@todo The assemblage algorithm, errors handler
-__Input__
-Parameter Type   0..* Description
---------- ------ ---- -----------
-node      Node   0..n node array
-__Output__
-Parameter Type   0..* Description
---------- ------ ---- -----------
-node      Node   1    root tree
-## Inject Id
-The system shall provide each node with unique node Id.
-Some nodes can already have ids from source file, especially those that referenced as parent or child and placed in separate files. For those nodes that still have empty id, the system must generate auto id 0..99.
-For example, when the system has assembled the tree
-```markdown
-# Artifact
-## Introduction
-### Purpose
-### Scope
-# User Requirements #ur
-# Functional Requirements #fr
-```
-and then generated id, the generated ids should be as follows:
-```markdown
-# Artifact Title #00
-## Introduction #01.01
-### Purpose #01.01.01
-### Scope #01.01.02
-# User Requirements #ur
-# Functional Requirements #fr
-```
-__Input__
-Parameter Type   0..* Description
---------- ------ ---- -----------
-root      Node   1    root node
-## Checking Tree
-The system shall provide the function to check assembled tree for errors related to assembling tree based on [[fr.treenode.tree]]. The system must check the following errors:
-- `duplicate id`, finds two or more nodes that share the same id;
-- `unknown parent`, finds nodes that have `parent` metadata, but parent not found in the tree;
-- `unknown index`, finds nodes with `order_index` metadata where one or more children in the index not found;
-- `unknown links`, finds nodes containing links but the links are not found.