contentfs 0.2.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e31d3c4cb4c0ffab42607cb9f3c4cc156707a66b399fc03f9ea499940cb95ccf
-  data.tar.gz: 5fa367925ffaa833aa5aeba306865fe85132cb8ad72e0b4772640714e18433de
+  metadata.gz: 70692d20be1e5c1f76afe4397718ceadc6c71a3457c2e408ba35ae0e11d40611
+  data.tar.gz: cddc23e982270efde7b2e0e9102b9d44ec71e2bd5c2863a98904b104ce1d9261
 SHA512:
-  metadata.gz: 72bdcb70dd4901bf9a20a3ac3f21aefb36b74d1b9af55e16204376a001bdb27e259b04d4cccc5082f3a737f92ea844aa9c8b4941420282526df8cb627ef0b0eb
-  data.tar.gz: c4af486c19311a43f14d328c65094a3a8106e9d82004fb59efc7105c66d5324ea88f3afa90b59db3ce6d61496d120b4b0f7b61b76ed70998592186d5c7849c6c
+  metadata.gz: 4677403196321b02096ea81e982e5499602b7f333cf826780fd407634b81da37b625fa1a0c1bbeb51c14dcb67dcc1cfbdc6fa6078394411464de3d8d1c12a9f7
+  data.tar.gz: b6caaa759c1ea97d5ab945327b2dee30ba8930431cbe74bc79a3a6aad1bf8fe8bb3b7f830d7cbafc6d95c89213adb0468687589677ce92787a1d27467b0898df

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [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))
+
 ## v0.2.1
 
 *unreleased*

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
@@ -41,8 +44,16 @@ module ContentFS
     end
 
     def render
+      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(@content)
+        renderer.render(working_content)
       else
         to_s
       end

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)
@@ -40,21 +41,28 @@ module ContentFS
         {}
       end
 
-      children, nested = {}, {}
+      content_path = path.join.glob("_content.*")[0]
+
+      @content = if content_path&.exist?
+        Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace, &block)
+      end
+
+      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)
 
-          if content.slug == :content
-            @content = content
-          else
-            children[content.slug] = content
-          end
+          children[content.slug] = content
         end
       end
 
@@ -69,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
@@ -111,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.2.1"
+  VERSION = "0.6.0"
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentfs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-16 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.