yarrow 0.7.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dba4f651517ceb22a806d2ac97637327983742ce4d6837ec0cc85cb4b9864c3
-  data.tar.gz: d7b2db29b33539da364b386023a662db2e4f5bcc009869444de005ae74f919fb
+  metadata.gz: d26941f2b464c551d825b73999b0365637b9e4feec159ee74de51a1abca3416e
+  data.tar.gz: 34081172c945cf83e97ab3ee03484436ba380de6c809c2dd87caaa50f1bba315
 SHA512:
-  metadata.gz: 0b6b0550245ef7ac0f752c602bcc1a191a8260cf8e4a3553b77f1a600d82ebf773e97adcaffa2bc1ed1d913af9a32d5d183472fdabcabd9ba3e61a52cc9155eb
-  data.tar.gz: '099eeb8f8f90867144ad3ca2586d353b1b69e38af9534923c0856410b944592e48847b49650d0526af724f74851ad8f93205fc2032b864eb1a854c0d3f59475a'
+  metadata.gz: 6300e2c0f83c741862cf6c49acc42118636a3832401706057b483d942c07a947ea1124b2c10e056cc5052e25a28a59f896216d0156911026639d16e0faa5ba73
+  data.tar.gz: 0b897183df8712cbc08d0a479ed1e1d129a90305ad76f9bc802ea262707026ff5ffa57890d0d26d49955f55721ffd0887510671c86430e4780564266758ebaed

data/.gitignore

@@ -7,3 +7,6 @@ yarrow-*.gem
 coverage
 bin/scripts
 .DS_Store
+/www
+/web
+/docs

data/lib/yarrow/config.rb

@@ -37,17 +37,23 @@ module Yarrow
       :port,
       :host,
       :handler,
-      #:docroot,
-      :middleware,
-      #:root_dir
+      :middleware
     )
 
-    # Content policy 
-    # Model = Yarrow::Schema::Value.new(
-
-    # )
+    class Output < Yarrow::Schema::Entity[:output]
+      attribute :generator, :string
+      attribute :template_dir, :path
+      #attribute :scripts, :array
+    end
 
     # Top level root config namespace.
+    class Instance < Yarrow::Schema::Entity
+      attribute :source_dir, :path
+      attribute :output_dir, :path
+      attribute :meta, :any
+      attribute :server, :any
+      #attribute :output, :output
+    end
     #
     # `content_dir` and `output_dir` are placeholders and should be overriden
     # with more fine-grained config for web and book outputs in future.
@@ -56,12 +62,12 @@ module Yarrow
     # server locally.
     #
     # TODO: meta should be union of Type::Optional and Config::Meta
-    Instance = Yarrow::Schema::Value.new(
-      project_dir: :path,
-      content_dir: :path,
-      output_dir: :path,
-      meta: :any,
-      server: :any
-    )
+    # Instance = Yarrow::Schema::Value.new(
+    #   project_dir: :path,
+    #   content_dir: :path,
+    #   output_dir: :path,
+    #   meta: :any,
+    #   server: :any
+    # )
   end
 end

data/lib/yarrow/configuration.rb

@@ -52,13 +52,11 @@ module Yarrow
         # 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[:project_dir] || ""
-        content_dir_or_string = config[:content_dir] || ""
+        source_dir_or_string = config[:source_dir] || ""
 
         Yarrow::Config::Instance.new(
           output_dir: Pathname.new(File.expand_path(out_dir_or_string)),
-          project_dir: Pathname.new(File.expand_path(source_dir_or_string)),
-          content_dir: Pathname.new(File.expand_path(content_dir_or_string)),
+          source_dir: Pathname.new(File.expand_path(source_dir_or_string)),
           meta: meta_obj,
           server: server_obj
         )

data/lib/yarrow/console_runner.rb

@@ -1,6 +1,5 @@
 module Yarrow
   class ConsoleRunner
-
     SUCCESS = 0
     FAILURE = 1
 
