yarrow 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a2ebdee5113cc218a9744d5da88b01cb0e7604b4ecfe0d133f776d48d2b4b97
-  data.tar.gz: 967ba36fec57253eea8069f903828b8529f43802578c8be009413e4a5373e1f1
+  metadata.gz: 9312b361a125e332c4283433f1b26d29eda2a66c19b08023778eb77ea4b7e297
+  data.tar.gz: 04d6809bb61575cb508b0abb87de095e5bc8c861261177558eb602c95f6913a1
 SHA512:
-  metadata.gz: 982f7c783ed933419504e6722e9ffbacaf513468a16cdb07ca4ec7ffc859d5eaed1470948d8c1ca7ce5aa00f5e0fc05b9c29a38f0f0e2972aa6d2f348aec2c7b
-  data.tar.gz: 4debe486afb56d7f664a0dd730db05429b2d7256a5f2789f1987339b394f404ac0f59f67d9e2f25126ad946675a46b7f910a91881d447afed148cb56eb4b5317
+  metadata.gz: 2c9869456f8255277347e442693d68e894b4af657f82ecba0024a9b3d624cfd4393e83f30f4e98f8cb3897bbbc36c15fcd564060fc940a0de727c193f38ceb3b
+  data.tar.gz: 6ed205652f8a844e87d6c9c5c447d34a65e7e26bfcdc661b742ff26079796082b8b1fcf7fd7d521d37885f79ea83342dcf07e605e64ee5d84d1a8a447d556266

data/README.md

@@ -29,7 +29,7 @@ gem 'yarrow'
 Status
 ------
 
-Yarrow is an extraction from several existing private documentation projects. This repo is in alpha state, which means that many of the useful features are not yet folded into this codebase.
+Yarrow is an extraction from several existing private documentation projects. ~~This repo is in alpha state, which means that many of the useful features are not yet folded into this codebase.~~ This repo is in flux as it is being used on several live projects, but lacks documentation and a unified command line tool.
 
 Yarrow is being slowly developed as a part-time project to scratch a few itches. New features and bugfixes are pushed straight to `main`, and releases of the Gem are kept more or less in sync with the planned roadmap.
 
@@ -40,12 +40,15 @@ A rough sketch of the project direction.
 
 | Version | Features                                        |
 |---------|-------------------------------------------------|
-| `0.9`   | Support standard text formats and linked assets |
-| `0.10`  | Custom Markdown components                      |
-| `0.11`  | Publishing support for S3 and GitHub/Netlify    |
-| `0.12`  | Clean up local web server and watcher           |
-| `0.13`  | Content structure transformations               |
-| `1.0`   | Reintroduce generic command line runner         |
+| `0.10`  | Filename map expansion strategy                 |
+| `0.11`  | Directory merge expansion strategy              |
+| `0.12`  | Basename merge expansion strategy               |
+| `0.13`  | Resources and Assets vocabulary                 |
+| `0.14`  | Flatten namespaces and clean up modules         |
+| `0.15`  | Web template mapping and markup generators      |
+| `0.16`  | Document custom Markdown components             |
+| `0.17`  | Publishing support for S3 and GitHub/Netlify    |
+| `0.18`  | Clean up local web server and watcher           |
 
 License
 -------

data/lib/yarrow/config.rb

@@ -10,11 +10,11 @@ module Yarrow
     # For larger web publishing projects, this should be moved out into a
     # template context or language/translation files to make it editable
     # for a larger group of people.
-    Meta = Yarrow::Schema::Value.new(
-      :title,
-      :author
+    class Meta < Yarrow::Schema::Entity
+      attribute :title, :string
+      attribute :author, :string
       # :copyright TODO: what other basic details to include?
-    )
+    end
 
     # Dev server config. This is mainly useful if you want to set up a specific
     # chain of Rack middleware and handlers. If you don’t care about default
@@ -52,27 +52,90 @@ module Yarrow
     #   :__config_source_map,
     #   Yarrow::Schema::Types::Map.of(Symbol)
     # )
-
     class Content < Yarrow::Schema::Entity
       attribute :module, :string
       #attribute :source_map, :__config_source_map
       attribute :source_map, :hash
     end
