paperwork 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0442b017eab906cbe4b15d82938e45ea6df77f7805e521bea5574071875ed804
-  data.tar.gz: 32b085683f2a46b1143c21982b16d08222f183499a004366da37abb53bddf45b
+  metadata.gz: 151389aa8930969de29cb2e7969505d8c52f085ffc46cf43bb3168575acbb325
+  data.tar.gz: 8121a20fc3f36067e2273b9cf6ac92173b9ad84cf25f1579c7f20afe1e5bfaf3
 SHA512:
-  metadata.gz: cb165a9b7949a61f76a5fe3f0450d44ffd1de1f40ea16754fc60a51263b44198a32c120c70151e6af0a7c6e1d5ab2be91aa89c33de947ee56865b958b3c89449
-  data.tar.gz: 1d58b651843b4f7a886f9d59f5c606ff7dfb062dd280a44c35b8c69f9ebd5ad9cd480b863ab992fa34896c9976fc9521751f036f819effca7060083c905b82bb
+  metadata.gz: dd6ada05928138cb198175167a0b9cbb1148dcc875f9ccf3a12049eb759a60832dffd538de17c31d4138aa8d4bf6ef7f1cb9b26d23d863e8770e1044ebb572ef
+  data.tar.gz: ea9028ea7f182d5d98841dc6e01ebe75c6e45e6839389c4a4247219e3efd56648ac317985209cecc2c1a25fbf3f0466cf780025648ef3d1e7498ef119cf328c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paperwork (0.2.1)
+    paperwork (0.2.6)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
 

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", "site.yml", "custom.js", "custom.css"]

data/lib/paperwork/tasks.rb

@@ -17,7 +17,7 @@ module Paperwork
         dependencies = []
         if task.nil?
             task = options.keys.first
-            dependencies = options.delete(ntaskame)
+            dependencies = options.delete(task)
         end
         doc = Paperwork::Tasks::Document.new(task, sources, *dependencies)
         doc.create_tasks

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,6 +20,21 @@ module InfoHelpers
         end
     end
 
+    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 site?
         data.respond_to?(:site)
     end
@@ -30,7 +45,12 @@ module InfoHelpers
 
     def navbar_links
         nav = data.site.navbar.links if navbar?
-        nav || {}
+        nav ||= {}
+        mapped = {}
+        nav.each do |name, link|
+            mapped[name] = relative_link(link)
+        end
+        mapped
     end
 
     def navbar_brand

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.1"
+    VERSION = "0.2.6"
 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/site.yml

@@ -4,4 +4,4 @@ navbar:
   brand: paperwork
   links:
     Home: README.md
-    Navbar Demo: navdemo.md
+    Navbar Demo: nested_example/navdemo.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 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
@@ -161,7 +161,7 @@ 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
 homepage: https://gitlab.com/couchbelag/paperwork