paperwork 0.2.0

data/lib/paperwork/assets/paperwork/presentation.css

@@ -0,0 +1,58 @@
+.slide {
+    background-color: rgb(52, 105, 165);
+    color: white;
+}
+
+a {
+    color: rgba(245, 245, 245, 0.705);
+}
+a:hover {
+    color: currentColor;
+    border-color: currentColor;
+    border-bottom: 0.01vh dotted;
+    text-decoration: none;
+}
+
+.cover .logo {
+    padding-left: 2vh;
+    padding-right: 2vh;
+    border-left: 0.2vh dotted;
+    border-right: 0.2vh dotted;
+    border-radius: 1.2vh;
+    border-color: currentColor;
+}
+
+.bye .info {
+    text-align: right;
+    margin-left: 120vh;
+    margin-top: 58vh;
+}
+
+.bye .info .list-group-item {
+    padding-left: 2vh;
+    padding-right: 2vh;
+    border-left: 0.2vh dotted;
+    border-right: 0.2vh dotted;
+    border-radius: 1.2vh;
+    border-color: transparent;
+}
+
+.bye .info .list-group-item:hover {
+    border-color: currentColor;
+}
+
+pre[class*="language-"] {
+    padding: 0.8vh;
+    padding-left: 3vh;
+    background-color: rgb(54, 72, 92);
+}
+
+code[class*="language-"] {
+    background-color: inherit;
+    color: white;
+}
+
+code {
+    background-color: inherit;
+    color: rgb(185, 226, 245);
+}

data/lib/paperwork/assets/presentation.css

@@ -0,0 +1,153 @@
+body {
+    font-size: 2vh;
+    overflow: hidden;
+    background-color: black;
+    color: black;
+}
+
+.slide {
+    position: absolute;
+    height: 100vh;
+    width: 177vh;
+    z-index: 0;
+    background-color: white;
+}
+
+.slide:target, #slide-0 {
+    z-index: 1;
+}
+
+.slide .content {
+    padding-top: 3.5vh;
+    padding-bottom: 2vh;
+    padding-left: 6.2vh;
+    padding-right: 6.2vh;
+}
+
+.cover .logo {
+    text-align: center;
+    font-size: 5vh;
+    margin-top: 30vh;
+}
+
+.cover .info {
+    margin-top:30vh;
+    margin-left: 5.3vh;
+}
+
+.bye {
+    padding-top: 25vh;
+}
+
+.bye .info {
+    margin-top: 40vh;
+    font-size: 1.9vh;
+    width: fit-content;
+}
+
+/* .bye a {
+    color: currentColor;
+} */
+
+.bye .info .list-group-item {
+    background-color: inherit;
+    color: inherit;
+    padding: 0vh;
+    border: none;
+}
+
+.bye .icon {
+    margin-right: 2vh;
+    font-size: 2.2vh;
+    font-weight: bold;
+}
+
+.navigation {
+    position: absolute;
+    bottom: 15vh;
+    width: 177vh;
+    padding-left: 0%;
+    padding-right: 0%;
+}
+
+
+h1 {
+    font-size: 5vh;
+    margin-bottom: 2vh;
+}
+
+h2 {
+    font-size: 3vh;
+    margin-bottom: 4vh;
+}
+
+h3 {
+    margin-top: 4vh;
+    font-size: 2.6vh;
+}
+
+h4 {
+    font-size: 2.3vh;
+}
+
+h5 {
+    font-size: 2vh;
+}
+
+h6 {
+    font-size: 2vh;
+}
+
+
+/* bootstrap w-xx classes are marked !important, so it's
+ * not possible to overwrite them here. let's use
+ * separate ones and transform w-xx to these during
+ * generation process
+ */
+.width-25 {
+    width: 14.1%;
+}
+
+.width-33 {
+    width: 18.6%;
+}
+
+.width-50 {
+    width: 28.2%;
+}
+
+.width-75 {
+    width: 42.3%;
+}
+
+.width-100 {
+    width: 56.4%;
+}
+
+.width-150 {
+    width: 84.6%;
+}
+
+.width-200 {
+    width: 112.8%;
+}
+
+/* position up to three images next to each other */
+img {
+    margin-right: 6%;
+}
+
+h1 img {
+    margin-right: 0%;
+}
+
+.slide-footer {
+    position: absolute;
+    bottom: 0vh;
+    width: 177vh;
+    padding-bottom: 1.5vh;
+    padding-left: 8.9vh;
+    padding-right: 8.9vh;
+    color: currentColor;
+    font-size: 1.35vh;
+}

