contentfs 0.2.1 → 0.6.0
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 +4 -4
- data/CHANGELOG.md +30 -0
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/lib/contentfs/content.rb +16 -5
- data/lib/contentfs/database.rb +55 -12
- data/lib/contentfs/renderers/markdown.rb +2 -27
- data/lib/contentfs/renderers/markdown/code.rb +19 -5
- data/lib/contentfs/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 70692d20be1e5c1f76afe4397718ceadc6c71a3457c2e408ba35ae0e11d40611
|
4
|
+
data.tar.gz: cddc23e982270efde7b2e0e9102b9d44ec71e2bd5c2863a98904b104ce1d9261
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4677403196321b02096ea81e982e5499602b7f333cf826780fd407634b81da37b625fa1a0c1bbeb51c14dcb67dcc1cfbdc6fa6078394411464de3d8d1c12a9f7
|
7
|
+
data.tar.gz: b6caaa759c1ea97d5ab945327b2dee30ba8930431cbe74bc79a3a6aad1bf8fe8bb3b7f830d7cbafc6d95c89213adb0468687589677ce92787a1d27467b0898df
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,33 @@
|
|
1
|
+
## [v0.6.0](https://github.com/metabahn/contentfs/releases/tag/v0.6.0)
|
2
|
+
|
3
|
+
*released on 2021-04-02*
|
4
|
+
|
5
|
+
* `add` [#12](https://github.com/metabahn/contentfs/pull/12) Provide a pattern for preprocessing content ([bryanp](https://github.com/bryanp))
|
6
|
+
|
7
|
+
## [v0.5.1](https://github.com/metabahn/contentfs/releases/tag/v0.5.1)
|
8
|
+
|
9
|
+
*released on 2021-04-02*
|
10
|
+
|
11
|
+
* `fix` [#11](https://github.com/metabahn/contentfs/pull/11) Handle code blocks with no available lexer ([bryanp](https://github.com/bryanp))
|
12
|
+
|
13
|
+
## [v0.5.0](https://github.com/metabahn/contentfs/releases/tag/v0.5.0)
|
14
|
+
|
15
|
+
*released on 2021-04-01*
|
16
|
+
|
17
|
+
* `chg` [#10](https://github.com/metabahn/contentfs/pull/10) Replace redcarpet with cmark ([bryanp](https://github.com/bryanp))
|
18
|
+
|
19
|
+
## [v0.4.0](https://github.com/metabahn/contentfs/releases/tag/v0.4.0)
|
20
|
+
|
21
|
+
*released on 2021-04-01*
|
22
|
+
|
23
|
+
* `add` [#9](https://github.com/metabahn/contentfs/pull/9) Includes ([bryanp](https://github.com/bryanp))
|
24
|
+
|
25
|
+
## [v0.3.0](https://github.com/metabahn/contentfs/releases/tag/v0.3.0)
|
26
|
+
|
27
|
+
*released on 2020-11-18*
|
28
|
+
|
29
|
+
* `chg` [#8](https://github.com/metabahn/contentfs/pull/8) Load database content from _content to avoid collisions ([bryanp](https://github.com/bryanp))
|
30
|
+
|
1
31
|
## v0.2.1
|
2
32
|
|
3
33
|
*unreleased*
|
data/LICENSE
CHANGED
data/README.md
CHANGED
@@ -40,7 +40,7 @@ The `content` name is special in that it defines content for the containing fold
|
|
40
40
|
|
41
41
|
### Formats
|
42
42
|
|
43
|
-
Markdown is supported by default. Simply add the `
|
43
|
+
Markdown is supported by default. Simply add the `commonmarker` gem to your project's `Gemfile`. For automatic syntax highlighting, add the `rouge` to your `Gemfile` as well.
|
44
44
|
|
45
45
|
Unknown formats default to plain text.
|
46
46
|
|
data/lib/contentfs/content.rb
CHANGED
@@ -12,26 +12,29 @@ module ContentFS
|
|
12
12
|
#
|
13
13
|
class Content
|
14
14
|
class << self
|
15
|
-
def load(path, metadata: {}, namespace: [])
|
16
|
-
new(path: path, metadata: metadata, namespace: namespace)
|
15
|
+
def load(path, database:, metadata: {}, namespace: [], &block)
|
16
|
+
new(path: path, database: database, metadata: metadata, namespace: namespace, &block)
|
17
17
|
end
|
18
18
|
end
|
19
19
|
|
20
20
|
FRONT_MATTER_REGEXP = /\A---\s*\n(.*?\n?)^---\s*$\n?/m
|
21
|
+
INCLUDE_REGEXP = /<!-- @include\s*([a-zA-Z0-9\-_\/.]*) -->/
|
21
22
|
|
22
23
|
attr_reader :format, :prefix, :slug, :metadata, :namespace
|
23
24
|
|
24
|
-
def initialize(path:, metadata: {}, namespace: [])
|
25
|
+
def initialize(path:, database:, metadata: {}, namespace: [], &block)
|
25
26
|
path = Pathname.new(path)
|
26
27
|
extname = path.extname
|
27
28
|
name = path.basename(extname)
|
28
29
|
prefix, remainder = Prefix.build(name)
|
29
30
|
@prefix = prefix
|
30
|
-
@format = extname.to_s[1
|
31
|
+
@format = extname.to_s[1..]&.to_sym
|
31
32
|
@slug = Slug.build(remainder)
|
32
33
|
@namespace = namespace.dup << @slug
|
34
|
+
@database = database
|
33
35
|
|
34
36
|
content = path.read
|
37
|
+
content = block.call(content) if block
|
35
38
|
@metadata = metadata.merge(parse_metadata(content))
|
36
39
|
@content = content.gsub(FRONT_MATTER_REGEXP, "")
|
37
40
|
end
|
@@ -41,8 +44,16 @@ module ContentFS
|
|
41
44
|
end
|
42
45
|
|
43
46
|
def render
|
47
|
+
working_content = @content.dup
|
48
|
+
|
49
|
+
@content.scan(INCLUDE_REGEXP) do |match|
|
50
|
+
if (include = @database.find_include(match[0]))
|
51
|
+
working_content.gsub!($~.to_s, include.render)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
44
55
|
if @format && (renderer = Renderers.resolve(@format))
|
45
|
-
renderer.render(
|
56
|
+
renderer.render(working_content)
|
46
57
|
else
|
47
58
|
to_s
|
48
59
|
end
|
data/lib/contentfs/database.rb
CHANGED
@@ -11,8 +11,8 @@ module ContentFS
|
|
11
11
|
#
|
12
12
|
class Database
|
13
13
|
class << self
|
14
|
-
def load(path, namespace: [], root: true)
|
15
|
-
new(path: path, namespace: namespace, root: root)
|
14
|
+
def load(path, parent: nil, namespace: [], root: true, &block)
|
15
|
+
new(path: path, parent: parent, namespace: namespace, root: root, &block)
|
16
16
|
end
|
17
17
|
end
|
18
18
|
|
@@ -20,12 +20,13 @@ module ContentFS
|
|
20
20
|
|
21
21
|
attr_reader :prefix, :slug, :namespace, :metadata
|
22
22
|
|
23
|
-
def initialize(path:, namespace: [], root: false)
|
23
|
+
def initialize(path:, parent: nil, namespace: [], root: false, &block)
|
24
24
|
path = Pathname.new(path)
|
25
25
|
name = path.basename(path.extname)
|
26
26
|
prefix, remainder = Prefix.build(name)
|
27
27
|
@prefix = prefix
|
28
28
|
@namespace = namespace.dup
|
29
|
+
@parent = parent
|
29
30
|
|
30
31
|
unless root
|
31
32
|
@slug = Slug.build(remainder)
|
@@ -40,21 +41,28 @@ module ContentFS
|
|
40
41
|
{}
|
41
42
|
end
|
42
43
|
|
43
|
-
|
44
|
+
content_path = path.join.glob("_content.*")[0]
|
45
|
+
|
46
|
+
@content = if content_path&.exist?
|
47
|
+
Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace, &block)
|
48
|
+
end
|
49
|
+
|
50
|
+
children, nested, includes = {}, {}, {}
|
44
51
|
Pathname.new(path).glob("*") do |path|
|
45
|
-
|
52
|
+
underscored = path.basename.to_s.start_with?("_")
|
53
|
+
next if underscored && path.directory?
|
46
54
|
|
47
55
|
if path.directory?
|
48
|
-
database = Database.load(path, namespace: @namespace, root: false)
|
56
|
+
database = Database.load(path, parent: self, namespace: @namespace, root: false, &block)
|
49
57
|
nested[database.slug] = database
|
58
|
+
elsif underscored
|
59
|
+
content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace, &block)
|
60
|
+
|
61
|
+
includes[content.slug.to_s[1..].to_sym] = content
|
50
62
|
else
|
51
|
-
content = Content.load(path, metadata: @metadata, namespace: @namespace)
|
63
|
+
content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace, &block)
|
52
64
|
|
53
|
-
|
54
|
-
@content = content
|
55
|
-
else
|
56
|
-
children[content.slug] = content
|
57
|
-
end
|
65
|
+
children[content.slug] = content
|
58
66
|
end
|
59
67
|
end
|
60
68
|
|
@@ -69,6 +77,12 @@ module ContentFS
|
|
69
77
|
(database.prefix || database.slug).to_s
|
70
78
|
}
|
71
79
|
]
|
80
|
+
|
81
|
+
@includes = Hash[
|
82
|
+
includes.sort_by { |key, content|
|
83
|
+
(content.prefix || content.slug).to_s
|
84
|
+
}
|
85
|
+
]
|
72
86
|
end
|
73
87
|
|
74
88
|
def content
|
@@ -111,6 +125,35 @@ module ContentFS
|
|
111
125
|
end
|
112
126
|
end
|
113
127
|
|
128
|
+
def find_include(path)
|
129
|
+
@includes[path.to_sym] || find_child_include(path) || find_parent_include(path) || find_include_from_toplevel(path)
|
130
|
+
end
|
131
|
+
|
132
|
+
def toplevel
|
133
|
+
@parent ? @parent.toplevel : self
|
134
|
+
end
|
135
|
+
|
136
|
+
private def find_child_include(path)
|
137
|
+
return unless path.include?("/")
|
138
|
+
|
139
|
+
path_parts = path.split("/", 2)
|
140
|
+
@nested[path_parts[0].to_sym]&.find_include(path_parts[1])
|
141
|
+
end
|
142
|
+
|
143
|
+
private def find_parent_include(path)
|
144
|
+
return if @parent.nil?
|
145
|
+
return unless path.start_with?("../")
|
146
|
+
|
147
|
+
path_parts = path.split("../", 2)
|
148
|
+
@parent.find_include(path_parts[1])
|
149
|
+
end
|
150
|
+
|
151
|
+
private def find_include_from_toplevel(path)
|
152
|
+
return if @parent.nil?
|
153
|
+
|
154
|
+
toplevel.find_include(path)
|
155
|
+
end
|
156
|
+
|
114
157
|
def to_s
|
115
158
|
@content&.to_s.to_s
|
116
159
|
end
|
@@ -1,39 +1,14 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require "
|
3
|
+
require "commonmarker"
|
4
4
|
|
5
5
|
module ContentFS
|
6
6
|
module Renderers
|
7
7
|
# @api private
|
8
8
|
class Markdown
|
9
9
|
class << self
|
10
|
-
OPTIONS = {
|
11
|
-
autolink: true,
|
12
|
-
footnotes: true,
|
13
|
-
fenced_code_blocks: true,
|
14
|
-
tables: true
|
15
|
-
}.freeze
|
16
|
-
|
17
10
|
def render(content)
|
18
|
-
|
19
|
-
end
|
20
|
-
|
21
|
-
def options
|
22
|
-
OPTIONS
|
23
|
-
end
|
24
|
-
|
25
|
-
private def renderer
|
26
|
-
@_renderer ||= Redcarpet::Markdown.new(Renderer, options)
|
27
|
-
end
|
28
|
-
end
|
29
|
-
|
30
|
-
class Renderer < Redcarpet::Render::HTML
|
31
|
-
def block_quote(quote)
|
32
|
-
if (match = quote.match(/<p>\[(.*)\]/))
|
33
|
-
%(<blockquote class="#{match[1]}">#{quote.gsub("[#{match[1]}]", "")}</blockquote>)
|
34
|
-
else
|
35
|
-
super
|
36
|
-
end
|
11
|
+
CommonMarker.render_html(content, [:DEFAULT, :UNSAFE])
|
37
12
|
end
|
38
13
|
end
|
39
14
|
end
|
@@ -1,7 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require "rouge"
|
4
|
-
require "rouge/plugins/redcarpet"
|
5
4
|
|
6
5
|
require_relative "../markdown"
|
7
6
|
|
@@ -12,16 +11,31 @@ module ContentFS
|
|
12
11
|
class Code
|
13
12
|
class << self
|
14
13
|
def render(content)
|
15
|
-
renderer.render(content)
|
14
|
+
renderer.render(CommonMarker.render_doc(content))
|
16
15
|
end
|
17
16
|
|
18
17
|
private def renderer
|
19
|
-
|
18
|
+
SyntaxRenderer.new(options: [:DEFAULT, :UNSAFE])
|
20
19
|
end
|
21
20
|
end
|
22
21
|
|
23
|
-
class
|
24
|
-
|
22
|
+
class SyntaxRenderer < CommonMarker::HtmlRenderer
|
23
|
+
def code_block(node)
|
24
|
+
block do
|
25
|
+
language = node.fence_info.split(/\s+/)[0]
|
26
|
+
out("<div class=\"highlight\"><pre class=\"highlight #{language}\"><code>")
|
27
|
+
out(syntax_highlight(node.string_content, language))
|
28
|
+
out('</code></pre></div>')
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
private def syntax_highlight(source, language)
|
33
|
+
if (lexer = Rouge::Lexer.find(language))
|
34
|
+
Rouge::Formatters::HTML.new.format(lexer.lex(source))
|
35
|
+
else
|
36
|
+
source
|
37
|
+
end
|
38
|
+
end
|
25
39
|
end
|
26
40
|
end
|
27
41
|
end
|
data/lib/contentfs/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: contentfs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Bryan Powell
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-04-02 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: A structured content file system.
|
14
14
|
email: bryan@metabahn.com
|
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
47
47
|
- !ruby/object:Gem::Version
|
48
48
|
version: '0'
|
49
49
|
requirements: []
|
50
|
-
rubygems_version: 3.
|
50
|
+
rubygems_version: 3.2.4
|
51
51
|
signing_key:
|
52
52
|
specification_version: 4
|
53
53
|
summary: A structured content file system.
|