@@ -12,20 +11,20 @@ module Yarrow
     }
 
     ALLOWED_CONFIG_FILES = [
-      '.yarrowdoc',
-      'Yarrowdoc'
+      ".yarrowdoc",
+      "Yarrowdoc",
+      "yarrow.yml"
     ]
 
-    def initialize(arguments, io=STDOUT)
+    def initialize(args, io=STDOUT)
+      @arguments = args
       @out = io
-      @arguments = arguments
       @options = {}
       @targets = []
-      @config = Configuration.load_defaults
     end
 
     def config
-      @config
+      @config ||= Configuration.load_defaults
     end
 
     def run_application
@@ -45,9 +44,7 @@ module Yarrow
 
         process_configuration
 
-        run_input_process
-
-        run_output_process
+        run_generation_process
 
         print_footer
 
@@ -80,17 +77,29 @@ module Yarrow
 
     def process_configuration
       # load_configuration(Dir.pwd)
+      default_config = Yarrow::Configuration.load_defaults
+
+      if @targets.empty?
+        @config = default_config
+      else
+        @config = Yarrow::Config::Instance.new(
+          output_dir: default_config.output_dir,
+          source_dir: @targets.first,
+          meta: default_config.meta,
+          server: default_config.meta
+        )
+      end
 
       # @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
+      # if has_option?(:config)
+      #   path = @options[:config]
+      #   @config.deep_merge! Configuration.load(path)
+      # end
 
-      @config.options = @options.to_hash
+      #@config.options = @options.to_hash
 
       # normalize_theme_path
 
@@ -139,9 +148,7 @@ module Yarrow
 
     def run_generation_process
       generator = Generator.new(@config)
-      generator.process do |manifest|
-        p manifest
-      end
+      generator.generate
     end
 
     def print_header
@@ -149,7 +156,7 @@ module Yarrow
     end
 
     def print_footer
-      @out.puts "Content generated at {path}!"
+      @out.puts "Content generated at #{@config.output_dir}"
     end
 
     def print_error(e)
@@ -157,42 +164,8 @@ module Yarrow
     end
 
     def print_help
-      help = <<HELP
-  See http://yarrow.maetl.net for more information.
-
-  Usage:
-
-   $ yarrow [options]
-   $ yarrow [options] <input>
-   $ yarrow [options] <input input> <output>
-
-   Arguments
-
-   <input>  -  Path to source directory or an individual source file. If not supplied
-               defaults to the current working directory. Multiple directories
-               can be specified by repeating arguments, separated by whitespace.
-
-   <output> -  Path to the generated documentation. If not supplied, defaults to
-               ./docs in the current working directory. If it does not exist, it
-               is created. If it does exist it remains in place, but existing
-               files are overwritten by new files with the same name.
-
-   Options
-
-   Use -o or --option for boolean switches and --option=value or --option:value
-   for options that require an explicit value to be set.
-
-    -h    --help          [switch]    Display this help message and exit
-    -v    --version       [switch]    Display version header and exit
-    -c    --config        [string]    Path to a config properties file
-    -p    --packages   	  [string]    Defines package convention for the model
-    -t    --theme         [string]    Template theme for generated docs
-
-
-HELP
-      @out.puts help
+      help_path = Pathname.new(__dir__) + "help.txt"
+      @out.puts(help_path.read)
     end
-
   end
-
 end

data/lib/yarrow/content/graph.rb

@@ -7,7 +7,7 @@ module Yarrow
       #
       # @return [Yarrow::Content::Graph]
       def self.from_source(config)
-        new(Source.collect(config.content_dir), config)
+        new(Source.collect(config.source_dir), config)
       end
 
       attr_reader :graph, :config

data/lib/yarrow/content/policy.rb

@@ -8,6 +8,8 @@ module Yarrow
         :match_path
       )
 
+      DEFAULT_HOME_NESTING = false
+
       DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
 
       DEFAULT_MATCH_PATH = "."

data/lib/yarrow/content/tree_expansion.rb

