yarrow 0.4.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d17bfb242d9562ef5920dae44542a59c519bf0ca6a144295017018b28d294f0
-  data.tar.gz: 9047ab5c8c9f64203093ec60b44ba0c440f5ae24fdbdc78c4450d6d60ce5554e
+  metadata.gz: 30b0321a3081bb91c9f121e41e360b548eab71f03c4cbfded36709473e3cc586
+  data.tar.gz: 67ed41c8e4579d80e211fc08c125410b1f957adfe8e505d778020f02566efd33
 SHA512:
-  metadata.gz: dbf90f57575402bfe1636695facae105ecdd7deb5ee46008a1f6821bedb8a7d78368e592e141537f66d2241fe6faa0a1b563fe04067bcd7e06252cd9291020cf
-  data.tar.gz: 07fee1bb1442ae4f4b5081dee38df672e0800991f06e379f77f1e9609bdb90ff16fc958453847a3acee996b1ff3214fb66557a5bc4ca8d98156390398a3780bf
+  metadata.gz: fcff8cbddd540f7a44d32411c5930a70fff1a86581b5e6efdfc2e1f1eae43afa729b3f254b56581d33bcaf4d30828b2409e3129284a1ba1221823c8a26758fdb
+  data.tar.gz: 485752729e471a4b33f55663f8e762f8d93d1fc9ec29763a2ead843bbda1bb662b210163c723c8dc7d71111693c703e780e8c6f1394c9c317ef254461a3e8d1c

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.7, '3.0', jruby]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,8 @@
+*.tgz
+fabfile.py
+fabfile.pyc
+pirum.xml
+Gemfile.lock
+yarrow-*.gem
+coverage
+bin/scripts

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2010-2014 by Mark Rickerby <http://maetl.net>.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+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]: 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.
+
+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.
+
+Installation
+------------
+
+Install the library and command line tool via RubyGems:
+
+```
+gem install yarrow
+```
+
+Or embed it in an existing Ruby project by adding the following line to the `Gemfile` and running `bundle`:
+
+```
+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 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.
+
+Roadmap
+-------
+
+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 |
+
+License
+-------
+
+MIT. See the `LICENSE` file in the source distribution.
+
+Contact
+-------
+
+Author: Mark Rickerby <me@maetl.net>

data/Rakefile

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path("./lib", __dir__)
+require "yarrow"
+
+task :version do
+  puts Yarrow::VERSION
+end
+
+task :build do
+  sh "gem build yarrow.gemspec"
+end
+
+task :publish do
+  sh "gem push yarrow-#{Yarrow::VERSION}.gem"
+end
+
+task :clean do
+  sh "rm yarrow-*.gem"
+end

data/SERVER.md

@@ -0,0 +1,41 @@
+# Local Dev Server
+
+Yarrow provides a local dev server for quick previews and incremental development of documentation.
+
+## Getting Started
+
+To start the server in the current working directory, run `yarrow-server`:
+
+```
+$ yarrow-server
+```
+
+## Directory Indexes
+
+There are several options that control the behavior of directory indexes:
+
+- `default_index` sets the name of the file used as a default directory index (usually `index.html`).
+- `auto_index` generates a listing of files in the directory when no default index is provided.
+
+## Default Content Type
+
+To set a default content type for files without an automatically detected MIME type or extension, use `default_type`:
+
+```
+default_type: 'text/html'
+```
+
+## Rack Configuration
+
+The following options are available under the `server` entry in the main configuration:
+
+|Option|Type|Description|Default|
+|-|-|-|-|
+|**port**|Integer|Local port for the server to listen on|`8888`|
+|**host**|String|Local host for the server to listen on|`localhost`|
+|**handler**|Symbol (one of `:thin`, `:webrick`, etc)|Specifies the webserver implementation that handles requests|`:thin`|
+|**middleware**|Array|List of Rack middleware to be injected as plugins|
+
+Additional configuration options that are relevant:
+
+`config.output_dir`: If specified, determines the docroot. Otherwise the server defaults to the current working directory.

data/lib/yarrow.rb

@@ -1,20 +1,34 @@
 require 'hashie'
 require 'yaml'
+require 'active_support/inflector'
 
 require 'yarrow/version'
 require 'yarrow/logging'
 require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/generator'
+require 'yarrow/assets'
+require 'yarrow/tools/front_matter'
+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/content_map'
 require 'yarrow/html'
-require 'yarrow/tools/front_matter'
 require 'yarrow/server'
 require 'yarrow/server/livereload'
+require 'yarrow/schema'
+
+require 'yarrow/process/workflow'
+require 'yarrow/process/step_processor'
+require 'yarrow/process/expand_content'
+require 'yarrow/process/extract_source'
+require 'yarrow/process/project_manifest'
 
 # Dir[File.dirname(__FILE__) + '/yarrow/generators/*.rb'].each do |generator|
 #   require generator

data/lib/yarrow/content/collection_expander.rb

@@ -0,0 +1,217 @@
+module Yarrow
+  module Content
+    class CollectionExpander
+      include Yarrow::Tools::FrontMatter
+
+      def initialize(content_types=nil)
+        @content_types = content_types || [
+          Yarrow::Content::ContentType.from_name(:pages)
+        ]
+      end
+
+      def expand(graph)
+        @content_types.each do |content_type|
+          expand_nested(graph, content_type)
+        end
+      end
+
+      def expand_nested(graph, content_type)
+        type = content_type.collection
+        exts = content_type.extensions
+
+        # 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 content_type.match_path == "."
+          graph.n(:root)
+        else
+          graph.n(:root).out(name: type.to_s)
+        end
+
+        # Extract metadata from given start node
+        data = extract_metadata(start_node, type)
+
+        # Collects all nested collections in the subgraph for this content type
+        subcollections = {}
+        index = nil
+
+        # Define alias for accessing metadata in the loop
+        metadata = data
+
+        # Scan and collect all nested directories under the top level source
+        start_node.depth_first.each do |node|
+          if node.label == :directory
+            # Check if this entry has metadata defined at the top level
+            if data[:collections]
+              item = data[:collections].find { |c| c[:slug] == node.props[:slug] }
+              metadata = item if item
+            end
+
+            # Create a collection node representing a collection of documents
+            index = graph.create_node do |collection_node|
+              collection_node.label = :collection
+              collection_node.props[:type] = type
+              collection_node.props[:name] = node.props[:name]
+              collection_node.props[:slug] = node.props[:slug]
+              collection_node.props[:title] = metadata[:title]
+
+              # Override default status so that mapped index collections always show
+              # up in the resulting document manifest, when they don’t have
+              # associated metadata. This is the opposite of how individual pieces
+              # of content behave (default to draft status if one isn’t supplied).
+              collection_node.props[:status] = if data[:status]
+                data[:status]
+              else
+                "published"
+              end
+
+              # TODO: URL generation might need to happen elsewhere
+              collection_node.props[:url] = if data[:url]
+                data[:url]
+              else
+                "#{node.props[:path].split('./content').last}/"
+              end
+            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
+          end
+        end
+
+        subcollections.each do |path, index|
+          # Group files matching the same slug under a common key
+          objects = graph.n(path: path).out(:file).all.select do |file|
+            file.props[:name].end_with?(*exts)
+          end.group_by do |file|
+            file.props[:slug]
+          end
+
+          build_content_nodes(graph, objects, type, index)
+        end
+      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
+
+      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
+
+        # Process collected content objects and generate entity nodes
+        objects.each do |name, sources|
+          item_node = graph.create_node do |node|
+            # TODO: Rename this to :entry and support similar fields to Atom
+            node.label = :item
+            node.props[:name] = name
+            node.props[:type] = content_type
+
+            meta = {}
+            content = ""
+
+            sources.each do |source|
+              body, data = process_content(source.props[:entry])
+              meta.merge!(data) unless data.nil?
+              content << body unless body.nil?
+            end
+
+            if meta[:url]
+              # If a URL is explicitly proided in metadata then use it
+              node.props[:url] = meta[:url]
+            elsif meta[:permalink]
+              # Support for legacy permalink attribute
+              node.props[:url] = meta[:permalink]
+            else
+              # Default URL generation strategy when no explicit URL is provided
+              # TODO: collection nodes need URL generation too
+              # TODO: replace this with URL generation strategy
+              # TODO: slug vs name - why do some nodes have 2 and some 3 props?
+              node.props[:url] = if parent_index.props[:name].to_sym == parent_index.props[:type]
+                "/#{parent_index.props[:type]}/#{name}"
+              else
+                "/#{parent_index.props[:type]}/#{parent_index.props[:slug]}/#{name}"
+              end
+            end
+
+            # For now, we are storing title, url, etc on the top-level item.
+            node.props[:title] = meta[:title]
+
+            # TODO: What belongs on the entity and what belongs on the item?
+            entity_props = meta.merge(body: content, name: meta[:id], url: node.props[:url])
+
+
+            # 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))
+            rescue
+              require "ostruct"
+              content_struct = OpenStruct
+            end
+
+            node.props[:entity] = content_struct.new(entity_props)
+          end
+
+          # Connect entity with source content
+          sources.each do |source|
+            graph.create_edge do |edge|
+              edge.label = :source
+              edge.from = item_node
+              edge.to = source.id
+            end
+          end
+
+          # Connect entity with parent collection
+          graph.create_edge do |edge|
+            edge.label = :child
+            edge.from = parent_index
+            edge.to = item_node
+          end
+        end
+      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/content_type.rb

@@ -0,0 +1,38 @@
+module Yarrow
+  module Content
+    class ContentType
+      DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
+
+      def self.from_name(name)
+        new(Yarrow::Configuration.new(collection: name.to_sym))
+      end
+
+      def initialize(properties)
+        unless properties.respond_to?(:collection) || properties.respond_to?(:entity)
+          raise "Must provide a collection name or entity name"
+        end
+
+        @properties = properties
+      end
+
+      def collection
+        return @properties.collection if @properties.respond_to?(:collection)
+        ActiveSupport::Inflector.pluralize(@properties.entity).to_sym
+      end
+
+      def entity
+        return @properties.entity if @properties.respond_to?(:entity)
+        ActiveSupport::Inflector.singularize(@properties.collection).to_sym
+      end
+
+      def extensions
+        return @properties.extensions if @properties.respond_to?(:extensions)
+        DEFAULT_EXTENSIONS
+      end
+
+      def match_path
+        "."
+      end
+    end
+  end
+end

data/lib/yarrow/content/graph.rb

@@ -0,0 +1,58 @@
+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)
+      end
+
+      attr_reader :graph, :config
+
+      def initialize(graph, config)
+        @graph = graph
+        @config = config
+      end
+
+      def expand_pages
+        expander = Yarrow::Content::CollectionExpander.new(config.content_types)
+        expander.expand(graph)
+      end
+
+      # List of source files.
+      def files
+        graph.nodes(:file)
+      end
+
+      # List of source directories.
+      def directories
+        graph.nodes(:directory)
+      end
+    end
+  end
+end

data/lib/yarrow/content/source.rb

@@ -0,0 +1,11 @@
+module Yarrow
+  module Content
+    class Source
+      attr_reader :input_dir
+
+      def initialize(config)
+        @input_dir = config[:input_dir]
+      end
+    end
+  end
+end

data/lib/yarrow/content/source_collector.rb

@@ -0,0 +1,55 @@
+module Yarrow
+  module Content
+    # Collects a digraph of all directories and files underneath the given input
+    # directory.
+    class SourceCollector
+      def self.collect(input_dir)
+        Mementus::Graph.new(is_mutable: true) do
+          root = create_node do |root|
+            root.label = :root
+          end
+
+          directories = {
+            Pathname.new(input_dir).to_s => root.id
+          }
+
+          Pathname.glob("#{input_dir}/**/**").each do |entry|
+            if entry.directory?
+              #puts "Reading directory: #{entry}"
+
+              content_node = create_node do |dir|
+                dir.label = :directory
+                dir.props[:name] = entry.basename.to_s
+                dir.props[:slug] = entry.basename.to_s
+                dir.props[:path] = entry.to_s
+                dir.props[:entry] = entry
+              end
+
+              directories[entry.to_s] = content_node.id
+            else
+              #puts "Reading file: #{entry} (#{entry.basename.sub_ext('')})"
+
+              content_node = create_node do |file|
+                file.label = :file
+                file.props[:name] = entry.basename.to_s
+                file.props[:slug] = entry.basename.sub_ext('').to_s
+                file.props[:path] = entry.to_s
+                file.props[:entry] = entry
+              end
+            end
+
+            if directories.key?(entry.dirname.to_s)
+              #puts "Create parent edge: #{directories[entry.dirname.to_s]}"
+
+              create_edge do |edge|
+                edge.label = :child
+                edge.from = directories[entry.dirname.to_s]
+                edge.to = content_node
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/output/context.rb

@@ -1,15 +1,12 @@
 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.
-    # 
-    # Includes the library of helpers for dynamically generating HTML tags.
+    # 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)
@@ -19,6 +16,5 @@ module Yarrow
         end
       end
     end
-
   end
 end

data/lib/yarrow/process/expand_content.rb

@@ -0,0 +1,12 @@
+module Yarrow
+  module Process
+    class ExpandContent < StepProcessor
+      accepts String
+      provides String
+
+      def step(source)
+        "#{source} | ExpandContent::Result"
+      end
+    end
+  end
+end

data/lib/yarrow/process/extract_source.rb

@@ -0,0 +1,12 @@
+module Yarrow
+  module Process
+    class ExtractSource < StepProcessor
+      accepts String
+      provides String
+
+      def step(source)
+        "#{source} | ExtractSource::Result"
+      end
+    end
+  end
+end

data/lib/yarrow/process/project_manifest.rb

@@ -0,0 +1,20 @@
+module Yarrow
+  module Process
+    class ProjectManifest < StepProcessor
+      accepts String
+      provides String
+
+      def before_step(content)
+
+      end
+
+      def step(content)
+        "#{content} | ProjectManifest::Result"
+      end
+
+      def after_step(content)
+
+      end
+    end
+  end
+end

data/lib/yarrow/process/step_processor.rb

@@ -0,0 +1,43 @@
+module Yarrow
+  module Process
+    class StepProcessor
+      attr_reader :source
+
+      class << self
+        attr_reader :accepted_input, :provided_output
+
+        def accepts(input_const)
+          @accepted_input = input_const.to_s
+        end
+
+        def provides(output_const)
+          @provided_output = output_const.to_s
+        end
+      end
+
+      def initialize
+        @source = nil
+      end
+
+      def accepts
+        self.class.accepted_input
+      end
+
+      def provides
+        self.class.provided_output
+      end
+
+      def can_accept?(provided)
+        accepts == provided
+      end
+
+      def process(source)
+        # begin
+        result = step(source)
+        # log.info("<Result source=#{result}>")
+        # rescue
+        result
+      end
+    end
+  end
+end

data/lib/yarrow/process/workflow.rb

@@ -0,0 +1,36 @@
+module Yarrow
+  module Process
+    class Workflow
+      def initialize(input)
+        @input = input
+        @processors = []
+      end
+
+      def connect(processor)
+        provided_input = if @processors.any?
+          @processors.last.provides
+        else
+          @input.class.to_s
+        end
+
+        if processor.can_accept?(provided_input)
+          @processors << processor
+        else
+          raise ArgumentError.new(
+            "`#{processor.class}` accepts `#{processor.accepts}` but was connected to `#{provided_input}`"
+          )
+        end
+      end
+
+      def process(&block)
+        result = @input
+
+        @processors.each do |processor|
+          result = processor.process(result)
+        end
+
+        block.call(result)
+      end
+    end
+  end
+end

data/lib/yarrow/schema.rb

@@ -0,0 +1,120 @@
+module Yarrow
+  module Schema
+    module Type
+      class Any
+      end
+    end
+
+    ##
+    # Checks values plugged into each slot and runs any required validations
+    # (validations not yet implemented).
+    #
+    # Current design throws on error rather than returns a boolean result.
+    class Validator
+      # @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 == @spec.keys.length
+
+        fields.keys.each do |key|
+          raise "key does not exist" unless @spec.key?(key)
+        end
+      end
+    end
+
+    ##
+    # Value object (with comparison by value equality). This just chucks back a
+    # Ruby struct but wraps the constructor with method advice that handles
+    # validation (and eventually type coercion if !yagni).
+    class Value
+      def self.new(*slots, **fields, &block)
+        factory(*slots, **fields, &block)
+      end
+
+      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_spec, keyword_init: true, &block)
+
+        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(**attr_values)
+
+          freeze
+        end
+
+        struct
+      end
+    end
+
+    ##
+    # Entity with comparison by reference equality. Generates attribute helpers
+    # for a declared set of props. Used to replace Hashie::Mash without dragging
+    # in a whole new library.
+    class Entity
+      class << self
+        def attribute(name, value_type)
+          # define_method("map_#{name}".to_sym) do |input|
+          #   value_type.coerce(input)
+          # end
+          dictionary[name] = value_type
+          attr_reader(name)
+        end
+
+        def dictionary
+          @dictionary ||= Hash.new
+        end
+      end
+
+      def dictionary
+        self.class.dictionary
+      end
+
+      def initialize(config)
+        dictionary.each_key do |name|
+          raise "missing declared attribute #{name}" unless dictionary.key?(name)
+        end
+
+        config.each_pair do |key, value|
+          raise "#{key} not a declared attribute" unless dictionary.key?(key)
+
+          defined_type = dictionary[key]
+
+          unless value.is_a?(defined_type)
+            raise "#{key} accepts #{defined_type} but #{value.class} given"
+          end
+
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+
+    def to_h
+      dictionary.keys.reduce({}) do |h, name|
+        h[name] = instance_variable_get("@#{name}")
+      end
+    end
+  end
+end

data/lib/yarrow/server.rb

@@ -16,6 +16,7 @@ module Yarrow
     # Rack Middleware for detecting and serving an 'index.html' file
     # instead of a directory index.
     #
+    # TODO: Fix bug where a directory /index.html/ causes this to crash
     # TODO: Add configurable mapping and media types for README files as an alternative
     class DirectoryIndex
       def initialize(app, options={})

data/lib/yarrow/source/graph.rb

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

data/lib/yarrow/tools/front_matter.rb

@@ -13,7 +13,7 @@ module Yarrow
 
           begin
             if options.key?(:symbolize_keys)
-              meta = symbolize_keys(YAML.load($1))
+              meta = YAML.load($1, symbolize_names: true)
             else
               meta = YAML.load($1)
             end
@@ -30,22 +30,6 @@ module Yarrow
 
         [text, nil]
       end
-
-      def symbolize_keys(hash)
-        hash.inject({}) do |result, (key, value)|
-          new_key = case key
-                    when String then key.to_sym
-                    else key
-                    end
-          new_value = case value
-                      when Hash then symbolize_keys(value)
-                      when Array then value.map { |entry| symbolize_keys(entry) }
-                      else value
-                      end
-          result[new_key] = new_value
-          result
-        end
-      end
     end
   end
 end

