yarrow 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96b575b4a93031397d38c09ab442ce577a98378114941c6be3dcaf4c2a71a3ac
-  data.tar.gz: 15d01eb7b8f710aee890c8879dc202a12ecab3f3cca0030cdc7df8e61619ed75
+  metadata.gz: ee0d0048f5ad41b5bd0d8c0cb49059728e2920217876618294cc08997e450914
+  data.tar.gz: e12fc19f4d9e973e522ae20e995bddf81c1e21861cfa26136cc3f03acf7f20b0
 SHA512:
-  metadata.gz: be90c39d718849c20db481c2f90d105400af237c7232d4cdd091e7260fffe3d09e4828c4d50f473424daa1d223d2cf5259ed55f4120534ad884ea7ca4d2124dc
-  data.tar.gz: b4e5150cd8a3da147489fe0f8077520df328ae2fc5018e4ea102ca171625ada864da3a08aeb59860a98d04b7515e8f0868a023f85fb10c1718592a066d818b1b
+  metadata.gz: 81d64f248a17176116104d16f3d1e1a718aa5aa68eced9cc5eefa5ae8fb2d050bf43532c378a131010eab80125cb63360704790d62687287669f1a8c96bf91e3
+  data.tar.gz: 1f3e90865e4a947a1615eb0ea190a35f7cf4b8d3b51de6a1e1d9b78391f7e47d7a480153aacdef51028debca6d6eeb58222017c480cb1c66b143e361fa762bb6

data/.gitignore

@@ -10,3 +10,4 @@ bin/scripts
 /www
 /web
 /docs
+_*.md

data/lib/yarrow/content/expansion/aggregator.rb

@@ -12,13 +12,13 @@ module Yarrow
         def before_traversal(policy)
         end
 
-        def expand_container(container, policy)
+        def expand_source(container, policy)
         end
 
-        def expand_collection(collection, policy)
+        def expand_directory(collection, policy)
         end
 
-        def expand_entity(entity, policy)
+        def expand_file(entity, policy)
         end
 
         def after_traversal(policy)
@@ -53,13 +53,16 @@ module Yarrow
         end
 
         def create_entity(source_node, parent_path, type, entity_const)
+          contents = Yarrow::Format.read(source_node.props[:path])
+
           # Create an entity node with attached resource model
           entity = graph.create_node do |entity_node|
             attributes = {
               name: source_node.props[:basename],
-              title: source_node.props[:basename].capitalize,
-              body: ""
-            }
+              title: Yarrow::Symbols.to_text(source_node.props[:basename]),
+              body: contents.document.to_s
+            }.merge(contents.metadata)
+            
             entity_node.label = :entity
             entity_node.props[:type] = type
             entity_node.props[:resource] = entity_const.new(attributes)

data/lib/yarrow/content/expansion/basename_merge.rb

@@ -9,18 +9,18 @@ module Yarrow
           @entity_collections = {}
         end
       
-        def expand_container(container, policy)
+        def expand_source(container, policy)
           puts "create_node label=:collection type=:#{policy.collection} name='#{container.props[:basename]}'"
           @container_collection = container.props[:basename]
         end
       
-        def expand_collection(collection, policy)
+        def expand_directory(collection, policy)
           if @container_collection == collection.props[:entry].parent.to_s
             puts "create_node label=:collection type=:#{policy.entity} name='#{collection.props[:basename]}' collection='#{@container_collection}'"
           end
         end
       
-        def expand_entity(entity, policy)
+        def expand_file(entity, policy)
           unless @entity_bundles.key?(entity.props[:basename])
             @entity_bundles[entity.props[:basename]] = []
           end

data/lib/yarrow/content/expansion/directory_merge.rb

@@ -8,16 +8,16 @@ module Yarrow
           @current_entity = nil
         end
 
-        def expand_container(container, policy)
+        def expand_source(container, policy)
           create_collection(container, policy.container, policy.container_const)
           @current_collection = container.props[:path]
         end
 
-        def expand_collection(collection, policy)
+        def expand_directory(collection, policy)
           @current_entity = collection.props[:basename]
         end
 
