yarrow 0.8.2 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea37c60e3c8bfe51e6ceb9425f0d0c81b93757a681c7987f7852c3335644824
-  data.tar.gz: 19cd090d3b3348f633f5d303d8b826fd2b8c054b790136355a41d9b4f0f098c4
+  metadata.gz: 33fcaf7b1d66e43c0bd0a83967d0cc8b4891b96ec652bbfd28e5e91e7991b7e2
+  data.tar.gz: ccf4513eee11929864f76386e22adf39224a1898f5b207a3cefb11a30a5ed6e7
 SHA512:
-  metadata.gz: ebd0dd29f6d8800b20560c2e24fd2988caecf19e9ae5f3e44a3d0b427afc9201971be1b086705e72c874683d30625821b270e6ad944c5c28ca9b6cd9ecd65ea2
-  data.tar.gz: 92d36891c8a270ff663a299b2a217ffe3bb6985200e70d84c4c9d29ee87bb00fb7b2e824e0d932d585b5f8b4a22d578748ee58ad3ae022aa8f1b8ab04117ac6f
+  metadata.gz: 20272c169c2dd1280c06b80277a981217ae08c77c80892b4c8d07bac0564099ea0cbc248d54ac3160522e7e38c7dbe129aa703e6cb9e9cb848619f2009e15273
+  data.tar.gz: 143a1bbb91909f1e8921b9b587f611293b2f20de9f50d66b18a7346c00e6ebc2078d98ac0e9abcb88cad258e2f3a2d902f1f2eda811d27abd0348ece8f7cf87e

data/lib/extensions/mementus.rb

@@ -21,4 +21,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/config.rb

@@ -62,7 +62,7 @@ module Yarrow
       attribute :meta, :any
       attribute :server, :any
       attribute :content, :__config_content
-      #attribute :output, :__config_output
+      attribute :output, :__config_output
     end
     #
     # `content_dir` and `output_dir` are placeholders and should be overriden

data/lib/yarrow/configuration.rb

@@ -59,6 +59,12 @@ module Yarrow
           })
         end
 
+        output_obj = if config.key?(:output)
+          Yarrow::Config::Output.new(config[:output])
+        else
+          Yarrow::Config::Output.new({ generator: "web", template_dir: "templates" })
+        end
+
         # TODO: messy hack to get rid of Hashie::Mash, this should either be
         # automated as part of the schema types or a default value should be
         # generated here (eg: `"#{Dir.pwd}/docs"`)
@@ -70,7 +76,8 @@ module Yarrow
           source_dir: Pathname.new(File.expand_path(source_dir_or_string)),
           meta: meta_obj,
           server: server_obj,
-          content: content_obj
+          content: content_obj,
+          output: output_obj
         )
       end
     end

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

@@ -3,19 +3,19 @@ module Yarrow
     module Expansion
       class Strategy
         include Yarrow::Tools::FrontMatter
-  
+
         attr_reader :graph
-  
+
         def initialize(graph)
           @graph = graph
         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
@@ -25,15 +25,32 @@ module Yarrow
             # 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)
@@ -46,6 +63,7 @@ module Yarrow
           when '.yml'
             [nil, YAML.load(File.read(path.to_s), symbolize_names: true)]
           end
+          # TODO: Raise error if unsupported extname reaches here
         end
       end
     end

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,35 +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
-              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/model.rb

@@ -4,7 +4,11 @@ module Yarrow
       def initialize(content_config)
         @policies = {}
         content_config.source_map.each_entry do |policy_label, policy_spec|
-          @policies[policy_label] = Policy.from_spec(policy_label, policy_spec)
+          @policies[policy_label] = Policy.from_spec(
+            policy_label,
+            policy_spec,
+            content_config.module
+          )
         end
       end
 

data/lib/yarrow/content/policy.rb

@@ -9,6 +9,8 @@ module Yarrow
 
       DEFAULT_MATCH_PATH = "."
 
+      MODULE_SEPARATOR = "::"
+
       # Construct a content policy from the given source specification.
       def self.from_spec(policy_label, policy_props, module_prefix="")
         # TODO: validate length, structure etc
