Allow specifying an editor as well as/instead of an author
[books.alexwlchan.net] / scripts / render_html.py
index bb0eb11..048a7fc 100755 (executable)
@@ -1,6 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 import datetime
+import hashlib
+import itertools
 import os
 import pathlib
 import re
@@ -8,22 +10,72 @@ import subprocess
 import sys
 
 import attr
+import bs4
+import cssmin
 import frontmatter
+from jinja2 import Environment, FileSystemLoader, select_autoescape
 import markdown
 from markdown.extensions.smarty import SmartyExtension
-from jinja2 import Environment, FileSystemLoader, select_autoescape
+import smartypants
+
+from generate_bookshelf import create_shelf_data_uri
+from tint_colors import get_tint_colors, store_tint_color
 
 
 def rsync(dir1, dir2):
     subprocess.check_call(["rsync", "--recursive", "--delete", dir1, dir2])
 
 
+def git(*args):
+    return subprocess.check_output(["git"] + list(args)).strip().decode("utf8")
+
+
+def set_git_timestamps():
+    """
+    For everything in the covers/ directory, set the last modified timestamp to
+    the last time it was modified in Git.  This should make tint colour computations
+    stable across machines.
+    """
+    root = git("rev-parse", "--show-toplevel")
+
+    now = datetime.datetime.now().timestamp()
+
+    for f in os.listdir("src/covers"):
+        path = os.path.join("src/covers", f)
+
+        if not os.path.isfile(path):
+            continue
+
+        stat = os.stat(path)
+
+        # If the modified time is >7 days ago, skip setting the modified time.  This means
+        # the script stays pretty fast when doing a regular sync.
+        if now - stat.st_mtime > 7 * 24 * 60 * 60 and "--reset" not in sys.argv:
+            continue
+
+        revision = git("rev-list", "--max-count=1", "HEAD", path)
+
+        if not revision:
+            continue
+
+        timestamp, *_ = git("show", "--pretty=format:%ai", "--abbrev-commit", revision).splitlines()
+        modified_time = datetime.datetime.strptime(timestamp, "%Y-%m-%d %H:%M:%S %z").timestamp()
+
+        access_time = stat.st_atime
+
+        os.utime(path, times=(access_time, modified_time))
+
+
 @attr.s
 class Book:
+    slug = attr.ib()
     title = attr.ib()
-    author = attr.ib()
     publication_year = attr.ib()
-    cover_image = attr.ib()
+
+    author = attr.ib(default="")
+    editor = attr.ib(default="")
+
+    cover_image = attr.ib(default="")
     cover_desc = attr.ib(default="")
 
     isbn10 = attr.ib(default="")
@@ -33,9 +85,11 @@ class Book:
 @attr.s
 class Review:
     date_read = attr.ib()
-    rating = attr.ib()
     text = attr.ib()
-    format = attr.ib()
+    date_order = attr.ib(default=1)
+    format = attr.ib(default=None)
+    rating = attr.ib(default=None)
+    did_not_finish = attr.ib(default=False)
 
 
 @attr.s
@@ -45,13 +99,23 @@ class ReviewEntry:
     review = attr.ib()
 
     def out_path(self):
-        return self.path.relative_to("src").with_suffix("")
+        name = self.path.with_suffix("").name
+        return pathlib.Path(f"reviews/{name}")
 
 
 def get_review_entry_from_path(path):
     post = frontmatter.load(path)
 
-    book = Book(**post["book"])
+    kwargs = {}
+    for attr_name in Book.__attrs_attrs__:
+        try:
+            kwargs[attr_name.name] = post["book"][attr_name.name]
+        except KeyError:
+            pass
+
+    kwargs["slug"] = os.path.basename(os.path.splitext(path)[0])
+    book = Book(**kwargs)
+
     review = Review(**post["review"], text=post.content)
 
     return ReviewEntry(path=path, book=book, review=review)
@@ -68,20 +132,50 @@ class CurrentlyReadingEntry:
     book = attr.ib()
     reading = attr.ib()
 
-    def out_path(self):
-        return self.path.relative_to("src").with_suffix("")
-
 
 def get_reading_entry_from_path(path):
     post = frontmatter.load(path)
 
-    book = Book(**post["book"])
+    slug = os.path.basename(os.path.splitext(path)[0])
+    book = Book(slug=slug, **post["book"])
+
     reading = CurrentlyReading(text=post.content)
 
     return CurrentlyReadingEntry(path=path, book=book, reading=reading)
 
 
