webcode-tk 1.0.2__tar.gz → 1.0.6__tar.gz

{webcode_tk-1.0.2 → webcode_tk-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: webcode-tk
-Version: 1.0.2
+Version: 1.0.6
 Summary: 
 Home-page: https://github.com/HundredVisionsGuy/webcode-tk
 License: MIT

{webcode_tk-1.0.2 → webcode_tk-1.0.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "webcode-tk"
-version = "1.0.2"
+version = "1.0.6"
 description = ""
 authors = ["hundredvisionsguy <cwinikka@gmail.com>"]
 keywords = ["html", "validation", "css", ]

{webcode_tk-1.0.2 → webcode_tk-1.0.6}/webcode_tk/__init__.py

@@ -18,4 +18,4 @@ Modules exported by this package:
 - `validator_tools`: sends HTML or CSS code to the W3C Validator to check
           for errors.
 """
-__version__ = "1.0.2"
+__version__ = "1.0.6"

{webcode_tk-1.0.2 → webcode_tk-1.0.6}/webcode_tk/cascade_tools.py

@@ -21,8 +21,8 @@ from webcode_tk import font_tools as fonts
 from webcode_tk import html_tools
 
 
-default_global_color = "#FFFFFF"
-default_global_background = None
+default_global_color = "#000000"
+default_global_background = "#ffffff"
 default_link_color = "#0000EE"
 default_link_visited = "#551A8B"
 root_font_size = 16
@@ -111,6 +111,13 @@ class Element(object):
             "specificity": "",
             "applied_by": "default",
         }
+        self.visited_background = {
+            "value": "",
+            "sheet": "",
+            "selector": "",
+            "specificity": "",
+            "applied_by": "default",
+        }
         self.hover_color = {
             "value": "",
             "sheet": "",
@@ -134,6 +141,13 @@ class Element(object):
             "large_aaa": True,
             "large_aa": True,
         }
+        self.hover_contrast_data = {
+            "ratio": 21.0,
+            "normal_aaa": True,
+            "normal_aa": True,
+            "large_aaa": True,
+            "large_aa": True,
+        }
         self.visited_contrast_data = {
             "ratio": 0.0,
             "normal_aaa": False,
@@ -156,6 +170,10 @@ class Element(object):
             self.visited_color["value"] = default_link_visited
             self.visited_color["sheet"] = "user-agent"
             self.visited_color["specificity"] = "000"
+            self.visited_background["value"] = default_global_background
+            self.visited_background["sheet"] = "user-agent"
+            self.visited_background["specificity"] = "000"
+            self.visited_background["applied_by"] = "context"
 
     def ammend_color_styles(self, new_styles: dict, filename: str) -> None:
         """adjust color styles based on specificity.
@@ -202,6 +220,25 @@ class Element(object):
                 # get contrast for color & bg_color
                 self.get_contrast_data("standard")
         else:
+            # be sure to change at least the background color for pseudo-states
+            if targets_bg_color:
+                # check hover background
+                hover_bg = self.hover_background.get("value")
+                hover_specificity = self.hover_background.get("specificity")
+                new_bg = new_styles.get("background-color")
+                if not hover_bg or new_specificity >= hover_specificity:
+                    self.hover_background["value"] = new_bg
+                    self.hover_background["specificity"] = new_specificity
+
+                # check visited background
+                visited_bg = self.visited_background.get("value")
+                visited_specificity = self.visited_background.get(
+                    "specificity"
+                )
+                if not visited_bg or new_specificity >= visited_specificity:
+                    self.visited_background["value"] = new_bg
+                    self.visited_background["specificity"] = new_specificity
+
             # Do we have a link selector?
             is_link_selector = css.is_link_selector(selector)
             if is_link_selector:
@@ -247,6 +284,11 @@ class Element(object):
             # If it was not directly set, we can change it
             if not bg_was_directly_set:
                 self.background_color["value"] = bg_color
+                if self.children:
+                    for kid in self.children:
+                        kid.ammend_bg_color(
+                            bg_color, new_selector, new_specificity, filename
+                        )
 
     def get_contrast_data(self, type="default") -> None:
         """get color contrast for the type specified
@@ -615,11 +657,17 @@ class Element(object):
                 )
                 self.background_color["gradient_colors"] = colors
             # set color, specificity, and directly applied
-            self.background_color["value"] = val
-            self.background_color["sheet"] = filename
-            self.background_color["specificity"] = new_specificity
-            self.background_color["applied_by"] = "directly"
-            self.background_color["selector"] = selector
+            if ":hover" in selector:
+                background_color_dict = self.hover_background
+            elif ":visited" in selector:
+                background_color_dict = self.visited_background
+            else:
+                background_color_dict = self.background_color
+            background_color_dict["value"] = val
+            background_color_dict["sheet"] = filename
+            background_color_dict["specificity"] = new_specificity
+            background_color_dict["applied_by"] = "directly"
+            background_color_dict["selector"] = selector
         else:
             if not previously_set:
                 self.background_color["value"] = val
@@ -808,7 +856,14 @@ class CSSAppliedTree:
             for ruleset in color_rules:
                 # get filename
                 filename = clerk.get_file_name(sheet.href)
-                self.__adjust_colors(body, ruleset, filename)
+                selector_source = ""
+                if body.name == "body":
+                    selector_source = "body"
+                else:
+                    input("Wait, what?")
+                self.__adjust_colors(
+                    body, ruleset, filename, selector_src=selector_source
+                )
 
     def targets_body(self, ruleset: dict) -> bool:
         """returns whether the ruleset is targetting the body or not.
@@ -873,7 +928,12 @@ class CSSAppliedTree:
         return
 
     def __adjust_colors(
-        self, element: Element, ruleset: dict, filename: str
+        self,
+        element: Element,
+        ruleset: dict,
+        filename: str,
+        applied_by="default",
+        selector_src="",
     ) -> None:
         """recursively adjust color where necessary to all elements that
         apply.
@@ -924,6 +984,8 @@ class CSSAppliedTree:
             else:
                 if ":hover" in selector:
                     color = element.hover_color
+                elif ":visited" in selector:
+                    color = element.visited_color
                 else:
                     color = element.color
                 color["value"] = declaration.get("color")
@@ -932,8 +994,36 @@ class CSSAppliedTree:
                 color["specificity"] = specificity
                 color["applied_by"] = "directly"
             for child in element.children:
-                self.__adjust_child_colors(child, ruleset, filename)
-
+                element_name = element.name
+                self.__adjust_child_colors(
+                    child, ruleset, filename, element_name
+                )
+        elif is_background_prop:
+            # background - if not set directly - apply by context
+            value = declaration.get("background-color")
+            if not value:
+                value = declaration.get("background")
+            if property == "background-image":
+                value = declaration.get("background-image")
+
+            # adjust if value is not the same as current value
+            applied_by = element.background_color.get("applied_by")
+            current_value = element.background_color.get("value")
+            time_to_adjust = (
+                applied_by == "default"
+                or applied_by == "context"
+                and value != current_value
+            )
+            # But only if the value was applied to an ancestor
+            # For example, a th is not a parent of a td
+            applied_to_ancestor = False
+            for ancestor in element.ancestors:
+                ancestor_tag = ancestor[0]
+                if ancestor_tag == selector_src:
+                    applied_to_ancestor = True
+            time_to_adjust = time_to_adjust and applied_to_ancestor
+            if time_to_adjust:
+                print("Wait")
         can_inherit = self.can_inherit_styles(element, selector, ruleset)
         if can_inherit and applies:
             declaration = ruleset.get(selector)
@@ -945,7 +1035,11 @@ class CSSAppliedTree:
             self.__adjust_colors(child, ruleset, filename)
 
     def __adjust_child_colors(
-        self, child: Element, ruleset: dict, filename: str
+        self,
+        child: Element,
+        ruleset: dict,
+        filename: str,
+        applied_by="default",
     ) -> None:
         """adjusts colors for child of an element.
 
@@ -953,10 +1047,16 @@ class CSSAppliedTree:
         to see if the child element is a link or not (as well as the selector)
         and check the specificity of the ruleset.
 
+        To help with background colors, we need to know where it was applied
+        from (name of tag) - that way we can check if a declaration was applied
+        by one of the tag's parents. If it was, then we apply that color by
+        context taking the background from the nearest parent.
+
         Args:
             child: the child element in question
             ruleset: the CSS rule being applied
             filename: name of the file where the styles came from
+            applied_from: the name of the element that was targetted
         """
         # Adjust colors if necessary - if there was a change,
         # adjust colors for children
@@ -1504,7 +1604,8 @@ def get_color_contrast_details(tree: CSSAppliedTree, rating="AAA") -> list:
         rating: the rating of contrast we check for (AAA or AA). The default
             is AAA.
     Returns:
-        results"""
+        results
+    """
     results = []
     filename = tree.filename
     # Loop recursively through the tree
@@ -1547,6 +1648,7 @@ def get_color_contrast_details(tree: CSSAppliedTree, rating="AAA") -> list:
                     passes = contrast_data.get("normal_aaa")
                 else:
                     passes = contrast_data.get("normal_aa")
+
             # only add results if failure
             if not passes:
                 if el.is_large:
@@ -1556,9 +1658,10 @@ def get_color_contrast_details(tree: CSSAppliedTree, rating="AAA") -> list:
                 selector = el.background_color.get("selector")
                 if not selector:
                     selector = el.color.get("selector")
-                msg = f"{el.name} tag (selector: {selector}) fails color "
-                msg += f"contrast at {size} {rating}."
+                msg = f"selector: {selector} fails color contrast {size}"
+                msg += f"{rating}"
                 results.append(msg)
+
         if not children:
             return
         else:
@@ -1570,7 +1673,7 @@ def get_color_contrast_details(tree: CSSAppliedTree, rating="AAA") -> list:
     if results:
         adjusted = []
         for result in results:
-            adjusted.append("fail: " + result)
+            adjusted.append(f"fail: ({filename}) " + result)
         results = adjusted
     else:
         # It's a success! Let's let them know
@@ -1580,6 +1683,32 @@ def get_color_contrast_details(tree: CSSAppliedTree, rating="AAA") -> list:
     return results
 
 
+def get_color_contrast_report(dir_path: str, rating="AAA") -> list:
+    """returns a list of all failures or a pass based on rating
+
+    Args:
+        dir_path: the path to the directory in question
+        rating: the rating of contrast we check for (AAA or AA). The default
+            is AAA.
+    Returns:
+        results: a list of pass or fail messages.
+    """
+    results = []
+    files = css.get_styles_by_html_files(dir_path)
+    for file in files:
+        filepath = file.get("file")
+        stylesheets = file.get("stylesheets")
+        tree = CSSAppliedTree(filepath, stylesheets)
+
+        report = get_color_contrast_details(tree, rating)
+        for item in report:
+            if item not in results:
+                results.append(item)
+        # Do one more pass on hyperlinks and double check contrast
+        print(results)
+    return results
+
+
 if __name__ == "__main__":
     project_path = "tests/test_files/attribute_selector_file"
     project_path = "tests/test_files/large_project/"

{webcode_tk-1.0.2 → webcode_tk-1.0.6}/webcode_tk/css_tools.py

@@ -2312,14 +2312,15 @@ def fonts_applied_report(project_dir: str, min=1, max=2) -> list:
     report = []
     all_file_data = get_styles_by_html_files(project_dir)
     for file in all_file_data:
+        font_families_applied = []
         number_of_fonts = 0
         filename = clerk.get_file_name(file.get("file"))
         stylesheets = file.get("stylesheets")
-        font_styles = []
         for sheet in stylesheets:
             font_details = get_font_families(sheet)
             number_of_fonts += len(font_details)
             for item in font_details:
+                results = None
                 selector = item.get("selector")
                 family = item.get("family")
                 if "," in family:
@@ -2328,22 +2329,36 @@ def fonts_applied_report(project_dir: str, min=1, max=2) -> list:
                     first_font = family
                 first_font = first_font.replace("'", "")
                 first_font = first_font.replace('"', "")
+                if first_font not in font_families_applied:
+                    font_families_applied.append(first_font)
                 if first_font.lower() == "times new roman":
                     results = f"fail: {filename}: {selector} element was set "
                     results += "to the default font"
-                elif number_of_fonts >= min and number_of_fonts <= max:
-                    results = f"pass: {filename}: {selector} element "
-                    results += f"was set to {first_font}"
-                elif number_of_fonts < min:
-                    results = f"fail: {filename} did not apply {min} fonts, "
-                    results += f"instead, it applied {number_of_fonts} fonts."
-                if results not in font_styles:
-                    font_styles.append(results)
-        # We have all font styles applied
-        if not font_styles:
-            report.append(f"fail: {filename} No modified fonts for {filename}")
-        else:
-            report += font_styles
+        num_fonts = len(font_families_applied)
+        if num_fonts >= min and num_fonts <= max:
+            results = f"pass: {filename} applied {num_fonts} "
+            if num_fonts == 1:
+                current_font = font_families_applied[0]
+                results += f"font: {current_font}"
+            else:
+                results += "fonts:"
+                for i in range(num_fonts):
+                    current_font = font_families_applied[i]
+                    if current_font == font_families_applied[-1]:
+                        results += f"and {current_font}"
+                    elif num_fonts > 2:
+                        results += f" {current_font}, "
+                    else:
+                        results += f" {current_font} "
+            results += "."
+        elif num_fonts < min:
+            results = f"fail: {filename} did not apply {min} fonts, "
+            results += f"instead, it applied {num_fonts} fonts."
+        elif num_fonts > max:
+            results = f"fail: {filename} applied too many fonts; "
+            results += f" it applied {num_fonts} fonts."
+        if results and results not in report:
+            report.append(results)
     if not report:
         report.append("fail: no html files to apply font styling to")
     return report
@@ -2461,6 +2476,38 @@ def get_heading_color_report(project_dir: str) -> list:
     return report
 
 
+def get_project_color_contrast_report(project_dir: str, level="AAA") -> list:
+    """returns a report of pass or fail for each element targetting color.
+
+    Args:
+        project_dir: the project folder where the html and css files are found.
+        level: the level for the report (AAA or AA)
+    Returns:
+        report: a report of every targetted color and whether it passes or
+            fails.
+    """
+    report = []
+    large = "Large " + level
+    normal = "Normal " + level
+    results = get_project_color_contrast(project_dir, normal, large)
+    for result in results:
+        filename = clerk.get_file_name(result[0])
+        selector = result[1]
+        level = result[2]
+        color = result[3]
+        bg_color = result[4]
+        ratio = result[5]
+        passes = result[6]
+        if passes:
+            msg = f"pass: {filename} selector: {selector} meets color contrast"
+        else:
+            msg = f"fail: {filename} selector: {selector} DOES NOT meet"
+        msg += f" report (level {level} for colors ({color} & {bg_color})"
+        msg += f" at a ratio of {ratio}."
+        report.append(msg)
+    return report
+
+
 if __name__ == "__main__":
     insane_gradient = """
     -moz-radial-gradient(0% 200%, ellipse cover,