aardi 0.9.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b1cd3200b5a5aadf79546a1052c8c75dee0b82080db2b6da7dcf2e952391140
-  data.tar.gz: f4f4c3649a1beaa853099d6cf98088c9eb47c6ca5698420f5129a7e3f1c60edb
+  metadata.gz: 0f5fd17e9f26a95d4822008bf0d1c359e2f887219296c35a6576eb88e87131f5
+  data.tar.gz: 59244e3456a33e30b26ca690a8cfe130cf9f42fd2f3165b00856da1405ab3972
 SHA512:
-  metadata.gz: 9bbad21eb1024a48d2adc48777b4d492c77406136aaf63ceabe01b1b09ea4598dd39dc591c15619fb947505ef553007e260da1b725efcd8912f3e439aeb65dfa
-  data.tar.gz: 5d4016e3ab9f933e6d82d172473704e79bc9bc1894ea1f3d4445059948a628e17adeec71da8ebccfa7c437e85d7162c59ed2fb3bb364ea39f8e232b0a5e21a9d
+  metadata.gz: 024e92b44b23e64e7b4f4d13ab59d081ad7f8accbbab321a021a61e7516efd27f9d29e5a25bb653b5df3b2c32bbaaa99144ba132d00724ce143519647c0cb04b
+  data.tar.gz: 5a41b64b3262b2f7f969a93b9b9f06e0e1bc0601e48a14541574f151d8bfb7b95a919e40ac759c50ccdcbb7ff37edbc85e85743cc128a52a82b242e4909f583f

data/lib/aardi/abstract_blog.rb

@@ -4,13 +4,18 @@ module Aardi
   class AbstractBlog
     attr_reader :key
 
-    def metadata = (@metadata ||= {})
+    def metadata = (@metadata ||= Metadata.new)
 
     def mtime = children.max_by(&:mtime)&.mtime
 
     def render
-      children.each(&:render)
-      write_target
+      children.each_with_object({}) { |child, acc| acc.merge!(child.render) }.merge!(write_target)
+    end
+
+    def title
+      return "#{base_title} - #{@tag}" if @tag
+
+      base_title
     end
 
     private
@@ -20,7 +25,7 @@ module Aardi
     end
 
     def write_target
-      source = PageContent.new content, title, metadata
+      source = PageContent.new(content, title, metadata)
       PageTarget.new(source, target_path).write
     end
   end

data/lib/aardi/abstract_feed.rb

@@ -2,25 +2,37 @@
 
 module Aardi
   class AbstractFeed < AbstractBlog
-    def initialize(posts)
+    def initialize(posts, archive_path = nil, tag = nil)
+      @archive_path = archive_path
       @posts = posts
+      @tag = tag
     end
 
     def render
       write_target
     end
 
-    def target_path = "./#{feed_file}"
+    def target_path
+      return "./#{@archive_path}/#{feed_file}" if @archive_path
+
+      "./#{feed_file}"
+    end
+
+    # Keep #title private so Nokogiri `:title` in ATOMFeed#feed_details
+    # as an element name rather than a delegated call.
+    private :title
 
     private
 
+    def base_title = Config[:site_title]
+
     def children
       @posts
     end
 
     def creation = children.max_by(&:creation)&.creation
 
-    def feed_url = "#{Aardi.config[:site_url]}/#{feed_file}"
+    def feed_url = "#{Config[:site_url]}#{target_path[1..]}"
 
     def updated = children.max_by(&:updated)&.updated
 

data/lib/aardi/abstract_page_support.rb

@@ -2,19 +2,25 @@
 
 module Aardi
   module AbstractPageSupport
-    attr_reader :metadata, :mtime
+    def metadata
+      @metadata
+    end
+
+    def mtime
+      @mtime
+    end
 
     def parse_source(path)
-      File.open(path, encoding: "utf-8") do |file|
+      File.open(path, encoding: 'utf-8') do |file|
         parts = file.read.rpartition("\n----\n")
-        @metadata = YAML.safe_load(parts.first, permitted_classes: [Time]) || {}
+        @metadata = Metadata.new(parts.first, path)
         @src_content = parts.last
         @mtime = file.mtime.utc
       end
     end
 
     def title
