paperwork 0.2.0 → 0.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a6ca73b108fa2e53bfc6882abb4e1dfd84c34e58d4306bc29a4ec54ae0b55a28
4
- data.tar.gz: 75c019845942a4b8596fc04e7c7b8cdc22198dd8fad7b94918e2c4a93cbac3f0
3
+ metadata.gz: 1955714ea9b28ec4ec30953e9bb6d9fdde843dc6b07b1e845250272e06d231ce
4
+ data.tar.gz: f173804ede9bd1280bd724867b34aac75cae1d48e9ef13735e0ca5957185dcf3
5
5
  SHA512:
6
- metadata.gz: bc72644eaa74956c6360083a90450f127df96ebcd15742ca5e63f50a16c4c7cbf43bdd105264610df53ca6362b682af52c217e65cfd717a67a0acf4d82c97c29
7
- data.tar.gz: 5aeecba6354e787619122d7fbb977e4025bc902ee28b5f1d6cdd4d32e4c1cc218b4d85f1c13c856d461c1862219e7cbe2cab0bb0f83654d28d50429942a6a1be
6
+ metadata.gz: 2a5f3811fbbe9c7f8a48e120f83e4dad99a5e48ea15489d183a64d627f1ecdf210734e08f764c559298df7f832affc1e232e17f65cded172f59d9111a4ffc90f
7
+ data.tar.gz: 0fbb45795dcfa953c0e9479e0a8c135e799a6fbb41f26cd59471d7e0a5a6fb083832bb6082d8881fc2f1368e302425209b7d6170b4ee98c537825f37cd28326f
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- paperwork (0.2.0)
4
+ paperwork (0.2.5)
5
5
  rake (~> 12.3)
6
6
  redcarpet (~> 3.5.0)
7
7
 
data/Rakefile CHANGED
@@ -13,4 +13,4 @@ task rebuild: [:clean, :build]
13
13
  task default: :spec
14
14
  CLEAN.include(".work/coverage")
15
15
 
16
- paperwork :doc, sources: ["README.md", "navdemo.md", "site.yml", "custom.js", "custom.css"]
16
+ paperwork :doc, sources: ["README.md", "nested_example/navdemo.md", "site.yml", "custom.js", "custom.css"]
@@ -17,7 +17,7 @@ module Paperwork
17
17
  dependencies = []
18
18
  if task.nil?
19
19
  task = options.keys.first
20
- dependencies = options.delete(ntaskame)
20
+ dependencies = options.delete(task)
21
21
  end
22
22
  doc = Paperwork::Tasks::Document.new(task, sources, *dependencies)
23
23
  doc.create_tasks
@@ -35,18 +35,25 @@ module Paperwork
35
35
  private
36
36
 
37
37
  def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize
38
+ nested_base = File.dirname(src)
39
+ if nested_base == "."
40
+ nested_base = dst_base
41
+ else
42
+ nested_base = File.join(dst_base, nested_base)
43
+ end
44
+
38
45
  ext = File.extname(src)
39
46
  case ext
40
47
  when ".md"
41
- File.join(dst_base, File.basename(src)).gsub(".md", ".html.md")
48
+ File.join(nested_base, File.basename(src)).gsub(".md", ".html.md")
42
49
  when ".scss"
43
- Paperwork::Config[:custom_css] << File.basename(src)
50
+ Paperwork::Config[:custom_css] << File.basename(src, ext)
44
51
  File.join(dst_base, "stylesheets", File.basename(src)).gsub(".scss", ".css.scss")
45
52
  when ".css"
46
- Paperwork::Config[:custom_css] << File.basename(src)
53
+ Paperwork::Config[:custom_css] << File.basename(src, ext)
47
54
  File.join(dst_base, "stylesheets", File.basename(src))
48
55
  when ".js"
49
- Paperwork::Config[:custom_js] << File.basename(src)
56
+ Paperwork::Config[:custom_js] << File.basename(src, ext)
50
57
  File.join(dst_base, "javascripts", File.basename(src))
51
58
  when ".yml"
52
59
  File.join(dst_base, "..", "data", File.basename(src))
@@ -50,7 +50,6 @@ set :relative_links, true
50
50
  activate :relative_assets
51
51
  activate :livereload
52
52
  activate :syntax, line_numbers: true
53
- # activate :directory_indexes
54
53
 