data/lib/paperwork/config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Paperwork
+    ##
+    # paperwork configuration
+    #
+    # currently available options are:
+    #   :build_root     build directory [default: .work]
+    #   :bundle_jobs    number of jobs for bundle install [default: 8]
+    #   :verbose        verbose middleman build [default: false]
+    #
+    class Config
+        attr_accessor :options
+
+        def initialize
+            self.options = {
+                build_root: ".work",
+                bundle_jobs: 8,
+                verbose: false,
+                custom_css: [],
+                custom_js: []
+            }
+        end
+
+        def [](key)
+            self.options[key]
+        end
+
+        def []=(key, value)
+            self.options[key] = value
+        end
+
+        def self.[](key)
+            self.instance[key]
+        end
+
+        def self.[]=(key, value)
+            self.instance[key] = value
+        end
+
+        def self.instance
+            @@instance ||= self.new
+        end
+    end
+end

data/lib/paperwork/tasks.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+##
+# global paperwork namespace
+module Paperwork
+    def paperwork_configure
+        yield Paperwork::Config.instance
+    end
+
+    ##
+    # creates the document named by 'task'. if a hash is provided
+    # instead of task (like in regular task definitions in rake),
+    # the first key is used as name and it's associated values are
+    # treated as dependencies of that task.
+    #
+    def paperwork(task = nil, sources: [], **options)
+        dependencies = []
+        if task.nil?
+            task = options.keys.first
+            dependencies = options.delete(ntaskame)
+        end
+        doc = Paperwork::Tasks::Document.new(task, sources, *dependencies)
+        doc.create_tasks
+    end
+end

data/lib/paperwork/tasks/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Paperwork
+    ##
+    # task generators for building with middleman
+    module Tasks
+        ##
+        # base class for all task generators. takes
+        # care that every task is registered and
+        # executed during build
+        #
+        class Base
+            attr_reader :name, :dependencies
+
+            def initialize(name, *dependencies)
+                @name = name
+                @dependencies = dependencies.compact
+                self.register(self)
+            end
+
+            def register(task)
+                registered_tasks[task.name] = task unless registered?(task.name)
+            end
+
+            def registered_tasks
+                @@registered_tasks ||= {}
+            end
+
+            def registered?(name)
+                registered_tasks.keys.include?(name)
+            end
+
+            def create_tasks
+                registered_tasks.each do |_name, task|
+                    task.tasks
+                end
+            end
+
+            def self.explain
+                list = @@registered_tasks.map do |_name, task|
+                    "\t#{task.class}: #{task.name} => #{task.dependencies}"
+                end
+                list.join("\n")
+            end
+        end
+    end
+end

data/lib/paperwork/tasks/build_dir.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Paperwork
+    ##
+    # task generators for building with middleman
+    module Tasks
+        require "rake"
+
+        # directory task generator creating dirs recursively
+        class BuildDir < Paperwork::Tasks::Base
+            include Rake::DSL
+
+            def initialize(name, *dependencies)
+                dir = File.dirname(name)
+                if !dir.empty? && dir != "."
+                    dependencies << dir
+                    BuildDir.new(dir)
+                end
+                super(name, *dependencies)
+            end
+
+            def tasks
+                directory self.name => self.dependencies
+            end
+        end
+    end
+end

