gloo-md 1.1 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4263fc76f70591ae470fa3bf72800df6bc2055fe6ea73610940d4bc398548b6
-  data.tar.gz: f645e639d0759dab026b38d8b266a4e67004c977039402b6c4efac5a0ee12008
+  metadata.gz: 2bfa6b6b1b63e61071e271da7649cb0d13d0dd7a6ab8f0bcfaeb455e6325efcc
+  data.tar.gz: 1fcd9683e59f38daf40984bc0d711fa44eac8ca3d9f39a7e6ce21d2b98568de6
 SHA512:
-  metadata.gz: c885359772e7b95bcf53baa9d2e62db12f9a03a86dce068a03c8c1eb9ea8aa9f10ea07252a929ebef0ad373b364f9b43fd6a6427aff134e6586468d9f2f7972c
-  data.tar.gz: 5bce0c04c4cc2f76e54fa69b6aa2b86b1f5506953eb04de23274c1102e5afc7c40d74e81340443da7a706d59f603826ed1e5964567c61ef50e4f120d29abb672
+  metadata.gz: 0ef1a0fc0d81d9fc7c145a5385b70dd848fc1de52c74c2c833175c998b04f8eded160ef9241ee579c1a723229f26b8036af4dd2dde7048871358c8b58730513e
+  data.tar.gz: a3572eb4470c11e401fef0628b1e506f24b628a07cc8115819abc4f59db7dc59d059591a5f4ef6422c72f4dd7f2fa5e43a4c7dba05d813e218fba1813920040b

data/lib/gloo-md.rb

@@ -4,18 +4,20 @@
 # This file is loaded when someone does `require 'gloo-md'`
 # 
 require 'md'
+require 'md_doc'
 require 'markdown_ext'
 
-# 
+#
 # Registers the extension.
-# 
+#
 class MdInit < Gloo::Plugin::Base
 
-    # 
+    #
     # Register verbs and objects.
-    # 
+    #
     def register( callback )
       callback.register_obj( Md )
+      callback.register_obj( MdDoc )
     end
 
 end

data/lib/md_doc.rb

@@ -0,0 +1,200 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2026 Eric Crane.  All rights reserved.
+#
+# A Markdown document with YAML frontmatter.
+# Holds a file path and exposes the frontmatter fields as container
+# children and the Markdown body as a text child.
+#
+require 'yaml'
+
+class MdDoc < Gloo::Core::Obj
+
+  KEYWORD       = 'md_doc'.freeze
+  KEYWORD_SHORT = 'md_doc'.freeze
+
+  PATH        = 'path'.freeze
+  FRONTMATTER = 'frontmatter'.freeze
+  BODY        = 'body'.freeze
+
+
+  # ---------------------------------------------------------------------
+  #    Type identity
+  # ---------------------------------------------------------------------
+
+  #
+  # The name of the object type.
+  #
+  def self.typename
+    return KEYWORD
+  end
+
+  #
+  # The short name of the object type.
+  #
+  def self.short_typename
+    return KEYWORD_SHORT
+  end
+
+  #
+  # Set the value with any necessary type conversions.
+  #
+  def set_value( new_value )
+    self.value = new_value.to_s
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Children
+  # ---------------------------------------------------------------------
+
+  #
+  # Does this object have children to add when an object
+  # is created in interactive mode?
+  #
+  def add_children_on_create?
+    return true
+  end
+
+  #
+  # Add the default children: path, frontmatter, body.
+  #
+  def add_default_children
+    fac = @engine.factory
+    fac.create_file PATH, nil, self
+    fac.create_can FRONTMATTER, self
+    fac.create_text BODY, nil, self
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Messages
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a list of message names that this object receives.
+  #
+  def self.messages
+    return super + %w[read write]
+  end
+
+  #
+  # Read the file at path, parse frontmatter and body, populate children.
+  # Only scalar frontmatter values become gloo string children; complex values
+  # (arrays, nested hashes) are skipped — they are preserved on write by
+  # re-reading the file.
+  #
+  def msg_read
+    path = resolve_path
+    return unless path
+
+    unless File.exist?( path )
+      @engine.log.error "md_doc file not found: #{path}"
+      return
+    end
+
+    content = File.read( path )
+    fm_hash, body_text = parse_frontmatter( content )
+
+    fm_can = find_child FRONTMATTER
+    if fm_can && fm_hash
+      fm_hash.each do |key, val|
+        next unless scalar?( val )
+        child = fm_can.find_add_child( key.to_s, 'string' )
+        child.set_value val.to_s
+      end
+    end
+
+    body = find_child BODY
+    body.set_value( body_text ) if body
+  end
+
+  #
+  # Serialize frontmatter and body children back to the file at path.
+  # Re-reads the current file to get the base hash (preserving arrays and other
+  # complex values), then overlays the scalar children which may have been
+  # modified. Creates the file if it does not exist.
+  #
+  def msg_write
+    path = resolve_path
+    return unless path
+
+    expanded = File.expand_path( path )
+
+    # Re-read the file so arrays and nested hashes survive unchanged.
+    base = {}
+    if File.exist?( expanded )
+      base, _ = parse_frontmatter( File.read( expanded ) )
+    end
+
+    fm_can = find_child FRONTMATTER
+
+    # Overlay scalar children; updating an existing key preserves its position.
+    if fm_can
+      fm_can.children.each do |child|
+        base[ child.name ] = child.value
+      end
+    end
+
+    body = find_child BODY
+    body_text = body ? body.value.to_s : ''
+
+    File.write( expanded, build_content( base, body_text ) )
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Private helpers
+  # ---------------------------------------------------------------------
+
+  private
+
+  #
+  # True for scalar YAML values that can be stored as gloo string children.
+  # Arrays, hashes, and other complex types are skipped on read.
+  #
+  def scalar?( val )
+    val.is_a?( String ) || val.is_a?( Integer ) || val.is_a?( Float ) ||
+      val.is_a?( TrueClass ) || val.is_a?( FalseClass ) || val.nil?
+  end
+
+  #
+  # Get the expanded path string from the path child.
+  #
+  def resolve_path
+    o = find_child PATH
+    return nil unless o
+    return nil if o.value.to_s.strip.empty?
+
+    File.expand_path( o.value.to_s )
+  end
+
+  #
+  # Parse YAML frontmatter from file content.
+  # Returns [fm_hash, body_text]. If there is no frontmatter block,
+  # fm_hash is empty and body_text is the full content.
+  #
+  def parse_frontmatter( content )
+    if content =~ /\A---\s*\n(.*?\n)---\s*\n?(.*)\z/m
+      fm_hash   = YAML.safe_load( $1 ) || {}
+      body_text = $2
+      return fm_hash, body_text
+    end
+
+    return {}, content
+  end
+
+  #
+  # Build the file content string from a frontmatter hash and body text.
+  # Emits frontmatter as YAML between --- delimiters.
+  #
+  def build_content( fm_hash, body_text )
+    if fm_hash.empty?
+      return body_text
+    end
+
+    # to_yaml emits "---\nkey: val\n"; strip the leading "---\n" and rewrap.
+    fm_yaml = fm_hash.to_yaml.sub( /\A---\n/, '' )
+    "---\n#{fm_yaml}---\n#{body_text}"
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo-md
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.3'
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-11 00:00:00.000000000 Z
+date: 2026-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -34,6 +34,7 @@ files:
 - lib/gloo-md.rb
 - lib/markdown_ext.rb
 - lib/md.rb
+- lib/md_doc.rb
 homepage: https://gloo.ecrane.us/
 licenses:
 - MIT