Fix generated news archive pages for Jekyll 4.2.0

stomar · stomar · commit f29a3d5f33cb · 2020-12-27T21:54:08.000+01:00
Before this change, with Jekyll 4.2.0 all news archive pages used `news.html` as layout, also the yearly and monthly archive pages, leading to wrong sidebars that list "Archives by Year" (without any entries) and "Syndicate". The reason is that `Page#relative_path` is a memoized value and Jekyll 4.2.0 changes when `relative_path` is first called during generation of the archive pages. Other than before it is now called from `read_yaml`, see jekyll/jekyll@2608640 `YearlyArchive` and `MonthlyArchive` call `ArchivePage#new` (via `super`), which uses `read_yaml`, so that from then on `relative_path` is set and will not change anymore. Therefore the reassignments of `@dir` in YearlyArchive and MonthlyArchive after the `super` calls have no effect on `relative_path`. Hence *all* archive pages have their relative path set to `<lang>/news/index.html`. Then for rendering, apparently the content of the page under the relative path is used (i.e. the `news.html` layout) instead of the in fact correctly set `content` of the respective archive page (i.e. `news_archive_year.html` or `news_archive_month.html`). This issue is fixed by not changing `@dir` after calling `super`.
diff --git a/_plugins/news.rb b/_plugins/news.rb
@@ -6,12 +6,15 @@ module Jekyll
   module News
     class ArchivePage < Page
 
-      def initialize(site, base, layout, lang, posts)
+      def initialize(site, base, subdir, layout, lang, posts)
         @site = site
         @base = base
-
         @lang = lang
-        @dir  = File.join(@lang, news_dir)
+        @dir  = if subdir
+                  File.join(@lang, news_dir, subdir)
+                else
+                  File.join(@lang, news_dir)
+                end
         @name = "index.html"
 
         @locales = @site.data["locales"][@lang]["news"] ||
@@ -47,11 +50,11 @@ class MonthlyArchive < ArchivePage
       LAYOUT = "news_archive_month.html"
 
       def initialize(site, base, lang, year, month, posts)
-        super(site, base, LAYOUT, lang, posts)
-
         @year  = year
         @month = month
-        @dir   = File.join(@dir, @year.to_s, "%.2d" % @month)
+        subdir = File.join(@year.to_s, "%.2d" % @month)
+
+        super(site, base, subdir, LAYOUT, lang, posts)
 
         title = @locales["monthly_archive_title"]
 
@@ -65,10 +68,10 @@ class YearlyArchive < ArchivePage
       LAYOUT = "news_archive_year.html"
 
       def initialize(site, base, lang, year, posts)
-        super(site, base, LAYOUT, lang, posts)
-
         @year = year
-        @dir  = File.join(@dir, @year.to_s)
+        subdir = @year.to_s
+
+        super(site, base, subdir, LAYOUT, lang, posts)
 
         title = @locales["yearly_archive_title"]
         month_link_text = @locales["monthly_archive_link"]
@@ -94,7 +97,8 @@ class Index < ArchivePage
       MAX_POSTS = 10
 
       def initialize(site, base, lang, posts)
-        super(site, base, LAYOUT, lang, posts)
+        subdir = nil
+        super(site, base, subdir, LAYOUT, lang, posts)
 
         title = @locales["recent_news"]
         year_link_text = @locales["yearly_archive_link"]