-def get_reviews(dirpath, constructor):
+def _parse_date(value):
+    if isinstance(value, datetime.date):
+        return value
+    else:
+        return datetime.datetime.strptime(value, "%Y-%m-%d").date()
+
+
+@attr.s
+class Plan:
+    text = attr.ib()
+    date_added = attr.ib(converter=_parse_date)
+
+
+@attr.s
+class PlanEntry:
+    path = attr.ib()
+    book = attr.ib()
+    plan = attr.ib()
+
+
+def get_plan_entry_from_path(path):
+    post = frontmatter.load(path)
+
+    slug = os.path.basename(os.path.splitext(path)[0])
+    book = Book(slug=slug, **post["book"])
+
+    plan = Plan(date_added=post["plan"]["date_added"], text=post.content)
+
+    return PlanEntry(path=path, book=book, plan=plan)
+
+
+def get_entries(dirpath, constructor):
     for dirpath, _, filenames in os.walk(dirpath):
         for f in filenames:
             if not f.endswith(".md"):
@@ -102,7 +196,7 @@ def render_markdown(text):
 
 def render_date(date_value):
     if isinstance(date_value, datetime.date):
-        return date_value.strftime("%d %B %Y")
+        return date_value.strftime("%-d %B %Y")
 
     date_match = re.match(
         r"^(?P<year>\d{4})-(?P<month>\d{2})(?:-(?P<day>\d{2}))?$", date_value
@@ -116,22 +210,85 @@ def render_date(date_value):
     )
 
     if date_match.group("day"):
-        return date_obj.strftime("%-d %B %Y")
+        return render_date(date_obj)
     else:
         return date_obj.strftime("%B %Y")
 
 
-def render_individual_review(env, *, review_entry):
-    template = env.get_template("review.html")
-    html = template.render(review_entry=review_entry)
-
-    out_name = review_entry.out_path() / "index.html"
-    out_path = pathlib.Path("_html") / out_name
+def save_html(template, out_name="", **kwargs):
+    html = template.render(**kwargs)
+    out_path = pathlib.Path("_html") / out_name / "index.html"
     out_path.parent.mkdir(exist_ok=True, parents=True)
-    out_path.write_text(html)
 
+    soup = bs4.BeautifulSoup(html, "html.parser")
+
+    # Minify the CSS in all inline <style> tags.
+    for style_tag in soup.find_all("style"):
+        style_tag.string = cssmin.cssmin(style_tag.string)
+
+    # Remove any comments
+    for comment in soup(text=lambda text: isinstance(text, bs4.Comment)):
+        comment.extract()
+
+    out_path.write_text(str(soup))
+
+
+def _create_new_thumbnail(src_path, dst_path):
+    dst_path.parent.mkdir(exist_ok=True, parents=True)
+
+    # Thumbnails are 240x240 max, then 2x for retina displays
+    subprocess.check_call([
+        "convert", src_path, "-resize", "480x480>", dst_path
+    ])
+
+
+def thumbnail_1x(name):
+    pth = pathlib.Path(name)
+    return pth.stem + "_1x" + pth.suffix
+
+
+def _create_new_square(src_path, square_path):
+    square_path.parent.mkdir(exist_ok=True, parents=True)
+
+    subprocess.check_call([
+        "convert",
+        src_path, "-resize", "240x240", "-gravity", "center", "-background", "white", "-extent", "240x240", square_path
+    ])
+
+
+def create_thumbnails():
+    for image_name in os.listdir("src/covers"):
+        if image_name == ".DS_Store":
+            continue
+
+        src_path = pathlib.Path("src/covers") / image_name
+        dst_path = pathlib.Path("_html/thumbnails") / image_name
+
+        if not dst_path.exists():
+            _create_new_thumbnail(src_path, dst_path)
+        elif src_path.stat().st_mtime > dst_path.stat().st_mtime:
+            _create_new_thumbnail(src_path, dst_path)
+
+        square_path = pathlib.Path("_html/squares") / image_name
+
+        if not square_path.exists():
+            _create_new_square(src_path, square_path)
+        elif src_path.stat().st_mtime > square_path.stat().st_mtime:
+            _create_new_square(src_path, square_path)
+
+        store_tint_color(dst_path)
+
+
+CSS_HASH = hashlib.md5(open('static/style.css', 'rb').read()).hexdigest()
+
+
+def css_hash(_):
+    return f"md5:{CSS_HASH}"
+
+
+def main():
+    set_git_timestamps()
 