data/lib/yarrow/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Yarrow
-  APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.4.2'.freeze
+  APP_NAME = 'Yarrow'
+  VERSION = '0.6.1'
 end

data/lib/yarrow/web/html_document.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class HTMLDocument
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/manifest.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Manifest
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/static_asset.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class StaticAsset
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/template.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Template
+      def initialize
+
+      end
+    end
+  end
+end

data/yarrow.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'yarrow/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'yarrow'
+  spec.version     = Yarrow::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.summary     = 'Documentation generator based on a fluent data model.'
+  spec.description = 'Yarrow is a tool for generating well structured documentation from a variety of input sources.'
+  spec.authors     = ['Mark Rickerby']
+  spec.email       = 'me@maetl.net'
+  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_development_dependency 'bundler', '~> 2.2.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8.23'
+  spec.add_development_dependency 'rack-test', '~> 0.8'
+  spec.homepage = 'http://rubygemspec.org/gems/yarrow'
+  spec.license = 'MIT'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -108,62 +108,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +201,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SERVER.md
 - bin/yarrow
 - bin/yarrow-server
 - lib/yarrow.rb
@@ -195,6 +216,11 @@ files:
 - lib/yarrow/assets/pipeline.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
+- lib/yarrow/content/collection_expander.rb
+- lib/yarrow/content/content_type.rb
+- lib/yarrow/content/graph.rb
+- lib/yarrow/content/source.rb
+- lib/yarrow/content/source_collector.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
 - lib/yarrow/generator.rb
@@ -205,11 +231,26 @@ files:
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
+- lib/yarrow/process/expand_content.rb
+- lib/yarrow/process/extract_source.rb
+- lib/yarrow/process/project_manifest.rb
+- lib/yarrow/process/step_processor.rb
+- lib/yarrow/process/workflow.rb
+- lib/yarrow/schema.rb
+- lib/yarrow/schema/validations/array.rb
+- lib/yarrow/schema/validations/object.rb
+- lib/yarrow/schema/validations/string.rb
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
+- lib/yarrow/source/graph.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
+- lib/yarrow/web/static_asset.rb
+- lib/yarrow/web/template.rb
+- yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:
 - MIT
@@ -229,8 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Documentation generator based on a fluent data model.