contentfs 0.3.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5386e4d1a1ef23527ec457ecb544d4d36d02e44811fe81f87db93f4188d82145
-  data.tar.gz: f44614daf6d97aabd4d83a0e2339dd8d20e19d742b8b8403c37fc2967dd40925
+  metadata.gz: 77679e7cfe4c3077753ec0b425edec31318c17272070713a4831f80b6878de3e
+  data.tar.gz: b07a87ccbfa7e5adcfbd193076af48ed7109b0240224c68e640c2189058c41c0
 SHA512:
-  metadata.gz: 39ee593b9c158d2093d5a8bc59a8d8510adb8a206d4b786a0465347e79f12323806765be999be8ad7fd14bccb4e32134696c1f851fa466a1a515d3b44d7ecc63
-  data.tar.gz: f1ab2b7a9cc994b5d91cef392fa8d4a4c1bedaac69428ceb9552143b7f969391ec32a16ae1240c66da616a80440945bfae9f8a30e010bcd47f2f36f7aa89e3ef
+  metadata.gz: 97667d012f6b9b94dfdf74281ce53bf47966b7bf2da4e375c6d433ef7917f6f906ea5e7497424aaac2bb95fd65ab8149c8d429749a14cc5389b8fd1e2b0d7deb
+  data.tar.gz: 65baae29aa627cb17ec18e657955dca9caad84eacff8a3ff2ce0c85696eeeb235820f3975a76dc66610c706605c2a892c64420ad775a977f1b0eef2a8c238fe6

data/CHANGELOG.md

@@ -1,6 +1,36 @@
-## v0.3.0
+## [v0.6.1](https://github.com/metabahn/contentfs/releases/tag/v0.6.1)
 
