webcode-tk 1.2.17__tar.gz → 1.2.19__tar.gz

{webcode_tk-1.2.17 → webcode_tk-1.2.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webcode-tk
-Version: 1.2.17
+Version: 1.2.19
 Summary: A set of tools for inspecting HTML and CSS code
 License: MIT
 License-File: LICENSE.rst

{webcode_tk-1.2.17 → webcode_tk-1.2.19}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "webcode-tk"
-version = "1.2.17"
+version = "1.2.19"
 description = "A set of tools for inspecting HTML and CSS code"
 authors = ["hundredvisionsguy <cwinikka@gmail.com>"]
 keywords = ["html", "validation", "css", ]

{webcode_tk-1.2.17 → webcode_tk-1.2.19}/webcode_tk/__init__.py

@@ -40,4 +40,4 @@
 - **`validator_tools`**: sends HTML or CSS code to the W3C Validator to check
           for errors.
 """
-__version__ = "1.2.17"
+__version__ = "1.2.19"

{webcode_tk-1.2.17 → webcode_tk-1.2.19}/webcode_tk/css_tools.py

@@ -1362,6 +1362,8 @@ def get_font_families(sheet: Stylesheet) -> list:
             # always take the last family as it would be an override in CSS
             family = families[-1]
             font_families.append({"selector": selector, "family": family})
+        else:
+            print()
     return font_families
 
 

{webcode_tk-1.2.17 → webcode_tk-1.2.19}/webcode_tk/font_tools.py

@@ -25,8 +25,11 @@ font-file or some other hidden calculation from the browser.
 import re
 from typing import Any
 from typing import Union
+from file_clerk import clerk
 
 from webcode_tk import css_tools
+from webcode_tk import html_tools as html
+
 
 absolute_keyword_regex = (
     r"\b(?:xx-small|x-small|small(?!-caps)|medium|large|x-large|"
@@ -357,6 +360,113 @@ def is_valid_shorthand(value: str) -> bool:
     return is_valid
 
 
+def get_google_font_report(project_dir: str, min=1, max=2) -> str:
+    """determines if the page is using the min number of google fonts
+
+    We're looking for three things in each web page:
+    1) a link in the head to the googlefonts API,
+    2) each of those fonts being applied, and
+    3) at least the minimum number of unique Google fonts and no more than the
+       max #.
+
+    Args:
+        project_dir: the folder where the files reside
+        min: minimum number of Google font families in use
+        max: maximum number of Google font families in use
+
+    Returns:
+        report: a pass/fail report with accompanying data
+    """
+
+    # Loop through all HTML docs and their styles
+    report = []
+    styles = css_tools.get_styles_by_html_files(project_dir)
+    for data in styles:
+
+        # Step 1: get all linked Google fonts
+        file = data.get("file")
+        filename = clerk.get_file_name(file)
+        links = html.get_elements("link", file)
+        google_fonts_linked = []
+
+        for link in links:
+            href = link.attrs.get("href")
+            if (
+                "fonts.googleapis.com" in href
+                and href != "https://fonts.googleapis.com"
+            ):
+                fonts = get_google_font_data(href)
+                if isinstance(fonts, list):
+                    google_fonts_linked += fonts
+                else:
+                    google_fonts_linked.append(fonts)
+
+        # Check to see the linked fonts match required number.
+        num_fonts = len(google_fonts_linked)
+        if num_fonts < min:
+            result = f"fail: {filename} does not link to min number of Google "
+            result += "fonts."
+            report.append(result)
+            continue
+
+        # if we have any google fonts, are they being used?
+        stylesheets = data.get("stylesheets")
+        fonts_used = []
+        for sheet in stylesheets:
+            families = []
+            font_data = css_tools.get_font_families(sheet)
+            if font_data:
+                families = extract_families(font_data)
+            if families:
+                for family in google_fonts_linked:
+                    if family in families:
+                        if family not in fonts_used:
+                            fonts_used.append(family)
+
+        num_used = len(fonts_used)
+        if num_used >= min and num_used <= max:
+            result = (
+                f"pass: {filename} uses the correct number of Google fonts"
+            )
+            report.append(result)
+        elif num_used > max:
+            result = f"fail: {filename} has too many font families - max is "
+            result += f"{max}, and you have {num_used} families."
+            report.append(result)
+        else:
+            result = (
+                f"fail: {filename} with {num_used} font families does not "
+            )
+            result += "have enough applied Google fonts"
+            report.append(result)
+    return report
+
+
+def extract_families(family_data: list) -> list:
+    families = []
+    for datum in family_data:
+        family_value = datum.get("family")
+        family = family_value.split(",")[0]
+        family = family.strip()
+        family = family.replace('"', "")
+        family = family.replace("'", "")
+        family = family.replace("&", "")
+        families.append(family)
+    return families
+
+
+def get_google_font_data(href: str) -> list:
+    font_families = []
+    font_data = href.split("family=")
+    font_data.pop(0)
+    for item in font_data:
+        family = item.split(":")[0]
+        family = family.replace("+", " ")
+        family = family.replace("&", "")
+        font_families.append(family)
+    return font_families
+
+
 if __name__ == "__main__":
     sample_styles = """
 /* <absolute-size> values */