paperwork 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 151389aa8930969de29cb2e7969505d8c52f085ffc46cf43bb3168575acbb325
-  data.tar.gz: 8121a20fc3f36067e2273b9cf6ac92173b9ad84cf25f1579c7f20afe1e5bfaf3
+  metadata.gz: 80f63892db3d3c30b601943f7c6a0929b92079d3dab71696a7b2426ef7ce7d3a
+  data.tar.gz: 2b70456d7d56e4674df35e4a1864483c75d64087519ea3643b131369aea3ed83
 SHA512:
-  metadata.gz: dd6ada05928138cb198175167a0b9cbb1148dcc875f9ccf3a12049eb759a60832dffd538de17c31d4138aa8d4bf6ef7f1cb9b26d23d863e8770e1044ebb572ef
-  data.tar.gz: ea9028ea7f182d5d98841dc6e01ebe75c6e45e6839389c4a4247219e3efd56648ac317985209cecc2c1a25fbf3f0466cf780025648ef3d1e7498ef119cf328c1
+  metadata.gz: a4f75a8c77f49ba6c00125cdd4176505bb43c85cf127278a033c479bc6d7a5ba22f4fecae0561b2ca4da0572aa5f014ce3e7a205b70a72aa1c59e6368ff81748
+  data.tar.gz: c3efec0580ccd1a16ac3fb11caf587537d7fb3c57c9b3006a16d0c77d302313ed2dea8dbe3ec1385b5aef8ed706b36493f8ac30cdd8e7730d1ab115d3717190d

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    paperwork (0.2.6)
+    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", "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,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/middleman_template/lib/info_helpers.rb

@@ -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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperwork
-    VERSION = "0.2.6"
+    VERSION = "0.3.0"
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Tobias Schmid
@@ -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
@@ -163,7 +180,7 @@ files:
 - lib/paperwork/version.rb
 - nested_example/navdemo.md
 - paperwork.gemspec
-- site.yml
+- paperwork.yml
 homepage: https://gitlab.com/couchbelag/paperwork
 licenses:
 - MIT