yarrow 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d26941f2b464c551d825b73999b0365637b9e4feec159ee74de51a1abca3416e
-  data.tar.gz: 34081172c945cf83e97ab3ee03484436ba380de6c809c2dd87caaa50f1bba315
+  metadata.gz: b4319be245b1b70240d28422cf095d64bb61bdacf1b95c545cd055ed7c9e645b
+  data.tar.gz: 1c0fc21f3536a09dd5c11a1c359ce11ab128ea9c527f002a6e6a777090848173
 SHA512:
-  metadata.gz: 6300e2c0f83c741862cf6c49acc42118636a3832401706057b483d942c07a947ea1124b2c10e056cc5052e25a28a59f896216d0156911026639d16e0faa5ba73
-  data.tar.gz: 0b897183df8712cbc08d0a479ed1e1d129a90305ad76f9bc802ea262707026ff5ffa57890d0d26d49955f55721ffd0887510671c86430e4780564266758ebaed
+  metadata.gz: 0c3d3176870c6bc82695a825bfa7dc46908311200a35722142620e2fdfd5ce60ea795ef03b88ee35c206379e9f382bab41e0cd38f96d5cc261ba0578d7fe51ed
+  data.tar.gz: 3d8b4f4acb48ef94dc75b65ebda43c5a0d0e588679688b090a6ebaba6c5bccc7f7610793d60663a2e7c5cdd6fcdc213be989f064ac8d9092f6dfd191a0b38b90

data/lib/yarrow/config.rb

@@ -40,7 +40,16 @@ module Yarrow
       :middleware
     )
 
-    class Output < Yarrow::Schema::Entity[:output]
+    # Yarrow::Schema.define do
+    #   type :config_source_map, Yarrow::Schema::Types::Instance.of(Hash).accept(Symbol)
+    # end
+
+    class Content < Yarrow::Schema::Entity[:__config_content]
+      attribute :module, :string
+      attribute :source_map, :hash
+    end
+
+    class Output < Yarrow::Schema::Entity[:__config_output]
       attribute :generator, :string
       attribute :template_dir, :path
       #attribute :scripts, :array
@@ -52,7 +61,8 @@ module Yarrow
       attribute :output_dir, :path
       attribute :meta, :any
       attribute :server, :any
-      #attribute :output, :output
+      attribute :content, :__config_content
+      attribute :output, :__config_output
     end
     #
     # `content_dir` and `output_dir` are placeholders and should be overriden

data/lib/yarrow/configuration.rb

@@ -48,6 +48,23 @@ module Yarrow
           nil
         end
 
+        content_obj = if config.key?(:content)
+          Yarrow::Config::Content.new(config[:content])
+        else
+          Yarrow::Config::Content.new({
+            module: "",
+            source_map: {
+              pages: :page
+            }
+          })
+        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"`)
@@ -58,7 +75,9 @@ module Yarrow
           output_dir: Pathname.new(File.expand_path(out_dir_or_string)),
           source_dir: Pathname.new(File.expand_path(source_dir_or_string)),
           meta: meta_obj,
-          server: server_obj
+          server: server_obj,
+          content: content_obj,
+          output: output_obj
         )
       end
     end

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

@@ -0,0 +1,54 @@
+module Yarrow
+  module Content
+    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
+            # 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
+
+        # 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+module Yarrow
+  module Content
+    module Expansion
+      class Tree < Strategy
+        def expand(policy)
+          #p graph.n(:root).out(:directory).to_a.count
+          #policy.match()
+
+          #p graph.n(:root).out(:directory).first.props[:name]
+          type = policy.container
+
+          # 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 true
+            # TODO: match against source_dir
+            graph.n(:root).out(:directory)
+          else
+            graph.n(:root).out(name: policy.container.to_s)
+          end
+
+          # Extract metadata from given start node
+          collection_metadata = extract_metadata(start_node, policy.container)
+
+          # Collect all nested collections in the subgraph for this content type
+          subcollections = {}
+          item_links = []
+          index = nil
+
+          # Scan and collect all nested files from the root
+          start_node.depth_first.each do |node|
+            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
+              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] == type.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
+            elsif node.label == :file
+              body, meta = process_content(node.props[:entry])
+
+              # 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
+
+              # 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
+              }
+            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|
+            graph.create_edge do |edge|
+              edge.label = :child
+              edge.from = subcollections[item_link[:parent_path]].id
+              edge.to = item_link[:item_id]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/content/graph.rb

@@ -17,11 +17,6 @@ module Yarrow
         @config = config
       end
 
-      def expand_pages
-        expander = Yarrow::Content::Expansion.new(Yarrow::Content::Model.new)
-        expander.expand(graph)
-      end
-
       # List of source files.
       def files
         graph.nodes(:file)

data/lib/yarrow/content/model.rb

@@ -1,45 +1,26 @@
 module Yarrow
   module Content
-    ContentSpec = Yarrow::Schema::Value.new(:namespace, :model) do
-      def to_world
-        "world"
-      end
-    end
-
-    ContentPolicy = Yarrow::Schema::Value.new(
-      :dir,
-      :file,
-      :expansion,
-      :container,
-      :record
-    )
-
     class Model
-      def initialize(spec=nil, namespace=nil)
-        @namespace = []
-        @namespace << namespace unless namespace.nil?
-
-        @policies = if spec.nil?
-          spec = {
-            root: ContentPolicy.new(
-              expansion: :tree,
-              dir: "*",
-              file: "*.md",
-              :container => :pages,
-              :record => :page
-            )
-          }
-        else
-          spec.model
+      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,
+            content_config.module
+          )
         end
       end
 
-      def each_policy(&block)
-        @policies.each_value(&block)
+      def expand(graph)
+        @policies.each_value do |policy|
+          strategy = Expansion::Tree.new(graph)
+          strategy.expand(policy)
+        end
       end
 
-      def policy_for(policy_key)
-        @policies[policy_key]
+      def policy_for(policy_label)
+        @policies[policy_label]
       end
     end
   end

data/lib/yarrow/content/policy.rb

@@ -1,49 +1,88 @@
 module Yarrow
   module Content
     class Policy
-      Options = Yarrow::Schema::Value.new(
-        :container,
-        :entity,
-        :extensions,
-        :match_path
-      )
-
       DEFAULT_HOME_NESTING = false
 
+      DEFAULT_EXPANSION = :tree
+
       DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
 
       DEFAULT_MATCH_PATH = "."
 
-      def self.from_name(name)
-        new(Options.new(container: name.to_sym))
-      end
+      MODULE_SEPARATOR = "::"
 
-      def initialize(properties)
-        unless properties.respond_to?(:container) || properties.respond_to?(:entity)
-          raise "Must provide a container name or entity name"
-        end
+      # Construct a content policy from the given source specification.
+      def self.from_spec(policy_label, policy_props, module_prefix="")
+        # TODO: validate length, structure etc
 
-        @properties = properties
-      end
+        # If the spec holds a symbol value then treat it as a container => entity mapping
+        if policy_props.is_a?(Symbol)
+          new(policy_label, policy_props, DEFAULT_EXPANSION, DEFAULT_EXTENSIONS, DEFAULT_MATCH_PATH, module_prefix)
+
+        # Otherwise scan through all the props and fill in any gaps
+        else
+          # Use explicit container name if provided
+          container = if policy_props.key?(:container)
+            policy_props[:container]
+          else
+            # If an entity name is provided use its plural for the container name
+            if policy_props.key?(:entity)
+              Yarrow::Symbols.to_plural(policy_props[:entity])
+            else
+              Yarrow::Symbols.to_plural(policy_label)
+            end
+          end
 
-      def container
-        return @properties.container if @properties.container
-        Yarrow::Symbols.to_plural(@properties.entity)
+          # Use explicit entity name if provided
+          entity = if policy_props.key?(:entity)
+            policy_props[:entity]
+          else
+            if policy_props.key?(:container)
+              Yarrow::Symbols.to_singular(policy_props[:container])
+            else
+              Yarrow::Symbols.to_singular(policy_label)
+            end
+          end
+
+          # Set expansion strategy
+          expansion = if policy_props.key?(:expansion)
+            policy_props[:expansion]
+          else
+            DEFAULT_EXPANSION
+          end
+
+          # Set list of extensions to turn into documents
+          extensions = if policy_props.key?(:extensions)
+            policy_props[:extensions]
+          else
+            DEFAULT_EXTENSIONS
+          end
+
+          # TODO: handle this in expansion strategies
+          match_path = DEFAULT_MATCH_PATH
+
+          # Construct the new policy
+          new(container, entity, expansion, extensions, match_path, module_prefix)
+        end
       end
 
-      def entity
-        return @properties.entity if @properties.entity
-        Yarrow::Symbols.to_singular(@properties.container)
+      attr_reader :container, :entity, :expansion, :extensions, :match_path, :module_prefix
+
+      def initialize(container, entity, expansion, extensions, match_path, module_prefix)
+        @container = container
+        @entity = entity
+        @expansion = expansion
+        @extensions = extensions
+        @match_path = match_path
+        @module_prefix = module_prefix.split(MODULE_SEPARATOR)
       end
 
-      def extensions
-        return @properties.extensions if @properties.extensions
-        DEFAULT_EXTENSIONS
+      def container_const
+        @container_const ||= Yarrow::Symbols.to_module_const([*module_prefix, container])
       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/defaults.yml

@@ -5,6 +5,11 @@ output_dir: docs
 meta:
   title: Default Project
   author: Default Name
+content:
+  module: Yarrow::Content
+  source_map:
+    pages:
+      expansion: tree
 output:
   generator: web
   template_dir: templates

data/lib/yarrow/generator.rb

@@ -13,8 +13,8 @@ module Yarrow
     provides Content::Graph
 
     def step(content)
-      expander = Content::Expansion.new(Yarrow::Content::Model.new)
-      expander.expand(content.graph)
+      model = Content::Model.new(content.config.content)
+      model.expand(content.graph)
       content
     end
   end

data/lib/yarrow/schema/definitions.rb

@@ -8,7 +8,7 @@ module Yarrow
         path: Types::Instance.of(Pathname).accept(String),
         any: Types::Any.new,
         array: Types::List.of(Types::Any),
-        hash: Types::Map.of(Symbol => Types::Any)
+        hash: Types::Instance.of(Hash)
       }
 
       TEMPLATE_TYPES = {
@@ -40,7 +40,7 @@ module Yarrow
 
           # Get reference to the type class we want to resolve
           template_type = TEMPLATE_TYPES[key_id]
-          
+
           # Resolve the type to an instance depending on structure of its template args
           resolved_type = if value_id.is_a?(Hash)
             # Map template with two argument constructor
@@ -55,7 +55,7 @@ module Yarrow
 
           # Cache the resolved type for later reference
           DEFINED_TYPES[identifier] = resolved_type
-          
+
           # Return the resolve type
           resolved_type
         else

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
   APP_NAME = "Yarrow"
-  VERSION = "0.8.1"
+  VERSION = "0.8.3"
 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/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

@@ -14,19 +14,15 @@ require "yarrow/schema/dictionary"
 require "yarrow/schema/entity"
 require "yarrow/schema/value"
 require "yarrow/schema/registry"
-require "yarrow/config"
-require "yarrow/configuration"
-require "yarrow/console_runner"
 require "yarrow/tools/front_matter"
 require "yarrow/tools/content_utils"
 require "yarrow/content/graph"
+require "yarrow/content/policy"
+require "yarrow/content/model"
 require "yarrow/content/source"
-require "yarrow/content/expansion"
-require "yarrow/content/expansion_strategy"
-require "yarrow/content/tree_expansion"
+require "yarrow/content/expansion/strategy"
+require "yarrow/content/expansion/tree"
 require "yarrow/content/resource"
-require "yarrow/content/model"
-require "yarrow/content/policy"
 require "yarrow/web/manifest"
 require "yarrow/web/document"
 require "yarrow/web/generator"
@@ -36,12 +32,14 @@ require "yarrow/output/web/indexed_file"
 require "yarrow/content_map"
 require "yarrow/server"
 require "yarrow/server/livereload"
-
 require "yarrow/process/workflow"
 require "yarrow/process/step_processor"
 require "yarrow/process/expand_content"
 require "yarrow/process/extract_source"
 require "yarrow/process/project_manifest"
+require "yarrow/config"
+require "yarrow/configuration"
+require "yarrow/console_runner"
 
 require "yarrow/generator"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.3
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -260,14 +260,13 @@ files:
 - lib/yarrow/config.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
-- lib/yarrow/content/expansion.rb
-- lib/yarrow/content/expansion_strategy.rb
+- lib/yarrow/content/expansion/strategy.rb
+- lib/yarrow/content/expansion/tree.rb
 - lib/yarrow/content/graph.rb
 - lib/yarrow/content/model.rb
 - lib/yarrow/content/policy.rb
 - lib/yarrow/content/resource.rb
 - lib/yarrow/content/source.rb
-- lib/yarrow/content/tree_expansion.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
 - lib/yarrow/generator.rb

data/lib/yarrow/content/expansion.rb

@@ -1,16 +0,0 @@
-module Yarrow
-  module Content
-    class Expansion
-      def initialize(model)
-        @model = model
-      end
-
-      def expand(graph)
-        @model.each_policy do |policy|
-          strategy = TreeExpansion.new(graph)
-          strategy.expand(policy)
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion_strategy.rb

@@ -1,51 +0,0 @@
-module Yarrow
-  module Content
-    class ExpansionStrategy
-      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
-          # 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
-
-      # 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
-      end
-    end
-  end
-end

data/lib/yarrow/content/tree_expansion.rb

@@ -1,88 +0,0 @@
-module Yarrow
-  module Content
-    class TreeExpansion < ExpansionStrategy
-      def expand(policy)
-        #p graph.n(:root).out(:directory).to_a.count
-        #policy.match()
-
-        #p graph.n(:root).out(:directory).first.props[:name]
-        type = policy.container
-
-        # 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 true
-          # TODO: match against source_dir
-          graph.n(:root).out(:directory)
-        else
-          graph.n(:root).out(name: policy.container.to_s)
-        end
-
-        # Extract metadata from given start node
-        collection_metadata = extract_metadata(start_node, policy.container)
-
-        # Collect all nested collections in the subgraph for this content type
-        subcollections = {}
-        item_links = []
-        index = nil
-
-        # Scan and collect all nested files from the root
-        start_node.depth_first.each do |node|
-          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
-            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] == type.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
-          elsif node.label == :file
-            body, meta = process_content(node.props[:entry])
-
-            # 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.record
-              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
-
-            # 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
-            }
-          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|
-          graph.create_edge do |edge|
-            edge.label = :child
-            edge.from = subcollections[item_link[:parent_path]].id
-            edge.to = item_link[:item_id]
-          end
-        end
-      end
-    end
-  end
-end