@@ -6,11 +6,6 @@ module Yarrow
         #policy.match()
 
         #p graph.n(:root).out(:directory).first.props[:name]
-
-        expand_impl(policy)
-      end
-
-      def expand_impl(policy)
         type = policy.container
 
         # If match path represents entire content dir, then include the entire
@@ -18,13 +13,14 @@ module Yarrow
         # the collection.
         #start_node = if policy.match_path == "."
         start_node = if true
-          graph.n(:root)
+          # TODO: match against source_dir
+          graph.n(:root).out(:directory)
         else
-          graph.n(:root).out(name: type.to_s)
+          graph.n(:root).out(name: policy.container.to_s)
         end
 
         # Extract metadata from given start node
-        collection_metadata = extract_metadata(start_node, type)
+        collection_metadata = extract_metadata(start_node, policy.container)
 
         # Collect all nested collections in the subgraph for this content type
         subcollections = {}
@@ -37,7 +33,7 @@ module Yarrow
             # 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[:type] = policy.container
               collection_node.props[:name] = node.props[:name]
 
               # TODO: title needs to be defined from metadata

data/lib/yarrow/defaults.yml

@@ -1,15 +1,13 @@
 # Default configuration settings for Yarrow.
 # This is loaded when the configuration is initialized.
-input_dir: content
-output_dir: .
+source_dir: content
+output_dir: docs
 meta:
   title: Default Project
   author: Default Name
 output:
-  target_dir: public
+  generator: web
   template_dir: templates
-  object_map:
-    page: Yarrow::Model::Site.pages
 assets:
   input_dir: assets
   output_dir: public/assets

data/lib/yarrow/generator.rb

@@ -21,17 +21,17 @@ module Yarrow
 
   class FlattenManifest < Process::StepProcessor
     accepts Content::Graph
-    provides Content::Manifest
+    provides Web::Manifest
 
     def step(content)
-      Content::Manifest.build(content.graph)
+      Web::Manifest.build(content.graph)
     end
   end
 
-  class BuildOutput < Process::StepProcessor
-    accepts Content::Manifest
-    provides Output::Result
-  end
+  # class BuildOutput < Process::StepProcessor
+  #   accepts Output::Manifest
+  #   provides Output::Result
+  # end
 
   # Generates documentation from a model.
   class Generator
@@ -50,8 +50,20 @@ module Yarrow
       end
     end
 
+    def generate
+      process do |manifest|
+        generators.each do |generator|
+          generator.generate(manifest)
+        end
+      end
+    end
+
     private
 
     attr_reader :config, :workflow
+
+    def generators
+      [Web::Generator.new(config)]
+    end
   end
 end

data/lib/yarrow/help.txt

@@ -0,0 +1,35 @@
+See https://github.com/maetl/yarrow for more information.
+
+Usage: yarrow [options] <source_dir...> <output_dir>
+
+yarrow [options]
+yarrow [options] <source_dir>
+yarrow [options] <source_dir> <output_dir>
+yarrow [options] <source_dir source_dir> <output_dir>
+
+Arguments
+
+<source_dir> - Path to source directory or an individual source file. If not
+               supplied defaults to the current working directory. Multiple
+               directories can be specified by repeating arguments, separated
+               by whitespace.
+
+<output_dir> - Path to the generated documentation. If not supplied, defaults
+               to `./docs` in the current working directory. If it does not
+               exist, it is created. If it does exist it remains in place, but
+               existing files are overwritten by new files with the same name.
+
+Options
+
+Use -o or --option for boolean switches and --option=value or --option:value
+for options that require an explicit value to be set.
+
+  -h    --help        [switch]    Display this help message and exit
+  -v    --version     [switch]    Display version header and exit
+  -c    --config      [string]    Path to a config properties file
+  -p    --packages    [string]    Defines package convention for the model
+  -t    --theme       [string]    Template theme for generated docs
+
+Not all these options currently work as they date back to when this library
+was used for generating documentation for PHP codebases, before it was
+generalised into a static site generator.