-*unreleased*
+*released on 2021-04-02*
+
+  * `fix` [#13](https://github.com/metabahn/contentfs/pull/13) Resolve includes after rendering ([bryanp](https://github.com/bryanp))
+
+## [v0.6.0](https://github.com/metabahn/contentfs/releases/tag/v0.6.0)
+
+*released on 2021-04-02*
+
+  * `add` [#12](https://github.com/metabahn/contentfs/pull/12) Provide a pattern for preprocessing content ([bryanp](https://github.com/bryanp))
+
+## [v0.5.1](https://github.com/metabahn/contentfs/releases/tag/v0.5.1)
+
+*released on 2021-04-02*
+
+  * `fix` [#11](https://github.com/metabahn/contentfs/pull/11) Handle code blocks with no available lexer ([bryanp](https://github.com/bryanp))
+
+## [v0.5.0](https://github.com/metabahn/contentfs/releases/tag/v0.5.0)
+
+*released on 2021-04-01*
+
+  * `chg` [#10](https://github.com/metabahn/contentfs/pull/10) Replace redcarpet with cmark ([bryanp](https://github.com/bryanp))
+
+## [v0.4.0](https://github.com/metabahn/contentfs/releases/tag/v0.4.0)
+
+*released on 2021-04-01*
+
+  * `add` [#9](https://github.com/metabahn/contentfs/pull/9) Includes ([bryanp](https://github.com/bryanp))
+
+## [v0.3.0](https://github.com/metabahn/contentfs/releases/tag/v0.3.0)
+
+*released on 2020-11-18*
 
   * `chg` [#8](https://github.com/metabahn/contentfs/pull/8) Load database content from _content to avoid collisions ([bryanp](https://github.com/bryanp))
 

data/LICENSE

@@ -1,6 +1,6 @@
 This software is licensed under the MIT License.
 
-Copyright 2020 Metabahn.
+Copyright 2020-2021 Metabahn.
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the

data/README.md

@@ -40,7 +40,7 @@ The `content` name is special in that it defines content for the containing fold
 
 ### Formats
 
-Markdown is supported by default. Simply add the `redcarpet` gem to your project's `Gemfile`. For automatic syntax highlighting, add the `rouge` to your `Gemfile` as well.
+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.
 
 Unknown formats default to plain text.
 

data/lib/contentfs/content.rb

@@ -12,26 +12,29 @@ module ContentFS
   #
   class Content
     class << self
-      def load(path, metadata: {}, namespace: [])
-        new(path: path, metadata: metadata, namespace: namespace)
+      def load(path, database:, metadata: {}, namespace: [], &block)
+        new(path: path, database: database, metadata: metadata, namespace: namespace, &block)
       end
     end
 
     FRONT_MATTER_REGEXP = /\A---\s*\n(.*?\n?)^---\s*$\n?/m
+    INCLUDE_REGEXP = /<!-- @include\s*([a-zA-Z0-9\-_\/.]*) -->/
 
     attr_reader :format, :prefix, :slug, :metadata, :namespace
 
-    def initialize(path:, metadata: {}, namespace: [])
+    def initialize(path:, database:, metadata: {}, namespace: [], &block)
       path = Pathname.new(path)
       extname = path.extname
       name = path.basename(extname)
       prefix, remainder = Prefix.build(name)
       @prefix = prefix
-      @format = extname.to_s[1..-1]&.to_sym
+      @format = extname.to_s[1..]&.to_sym
       @slug = Slug.build(remainder)
       @namespace = namespace.dup << @slug
+      @database = database
 
       content = path.read
+      content = block.call(content) if block
       @metadata = metadata.merge(parse_metadata(content))
       @content = content.gsub(FRONT_MATTER_REGEXP, "")
     end
@@ -42,12 +45,24 @@ module ContentFS
 
     def render
       if @format && (renderer = Renderers.resolve(@format))
-        renderer.render(@content)
+        resolve_includes(renderer.render(@content))
       else
-        to_s
+        resolve_includes(to_s)
       end
     end
 
+    private def resolve_includes(content)
+      working_content = content.dup
+
+      content.scan(INCLUDE_REGEXP) do |match|
+        if (include = @database.find_include(match[0]))
+          working_content.gsub!($~.to_s, include.render)
+        end
+      end
+
+      working_content
+    end
+
     private def parse_metadata(content)
       if (match = content.match(FRONT_MATTER_REGEXP))
         YAML.safe_load(match.captures[0]).to_h

data/lib/contentfs/database.rb

@@ -11,8 +11,8 @@ module ContentFS
   #
   class Database
     class << self
-      def load(path, namespace: [], root: true)
-        new(path: path, namespace: namespace, root: root)
+      def load(path, parent: nil, namespace: [], root: true, &block)
+        new(path: path, parent: parent, namespace: namespace, root: root, &block)
       end
     end
 
@@ -20,12 +20,13 @@ module ContentFS
 
     attr_reader :prefix, :slug, :namespace, :metadata
 
-    def initialize(path:, namespace: [], root: false)
+    def initialize(path:, parent: nil, namespace: [], root: false, &block)
       path = Pathname.new(path)
       name = path.basename(path.extname)
       prefix, remainder = Prefix.build(name)
       @prefix = prefix
       @namespace = namespace.dup
+      @parent = parent
 
       unless root
         @slug = Slug.build(remainder)
@@ -43,18 +44,23 @@ module ContentFS
       content_path = path.join.glob("_content.*")[0]
 
       @content = if content_path&.exist?
-        Content.load(content_path, metadata: @metadata, namespace: @namespace)
+        Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace, &block)
       end
 
-      children, nested = {}, {}
+      children, nested, includes = {}, {}, {}
       Pathname.new(path).glob("*") do |path|
-        next if path.basename.to_s.start_with?("_")
+        underscored = path.basename.to_s.start_with?("_")
+        next if underscored && path.directory?
 
         if path.directory?
-          database = Database.load(path, namespace: @namespace, root: false)
+          database = Database.load(path, parent: self, namespace: @namespace, root: false, &block)
           nested[database.slug] = database
+        elsif underscored
+          content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace, &block)
+
+          includes[content.slug.to_s[1..].to_sym] = content
         else
-          content = Content.load(path, metadata: @metadata, namespace: @namespace)
+          content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace, &block)
 
           children[content.slug] = content
         end
@@ -71,6 +77,12 @@ module ContentFS
           (database.prefix || database.slug).to_s
         }
       ]
+
+      @includes = Hash[
+        includes.sort_by { |key, content|
+          (content.prefix || content.slug).to_s
+        }
+      ]
     end
 
     def content
@@ -113,6 +125,35 @@ module ContentFS
       end
     end
 
+    def find_include(path)
+      @includes[path.to_sym] || find_child_include(path) || find_parent_include(path) || find_include_from_toplevel(path)
+    end
+
+    def toplevel
+      @parent ? @parent.toplevel : self
+    end
+
+    private def find_child_include(path)
+      return unless path.include?("/")
+
+      path_parts = path.split("/", 2)
+      @nested[path_parts[0].to_sym]&.find_include(path_parts[1])
+    end
+
+    private def find_parent_include(path)
+      return if @parent.nil?
+      return unless path.start_with?("../")
+
+      path_parts = path.split("../", 2)
+      @parent.find_include(path_parts[1])
+    end
+
+    private def find_include_from_toplevel(path)
+      return if @parent.nil?
+
+      toplevel.find_include(path)
+    end
+
     def to_s
       @content&.to_s.to_s
     end

data/lib/contentfs/renderers/markdown.rb

@@ -1,39 +1,14 @@
 # frozen_string_literal: true
 
-require "redcarpet"
+require "commonmarker"
 
 module ContentFS
   module Renderers
     # @api private
     class Markdown
       class << self
-        OPTIONS = {
-          autolink: true,
-          footnotes: true,
-          fenced_code_blocks: true,
-          tables: true
-        }.freeze
-
         def render(content)
-          renderer.render(content)
-        end
-
-        def options
-          OPTIONS
-        end
-
-        private def renderer
-          @_renderer ||= Redcarpet::Markdown.new(Renderer, options)
-        end
-      end
-
-      class Renderer < Redcarpet::Render::HTML
-        def block_quote(quote)
-          if (match = quote.match(/<p>\[(.*)\]/))
-            %(<blockquote class="#{match[1]}">#{quote.gsub("[#{match[1]}]", "")}</blockquote>)
-          else
-            super
-          end
+          CommonMarker.render_html(content, [:DEFAULT, :UNSAFE])
         end
       end
     end

data/lib/contentfs/renderers/markdown/code.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rouge"
-require "rouge/plugins/redcarpet"
 
 require_relative "../markdown"
 
@@ -12,16 +11,31 @@ module ContentFS
       class Code
         class << self
           def render(content)
-            renderer.render(content)
+            renderer.render(CommonMarker.render_doc(content))
           end
 
           private def renderer
-            @_renderer ||= Redcarpet::Markdown.new(Renderer, Markdown.options)
+            SyntaxRenderer.new(options: [:DEFAULT, :UNSAFE])
           end
         end
 
-        class Renderer < Markdown::Renderer
-          include Rouge::Plugins::Redcarpet
+        class SyntaxRenderer < CommonMarker::HtmlRenderer
+          def code_block(node)
+            block do
+              language = node.fence_info.split(/\s+/)[0]
+              out("<div class=\"highlight\"><pre class=\"highlight #{language}\"><code>")
+              out(syntax_highlight(node.string_content, language))
+              out('</code></pre></div>')
+            end
+          end
+
+          private def syntax_highlight(source, language)
+            if (lexer = Rouge::Lexer.find(language))
+              Rouge::Formatters::HTML.new.format(lexer.lex(source))
+            else
+              source
+            end
+          end
         end
       end
     end

data/lib/contentfs/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ContentFS
-  VERSION = "0.3.0"
+  VERSION = "0.6.1"
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentfs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies: []
 description: A structured content file system.
 email: bryan@metabahn.com
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: A structured content file system.