paperwork 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13203b1fabe9808e33e1cdaea4ba2c92d738daa94ffa1d22117af9057e76d6b
-  data.tar.gz: d4349a96f701e92591eabdc19abf1316b72ba88b876cd518ce9b58ea705aeecf
+  metadata.gz: 88ee93586dfaeee4e866d016e2590a7d0fe48e2401dc5c29f5a9307adfac54c5
+  data.tar.gz: 6e237a15962eec55281ecdd1d93b14a26502d5f53793c7f164e2fdc7780727b3
 SHA512:
-  metadata.gz: '009b8503df60c1e652123084e5c51ec935e1daf996d7e7002b24f63a163a1fab9b5059d3e76b2c1f30d7489db70192dc157346a08f33d904d2fafd66ec4fe161'
-  data.tar.gz: 9cee87ec48e8587f19332f5fd5c5bb4b675199ffe5ec529582123a13c1b9dd46e0a3a7f4794f1347d36e3cfdb23986b17cdeb78951b4bb9970c984f747100392
+  metadata.gz: f30ee505178ea14ff03258a0f807b1b7aacbd2c738f5d025a6e339a78bab132b897e823c0f90278ce0d69e6751df5446207591c35e8b6b7ca7c122a7579df15c
+  data.tar.gz: ed1b2dd3d7713bccb6def5fb4b84c48af51620525960a1ea38db6c5800070c4a29113e34527d2703f80acab7cca6509a30ecb2e0f493ac3951f785dbe0c1f337

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.4.0)
       listen (~> 3.4.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
@@ -75,4 +75,4 @@ DEPENDENCIES
   simplecov (~> 0.18.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.27

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/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>