data/lib/yarrow/schema/definitions.rb

@@ -2,12 +2,18 @@ module Yarrow
   module Schema
     module Definitions
       DEFINED_TYPES = {
-        #string: Types::String,
         string: Types::Instance.of(String),
-        #integer: Types::Integer,
         integer: Types::Instance.of(Integer),
-        path: Types::Instance.of(Pathname),
-        any: Types::Any.new
+        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),
+        hash: Types::Map.of(Symbol => Types::Any)
+      }
+
+      TEMPLATE_TYPES = {
+        list: Types::List,
+        map: Types::Map
       }
 
       def self.register(identifier, type_class)
@@ -19,13 +25,43 @@ module Yarrow
       end
 
       def resolve_type(identifier)
-        #return identifier unless identifier.is_a?(Symbol)
+        # Type is directly resolvable from the definition table
+        return DEFINED_TYPES[identifier] if DEFINED_TYPES.key?(identifier)
 
-        unless DEFINED_TYPES.key?(identifier)
-          raise "#{identifier} is not defined"
-        end
+        if identifier.is_a?(Hash)
+          # If type identifier is a compound template extract its key and value mapping
+          key_id = identifier.keys.first
+          value_id = identifier.values.first
 
-        return DEFINED_TYPES[identifier]
+          # Check if the given key is defined as a template type
+          unless TEMPLATE_TYPES.key?(key_id)
+            raise "compound type #{key_id} is not defined"
+          end
+
+          # Get reference to the type class we want to resolve
+          template_type = TEMPLATE_TYPES[key_id]
+          
+          # Resolve the type to an instance depending on structure of its template args
+          resolved_type = if value_id.is_a?(Hash)
+            # Map template with two argument constructor
+            template_type.new(
+              resolve_type(value_id.keys.first),
+              resolve_type(value_id.values.first)
+            )
+          else
+            # Use the single arg constructor with the given unit type
+            template_type.of(resolve_type(value_id).unit)
+          end
+
+          # Cache the resolved type for later reference
+          DEFINED_TYPES[identifier] = resolved_type
+          
+          # Return the resolve type
+          resolved_type
+        else
+          # Not a compound template so we know it’s missing in the lookup table
+          raise "type #{identifier} is not defined"
+        end
       end
     end
   end

data/lib/yarrow/schema/entity.rb

@@ -13,6 +13,19 @@ module Yarrow
         def dictionary
           @dictionary ||= Dictionary.new({})
         end
+
+        def [](label)
+          @label = label
+          self
+        end
+
+        def inherited(class_name)
+          if @label
+            class_type = Yarrow::Schema::Types::Instance.of(class_name)
+            Yarrow::Schema::Definitions.register(@label, class_type)
+            @label = nil
+          end
+        end
       end
 
       def initialize(config)
@@ -33,11 +46,26 @@ module Yarrow
 
       def to_h
         dictionary.attr_names.reduce({}) do |attr_dict, name|
-          attr_dict[name] = instance_variable_get("@#{name}")
+          value = instance_variable_get("@#{name}")
+
+          attr_dict[name] = if value.respond_to?(:to_h)
+            value.to_h
+          else
+            value
+          end
+
           attr_dict
         end
       end
 
+      def merge(other)
+        unless other.is_a?(self.class)
+          raise ArgumentError.new("cannot merge entities that are not the same type")
+        end
+
+        self.class.new(to_h.merge(other.to_h))
+      end
+
       private
 
       def dictionary

data/lib/yarrow/schema/registry.rb

@@ -0,0 +1,14 @@
+module Yarrow
+  module Schema
+    class Registry
+      def type(identifier, type_class)
+        Definitions.register(identifier, type_class)
+      end
+    end
+
+    def self.define(&block)
+      instance = Registry.new
+      instance.instance_eval(&block)
+    end
+  end
+end

data/lib/yarrow/schema/types.rb

