feat: refactored static page generation

Issue #16

Author: stepanzh

.gitignore

@@ -1,4 +1,7 @@
 debug
 deploy
 venv
-src/promo.jpg
+static/promo.jpg
+
+*.pyc
+

Makefile

@@ -1,34 +1,31 @@
-SOURCE_DIR = src
 DEBUG_DIR = debug
 DEPLOY_DIR = deploy
+STATIC_DIR = static
 
+all: clear debug deploy
 
-all: debug deploy
-
-debug: $(SOURCE_DIR)/index.html $(SOURCE_DIR)/script.js $(SOURCE_DIR)/app.css $(SOURCE_DIR)/promo.css $(SOURCE_DIR)/examples.html
+debug:
 	mkdir -p $(DEBUG_DIR)
-	cp -r $(SOURCE_DIR)/* $(DEBUG_DIR)
-	python3 html_builder.py -m debug -f $(SOURCE_DIR)/index.html > $(DEBUG_DIR)/index.html
-	python3 examples_page_builder.py -m debug -f $(SOURCE_DIR)/examples.html > $(DEBUG_DIR)/examples.html
+	cp -r $(STATIC_DIR)/* $(DEBUG_DIR)
+	python3 build.py --debug -d $(DEBUG_DIR)
 
 deploy: debug
 	mkdir -p $(DEPLOY_DIR)
-	cp -r $(DEBUG_DIR)/* $(DEPLOY_DIR)
-	python3 html_builder.py -m deploy -f $(SOURCE_DIR)/index.html > $(DEPLOY_DIR)/index.html
-	python3 examples_page_builder.py -m deploy -f $(SOURCE_DIR)/examples.html > $(DEPLOY_DIR)/examples.html
-	uglifyjs $(DEBUG_DIR)/script.js > $(DEPLOY_DIR)/script.js
-	uglifyjs $(DEBUG_DIR)/examples.js > $(DEPLOY_DIR)/examples.js
-
-pages: deploy
-	ghp-import -n -f -p $(DEPLOY_DIR)
+	cp -r $(STATIC_DIR)/* $(DEPLOY_DIR)
+	python3 build.py -d $(DEPLOY_DIR)
+	uglifyjs $(STATIC_DIR)/js/index.js > $(DEPLOY_DIR)/js/index.js
+	uglifyjs $(STATIC_DIR)/js/examples.js > $(DEPLOY_DIR)/js/examples.js
 
 clear:
 	rm -rf $(DEBUG_DIR)
 	rm -rf $(DEPLOY_DIR)
 
+pages: deploy
+	ghp-import -n -f -p $(DEPLOY_DIR)
+
 newpromo:
 ifdef i
-	cp $(i) 'src/promo.jpg'
+	cp $(i) 'static/promo.jpg'
 else
 	@echo "No picture specified. Usage: make i=path newpromo"
 endif

build.py

@@ -0,0 +1,143 @@
+import argparse
+from dataclasses import dataclass, field
+import jinja2
+import json
+import pathlib
+from typing import Optional
+
+from builder.icons import Icons
+from builder.contact import Contact
+from builder.recipe import RecipeExample
+
+
+@dataclass
+class JqueryCDN:
+    src: str
+    integrity: str
+
+
+TEMPLATES_PATH = pathlib.Path(__file__).parent / 'templates'
+STATICS_PATH = pathlib.Path(__file__).parent / 'static'
+ICONS = Icons.from_icon_folder(STATICS_PATH / 'icons')
+EXTERNAL_LINKS = {
+    'payment': 'https://www.tinkoff.ru/cf/7T9naweBKz8',
+    'repository': 'https://github.com/stepanzh/Proportio',
+}
+PROJECT_CONTACTS = {
+    'Stepan': Contact(
+        firstname='Степан',
+        secondname='Захаров',
+        telegram='https://t.me/red_deer',
+        github='https://github.com/stepanzh',
+    ),
+    'Alexandra': Contact(
+        firstname='Александра',
+        secondname='Кобец',
+        telegram='https://t.me/kobets_dez',
+    ),
+    'Mariya': Contact(
+        firstname='Мария',
+        secondname='Лукьянова',
+        telegram='https://t.me/Marnia_made'
+    ),
+}
+
+JQUERY = {
+    'debug': JqueryCDN(
+        src="https://code.jquery.com/jquery-3.6.2.js",
+        integrity="sha256-pkn2CUZmheSeyssYw3vMp1+xyub4m+e+QK4sQskvuo4="
+    ),
+    'deploy': JqueryCDN(
+        src="https://code.jquery.com/jquery-3.6.3.slim.min.js",
+        integrity="sha256-ZwqZIVdD3iXNyGHbSYdsmWP//UBokj2FHAxKuSBKDSo="
+    ),
+}
+
+
+class Page:
+    name: str
+    template_variables: dict
+
+    def extend_template_variables(self, variables: dict):
+        self.template_variables |= variables
+
+
+class PageWriter:
+    def __init__(self, environment: jinja2.Environment, rootdir: pathlib.Path):
+        self.environment = environment
+        self.rootdir = rootdir
+
+    def write(self, page: Page):
+        filename = page.name + '.html'
+        template = self.environment.get_template(filename)
+        text = template.render(page.template_variables)
+        with open(self.rootdir / filename, 'w') as io:
+            print(text, file=io)
+
+
+class IndexPage(Page):
+    name = 'index'
+    template_variables = {
+        'contacts': PROJECT_CONTACTS,
+        'icons': ICONS,
+        'links': EXTERNAL_LINKS,
+        'jquery': JQUERY,
+   }
+
+
+class PromoPage(Page):
+    name = 'promo'
+    template_variables = dict()
+
+
+class ExamplePage(Page):
+    name = 'examples'
+
+    def __init__(self):
+        recipe_dir = STATICS_PATH / 'example_recipes'
+
+        recipes = sorted(
+            map(
+                lambda path: RecipeExample.from_json_path(path),
+                filter(lambda x: x.is_file(), recipe_dir.iterdir())
+            ),
+            key=lambda recipe: recipe.title.lower(),
+        )
+
+        self.template_variables = {
+            'recipe_examples': recipes,
+        }
+
+
+PAGES = [IndexPage(), PromoPage(), ExamplePage()]
+
+
+def parse_commandline():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-d', '--output_dir',
+        required=True,
+        help='output directory for site',
+    )
+    parser.add_argument('--debug',
+        help='generate debuggable version of site',
+        action=argparse.BooleanOptionalAction,
+        default=False,
+    )
+    args = parser.parse_args()
+    return args
+
+def main():
+    args = parse_commandline()
+
+    environment = jinja2.Environment(loader=jinja2.FileSystemLoader(TEMPLATES_PATH))
+
+    pagewriter = PageWriter(environment, pathlib.Path(args.output_dir))
+    for page in PAGES:
+        page.extend_template_variables({
+            'isdebug': args.debug,
+        })
+        pagewriter.write(page)
+
+
+if __name__ == '__main__':
+    main()

builder/contact.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+import typing
+
+
+@dataclass
+class Contact:
+    firstname: str = ""
+    secondname: str = ""
+    telegram: str = ""
+    github: str = ""

builder/icons.py

@@ -0,0 +1,25 @@
+import pathlib
+import typing
+
+
+class Icons:
+    def __init__(self):
+        self.inner = dict()
+
+    def __getattr__(self, icon_name):
+        if icon_name not in self.inner.keys():
+            raise AttributeError()
+        return self.inner[icon_name]
+
+    @classmethod
+    def from_icon_folder(cls, folder_path: pathlib.Path):
+        assert folder_path.is_dir(), f"Icon folder does not exist: {folder_path}"
+
+        icons = Icons()
+
+        for child in folder_path.iterdir():
+            if not child.is_file():
+                continue
+            with open(child) as io:
+                icons.inner[child.stem] = io.read().strip()
+        return icons

builder/recipe.py

@@ -0,0 +1,53 @@
+from dataclasses import dataclass
+import json
+import pathlib
+import typing
+
+
+@dataclass
+class RecipeCredits:
+    author: str = ''
+    recipe_url: str = ''
+
+    @classmethod
+    def from_dict(cls, d):
+        if d is None:
+            return RecipeCredits()
+
+        author = d.get('author', '')
+        recipe_url = d.get('recipe_url', '')
+        return RecipeCredits(author, recipe_url)
+
+    @property
+    def is_empty(self):
+        return (not self.author) and (not self.recipe_url)
+
+
+@dataclass
+class RecipeExample:
+    title: str
+    ingredients: typing.List[str]
+    relative_url: str
+    credits: RecipeCredits
+
+    @property
+    def ingredients_as_string(self):
+        ingredients = list(map(lambda x: str(x).lower(), self.ingredients))
+        ingredients[0] = ingredients[0].capitalize()
+        s = ', '.join(ingredients)
+        return s
+
+    @classmethod
+    def from_json_path(cls, json_path):
+        with open(json_path) as io:
+            recipe = json.loads(io.read())
+
+            title = recipe.get('title', '').replace(' - ', ' — ')
+            ingredients = [item['name'] for item in recipe.get('original_items')]
+            # TODO: Should be refactored
+            relative_url = json_path.relative_to(
+                pathlib.Path(__file__).parent.parent / 'static'
+            )
+            credits = RecipeCredits.from_dict(recipe.get('credits'))
+
+            return RecipeExample(title=title, ingredients=list(ingredients), relative_url=relative_url, credits=credits)