aardi 0.9.2 → 2.0.0

data/lib/aardi/tasks/render.rake

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-desc("Render new or updated files [DEFAULT]")
+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

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-desc("Run a server")
+desc('Run a server')
 task :server do
-  require "aardi/path_servlet"
+  require 'aardi/path_servlet'
 
   port = 8000
   url = "http://localhost:#{port}/"
-  root = "."
+  root = '.'
   puts(url)
 
   server = WEBrick::HTTPServer.new(Port: port, DocumentRoot: root)
-  server.mount("/", Aardi::PathServlet)
+  server.mount('/', Aardi::PathServlet)
 
-  trap("INT") { server.shutdown }
-  system("(open '#{url}')&")
+  trap('INT') { server.shutdown }
+  system('open', url)
   server.start
 end

data/lib/aardi/tasks.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require "aardi"
+require 'aardi'
 
-Dir[File.join(__dir__, "tasks", "*.rake")].each { |f| load f }
+Dir[File.join(__dir__, 'tasks', '*.rake')].each { |f| load f }

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

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
-require "git"
+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 = "0.9.2"
+  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

data/lib/aardi.rb

@@ -1,54 +1,64 @@
 # frozen_string_literal: true
 
-require "date"
-require "fileutils"
-require "json"
-require "yaml"
-require "zlib"
+%w[
+  date
+  fileutils
+  json
+  yaml
+  zlib
+  nokogiri
+  rake
+  redcarpet
+].each { |lib| require lib }
 
-require "nokogiri"
-require "rake"
-require "redcarpet"
+%w[
+  errors
+  version
+  config
+  metadata
+  content
+  content_hashes
+  custom_renderer
+  renderer
+  abstract_blog
+  abstract_page_support
+  abstract_feed
+  file_target
+  page_target
+  page_content
+  template
+  page
+  post_bookmark_line
+  post
+  day
+  month
+  year
+  archive
+  home_footer_links
+  home
+  tags
+  atom_feed
+  json_feed
+  blog
+  tag_blog
+  folder
+  sitemap
+  orphanage
+  site
+].each { |name| require_relative "aardi/#{name}" }
 
-require_relative "aardi/version"
-require_relative "aardi/config"
-require_relative "aardi/ledger"
-require_relative "aardi/content"
-require_relative "aardi/content_hashes"
-require_relative "aardi/custom_renderer"
-require_relative "aardi/abstract_blog"
-require_relative "aardi/abstract_page_support"
-require_relative "aardi/abstract_feed"
-require_relative "aardi/file_target"
-require_relative "aardi/page_target"
-require_relative "aardi/page_content"
-require_relative "aardi/template"
-require_relative "aardi/page"
-require_relative "aardi/post"
-require_relative "aardi/day"
-require_relative "aardi/month"
-require_relative "aardi/year"
-require_relative "aardi/archive"
-require_relative "aardi/home"
-require_relative "aardi/atom_feed"
-require_relative "aardi/json_feed"
-require_relative "aardi/blog"
-require_relative "aardi/folder"
-require_relative "aardi/sitemap"
-require_relative "aardi/orphanage"
-require_relative "aardi/site"
-
-RubyVM::YJIT.enable if RUBY_ENGINE == "ruby" && RUBY_VERSION.to_f >= 3.1
+RubyVM::YJIT.enable if RUBY_ENGINE == 'ruby'
 
 module Aardi
   class << self
-    def config = @config ||= Config.new
+    # :reek:Attribute
+    attr_writer :renderer
 
-    def ledger = @ledger ||= Ledger.new
+    def renderer = @renderer ||= Renderer.new
 
     def reset!
-      @config = Config.new
-      @ledger = Ledger.new
+      Config.reset
+      @renderer = nil
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aardi
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Faisal N Jawdat
@@ -79,146 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: flog
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-ordered_methods
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rubyfmt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.35.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.35.1
 email: aardi@faisal.com
 executables: []
 extensions: []
@@ -236,12 +96,14 @@ files:
 - lib/aardi/content_hashes.rb
 - lib/aardi/custom_renderer.rb
 - lib/aardi/day.rb
+- lib/aardi/errors.rb
 - lib/aardi/file_target.rb
 - lib/aardi/folder.rb
 - lib/aardi/home.rb
+- lib/aardi/home_footer_links.rb
 - lib/aardi/init_files/config.yml
 - lib/aardi/json_feed.rb
-- lib/aardi/ledger.rb
+- lib/aardi/metadata.rb
 - lib/aardi/month.rb
 - lib/aardi/orphanage.rb
 - lib/aardi/page.rb
@@ -249,8 +111,12 @@ files:
 - lib/aardi/page_target.rb
 - lib/aardi/path_servlet.rb
 - lib/aardi/post.rb
+- lib/aardi/post_bookmark_line.rb
+- lib/aardi/renderer.rb
 - lib/aardi/site.rb
 - lib/aardi/sitemap.rb
+- lib/aardi/tag_blog.rb
+- lib/aardi/tags.rb
 - lib/aardi/tasks.rb
 - lib/aardi/tasks/fixtimes.rake
 - lib/aardi/tasks/homepage.rake
@@ -265,10 +131,14 @@ files:
 - lib/aardi/timekeeper.rb
 - lib/aardi/version.rb
 - lib/aardi/year.rb
+homepage: https://github.com/faisal/aardi
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://www.github.com/faisal/aardi
+  source_code_uri: https://github.com/faisal/aardi
+  bug_tracker_uri: https://github.com/faisal/aardi/issues
+  changelog_uri: https://github.com/faisal/aardi/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/faisal/aardi/blob/main/README.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -284,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.12
 specification_version: 4
 summary: A static site generator.
 test_files: []

data/lib/aardi/ledger.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Aardi
-  class Ledger
-    def initialize
-      @data = {}
-    end
-
-    def [](key) = @data[key]
-
-    def []=(key, value)
-      @data[key] = value
-    end
-  end
-end