@@ -18,20 +18,20 @@ module Yarrow
           new("#{t} does not implement #{m}")
         end
       end
-  
+
       class TypeClass
         def self.of(unit_type)
           new(unit_type)
         end
 
         attr_reader :unit, :accepts
-  
+
         def initialize(unit_type=nil)
           @unit = unit_type
           @accepts = {}
         end
 
-        def accept(type, constructor)
+        def accept(type, constructor=:new)
           accepts[type] = constructor
           self
         end
@@ -44,7 +44,7 @@ module Yarrow
           constructor = accepts[input.class]
           unit.send(constructor, input)
         end
-  
+
         def check_instance_of!(input)
           unless input.instance_of?(unit)
             raise CastError.instance_of(input.class, unit)
@@ -74,27 +74,27 @@ module Yarrow
           check(input)
         end
       end
-  
+
       class Any < TypeClass
         def cast(input)
           input
         end
       end
-  
+
       class Instance < TypeClass
         def check(input)
           check_instance_of!(input)
           input
         end
       end
-  
+
       class Kind < TypeClass
         def check(input)
           check_kind_of!(input)
           input
         end
       end
-  
+
       class Interface < TypeClass
         def self.any(*args)
           interface_type = new(args)
@@ -117,7 +117,7 @@ module Yarrow
           when :any then check_respond_to_any!(input, members)
           when :all then check_respond_to_all!(input, members)
           end
-          
+
           input
         end
       end
@@ -192,4 +192,4 @@ module Yarrow
       end
     end
   end
-end
+end

data/lib/yarrow/schema/value.rb

@@ -50,6 +50,32 @@ module Yarrow
           freeze
         end
 
+        struct.define_method(:merge) do |other|
+          unless other.is_a?(self.class)
+            raise ArgumentError.new("cannot merge incompatible values")
+          end
+
+          kwargs = validator.attr_names.reduce({}) do |data, attr_name|
+            current_val = self.send(attr_name)
+            other_val = other.send(attr_name)
+
+            # TODO: handle optional types better
+            # call out to dictionary?
+            # validator.merge(attr_name, current_val, other_val)
+            data[attr_name] = if current_val.nil?
+              other_val
+            elsif other_val.nil?
+              current_val
+            else
+              other_val
+            end
+
+            data
+          end
+
+          struct.new(**kwargs)
+        end
+
         struct
       end
     end

data/lib/yarrow/server.rb

@@ -96,7 +96,7 @@ module Yarrow
 
       app_args = [docroot, {}].tap { |args| args.push(default_type) if default_type }
 
-      static_app = Rack::File.new(*app_args)
+      static_app = Rack::Files.new(*app_args)
 
       if live_reload?
         require 'rack-livereload'

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
-  APP_NAME = 'Yarrow'
-  VERSION = '0.7.6'
+  APP_NAME = "Yarrow"
+  VERSION = "0.8.1"
 end

data/lib/yarrow/web/document.rb

@@ -0,0 +1,42 @@
+module Yarrow
+  module Web
+    class Document
+      # This class is somewhat verbose for simplicity and long-term maintainability
+      # (having a clear and easy to follow construction, rather than doing anything
+      # too clever which has burned this lib in the past).
+      def initialize(item, parent, is_index)
+        @item = item
+        @parent = parent
+        @is_index = is_index
+      end
+
+      def name
+        @item.props[:name]
+      end
+
+      def title
+        @item.props[:title]
+      end
+
+      def type
+        @item.props[:type]
+      end
+
+      def url
+        if @parent.nil?
+          "/"
+        else
+          segments = [@item.props[:name]]
+          current = @parent
+
+          until current.in(:collection).first.nil? do
+            segments << current.props[:name]
+            current = current.in(:collection).first
+          end
+
+          "/" + segments.reverse.join("/")
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/web/generator.rb

