paperwork 0.3.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13203b1fabe9808e33e1cdaea4ba2c92d738daa94ffa1d22117af9057e76d6b
-  data.tar.gz: d4349a96f701e92591eabdc19abf1316b72ba88b876cd518ce9b58ea705aeecf
+  metadata.gz: 0ce95a4eba79bce8b9489a4f421da5fd2d90eb5814222c4d99dceb39966b25b5
+  data.tar.gz: 1c0448b67db7619d2d798b370f9a8020e97885a30ad88588dc809341a9c306df
 SHA512:
-  metadata.gz: '009b8503df60c1e652123084e5c51ec935e1daf996d7e7002b24f63a163a1fab9b5059d3e76b2c1f30d7489db70192dc157346a08f33d904d2fafd66ec4fe161'
-  data.tar.gz: 9cee87ec48e8587f19332f5fd5c5bb4b675199ffe5ec529582123a13c1b9dd46e0a3a7f4794f1347d36e3cfdb23986b17cdeb78951b4bb9970c984f747100392
+  metadata.gz: e0e9dd39efe87a4174ffa674c13a5554a4b9788fecb9c27e276cad5bcfdef26c13b81eee9d6678895c20cf2637ed38fe53d6d58c595730f07e320fb2c94efab3
+  data.tar.gz: 6917edf9fa357eda4aa207763057938bf872e64644ce5781c6a98fe667f6655a88cbb4520e8726d66c0cd820b0d5840a972ea6339ef5e9a83311203bd7d5f2f1

data/.gitignore

@@ -13,3 +13,4 @@
 # rspec failure tracking
 .rspec_status
 .build
+/lib/paperwork/tasks/middleman_template/node_modules

data/.gitlab-ci.yml

@@ -1,20 +1,26 @@
-image: "ruby:2.6"
-
-# include:
-#   - template: License-Scanning.gitlab-ci.yml
+image: ruby:2.6.8
 
 stages:
   - build
   - test
+  - release
   - deploy
 
 before_script:
-  - ruby -v
-  - which ruby
   - apt update
   - apt install nodejs npm yarn -y
-  - gem install bundler --no-document
-  - bundle install --jobs $(nproc) ${FLAGS}
+  # default rubygems CLI in ruby2.6-container-images is 3.0.3, which won't
+  # support API KEY being provided by environment variable GEM_HOST_API_KEY.
+  # --> update it to >3.0.5
+  - gem update --system
+  - gem install bundler -v 2.2.27 --no-document
+  - bundle config set --local path .bundle
+  - bundle install --jobs $(nproc)
+
+cache:
+  key: ${CI_COMMIT_REF_NAME}
+  paths:
+    - .bundle
 
 build:
   stage: build
@@ -27,8 +33,6 @@ build:
 
 rspec:
   stage: test
-  dependencies:
-    - build
   script:
     - bundle exec "rspec --format RspecJunitFormatter --out rspec.xml"
   artifacts:
@@ -38,28 +42,48 @@ rspec:
     reports:
       junit: rspec.xml
 
-rubocop:
-  stage: test
+# requires environment variable GEM_HOST_API_KEY to be set. content
+# has to be a valid rubygems API key for authentication when publishing the
+# gem to rubygems.org.
+#
+# also requires GIT_REPOSITORY_AUTH in which "access_token_name:access_token"
+# for this git repository is configured.
+release:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
+      when: manual
+  variables:
+    GIT_REMOTE_URL: ${CI_SERVER_PROTOCOL}://${GIT_REPOSITORY_AUTH}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/${CI_PROJECT_PATH}.git
   script:
-    - bundle exec "rubocop --format junit --out rubocop.xml"
-  artifacts:
-    paths:
-      - rubocop.xml
-    reports:
-      junit: rubocop.xml
+    - VERSION=$(bundle exec rake version)
+    - bundle exec rake build
+    # remember who is responsible for this release
+    - git config --global user.name "${GITLAB_USER_LOGIN}"
+    - git config --global user.email "${GITLAB_USER_EMAIL}"
+    - git remote add release ${GIT_REMOTE_URL}
+    - git tag ${VERSION}
+    - git push release --tags
+    - gem push pkg/paperwork-${VERSION}.gem
+
+# rubocop:
+#   stage: test
+#   script:
+#     - bundle exec "rubocop --format junit --out rubocop.xml"
+#   artifacts:
+#     paths:
+#       - rubocop.xml
+#     reports:
+#       junit: rubocop.xml
 
 pages:
   stage: deploy
