paperwork 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2e693dd5bb169466f35243976c240df90b650c5a026b958fb2ad359362b97da
-  data.tar.gz: 47d925596e691ea695051d32196b20d2f1f4af1bd4cbf52c828090c7904da41e
+  metadata.gz: f13203b1fabe9808e33e1cdaea4ba2c92d738daa94ffa1d22117af9057e76d6b
+  data.tar.gz: d4349a96f701e92591eabdc19abf1316b72ba88b876cd518ce9b58ea705aeecf
 SHA512:
-  metadata.gz: 7743a376ef7a4cbacc04d71770622c4363a503a2396ec6135522b8fe266ecd774913c10af0c46bb561c68c454138daf90e71a8f1fcd2b15c1f554f08abc8f642
-  data.tar.gz: 8d428a9773633ade5b13b79ed1f7d5e98cdd1f480b85a3370d22e36c48c5735155ac240c459c1f25816cf960c26708eaaf1220600021af838bdd7e8e9225df50
+  metadata.gz: '009b8503df60c1e652123084e5c51ec935e1daf996d7e7002b24f63a163a1fab9b5059d3e76b2c1f30d7489db70192dc157346a08f33d904d2fafd66ec4fe161'
+  data.tar.gz: 9cee87ec48e8587f19332f5fd5c5bb4b675199ffe5ec529582123a13c1b9dd46e0a3a7f4794f1347d36e3cfdb23986b17cdeb78951b4bb9970c984f747100392

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    paperwork (0.3.4)
+    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/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
 
@@ -116,22 +119,33 @@ module Paperwork
                                 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/version.rb

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