aardi 1.0.0 → 2.0.0

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/post.rb

@@ -7,24 +7,20 @@ module Aardi
     def initialize(path)
       @path = path
       parse_source path
-      raise "#{path}: missing Creation metadata" unless metadata['Creation']
+
+      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 report_field_summary
@@ -32,26 +28,20 @@ module Aardi
       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,65 +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.report
+    def posts
+      post_paths.map { |path| Post.new(path) }
     end
 
-    def write_target; end
+    def write_target = {}
   end
 end

data/lib/aardi/sitemap.rb

@@ -15,6 +15,12 @@ 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
@@ -26,7 +32,8 @@ module Aardi
       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/homepage.rake

@@ -2,5 +2,5 @@
 
 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

@@ -6,13 +6,10 @@ 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)
 
-      if !File.exist?(dest) || prompt_overwrite?(dest)
-        FileUtils.cp(src, dest)
-        puts "Wrote #{dest}"
-      else
-        puts "Skipped #{dest}"
-      end
+      FileUtils.cp(src, dest)
+      puts "Wrote #{dest}"
     end
 
     def self.prompt_overwrite?(filename)

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,7 +3,7 @@
 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)

data/lib/aardi/tasks/render.rake

@@ -3,4 +3,6 @@
 desc('Render new or updated files [DEFAULT]')
 task render: [:load_config] do
   Aardi::Site.new.render
+rescue Aardi::MissingPathError => e
+  abort e.message
 end

data/lib/aardi/tasks/server.rake

@@ -13,6 +13,6 @@ task :server do
   server.mount('/', Aardi::PathServlet)
 
   trap('INT') { server.shutdown }
-  system("(open '#{url}')&")
+  system('open', url)
   server.start
 end

data/lib/aardi/template.rb

@@ -3,39 +3,53 @@
 module Aardi
   # :reek:DataClump
   class Template
+    PLACEHOLDER_MAIN = '__PLACEHOLDER_MAIN__'
+    PLACEHOLDER_TITLE = '__PLACEHOLDER_TITLE__'
+    PLACEHOLDER_DESCRIPTION = '__PLACEHOLDER_DESCRIPTION__'
+
     def initialize(path)
       @path = path
-      @content = File.read(path).strip
-      @dom = Nokogiri::HTML5.parse(@content)
+      dom = Nokogiri::HTML5.parse(File.read(path).strip)
+      required(dom, 'main').add_child(PLACEHOLDER_MAIN)
+      required(dom, 'title').content += PLACEHOLDER_TITLE
+      update_description_if_present(dom.at_css('meta[name="description"]'))
+      @compiled = dom.to_html.strip
     end
 
-    # :reek:TooManyStatements
     def render(src)
-      Aardi.ledger[:custom_renderer].reset
-      dom = @dom.clone
-
-      add_main(dom, src)
-      add_title(dom, src)
-      add_description(dom, src)
-
-      dom.to_html.strip
+      result = @compiled.dup
+      result.sub!(PLACEHOLDER_MAIN, Aardi.renderer.markup(src.content))
+      result.sub!(PLACEHOLDER_TITLE, " #{text_escape(src.title)}")
+      result.sub!(PLACEHOLDER_DESCRIPTION, description_value(src)) if @default_description
+      result
     end
 
     private
 
-    def add_description(dom, src)
-      description = src.metadata['Description']
-      return unless description
+    def description_value(src)
+      escape_attributes(src.metadata.description || @default_description)
+    end
 
-      dom.at_css('meta[name="description"]')['content'] = description
+    def escape_attributes(str)
+      str.gsub('&', '&').gsub('"', '"')
     end
 
-    def add_main(dom, src)
-      dom.at_css('main').add_child(Aardi.ledger[:markdown_renderer].render(src.content))
+    def required(dom, selector)
+      dom.at_css(selector) ||
+        raise(MissingTemplateElementError,
+              "Template missing required <#{selector}> element in #{@path}")
     end
 
-    def add_title(dom, src)
-      dom.at_css('title').content += " #{src.title}"
+    def text_escape(str)
+      str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+    end
+
+    # :reek:FeatureEnvy
+    def update_description_if_present(meta)
+      return unless meta
+
+      @default_description = meta['content'] || ''
+      meta['content'] = PLACEHOLDER_DESCRIPTION
     end
   end
 end

data/lib/aardi/timekeeper.rb

@@ -3,21 +3,18 @@
 require 'git'
 
 module Aardi
-  # :reek:TooManyInstanceVariables
   class Timekeeper
     def initialize
-      @repo = Git.open(Dir.pwd)
-      @commit_log = @repo.log(:all).all
-      @files = tracked_files_by_mtime
-      @files_count = @files.count
+      repo = Git.open(Dir.pwd)
+      @commit_log = repo.log(:all).all
+      @files = repo.ls_files.keys.sort_by { |file| File.mtime(file) }.reverse!
       @updated = 0
       @prior_summary_length = 0
     end
 
     def run
-      @files.each.with_index do |path, index|
+      @files.each_with_index do |path, index|
         @prior_summary_length = print_progress(index, path)
-
         commit_date = author_date(path)
         next unless commit_date
 
@@ -41,13 +38,9 @@ module Aardi
     end
 
     def print_progress(index, path)
-      summary = "(#{index} / #{@files_count}) #{@updated}: #{path}"
+      summary = "(#{index} / #{@files.size}) #{@updated}: #{path}"
       print format("\r%-#{@prior_summary_length}s", summary)
       summary.length
     end
-
-    def tracked_files_by_mtime
-      @repo.ls_files.keys.sort_by { |file| File.mtime(file) }.reverse!
-    end
   end
 end

data/lib/aardi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aardi
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/aardi/year.rb

@@ -2,14 +2,15 @@
 
 module Aardi
   class Year < AbstractBlog
-    def initialize(key, archive_path)
+    def initialize(key, archive_path, tag = nil)
       @key = key
       @archive_path = archive_path
-      @index = Hash.new { |hash, month| hash[month] = Month.new(self, month, archive_path) }
+      @index = Hash.new { |hash, month| hash[month] = Month.new(self, month, archive_path, tag) }
+      @tag = tag
     end
 
     def <<(post)
-      @index[post.month] << post
+      @index[post.creation.month] << post
     end
 
     def archive_row(year_fmt, month_fmt)
@@ -25,16 +26,16 @@ module Aardi
       "./#{@archive_path}/#{self}/index.html"
     end
 
-    def title = to_s
-
     private
 
+    def base_title = to_s
+
     def children
       months
     end
 
     def month_link(month)
-      "- [#{Date::MONTHNAMES[month.key]}](#{Aardi.config[:site_url]}/#{@archive_path}/#{self}/#{month}/)"
+      "- [#{Date::MONTHNAMES[month.key]}](#{Config[:site_url]}/#{@archive_path}/#{self}/#{month}/)"
     end
 
     def months