-  dependencies:
-    - build
-    - rspec
-    - rubocop
+  rules:
+    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
+  artifacts:
+    paths:
+      - public
   script:
     - mkdir public
     - mv .work/doc/build/* public/
     - mv .work/coverage public/
-  artifacts:
-    paths:
-      - public
-  only:
-    - master

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paperwork (0.3.5)
+    paperwork (0.5.0)
       listen (~> 3.4.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
@@ -10,38 +10,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    ffi (1.14.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    ffi (1.15.5)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     redcarpet (3.5.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.87.1)
@@ -53,15 +53,15 @@ GEM
       rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    simplecov-html (0.12.3)
     thor (1.1.0)
-    unicode-display_width (1.7.0)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   ruby
@@ -75,4 +75,4 @@ DEPENDENCIES
   simplecov (~> 0.18.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.27

data/README.md

@@ -2,7 +2,9 @@
 title: paperwork
 ---
 
-# paperwork [![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/pipeline.svg)](https://gitlab.com/couchbelag/paperwork/-/commits/master)[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/coverage.svg)](https://couchbelag.gitlab.io/paperwork/coverage)
+# paperwork
+
+[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/pipeline.svg)](https://gitlab.com/couchbelag/paperwork/-/commits/master)[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/coverage.svg)](https://couchbelag.gitlab.io/paperwork/coverage)
 
 
 ### The *paperwork gem* is an aproach to create appealing documentation from markdown documents.

data/Rakefile

@@ -14,3 +14,8 @@ task default: :spec
 CLEAN.include(".work/coverage")
 
 paperwork :doc, sources: ["README.md", "nested_example/navdemo.md", "paperwork.yml", "custom.js", "custom.css"]
+
+desc "returns version information"
+task :version do
+  puts Paperwork::VERSION
+end

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

@@ -48,7 +48,7 @@ module DocRenderer
         # end
 
         def paragraph(text)
-            definition_list(text.strip)
+            "<p>#{definition_list(text.strip)}</p>"
         end
 
         def table(header, body)

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

@@ -60,4 +60,10 @@ module InfoHelpers
     def footer_text
         data.paperwork.footer if paperwork?
     end
+
+    def toc?
+        !data.paperwork.config.nil? &&
+            !data.paperwork.config.toc.nil? &&
+            data.paperwork.config.toc
+    end
 end

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

@@ -4,5 +4,14 @@ import $ from "jquery";
 import 'popper.js';
 import 'bootstrap';
 import mermaid from "mermaid";
+import {getTableOfContents} from './toc';
 
 mermaid.initialize({startOnLoad:true});
+
+$(()=>{
+  var sidebar = $(".toc.sidebar > ul")
+  var topbar = $(".toc.topbar > ul")
+  var toc = getTableOfContents();
+  toc.insertTo(sidebar);
+  toc.insertTo(topbar);
+});

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

@@ -0,0 +1,64 @@
+import $ from "jquery";
+
+var idCounter = 0;
+
+class Section {
+  constructor(element=null) {
+    this.children = [];
+    this.element = element;
+
+    if (this.element) {
+      this.anchor = "paperwork-h-" + ++idCounter;
+    } else {
+      this.element = $("body");
+    }
+
+    this.element.find(":header").each((index, elem)=>{
+      this.add(new Section($(elem)));
+    });
+  }
+
+  add(childSection) {
+    this.children.push(childSection);
+  }
+
+  id() {
+    return this.anchor;
+  }
+
+  level() {
+    return this.element.prop("tagName").toLowerCase();
+  }
+
+  mark() {
+    if (this.level() != "body") {
+      // create anchor
+      this.element.before("<div id='" + this.id() + "'></div>");
+    }
+    this.children.forEach((child)=>{
+      child.mark();
+    });
+  }
+
+  insertTo(target) {
+    if (this.level() != "body") {
+      // link to anchor
+      target.append("<li class='toc-" + this.level() + "'><a href='#" + this.id() + "'>" + this.text() + "</a></li>");
+    }
+    this.children.forEach((child)=>{
+      child.insertTo(target);
+    });
+  }
+
+  text() {
+    return this.element.text();
+  }
+}
+
+function getTableOfContents() {
+  var toc = new Section();
+  toc.mark();
+  return toc;
+}
+
+export { getTableOfContents };

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

@@ -0,0 +1,6 @@
+<%= partial "layouts/header" %>
+<div class="row">
+    <div class="col">
+        <%= body %>
+    </div>
+</div>

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

@@ -0,0 +1,25 @@
+<div class="d-flex">
+    <div class="d-xl-block d-lg-block d-md-block d-none">
+        <%= partial "layouts/toc", locals: {classes: [:sidebar]} %>
+    </div>
+
+    <div>
+        <%= partial "layouts/header" %>
+
+        <div class="row d-xl-none d-lg-none d-md-none ">
+            <div class="col">
+                <%= partial "layouts/toc", locals: {classes: [:topbar]} %>
+            </div>
+        </div>
+
+        <div class="row">
+            <div class="col">
+                <%= body %>
+            </div>
+        </div>
+    </div>
+
+    <div class="v-spacer-2 d-xl-block d-lg-block d-md-block d-sm-none d-xs-none"></div>
+    <div class="v-spacer-2 d-xl-block d-lg-block d-md-none d-sm-none d-xs-none"></div>
+    <div class="v-spacer-3 d-xl-block d-lg-none d-md-none d-sm-none d-xs-none"></div>
+</div>

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

@@ -29,14 +29,21 @@
     <body>
         <%= partial "layouts/navbar" %>
 
+        <% if toc? %>
+        <div class="container-fluid">
+            <div class="row">
+                <div class="col">
+                    <%= partial "layouts/content_with_toc", locals: {body: body} %>
+                </div>
+            </div>
+        <% else %>
         <div class="container">
-            <%= partial "layouts/header" %>
-
             <div class="row">
                 <div class="col">
-                    <%= body %>
+                    <%= partial "layouts/content", locals: {body: body} %>
                 </div>
             </div>
+        <% end %>
 
             <div class="row mt-5 pb-4">
                 <div class="col text-right small border-top">

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

@@ -1,14 +1,14 @@
 <div class="row">
     <div class="col-sm-7 mb-5">
-        <span class="display-2"><%= yield_content :title %></span>
+        <span class="page-title"><%= yield_content :title %></span>
         <br>
-        <span class="display-4"><%= yield_content :subtitle %></span>
+        <span class="page-sub-title"><%= yield_content :subtitle %></span>
     </div>
 
     <div class="col-sm-5">
 
         <div class="row">
-            <div class="col text-right sub-title mb-2">
+            <div class="col text-right page-category mb-2">
                 <%= yield_content :category %>
             </div>
         </div>

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

@@ -1,13 +1,15 @@
 <nav class="sticky-top navbar navbar-expand-lg navbar-dark bg-dark">
     <a class="navbar-brand" href="<%= root_path %>"><%= navbar_brand || yield_content(:title) %></a>
-    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
-        <span class="navbar-toggler-icon"></span>
-    </button>
-    <div id="navbarSupportedContent" class="collapse navbar-collapse">
-        <ul class="mr-auto navbar-nav">
-            <% navbar_links.each do |name, link| %>
-                <li class=" nav-item"><a class="nav-link" data-method="get" href="<%= link.gsub(/\.md$/, ".html") %>"><%= name %></a></li>
-            <% end %>
-        </ul>
-    </div>
+    <% if navbar_links.size > 0 %>
+        <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+        </button>
+        <div id="navbarSupportedContent" class="collapse navbar-collapse">
+            <ul class="mr-auto navbar-nav">
+                <% navbar_links.each do |name, link| %>
+                    <li class=" nav-item"><a class="nav-link" data-method="get" href="<%= link.gsub(/\.md$/, ".html") %>"><%= name %></a></li>
+                <% end %>
+            </ul>
+        </div>
+    <% end %>
 </nav>

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

@@ -0,0 +1,9 @@
+<%
+    classes ||= []
+    classes << "toc"
+%>
+
+<div class="<%= classes.join(" ") %>">
+    <div class="title">Table of Contents</div>
+    <ul class="list-unstyled"></ul>
+</div>