+    
+    # Template engine and site generator configuration block
+    class OutputGenerator < Yarrow::Schema::Entity
+      attribute :engine, :string
+      attribute :template_dir, :string
+      attribute :options, :hash
+    end
+
+    # Document mapping configuration block
+    class OutputManifest < Yarrow::Schema::Entity
+      attribute :layout, :string
+      attribute :scheme, :string
+
+      DEFAULT_URL_SCHEME = "/{ancestors*}"
+
+      def self.from_spec(input, context)
+        attrs = {}
+
+        if input.is_a?(TrueClass)
+          attrs[:layout] = context[:key].to_s
+        elsif input.is_a?(FalseClass)
+          raise "Reconciliation for content type #{context[:key]} cannot be skipped (yet)"
+        elsif input.is_a?(Symbol)
+          attrs[:layout] = input.to_s
+        elsif input.is_a?(String)
+          attrs[:layout] = context[:key].to_s
+          attrs[:scheme] = input
+        elsif input.is_a?(Hash)
+          attrs = input
+        else
+          raise "Invalid data for output manifest: #{input.class}"
+        end
+
+        unless attrs.key?(:scheme)
+          attrs[:scheme] = DEFAULT_URL_SCHEME
+        end
+       
+        new(attrs)
+      end
+    end
+
+    # Define output document map type
+    Yarrow::Schema::Definitions.register(
+      :yarrow_config_output_manifest_spec,
+      Yarrow::Schema::Types::Map.of(Symbol => OutputManifest).accept_elements(Hash)
+                                                             .accept_elements(TrueClass, :from_spec)
+                                                             .accept_elements(FalseClass, :from_spec)
+                                                             .accept_elements(Symbol, :from_spec)
+                                                             .accept_elements(String, :from_spec)
+    )
+
+    # Manifest reconciliation configuration block
+    class OutputReconcile < Yarrow::Schema::Entity
+      attribute :match, :string
+      attribute :manifest, :yarrow_config_output_manifest_spec
+    end
 
+    # Output configuration block
     class Output < Yarrow::Schema::Entity
-      attribute :generator, :string
-      attribute :template_dir, :path
-      #attribute :scripts, :array
+      attribute :target, :string
+      attribute :generator, :yarrow_config_output_generator
+      attribute :reconcile, :yarrow_config_output_reconcile
     end
 
+    # Define output schema list type
+    Yarrow::Schema::Definitions.register(
+      :yarrow_config_output_list,
+      Yarrow::Schema::Types::List.of(Output).accept_elements(Hash)
+    )
+
     # Top level root config namespace.
     class Instance < Yarrow::Schema::Entity
       attribute :source_dir, :path
       attribute :output_dir, :path
-      attribute :meta, :any
+      attribute :meta, :yarrow_config_meta
       attribute :server, :any
       attribute :content, :yarrow_config_content
-      attribute :output, :yarrow_config_output
+      attribute :output, :yarrow_config_output_list
+      #attribute :output, :any
     end
     #
     # `content_dir` and `output_dir` are placeholders and should be overriden

data/lib/yarrow/configuration.rb

@@ -1,21 +1,11 @@
 module Yarrow
   class Configuration
     class << self
-      # Merges the given configuration or hash-like object with the
-      # registered global configuration.
-      #
-      # @param [Hash, Hashie::Mash, Yarrow::Configuration]
-      #
-      def merge(config)
-        instance.deep_merge!(config)
-      end
-
       # Loads a configuration object from the given YAML file.
       #
       # @param [String] path to YAML file
       #
       # @return [Yarrow::Config]
-      #
       def load(file)
         coerce_config_struct(YAML.load(File.read(file), symbolize_names: true))
       end
@@ -34,12 +24,9 @@ module Yarrow
       # TODO: this should be folded into the schema machinery with type coercions
       def coerce_config_struct(config)
         meta_obj = if config.key?(:meta)
-          Yarrow::Config::Meta.new(
-            title: config[:meta][:title],
-            author: config[:meta][:author]
-          )
+          config[:meta]
         else
-          nil
+          raise "missing :meta key in config"
         end
 
         server_obj = if config.key?(:server)
@@ -49,7 +36,7 @@ module Yarrow
         end
 
         content_obj = if config.key?(:content)
-          Yarrow::Config::Content.new(config[:content])
+          config[:content]
         else
           Yarrow::Config::Content.new({
             module: "",
@@ -60,9 +47,9 @@ module Yarrow
         end
 
         output_obj = if config.key?(:output)
-          Yarrow::Config::Output.new(config[:output])
+          config[:output]
         else
-          Yarrow::Config::Output.new({ generator: "web", template_dir: "templates" })
+          raise "missing :output key in config"
         end
 
         # TODO: messy hack to get rid of Hashie::Mash, this should either be

data/lib/yarrow/content/collection.rb

@@ -0,0 +1,7 @@
+module Yarrow
+  module Content
+    class Collection < Yarrow::Schema::Entity
+      
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module Yarrow
             }
             collection_node.label = :collection
             collection_node.props[:type] = type
-            collection_node.props[:resource] = collection_const.new(attributes)
+            collection_node.props[:collection] = collection_const.new(attributes)
           end
 
           # Add this collection id to the lookup table for edge construction
@@ -52,7 +52,7 @@ module Yarrow
           end
         end
 
-        def create_entity(source_node, parent_path, type, entity_const)
+        def create_resource(source_node, parent_path, type, entity_const)
           contents = Yarrow::Format.read(source_node.props[:path])
 
           # Create an entity node with attached resource model
@@ -63,7 +63,7 @@ module Yarrow
               body: contents.document.to_s
             }.merge(contents.metadata)
             
-            entity_node.label = :entity
+            entity_node.label = :resource
             entity_node.props[:type] = type
             entity_node.props[:resource] = entity_const.new(attributes)
           end

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

@@ -15,7 +15,7 @@ module Yarrow
         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)
+            create_resource(entity, parent_path, policy.entity, policy.entity_const)
           end
         end
       end

data/lib/yarrow/content/policy.rb

@@ -1,40 +1,53 @@
+Yarrow::Schema::Definitions.register(:extension_list, Yarrow::Schema::Types::List.of(String))
+
 module Yarrow
   module Content
-    class Policy
+    class Policy < Yarrow::Schema::Entity
+      # TODO: document meaning and purpose of each attribute
+      attribute :container, :symbol
+      attribute :collection, :symbol
+      attribute :entity, :symbol
+      attribute :expansion, :symbol
+      attribute :extensions, :extension_list
+      attribute :source_path, :string
+      attribute :module_prefix, :string
+
       DEFAULT_EXPANSION = :filename_map
 
       DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
 
       DEFAULT_SOURCE_PATH = "."
 
+      DEFAULT_MODULE_PREFIX = ""
+
       MODULE_SEPARATOR = "::"
 
       # Construct a content policy from the given source specification.
-      def self.from_spec(policy_label, policy_props, module_prefix="")
+      def self.from_spec(policy_label, policy_props=DEFAULT_SOURCE_PATH, module_prefix=DEFAULT_MODULE_PREFIX)
         # TODO: validate length, structure etc
 
         # If the spec holds a symbol value then treat it as an entity mapping
         if policy_props.is_a?(Symbol)
-          new(
-            policy_label,
-            policy_label,
-            policy_props,
-            DEFAULT_EXPANSION,
-            DEFAULT_EXTENSIONS,
-            policy_label.to_s,
-            module_prefix
-          )
+          new({
+            container: policy_label,
+            collection: policy_label,
+            entity: policy_props,
+            expansion: DEFAULT_EXPANSION,
+            extensions: DEFAULT_EXTENSIONS,
+            source_path: policy_label.to_s,
+            module_prefix: module_prefix
+          })
 
         # If the spec holds a string value then treat it as a source path mapping
         elsif policy_props.is_a?(String)
           new(
-            policy_label,
-            policy_label,
-            Yarrow::Symbols.to_singular(policy_label),
-            DEFAULT_EXPANSION,
-            DEFAULT_EXTENSIONS,
-            policy_props,
-            module_prefix
+            container: policy_label,
+            collection: policy_label,
+            entity: Yarrow::Symbols.to_singular(policy_label),
+            expansion: DEFAULT_EXPANSION,
+            extensions: DEFAULT_EXTENSIONS,
+            source_path: policy_props,
+            module_prefix: module_prefix
           )
 
         # Otherwise scan through the spec and fill in any gaps
@@ -43,7 +56,8 @@ module Yarrow
           collection = if policy_props.key?(:collection)
             policy_props[:collection]
           else
-            # If an entity name is provided use its plural for the container name
+            # If an entity name is provided use its plural for the container name.
+            # Otherwise fall back to a container name or policy label. 
             if policy_props.key?(:entity)
               Yarrow::Symbols.to_plural(policy_props[:entity])
             else
@@ -51,7 +65,7 @@ module Yarrow
             end
           end
 
-          # Use explicit container name if provided
+          # Use explicit container name if provided. Otherwise fall back to the collection name.
           container = if policy_props.key?(:container)
             policy_props[:container]
           else
@@ -91,44 +105,36 @@ module Yarrow
           end
 
           # Construct the new policy
-          new(
-            container,
-            collection,
-            entity,
-            expansion,
-            extensions,
-            source_path,
-            module_prefix
-          )
+          new({
+            container: container,
+            collection: collection,
+            entity: entity,
+            expansion: expansion,
+            extensions: extensions,
+            source_path: source_path,
+            module_prefix: module_prefix
+          })
         end
       end
 
-      attr_reader :container, :collection, :entity, :expansion, :extensions, :source_path, :module_prefix
-
-      def initialize(container, collection, entity, expansion, extensions, source_path, module_prefix)
-        @container = container
-        @collection = collection
-        @entity = entity
-        @expansion = expansion.to_sym
-        @extensions = extensions
-        @source_path = source_path
-        @module_prefix = module_prefix.split(MODULE_SEPARATOR)
+      def module_prefix_parts
+        module_prefix.split(MODULE_SEPARATOR)
       end
 
       def container_const
-        @container_const ||= Yarrow::Symbols.to_module_const([*module_prefix, container])
+        @container_const ||= Yarrow::Symbols.to_module_const([*module_prefix_parts, container])
       end
 
       def collection_const
         begin
-          @collection_const ||= Yarrow::Symbols.to_module_const([*module_prefix, collection])
+          @collection_const ||= Yarrow::Symbols.to_module_const([*module_prefix_parts, collection])
         rescue NameError
           raise NameError, "cannot map undefined entity `#{collection}`"
         end
       end
 
       def entity_const
-        @entity_const ||= Yarrow::Symbols.to_module_const([*module_prefix, entity])
+        @entity_const ||= Yarrow::Symbols.to_module_const([*module_prefix_parts, entity])
       end
 
       def aggregator_const

data/lib/yarrow/defaults.yml

@@ -11,8 +11,21 @@ content:
     pages:
       expansion: tree
 output:
-  generator: web
-  template_dir: templates
+  - target: web
+    generator:
+      engine: __PENDING_LIBRARY_DECISION__
+      template_dir: templates
+      options:
+        error_mode: strict
+    reconcile:
+      match: collection
+      manifest:
+        collection:
+          layout: collection
+          scheme: /{ancestor_path}
+        resource:
+          layout: resource
+          scheme: /{ancestor_path}/{name}
 assets:
   input_dir: assets
   output_dir: public/assets

data/lib/yarrow/output/build.rb

@@ -0,0 +1,37 @@
+module Yarrow
+  module Output
+    class Build
+      attr_reader :graph, :output_config
+      
+      def initialize(graph, output_config)
+        @graph = graph
+        @output_config = output_config
+      end
+
+      def reconcile
+        case output_config.reconcile.match
+        when "collection/resource" then traverse_by_path(:collection, :resource)
+        when "collection" then traverse_by_label(:collection)
+        when "resource" then traverse_by_label(:resource)
+        end
+      end
+
+      private
+
+      def traverse_by_label(label)
+        graph.n(label).each do |node|
+          puts "§ #{label} node #{node.label} #{node.props}"
+        end
+      end
+
+      def traverse_by_path(parent_label, child_label)
+        graph.n(parent_label).each do |collection_node|
+          puts "§ #{parent_label} node #{collection_node.label} #{collection_node.props}"
+          collection_node.out(child_label).each do |resource_node|
+            puts "§ #{child_label} node #{resource_node.label} #{resource_node.props}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/schema/definitions.rb

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

data/lib/yarrow/schema/dictionary.rb

@@ -23,11 +23,12 @@ module Yarrow
         @attrs_spec.keys
       end
 
-      def cast(input)
+      def cast(input, context=nil)
         missing_attrs = @attrs_spec.keys.difference(input.keys)
 
         if missing_attrs.any?
           missing_attrs.each do |name|
+            # TODO: add optional check
             raise "#{missing_attrs} wrong number of attributes" unless @attrs_spec[name].is_a?(Types::Any)
           end
         end
@@ -37,7 +38,7 @@ module Yarrow
         raise "attribute #{mismatching_attrs} does not exist" if mismatching_attrs.any?
 
         input.reduce({}) do |converted, (name, value)|
-          converted[name] = @attrs_spec[name].cast(value)
+          converted[name] = @attrs_spec[name].cast(value, context)
           converted
         end
       end

data/lib/yarrow/schema/entity.rb

@@ -33,7 +33,7 @@ module Yarrow
         end
       end
 
