aardi 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7be17f66c6135658a1a7e9bcd7cf85e0ea7a1e0b73894377bc97466ca305327
-  data.tar.gz: 4a2a44e5426dbf7be491b02e5ebf4fa15feeb1213229d0de6170f5e6efe329fc
+  metadata.gz: 129167c280727dd641e8842090ea97a9a15cb342d8ac6a160a0cd9591c3cbc4c
+  data.tar.gz: 51dadc501772acb3ee741463e475296f27864af8d323f576f7753b6f69334b48
 SHA512:
-  metadata.gz: 3abf73d04d38a2ec22d0e9667b91d45b7f55c06a5835f629d82bf531738f8756af7ded38cfd917d212caefc0527081b3f4846ffe5cefba8f044c6f7b7797d58b
-  data.tar.gz: e3e33868803f8adcfae3c59439f207b8664badbdad53489fc06bf0419598e581201ffbaaa36d6d05f5c27b3fef0c9eb51b31aada42ed6f0f9e6923977e27e0b6
+  metadata.gz: 242ddfb6fc66e2593daa08dffc5f8dbaf5313838d46fad8903d58355a4b597b03ae339855e52b1cf6ada248f5b6c5cfa3521bf85b6b81dccaf0e6fd14e0cb1f0
+  data.tar.gz: e0af3d46e798c83d87da4b332b86814342401da1b5ee602f8b637d39e30535487a42e477571f84657c105165ac718cc6fd58856166be5495f33c0493ecd87c4f

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|
         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
-      "# #{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

@@ -15,14 +15,12 @@ module Aardi
     # :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 }
+                   title:, updated: updated.iso8601 }
 
       subnodes.each do |node, value|
         feed.public_send node, value

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

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
 
@@ -29,10 +30,10 @@ 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

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?
 
-      @src.output != File.read(@path).strip # in case cache missing (or corrupt) yet file good.
-    end
-
-    def update_hash
-      @content_hashes[@path] = @src.output_hash
+      # in case cache missing (or corrupt) yet file good.
+      @src.output != File.read(@path).strip
     end
   end
 end

data/lib/aardi/folder.rb

@@ -7,12 +7,12 @@ module Aardi
       @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 == '.'
-    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') }
     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)

data/lib/aardi/metadata.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Aardi
+  class Metadata
+    KNOWN_KEYS = %w[Title Description Creation Updated Tags].freeze
+
+    def initialize(yaml_str = '', source = nil)
+      yaml = YAML.safe_load(yaml_str, permitted_classes: [Time])
+      @yaml = {}
+      @yaml = yaml if yaml.is_a? Hash
+      confirm_keys(source)
+    end
+
+    def creation    = @yaml['Creation']
+    def description = @yaml['Description']
+    def empty?      = @yaml.empty?
+    def tags        = @yaml['Tags']&.split&.sort
+    def title       = @yaml['Title']
+    def updated     = @yaml['Updated']
+
+    private
+
+    def confirm_keys(source)
+      unknown = @yaml.keys - KNOWN_KEYS
+      return if unknown.empty?
+
+      unknown.each { |key| warn "Ignored unknown declaration '#{key}'#{source_location(source)}" }
+    end
+
+    def source_location(source)
+      return '' unless source
+
+      " in #{source}"
+    end
+  end
+end

data/lib/aardi/month.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
 module Aardi
+  # :reek:TooManyInstanceVariables
   class Month < AbstractBlog
-    def initialize(year, key, archive_path)
+    def initialize(year, key, archive_path, tag = nil)
       @year = year
       @key = key
       @archive_path = archive_path
-      @index = Hash.new { |hash, day| hash[day] = Day.new(year, self, day, archive_path) }
+      @index = Hash.new { |hash, day| hash[day] = Day.new(year, self, day, archive_path, tag) }
+      @tag = tag
     end
 
     def <<(post)
-      @index[post.day] << post
+      @index[post.creation.day] << post
     end
 
     def archive_cell(month_fmt)
-      cell = count.zero? ? '' : format(month_fmt, count:, archive_path: @archive_path, year: @year, month: self)
-      "#{cell} |"
+      return ' |' if count.zero?
+
+      "#{format(month_fmt, count:, archive_path: @archive_path, year: @year, month: self)} |"
     end
 
     def content
-      @content ||= begin
-        days_content = days.map { |day| "##{day.content}" }.join
-        "# #{title}\n#{days_content}"
-      end
+      @content ||= "# #{title}\n#{days.map { |day| "##{day.content}" }.join}"
     end
 
     def count = days.sum(&:count)
@@ -31,12 +31,12 @@ module Aardi
       "./#{@archive_path}/#{@year}/#{self}/index.html"
     end
 
-    def title = Date.new(@year.key, @key).strftime('%B %Y')
-
     def to_s = @key.to_s.rjust(2, '0')
 
     private
 
+    def base_title = Date.new(@year.key, @key).strftime('%B %Y')
+
     def children
       days
     end

data/lib/aardi/orphanage.rb

@@ -2,14 +2,14 @@
 
 module Aardi
   class Orphanage
-    def report
-      Aardi.ledger[:html_files].each { |path| warn("Orphan: #{path}") unless ignored?(path) }
+    def report(html_files, generated_paths)
+      (html_files - generated_paths).each { |path| warn("Orphan: #{path}") unless ignored?(path) }
     end
 
     private
 
     def ignored?(path)
-      Array(Aardi.config[:ignore_orphans]).any? { |prefix| path.start_with?(prefix) }
+      Array(Config.fetch(:ignore_orphans)).any? { |prefix| path.start_with?(prefix) }
     end
   end
 end