paperwork 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66af98ddc420cbb32f380bd7e9f4c96b5204f8e23632a3588a48e8d43253dec2
-  data.tar.gz: f849b6f17d1614a168c9f6c231e47d1a8a67735c4dd49867131fcde93c48bb94
+  metadata.gz: 80f63892db3d3c30b601943f7c6a0929b92079d3dab71696a7b2426ef7ce7d3a
+  data.tar.gz: 2b70456d7d56e4674df35e4a1864483c75d64087519ea3643b131369aea3ed83
 SHA512:
-  metadata.gz: 07aec73f0bd4e8c998552f290325594c31e8028aa20fc315965a2e34e98b1f4d13a6d35dbd0a6aacb85c73751f74e9f8f174509e1234456f6b4a284798ea8707
-  data.tar.gz: 35a393b36b652cbccbe71f19909d0e84ef5ec5bdbbc1a461cfdb63eaae142790b5243f72b60f2989f96a10abdd515627c1a5dd341b7bc40e19e2badbfa002fac
+  metadata.gz: a4f75a8c77f49ba6c00125cdd4176505bb43c85cf127278a033c479bc6d7a5ba22f4fecae0561b2ca4da0572aa5f014ce3e7a205b70a72aa1c59e6368ff81748
+  data.tar.gz: c3efec0580ccd1a16ac3fb11caf587537d7fb3c57c9b3006a16d0c77d302313ed2dea8dbe3ec1385b5aef8ed706b36493f8ac30cdd8e7730d1ab115d3717190d

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    paperwork (0.2.2)
+    paperwork (0.3.0)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
+      thor (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -51,6 +52,7 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
+    thor (1.1.0)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/Rakefile

@@ -13,4 +13,4 @@ task rebuild: [:clean, :build]
 task default: :spec
 CLEAN.include(".work/coverage")
 
-paperwork :doc, sources: ["README.md", "navdemo.md", "site.yml", "custom.js", "custom.css"]
+paperwork :doc, sources: ["README.md", "nested_example/navdemo.md", "paperwork.yml", "custom.js", "custom.css"]

data/bin/paperwork

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "paperwork"
+
+Paperwork::CLI.start

data/lib/paperwork.rb

@@ -35,5 +35,7 @@ require "paperwork/tasks/root_helpers"
 require "paperwork/tasks/document"
 require "paperwork/tasks/template"
 
+require "paperwork/cli"
+
 
 include Paperwork # rubocop:disable Style/MixinUsage

data/lib/paperwork/cli.rb

@@ -0,0 +1,61 @@
+require "yaml"
+require "thor"
+require "paperwork"
+
+module Paperwork
+    class CLI < Thor
+        attr_accessor :config
+
+        CONFIG_FILE = "paperwork.yml"
+
+        class_option :verbose, aliases: "-v", desc: "be verbose about the build", type: :boolean, default: false
+
+        desc    "build",
+                "creates documentation as defined in #{CONFIG_FILE} and writes it to '#{Paperwork::Config[:build_root]}/<name>/build'"
+        def build
+            build_internal "build"
+        end
+
+        desc    "rebuild",
+                "removes previous builds and creates documentation as defined in #{CONFIG_FILE} and writes it to '#{Paperwork::Config[:build_root]}/<name>/build'"
+        def rebuild
+            build_internal "rebuild"
+        end
+
+        desc    "server",
+                "starts a aerver that serves documentation as defined in #{CONFIG_FILE}"
+        def server
+            build_internal "server"
+        end
+
+        protected
+            def build_internal(task)
+                setup_config
+                setup_tasks
+                invoke_tasks task
+            end
+
+            def setup_config
+                raise Exception.new(
+                    "#{CONFIG_FILE} not found. You need to create a configuration file first."
+                ) unless File.exist?(CONFIG_FILE)
+
+                yaml = YAML.load_file(CONFIG_FILE)
+                self.config = yaml["config"]
+                self.config["sources"] << CONFIG_FILE
+
+                raise Exception.new(
+                    "No 'config' found in #{CONFIG_FILE}. You need to describe the build setup in a 'config' section first."
+                ) if self.config.nil?
+            end
+
+            def setup_tasks
+                paperwork self.config["name"], sources: self.config["sources"]
+            end
+
+            def invoke_tasks(target)
+                Rake::Task["paperwork:#{self.config["name"]}:set_verbose"].invoke if options[:verbose]
+                Rake::Task["paperwork:#{self.config["name"]}:#{target}"].invoke
+            end
+    end
+end

data/lib/paperwork/tasks/document.rb

@@ -9,7 +9,7 @@ module Paperwork
         ##
         # main task generator for building the document
         #
-        class Document < Paperwork::Tasks::Base
+        class Document < Paperwork::Tasks::Base # rubocop:disable Metrics/ClassLength
             attr_reader :dir
 
             include Rake::DSL
@@ -34,19 +34,26 @@ module Paperwork
 
             private
 
-            def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize
+            def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+                nested_base = File.dirname(src)
+                nested_base = if nested_base == "."
+                                  dst_base
+                              else
+                                  File.join(dst_base, nested_base)
+                              end
+
                 ext = File.extname(src)
                 case ext
                 when ".md"
-                    File.join(dst_base, File.basename(src)).gsub(".md", ".html.md")
+                    File.join(nested_base, File.basename(src)).gsub(".md", ".html.md")
                 when ".scss"
-                    Paperwork::Config[:custom_css] << File.basename(src)
+                    Paperwork::Config[:custom_css] << File.basename(src, ext)
                     File.join(dst_base, "stylesheets", File.basename(src)).gsub(".scss", ".css.scss")
                 when ".css"
-                    Paperwork::Config[:custom_css] << File.basename(src)
+                    Paperwork::Config[:custom_css] << File.basename(src, ext)
                     File.join(dst_base, "stylesheets", File.basename(src))
                 when ".js"
-                    Paperwork::Config[:custom_js] << File.basename(src)
+                    Paperwork::Config[:custom_js] << File.basename(src, ext)
                     File.join(dst_base, "javascripts", File.basename(src))
                 when ".yml"
                     File.join(dst_base, "..", "data", File.basename(src))
@@ -79,9 +86,9 @@ module Paperwork
                 end
             end
 
-            def tasks_nested # rubocop:disable Metrics/AbcSize
-                namespace :paperwork do
-                    namespace self.name do
+            def tasks_nested # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+                namespace :paperwork do # rubocop:disable Metrics/BlockLength
+                    namespace self.name do # rubocop:disable Metrics/BlockLength
                         task build: ["paperwork:#{self.name}"]
 
                         desc "rebuild documentation from scratch for '#{self.name}'"
@@ -98,6 +105,31 @@ module Paperwork
                         task :clean do
                             rm_rf self.dir
                         end
+
+                        desc "start middleman server for editing documents and get visual feedback with live reload"
+                        task server: :build do
+                            Dir.chdir(self.dir) do
+                                Bundler.with_unbundled_env do
+                                    Process.spawn(
+                                        "bundle exec middleman server",
+                                        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
+                        end
                     end
                 end
             end

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

@@ -50,7 +50,6 @@ set :relative_links, true
 activate :relative_assets
 activate :livereload
 activate :syntax, line_numbers: true
-# activate :directory_indexes
 
 
 require "lib/doc_renderer"

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

@@ -6,10 +6,12 @@
 #
 module DocRenderer
     require "middleman-core/renderers/redcarpet"
+    require_relative "info_helpers"
 
     # This is a basic renderer for transforming markdown to HTML
     # inherit from this renderer to create more specific variants
     class Base < Middleman::Renderers::MiddlemanRedcarpetHTML
+        include InfoHelpers
 
         # block level calls
         def block_code(code, language)
@@ -79,11 +81,11 @@ module DocRenderer
         # def emphasis(text)
         # end
 
-        # def image(link, title, alt_text, default_class: "img-fluid")
-        #     <<~IMG
-        #         <img src="#{link}" alt="#{alt_text}" class="#{default_class}">
-        #     IMG
-        # end
+        def image(link, title, alt_text)
+            <<~IMG
+                <img src="#{relative_link link, scope.current_path}" alt="#{alt_text}" class="img-fluid">#{title}</img>
+            IMG
+        end
 
         # def linebreak()
         # end

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

@@ -20,24 +20,44 @@ module InfoHelpers
         end
     end
 
-    def site?
-        data.respond_to?(:site)
+    def relative_link(stringifyable, current_path = current_page.path)
+        relative = String.new
+        dots = current_path.split(/[\/\\]/).size - 1
+        dots.times{ relative += "../" }
+        # This has been some nasty part to debug...
+        # keep these comments for debugging session yet to come
+        # puts "##################################"
+        # puts "current_page.path: #{current_page.path}"
+        # puts "stringifyable: #{stringifyable.to_s}"
+        # puts "dots: #{dots}"
+        # puts "relative link: #{relative + stringifyable.to_s}"
+        # puts "##################################"
+        relative + stringifyable.to_s
+    end
+
+    def paperwork?
+        data.respond_to?(:paperwork)
     end
 
     def navbar?
-        site? && data.site.respond_to?(:navbar)
+        paperwork? && data.paperwork.respond_to?(:navbar)
     end
 
     def navbar_links
-        nav = data.site.navbar.links if navbar?
-        nav || {}
+        nav = data.paperwork.navbar.links if navbar?
+        nav ||= {}
+        mapped = {}
+        nav.each do |name, link|
+            mapped[name] = relative_link(link)
+        end
+        mapped
     end
 
     def navbar_brand
-        data.site.navbar.brand if navbar?
+        data.paperwork.navbar.brand if navbar?
     end
 
     def footer_text
-        data.site.footer if site?
+        data.paperwork.footer if paperwork?
     end
 end

data/lib/paperwork/tasks/root_helpers.rb

@@ -33,7 +33,7 @@ module Paperwork
                         <<~ROOT_HELPERS
                             module RootHelpers
                                 def root_path
-                                    "#{self.root}"
+                                    relative_link "#{self.root}"
                                 end
 
                                 def custom_css

data/lib/paperwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperwork
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
 end

data/{navdemo.md → nested_example/navdemo.md}

@@ -3,3 +3,6 @@ title: Linked
 ---
 
 # just a linked page for demonstrating navbar links
+
+
+[Back...](../README.md)

data/paperwork.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
 
     spec.add_runtime_dependency "rake", "~> 12.3"
     spec.add_runtime_dependency "redcarpet", "~> 3.5.0"
+    spec.add_runtime_dependency "thor", "~> 1.1.0"
 end

data/paperwork.yml

@@ -0,0 +1,15 @@
+footer: © Tobi Schmid
+
+navbar:
+  brand: paperwork
+  links:
+    Home: README.md
+    Navbar Demo: nested_example/navdemo.md
+
+config:
+  name: doc
+  sources:
+    - README.md
+    - nested_example/navdemo.md
+    - custom.js
+    - custom.css

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tobias Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -108,11 +108,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: 
 email:
 - couchbelag@gmail.com
 executables:
 - console
+- paperwork
 - setup
 extensions: []
 extra_rdoc_files: []
@@ -128,12 +143,14 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/paperwork
 - bin/setup
 - custom.css
 - custom.js
 - lib/paperwork.rb
 - lib/paperwork/assets/paperwork/presentation.css
 - lib/paperwork/assets/presentation.css
+- lib/paperwork/cli.rb
 - lib/paperwork/config.rb
 - lib/paperwork/tasks.rb
 - lib/paperwork/tasks/base.rb
@@ -161,9 +178,9 @@ files:
 - lib/paperwork/tasks/root_helpers.rb
 - lib/paperwork/tasks/template.rb
 - lib/paperwork/version.rb
-- navdemo.md
+- nested_example/navdemo.md
 - paperwork.gemspec
-- site.yml
+- paperwork.yml
 homepage: https://gitlab.com/couchbelag/paperwork
 licenses:
 - MIT

data/site.yml

@@ -1,7 +0,0 @@
-footer: © Tobi Schmid
-
-navbar:
-  brand: paperwork
-  links:
-    Home: README.md
-    Navbar Demo: navdemo.md