@@ -0,0 +1,57 @@
+module Yarrow
+  module Web
+    class Generator
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+        # Config is here but we haven’t decided on schema for web publishing fields
+        # so hard-code the needed values as part of this prototype
+        @default_host = "http://example.com"
+      end
+
+      def generate(manifest)
+        Parallel.each(manifest.documents) do |document|
+          write_document(document)
+        end
+        #generate_sitemap(manifest)
+      end
+
+      def write_document(document)
+        template = Template.for_document(document)
+        write_output_file(document.url, template.render(document))
+      end
+
+      def write_output_file(url, content)
+        # If the target path is a directory,
+        # generate a default index filename.
+        if url[url.length-1] == '/'
+          url = "#{url}index"
+        end
+
+        # Construct full path to file in output dir
+        path = @config.output_dir.join(url.delete_prefix("/")).sub_ext('.html')
+
+        # Create directory path if it doesn’t exist
+        FileUtils.mkdir_p(path.dirname)
+
+        # Write out the file
+        File.open(path.to_s, 'w+:UTF-8') do |file|
+          file.puts(content)
+        end
+      end
+
+      def generate_sitemap(manifest)
+        # SitemapGenerator::Sitemap.default_host = @default_host
+        # SitemapGenerator::Sitemap.public_path = @public_dir
+        # SitemapGenerator::Sitemap.create do
+        #   manifest.documents.each do |document|
+        #     # Options: :changefreq, :lastmod, :priority, :expires
+        #     #add(document.url, lastmod: document.published_at)
+        #     add(document.url)
+        #   end
+        # end
+      end
+    end
+  end
+end

data/lib/yarrow/web/manifest.rb

@@ -1,8 +1,64 @@
 module Yarrow
   module Web
     class Manifest
+      def self.build(graph)
+        manifest = new
+
+        graph.n(:collection).each do |collection|
+          # TODO: raise error if both content_only and index_only are set
+          index = nil
+
+          # If the collection is tagged :index_only then skip adding individual documents
+          unless collection.props[:index_only]
+            collection.out(:item).each do |item|
+              #if item[:entity].status.to_sym == :published
+              if item.props[:name] == "index"
+                index = item
+              else
+                manifest.add_document(item_context(item))
+              end
+              #end
+            end
+          end
+
+          # If the collection is tagged :content_only then skip top level listing/index
+          unless collection.props[:content_only]
+            if index
+              manifest.add_document(collection_index_context(collection, index))
+            else 
+              manifest.add_document(collection_context(collection))
+            end
+          end
+        end
+
+        manifest
+      end
+
+      attr_reader :documents, :assets
+
       def initialize
+        @documents = []
+        @assets = []
+      end
+
+      def add_document(document)
+        @documents << document
+      end
+
+      def add_asset(asset)
+        @assets << asset
+      end
+
+      def self.collection_context(collection)
+        Document.new(collection, collection.in(:collection).first, true)
+      end
+
+      def self.collection_index_context(collection, item)
+        Document.new(item, collection.in(:collection).first, false)
+      end
 
+      def self.item_context(item)
+        Document.new(item, item.in(:collection).first, false)
       end
     end
   end

data/lib/yarrow/web/template.rb

@@ -1,8 +1,28 @@
 module Yarrow
   module Web
     class Template
-      def initialize
+      def self.for_document(document)
+        layout_name = if document.respond_to?(:layout)
+          document.layout || document.type
+        else
+          document.type
+        end
 
+        @template_dir = "./spec/fixtures/templates/doctest"
+        @template_ext = ".html"
+
+        template_file = "#{layout_name}#{@template_ext}"
+        template_path = Pathname.new(@template_dir) + template_file
+
+        new(template_path.read)
+      end
+
+      def initialize(source)
+        @source = source
+      end
+
+      def render(document)
+        Mustache.render(@source, document)
       end
     end
   end

data/lib/yarrow.rb

@@ -1,46 +1,50 @@
-require 'pathname'
-require 'yaml'
+require "pathname"
+require "yaml"
+require "mustache"
+require "parallel"
 
