yarrow 0.8.3 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4319be245b1b70240d28422cf095d64bb61bdacf1b95c545cd055ed7c9e645b
-  data.tar.gz: 1c0fc21f3536a09dd5c11a1c359ce11ab128ea9c527f002a6e6a777090848173
+  metadata.gz: cb8358e221f56cb48075609b4ae35e07ef7ea1bef577d6a1f929a8eb26ca4242
+  data.tar.gz: 8730eec22402eb73b1555a7421fd6ea5f22edb049d8dc7083c0b4de1ea777681
 SHA512:
-  metadata.gz: 0c3d3176870c6bc82695a825bfa7dc46908311200a35722142620e2fdfd5ce60ea795ef03b88ee35c206379e9f382bab41e0cd38f96d5cc261ba0578d7fe51ed
-  data.tar.gz: 3d8b4f4acb48ef94dc75b65ebda43c5a0d0e588679688b090a6ebaba6c5bccc7f7610793d60663a2e7c5cdd6fcdc213be989f064ac8d9092f6dfd191a0b38b90
+  metadata.gz: 1571c747f38efd25382c758b9974c1e5b644f541aa93f76f9f8d3082c35db13b30cf39da52487e67ad2611feb73fc24ad39acdf7de57393aaa8e16cebe8dc0ea
+  data.tar.gz: aad027b60c53a918b9b96f800e144b8b981f3e083a211524ce329549b8242cbd9100da756b7130adcfac990b7944d557378de963b62042cf2effba12acade81e

data/lib/extensions/mementus.rb

@@ -6,6 +6,22 @@ module Mementus
       # Monkeypatch extension to ensure each pipeline step supports enumerable
       # methods. Mostly used for #map. API needs to be fixed in the gem itself.
       include Enumerable
+
+      def to
+        Step.new(map { |edge| edge.to }, Pipe.new(graph), graph)
+      end
+
+      def props
+        Step.new(map { |node| node.props }, Pipe.new(graph), graph)
+      end
+
+      # def props
+      #   node_props = source.inject([]) do |result, node|
+      #     result.concat(node.props)
+      #   end
+
+      #   Step.new(node_props, Pipe.new(graph), graph)
+      # end
     end
   end
   module Structure
@@ -21,4 +37,11 @@ module Mementus
         "nodes_count=#{nodes_count} edges_count=#{edges_count}>"
     end
   end
+
+  class Node
+    def merge_props(data)
+      next_props = props.merge(data)
+      @props = next_props.freeze
+    end
+  end
 end

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

@@ -34,6 +34,23 @@ module Yarrow
           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)

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

@@ -21,11 +21,12 @@ module Yarrow
           end
 
           # Extract metadata from given start node
-          collection_metadata = extract_metadata(start_node, policy.container)
+          #collection_metadata = extract_metadata(start_node, policy.container)
 
           # Collect all nested collections in the subgraph for this content type
           subcollections = {}
-          item_links = []
+          entity_links = []
+          index_links = []
           index = nil
 
           # Scan and collect all nested files from the root
@@ -33,12 +34,14 @@ module Yarrow
             if node.label == :directory
               # Create a collection node representing a collection of documents
               index = graph.create_node do |collection_node|
-                collection_node.label = :collection
-                collection_node.props[:type] = policy.container
-                collection_node.props[:name] = node.props[:name]
 
-                # TODO: title needs to be defined from metadata
-                collection_node.props[:title] = node.props[:name].capitalize
+                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
@@ -54,38 +57,55 @@ module Yarrow
               end
             elsif node.label == :file
               body, meta = process_content(node.props[:entry])
+              meta = {} if !meta
 
-              # Create an item node representing a file mapped to a unique content object
-              item = graph.create_node do |item_node|
-                item_node.label = :item
-                item_node.props[:type] = policy.entity
-                item_node.props[:name] = node.props[:entry].basename(node.props[:entry].extname).to_s
-                item_node.props[:body] = body if body
-                item_node.props[:title] = meta[:title] if meta
-                # TODO: better handling of metadata on node props
-
-                # TODO: new schema edits go here
-                #puts policy.entity_const
-              end
+              # 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
 