-        def expand_entity(entity, policy)
+        def expand_file(entity, policy)
           if entity.props[:basename] == @current_entity && entity.props[:ext] == ".md"
             create_entity(entity, @current_collection, policy.entity, policy.entity_const)
           else

data/lib/yarrow/content/expansion/filename_map.rb

@@ -2,17 +2,17 @@ module Yarrow
   module Content
     module Expansion
       class FilenameMap < Aggregator
-        def expand_container(container, policy)
+        def expand_source(container, policy)
           create_collection(container, policy.container, policy.container_const)
           @current_collection = container.props[:path]
         end
 
-        def expand_collection(collection, policy)
+        def expand_directory(collection, policy)
           create_collection(collection, policy.collection, policy.collection_const)
           @current_collection = collection.props[:path]
         end
 
-        def expand_entity(entity, policy)
+        def expand_file(entity, policy)
           if policy.match_by_extension(entity.props[:ext])
             parent_path = entity.incoming(:directory).first.props[:path]
             create_entity(entity, parent_path, policy.entity, policy.entity_const)

data/lib/yarrow/content/expansion/traversal.rb

@@ -21,45 +21,45 @@ module Yarrow
           end
         end
 
-        def on_root_visited(root_node)
-          aggregator.expand_container(root_node, policy)
+        def visit_source(root_node)
+          aggregator.expand_source(root_node, policy)
         end
 
-        def on_directory_visited(dir_node)
+        def visit_directory(dir_node)
           # TODO: match on potential directory extension/filter
-          aggregator.expand_collection(dir_node, policy)
+          aggregator.expand_directory(dir_node, policy)
         end
 
-        def on_file_visited(file_node)
+        def visit_file(file_node)
           # TODO: dispatch underscore prefix or index files separately
           # TODO: match on file extension
-          aggregator.expand_entity(file_node, policy)
+          aggregator.expand_file(file_node, policy)
         end
 
-        def on_traversal_initiated
+        def start_traversal
           aggregator.before_traversal(policy)
         end
 
-        def on_traversal_completed
+        def complete_traversal
           aggregator.after_traversal(policy)
         end
 
         def expand
-          on_traversal_initiated
+          start_traversal
 
           traversal = source_node.depth_first.each
           
-          on_root_visited(traversal.next)
+          visit_source(traversal.next)
 
           loop do
             node = traversal.next
             case node.label
-            when :directory then on_directory_visited(node)
-            when :file then on_file_visited(node)
+            when :directory then visit_directory(node)
+            when :file then visit_file(node)
             end
           end
 
-          on_traversal_completed
+          complete_traversal
         end
       end
     end

data/lib/yarrow/content/policy.rb

@@ -109,7 +109,7 @@ module Yarrow
         @container = container
         @collection = collection
         @entity = entity
-        @expansion = expansion
+        @expansion = expansion.to_sym
         @extensions = extensions
         @source_path = source_path
         @module_prefix = module_prefix.split(MODULE_SEPARATOR)

data/lib/yarrow/format/markdown.rb

@@ -1,6 +1,6 @@
 module Yarrow
   module Format
-    class Markdown < ContentType[".md", ".markdown"]
+    class Markdown < ContentType[".md", ".markdown", ".htm"]
       include Methods::FrontMatter
 
       def initialize(source)

data/lib/yarrow/format/methods/front_matter.rb

@@ -3,18 +3,75 @@ module Yarrow
     module Methods
       # Utility methods for working with text formats containing frontmatter separators.
       module FrontMatter
+        module Syntax
+          YAML = "-"
+          YAML_DOC_END = "."
+          TOML = "+"
+          MM_JSON = ";"
+          JSON_START = "{"
+          JSON_END = "}"
+
+          PATTERN = /\A
+            (?<start>[\-]{3}|[\+]{3}|[;]{3}|[\{]{1})\s*\r?\n
+            (?<meta>.*?)\r?\n?
+            ^(?<stop>[\-]{3}|[\+]{3}|[;]{3}|[\.]{3}|[\}]{1})\s*\r?\n?
+            \r?\n?
+            (?<body>.*)
+          /mx
+        end
+
         module ClassMethods
           def read(path)
             text = File.read(path, :encoding => "utf-8")
-            source, metadata = read_yfm(path)
+            source, metadata = parse(text)
             Yarrow::Format::Contents.new(new(source), metadata)
           end
 
+          def parse(text)
+            result = Syntax::PATTERN.match(text)
+
+            return [text, nil] if result.nil?
+
+            start_chr = result[:start].chr
+            stop_chr = result[:stop].chr
+            input = result[:meta]
+
+            meta = if start_chr == stop_chr
+              case start_chr
+              when Syntax::YAML then parse_yaml(input)
+              when Syntax::TOML then parse_toml(input)
+              when Syntax::MM_JSON then parse_json(input)
+              end
+            else
+              if start_chr == Syntax::YAML && stop_chr == Syntax::YAML_DOC_END
+                parse_yaml(input)
+              elsif start_chr == Syntax::JSON_START && stop_chr == Syntax::JSON_END
+                parse_json(input)
+              else
+                raise "Unsupported frontmatter delimiters"
+              end
+            end
+
+            [result[:body], meta]
+          end
+
+          def parse_yaml(raw)
+            YAML.load(raw, symbolize_names: true)
+          end
+
+          def parse_toml(raw)
+            TomlRB.parse(raw, symbolize_keys: true)
+          end
+
+          def parse_json(raw)
+            JSON.parse("{#{raw}}", symbolize_names: true)
+          end
+
           def read_yfm(path)
             text = File.read(path, :encoding => 'utf-8')
             extract_yfm(text, symbolize_keys: true)
           end
-  
+
           def extract_yfm(text, options={})
             pattern = /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
             if text =~ pattern

data/lib/yarrow/format.rb

@@ -5,7 +5,7 @@ module Yarrow
 
       def initialize(document, metadata)
         @document = document
-        @metadata = metadata
+        @metadata = metadata || {}
       end
     end
 

data/lib/yarrow/symbols.rb

@@ -30,5 +30,11 @@ module Yarrow
     def self.to_plural(atom)
       Strings::Inflection.pluralize(atom.to_s).to_sym
     end
+
+    # @param [Symbol, String] atom
+    # @return [String]
+    def self.to_text(identifier)
+      identifier.to_s.gsub(/\A[^[:alnum:]]+/, "").gsub(/[\-_]+/, " ").capitalize
+    end
   end
 end

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
   APP_NAME = "Yarrow"
-  VERSION = "0.9.0"
+  VERSION = "0.9.2"
 end

data/lib/yarrow/web/generator.rb

@@ -40,7 +40,8 @@ module Yarrow
           file.puts(content)
         end
 
-        puts "[write] #{path} → #{url}"
+        # If stdout logging
+        #puts "[write] #{path} → #{url}"
       end
 
       def generate_sitemap(manifest)

data/lib/yarrow/web/manifest.rb

@@ -56,10 +56,18 @@ module Yarrow
       end
 
       def self.collection_context(collection)
+        # TODO: debug log
+        # puts "collection_context"
+        # p collection.props[:resource].title
+        # p collection
         IndexDocument.new(collection, nil, true)
       end
 
       def self.collection_index_context(collection, entity)
+        # TODO: debug log
+        # puts "collection_index_context"
+        # p collection.props[:resource].title
+        # p entity.props[:resource].title
         IndexDocument.new(collection, entity, false)
       end
 

data/lib/yarrow.rb

@@ -1,6 +1,7 @@
 require "pathname"
 require "yaml"
 require "kramdown"
+require "toml-rb"
 require "mustache"
 require "parallel"
 

data/yarrow.gemspec

@@ -24,7 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'parallel', '~> 1.22.1'
   spec.add_runtime_dependency 'strings-inflection', '~> 0.1'
   spec.add_runtime_dependency 'strings-case', '~> 0.3'