data/lib/paperwork/tasks/build_file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Paperwork
+    ##
+    # task generators for building with middleman
+    module Tasks
+        require "rake"
+
+        ##
+        # file task generator linking source files into the
+        # middleman template directory
+        #
+        class BuildFile < Paperwork::Tasks::BuildDir
+            attr_reader :source
+
+            include Rake::DSL
+
+            def initialize(name, source, *dependencies)
+                super(name, source, *dependencies)
+                @source = source
+            end
+
+            def tasks
+                file self.name => self.dependencies do
+                    unless File.exist?(self.name)
+                        ln self.source, self.name
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/paperwork/tasks/document.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Paperwork
+    ##
+    # task generators for building with middleman
+    module Tasks
+        require "rake"
+
+        ##
+        # main task generator for building the document
+        #
+        class Document < Paperwork::Tasks::Base
+            attr_reader :dir
+
+            include Rake::DSL
+
+            def initialize(name, sources, *dependencies)
+                @dir = Paperwork::Tasks::Template.new(name).dir
+
+                sources.each do |src|
+                    dst = get_destination(File.join(self.dir, "source"), src)
+                    BuildFile.new(dst, src)
+                    dependencies << dst
+                end
+
+                dependencies << RootHelpers.new(@dir, sources.first).name
+                super(name, *dependencies)
+            end
+
+            def tasks
+                tasks_build
+                tasks_nested
+            end
+
+            private
+
+            def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize
+                ext = File.extname(src)
+                case ext
+                when ".md"
+                    File.join(dst_base, File.basename(src)).gsub(".md", ".html.md")
+                when ".scss"
+                    Paperwork::Config[:custom_css] << File.basename(src)
+                    File.join(dst_base, "stylesheets", File.basename(src)).gsub(".scss", ".css.scss")
+                when ".css"
+                    Paperwork::Config[:custom_css] << File.basename(src)
+                    File.join(dst_base, "stylesheets", File.basename(src))
+                when ".js"
+                    Paperwork::Config[:custom_js] << File.basename(src)
+                    File.join(dst_base, "javascripts", File.basename(src))
+                when ".yml"
+                    File.join(dst_base, "..", "data", File.basename(src))
+                else
+                    File.join(dst_base, "images", File.basename(src))
+                end
+            end
+
+            def tasks_build # rubocop:disable Metrics/AbcSize
+                namespace :paperwork do
+                    desc "build documentation for '#{self.name}'"
+                    task self.name => self.dependencies do
+                        verbose_flag = Paperwork::Config[:verbose] ? " --verbose" : ""
+                        Dir.chdir(self.dir) do
+                            Bundler.with_unbundled_env do
+                                Process.spawn(
+                                    "bundle exec middleman build#{verbose_flag}",
+                                    out: :out,
+                                    in: :in,
+                                    err: :err
+                                )
+                            end
+                            Process.waitall
+                        end
+
+                        puts
+                        puts "...Done!"
+                        puts "build artifacts are located in #{File.join(self.dir, "build")}"
+                    end
+                end
+            end
+
+            def tasks_nested # rubocop:disable Metrics/AbcSize
+                namespace :paperwork do
+                    namespace self.name do
+                        task build: ["paperwork:#{self.name}"]
+
+                        desc "rebuild documentation from scratch for '#{self.name}'"
+                        task rebuild: [:clean, :build]
+
+                        desc "build documentation for '#{self.name}' with verbose output"
+                        task build_verbose: [:set_verbose, :build]
+
+                        task :set_verbose do
+                            Paperwork::Config[:verbose] = true
+                        end
+
+                        desc "clean documentation build directory for '#{self.name}'"
+                        task :clean do
+                            rm_rf self.dir
+                        end
+                    end
+                end
+            end
+        end
+    end
+end