-      metadata["Title"] || @src_content.split("\n").first.sub(/^#+ /, "")
+      metadata.title || @src_content[/\A(?:#+ +)?([^\n]+)/, 1]
     end
   end
 end

data/lib/aardi/archive.rb

@@ -2,47 +2,52 @@
 
 module Aardi
   class Archive < AbstractBlog
-    def initialize(posts, archive_path)
-      @posts = posts
+    def initialize(archive_path, tag = nil, tags = nil)
       @archive_path = archive_path
+      @tag = tag
+      @tags = tags
+      @index = Hash.new { |hash, year| hash[year] = Year.new(year, @archive_path, @tag) }
+    end
+
+    def <<(post)
+      @index[post.creation.year] << post
     end
 
     def content
       year_fmt = "| %<year>s | %<months>s \n"
-      month_fmt = "[&nbsp;%<count>s&nbsp;](#{Aardi.config[:site_url]}/%<archive_path>s/%<year>s/%<month>s/)"
+      month_fmt = "[&nbsp;%<count>s&nbsp;](#{Config[:site_url]}/%<archive_path>s/%<year>s/%<month>s/)"
 
-      "#{header}#{years.map { |year| year.archive_row(year_fmt, month_fmt) }.join}"
+      rows = years.map { |year| year.archive_row(year_fmt, month_fmt) }.join
+      "#{title_heading}#{tag_list}**When**:\n\n#{table_header}#{rows}"
     end
 
     def target_path = "./#{@archive_path}/index.html"
 
-    def title = Aardi.config[:blog_archive_title]
-
     private
 
-    def calendar
-      index = Hash.new { |hash, year| hash[year] = Year.new(year, @archive_path) }
-      @posts.each do |post|
-        index[post.year] << post
-      end
-
-      index
-    end
+    def base_title = Config[:blog_archive_title]
 
     def children
       years
     end
 
-    def header
-      "# #{Aardi.config[:blog_archive_title]}
-
-||Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|
+    def table_header
+      "||Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|
 |---|---|---|---|---|---|---|---|---|---|---|---|---|
 "
     end
 
+    def tag_list
+      return '' unless @tags
+      return '' if @tags.empty?
+
+      "**What**: #{@tags.inline_links}\n\n"
+    end
+
+    def title_heading = "# #{title}\n\n"
+
     def years
-      @years ||= calendar.values.sort_by { |date| -date.key }
+      @years ||= @index.values.sort_by { |date| -date.key }
     end
   end
 end

data/lib/aardi/atom_feed.rb

@@ -3,8 +3,8 @@
 module Aardi
   class ATOMFeed < AbstractFeed
     def content
-      atom_feed = Nokogiri::XML::Builder.new(encoding: "UTF-8") do
-        feed("xmlns" => "http://www.w3.org/2005/Atom") do |feed|
+      atom_feed = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do
+        feed('xmlns' => 'http://www.w3.org/2005/Atom') do |feed|
           feed_details(feed)
         end
       end
@@ -13,15 +13,14 @@ module Aardi
     end
 
     # :reek:TooManyStatements
+    # rubocop:disable Metrics/MethodLength
     def feed_details(feed)
-      aardi_config = Aardi.config
-
       feed.author do
-        name(aardi_config[:site_author])
+        name(Config[:site_author])
       end
 
-      subnodes = {id: feed_url, link: {href: feed_url, rel: "self"},
-                  title: aardi_config[:site_title], updated: updated.iso8601}
+      subnodes = { id: feed_url, link: { href: feed_url, rel: 'self' },
+                   title:, updated: updated.iso8601 }
 
       subnodes.each do |node, value|
         feed.public_send node, value
@@ -31,11 +30,12 @@ module Aardi
         post_details(post, feed)
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
     def feed_file
-      "index.xml"
+      'index.xml'
     end
 
     # :reek:FeatureEnvy
@@ -45,10 +45,10 @@ module Aardi
         post_url = post.url
 
         # For safety, must use content_ and not content:
-        content_(post.feed_snippet).type = "html"
+        content_(post.feed_snippet).type = 'html'
 
-        subnodes = {id: post_url, link: {href: post_url}, title: post.title,
-                    published: post.creation.iso8601, updated: post.updated.iso8601}
+        subnodes = { id: post_url, link: { href: post_url }, title: post.title,
+                     published: post.creation.iso8601, updated: post.updated.iso8601 }
         subnodes.each do |node, value|
           feed.public_send node, value
         end

data/lib/aardi/blog.rb

@@ -2,13 +2,17 @@
 
 module Aardi
   class Blog < AbstractBlog
-    def initialize(posts_path, archive_path)
-      @posts_path = posts_path
-      @archive_path = archive_path
+    def initialize
+      @posts = []
+      @blog_path = nil
+      @archive_path = Config[:blog_archive_path]
+      @tags = Tags.new
     end
 
-    def posts
-      @posts ||= Dir.glob("#{@posts_path}/**/*.md").map { |post_path| Post.new(post_path) }.sort_by(&:creation)
+    def <<(post)
+      @posts << post
+      archive << post
+      @tags << post
     end
 
     def report_recent
@@ -18,15 +22,15 @@ module Aardi
     private
 
     def archive
-      Archive.new(posts, @archive_path)
+      @archive ||= Archive.new(@archive_path, tag, @tags)
     end
 
     def atom_feed
-      ATOMFeed.new(feed_posts)
+      ATOMFeed.new(feed_posts, @blog_path, tag)
     end
 
     def children
-      [archive, home, atom_feed, json_feed]
+      [archive, home, atom_feed, json_feed, *@tags]
     end
 
     def feed_posts
@@ -34,17 +38,19 @@ module Aardi
     end
 
     def home
-      Home.new(recent_posts(:blog_home_posts), @archive_path)
+      Home.new(recent_posts(:blog_home_posts), @archive_path, @blog_path, tag)
     end
 
     def json_feed
-      JSONFeed.new(feed_posts)
+      JSONFeed.new(feed_posts, @blog_path, tag)
     end
 
     def recent_posts(conf_key)
-      posts.last(Aardi.config[conf_key]).reverse
+      @posts.max_by(Config[conf_key], &:creation)
     end
 
-    def write_target = nil
+    def tag = nil
+
+    def write_target = {}
   end
 end

data/lib/aardi/config.rb

@@ -2,20 +2,24 @@
 
 module Aardi
   class Config
-    def initialize
-      @data = {}
-    end
+    RAISE_ON_MISS = ->(_, key) { raise KeyError, "Key not found: #{key.inspect}" }
+
+    @data = Hash.new(&RAISE_ON_MISS)
+
+    class << self
+      def [](key) = @data[key]
+      def fetch(key, default = nil) = @data.fetch(key, default)
+      def load(path) = prepare(File.read(path))
 
-    def [](key) = @data[key]
+      def prepare(config_yaml)
+        @data.merge!(YAML.safe_load(config_yaml).transform_keys(&:to_sym))
+        @data.freeze
+        self
+      end
 
-    # :reek:TooManyStatements
-    def load(path)
-      config_hash = YAML.safe_load_file(path)
-      config_hash.transform_keys!(&:to_sym)
-      config_hash[:markup_options]&.transform_keys!(&:to_sym)
-      @data.merge!(config_hash)
-      @data.freeze
-      self
+      def reset
+        @data = Hash.new(&RAISE_ON_MISS)
+      end
     end
   end
 end

data/lib/aardi/content_hashes.rb

@@ -15,6 +15,16 @@ module Aardi
       @hashes[path] = hash
     end
 
+    def replace(new_hashes)
+      @hashes = new_hashes
+      @new_hashes = nil
+    end
+
+    def save(new_hashes)
+      replace(new_hashes)
+      write
+    end
+
     def write
       return if new_hashes == @original_hashes
 
@@ -25,15 +35,12 @@ module Aardi
     private
 
     def new_hashes
-      @new_hashes ||= @hashes.sort.map! { |path, hash| "#{path}: #{hash}\n" }.join
+      @new_hashes ||= @hashes.sort.map { |path, hash| "#{path}: #{hash}\n" }.join
     end
 
     def read_hashes
-      @original_hashes = File.exist?(@path) ? File.read(@path) : ""
-      @hashes = @original_hashes.split("\n").to_h do |line|
-        path, hash = line.split(":", 2)
-        [path.strip, hash.to_i]
-      end
+      @original_hashes = File.exist?(@path) ? File.read(@path) : ''
+      @hashes = @original_hashes.scan(/^(.+): (\d+)$/).to_h { |path, hash| [path, hash.to_i] }
     end
   end
 end

data/lib/aardi/custom_renderer.rb

@@ -7,9 +7,7 @@ module Aardi
     HEADER_SQUEEZE = /&#.*?;|"|[^a-z0-9\-_]/
 
     def header(text, header_level)
-      squeezed_text = text.squeeze(" ")
-      id = header_id(text)
-      "<h#{header_level} id=\"#{id}\">#{squeezed_text}</h#{header_level}>"
+      "<h#{header_level} id=\"#{header_id(text)}\">#{text.squeeze(' ')}</h#{header_level}>"
     end
 
     def link(link, title, content)
@@ -33,7 +31,7 @@ module Aardi
     end
 
     def header_stub_id(text)
-      text.downcase.strip.tr(" ", "-").gsub(HEADER_SQUEEZE, "").squeeze("-")
+      text.downcase.strip.tr(' ', '-').gsub(HEADER_SQUEEZE, '').squeeze('-')
     end
 
     def ids

data/lib/aardi/day.rb

@@ -3,11 +3,12 @@
 module Aardi
   # :reek:TooManyInstanceVariables
   class Day < AbstractBlog
-    def initialize(year, month, key, archive_path)
+    def initialize(year, month, key, archive_path, tag = nil)
       @year = year
       @month = month
       @key = key
       @archive_path = archive_path
+      @tag = tag
       @posts = []
     end
 
@@ -18,7 +19,7 @@ module Aardi
     def content
       @content ||= begin
         sorted_posts = @posts.sort_by(&:creation)
-        posts_content = sorted_posts.reverse!.map!(&:content)
+        posts_content = sorted_posts.reverse.map(&:content)
         "# #{title}\n#{posts_content.join}"
       end
     end
@@ -29,16 +30,16 @@ module Aardi
       "./#{@archive_path}/#{@year}/#{@month}/#{self}/index.html"
     end
 
-    def title = date.strftime("%A, %-e %B %Y")
-
     private
 
+    def base_title = date.strftime('%A, %-e %B %Y')
+
     def children
       @posts
     end
 
     def date = Date.new(@year.key, @month.key, @key)
 
-    def to_s = @key.to_s.rjust(2, "0")
+    def to_s = @key.to_s.rjust(2, '0')
   end
 end

data/lib/aardi/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Aardi
+  class MissingPathError < StandardError; end
+  class MissingTemplateElementError < StandardError; end
+end

data/lib/aardi/file_target.rb

@@ -3,20 +3,22 @@
 module Aardi
   class FileTarget
     def initialize(src, target_path)
+      renderer = Aardi.renderer
       @src = src
       @path = target_path
-      @content_hashes = Aardi.ledger[:content_hashes]
+      @content_hashes = renderer.content_hashes
+      @html_files = renderer.html_files
     end
 
     # :reek:TooManyStatements
     def write
-      do_write = should_write?
-      update_hash
-      return unless do_write
+      hash = @src.output_hash
+      return { @path => hash } unless should_write?
 
       FileUtils.mkdir_p(File.dirname(@path))
       File.write(@path, "#{@src.output}\n")
       puts("Wrote #{@path}")
+      { @path => hash }
     end
 
     private
@@ -33,11 +35,8 @@ module Aardi
       return true unless file_exists?
       return false unless output_hash_changed?
 
+      # in case cache missing (or corrupt) yet file good.
       @src.output != File.read(@path).strip
     end
-
-    def update_hash
-      @content_hashes[@path] = @src.output_hash
-    end
   end
 end

data/lib/aardi/folder.rb

@@ -4,15 +4,15 @@ module Aardi
   class Folder
     def initialize(path)
       @path = path
-      @normalized_path = "#{path.sub(/^\./, "")}/"
+      @normalized_path = "#{path.sub(/^\./, '')}/"
     end
 
-    def mtime = children.max_by(&:mtime).mtime
+    def mtime = children.filter_map(&:mtime).max
 
     def render
-      children.each(&:render)
-
-      update_sitemap if Aardi.config[:sitemap_entries][@normalized_path]
+      result = children.each_with_object({}) { |child, acc| acc.merge!(child.render) }
+      Aardi.renderer.sitemap.record_mtime(@normalized_path, mtime) unless @path == '.'
+      result
     end
 
     private
@@ -26,16 +26,11 @@ module Aardi
     end
 
     def paths
-      @paths ||= FileList["#{@path}/*"].exclude(Aardi.config[:files_to_exclude])
+      @paths ||= FileList["#{@path}/*"].exclude(Config[:files_to_exclude])
     end
 
     def sources
-      @sources ||= paths.filter_map { |path| Page.new(path) if path.end_with?(".md") }
-    end
-
-    def update_sitemap
-      # '.' is the top level so skip it since the homepage will register itself
-      Aardi.ledger[:sitemap].update_mtime(@normalized_path, mtime) unless @path == "."
+      @sources ||= paths.filter_map { |path| Page.new(path) if path.end_with?('.md') }
     end
   end
 end

data/lib/aardi/home.rb

@@ -2,9 +2,11 @@
 
 module Aardi
   class Home < AbstractBlog
-    def initialize(posts, archive_path)
+    def initialize(posts, archive_path, blog_path = nil, tag = nil)
       @posts = posts
       @archive_path = archive_path
+      @blog_path = blog_path
+      @tag = tag
     end
 
     def content
@@ -12,36 +14,33 @@ module Aardi
     end
 
     def render
-      Aardi.ledger[:sitemap].update_mtime("/", mtime)
+      Aardi.renderer.sitemap.update_mtime('/', mtime) unless @blog_path
       write_target
     end
 
-    def target_path = "./index.html"
+    def target_path
+      return "./#{@blog_path}/index.html" if @blog_path
 
-    def title = Aardi.config[:blog_home_title]
+      './index.html'
+    end
 
     private
 
+    def base_title = Config[:blog_home_title]
+
     def children
       @posts
     end
 
-    def content_footer
-      site_url = Aardi.config[:site_url]
-      more_archive = "[Archive](#{site_url}/#{@archive_path}/)"
-      more_rss = "[RSS](#{site_url}/index.xml)"
-      more_json = "[JSON](#{site_url}/index.json)"
-      "**More:** #{more_archive}, #{more_rss}, #{more_json}"
-    end
+    def content_footer = HomeFooterLinks.new(@blog_path).to_s
 
     def days_hash
-      @days_hash ||= @posts.group_by { |post| post.creation.strftime("%Y-%m-%d") }
+      @days_hash ||= @posts.group_by { |post| post.creation.strftime('%Y-%m-%d') }
     end
 
     def post_day_content(post_day)
-      date_header = post_day.first.creation.strftime("%A, %e %B %Y")
-      posts_content = post_day.map(&:content).join
-      "## #{date_header}\n#{posts_content}"
+      first_post = post_day.first
+      "## #{first_post.creation.strftime('%A, %e %B %Y')}\n#{post_day.map(&:content).join}"
     end
 
     def post_days_content

data/lib/aardi/home_footer_links.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Aardi
+  class HomeFooterLinks
+    def initialize(blog_path)
+      @blog_path = blog_path
+    end
+
+    def to_s
+      "**More:** [Archive](#{archive_url}), [RSS](#{rss_url}), [JSON](#{json_url})"
+    end
+
+    private
+
+    def archive_url  = "#{base_url}/#{Config[:blog_archive_path]}/"
+    def base_url     = "#{Config[:site_url]}#{feed_base}"
+    def feed_base    = @blog_path ? "/#{@blog_path}" : ''
+    def json_url     = "#{base_url}/index.json"
+    def rss_url      = "#{base_url}/index.xml"
+  end
+end

data/lib/aardi/init_files/config.yml

@@ -13,6 +13,7 @@ blog_recent_posts: 10
 blog_archive_title: Blog Archive
 blog_home_title: My Site
 blog_home_posts: 10
+blog_tags_path: tags
 sitemap_entries:
   /: daily
 markup_options:

data/lib/aardi/json_feed.rb

@@ -3,9 +3,8 @@
 module Aardi
   class JSONFeed < AbstractFeed
     def content
-      aardi_config = Aardi.config
-      feed_content = {version: "https://jsonfeed.org/version/1.1", title: aardi_config[:site_title],
-                      home_page_url: aardi_config[:site_url], feed_url:}
+      feed_content = { version: 'https://jsonfeed.org/version/1.1', title:,
+                       home_page_url: Config[:site_url], feed_url: }
       feed_content[:items] = @posts.map { |post| post_details(post) }
 
       JSON.pretty_generate(feed_content)
@@ -14,19 +13,19 @@ module Aardi
     private
 
     def feed_file
-      "index.json"
+      'index.json'
     end
 
     def post_details(post)
       post_updated = post.updated
       post_creation = post.creation
 
-      details = {id: post.name, url: post.url, title: post.title,
-                 date_published: post_creation.iso8601, content_html: post.feed_snippet}
+      details = { id: post.name, url: post.url, title: post.title,
+                  date_published: post_creation.iso8601, content_html: post.feed_snippet }
 
       details[:date_modified] = post_updated.iso8601 unless post_creation == post_updated
 
-      details.compact
+      details
     end
   end
 end