-              # We may not have an expanded node for the parent collection if this is a
-              # preorder traversal so save it for later
-              item_links << {
-                parent_path: node.props[:entry].parent.to_s,
-                item_id: item.id
-              }
+                  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
 
           # Once all files and directories have been expanded, connect all the child
-          # edges between collections and items
-          item_links.each do |item_link|
+          # edges between collections and entities
+          entity_links.each do |entity_link|
             graph.create_edge do |edge|
               edge.label = :child
-              edge.from = subcollections[item_link[:parent_path]].id
-              edge.to = item_link[:item_id]
+              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

data/lib/yarrow/content/policy.rb

@@ -81,6 +81,9 @@ module Yarrow
         @container_const ||= Yarrow::Symbols.to_module_const([*module_prefix, container])
       end
 
+      alias_method :collection, :container
+      alias_method :collection_const, :container_const
+
       def entity_const
         @entity_const ||= Yarrow::Symbols.to_module_const([*module_prefix, entity])
       end

data/lib/yarrow/generator.rb

@@ -58,7 +58,7 @@ module Yarrow
       end
     end
 
-    private
+    #private
 
     attr_reader :config, :workflow
 

data/lib/yarrow/schema/definitions.rb

@@ -8,7 +8,8 @@ module Yarrow
         path: Types::Instance.of(Pathname).accept(String),
         any: Types::Any.new,
         array: Types::List.of(Types::Any),
