yarrow 0.8.7 → 0.9.1

data/lib/yarrow/symbols.rb

@@ -30,5 +30,11 @@ module Yarrow
     def self.to_plural(atom)
       Strings::Inflection.pluralize(atom.to_s).to_sym
     end
+
+    # @param [Symbol, String] atom
+    # @return [String]
+    def self.to_text(identifier)
+      identifier.to_s.gsub(/\A[^[:alnum:]]+/, "").gsub(/[\-_]+/, " ").capitalize
+    end
   end
 end

data/lib/yarrow/version.rb

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

data/lib/yarrow/web/generator.rb

@@ -40,7 +40,8 @@ module Yarrow
           file.puts(content)
         end
 
-        puts "[write] #{path} → #{url}"
+        # If stdout logging
+        #puts "[write] #{path} → #{url}"
       end
 
       def generate_sitemap(manifest)

data/lib/yarrow/web/manifest.rb

@@ -3,6 +3,7 @@ module Yarrow
     class Manifest
       def self.build(graph)
         manifest = new
+        manifest.set_graph(graph)
 
         graph.n(:collection).each do |collection|
           # TODO: raise error if both content_only and index_only are set
@@ -10,12 +11,12 @@ module Yarrow
 
           # If the collection is tagged :index_only then skip adding individual documents
           unless collection.props[:index_only]
-            collection.out(:item).each do |item|
+            collection.out(:entity).each do |entity|
               #if item[:entity].status.to_sym == :published
-              if item.props[:resource].name == "index"
-                index = item
+              if entity.props[:resource].name == "index"
+                index = entity
               else
-                manifest.add_document(item_context(item))
+                manifest.add_document(entity_context(entity))
               end
               #end
             end
@@ -34,13 +35,18 @@ module Yarrow
         manifest
       end
 
-      attr_reader :documents, :assets
+      attr_reader :documents, :assets, :graph
 
       def initialize
         @documents = []
         @assets = []
       end
 
+      # Used for dot debugging
+      def set_graph(graph)
+        @graph = graph
+      end
+
       def add_document(document)
         @documents << document
       end
@@ -50,15 +56,23 @@ module Yarrow
       end
 
       def self.collection_context(collection)
+        # TODO: debug log
+        # puts "collection_context"
+        # p collection.props[:resource].title
+        # p collection
         IndexDocument.new(collection, nil, true)
       end
 
-      def self.collection_index_context(collection, item)
-        IndexDocument.new(collection, item, false)
+      def self.collection_index_context(collection, entity)
+        # TODO: debug log
+        # puts "collection_index_context"
+        # p collection.props[:resource].title
+        # p entity.props[:resource].title
+        IndexDocument.new(collection, entity, false)
       end
 
-      def self.item_context(item)
-        Document.new(item, false)
+      def self.entity_context(entity)
+        Document.new(entity, false)
       end
     end
   end

data/lib/yarrow.rb

@@ -1,6 +1,7 @@
 require "pathname"
 require "yaml"
 require "kramdown"
+require "toml"
 require "mustache"
 require "parallel"
 
@@ -15,14 +16,16 @@ require "yarrow/schema/dictionary"
 require "yarrow/schema/entity"
 require "yarrow/schema/value"
 require "yarrow/schema/registry"
-require "yarrow/tools/front_matter"
-require "yarrow/tools/content_utils"
+require "yarrow/format"
 require "yarrow/content/graph"
 require "yarrow/content/policy"
 require "yarrow/content/model"
 require "yarrow/content/source"
-require "yarrow/content/expansion/strategy"
-require "yarrow/content/expansion/tree"
+require "yarrow/content/expansion/aggregator"
+require "yarrow/content/expansion/basename_merge"
+require "yarrow/content/expansion/filename_map"
+require "yarrow/content/expansion/directory_merge"
+require "yarrow/content/expansion/traversal"
 require "yarrow/content/resource"
 require "yarrow/web/manifest"
 require "yarrow/web/document"
@@ -41,9 +44,4 @@ require "yarrow/process/project_manifest"
 require "yarrow/config"
 require "yarrow/configuration"
 require "yarrow/console_runner"
-
 require "yarrow/generator"
-
-# Dir[File.dirname(__FILE__) + "/yarrow/generators/*.rb"].each do |generator|
-#   require generator
-# end

data/yarrow.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   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 'toml', '~> 0.3.0'
   # https://github.com/joeldrapper/phlex
   spec.add_runtime_dependency 'kramdown', '~> 2.4.0'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.9.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: toml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -245,6 +259,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- CONTENT.md
 - Gemfile
 - LICENSE
 - README.md
@@ -260,7 +275,14 @@ files:
 - lib/yarrow/config.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
+- lib/yarrow/content/expansion/aggregator.rb
+- lib/yarrow/content/expansion/basename_merge.rb
+- lib/yarrow/content/expansion/directory_map.rb
+- lib/yarrow/content/expansion/directory_merge.rb
+- lib/yarrow/content/expansion/file_list.rb
+- lib/yarrow/content/expansion/filename_map.rb
 - lib/yarrow/content/expansion/strategy.rb
+- lib/yarrow/content/expansion/traversal.rb
 - lib/yarrow/content/expansion/tree.rb
 - lib/yarrow/content/graph.rb
 - lib/yarrow/content/model.rb
@@ -269,6 +291,18 @@ files:
 - lib/yarrow/content/source.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
+- lib/yarrow/format.rb
+- lib/yarrow/format/asciidoc.rb
+- lib/yarrow/format/html.rb
+- lib/yarrow/format/json.rb
+- lib/yarrow/format/markdown.rb
+- lib/yarrow/format/mediawiki.rb
+- lib/yarrow/format/methods/front_matter.rb
+- lib/yarrow/format/methods/metadata.rb
+- lib/yarrow/format/orgmode.rb
+- lib/yarrow/format/text.rb
+- lib/yarrow/format/xml.rb
+- lib/yarrow/format/yaml.rb
 - lib/yarrow/generator.rb
 - lib/yarrow/help.txt
 - lib/yarrow/logging.rb
@@ -292,7 +326,6 @@ files:
 - 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/version.rb
 - lib/yarrow/web/document.rb

data/lib/yarrow/tools/content_utils.rb

@@ -1,74 +0,0 @@
-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