@@ -27,7 +29,7 @@ module Yarrow
             if policy_props.key?(:entity)
               Yarrow::Symbols.to_plural(policy_props[:entity])
             else
-              Yarrow::Symbols.to_plural(label)
+              Yarrow::Symbols.to_plural(policy_label)
             end
           end
 
@@ -38,7 +40,7 @@ module Yarrow
             if policy_props.key?(:container)
               Yarrow::Symbols.to_singular(policy_props[:container])
             else
-              Yarrow::Symbols.to_singular(label)
+              Yarrow::Symbols.to_singular(policy_label)
             end
           end
 
@@ -64,7 +66,7 @@ module Yarrow
         end
       end
 
-      attr_reader :container, :entity, :expansion, :extensions, :match_path, :module
+      attr_reader :container, :entity, :expansion, :extensions, :match_path, :module_prefix
 
       def initialize(container, entity, expansion, extensions, match_path, module_prefix)
         @container = container
@@ -72,35 +74,18 @@ module Yarrow
         @expansion = expansion
         @extensions = extensions
         @match_path = match_path
-        @module_prefix = module_prefix
+        @module_prefix = module_prefix.split(MODULE_SEPARATOR)
       end
 
       def container_const
-        @container_const ||= Yarrow::Symbols.to_module_const([module_prefix, container])
-      end
-
-      def entity_const
-        @entity_const ||= Yarrow::Symbols.to_module_const([module_prefix, entity])
-      end
-
-      def _container
-        return @properties.container if @properties.container
-        Yarrow::Symbols.to_plural(@properties.entity)
+        @container_const ||= Yarrow::Symbols.to_module_const([*module_prefix, container])
       end
 
-      def _entity
-        return @properties.entity if @properties.entity
-        Yarrow::Symbols.to_singular(@properties.container)
-      end
+      alias_method :collection, :container
+      alias_method :collection_const, :container_const
 
-      def _extensions
-        return @properties.extensions if @properties.extensions
-        DEFAULT_EXTENSIONS
-      end
-
-      def _match_path
-        return @properties.match_path if @properties.match_path
-        DEFAULT_MATCH_PATH
+      def entity_const
+        @entity_const ||= Yarrow::Symbols.to_module_const([*module_prefix, entity])
       end
     end
   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.2"
+  VERSION = "0.8.5"
 end

data/lib/yarrow/web/document.rb

@@ -6,35 +6,75 @@ module Yarrow
       # too clever which has burned this lib in the past).
       def initialize(item, parent, is_index)
         @item = item
+        @resource = item.props[:resource]
         @parent = parent
         @is_index = is_index
       end
 
+      def resource
+        @resource
+      end
+
+      def index
+        _index = @item.out_e(:index)
+        unless _index.first.nil?
+          _index.first.to.props
+        else
+          nil
+        end
+      end
+
+      def index_body
+        @item.props[:index_body]
+      end
+
+      # TODO: manage behaviour with and without current item
+      # TODO: link to manifest
+      def breadcrumbs
+        path = []
+
+        current_parent = @item.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]
       end
 
+      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

data/lib/yarrow/web/generator.rb

@@ -18,7 +18,7 @@ module Yarrow
       end
 
       def write_document(document)
-        template = Template.for_document(document)
+        template = Template.for_document(document, config)
         write_output_file(document.url, template.render(document))
       end
 
@@ -39,6 +39,8 @@ module Yarrow
         File.open(path.to_s, 'w+:UTF-8') do |file|
           file.puts(content)
         end
+
+        puts "[write] #{path} → #{url}"
       end
 
       def generate_sitemap(manifest)

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

data/lib/yarrow/web/template.rb

@@ -1,14 +1,15 @@
 module Yarrow
   module Web
     class Template
-      def self.for_document(document)
+      def self.for_document(document, config)
         layout_name = if document.respond_to?(:layout)
           document.layout || document.type
         else
           document.type
         end
 
-        @template_dir = "./spec/fixtures/templates/doctest"
+        @template_dir = config.output.template_dir
+        #@template_dir = "./spec/fixtures/templates/doctest"
         @template_ext = ".html"
 
         template_file = "#{layout_name}#{@template_ext}"

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.2
+  version: 0.8.5
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable