paperwork 0.2.5 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1955714ea9b28ec4ec30953e9bb6d9fdde843dc6b07b1e845250272e06d231ce
-  data.tar.gz: f173804ede9bd1280bd724867b34aac75cae1d48e9ef13735e0ca5957185dcf3
+  metadata.gz: 30489519acbe8e37aaafa3a46cb8da6c007cd4f4b77bef00e22acd4ee4e3efed
+  data.tar.gz: 72ee620c27ccc6a8a7968b016713ac02a67a0e19b128868472984b27762a6197
 SHA512:
-  metadata.gz: 2a5f3811fbbe9c7f8a48e120f83e4dad99a5e48ea15489d183a64d627f1ecdf210734e08f764c559298df7f832affc1e232e17f65cded172f59d9111a4ffc90f
-  data.tar.gz: 0fbb45795dcfa953c0e9479e0a8c135e799a6fbb41f26cd59471d7e0a5a6fb083832bb6082d8881fc2f1368e302425209b7d6170b4ee98c537825f37cd28326f
+  metadata.gz: 362686f84cffe18524ca091f5f50cff9767c739a7554c5e596120a8841aad6396aa35b8cbaef19a98865c86ef712123f3840a0557aff3be9c28e642be8029d12
+  data.tar.gz: b193c78aa08c1da1dbc3fba4cc098794368d6a146569c8cfbf4900aa18f0dcd323d4f97dbe0efa657e37cfdd3a2e46dd225d10fe53b8ec376bcc2eec41ebfba8

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    paperwork (0.2.5)
+    paperwork (0.3.3)
       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/build_file.rb

@@ -23,7 +23,7 @@ module Paperwork
             def tasks
                 file self.name => self.dependencies do
                     unless File.exist?(self.name)
-                        ln self.source, self.name
+                        ln_sf self.source, self.name
                     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,13 +34,13 @@ 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)
-                if nested_base == "."
-                    nested_base = dst_base
-                else
-                    nested_base = File.join(dst_base, nested_base)
-                end
+                nested_base = if nested_base == "."
+                                  dst_base
+                              else
+                                  File.join(dst_base, nested_base)
+                              end
 
                 ext = File.extname(src)
                 case ext
@@ -68,17 +68,16 @@ module Paperwork
                     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
-                                )
+                            cmd = "bundle exec middleman build#{verbose_flag}"
+                            if defined? Bundler
+                                Bundler.with_unbundled_env do
+                                    Process.spawn(cmd, out: :out, in: :in, err: :err)
+                                end
+                            else
+                                Process.spawn(cmd, out: :out, in: :in, err: :err)
                             end
                             Process.waitall
                         end
-
                         puts
                         puts "...Done!"
                         puts "build artifacts are located in #{File.join(self.dir, "build")}"
@@ -86,9 +85,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}'"
@@ -105,6 +104,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
+                                cmd = "bundle exec middleman server"
+                                if defined? Bundler
+                                    Bundler.with_unbundled_env do
+                                        Process.spawn(cmd, out: :out, in: :in, err: :err)
+                                    end
+                                else
+                                    Process.spawn(cmd, 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/lib/doc_renderer.rb

@@ -85,7 +85,6 @@ module DocRenderer
             <<~IMG
                 <img src="#{relative_link link, scope.current_path}" alt="#{alt_text}" class="img-fluid">#{title}</img>
             IMG
-            #super(relative_link(link, scope.current_path), title, alt_text)
         end
 
         # def linebreak()

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

@@ -20,7 +20,7 @@ module InfoHelpers
         end
     end
 
-    def relative_link(stringifyable, current_path=current_page.path)
+    def relative_link(stringifyable, current_path = current_page.path)
         relative = String.new
         dots = current_path.split(/[\/\\]/).size - 1
         dots.times{ relative += "../" }
@@ -35,16 +35,16 @@ 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|
@@ -54,10 +54,10 @@ module InfoHelpers
     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/template.rb

@@ -28,13 +28,13 @@ module Paperwork
                 directory self.name => self.dependencies do
                     cp_r template, self.dir
                     Dir.chdir(self.dir) do
-                        Bundler.with_unbundled_env do
-                            Process.spawn(
-                                "bundle install --path=../.bundle/gems --jobs 8 --without test development",
-                                out: :out,
-                                in: :in,
-                                err: :err
-                            )
+                        cmd = "bundle install --path=../.bundle/gems --jobs 8 --without test development"
+                        if defined? Bundler
+                            Bundler.with_unbundled_env do
+                                Process.spawn(cmd, out: :out, in: :in, err: :err)
+                            end
+                        else
+                            Process.spawn(cmd, out: :out, in: :in, err: :err)
                         end
                         Process.spawn("yarn install", out: :out, in: :in, err: :err)
                         Process.waitall

data/lib/paperwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperwork
-    VERSION = "0.2.5"
+    VERSION = "0.3.3"
 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.5
+  version: 0.3.3
 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