-  # https://github.com/joeldrapper/phlex
+  spec.add_runtime_dependency 'toml-rb', '~> 2.2.0'
+  spec.add_runtime_dependency 'shale', '~> 1.0.0'
+  spec.add_runtime_dependency 'phlex', '~> 1.8.1'
   spec.add_runtime_dependency 'kramdown', '~> 2.4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.11'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -164,6 +164,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: shale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -263,13 +305,9 @@ files:
 - lib/yarrow/console_runner.rb
 - lib/yarrow/content/expansion/aggregator.rb
 - lib/yarrow/content/expansion/basename_merge.rb
-- lib/yarrow/content/expansion/directory_map.rb
 - lib/yarrow/content/expansion/directory_merge.rb
-- lib/yarrow/content/expansion/file_list.rb
 - lib/yarrow/content/expansion/filename_map.rb
-- lib/yarrow/content/expansion/strategy.rb
 - lib/yarrow/content/expansion/traversal.rb
-- lib/yarrow/content/expansion/tree.rb
 - lib/yarrow/content/graph.rb
 - lib/yarrow/content/model.rb
 - lib/yarrow/content/policy.rb

data/lib/yarrow/content/expansion/directory_map.rb

@@ -1,21 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class DirectoryMap < Aggregator
-        def expand_container(container, policy)
-          puts "create_node label=:collection type=:#{policy.container} name='#{container.props[:basename]}'"
-          @current_collection = container.props[:basename]
-        end
-
-        def expand_collection(collection, policy)
-          puts "create_node label=:collection type=:#{policy.collection} name='#{collection.props[:basename]}' collection=#{@current_collection}"
-          @current_collection = collection.props[:basename]
-        end
-
-        def expand_entity(entity, policy)
-          puts "create_node label=:entity type=:#{policy.entity} name='#{entity.props[:basename]}' collection='#{@current_collection}"
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/file_list.rb

@@ -1,15 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class FileList < Strategy
-        def expand(policy)
-          start_node = graph.n(:root).out(name: policy.container.to_s)
-
-          start_node.out(:files).each do |file_node|
-
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/strategy.rb

@@ -1,118 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class Strategy
-        include Yarrow::Tools::FrontMatter
-
-        attr_reader :graph
-
-        def initialize(graph)
-          @graph = graph
-          @subcollections = {}
-          @entity_links = []
-          @index_links = []
-          @index = nil
-        end
-
-        # Expand a directory to a collection node representing a collection of entities
-        def expand_directory(policy, node)
-          index = graph.create_node do |collection_node|
-
-            collection_attrs = {
-              name: node.props[:name],
-              title: node.props[:name].capitalize,
-              body: ""
-            }
-
-            populate_collection(collection_node, policy, collection_attrs)
-          end
-
-          # Add this collection id to the lookup table for edge construction
-          @subcollections[node.props[:path]] = index
-
-          # Join the collection to its parent
-          unless node.props[:slug] == policy.collection.to_s || !@subcollections.key?(node.props[:entry].parent.to_s)
-            graph.create_edge do |edge|
-              edge.label = :child
-              edge.from = @subcollections[node.props[:entry].parent.to_s].id
-              edge.to = index.id
-            end
-          end
-        end
-
-        # Extract collection level configuration/metadata from the root node for
-        # this content type.
-        def extract_metadata(node, type)
-          # TODO: support _index or _slug convention as well
-          meta_file = node.out(slug: type.to_s).first
-
-          if meta_file
-            # Process metadata and add it to the collection node
-            # TODO: pass in content converter object
-            # TODO: index/body content by default if extracted from frontmatter
-            body, data = process_content(meta_file.props[:entry])
-          else
-            # Otherwise, assume default collection behaviour
-            data = {}
-          end
-
-          # Generate a default title if not provided in metadata
-          unless data.key?(:title)
-            data[:title] = type.to_s.capitalize
-          end
-
-          data
-        end
-
-        def populate_collection(node, policy, meta_attrs)
-          node.label = :collection
-          node.props[:type] = policy.collection
-          node.props[:resource] = policy.collection_const.new(meta_attrs)
-        end
-
-        def populate_entity(node, policy, meta_attrs)
-          node.label = :item
-          node.props[:type] = policy.entity
-          node.props[:resource] = policy.entity_const.new(meta_attrs)
-        end
-
-        def merge_collection_index(node, policy, meta_attrs)
-          props = { resource: node.props[:resource].merge(meta_attrs) }
-          node.merge_props(props)
-        end
-
-        # Workaround for handling meta and content source in multiple files or a single
-        # file with front matter.
-        def process_content(path)
-          case path.extname
-          when '.htm', '.md'
-            read_split_content(path.to_s, symbolize_keys: true)
-          # when '.md'
-          #   body, data = read_split_content(path.to_s, symbolize_keys: true)
-          #   [Kramdown::Document.new(body).to_html, data]
-          when '.yml'
-            [nil, YAML.load(File.read(path.to_s), symbolize_names: true)]
-          end
-          # TODO: Raise error if unsupported extname reaches here
-        end
-
-        def connect_expanded_entities
-          # Once all files and directories have been expanded, connect all the child
-          # edges between collections and entities
-          @entity_links.each do |entity_link|
-            graph.create_edge do |edge|
-              edge.label = :child
-              edge.from = entity_link[:parent_id].id
-              edge.to = entity_link[:child_id].id
-            end
-          end
-
-          # Merge index page body and metadata with their parent collections
-          @index_links.each do |index_link|
-            merge_collection_index(index_link[:parent_id], policy, index_link[:index_attrs])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/tree.rb

@@ -1,93 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class Tree < Strategy
-        def expand(policy)
-          # If match path represents entire content dir, then include the entire
-          # content dir instead of scanning from a subfolder matching the name of
-          # the collection.
-          #start_node = if policy.match_path == "."
-          start_node = if policy.match_path == "."
-            # TODO: match against source_dir
-            graph.n(:root).out(:directory)
-          else
-            graph.n(name: policy.match_path)
-          end
-
-          # Collect all nested collections in the subgraph for this content type
-          @subcollections = {}
-          @entity_links = []
-          @index_links = []
-          @index = nil
-
-          # Scan and collect all nested files from the root
-          start_node.depth_first.each do |node|
-            if node.label == :directory
-              expand_directory(policy, node)
-            elsif node.label == :file
-              expand_file_by_extension(policy, node)
-            end
-          end
-
-          # Once all files and directories have been expanded, connect all the child
-          # edges between collections and entities
-          @entity_links.each do |entity_link|
-            graph.create_edge do |edge|
-              edge.label = :child
-              edge.from = entity_link[:parent_id].id
-              edge.to = entity_link[:child_id].id
-            end
-          end
-
-          # Merge index page body and metadata with their parent collections
-          @index_links.each do |index_link|
-            merge_collection_index(index_link[:parent_id], policy, index_link[:index_attrs])
-          end
-        end
-
-        def expand_file_by_basename(policy, node)
-          body, meta = process_content(node.props[:entry])
-          meta = {} if !meta
-
-
-        end
-
-        def expand_file_by_extension(policy, node)
-          body, meta = process_content(node.props[:entry])
-          meta = {} if !meta
-
-          # TODO: document mapping convention for index pages and collection metadata
-          # TODO: underscore _index pattern?
-          bare_basename = node.props[:entry].basename(node.props[:entry].extname)
-          if bare_basename.to_s == "index"
-            @index_links << {
-              parent_id: @subcollections[node.props[:entry].parent.to_s],
-              index_attrs: meta.merge({ body: body})
-            }
-          else
-            # Create an entity node representing a file mapped to a unique content object
-            entity = graph.create_node do |entity_node|
-
-              entity_slug = node.props[:entry].basename(node.props[:entry].extname).to_s
-
-              entity_attrs = {
-                name: entity_slug,
-                title: entity_slug.gsub("-", " ").capitalize,
-                body: body
-              }
-
-              populate_entity(entity_node, policy, entity_attrs.merge(meta || {}))
-            end
-
-            # We may not have an expanded node for the parent collection if this is a
-            # preorder traversal so save it for later
-            @entity_links << {
-              parent_id: @subcollections[node.props[:entry].parent.to_s],
-              child_id: entity
-            }
-          end
-        end
-      end
-    end
-  end
-end