-        hash: Types::Instance.of(Hash)
+        hash: Types::Instance.of(Hash),
+        markdown: Types::Instance.of(Kramdown::Document).accept(String)
       }
 
       TEMPLATE_TYPES = {

data/lib/yarrow/schema/dictionary.rb

@@ -28,13 +28,13 @@ module Yarrow
 
         if missing_attrs.any?
           missing_attrs.each do |name|
-            raise "wrong number of attributes" unless @attrs_spec[name].is_a?(Types::Any)
+            raise "#{missing_attrs} wrong number of attributes" unless @attrs_spec[name].is_a?(Types::Any)
           end
         end
 
         mismatching_attrs = input.keys.difference(@attrs_spec.keys)
 
-        raise "attribute does not exist" if mismatching_attrs.any?
+        raise "attribute #{mismatching_attrs} does not exist" if mismatching_attrs.any?
 
         input.reduce({}) do |converted, (name, value)|
           converted[name] = @attrs_spec[name].cast(value)

data/lib/yarrow/schema/entity.rb

@@ -59,7 +59,7 @@ module Yarrow
       end
 
       def merge(other)
-        unless other.is_a?(self.class)
+        unless other.is_a?(self.class) || other.is_a?(Hash)
           raise ArgumentError.new("cannot merge entities that are not the same type")
         end
 

data/lib/yarrow/schema/types.rb

@@ -31,8 +31,13 @@ module Yarrow
           @accepts = {}
         end
 
-        def accept(type, constructor=:new)
-          accepts[type] = constructor
+        def accept(type, constructor=:new, options=nil)
+          accepts[type] = if options.nil?
+            [constructor]
+          else
+            [constructor, options]
+          end
+
           self
         end
 
@@ -41,8 +46,14 @@ module Yarrow
         end
 
         def coerce(input)
-          constructor = accepts[input.class]
-          unit.send(constructor, input)
+          constructor, options = accepts[input.class]
+
+          # TODO: should we clone all input so copy is stored rather than ref?
+          if options.nil?
+            unit.send(constructor, input)
+          else
+            unit.send(constructor, input, options.clone)
+          end
         end
 
         def check_instance_of!(input)

data/lib/yarrow/version.rb

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

data/lib/yarrow/web/document.rb

@@ -1,42 +1,125 @@
-module Yarrow
+  module Yarrow
   module Web
-    class Document
-      # This class is somewhat verbose for simplicity and long-term maintainability
-      # (having a clear and easy to follow construction, rather than doing anything
-      # too clever which has burned this lib in the past).
-      def initialize(item, parent, is_index)
-        @item = item
-        @parent = parent
-        @is_index = is_index
+    class BaseDocument
+      def resource
+        @resource
+      end
+
+      def type
+        @type
+      end
+
+      # TODO: confirm this can be deleted
+      def index
+        _index = @item.out_e(:index)
+        unless _index.first.nil?
+          _index.first.to.props
+        else
+          nil
+        end
+      end
+
+      # TODO: confirm this can be deleted
+      def index_body
+        @item.props[:index_body]
+      end
+
+      # TODO: manage behaviour with and without current item
+      # TODO: link to manifest
+      #
+      # TODO: replace @item and @collection with @node internally and in class interface
+      def breadcrumbs
+        path = []
+
+        current_parent = @node.in(:collection)
+
+        while !current_parent.first.nil?
+          path << current_parent.first.props[:resource]
+          current_parent = current_parent.in(:collection)
+        end
+
+        path.reverse
       end
 
       def name
-        @item.props[:name]
+        @resource.name
       end
 
       def title
-        @item.props[:title]
+        @resource.title
       end
 
-      def type
-        @item.props[:type]
+      def body
+        return @resource.body.to_html if @resource.respond_to?(:body)
+        ""
       end
 
       def url
         if @parent.nil?
           "/"
         else
-          segments = [@item.props[:name]]
+          segments = [@resource.name]
           current = @parent
 
           until current.in(:collection).first.nil? do
-            segments << current.props[:name]
+            segments << current.props[:resource].name
             current = current.in(:collection).first
           end
 
-          "/" + segments.reverse.join("/")
+          suffix = @is_index ? "/" : ""
+
+          "/" + segments.reverse.join("/") + suffix
         end
       end
     end
+
+    class IndexDocument < BaseDocument
+      # Represents the index document of a collection. This contains
+      # a reference to the individual items in the collection as well as
+      # any document content itself.
+      def initialize(collection, item=nil, is_index=false)
+        @collection = collection
+        @item = item
+        # The parent node of the collection is the first incoming node link
+        @parent = collection.in(:collection).first
+        @is_index = is_index
+
+        template_map = collection.out_e(:child).to.all.inject([]) do |result, node|
+          result << Document.new(node, false)
+        end
+
+        instance_variable_set("@children", template_map)
+        define_singleton_method(:children){ template_map }
+
+        if @item.nil?
+          @resource = collection.props[:resource]
+          @type = collection.props[:type]
+          @node = collection
+        else
+          @resource = item.props[:resource]
+          @type = item.props[:type]
+          @node = item
+        end
+
+        instance_variable_set("@#{@type}", @resource)
+        define_singleton_method(@type){ @resource }
+      end
+    end
+
+    class Document < BaseDocument
+      # This class is somewhat verbose for simplicity and long-term maintainability
+      # (having a clear and easy to follow construction, rather than doing anything
+      # too clever which has burned this lib in the past).
+      def initialize(item, is_index)
+        @item = item
+        @type = item.props[:type]
+        @parent = item.in(:collection).first
+        @node = item
+        @is_index = is_index
+        @resource = item.props[:resource]
+        instance_variable_set("@#{item.props[:type]}", @resource)
+        define_singleton_method(item.props[:type]){ @resource }
+      end
+    end
   end
 end

data/lib/yarrow/web/manifest.rb

@@ -12,7 +12,7 @@ module Yarrow
           unless collection.props[:index_only]
             collection.out(:item).each do |item|
               #if item[:entity].status.to_sym == :published
-              if item.props[:name] == "index"
+              if item.props[:resource].name == "index"
                 index = item
               else
                 manifest.add_document(item_context(item))
@@ -25,7 +25,7 @@ module Yarrow
           unless collection.props[:content_only]
             if index
               manifest.add_document(collection_index_context(collection, index))
-            else 
+            else
               manifest.add_document(collection_context(collection))
             end
           end
@@ -50,15 +50,15 @@ module Yarrow
       end
 
       def self.collection_context(collection)
-        Document.new(collection, collection.in(:collection).first, true)
+        IndexDocument.new(collection, nil, true)
       end
 
       def self.collection_index_context(collection, item)
-        Document.new(item, collection.in(:collection).first, false)
+        IndexDocument.new(collection, item, false)
       end
 
       def self.item_context(item)
-        Document.new(item, item.in(:collection).first, false)
+        Document.new(item, false)
       end
     end
   end

data/lib/yarrow.rb

@@ -1,5 +1,6 @@
 require "pathname"
 require "yaml"
+require "kramdown"
 require "mustache"
 require "parallel"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.6
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable