yarrow 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1a14b73412ec27fad2ff75bd7944f1ef25f241779c532d3449339a436e4c32
-  data.tar.gz: 2cf2db75cc8c107b1d1bcbb6a79ad7fd92a6ba32e27413f2057158f7b8bb3c8a
+  metadata.gz: ff50d9afd65a1ab1f8fd668c7db4acc0ceacabc095bccd65b384c2b47f8e7eb0
+  data.tar.gz: cb0f022b2163753231e701b98e1da2da2ee963b61cd635031f4128b7ce6034be
 SHA512:
-  metadata.gz: 436cec2447208c2641d4ac332cbb1910b7b016983a0630782282a28fe34e7a929b4661f424f0002d937854316d00f6d822ec05407f40185a7d5bbd642a2b88d2
-  data.tar.gz: bd798c5d999b7d2665209778d507bfe9b54da98473850dd66b62c60391a270f93aa00d913315a7b29e6c92e7cb436f64fb89b692ecb4ea2da8bad5387d43b0b6
+  metadata.gz: 93f4705d0556fee8b22ea19ca0a42a272a85ec52b7ced0ab408072147b27789173465c5ea0bcb4f95787da01499499f16d57971b325de5af3bb2d0a1b1f8ccf4
+  data.tar.gz: 59df4131a12acd9bd7ea051c1e308d17b99cd391e63e07b5582340f8bcd7e2be1216b98a32e2b4a86d8b88278dd11505d7d0b689997d249ca30057222ca4cc4e

data/.github/workflows/ruby.yml

@@ -1,16 +1,16 @@
-name: Ruby
+name: ruby
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.7, '3.0', jruby]
+        ruby: [2.7, '3.0', jruby-head]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/README.md

@@ -1,17 +1,15 @@
 Yarrow
 ======
 
-[![Gem Version](http://img.shields.io/gem/v/yarrow.svg)][gem]
-[![Build Status](http://img.shields.io/github/workflow/status/:user/maetl/yarrow/workflow)][github]
-[![Coverage Status](http://img.shields.io/coveralls/maetl/yarrow.svg)][coveralls]
+[![Gem Version](https://img.shields.io/gem/v/yarrow.svg)][gem]
+[![Build Status](https://img.shields.io/github/workflow/status/maetl/yarrow/ruby/main)][github]
 
 [gem]: https://rubygems.org/gems/yarrow
 [github]: https://github.com/maetl/yarrow
-[coveralls]: https://coveralls.io/r/maetl/yarrow
 
-Yarrow is a tool for generating well structured documentation from a variety of input sources.
+Yarrow is a framework for generating well structured publishing outputs from a variety of input sources.
 
-Unlike most static site generators and code documentation tools, Yarrow is written with design and content-strategy in mind. It does not impose its own structure on your content. This makes it appropriate for building static sites and blogs as well as style guides and API docs.
+Unlike most static site generators and code documentation tools, Yarrow is written with design and content-strategy in mind. It does not impose its own structure on your content. This makes it useful for building style guides, technical docs and complex ebooks as well as static sites and blogs.
 
 Installation
 ------------
@@ -33,7 +31,7 @@ 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 being slowly developed as a part-time project to scratch a few itches. New features and bugfixes are pushed straight to master, and releases of the Gem are kept more or less in sync with the planned roadmap.
+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.
 
 Roadmap
 -------
@@ -42,13 +40,13 @@ A rough sketch of the project direction.
 
 | Version | Features |
 |---------|----------|
-| `0.3`   | **[Local dev server and asset pipeline](https://github.com/maetl/yarrow/issues/48)** |
-| `0.4`   | Default media type mapping, collector, markup converters |
-| `0.5`   | Content model/object mapping, template/site context |
-| `0.6`   | HTML tag helpers, default layout templates |
-| `0.7`   | Rake integration, task library |
-| `0.8`   | Generic command line runner |
-| `0.9`   | Refactoring, performance fixes, lock down API |
+| `0.6`   | Default media type mapping, graph collectors, markup converters |
+| `0.7`   | Content model/object mapping, template/site context |
+| `0.8`   | HTML publishing workflow |
+| `0.9`   | PDF publishing workflow |
+| `0.10`   | Media and video publishing workflow |
+| `0.11`   | Generic command line runner |
+| `1.0`   | Refactoring, performance fixes, lock down API |
 
 License
 -------

data/lib/yarrow.rb

@@ -1,28 +1,29 @@
-require 'hashie'
+require 'pathname'
 require 'yaml'
-require 'active_support/inflector'
 
 require 'yarrow/version'
+require 'yarrow/extensions'
+require 'yarrow/symbols'
 require 'yarrow/logging'
+require 'yarrow/schema'
+require 'yarrow/config'
 require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/generator'
-require 'yarrow/assets'
 require 'yarrow/tools/front_matter'
+require 'yarrow/tools/content_utils'
 require 'yarrow/content/graph'
 require 'yarrow/content/content_type'
 require 'yarrow/content/source'
 require 'yarrow/content/source_collector'
 require 'yarrow/content/collection_expander'
-require 'yarrow/html/asset_tags'
 require 'yarrow/output/mapper'
 require 'yarrow/output/generator'
 require 'yarrow/output/context'
+require 'yarrow/output/web/indexed_file'
 require 'yarrow/content_map'
-require 'yarrow/html'
 require 'yarrow/server'
 require 'yarrow/server/livereload'
-require 'yarrow/schema'
 
 require 'yarrow/process/workflow'
 require 'yarrow/process/step_processor'

data/lib/yarrow/config.rb

@@ -0,0 +1,60 @@
+# Replacement for the legacy Hashie::Mash/Module mixin configuration
+# pattern. This provides the same API (chaining nested attribute calls) but
+# handles schema validation and doesn’t pollute other namespaces.
+module Yarrow
+  module Config
+    # Basic defaults which can be used to populate HTML metadata as well as
+    # used in CLI listings and other generated docs. The default H1 if no
+    # specific output config or template themes are provided.
+    #
+    # 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
+      # :copyright TODO: what other basic details to include?
+    )
+
+    # 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
+    # directory indexes or port handling, you can completely ignore this.
+    #
+    # There are many better live reloading options available in JS, so the Rack
+    # infrastructure here should be ignored for UI-heavy jobs. It’s otherwise
+    # fine for slower-paced general purpose web publishing.
+    #
+    # The default index config could possibly move into a dedicated namespace
+    # in future if it makes sense to use the underlying graph infrastructure
+    # as a live lookup rather than a compiler-generated artifact. This would
+    # mean rather than doing a ls on the directory, the index pages would
+    # grab a list of entries out of a graph projection for the directory.
+    Server = Yarrow::Schema::Value.new(
+      :live_reload,
+      :auto_index,
+      :default_index,
+      :default_type,
+      :port,
+      :host,
+      :handler,
+      :docroot,
+      :middleware,
+      :root_dir
+    )
+
+    # Top level root config namespace. Source, content and output are directory
+    # paths and should be the only required defaults for a complete batch run.
+    #
+    # Additional server config is optional and only needed if running the dev
+    # server locally.
+    #
+    # TODO: meta should be union of Type::Optional and Config::Meta
+    Instance = Yarrow::Schema::Value.new(
+      source: Pathname,
+      content: Pathname,
+      output_dir: Pathname,
+      meta: Yarrow::Schema::Type::Any,
+      server: Yarrow::Schema::Type::Any
+    )
+  end
+end

data/lib/yarrow/configuration.rb

@@ -1,50 +1,6 @@
 module Yarrow
-  ##
-  # Hash-like object containing runtime configuration values. Can be accessed indifferently
-  # via object style lookups or symbol keys.
-  #
-  class Configuration < Hashie::Mash
+  class Configuration
     class << self
-      ##
-      # Provides access to the registered global configuration.
-      #
-      # If no configuration is registered, returns a blank object.
-      #
-      # @return [Yarrow::Configuration]
-      #
-      def instance
-        @@configuration ||= self.new
-      end
-
-      ##
-      # Loads and registers a global configuration instance.
-      #
-      # This will reset any previously initialized configuration.
-      #
-      # @param [String] path to YAML file
-      #
-      def register(file)
-        @@configuration = load(file)
-      end
-
-      ##
-      # Loads and registers a global configuration instance with
-      # library-provided defaults.
-      #
-      # This will reset any previously initialized configuration.
-      #
-      def register_defaults
-        @@configuration = load_defaults
-      end
-
-      ##
-      # Clears the global configuration to the empty default.
-      #
-      def clear
-        @@configuration = self.new
-      end
-
-      ##
       # Merges the given configuration or hash-like object with the
       # registered global configuration.
       #
@@ -54,18 +10,16 @@ module Yarrow
         instance.deep_merge!(config)
       end
 
-      ##
       # Loads a configuration object from the given YAML file.
       #
       # @param [String] path to YAML file
       #
-      # @return [Yarrow::Configuration]
+      # @return [Yarrow::Config]
       #
       def load(file)
-        self.new(YAML.load_file(file))
+        coerce_config_struct(YAML.load(File.read(file), symbolize_names: true))
       end
 
-      ##
       # Yarrow is distributed with a `defaults.yml` which provides minimum
       # boostrap configuration and default settings for various internal
       # classes. Use this method to automatically load these defaults.
@@ -74,26 +28,49 @@ module Yarrow
       def load_defaults
         load(File.join(File.dirname(__FILE__), 'defaults.yml'))
       end
-    end
-  end
 
-  ##
-  # Embeds global configuration access in a client object.
-  #
-  module Configurable
-    ##
-    # Provides access to the registered global configuration. This can
-    # be overriden by subclasses to customize behaviour (eg: in test cases).
-    #
-    # @return [Yarrow::Configuration]
-    #
-    def config
-      Configuration.instance
+      private
+
+      # 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]
+          )
+        else
+          nil
+        end
+
+        server_obj = if config.key?(:server)
+          Yarrow::Config::Server.new(**config[:server])
+        else
+          nil
+        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"`)
+        out_dir_or_string = config[:output_dir] || ""
+        source_dir_or_string = config[:source] || ""
+        content_dir_or_string = config[:content] || ""
+
+        Yarrow::Config::Instance.new(
+          output_dir: Pathname.new(File.expand_path(out_dir_or_string)),
+          source: Pathname.new(File.expand_path(source_dir_or_string)),
+          content: Pathname.new(File.expand_path(content_dir_or_string)),
+          meta: meta_obj,
+          server: server_obj
+        )
+      end
     end
   end
 
   ##
   # Raised when a required config section or property is missing.
   class ConfigurationError < StandardError
+    def self.missing_section(name)
+      new("Missing config section #{name.to_sym}")
+    end
   end
 end

data/lib/yarrow/console_runner.rb

@@ -31,27 +31,27 @@ module Yarrow
 
     def run_application
       print_header
-      
+
       begin
         process_arguments
-      
+
         if has_option?(:version)
           return SUCCESS
         end
-      
+
         if has_option?(:help)
           print_help
           return SUCCESS
         end
-        
+
         process_configuration
-        
+
         run_input_process
-        
+
         run_output_process
-        
+
         print_footer
-        
+
         SUCCESS
       rescue Exception => e
         print_error e
@@ -81,20 +81,20 @@ module Yarrow
 
     def process_configuration
       # load_configuration(Dir.pwd)
-      
+
       # @targets.each do |input_path|
       #   @config.deep_merge! load_configuration(input_path)
       # end
-      
+
       if has_option?(:config)
         path = @options[:config]
         @config.deep_merge! Configuration.load(path)
       end
-      
+
       @config.options = @options.to_hash
 
       # normalize_theme_path
-      
+
       # theme = @config.options.theme
       # @config.append load_configuration(theme)
     end
@@ -113,9 +113,9 @@ module Yarrow
       else
         value = true
       end
-      
+
       name = option.gsub("-", "")
-      
+
       if option[0..1] == "--"
         if ENABLED_OPTIONS.has_value?(name.to_sym)
           @options[name.to_sym] = value
@@ -127,7 +127,7 @@ module Yarrow
           return
         end
       end
-      
+
       raise "Unrecognized option: #{raw_option}"
     end
 
@@ -142,7 +142,7 @@ module Yarrow
     def run_input_process
       # noop
     end
-    
+
     def run_output_process
       # noop
     end
@@ -161,7 +161,7 @@ module Yarrow
 
     def print_help
       help = <<HELP
-  See http://yarrowdoc.org for more information.
+  See http://yarrow.maetl.net for more information.
 
   Usage:
 

data/lib/yarrow/content/collection_expander.rb

@@ -125,7 +125,7 @@ module Yarrow
 
       def build_content_nodes(graph, objects, type, parent_index)
         # TODO: this may need to use a strategy that can be overriden
-        content_type = ActiveSupport::Inflector.singularize(type).to_sym
+        content_type = Yarrow::Symbols.to_singular(type)
 
         # Process collected content objects and generate entity nodes
         objects.each do |name, sources|
@@ -172,8 +172,9 @@ module Yarrow
             # TODO: consider whether to provide `body` on the item/document or at
             # the custom content type level.
             begin
-              content_struct = Object.const_get(ActiveSupport::Inflector.classify(content_type))
+              content_struct = Yarrow::Symbols.to_const(content_type)
             rescue
+              # No immutable struct found: fall back to slower dynamically typed open struct
               require "ostruct"
               content_struct = OpenStruct
             end

data/lib/yarrow/content/content_type.rb

@@ -1,10 +1,14 @@
+gem "strings-inflection"
+
 module Yarrow
   module Content
     class ContentType
+      Value = Yarrow::Schema::Value.new(:collection, :entity, :extensions)
+
       DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
 
       def self.from_name(name)
-        new(Yarrow::Configuration.new(collection: name.to_sym))
+        new(Value.new(collection: name.to_sym))
       end
 
       def initialize(properties)
@@ -16,17 +20,17 @@ module Yarrow
       end
 
       def collection
-        return @properties.collection if @properties.respond_to?(:collection)
-        ActiveSupport::Inflector.pluralize(@properties.entity).to_sym
+        return @properties.collection if @properties.collection
+        Yarrow::Symbols.to_plural(@properties.entity)
       end
 
       def entity
-        return @properties.entity if @properties.respond_to?(:entity)
-        ActiveSupport::Inflector.singularize(@properties.collection).to_sym
+        return @properties.entity if @properties.entity
+        Yarrow::Symbols.to_singular(@properties.collection)
       end
 
       def extensions
-        return @properties.extensions if @properties.respond_to?(:extensions)
+        return @properties.extensions if @properties.extensions
         DEFAULT_EXTENSIONS
       end
 

data/lib/yarrow/content/graph.rb

@@ -1,35 +1,10 @@
-require "mementus"
-
-module Mementus
-  module Pipeline
-    class Step
-      # 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
-    end
-  end
-  module Structure
-    class IncidenceList
-      def inspect
-        "<Mementus::Structure::IncidenceList>"
-      end
-    end
-  end
-  class Graph
-    def inspect
-      "<Mementus::Graph @structure=#{@structure.inspect} " +
-        "nodes_count=#{nodes_count} edges_count=#{edges_count}>"
-    end
-  end
-end
-
 module Yarrow
   module Content
     # A directed graph of every element of content in the project.
     class Graph
       # Construct a graph collected from source content files.
       def self.from_source(config)
-        new(SourceCollector.collect(config.input_dir), config)
+        new(SourceCollector.collect(config.source), config)
       end
 
       attr_reader :graph, :config
@@ -40,7 +15,7 @@ module Yarrow
       end
 
       def expand_pages
-        expander = Yarrow::Content::CollectionExpander.new(config.content_types)
+        expander = Yarrow::Content::CollectionExpander.new
         expander.expand(graph)
       end
 

data/lib/yarrow/defaults.yml

@@ -22,7 +22,7 @@ server:
   auto_index: true
   default_index: index.html
   default_type: text/plain
-  port: 4000
+  port: 5005
   host: localhost
   handler: webrick
   middleware:

data/lib/yarrow/extensions.rb

@@ -0,0 +1 @@
+require "yarrow/extensions/mementus"

data/lib/yarrow/extensions/mementus.rb

@@ -0,0 +1,24 @@
+require "mementus"
+
+module Mementus
+  module Pipeline
+    class Step
+      # 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
+    end
+  end
+  module Structure
+    class IncidenceList
+      def inspect
+        "<Mementus::Structure::IncidenceList>"
+      end
+    end
+  end
+  class Graph
+    def inspect
+      "<Mementus::Graph @structure=#{@structure.inspect} " +
+        "nodes_count=#{nodes_count} edges_count=#{edges_count}>"
+    end
+  end
+end

data/lib/yarrow/output/context.rb

@@ -4,11 +4,7 @@ module Yarrow
     #
     # Methods provided by this class become available as named variables in
     # Mustache templates.
-    #
-    # Includes the library of helpers for dynamically generating HTML tags.
     class Context
-      include Yarrow::HTML::AssetTags
-
       def initialize(attributes)
         metaclass = class << self; self; end
         attributes.each do |name, value|

data/lib/yarrow/output/generator.rb

@@ -8,12 +8,12 @@ module Yarrow
 
       # Mapping between template types and provided object model
       def object_map
-        @config.output.object_map
+        @config[:output][:object_map]
       end
 
       # Mapping between template types and provided output templates.
       def template_map
-        
+
       end
 
       # Template converter used by this generator instance.

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

@@ -0,0 +1,39 @@
+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}")
+
+          FileUtils.mkdir_p(target_path.dirname)
+
+          File.open(target_path.to_s, WRITE_MODE) do |file|
+            file.puts(content)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/schema.rb

@@ -11,25 +11,29 @@ module Yarrow
     #
     # Current design throws on error rather than returns a boolean result.
     class Validator
-      # @param slots [Array<Symbol>, <Hash>] defines the slots in the schema to validate against
-      def initialize(slots)
-        @keys = slots.reduce({}) do |keys, slot|
-          if slot.is_a?(Array)
-            keys[slot[0]] = slot[1]
-          else
-            keys[slot.to_sym] = Type::Any
-          end
-
-          keys
-        end
+      # @param fields_spec [Hash] defines the slots in the schema to validate against
+      def initialize(fields_spec)
+        @spec = fields_spec
       end
 
       def check(fields)
-        raise "wrong number of args" unless fields.keys.length == @keys.keys.length
+        missing_fields = @spec.keys.difference(fields.keys)
+
+        if missing_fields.any?
+          missing_fields.each do |field|
+            raise "wrong number of args" unless @spec[field].eql?(Type::Any)
+          end
+        end
+
+        mismatching_fields = fields.keys.difference(@spec.keys)
+
+        raise "key does not exist" if mismatching_fields.any?
 
-        fields.keys.each do |key|
-          raise "key does not exist" unless @keys.key?(key)
+        fields.each do |(field, value)|
+          raise "wrong data type" unless value.is_a?(@spec[field]) || @spec[field].eql?(Type::Any)
         end
+
+        true
       end
     end
 
@@ -38,19 +42,38 @@ module Yarrow
     # Ruby struct but wraps the constructor with method advice that handles
     # validation (and eventually type coercion if !yagni).
     class Value
-      def self.new(*slots, &block)
-        factory(*slots, &block)
+      def self.new(*slots, **fields, &block)
+        factory(*slots, **fields, &block)
       end
 
-      def self.factory(*slots, &block)
-        validator = Validator.new(slots)
+      def self.factory(*slots, **fields, &block)
+        if slots.empty? && fields.empty?
+          raise ArgumentError.new("missing attribute definition")
+        end
+
+        slots_spec, fields_spec = if fields.any?
+          raise ArgumentError.new("cannot use slots when field map is supplied") if slots.any?
+          [fields.keys, fields]
+        else
+          [slots, Hash[slots.map { |s| [s, Type::Any]}]]
+        end
+
+        validator = Validator.new(fields_spec)
 
-        struct = Struct.new(*slots, keyword_init: true, &block)
+        struct = Struct.new(*slots_spec, keyword_init: true, &block)
 
-        struct.define_method :initialize do |kwargs|
-          validator.check(kwargs)
+        struct.define_method :initialize do |*args, **kwargs|
+          attr_values = if args.any?
+            raise ArgumentError.new("cannot mix slots and kwargs") if kwargs.any?
+            Hash[slots.zip(args)]
+          else
+            kwargs
+          end
+
+          validator.check(attr_values)
           # TODO: type coercion or mapping decision goes here
-          super(**kwargs)
+          super(**attr_values)
+
           freeze
         end
 

data/lib/yarrow/server.rb

@@ -4,12 +4,18 @@ module Yarrow
   ##
   # Little web server for browsing local files.
   class Server
-    include Configurable
+    attr_reader :config
 
-    def initialize
-      if config.server.nil?
-        raise ConfigurationError.new('Missing server entry')
+    def self.default
+      new(Yarrow::Configuration.load_defaults)
+    end
+
+    def initialize(instance_config)
+      if instance_config.server.nil?
+        raise ConfigurationError.missing_section(:server)
       end
+
+      @config = instance_config
     end
 
     ##
@@ -55,6 +61,7 @@ module Yarrow
       app.use(DirectoryIndex, root: docroot, index: default_index)
 
       app_args = [docroot, {}].tap { |args| args.push(default_type) if default_type }
+
       static_app = Rack::File.new(*app_args)
 
       if live_reload?
@@ -87,7 +94,7 @@ module Yarrow
 
       trap(:INT) do
         handler.shutdown if handler.respond_to?(:shutdown)
-        reactor.stop
+        reactor.stop if live_reload?
       end
 
       handler.run(app, run_options)
@@ -95,10 +102,13 @@ module Yarrow
 
     private
 
-    ##
+    # Host directory of the mounted web server.
+    #
+    # Fallback to `config.output_dir`.
+    #
     # @return [String]
     def docroot
-      config.output_dir || Dir.pwd
+      config.output_dir
     end
 
     ##

data/lib/yarrow/symbols.rb

@@ -0,0 +1,19 @@
+require "strings-inflection"
+require "strings-case"
+
+module Yarrow
+  module Symbols
+    # Converts an atomic content identifier to a live class constant.
+    def self.to_const(atom)
+      Object.const_get(Strings::Case.pascalcase(atom.to_s).to_sym)
+    end
+
+    def self.to_singular(atom)
+      Strings::Inflection.singularize(atom.to_s).to_sym
+    end
+
+    def self.to_plural(atom)
+      Strings::Inflection.pluralize(atom.to_s).to_sym
+    end
+  end
+end

data/lib/yarrow/tools/content_utils.rb

@@ -0,0 +1,74 @@
+module Yarrow
+  module Tools
+    # Synchronous utility functions for working with filesystem content tasks.
+    module ContentUtils
+      # Pass in a source path and get back a parsed representation of the
+      # content if it is in a known text format. Mostly used as a fallback if
+      # a custom parser or processing chain is not configured for a content
+      # type.
+      #
+      # Supported formats:
+      # - HTML template and document partials
+      # - Markdown documents
+      # - YAML documents
+      # - JSON (untested)
+      #
+      # Works around meta and content source in multiple files or a single
+      # file with front matter.
+      def read_yfm(name)
+        path = if name.is_a?(Pathname)
+          name
+        else
+          Pathname.new(name)
+        end
+
+        text = File.read(path, :encoding => 'utf-8')
+
+        case path.extname
+        when '.htm', '.md', '.txt', '.yfm'
+          extract_yfm(text, 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)]
+        when '.json'
+          [nil, JSON.parse(File.read(path.to_s))]
+        end
+      end
+
+      def extract_yfm(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
+
+      def write_yfm(name, text, meta)
+        # Symbolized keys are better to deal with when manipulating data in
+        # Ruby but are an interop nightmare when serialized so here we do a
+        # round-trip through JSON encoding to ensure all keys are string
+        # encoded before dumping them to the front matter format.
+        File.write(name, [YAML.dump(meta.to_json), "---", text].join("\n"))
+      end
+    end
+  end
+end

data/lib/yarrow/tools/front_matter.rb

@@ -1,5 +1,7 @@
 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={})
@@ -21,8 +23,8 @@ module Yarrow
           rescue Psych::SyntaxError => error
             if defined? ::Logger
               # todo: application wide logger
-              logger = ::Logger.new(STDOUT)
-              logger.error "#{error.message}"
+              #logger = ::Logger.new(STDOUT)
+              #logger.error "#{error.message}"
             end
             return [content, nil]
           end

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
   APP_NAME = 'Yarrow'
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/yarrow.gemspec

@@ -13,14 +13,13 @@ Gem::Specification.new do |spec|
   spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables << 'yarrow'
   spec.executables << 'yarrow-server'
-  spec.add_runtime_dependency 'hashie', '~> 3.5'
   spec.add_runtime_dependency 'mementus', '~> 0.8'
-  spec.add_runtime_dependency 'activesupport', '~> 5.1'
   spec.add_runtime_dependency 'rack', '~> 2.0'
   spec.add_runtime_dependency 'rack-livereload', '~> 0.3'
   spec.add_runtime_dependency 'eventmachine', '~> 1.2'
   spec.add_runtime_dependency 'em-websocket', '~> 0.5.1'
-  spec.add_runtime_dependency 'sprockets', '~> 3.7'
+  spec.add_runtime_dependency 'strings-inflection', '~> 0.1'
+  spec.add_runtime_dependency 'strings-case', '~> 0.3'
   spec.add_development_dependency 'bundler', '~> 2.2.9'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Mark Rickerby
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: mementus
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -109,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: strings-inflection
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: strings-case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +200,7 @@ files:
 - 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_expander.rb
@@ -223,14 +210,14 @@ files:
 - lib/yarrow/content/source_collector.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
+- lib/yarrow/extensions.rb
+- lib/yarrow/extensions/mementus.rb
 - lib/yarrow/generator.rb
-- lib/yarrow/html.rb
-- lib/yarrow/html/asset_tags.rb
-- lib/yarrow/html/content_tags.rb
 - lib/yarrow/logging.rb
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
+- lib/yarrow/output/web/indexed_file.rb
 - lib/yarrow/process/expand_content.rb
 - lib/yarrow/process/extract_source.rb
 - lib/yarrow/process/project_manifest.rb
@@ -243,8 +230,9 @@ files:
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
 - lib/yarrow/source/graph.rb
+- lib/yarrow/symbols.rb
+- lib/yarrow/tools/content_utils.rb
 - lib/yarrow/tools/front_matter.rb
-- lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
 - lib/yarrow/web/html_document.rb
 - lib/yarrow/web/manifest.rb
@@ -255,7 +243,7 @@ homepage: http://rubygemspec.org/gems/yarrow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -271,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Documentation generator based on a fluent data model.
 test_files: []

data/lib/yarrow/html.rb

@@ -1 +0,0 @@
-require_relative 'html/asset_tags'

data/lib/yarrow/html/asset_tags.rb

@@ -1,59 +0,0 @@
-module Yarrow
-  module HTML
-    module AssetTags
-      include Yarrow::Configurable
-
-      # TODO: make sprockets manifest optional/pluggable
-      def manifest
-        Yarrow::Assets::Manifest.new(config)
-      end
-
-      ##
-      # Computes the base URL path to assets in the public web directory.
-      def base_url_path
-        if config.assets.nil? || config.output_dir.nil?
-          raise Yarrow::ConfigurationError
-        end
-
-        # TODO: prepend configurable CDN URL for host path
-        # TODO: dev/production mode switch
-
-        config.assets.output_dir.gsub(config.output_dir, '')
-      end
-
-      def script_tags
-        manifest.js_logical_paths.map { |path| script_tag(asset: path) }.join("\n")
-      end
-
-      def script_tag(options)
-        src_path = if asset_in_manifest?(options)
-          digest_path(options[:asset])
-        else
-          options[:src]
-        end
-
-        "<script src=\"#{src_path}\"></script>"
-      end
-
-      def link_tag(options)
-        href_path = if asset_in_manifest?(options)
-           digest_path(options[:asset])
-        else
-          options[:href]
-        end
-
-        "<link href=\"#{href_path}\" rel=\"stylesheet\" type=\"text/css\">"
-      end
-
-      private
-
-      def asset_in_manifest?(options)
-        options.has_key?(:asset) and manifest.exists?(options[:asset])
-      end
-
-      def digest_path(path)
-        "#{base_url_path}/#{manifest.digest_path(path)}"
-      end
-    end
-  end
-end

data/lib/yarrow/html/content_tags.rb

@@ -1,7 +0,0 @@
-module Yarrow
-  module HTML
-    module ContentTags
-      
-    end
-  end
-end

data/lib/yarrow/tools/output_file.rb

@@ -1,40 +0,0 @@
-module Yarrow
-  module Tools
-    # TODO: consider renaming this to OutputDocument.
-    class OutputFile
-      include Yarrow::Configurable
-
-      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}")
-
-        FileUtils.mkdir_p(target_path.dirname)
-
-        File.open(target_path.to_s, WRITE_MODE) do |file|
-          file.puts(content)
-        end
-      end
-    end
-  end
-end