55
54
 
56
55
  require "lib/doc_renderer"
@@ -6,10 +6,12 @@
6
6
  #
7
7
  module DocRenderer
8
8
  require "middleman-core/renderers/redcarpet"
9
+ require_relative "info_helpers"
9
10
 
10
11
  # This is a basic renderer for transforming markdown to HTML
11
12
  # inherit from this renderer to create more specific variants
12
13
  class Base < Middleman::Renderers::MiddlemanRedcarpetHTML
14
+ include InfoHelpers
13
15
 
14
16
  # block level calls
15
17
  def block_code(code, language)
@@ -79,11 +81,12 @@ module DocRenderer
79
81
  # def emphasis(text)
80
82
  # end
81
83
 
82
- # def image(link, title, alt_text, default_class: "img-fluid")
83
- # <<~IMG
84
- # <img src="#{link}" alt="#{alt_text}" class="#{default_class}">
85
- # IMG
86
- # end
84
+ def image(link, title, alt_text)
85
+ <<~IMG
86
+ <img src="#{relative_link link, scope.current_path}" alt="#{alt_text}" class="img-fluid">#{title}</img>
87
+ IMG
88
+ #super(relative_link(link, scope.current_path), title, alt_text)
89
+ end
87
90
 
88
91
  # def linebreak()
89
92
  # end
@@ -119,7 +122,7 @@ module DocRenderer
119
122
  private
120
123
 
121
124
  def definition_list(text)
122
- str = ""
125
+ str = String.new
123
126
  re = /^[^:].*?(?:\R: .*)+/
124
127
  text.scan(re) do |match|
125
128
  list = match.split(":")
@@ -20,6 +20,21 @@ module InfoHelpers
20
20
  end
21
21
  end
22
22
 
23
+ def relative_link(stringifyable, current_path=current_page.path)
24
+ relative = String.new
25
+ dots = current_path.split(/[\/\\]/).size - 1
26
+ dots.times{ relative += "../" }
27
+ # This has been some nasty part to debug...
28
+ # keep these comments for debugging session yet to come
29
+ # puts "##################################"
30
+ # puts "current_page.path: #{current_page.path}"
31
+ # puts "stringifyable: #{stringifyable.to_s}"
32
+ # puts "dots: #{dots}"
33
+ # puts "relative link: #{relative + stringifyable.to_s}"
34
+ # puts "##################################"
35
+ relative + stringifyable.to_s
36
+ end
37
+
23
38
  def site?
24
39
  data.respond_to?(:site)
25
40
  end
@@ -30,7 +45,12 @@ module InfoHelpers
30
45
 
31
46
  def navbar_links
32
47
  nav = data.site.navbar.links if navbar?
33
- nav || {}
48
+ nav ||= {}
49
+ mapped = {}
50
+ nav.each do |name, link|
51
+ mapped[name] = relative_link(link)
52
+ end
53
+ mapped
34
54
  end
35
55
 
36
56
  def navbar_brand
@@ -33,7 +33,7 @@ module Paperwork
33
33
  <<~ROOT_HELPERS
34
34
  module RootHelpers
35
35
  def root_path
36
- "#{self.root}"
36
+ relative_link "#{self.root}"
37
37
  end
38
38
 
39
39
  def custom_css
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Paperwork
4
- VERSION = "0.2.0"
4
+ VERSION = "0.2.5"
5
5
  end
@@ -3,3 +3,6 @@ title: Linked
3
3
  ---
4
4
 
5
5
  # just a linked page for demonstrating navbar links
6
+
7
+
8
+ [Back...](../README.md)
data/site.yml CHANGED
@@ -4,4 +4,4 @@ navbar:
4
4
  brand: paperwork
5
5
  links:
6
6
  Home: README.md
7
- Navbar Demo: navdemo.md
7
+ Navbar Demo: nested_example/navdemo.md
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: paperwork
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tobias Schmid
@@ -161,7 +161,7 @@ files:
161
161
  - lib/paperwork/tasks/root_helpers.rb
162
162
  - lib/paperwork/tasks/template.rb
163
163
  - lib/paperwork/version.rb
164
- - navdemo.md
164
+ - nested_example/navdemo.md
165
165
  - paperwork.gemspec
166
166
  - site.yml
167
167
  homepage: https://gitlab.com/couchbelag/paperwork