fix: [general] clean up todos and format code

Author: mwasilew

image_formatter/image_properties_tag_replacer/image_properties_tag_replacer.py

@@ -70,7 +70,7 @@ def add_tag_properties_to_url(self, tag_token: Token) -> str:
         Returns:
             str: image tag properties formatted to CSS
         """
-        if (tag_token.string not in self.image_tags_properties):
+        if tag_token.string not in self.image_tags_properties:
             log.info(f"{ImagePropertiesTagReplacer.name()}: {tag_token.string} is an unknown tag, removing formatting")
             return self.curr_token.string
         properties = '{: style="'

image_formatter/lexer/lexer.py

@@ -51,7 +51,7 @@ def __init__(
         self.max_int = max_int
         self.tag = tag
         self.special_signs = special_signs
-        self.newline_characters = newline_characters  # @TODO add hypothesis tests
+        self.newline_characters = newline_characters
         self.additional_path_signs = additional_path_signs
 
     @classmethod
@@ -305,7 +305,7 @@ def get_url_ending(self, string: str) -> str or None:
             return None
         string += self.current_char
         self.next_char()
-        while self.is_character() or self.current_char in self.additional_path_signs:  # @TODO add hypothesis tests
+        while self.is_character() or self.current_char in self.additional_path_signs:
             string += self.current_char
             self.next_char()
         log.info(f"{Lexer.name()}: Url ending built successfully.")

tests/image_formatter_plugin/test_e2e_image_formatter_plugin.py

@@ -29,6 +29,7 @@
 from click.testing import CliRunner
 from mkdocs.__main__ import build_command
 
+
 # Adapted from https://github.com/timvink/mkdocs-table-reader-plugin/blame/master/tests/test_build.py
 def setup_clean_mkdocs_folder(mkdocs_yml_path, output_path):
     """
@@ -72,6 +73,7 @@ def setup_clean_mkdocs_folder(mkdocs_yml_path, output_path):
 
     return testproject_path
 
+
 def build_docs_setup(testproject_path):
     """
     Runs the `mkdocs build` command
@@ -98,25 +100,28 @@ def build_docs_setup(testproject_path):
 
 
 def test_given_tags_in_config_then_changes_image_styling(tmp_path):
-    tmp_proj = setup_clean_mkdocs_folder(
-        "./resources/e2e_test_files/test_project/mkdocs.yml", tmp_path
-    )
+    tmp_proj = setup_clean_mkdocs_folder("./resources/e2e_test_files/test_project/mkdocs.yml", tmp_path)
 
     build_docs_setup(tmp_proj)
 
-    page_path = tmp_proj / 'site/index.html'
+    page_path = tmp_proj / "site/index.html"
     contents = page_path.read_text()
     assert re.search(r'<img alt="Persian Cat" src="img/Persialainen.jpg" style="height:100px;width:100px" />', contents)
-    assert re.search(r'<img alt="Siamese Cat" src="img/Siam_lilacpoint.jpg" style="height:200px;width:200px" />', contents)
+    assert re.search(
+        r'<img alt="Siamese Cat" src="img/Siam_lilacpoint.jpg" style="height:200px;width:200px" />', contents
+    )
     assert re.search(r'<img alt="Maine Coon" src="img/Maine_coon.jpg" style="height:100px;width:100px" />', contents)
 
+
 def test_given_unknown_tags_in_config_then_no_styling_applied(tmp_path):
     tmp_proj = setup_clean_mkdocs_folder("./resources/e2e_test_files/test_project_unknown_tags/mkdocs.yml", tmp_path)
 
     build_docs_setup(tmp_proj)
 
-    page_path = tmp_proj / 'site/index.html'
+    page_path = tmp_proj / "site/index.html"
     contents = page_path.read_text()
     assert re.search(r'<img alt="Persian Cat" src="img/Persialainen.jpg" />', contents)
-    assert re.search(r'<img alt="Siamese Cat" src="img/Siam_lilacpoint.jpg" style="height:200px;width:200px" />', contents)
+    assert re.search(
+        r'<img alt="Siamese Cat" src="img/Siam_lilacpoint.jpg" style="height:200px;width:200px" />', contents
+    )
     assert re.search(r'<img alt="Maine Coon" src="img/Maine_coon.jpg" />', contents)

tests/image_properties_tag_replacer/test_image_properties_tag_replacer_exceptions.py

@@ -6,7 +6,6 @@
 from image_formatter.lexer.position import Position
 from tests.test_helpers import get_all_tags_replacer_results
 
-# @ TODO inline global var
 image_tags_properties = {
     "small": {"height": "100px", "width": "100px"},
     "small-2": {"height": "110px", "width": "110px"},

tests/image_properties_tag_replacer/test_unit_image_properties_tag_replacer.py

@@ -4,7 +4,6 @@
 from image_formatter.lexer.position import Position
 from tests.test_helpers import get_all_tags_replacer_results
 
-# @ TODO inline global var
 image_tags_properties = {
     "small": {"height": "100px", "width": "100px"},
     "medium": {"height": "150px", "width": "150px"},
@@ -51,7 +50,7 @@ def test_given_only_image_links_then_only_image_links_returned():
     assert result == expected_tokens
 
 
-def test_given_tag_and_url_separated_by_char_then_only_false_returned():
+def test_given_tag_and_url_separated_by_char_then_tags_are_unchanged():
     mock_lexer = Mock()
     mock_lexer.get_token.side_effect = [
         Token(TokenType.T_IMAGE_SIZE_TAG, Position(1, 1), "small"),
@@ -72,7 +71,7 @@ def test_given_tag_and_url_separated_by_char_then_only_false_returned():
     assert result == expected_tokens
 
 
-def test_given_no_tags_or_urls_then_only_false_returned():
+def test_given_no_tags_or_urls_then_tags_are_unchanged():
     mock_lexer = Mock()
     mock_lexer.get_token.side_effect = [
         Token(TokenType.T_CHAR, Position(1, 1), "*"),
@@ -93,7 +92,7 @@ def test_given_no_tags_or_urls_then_only_false_returned():
     assert result == expected_tokens
 
 
-def test_given_url_and_tag_token_in_reverted_order_then_only_false_returned():
+def test_given_url_and_tag_token_in_reverted_order_then_tags_are_unchanged():
     mock_lexer = Mock()
     mock_lexer.get_token.side_effect = [
         Token(TokenType.T_IMAGE_URL, Position(1, 1), "(some/url.png)"),

tests/lexer/test_unit_lexer.py

@@ -141,7 +141,6 @@ def test_given_only_tags_and_white_chars_then_only_tag_and_white_char_tokens_are
             [Position(1, 1), Position(2, 1), Position(2, 2)],
             [TokenType.T_WHITE_CHAR, TokenType.T_WHITE_CHAR, TokenType.T_IMAGE_URL],
         ),
-        # ("  \t(url1.png.url2/url3.jpg)", [Position(1, 4)]), @TODO
     ],
 )
 def test_given_only_urls_and_white_chars_then_only_url_and_white_char_tokens_are_returned(text, positions, types):

tests/token_to_string_converter/test_unit_token_to_string_converter.py

@@ -4,7 +4,6 @@
 from image_formatter.image_properties_tag_replacer.image_properties_tag_replacer import ImagePropertiesTagReplacer
 from image_formatter.token_to_string_converter.token_to_string_converter import TokenToStringConverter
 
-# @ TODO inline global var
 image_tags_properties = {
     "small": {"height": "100px", "width": "100px"},
     "small2": {"height": "110px", "width": "110px"},