paperwork 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f63892db3d3c30b601943f7c6a0929b92079d3dab71696a7b2426ef7ce7d3a
-  data.tar.gz: 2b70456d7d56e4674df35e4a1864483c75d64087519ea3643b131369aea3ed83
+  metadata.gz: f13203b1fabe9808e33e1cdaea4ba2c92d738daa94ffa1d22117af9057e76d6b
+  data.tar.gz: d4349a96f701e92591eabdc19abf1316b72ba88b876cd518ce9b58ea705aeecf
 SHA512:
-  metadata.gz: a4f75a8c77f49ba6c00125cdd4176505bb43c85cf127278a033c479bc6d7a5ba22f4fecae0561b2ca4da0572aa5f014ce3e7a205b70a72aa1c59e6368ff81748
-  data.tar.gz: c3efec0580ccd1a16ac3fb11caf587537d7fb3c57c9b3006a16d0c77d302313ed2dea8dbe3ec1385b5aef8ed706b36493f8ac30cdd8e7730d1ab115d3717190d
+  metadata.gz: '009b8503df60c1e652123084e5c51ec935e1daf996d7e7002b24f63a163a1fab9b5059d3e76b2c1f30d7489db70192dc157346a08f33d904d2fafd66ec4fe161'
+  data.tar.gz: 9cee87ec48e8587f19332f5fd5c5bb4b675199ffe5ec529582123a13c1b9dd46e0a3a7f4794f1347d36e3cfdb23986b17cdeb78951b4bb9970c984f747100392

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    paperwork (0.3.0)
+    paperwork (0.3.5)
+      listen (~> 3.4.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
       thor (~> 1.1.0)
@@ -13,11 +14,18 @@ GEM
     byebug (11.1.3)
     diff-lcs (1.4.4)
     docile (1.3.2)
+    ffi (1.14.2)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     redcarpet (3.5.1)
     regexp_parser (1.7.1)
     rexml (3.2.4)

data/README.md

@@ -9,6 +9,7 @@ title: paperwork
 
 Markdown is used throughout many software development projects because of its simple syntax. Though being simple markdown provides sufficient elements necessary to visualize most aspects of software. And it's integrated into many tools, like github, gitlab, Visual Studio Code,... most likely these are already part of nowadays development processes anyway.
 
+
 Most developers want to focus on code and progress and not on documentation. *paperwork* tries to keep most of the publishing topics of documentation away from them. One important goal with this is to keep the markdown document independent from the target media. So it is possible to write documentation as HTML pages that can be scrolled, printed,... as you would do with usual web sites. On the other hand, markdown could also be transformed to presentations. If you're reading this in a presentation, you're already looking at one example of such a transformation. If you don't, have a look at the [generated presentation](https://couchbelag.gitlab.io/paperwork). The source file for the presentation is the [regular `README.md` file of the project](https://gitlab.com/couchbelag/paperwork/-/blob/master/README.md).
 
 
@@ -21,7 +22,6 @@ Well... you wouldn't, I agree. Nevertheless I've been into situations where I cr
 *paperwork* is not simply a renderer like *redcarpet* (which is actually used as renderer within *paperwork*). It provides *"markdown API"* to interface with different media formats. Of course, *paperwork* is not limited to presentations and/or books. Any media could be addressed. The idea simply is *reduce, reuse, recycle*, write documentation once and spread it across multiple channels.
 
 
-
 ## Installation & Usage
 
 ### In a ruby application

data/lib/paperwork/cli.rb

@@ -1,8 +1,16 @@
-require "yaml"
-require "thor"
-require "paperwork"
+# 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
 
@@ -11,13 +19,22 @@ module Paperwork
         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'"
+                <<~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",
-                "removes previous builds and creates documentation as defined in #{CONFIG_FILE} and writes it to '#{Paperwork::Config[:build_root]}/<name>/build'"
+                <<~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
@@ -29,33 +46,38 @@ module Paperwork
         end
 
         protected
-            def build_internal(task)
-                setup_config
-                setup_tasks
-                invoke_tasks task
-            end
 
-            def setup_config
+        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."
-                ) unless File.exist?(CONFIG_FILE)
+                )
+            end
 
-                yaml = YAML.load_file(CONFIG_FILE)
-                self.config = yaml["config"]
-                self.config["sources"] << 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
+            return unless self.config.nil?
 
-            def setup_tasks
-                paperwork self.config["name"], sources: self.config["sources"]
-            end
+            raise Exception.new(
+                "No 'config' found in #{CONFIG_FILE}. You need to describe the build setup in a 'config' section first."
+            )
+        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
+        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

@@ -22,9 +22,7 @@ module Paperwork
 
             def tasks
                 file self.name => self.dependencies do
-                    unless File.exist?(self.name)
-                        ln self.source, self.name
-                    end
+                    cp self.source, self.name
                 end
             end
         end

data/lib/paperwork/tasks/document.rb

@@ -5,21 +5,24 @@ module Paperwork
     # task generators for building with middleman
     module Tasks
         require "rake"
+        require "listen"
 
         ##
         # main task generator for building the document
         #
         class Document < Paperwork::Tasks::Base # rubocop:disable Metrics/ClassLength
-            attr_reader :dir
+            attr_reader :dir, :sources_map
 
             include Rake::DSL
 
             def initialize(name, sources, *dependencies)
                 @dir = Paperwork::Tasks::Template.new(name).dir
 
+                @sources_map = {}
                 sources.each do |src|
                     dst = get_destination(File.join(self.dir, "source"), src)
                     BuildFile.new(dst, src)
+                    sources_map[src] = dst
                     dependencies << dst
                 end
 
@@ -68,17 +71,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")}"
@@ -109,30 +111,41 @@ module Paperwork
                         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
-                                    )
+                                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
+
+                            listen_to_sources
+
+                            Process.waitall
                         end
                     end
                 end
             end
+
+            def listen_to_sources
+                sources = {}
+                self.sources_map.each do |src, dst|
+                    sources[File.absolute_path(src)] = dst
+                end
+
+                ignore_list = [/#{Paperwork::Config[:build_root]}/]
+                Listen.to(Dir.pwd, ignore: ignore_list) do |modified, added, removed|
+                    (modified + added + removed).each do |src|
+                        dst = sources[src]
+                        unless dst.nil?
+                            puts "## updating #{src}"
+                            FileUtils.cp src, dst
+                        end
+                    end
+                end.start
+            end
         end
     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.3.0"
+    VERSION = "0.3.5"
 end

data/paperwork.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "rubocop", "~> 0.87.1"
     spec.add_development_dependency "simplecov", "~> 0.18.5"
 
+    spec.add_runtime_dependency "listen", "~> 3.4.1"
     spec.add_runtime_dependency "rake", "~> 12.3"
     spec.add_runtime_dependency "redcarpet", "~> 3.5.0"
     spec.add_runtime_dependency "thor", "~> 1.1.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Tobias Schmid
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,9 +140,7 @@ description:
 email:
 - couchbelag@gmail.com
 executables:
-- console
 - paperwork
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -142,9 +154,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
 - bin/paperwork
-- bin/setup
 - custom.css
 - custom.js
 - lib/paperwork.rb

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