-require 'yarrow/version'
-require 'yarrow/extensions'
-require 'yarrow/symbols'
-require 'yarrow/logging'
-require 'yarrow/schema/types'
-require 'yarrow/schema/definitions'
-require 'yarrow/schema/dictionary'
-require 'yarrow/schema/entity'
-require 'yarrow/schema/value'
-require 'yarrow/config'
-require 'yarrow/configuration'
-require 'yarrow/console_runner'
-require 'yarrow/tools/front_matter'
-require 'yarrow/tools/content_utils'
-require 'yarrow/content/graph'
-require 'yarrow/content/source'
-require 'yarrow/content/expansion'
-require 'yarrow/content/expansion_strategy'
-require 'yarrow/content/tree_expansion'
-require 'yarrow/content/manifest'
-require 'yarrow/content/resource'
-require 'yarrow/content/model'
-require 'yarrow/content/policy'
-require 'yarrow/output/mapper'
-require 'yarrow/output/generator'
-require 'yarrow/output/context'
-require 'yarrow/output/result'
-require 'yarrow/output/web/indexed_file'
-require 'yarrow/content_map'
-require 'yarrow/server'
-require 'yarrow/server/livereload'
+require "extensions/mementus"
 
-require 'yarrow/process/workflow'
-require 'yarrow/process/step_processor'
-require 'yarrow/process/expand_content'
-require 'yarrow/process/extract_source'
-require 'yarrow/process/project_manifest'
+require "yarrow/version"
+require "yarrow/symbols"
+require "yarrow/logging"
+require "yarrow/schema/types"
+require "yarrow/schema/definitions"
+require "yarrow/schema/dictionary"
+require "yarrow/schema/entity"
+require "yarrow/schema/value"
+require "yarrow/schema/registry"
+require "yarrow/config"
+require "yarrow/configuration"
+require "yarrow/console_runner"
+require "yarrow/tools/front_matter"
+require "yarrow/tools/content_utils"
+require "yarrow/content/graph"
+require "yarrow/content/source"
+require "yarrow/content/expansion"
+require "yarrow/content/expansion_strategy"
+require "yarrow/content/tree_expansion"
+require "yarrow/content/resource"
+require "yarrow/content/model"
+require "yarrow/content/policy"
+require "yarrow/web/manifest"
+require "yarrow/web/document"
+require "yarrow/web/generator"
+require "yarrow/web/template"
+require "yarrow/output/context"
+require "yarrow/output/web/indexed_file"
+require "yarrow/content_map"
+require "yarrow/server"
+require "yarrow/server/livereload"
 
-require 'yarrow/generator'
+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 "yarrow/generator"
+
+# Dir[File.dirname(__FILE__) + "/yarrow/generators/*.rb"].each do |generator|
 #   require generator
 # end

data/yarrow.gemspec

@@ -13,12 +13,15 @@ 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 'addressable', '~> 2.8'
   spec.add_runtime_dependency 'mementus', '~> 0.8'
   spec.add_runtime_dependency 'rack', '~> 3.0'
   spec.add_runtime_dependency 'rackup', '~> 0.2'
   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 'mustache', '~> 1.1.1'
+  spec.add_runtime_dependency 'parallel', '~> 1.22.1'
   spec.add_runtime_dependency 'strings-inflection', '~> 0.1'
   spec.add_runtime_dependency 'strings-case', '~> 0.3'
   spec.add_runtime_dependency 'kramdown', '~> 2.4.0'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: mementus
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: strings-inflection
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +252,7 @@ files:
 - SERVER.md
 - bin/yarrow
 - bin/yarrow-server
+- lib/extensions/mementus.rb
 - lib/yarrow.rb
 - lib/yarrow/assets.rb
 - lib/yarrow/assets/manifest.rb
@@ -220,7 +263,6 @@ files:
 - lib/yarrow/content/expansion.rb
 - lib/yarrow/content/expansion_strategy.rb
 - lib/yarrow/content/graph.rb
