paperwork 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6ca73b108fa2e53bfc6882abb4e1dfd84c34e58d4306bc29a4ec54ae0b55a28
+  data.tar.gz: 75c019845942a4b8596fc04e7c7b8cdc22198dd8fad7b94918e2c4a93cbac3f0
+SHA512:
+  metadata.gz: bc72644eaa74956c6360083a90450f127df96ebcd15742ca5e63f50a16c4c7cbf43bdd105264610df53ca6362b682af52c217e65cfd717a67a0acf4d82c97c29
+  data.tar.gz: 5aeecba6354e787619122d7fbb977e4025bc902ee28b5f1d6cdd4d32e4c1cc218b4d85f1c13c856d461c1862219e7cbe2cab0bb0f83654d28d50429942a6a1be

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.work
+/.vscode
+.byebug_history
+
+# rspec failure tracking
+.rspec_status
+.build

data/.gitlab-ci.yml

@@ -0,0 +1,65 @@
+image: "ruby:2.6"
+
+# include:
+#   - template: License-Scanning.gitlab-ci.yml
+
+stages:
+  - build
+  - test
+  - 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}
+
+build:
+  stage: build
+  script:
+    - bundle exec rake build
+  artifacts:
+    paths:
+      - pkg/
+      - .work/doc/build/
+
+rspec:
+  stage: test
+  dependencies:
+    - build
+  script:
+    - bundle exec "rspec --format RspecJunitFormatter --out rspec.xml"
+  artifacts:
+    paths:
+      - .work/coverage/
+      - rspec.xml
+    reports:
+      junit: rspec.xml
+
+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
+  script:
+    - mkdir public
+    - mv .work/doc/build/* public/
+    - mv .work/coverage public/
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,68 @@
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - heredoc
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - heredoc
+  Max: 20
+
+Layout/IndentationWidth:
+  Width: 4
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/SymbolArray:
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: "()"
+    "%i": "()"
+    "%I": "()"
+    "%r": "()"
+    "%w": "()"
+    "%W": "()"

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paperwork.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    paperwork (0.2.0)
+      rake (~> 12.3)
+      redcarpet (~> 3.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.87.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      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)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1.3)
+  paperwork!
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.1)
+  rubocop (~> 0.87.1)
+  simplecov (~> 0.18.5)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 The paperwork gem authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+---
+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)
+
+
+### 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).
+
+
+### Why would I want to transform my project documentation into a presentation?
+
+Well... you wouldn't, I agree. Nevertheless I've been into situations where I created a presentation for a project and thought afterwards *"Damn, that would fit into the documentation perfectly!!"*... and I did it a second time. So the real benefit in this is to have a presentation that can be reused and integrated seamlessly into a project's documentation. In gitlab for example documentation and presentations would have same layout in the web UI, so you wouldn't notice what's presentation and what's documentation.
+
+### *paperwork* is not another markdown renderer
+
+*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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperwork'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+
+### In other languages
+
+In other languages you will need to setup a `Gemfile` like the one above and a `Rakefile` for the build process:
+
+```ruby
+require "paperwork/tasks"
+
+Paperwork.book do |p|
+    p.title = "fancy title"
+    p << "README.md"
+end
+```
+
+Change into the directory where the Rakefile and the Gemfile (and of course the `README.md`) are located and execute:
+
+```bash
+$ bundle install
+$ rake paperwork
+```
+
+If you'd like to know what tasks are shipped with *paperwork* do a `rake -T` to get a list of all tasks.
+
+**For more information about how to use *paperwork* have a look into the [user's guide](guides/users_guide.md).**
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+If you'd like to contribute to the project, please have a look at the project's [developer guide](https://gitlab.com/couchbelag/gog/-/tree/2.0.0/developer-guide). The automated build process provides some information about the current *master* branch:
+
+* [Example presentation from README.md (this file)](https://couchbelag.gitlab.io/paperwork)
+* [code coverage report](https://couchbelag.gitlab.io/paperwork/coverage)
+
+## Contributing
+
+Bug reports and pull requests are welcome on gitlab at https://gitlab.com/couchbelag/paperwork.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "paperwork"
+
+RSpec::Core::RakeTask.new(:spec)
+
+
+Rake::Task[:build].enhance(["paperwork:doc"])
+Rake::Task[:clean].enhance(["paperwork:doc:clean"])
+task rebuild: [:clean, :build]
+task default: :spec
+CLEAN.include(".work/coverage")
+
+paperwork :doc, sources: ["README.md", "navdemo.md", "site.yml", "custom.js", "custom.css"]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paperwork"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/custom.css

@@ -0,0 +1 @@
+

data/custom.js

@@ -0,0 +1 @@
+

data/lib/paperwork.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 The paperwork gem authors
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#
+
+require "paperwork/version"
+require "paperwork/config"
+require "paperwork/tasks"
+require "paperwork/tasks/base"
+require "paperwork/tasks/build_dir"
+require "paperwork/tasks/build_file"
+require "paperwork/tasks/root_helpers"
+require "paperwork/tasks/document"
+require "paperwork/tasks/template"
+
+
+include Paperwork # rubocop:disable Style/MixinUsage