Adds dynamic <title> tag based on post title (#2)

carlwiedemann · web-flow · commit 74d8fe66ddef · 2023-02-11T19:32:16.000-07:00
* test: Use dynamic title in posts.

* docs: Describe new feature for dynamic title in posts.

* feat: Dynamic title for posts.

* chore: Prepare for 1.2.0 release.

* docs: Link to PR, not to issue.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+TBD
+
+## [1.2.0] - 2023-02-11
+
+### Added
+
+[#2](https://github.com/carlwiedemann/foresite/pull/2) Dynamic `<title>` tag based on post title
+
 ### Fixed
 
 * Typo in README.
diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ Some facts:
 
 `post.md.erb` is used to when running `foresite touch` for the default markdown content. It has two variables, `@title` for the post title and `@date_ymd` for the created date in ISO 8601 `YYYY-MM-DD` format. Modify to have different defaults when running `foresite touch`.
 
-`wrapper.html.erb` wraps all of your markdown. Its sole variable `@content` will be a given post's HTML (converted from markdown). For the `index.html` file, `@content` will be an list of links to all posts in reverse-chronological order. Modify to have different overall page structure, or to add `<style>` etc.
+`wrapper.html.erb` wraps all of your markdown. It has two variables, `@title` for the post title that will populate the `<title>` tag, and `@content` for a given post's HTML (converted from markdown). For the `index.html` file, `@title` will be `nil`, and `@content` will be an list of links to all posts in reverse-chronological order. Modify to have different overall page structure, or to add `<style>` etc.
 
 `_list.html.erb` is used to generate the `<ul>` list of posts on the `index.html` file. Modify to show posts in a different way.
 
diff --git a/lib/foresite.rb b/lib/foresite.rb
@@ -82,8 +82,9 @@ def self.render_post(title, date_ymd)
     })
   end
 
-  def self.render_wrapped(markdown_content)
+  def self.render_wrapped(title, markdown_content)
     render_erb_file(FILENAME_WRAPPER_HTML, {
+      title: title,
       content: ::Kramdown::Document.new(markdown_content).to_html
     })
   end
diff --git a/lib/foresite/cli.rb b/lib/foresite/cli.rb
@@ -93,11 +93,12 @@ def build
 
       links = markdown_paths.map do |markdown_path|
         markdown_content = File.read(markdown_path)
+        title = markdown_content.split("\n").first { |line| /^# [a-z]/i =~ line }.gsub(/^#/, "").strip
 
         filename_markdown = File.basename(markdown_path)
         html_path = Foresite.get_path_to_out_file(filename_markdown.gsub(/\.md$/, ".html"))
 
-        File.write(html_path, Foresite.render_wrapped(markdown_content))
+        File.write(html_path, Foresite.render_wrapped(title, markdown_content))
         $stdout.puts("Created #{Foresite.relative_path(html_path)}")
 
         # Extract date if it exists.
@@ -106,7 +107,7 @@ def build
         {
           date_ymd: match_data.nil? ? "" : match_data[0],
           href: Foresite.relative_path(html_path),
-          title: markdown_content.split("\n").first { |line| /^# [a-z]/i =~ line }.gsub(/^#/, "").strip
+          title: title
         }
       end
 
diff --git a/lib/foresite/version.rb b/lib/foresite/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Foresite
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end
diff --git a/lib/skeleton/wrapper.html.erb b/lib/skeleton/wrapper.html.erb
@@ -1,8 +1,11 @@
+<%
+  index_title = 'Another Foresite Blog'
+-%>
 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
-  <title>Another Foresite Blog</title>
+  <title><%= @title ? "#{@title} - #{index_title}" : index_title %></title>
   <style></style>
 </head>
 <body>
diff --git a/spec/foresite/cli_spec.rb b/spec/foresite/cli_spec.rb
@@ -204,10 +204,12 @@
         expect(File.read(expected_path_index)).to include(expected_content_index)
 
         # They should also use the top-level HTML template, we can just use a dummy string to confirm.
-        expected_template_content = "<title>Another Foresite Blog</title>"
-        expect(File.read(expected_path_first)).to include(expected_template_content)
-        expect(File.read(expected_path_second)).to include(expected_template_content)
-        expect(File.read(expected_path_index)).to include(expected_template_content)
+        expected_title_index = "<title>Another Foresite Blog</title>"
+        expected_title_first = "<title>Jackdaws Love my Big Sphinx of Quartz! - Another Foresite Blog</title>"
+        expected_title_second = "<title>When Zombies Arrive, Quickly Fax Judge Pat - Another Foresite Blog</title>"
+        expect(File.read(expected_path_first)).to include(expected_title_first)
+        expect(File.read(expected_path_second)).to include(expected_title_second)
+        expect(File.read(expected_path_index)).to include(expected_title_index)
       end
     end
 