-      def initialize(config)
+      def initialize(config, context=nil)
         converted = dictionary.cast(config)
 
         converted.each_pair do |key, value|
@@ -46,7 +46,15 @@ module Yarrow
         dictionary.attr_names.reduce({}) do |attr_dict, name|
           value = instance_variable_get("@#{name}")
 
-          attr_dict[name] = if value.respond_to?(:to_h)
+          attr_dict[name] =if value.is_a?(Array)
+            value.map do |entry|
+              if entry.respond_to?(:to_h)
+                entry.to_h
+              else
+                entry
+              end
+            end
+          elsif value.respond_to?(:to_h)
             value.to_h
           else
             value

data/lib/yarrow/schema/types.rb

@@ -53,14 +53,37 @@ module Yarrow
           accepts.key?(input.class)
         end
 
-        def coerce(input)
+        # Coerce input into the defined format based on configured
+        # accept rules.
+        #
+        # Will use the unit type’s constructor by default unless
+        # an alternative factory method and constructor arguments are
+        # provided in the accept rule or passed in via context.
+        #
+        # Most object coercions use the defaults, but the context
+        # and options enable specific customisations, such as passing
+        # in an assigned attribute name or the hash key that the input
+        # is a value of.
+        # 
+        # @param [Object] input
+        # @param [nil, Hash] context
+        #
+        # @return [Object] instance of unit type represented by this wrapper
+        def coerce(input, context=nil)
           constructor, options = accepts[input.class]
 
-          # TODO: should we clone all input so copy is stored rather than ref?
-          if options.nil?
+          context_args = if context.nil?
+            options.clone
+          elsif options.nil?
+            context.clone
+          else
+            options.merge(context)
+          end
+
+          if context_args.nil?
             unit.send(constructor, input)
           else
-            unit.send(constructor, input, options.clone)
+            unit.send(constructor, input, context_args)
           end
         end
 
@@ -88,14 +111,14 @@ module Yarrow
           end
         end
 
-        def cast(input)
-          return coerce(input) if should_coerce?(input)
+        def cast(input, context=nil)
+          return coerce(input, context) if should_coerce?(input)
           check(input)
         end
       end
 
       class Any < TypeClass
-        def cast(input)
+        def cast(input, context=nil)
           input
         end
       end
@@ -141,39 +164,40 @@ module Yarrow
         end
       end
 
-      module CompoundType
-        def instance(unit_type)
-          @unit = Instance.of(unit_type)
-          self
+      class List < TypeClass
+        def self.any
+          # Constraint: must be array instance
+          new(Instance.of(Array), Any.new)
         end
 
-        def kind(unit_type)
-          @unit = Kind.of(unit_type)
-          self
+        def self.of(wrapped_type)
+          new(Instance.of(Array), Instance.of(wrapped_type))
         end
 
-        def interface(*args)
-          @unit = Interface.of(args)
-          self
-        end
-      end
+        attr_reader :element_type
+        alias container_type unit
 
-      class List < TypeClass
-        include CompoundType
+        def initialize(unit_type, element_type)
+          @element_type = element_type
+          super(unit_type)
+        end
 
-        def self.of(unit_type)
-          new(Instance.of(unit_type))
+        def accept_elements(accept_type)
+          element_type.accept(accept_type)
+          self
         end
 
-        def cast(input)
-          input.map do |item|
-            unit.cast(item)
+        def check(input)
+          converted = container_type.cast(input)
+
+          converted.map do |item|
+            element_type.cast(item)
           end
         end
       end
 
       class Map < TypeClass
-        include CompoundType
+        #include CompoundType
 
         def self.of(map_spec)
           if map_spec.is_a?(Hash)
@@ -198,15 +222,21 @@ module Yarrow
           super(value_type)
         end
 
+        def accept_elements(accept_type, constructor=:new, options=nil)
+          value_type.accept(accept_type, constructor, options)
+          self
+        end
+
         def check(input)
-          keys = input.keys.map do |key|
-            key_type.cast(key)
-          end
-          values = input.values.map do |value|
-            value_type.cast(value)
+          result = {}
+
+          input.each_pair do |key, value|
+            checked_key = key_type.cast(key)
+            checked_value = value_type.cast(value, { key: checked_key })
+            result[checked_key] = checked_value
           end
 
-          [keys, values].transpose.to_h
+          result
         end
       end
 

data/lib/yarrow/version.rb

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

data/lib/yarrow/web/document.rb

@@ -1,5 +1,26 @@
-  module Yarrow
+module Yarrow
   module Web
