paperwork 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2e693dd5bb169466f35243976c240df90b650c5a026b958fb2ad359362b97da
-  data.tar.gz: 47d925596e691ea695051d32196b20d2f1f4af1bd4cbf52c828090c7904da41e
+  metadata.gz: 8f8c3450109475a508ced5b1797489164894944e7e86794b6961edf23ce44e6a
+  data.tar.gz: f090d5a1eb0f3aa63aee49c784968e0e365f340f060b48bf01d1eb9240096d6a
 SHA512:
-  metadata.gz: 7743a376ef7a4cbacc04d71770622c4363a503a2396ec6135522b8fe266ecd774913c10af0c46bb561c68c454138daf90e71a8f1fcd2b15c1f554f08abc8f642
-  data.tar.gz: 8d428a9773633ade5b13b79ed1f7d5e98cdd1f480b85a3370d22e36c48c5735155ac240c459c1f25816cf960c26708eaaf1220600021af838bdd7e8e9225df50
+  metadata.gz: a62ec73b5be3e1fbf41af291436b9c99ddd28559ebc3e5fb444beff51836e6b0138e2a89915b2d5301b2d1e551450fe2c4d0f06b83cebe7990b95e251eddd7cd
+  data.tar.gz: b9f1b73b11969e1016239e4e8e2e687a4c42cb4f86214123bbdcd9f02080da4542271bbf7904a4fbf7305f9b679e889d746071c579e9e681c74c972ae772fe3d

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,8 @@
 PATH
   remote: .
   specs:
-    paperwork (0.3.4)
+    paperwork (0.4.1)
+      listen (~> 3.4.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
       thor (~> 1.1.0)
@@ -9,31 +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)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    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.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.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)
@@ -45,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
@@ -67,4 +75,4 @@ DEPENDENCIES
   simplecov (~> 0.18.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.27

data/README.md

@@ -2,13 +2,16 @@
 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.
 
 Markdown is used throughout many software development projects because of its simple syntax. Though being simple markdown provides sufficient elements necessary to visualize most aspects of software. And it's integrated into many tools, like github, gitlab, Visual Studio Code,... most likely these are already part of nowadays development processes anyway.
 
+
 Most developers want to focus on code and progress and not on documentation. *paperwork* tries to keep most of the publishing topics of documentation away from them. One important goal with this is to keep the markdown document independent from the target media. So it is possible to write documentation as HTML pages that can be scrolled, printed,... as you would do with usual web sites. On the other hand, markdown could also be transformed to presentations. If you're reading this in a presentation, you're already looking at one example of such a transformation. If you don't, have a look at the [generated presentation](https://couchbelag.gitlab.io/paperwork). The source file for the presentation is the [regular `README.md` file of the project](https://gitlab.com/couchbelag/paperwork/-/blob/master/README.md).
 
 
@@ -21,7 +24,6 @@ Well... you wouldn't, I agree. Nevertheless I've been into situations where I cr
 *paperwork* is not simply a renderer like *redcarpet* (which is actually used as renderer within *paperwork*). It provides *"markdown API"* to interface with different media formats. Of course, *paperwork* is not limited to presentations and/or books. Any media could be addressed. The idea simply is *reduce, reuse, recycle*, write documentation once and spread it across multiple channels.
 
 
-
 ## Installation & Usage
 
 ### In a ruby application

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/document.rb

@@ -5,21 +5,24 @@ module Paperwork
     # task generators for building with middleman
     module Tasks
         require "rake"
+        require "listen"
 
         ##
         # main task generator for building the document
         #
         class Document < Paperwork::Tasks::Base # rubocop:disable Metrics/ClassLength
-            attr_reader :dir
+            attr_reader :dir, :sources_map
 
             include Rake::DSL
 
             def initialize(name, sources, *dependencies)
                 @dir = Paperwork::Tasks::Template.new(name).dir
 
+                @sources_map = {}
                 sources.each do |src|
                     dst = get_destination(File.join(self.dir, "source"), src)
                     BuildFile.new(dst, src)
+                    sources_map[src] = dst
                     dependencies << dst
                 end
 
@@ -116,22 +119,33 @@ module Paperwork
                                 else
                                     Process.spawn(cmd, out: :out, in: :in, err: :err)
                                 end
-                                puts
-                                puts "+---------------------------------------------------------------+"
-                                puts "|                                                               |"
-                                puts "|  IMPORTANT:  Edit documents in #{self.dir} for live reload!   |"
-                                puts "|  ----------  The documents there are hard links to your       |"
-                                puts "|              source files, so the changes will be there       |"
-                                puts "|              as well.                                         |"
-                                puts "|                                                               |"
-                                puts "+---------------------------------------------------------------+"
-                                puts
-                                Process.waitall
                             end
+
+                            listen_to_sources
+
+                            Process.waitall
                         end
                     end
                 end
             end
+
+            def listen_to_sources
+                sources = {}
+                self.sources_map.each do |src, dst|
+                    sources[File.absolute_path(src)] = dst
+                end
+
+                ignore_list = [/#{Paperwork::Config[:build_root]}/]
+                Listen.to(Dir.pwd, ignore: ignore_list) do |modified, added, removed|
+                    (modified + added + removed).each do |src|
+                        dst = sources[src]
+                        unless dst.nil?
+                            puts "## updating #{src}"
+                            FileUtils.cp src, dst
+                        end
+                    end
+                end.start
+            end
         end
     end
 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/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>