paperwork 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a4d78a79310dd0ce95afc1fa65864f5a5b8f71a0d01972762484c9ab4d4e28c
-  data.tar.gz: 6d5edf6cddc099b47bf01e659a639df84a7305ac1d895aeb31018d65a20f8e87
+  metadata.gz: acec360949d7b7403f5b7d6985a6cca4289d03c19cf13f7c12a5db5d468072ea
+  data.tar.gz: d6cdb1bd4f9cbb211d2663c62b1ccd461c15a7c8d7a84f9afad049c31a8c2dd4
 SHA512:
-  metadata.gz: 5983c073fb3c2295aa6827c66f6c27f647a3f3d19efaad7bce6c5ccaccdf0b67e42aeea9096c3a814ec5fea39a7980eee4df5c65aa462da0e82f51dfbccdcba4
-  data.tar.gz: 7038d59fa69df43ef00541adc169a440439dda1f418822a0c4c36fcb86322f2866f2f988cca6e55143cb25bd81c92449b234dbf0dbff8c911521bfd1730d6191
+  metadata.gz: e6a1b14be156b22c42345512735e242a58b1b4ea38354e9b0550c1cab88d4c52d3a8b3efacbefbbe010f983fdaaf7536351efb394390604db58566086c085d98
+  data.tar.gz: 3b781ef6f0ce74100687d61e04a425a6477629f1ad1cf65f2f476a80629eddef4a32cbed834d5ef0012addd5f1dcc1dd0652aafeda8280f2e281aac6ecd958dc

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    paperwork (0.2.3)
+    paperwork (0.3.1)
       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", "nested_example/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,83 @@
+# frozen_string_literal: true
+
+##
+# globla namespace for paperwork
+#
+module Paperwork
+    require "yaml"
+    require "thor"
+    require "paperwork"
+
+    ##
+    # command line interface for 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",
+                <<~DESC
+                    creates documentation as defined in
+                    #{CONFIG_FILE} and writes it to
+                    '#{Paperwork::Config[:build_root]}/<name>/build'
+                DESC
+        def build
+            build_internal "build"
+        end
+
+        desc    "rebuild",
+                <<~DESC
+                    removes previous builds and creates
+                    documentation as defined in
+                    #{CONFIG_FILE} and writes it to
+                    '#{Paperwork::Config[:build_root]}/<name>/build'
+                DESC
+        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
+            unless File.exist?(CONFIG_FILE)
+                raise Exception.new(
+                    "#{CONFIG_FILE} not found. You need to create a configuration file first."
+                )
+            end
+
+            yaml = YAML.load_file(CONFIG_FILE)
+            self.config = yaml["config"]
+            self.config["sources"] << CONFIG_FILE
+
+            return unless self.config.nil?
+
+            raise Exception.new(
+                "No 'config' found in #{CONFIG_FILE}. You need to describe the build setup in a 'config' section first."
+            )
+        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,20 +34,26 @@ module Paperwork
 
             private
 
-            def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize
-                dst_base = File.join(dst_base, File.dirname(src))
+            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))
@@ -80,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}'"
@@ -99,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,9 +20,9 @@ module InfoHelpers
         end
     end
 
-    def relative_link(stringifyable)
+    def relative_link(stringifyable, current_path = current_page.path)
         relative = String.new
-        dots = current_page.path.split(/[\/\\]/).size - 1
+        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
@@ -35,28 +35,29 @@ module InfoHelpers
         relative + stringifyable.to_s
     end
 
-    def site?
-        data.respond_to?(:site)
+    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 = data.paperwork.navbar.links if navbar?
         nav ||= {}
+        mapped = {}
         nav.each do |name, link|
-            nav[name] = relative_link(link)
+            mapped[name] = relative_link(link)
         end
-        nav
+        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/version.rb

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

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/{site.yml → paperwork.yml}

@@ -5,3 +5,11 @@ navbar:
   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.3
+  version: 0.3.1
 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,12 +108,25 @@ 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
-- setup
+- paperwork
 extensions: []
 extra_rdoc_files: []
 files:
@@ -127,13 +140,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- bin/paperwork
 - 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
@@ -163,7 +176,7 @@ files:
 - lib/paperwork/version.rb
 - nested_example/navdemo.md
 - paperwork.gemspec
-- site.yml
+- paperwork.yml
 homepage: https://gitlab.com/couchbelag/paperwork
 licenses:
 - MIT

data/bin/console

@@ -1,15 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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