+    class Document
+      attr_reader :content_node
+
+      def initialize(node, manifest)
+        @content_node = node
+        #manifest.add_document(self)
+        @manifest = manifest
+      end
+
+      def resource
+        content_node.props[:resource]
+      end
+
+      def url
+        @url ||= URL.generate(resource)
+      end
+    end
+  end
+
+  # Deprecated
+  module LegacyWeb
     class BaseDocument
       def resource
         @resource

data/lib/yarrow/web/manifest.rb

@@ -1,5 +1,27 @@
 module Yarrow
   module Web
+    class NewManifest
+      def initialize
+        @documents_index = {}
+        @documents = []
+      end
+
+      attr_reader :documents
+
+      def add_resource(resource)
+        add_document(Document.new(resource, self))
+      end
+
+      def add_document(document)
+        if @documents_index.key?(document.url)
+          raise "#{document.url} already exists in manifest" 
+        end
+
+        @documents << document
+        @documents_index[document.url] = @documents.count - 1
+      end
+    end
+
     class Manifest
       def self.build(graph)
         manifest = new

data/lib/yarrow/web/url.rb

@@ -0,0 +1,29 @@
+module Yarrow
+  module Web
+    module URI
+    end
+
+    class URL
+      def self.generate(resource)
+        path = if resource.respond_to?(:url)
+          resource.url
+        elsif resource.respond_to?(:permalink)
+          resource.permalink
+        else
+          # TODO: URL generation strategy
+          "/one/two/three"
+        end
+
+        new(path)
+      end
+
+      def initialize(path)
+        @path = path
+      end
+
+      def to_s
+        @path
+      end
+    end
+  end
+end

data/lib/yarrow.rb

@@ -4,6 +4,7 @@ require "kramdown"
 require "toml-rb"
 require "mustache"
 require "parallel"
+require "addressable/template"
 
 require "extensions/mementus"
 
@@ -28,11 +29,11 @@ require "yarrow/content/expansion/directory_merge"
 require "yarrow/content/expansion/traversal"
 require "yarrow/content/resource"
 require "yarrow/web/manifest"
+require "yarrow/web/url"
 require "yarrow/web/document"
 require "yarrow/web/generator"
 require "yarrow/web/template"
-require "yarrow/output/context"
-require "yarrow/output/web/indexed_file"
+require "yarrow/output/build"
 require "yarrow/content_map"
 require "yarrow/server"
 require "yarrow/server/livereload"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -297,12 +297,10 @@ files:
 - bin/yarrow-server
 - lib/extensions/mementus.rb
 - lib/yarrow.rb
-- lib/yarrow/assets.rb
-- lib/yarrow/assets/manifest.rb
-- lib/yarrow/assets/pipeline.rb
 - lib/yarrow/config.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
+- lib/yarrow/content/collection.rb
 - lib/yarrow/content/expansion/aggregator.rb
 - lib/yarrow/content/expansion/basename_merge.rb
 - lib/yarrow/content/expansion/directory_merge.rb
@@ -330,8 +328,7 @@ files:
 - lib/yarrow/generator.rb
 - lib/yarrow/help.txt
 - lib/yarrow/logging.rb
-- lib/yarrow/output/context.rb
-- lib/yarrow/output/web/indexed_file.rb
+- lib/yarrow/output/build.rb
 - lib/yarrow/process/expand_content.rb
 - lib/yarrow/process/extract_source.rb
 - lib/yarrow/process/project_manifest.rb
@@ -348,15 +345,14 @@ files:
 - lib/yarrow/schema/value.rb
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
-- lib/yarrow/source/graph.rb
 - lib/yarrow/symbols.rb
-- lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
 - lib/yarrow/web/document.rb
 - lib/yarrow/web/generator.rb
 - lib/yarrow/web/manifest.rb
 - lib/yarrow/web/static_asset.rb
 - lib/yarrow/web/template.rb
+- lib/yarrow/web/url.rb
 - yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:

data/lib/yarrow/assets/manifest.rb

@@ -1,118 +0,0 @@
-# TODO: where else is this used?
-require 'json'
-
-module Yarrow
-  module Assets
-    ##
-    # Provides access to the bundle of compiled CSS and JS assets.
-    #
-    # This is currently based on the output structure of the JSON manifest file
-    # generated by Sprockets, but this class isn't coupled to the Sprockets API
-    # so could be used as a generic manifest reader.
-    #
-    # - `logical_path` represents the core named path to an asset sans version, eg: `main.css`
-    # - `digest_path` represents the versioned instance of an asset with associated digest,
-    #    eg: `main-4362eea15558e73d3663de653cdeb81e.css`
-    class Manifest
-      ##
-      # Initializes the manifest from a Sprockets-style JSON file.
-      #
-      # If no assets directory is given, looks for a manifest in the main output directory.
-      #
-      # @param config [Yarrow::Configuration]
-      def initialize(config)
-        raise Yarrow::ConfigurationError if config.assets.nil?
-
-        if config.assets.output_dir
-          manifest_path = Pathname.new(config.assets.output_dir) + config.assets.manifest_file
-        else
-          manifest_path = Pathname.new(config.output_dir) + config.assets.manifest_file
-        end
-
-        if File.exists?(manifest_path)
-          manifest_data = JSON.parse(File.read(manifest_path))
-
-          @manifest_index = if manifest_data.key?('assets')
-            manifest_data['assets']
-          else
-            manifest_data
-          end
-        else
-          @manifest_index = {}
-        end
-      end
-
-      ##
-      # True if the named asset exists.
-      #
-      # @param logical_path [String]
-      # @return [Boolean]
-      def exists?(logical_path)
-        @manifest_index.key? logical_path
-      end
-
-      ##
-      # Returns the generated digest path to a named asset.
-      #
-      # @param logical_path [String]
-      # @return [String]
-      def digest_path(logical_path)
-        @manifest_index[logical_path]
-      end
-
-      ##
-      # Returns the list of named assets in the manifest.
-      #
-      # @return [Array<String>]
-      def logical_paths
-        @manifest_index.keys
-      end
-
-      ##
-      # Returns the list of generated digest paths in the manifest.
-      #
-      # @return [Array<String>]
-      def digest_paths
-        @manifest_index.values
-      end
-
-      ##
-      # Returns the list of named CSS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def css_logical_paths
-        select_by_extension(logical_paths, '.css')
-      end
-
-      ##
-      # Returns the list of named JS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def js_logical_paths
-        select_by_extension(logical_paths, '.js')
-      end
-
-      ##
-      # Returns the list of generated CSS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def css_digest_paths
-        select_by_extension(digest_paths, '.css')
-      end
-
-      ##
-      # Returns the list of generated JS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def js_digest_paths
-        select_by_extension(digest_paths, '.js')
-      end
-
-      private
-
-      def select_by_extension(collection, ext)
-        collection.select { |asset| asset.end_with?(ext) }
-      end
-    end
-  end
-end

data/lib/yarrow/assets/pipeline.rb

@@ -1,126 +0,0 @@
-require 'pathname'
-require 'fileutils'
-require 'sprockets'
-
-module Yarrow
-  module Assets
-    ##
-    # Processes static assets using Sprockets.
-    class Pipeline
-
-      include Loggable
-
-      attr_reader :input_dir, :output_dir, :append_paths, :bundles, :assets
-
-      ##
-      # @param config [Yarrow::Configuration]
-      def initialize(config)
-        raise Yarrow::ConfigurationError if config.assets.nil?
-
-        @input_dir = config.assets.input_dir || default_input_dir
-
-        if config.assets.output_dir
-          @output_dir = config.assets.output_dir
-        else
-          @output_dir = config.output_dir || default_output_dir
-        end
-
-        @append_paths = []
-
-        case config.assets.append_paths
-        when Array
-          @append_paths = config.assets.append_paths
-        when '*'
-          @append_paths = Dir[@input_dir + '/*'].select do |path|
-            File.directory?(path)
-          end.map do |path|
-            File.basename(path)
-          end
-        when String
-          @append_paths << config.assets.append_paths
-        end
-      end
-
-      ##
-      # Compiles an asset manifest and processed output files from the given input bundles.
-      # Also generates a manifest linking each output bundle to its given input name.
-      #
-      # @param bundles [Array<String>]
-      def compile(bundles = [])
-        bundles.each do |bundle|          
-          if bundle.include? '*'
-            Dir["#{@input_dir}/#{bundle}"].each do |asset|
-              logger.info "Compiling: #{asset}"
-              manifest.compile(File.basename(asset))
-            end
-          else
-            logger.info "Compiling: #{bundle}"
-            manifest.compile(bundle)
-          end
-        end
-      end
-
-      ##
-      # Copy the given files to the output path without processing or renaming.
-      #
-      # @param bundle [Array<String>]
-      def copy(bundles = [])
-        bundles.each do |bundle|
-          FileUtils.cp_r "#{@input_dir}/#{bundle}", "#{@output_dir}/#{bundle}"
-        end
-      end
-
-      ##
-      # Purges redundant compiled assets from the output path.
-      #
-      # @example Purge all assets except those created in the last 10 minutes
-      #   pipeline.purge(0, )
-      #
-      # @param keep [Integer] Number of previous revisions to keep. Defaults to 2.
-      # @param age [Integer] Purge all assets older than this date. Defaults to 1 hour.
-      def purge(keep = 2, age = 3600)
-        # TODO: upgrade to Sprockets 3.0 to support the age arg
-        manifest.clean(keep)
-      end
-
-      ##
-      # Access instance of the Sprockets environment.
-      #
-      # @return [Sprockets::Environment]
-      def environment
-        # TODO: decouple dependency on Sprockets
-        @environment ||= create_environment
-      end
-
-      private
-
-      def default_input_dir
-        "#{Dir.pwd}/assets"
-      end
-
-      def default_output_dir
-        "#{Dir.pwd}/public/assets"
-      end
-
-      def manifest_file_path
-        "#{@output_dir}/manifest.json"
-      end
-
-      def manifest
-        Sprockets::Manifest.new(environment, manifest_file_path)
-      end
-
-      def create_environment
-        environment = Sprockets::Environment.new(@input_dir)
-        
-        @append_paths.each do |path|
-          environment.append_path path
-        end
-
-        environment
-      end
-
-    end
-
-  end
-end

data/lib/yarrow/assets.rb

@@ -1,2 +0,0 @@
-require_relative 'assets/pipeline'
-require_relative 'assets/manifest'

data/lib/yarrow/output/context.rb

@@ -1,16 +0,0 @@
-module Yarrow
-  module Output
-    # Provides a data context for rendering a template.
-    #
-    # Methods provided by this class become available as named variables in
-    # Mustache templates.
-    class Context
-      def initialize(attributes)
-        metaclass = class << self; self; end
-        attributes.each do |name, value|
-          metaclass.send :define_method, name, lambda { value }
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/output/web/indexed_file.rb

@@ -1,45 +0,0 @@
-module Yarrow
-  module Output
-    module Web
-      class IndexedFile
-        WRITE_MODE = 'w+:UTF-8'.freeze
-
-        # @return [String] Basename reflecting the server convention (usually: index.html)
-        def index_name
-          @index_name ||= config.index_name || 'index.html'
-        end
-
-        # @return [String] Docroot of the output target
-        def docroot
-          @docroot ||= config.output_dir || 'public'
-        end
-
-        # Write an output file to the specified path under the docroot.
-        #
-        # @param path [String]
-        # @param content [String]
-        def write(path, content)
-          # If the target path is a directory,
-          # generate a default index filename.
-          if path[path.length-1] == '/'
-            path = "#{path}#{index_name}"
-          end
-
-          target_path = Pathname.new("#{docroot}#{path}")
-
-          ensure_dir_exists!(target_path.dirname)
-
-          File.open(target_path.to_s, WRITE_MODE) do |file|
-            file.puts(content)
-          end
-        end
-
-        def ensure_dir_exists!(target)
-          unless File.directory?(target)
-            FileUtils.mkdir_p(target)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/source/graph.rb

@@ -1,6 +0,0 @@
-module Yarrow
-  module Source
-    class Graph
-    end
-  end
-end

data/lib/yarrow/tools/front_matter.rb

@@ -1,37 +0,0 @@
-module Yarrow
-  module Tools
-    # @deprecated
-    # Maintained here as it is still used in a number of places but needs to be removed soon
-    module FrontMatter
-
-      def read_split_content(path, options={})
-        extract_split_content(File.read(path, :encoding => 'utf-8'), options)
-      end
-
-      def extract_split_content(text, options={})
-        pattern = /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
-        if text =~ pattern
-          content = text.sub(pattern, "")
-
-          begin
-            if options.key?(:symbolize_keys)
-              meta = YAML.load($1, symbolize_names: true)
-            else
-              meta = YAML.load($1)
-            end
-            return [content, meta]
-          rescue Psych::SyntaxError => error
-            if defined? ::Logger
-              # todo: application wide logger
-              #logger = ::Logger.new(STDOUT)
-              #logger.error "#{error.message}"
-            end
-            return [content, nil]
-          end
-        end
-
-        [text, nil]
-      end
-    end
-  end
-end