-if __name__ == "__main__":
     env = Environment(
         loader=FileSystemLoader("templates"),
         autoescape=select_autoescape(["html", "xml"]),
@@ -139,6 +296,14 @@ if __name__ == "__main__":
 
     env.filters["render_markdown"] = render_markdown
     env.filters["render_date"] = render_date
+    env.filters["smartypants"] = smartypants.smartypants
+    env.filters["thumbnail_1x"] = thumbnail_1x
+    env.filters["css_hash"] = css_hash
+    env.filters["create_shelf_data_uri"] = create_shelf_data_uri
+
+    create_thumbnails()
+
+    tint_colors = get_tint_colors()
 
     rsync("src/covers/", "_html/covers/")
     rsync("static/", "_html/static/")
@@ -146,38 +311,96 @@ if __name__ == "__main__":
     # Render the "all reviews page"
 
     all_reviews = list(
-        get_reviews(dirpath="src/reviews", constructor=get_review_entry_from_path)
+        get_entries(dirpath="src/reviews", constructor=get_review_entry_from_path)
     )
     all_reviews = sorted(
-        all_reviews, key=lambda rev: str(rev.review.date_read), reverse=True
+        all_reviews, key=lambda rev: f"{rev.review.date_read}/{rev.review.date_order}", reverse=True
     )
 
     for review_entry in all_reviews:
-        render_individual_review(env, review_entry=review_entry)
-
-    template = env.get_template("list_reviews.html")
-    html = template.render(all_reviews=all_reviews)
-
-    out_path = pathlib.Path("_html") / "reviews/index.html"
-    out_path.write_text(html)
+        save_html(
+            template=env.get_template("review.html"),
+            out_name=review_entry.out_path(),
+            review_entry=review_entry,
+            title=f"My review of {review_entry.book.title}",
+            tint_colors=tint_colors
+        )
+
+    save_html(
+        template=env.get_template("list_reviews.html"),
+        out_name="reviews",
+        all_reviews=[
+            (year, list(reviews))
+            for (year, reviews) in itertools.groupby(
+                all_reviews, key=lambda rev: str(rev.review.date_read)[:4]
+            )
+        ],
+        title="books i’ve read",
+        this_year=str(datetime.datetime.now().year),
+        tint_colors=tint_colors
+    )
 
     # Render the "currently reading" page
 
     all_reading = list(
-        get_reviews(dirpath="src/currently_reading", constructor=get_reading_entry_from_path)
+        get_entries(
+            dirpath="src/currently_reading", constructor=get_reading_entry_from_path
+        )
     )
 
-    template = env.get_template("list_reading.html")
-    html = template.render(all_reading=all_reading)
+    save_html(
+        template=env.get_template("list_reading.html"),
+        out_name="reading",
+        all_reading=all_reading,
+        title="books i’m currently reading",
+        tint_colors=tint_colors
+    )
 
-    out_path = pathlib.Path("_html") / "reading/index.html"
-    out_path.parent.mkdir(exist_ok=True, parents=True)
-    out_path.write_text(html)
+    # Render the "want to read" page
+
+    all_plans = list(
+        get_entries(dirpath="src/plans", constructor=get_plan_entry_from_path)
+    )
+
+    all_plans = sorted(all_plans, key=lambda plan: plan.plan.date_added, reverse=True)
+
+    save_html(
+        template=env.get_template("list_plans.html"),
+        out_name="to-read",
+        all_plans=all_plans,
+        title="books i want to read",
+        tint_colors=tint_colors,
+    )
+
+    # Render the "never going to read this page"
+
+    all_retired = list(
+        get_entries(dirpath="src/will_never_read", constructor=get_plan_entry_from_path)
+    )
+
+    all_retired = sorted(
+        all_retired, key=lambda plan: plan.plan.date_added, reverse=True
+    )
+
+    save_html(
+        template=env.get_template("list_will_never_read.html"),
+        out_name="will-never-read",
+        all_retired=all_retired,
+        title="books i&rsquo;m never going to read",
+        tint_colors=tint_colors
+    )
 
     # Render the front page
 
-    index_template = env.get_template("index.html")
-    html = index_template.render(text=open("src/index.md").read())
+    save_html(
+        template=env.get_template("index.html"),
+        text=open("src/index.md").read(),
+        reviews=all_reviews[:5],
+        tint_colors=tint_colors
+    )
+
+    print("✨ Rendered HTML files to _html ✨")
 
-    index_path = pathlib.Path("_html") / "index.html"
-    index_path.write_text(html)
+
+if __name__ == "__main__":
+    main()