contentfs 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a9b603b9239b87457c9783f5908964a92e42d2962ad28cbcec82f67520f9a2
-  data.tar.gz: 97852ac7a01d5d050427a4b0e0e3a0687d794365dccee532bd3737a66f823517
+  metadata.gz: 82208eb59ae04f8483de860c59b496e0bfe47488c6693ee80b2517bb69c37619
+  data.tar.gz: '0685aaaf67a70ee5f713015ffc1312b8554598e7153d8427d957b8785007b312'
 SHA512:
-  metadata.gz: 4622e5fe7621c3a5b13d9a54c2f7af22d5129a04e182a2da57cbd73e678a1aa1613c7abc45559182ed74b4d8afd497b8200395bbc28f0eeb5907856f77d415a3
-  data.tar.gz: 999012506f5131e5448b4d8e4c665bd93a7d9dfb2b09043095b5c7b8e2cc98d4c6c7bc87d4c34559151f87bddd8600d357a09512ca1ca546feaf8627f5fec0c2
+  metadata.gz: 89f9d947f2bff284a260b10da2207d0305f85ee8df746078dd8aa57c23c70314580b04472235818e9fb9acd24e745d0f0995e03a47a3e1dd12282eb2be3765fd
+  data.tar.gz: 890b635054dbe37744334035bf495205bf97a4aebe4acdea70ac0e4c9572d5103ff5b98994cfae633f5d62ae5c52351293aea311707edcdc1b3b568af9e74026

data/CHANGELOG.md

@@ -1,12 +1,42 @@
-## v0.1.1
+## [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*
 
+  * `fix` [#7](https://github.com/metabahn/contentfs/pull/7) Order content and databases by prefix or slug ([bryanp](https://github.com/bryanp))
+
+## [v0.2.0](https://github.com/metabahn/contentfs/releases/tag/v0.2.0)
+
+*released on 2020-11-14*
+
+  * `add` [#6](https://github.com/metabahn/contentfs/pull/6) Expose database metadata ([bryanp](https://github.com/bryanp))
+
+## [v0.1.1](https://github.com/metabahn/contentfs/releases/tag/v0.1.1)
+
+*released on 2020-11-13*
+
   * `fix` [#5](https://github.com/metabahn/contentfs/pull/5) Remove front-matter from content ([bryanp](https://github.com/bryanp))
 
-## v0.1.0
+## [v0.1.0](https://github.com/metabahn/contentfs/releases/tag/v0.1.0)
 
-*unreleased*
+*released on 2020-11-12*
 
   * `add` [#4](https://github.com/metabahn/contentfs/pull/4) Expose namespaces for databases and content ([bryanp](https://github.com/bryanp))
   * `add` [#3](https://github.com/metabahn/contentfs/pull/3) Introduce `Database#nested` for iterating over databases ([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/lib/contentfs/content.rb

@@ -12,24 +12,26 @@ module ContentFS
   #
   class Content
     class << self
-      def load(path, metadata: {}, namespace: [])
-        new(path: path, metadata: metadata, namespace: namespace)
+      def load(path, database:, metadata: {}, namespace: [])
+        new(path: path, database: database, metadata: metadata, namespace: namespace)
       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: [])
       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
       @metadata = metadata.merge(parse_metadata(content))
@@ -41,8 +43,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,23 +11,22 @@ 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)
+        new(path: path, parent: parent, namespace: namespace, root: root)
       end
     end
 
     METADATA_FILE = "_metadata.yml"
 
-    attr_reader :prefix, :slug, :namespace
+    attr_reader :prefix, :slug, :namespace, :metadata
 
-    def initialize(path:, namespace: [], root: false)
+    def initialize(path:, parent: nil, namespace: [], root: false)
       path = Pathname.new(path)
       name = path.basename(path.extname)
       prefix, remainder = Prefix.build(name)
       @prefix = prefix
-      @children = {}
-      @nested = {}
       @namespace = namespace.dup
+      @parent = parent
 
       unless root
         @slug = Slug.build(remainder)
@@ -36,28 +35,54 @@ module ContentFS
 
       metadata_path = path.join(METADATA_FILE)
 
-      metadata = if metadata_path.exist?
+      @metadata = if metadata_path.exist?
         YAML.safe_load(metadata_path.read).to_h
       else
         {}
       end
 
+      content_path = path.join.glob("_content.*")[0]
+
+      @content = if content_path&.exist?
+        Content.load(content_path, database: self, metadata: @metadata, namespace: @namespace)
+      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)
-          @nested[database.slug] = database
+          database = Database.load(path, parent: self, namespace: @namespace, root: false)
+          nested[database.slug] = database
+        elsif underscored
+          content = Content.load(path, database: self, metadata: @metadata, namespace: @namespace)
+
+          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)
 
-          if content.slug == :content
-            @content = content
-          else
-            @children[content.slug] = content
-          end
+          children[content.slug] = content
         end
       end
+
+      @children = Hash[
+        children.sort_by { |key, content|
+          (content.prefix || content.slug).to_s
+        }
+      ]
+
+      @nested = Hash[
+        nested.sort_by { |key, database|
+          (database.prefix || database.slug).to_s
+        }
+      ]
+
+      @includes = Hash[
+        includes.sort_by { |key, content|
+          (content.prefix || content.slug).to_s
+        }
+      ]
     end
 
     def content
@@ -100,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,27 @@ 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)
+            Rouge::Formatters::HTML.new.format(Rouge::Lexer.find(language).lex(source))
+          end
         end
       end
     end

data/lib/contentfs/version.rb

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

metadata

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