contentfs 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b815f957fcccb235ddec7a7cd90ae7392727a949e50883bbcf9425c4904b5fba
-  data.tar.gz: 0e20ede1a87ef3fa34f7755740489322039f760580406b44d35914fb6103aff2
+  metadata.gz: 9e66ff05acd68a19366aae10bfc7c25e0a97c00a498f4654c20e825f4e84a7a2
+  data.tar.gz: 5da2c74e38cc0a0a05fe3fa942d1c1855bebf41fb8e2e643630d490e2c8241c0
 SHA512:
-  metadata.gz: 36c32a237713fdd88a28ce5c6fe0770c0aefa0275e5d350f31a56a363976d83c72428ea6ab89e79645d1c28c0fbfc681704c0dd7856069efcbc7034546398168
-  data.tar.gz: a7abf1c49c7cdaadcdb855ed1a5965eb4f3f0623fa63f7a86b03ac72c1f0f2e05bc427d06c84dfcab75aa8323df93e983aba043ffb1c39594e0a1753cd7acfbc
+  metadata.gz: 5a3a49083b8935a1807b74166430cd3e18a130ba04e948703047a323c5de405c491482bd155fe6ed2f84ac4d1a040fb0e66aee2d76f10956ddb86b84385727f1
+  data.tar.gz: 7d1ddf1d6454d2a2457bbc4a3bf771b56bcf024f19244edb744f92b9953e81f0fe0fc72a3a08e7e206740a58015858d103fffe01696e31710a55d4a803a07838

data/CHANGELOG.md

@@ -1,6 +1,36 @@
-## v0.1.0
+## [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](https://github.com/metabahn/contentfs/releases/tag/v0.1.0)
+
+*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))
@@ -8,8 +38,8 @@
   * `add` [#1](https://github.com/metabahn/contentfs/pull/1) Introduce `Database#find` for safer traversal ([bryanp](https://github.com/bryanp))
 
 ## [v0.0.0](https://github.com/metabahn/contentfs/releases/tag/v0.0.0)
-*released on 2020-11-11*
 
+*released on 2020-11-11*
 
   * Initial release.
 

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,26 +12,30 @@ 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)
-      @content = path.read
-      @metadata = metadata.merge(parse_metadata(@content))
       @namespace = namespace.dup << @slug
+      @database = database
+
+      content = path.read
+      @metadata = metadata.merge(parse_metadata(content))
+      @content = content.gsub(FRONT_MATTER_REGEXP, "")
     end
 
     def to_s
@@ -39,8 +43,16 @@ module ContentFS
     end
 
     def render
+      working_content = @content.dup
+
+      @content.scan(INCLUDE_REGEXP).each 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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentfs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-04-01 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.