-- lib/yarrow/content/manifest.rb
 - lib/yarrow/content/model.rb
 - lib/yarrow/content/policy.rb
 - lib/yarrow/content/resource.rb
@@ -228,14 +270,10 @@ files:
 - lib/yarrow/content/tree_expansion.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/help.txt
 - lib/yarrow/logging.rb
 - lib/yarrow/output/context.rb
-- lib/yarrow/output/generator.rb
-- lib/yarrow/output/mapper.rb
-- lib/yarrow/output/result.rb
 - lib/yarrow/output/web/indexed_file.rb
 - lib/yarrow/process/expand_content.rb
 - lib/yarrow/process/extract_source.rb
@@ -245,6 +283,7 @@ files:
 - lib/yarrow/schema/definitions.rb
 - lib/yarrow/schema/dictionary.rb
 - lib/yarrow/schema/entity.rb
+- lib/yarrow/schema/registry.rb
 - lib/yarrow/schema/types.rb
 - lib/yarrow/schema/validations/array.rb
 - lib/yarrow/schema/validations/object.rb
@@ -257,7 +296,8 @@ files:
 - lib/yarrow/tools/content_utils.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
-- lib/yarrow/web/html_document.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

data/lib/yarrow/content/manifest.rb

@@ -1,61 +0,0 @@
-module Yarrow
-  module Content
-    class Manifest
-      def self.build(graph)
-        manifest = new
-
-        graph.n(:collection).each do |collection|
-
-          unless collection.props[:content_only]
-            manifest.add_document(collection_context(collection))
-          end
-
-          unless collection.props[:index_only]
-            collection.out(:item).each do |item|
-              #if item[:entity].status.to_sym == :published
-              manifest.add_document(item_context(item))
-              #end
-            end
-          end
-        end
-
-        manifest
-      end
-
-      attr_reader :documents, :assets
-
-      def initialize
-        @documents = []
-        @assets = []
-      end
-
-      def self.collection_context(collection)
-        Yarrow::Output::Context.new(
-          parent: collection.in(:collection).first,
-          name: collection.props[:name],
-          #url: collection.props[:url],
-          title: collection.props[:title],
-          type: collection.props[:type]
-        )
-      end
-
-      def self.item_context(item)
-        Yarrow::Output::Context.new(
-          parent: item.in(:collection).first,
-          name: item.props[:name],
-          #url: item.props[:url],
-          title: item.props[:title],
-          type: item.props[:type]
-        )
-      end
-
-      def add_document(document)
-        @documents << document
-      end
-
-      def add_asset(asset)
-        @assets << asset
-      end
-    end
-  end
-end

data/lib/yarrow/extensions.rb

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

data/lib/yarrow/output/generator.rb

@@ -1,43 +0,0 @@
-module Yarrow
-  module Output
-    # Generates documentation from an object model.
-    class Generator
-      def initialize(config={})
-        @config = config
-      end
-
-      # Mapping between template types and provided object model
-      def 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.
-      def converter
-
-      end
-
-      def write_output_file(filename, content)
-      end
-
-      # Builds the output documentation.
-      def build_docs
-        object_map.each do |index, objects|
-          objects.each do |object|
-            template_context = {
-              #:meta => Site
-              index => object
-            }
-            content = converter.render(template_map[index], template_context)
-            filename = converter.filename_for(object)
-            write_output_file(filename, content)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/output/mapper.rb

@@ -1,23 +0,0 @@
-module Yarrow
-  module Output
-    class Mapper
-
-      def initialize(config)
-        @config = config
-      end
-
-      def object_map
-        @config.output.object_map
-      end
-
-      def template_map
-        @config.output.template_map
-      end
-
-      def model
-
-      end
-
-    end
-  end
-end

data/lib/yarrow/output/result.rb

@@ -1,13 +0,0 @@
-module Yarrow
-  module Output
-    class Log
-      
-    end
-
-    class Result
-      def initialize
-
-      end
-    end
-  end
-end

data/lib/yarrow/web/html_document.rb

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