aardi 0.9.2 → 2.0.0

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")
+    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 warn
-      Aardi.ledger[:html_files].each { |path| puts("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)
-      Aardi.config[:ignore_orphans].any? { |prefix| path.start_with?(prefix) }
+      Array(Config.fetch(:ignore_orphans)).any? { |prefix| path.start_with?(prefix) }
     end
   end
 end

data/lib/aardi/page.rb

@@ -19,7 +19,7 @@ module Aardi
     end
 
     def target_path
-      @path.pathmap("%X.html")
+      @path.pathmap('%X.html')
     end
   end
 end

data/lib/aardi/page_content.rb

@@ -4,7 +4,7 @@ module Aardi
   class PageContent < Content
     attr_reader :title, :metadata
 
-    def initialize(src_content, title, metadata = {})
+    def initialize(src_content, title, metadata = Metadata.new)
       super(src_content)
       @title = title
       @metadata = metadata
@@ -15,7 +15,7 @@ module Aardi
     end
 
     def output
-      @output ||= Aardi.ledger[:template].render(self)
+      @output ||= Aardi.renderer.render(self)
     end
   end
 end

data/lib/aardi/page_target.rb

@@ -2,15 +2,13 @@
 
 module Aardi
   class PageTarget < FileTarget
-    def write
-      super
-      Aardi.ledger[:html_files].delete(@path)
-    end
-
     private
 
+    # Optimization: in PageTarget first check the existing .html
+    # list rather than always rechecking the file system. But then
+    # check anyway because html_files doesn't always catch tag pages.
     def file_exists?
-      Aardi.ledger[:html_files].include? @path
+      @html_files.include?(@path) || File.exist?(@path)
     end
   end
 end

data/lib/aardi/path_servlet.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "webrick"
+require 'webrick'
 
 module Aardi
   class PathServlet < WEBrick::HTTPServlet::AbstractServlet
     def service(req, res)
       # use index if folder
-      path = "./#{req.path}".sub(%r{/$}, "/index.html")
+      path = "./#{req.path}".sub(%r{/$}, '/index.html')
 
       file = path if File.exist?(path)
       file ||= "#{path}.html" if File.exist?("#{path}.html")

data/lib/aardi/post.rb

@@ -7,50 +7,41 @@ module Aardi
     def initialize(path)
       @path = path
       parse_source path
+
+      raise "#{path}: missing Creation metadata" unless metadata.creation
     end
 
     def content
-      "#{@src_content}\n<div><span class=\"bookmark\">[<a href=\"#{url}\">bookmark</a>]</span></div>\n"
+      @content ||= "#{@src_content}\n<div>#{PostBookmarkLine.new(self)}</div>\n"
     end
 
-    def creation = metadata["Creation"]
-
-    def day = creation.day
+    def creation = metadata.creation
 
     def feed_snippet
-      clean_content = @src_content.sub(/\A(### .*\n)?\n+/, "")
-      render_markup(clean_content).strip
+      @feed_snippet ||= Aardi.renderer.markup_feed_snippet(@src_content)
     end
 
-    def month = creation.month
-
-    def name = File.basename(@path, ".*")
+    def name = File.basename(@path, '.*')
 
     def report_field_summary
-      creation_header = creation.strftime("%e %b %Y")
+      creation_header = creation.strftime('%e %b %Y')
       puts "#{creation_header} | #{@path} | #{title}"
     end
 
+    def tags = metadata.tags
+
     def target_path
       "./#{short_target}.html"
     end
 
-    def updated = metadata["Updated"] || creation
+    def updated = metadata.updated || creation
 
-    def url = "#{Aardi.config[:site_url]}/#{short_target}"
-
-    def year = creation.year
+    def url = "#{Config[:site_url]}/#{short_target}"
 
     private
 
-    def render_markup(content)
-      ledger = Aardi.ledger
-      ledger[:custom_renderer].reset
-      ledger[:markdown_renderer].render(content)
-    end
-
     def short_target
-      "#{Aardi.config[:blog_archive_path]}/#{creation.strftime("%Y/%m/%d")}/#{name}"
+      "#{Config[:blog_archive_path]}/#{creation.strftime('%Y/%m/%d')}/#{name}"
     end
   end
 end

data/lib/aardi/post_bookmark_line.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Aardi
+  class PostBookmarkLine
+    def initialize(post)
+      @post = post
+    end
+
+    def to_s
+      %(<span class="bookmark">[<a href="#{@post.url}">bookmark</a>]#{tag_links}</span>)
+    end
+
+    private
+
+    def tag_links
+      tags = @post.tags
+      return '' unless tags&.any?
+
+      " #{tags.map { |tag| %(<a href="#{tags_base_url}/#{tag}/">#{tag}</a>) }.join(', ')}"
+    end
+
+    def tags_base_url
+      "#{Config[:site_url]}/#{Config[:blog_tags_path]}"
+    end
+  end
+end

data/lib/aardi/renderer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Aardi
+  # :reek:TooManyInstanceVariables
+  class Renderer
+    attr_reader :content_hashes, :html_files, :sitemap
+
+    # :reek:ControlParameter
+    def initialize(html_files: nil, content_hashes: nil, sitemap: nil)
+      @html_files = html_files || Dir.glob('./**/*.html').to_set
+      @content_hashes = content_hashes || ContentHashes.new(Config[:content_hashes_path])
+      @sitemap = sitemap || Sitemap.new
+      @template = Template.new(Config[:template_path])
+      @custom_renderer = CustomRenderer.new
+      @markup_renderer = Redcarpet::Markdown.new(@custom_renderer, markup_options)
+    end
+
+    def finalize(result)
+      content_hashes.save(result)
+      Orphanage.new.report(html_files, result.keys)
+    end
+
+    def markup(content)
+      @custom_renderer.reset
+      @markup_renderer.render(content)
+    end
+
+    def markup_feed_snippet(content)
+      markup(content.sub(/\A(### .*\n)?\n+/, '')).strip
+    end
+
+    def render(src)
+      @template.render(src)
+    end
+
+    private
+
+    def markup_options
+      (Config.fetch(:markup_options) || {}).transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/aardi/site.rb

@@ -3,66 +3,33 @@
 module Aardi
   class Site < AbstractBlog
     def initialize
-      initialize_ledger
+      posts.each do |post|
+        blog << post
+      end
     end
 
-    # :reek:FeatureEnvy
     def blog
-      aardi_config = Aardi.config
-      @blog ||= Blog.new(aardi_config[:blog_posts_path], aardi_config[:blog_archive_path])
+      @blog ||= Blog.new
     end
 
     def render
-      super
-      content_hashes.write
-      warn_about_orphans
+      Aardi.renderer.finalize(super)
     end
 
     private
 
     def children
-      [Folder.new("."), blog, sitemap]
-    end
-
-    def content_hashes
-      @content_hashes ||= ContentHashes.new(Aardi.config[:content_hashes_path])
-    end
-
-    def custom_renderer
-      @custom_renderer ||= CustomRenderer.new
-    end
-
-    def html_files
-      @html_files ||= Dir.glob("./**/*.html").to_set
-    end
-
-    def initialize_ledger
-      ledger = Aardi.ledger
-      # set up content hashes so they're in place while building out the rest
-      ledger[:content_hashes] = content_hashes
-
-      {custom_renderer:, markdown_renderer:, html_files:, sitemap:, template:}.each do |message, value|
-        ledger[message] = value
-      end
-    end
-
-    def markdown_renderer
-      Redcarpet::Markdown.new(custom_renderer, Aardi.config[:markup_options])
-    end
-
-    def sitemap
-      @sitemap ||= Sitemap.new
+      [Folder.new('.'), blog, Aardi.renderer.sitemap]
     end
 
-    def template
-      Template.new Aardi.config[:template_path]
+    def post_paths
+      Dir.glob("#{Config[:blog_posts_path]}/**/*.md")
     end
 
-    def warn_about_orphans
-      Orphanage.new.warn
+    def posts
+      post_paths.map { |path| Post.new(path) }
     end
 
-    def write_target
-    end
+    def write_target = {}
   end
 end

data/lib/aardi/sitemap.rb

@@ -4,8 +4,8 @@ module Aardi
   class Sitemap
     # :reek:NestedIterators
     def content
-      sitemap = Nokogiri::XML::Builder.new(encoding: "UTF-8") do
-        urlset(xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9") do |urlset|
+      sitemap = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do
+        urlset(xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9') do |urlset|
           urls.each do |path, details|
             url_details(path, details, urlset)
           end
@@ -15,18 +15,25 @@ module Aardi
       sitemap.to_xml
     end
 
+    def record_mtime(path, path_mtime)
+      return unless urls.key?(path) && path_mtime
+
+      update_mtime(path, path_mtime)
+    end
+
     def render
       source = Content.new(content)
       FileTarget.new(source, target_path).write
     end
 
-    def target_path = "./sitemap.xml"
+    def target_path = './sitemap.xml'
 
     def update_mtime(path, path_mtime)
       urls[path][:lastmod] = path_mtime.iso8601
     end
 
-    # Methods called inside builder blocks must be public.
+    # Absent a block variable on Nokogiri::XML::Builder.new, this
+    # is called by the builder, not sitemap itself, and must be public.
     # :reek:FeatureEnvy
     def url_details(path, details, urlset)
       missing_path(path) unless File.exist?("./#{path}")
@@ -39,18 +46,17 @@ module Aardi
     end
 
     def urls
-      @urls ||= Aardi.config[:sitemap_entries].to_h { |path, cf| [path, url_values(path, cf)] }
+      @urls ||= Config[:sitemap_entries].to_h { |path, cf| [path, url_values(path, cf)] }
     end
 
     private
 
     def missing_path(path)
-      puts("FATAL: #{path} missing")
-      exit
+      raise MissingPathError, "#{path} is missing"
     end
 
     def url_values(path, changefreq)
-      {loc: "#{Aardi.config[:site_url]}#{path}", changefreq:}
+      { loc: "#{Config[:site_url]}#{path}", changefreq: }
     end
   end
 end

data/lib/aardi/tag_blog.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Aardi
+  class TagBlog < Blog
+    # :reek:DuplicateMethodCall
+    def initialize(tag)
+      super()
+      @tag = tag
+      @blog_path = "#{Config[:blog_tags_path]}/#{tag}"
+      @archive_path = "#{@blog_path}/#{Config[:blog_archive_path]}"
+    end
+
+    def <<(post)
+      @posts << post
+      archive << post
+    end
+
+    def count
+      @posts.count
+    end
+
+    def index_line
+      "- #{inline_link_text}"
+    end
+
+    def inline_link_text
+      "[#{tag}](#{url}) (#{count})"
+    end
+
+    def url
+      "#{Config[:site_url]}/#{@blog_path}/"
+    end
+
+    private
+
+    attr_reader :tag
+
+    def children
+      [archive, home, atom_feed, json_feed]
+    end
+  end
+end

data/lib/aardi/tags.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Aardi
+  class Tags < AbstractBlog
+    def initialize
+      @index = Hash.new { |hash, tag| hash[tag] = TagBlog.new(tag) }
+    end
+
+    def <<(post)
+      post.tags&.each do |tag|
+        @index[tag] << post
+      end
+    end
+
+    def content
+      return "# Tags\n" if counts.empty?
+
+      "# Tags\n\n#{tag_lines.join("\n")}\n"
+    end
+
+    def empty? = @index.empty?
+
+    def inline_links
+      counts.map { |_tag, tag_blog| tag_blog.inline_link_text }.join(', ')
+    end
+
+    def target_path
+      "./#{tags_base_path}/index.html"
+    end
+
+    def title = 'Tags'
+
+    private
+
+    def children
+      @index.values
+    end
+
+    def counts
+      sorted_index
+    end
+
+    def sorted_index
+      @sorted_index ||= @index.sort_by { |_key, tag_blog| tag_blog.count }.reverse.to_h
+    end
+
+    def tag_lines
+      sorted_index.map { |_tag, tag_blog| tag_blog.index_line }
+    end
+
+    def tags_base_path
+      Config[:blog_tags_path]
+    end
+
+    def write_target
+      return {} if empty?
+
+      super
+    end
+  end
+end

data/lib/aardi/tasks/fixtimes.rake

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-desc("Fix file timestamps")
+desc('Fix file timestamps')
 task(:fixtimes) do
-  require "aardi/timekeeper"
+  require 'aardi/timekeeper'
 
   Aardi::Timekeeper.new.run
 end

data/lib/aardi/tasks/homepage.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc("Visit home page")
+desc('Visit home page')
 task homepage: [:load_config] do
-  system("open #{Aardi.config[:site_url]}")
+  system('open', Aardi::Config[:site_url])
 end

data/lib/aardi/tasks/init.rake

@@ -1,34 +1,36 @@
 # frozen_string_literal: true
 
-INIT_FILES_DIR = File.expand_path("../init_files", __dir__)
+INIT_FILES_DIR = File.expand_path('../init_files', __dir__)
 
-desc("Scaffold a new Aardi site")
-task :init do
-  Dir.glob("#{INIT_FILES_DIR}/**/*", File::FNM_DOTMATCH).each do |src|
-    next if File.directory?(src)
+unless defined?(InitTask)
+  module InitTask
+    def self.install_file(src)
+      dest = File.basename(src)
+      return puts "Skipped #{dest}" if File.exist?(dest) && !prompt_overwrite?(dest)
 
-    dest = File.basename(src)
-
-    unless File.exist?(dest)
       FileUtils.cp(src, dest)
-      puts "Created #{dest}"
-      next
+      puts "Wrote #{dest}"
     end
 
-    loop do
-      print "#{dest} already exists. Overwrite? [y]es / [n]o: "
-      answer = $stdin.gets&.strip&.downcase
-      case answer
-      when "y"
-        FileUtils.cp(src, dest)
-        puts "Overwrote #{dest}"
-        break
-      when "n"
-        puts "Skipped #{dest}"
-        break
+    def self.prompt_overwrite?(filename)
+      loop do
+        print "#{filename} already exists. Overwrite? [y]es / [n]o: "
+        case $stdin.gets&.strip&.downcase
+        when 'y' then return true
+        when 'n' then return false
+        end
       end
     end
   end
+end
+
+desc('Scaffold a new Aardi site')
+task :init do
+  Dir.glob("#{INIT_FILES_DIR}/**/*", File::FNM_DOTMATCH).each do |src|
+    next if File.directory?(src)
+
+    InitTask.install_file(src)
+  end
 
-  puts "Site scaffolding installed."
+  puts 'Site scaffolding installed.'
 end

data/lib/aardi/tasks/load_config.rake

@@ -2,6 +2,6 @@
 
 # rubocop:disable Rake/Desc
 task :load_config do
-  Aardi.config.load "./config.yml"
+  Aardi::Config.load './config.yml'
 end
 # rubocop:enable Rake/Desc

data/lib/aardi/tasks/new.rake

@@ -3,14 +3,14 @@
 def create_new_post
   now = Time.now.utc
   new_post_file = "#{now.to_i}.md"
-  new_post_path = "#{Aardi.config[:blog_posts_path]}/#{new_post_file.hash.modulo(36).to_s(36)}/#{new_post_file}"
+  new_post_path = "#{Aardi::Config[:blog_posts_path]}/#{new_post_file.hash.modulo(36).to_s(36)}/#{new_post_file}"
   new_post_content = "Creation: #{now.iso8601}\n\n----\n### title\n\n[source](url): \"excerpt\"\n"
   FileUtils.mkdir_p(File.dirname(new_post_path))
   File.write(new_post_path, new_post_content)
   puts(new_post_path)
 end
 
-desc("Create a new blog post and reveal it in Finder")
+desc('Create a new blog post and reveal it in Finder')
 task new: [:load_config] do
   create_new_post
 end

data/lib/aardi/tasks/now.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc("Produce an Updated header with current timestamp")
+desc('Produce an Updated header with current timestamp')
 task :now do
   puts "Updated: #{Time.now.utc.iso8601}"
 end

data/lib/aardi/tasks/recent.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc("View recent posts")
+desc('View recent posts')
 task recent: [:load_config] do
   Aardi::Site.new.blog.report_recent
 end