contentfs 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e66ff05acd68a19366aae10bfc7c25e0a97c00a498f4654c20e825f4e84a7a2
-  data.tar.gz: 5da2c74e38cc0a0a05fe3fa942d1c1855bebf41fb8e2e643630d490e2c8241c0
+  metadata.gz: 44c0630662c386eee30711ce48061817fecc4d20b619d524b2496811472062a4
+  data.tar.gz: b605d224de8a8662cedfa5df0404206b6f5b05d66616954d1e781a1c0845dec6
 SHA512:
-  metadata.gz: 5a3a49083b8935a1807b74166430cd3e18a130ba04e948703047a323c5de405c491482bd155fe6ed2f84ac4d1a040fb0e66aee2d76f10956ddb86b84385727f1
-  data.tar.gz: 7d1ddf1d6454d2a2457bbc4a3bf771b56bcf024f19244edb744f92b9953e81f0fe0fc72a3a08e7e206740a58015858d103fffe01696e31710a55d4a803a07838
+  metadata.gz: f6fe40b8bbb1b4f05cd85b4bca5d5535b2cbe73886e679153e02a510a62d3bbe113ac5caa8b8c41b3f77b9c2331b2ff8f2b615a8aae507119394b9cdae3bb232
+  data.tar.gz: 50fe653eb6e89011b9ce39021c04e67c26e7037043b536c9776d03f7fc1212621b93a3663785c01e06897346f7d09a67e67ef2fdd9bb043e734fca723e08cc1a

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [v0.6.2](https://github.com/metabahn/contentfs/releases/tag/v0.6.2)
+
+*released on 2021-04-05*
+
+  * `fix` [#14](https://github.com/metabahn/contentfs/pull/14) Load metadata for root content ([bryanp](https://github.com/bryanp))
+
+## [v0.6.1](https://github.com/metabahn/contentfs/releases/tag/v0.6.1)
+
+*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*

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,8 +12,8 @@ module ContentFS
   #
   class Content
     class << self
-      def load(path, database:, metadata: {}, namespace: [])
-        new(path: path, database: database, metadata: metadata, namespace: namespace)
+      def load(path, database:, metadata: {}, namespace: [], &block)
+        new(path: path, database: database, metadata: metadata, namespace: namespace, &block)
       end
     end
 
@@ -22,7 +22,7 @@ module ContentFS
 
     attr_reader :format, :prefix, :slug, :metadata, :namespace
 
-    def initialize(path:, database:, metadata: {}, namespace: [])
+    def initialize(path:, database:, metadata: {}, namespace: [], &block)
       path = Pathname.new(path)
       extname = path.extname
       name = path.basename(extname)
@@ -34,6 +34,7 @@ module ContentFS
       @database = database
 
       content = path.read
+      content = block.call(content) if block
       @metadata = metadata.merge(parse_metadata(content))
       @content = content.gsub(FRONT_MATTER_REGEXP, "")
     end
@@ -43,19 +44,23 @@ module ContentFS
     end
 
     def render
-      working_content = @content.dup
+      if @format && (renderer = Renderers.resolve(@format))
+        resolve_includes(renderer.render(@content))
+      else
+        resolve_includes(to_s)
+      end
+    end
 
-      @content.scan(INCLUDE_REGEXP).each do |match|
+    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
 
-      if @format && (renderer = Renderers.resolve(@format))
-        renderer.render(working_content)
-      else
-        to_s
-      end
+      working_content
     end
 
     private def parse_metadata(content)

data/lib/contentfs/database.rb

@@ -11,8 +11,8 @@ module ContentFS
   #
   class Database
     class << self
-      def load(path, parent: nil, namespace: [], root: true)
-        new(path: path, parent: parent, 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,7 +20,7 @@ module ContentFS
 
     attr_reader :prefix, :slug, :namespace, :metadata
 
-    def initialize(path:, parent: nil, 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)
@@ -43,8 +43,9 @@ module ContentFS
 
       content_path = path.join.glob("_content.*")[0]
 
-      @content = if content_path&.exist?
-        Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace)
+      if content_path&.exist?
+        @content = Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace, &block)
+        @metadata = @content.metadata.dup
       end
 
       children, nested, includes = {}, {}, {}
@@ -53,14 +54,14 @@ module ContentFS
         next if underscored && path.directory?
 
         if path.directory?
-          database = Database.load(path, parent: self, 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)
+          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, database: self, metadata: @metadata, namespace: @namespace)
+          content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace, &block)
 
           children[content.slug] = content
         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.4.0"
+  VERSION = "0.6.2"
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentfs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies: []
 description: A structured content file system.
 email: bryan@metabahn.com