Merge branch 'main' into hypothesis_tests

Author: j-jodczyk

docs/image_properties_tag_replacer.md

@@ -0,0 +1,3 @@
+# ImagePropertiesTagReplacer
+
+::: image_formatter.image_properties_tag_replacer.image_properties_tag_replacer

docs/parser.md

@@ -56,6 +56,6 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig or None:
         return config
 
     def on_page_read_source(self, page: Page, config: MkDocsConfig) -> str or None:
-        # todo: using lexer, parser and interpreter read user's docs and apply sizes specified in tags
+        # todo: using lexer, image_properties_tag_replacer and interpreter read user's docs and apply sizes specified in tags
 
         pass

image_formatter/image_formatter_plugin/image_formatter_plugin.py

@@ -0,0 +1,108 @@
+import copy
+
+from image_formatter.lexer.lexer import Lexer
+from image_formatter.lexer.token import TokenType, Token
+from image_formatter.error_handler.error_handler import ErrorHandler
+from image_formatter.error_handler.errors import UnexpectedTagException
+from mkdocs.plugins import get_plugin_logger
+
+log = get_plugin_logger(__name__)
+
+
+class ImagePropertiesTagReplacer:
+    """
+    Class ImagePropertiesTagReplacer responsible for replacing image size tags with properties after the image URL.
+    Focuses only on the plugin's purpose - images with added size tags
+    """
+
+    def __init__(self, lex: Lexer, image_tags_properties: dict, error_handler: ErrorHandler = ErrorHandler()):
+        """
+        Args:
+            lex: lexer used for obtaining tokens
+            image_tags_properties: properties to be added after tagged urls
+            error_handler: used to register errors, takes care of error handling
+        """
+        self.lexer = lex
+        self.curr_token = lex.get_token()
+        self.image_tags_properties = image_tags_properties
+        self.error_handler = error_handler
+
+    @staticmethod
+    def name() -> str:
+        return __class__.__name__
+
+    def next_token(self):
+        self.curr_token = self.lexer.get_token()
+
+    def parse_image_link_url(self, tag_token: Token) -> Token:
+        """
+        Verify if image url can be created according to the:
+        ```
+        image_link = image_size_tag, image_url
+        ```
+
+        Args:
+            tag_token: already found tag
+
+        Returns:
+            Token: of TokenType.T_IMAGE_URL_WITH_PROPERTIES if successful, otherwise of TokenType.T_IMAGE_SIZE_TAG
+        """
+        log.info(f"{ImagePropertiesTagReplacer.name()}: Trying to parse image link url.")
+        if self.curr_token.type == TokenType.T_IMAGE_URL:
+            log.info(f"{ImagePropertiesTagReplacer.name()}: Url tag found: {self.curr_token}")
+            url_token = copy.deepcopy(self.curr_token)
+            formatted_url = self.add_tag_properties_to_url(tag_token)
+            self.next_token()
+            return Token(TokenType.T_IMAGE_URL_WITH_PROPERTIES, url_token.position, formatted_url)
+        else:
+            log.error(f"{ImagePropertiesTagReplacer.name()}: Failed to parse image link url.")
+            self.error_handler.handle(UnexpectedTagException(TokenType.T_IMAGE_URL, self.curr_token.type))
+            return tag_token
+
+    def add_tag_properties_to_url(self, tag_token: Token) -> str:
+        """
+        Formats properties for given tag_token to string in a CSS format.
+
+        Args:
+            tag_token: token used to mark a url
+
+        Returns:
+            str: image tag properties formatted to CSS
+        """
+        properties = '{: style="'
+        pairs = ";".join([f"{key}:{value}" for key, value in self.image_tags_properties[tag_token.string].items()])
+        properties = properties + pairs + '"}'
+        formatted_url = self.curr_token.string + properties
+        return formatted_url
+
+    def parse_image_link_tag(self) -> Token or bool:
+        """
+        Tries to parse the first part of image link - the tag.
+        image_link = image_size_tag, image_url
+
+        Returns:
+            Token: of TokenType.T_IMAGE_URL_WITH_PROPERTIES if successful
+            False: if image link tag cannot be created
+        """
+        log.info(f"{ImagePropertiesTagReplacer.name()}: Trying to parse image link tag.")
+        if self.curr_token.type == TokenType.T_IMAGE_SIZE_TAG:
+            log.info(f"{ImagePropertiesTagReplacer.name()}: Image size tag found: {self.curr_token}")
+            tag_token = copy.deepcopy(self.curr_token)
+            self.next_token()
+            return self.parse_image_link_url(tag_token)
+        log.info(f"{ImagePropertiesTagReplacer.name()}: Failed to parse image link tag.")
+        return False
+
+    def get_token(self):
+        """
+        Replaces image size tags with properties after the url
+        """
+        while self.curr_token.type != TokenType.T_EOF:
+            if image_link_token := self.parse_image_link_tag():
+                log.info(
+                    f"{ImagePropertiesTagReplacer.name()}: Returning image link token with properties: '{image_link_token.string}'."
+                )
+                yield image_link_token
+            else:
+                yield self.curr_token
+                self.next_token()

image_formatter/parser/__init__.py renamed to image_formatter/image_properties_tag_replacer/__init__.py

@@ -325,8 +325,8 @@ def build_url(self) -> Token or None:
             log.info(f"{Lexer.name()}: Failed to build a url. Missing '('.)")
             return None
         position = deepcopy(self.current_position)
+        string = self.current_char
         self.next_char()
-        string = ""
         while self.is_character() or self.current_char == "/":
             string += self.current_char
             self.next_char()
@@ -336,6 +336,7 @@ def build_url(self) -> Token or None:
         if not self.current_char == ")":
             log.info(f"{Lexer.name()}: Failed to build a url. Missing ')'.)")
             return None
+        string += self.current_char
         self.next_char()
         log.info(f"{Lexer.name()}: Image url built successfully. Returning 'T_IMAGE_URL' token.")
         return Token(TokenType.T_IMAGE_URL, position, string)

image_formatter/image_properties_tag_replacer/image_properties_tag_replacer.py

@@ -14,7 +14,8 @@ class TokenType(Enum):
     T_CHAR = 3
     T_INTEGER = 4
     T_WHITE_CHAR = 5
-    T_EOF = 6
+    T_IMAGE_URL_WITH_PROPERTIES = 6
+    T_EOF = 7
 
 
 class Token:
@@ -33,6 +34,12 @@ def __init__(self, type: TokenType, position: Position, string: str = ""):
         self.position = position
         self.string = string
 
+    def __eq__(self, other):
+        if other.__class__ != self.__class__:
+            return False
+
+        return (self.position == other.position) and (self.string == other.string)
+
 
 class IntegerToken(Token):
     """

image_formatter/lexer/lexer.py

@@ -39,5 +39,5 @@ def on_config(self, config: dict) -> dict:
         return config
 
     def on_page_read_source() -> str or None:
-        # todo: using lexer, parser and interpreter read user's docs and apply sizes specified in tags
+        # todo: using lexer, image_properties_tag_replacer and interpreter read user's docs and apply sizes specified in tags
         pass

image_formatter/lexer/token.py

@@ -1,5 +1,5 @@
 from image_formatter.lexer.lexer import Lexer
-from image_formatter.parser.parser import Parser
+from image_formatter.image_properties_tag_replacer.image_properties_tag_replacer import ImagePropertiesTagReplacer
 
 if __name__ == "__main__":
     # filename = "tests/lexer/test_files/test1.txt"
@@ -8,5 +8,5 @@
         print(type(fp))
         lexer = Lexer(fp)
         lexer.next_char()
-        parser = Parser(lexer)
-        parser.parse()
+        parser = ImagePropertiesTagReplacer(lexer)
+        parser.get_token()

image_formatter/parser/parser.py

@@ -10,4 +10,4 @@ nav:
   - Home: index.md
   - Plugin: plugin.md
   - Lexer: lexer.md
-  - Parser: parser.md
+  - ImagePropertiesTagReplacer: image_properties_tag_replacer.md

image_size.py

@@ -1,10 +1,16 @@
 from unittest.mock import Mock
-from image_formatter.parser.parser import Parser
+from image_formatter.image_properties_tag_replacer.image_properties_tag_replacer import ImagePropertiesTagReplacer
 from image_formatter.lexer.token import Token, TokenType
 from image_formatter.error_handler.error_handler import ErrorHandler
 from image_formatter.error_handler.errors import UnexpectedTagException
 from image_formatter.lexer.position import Position
-from tests.test_helpers import get_all_parser_results
+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"},
+}
 
 
 def test_given_tag_when_not_followed_by_url_then_exception_is_registered():
@@ -15,8 +21,8 @@ def test_given_tag_when_not_followed_by_url_then_exception_is_registered():
         "",
     ]
     error_handler = ErrorHandler()
-    parser = Parser(mock_lexer, error_handler)
-    get_all_parser_results(parser, 1)
+    tags_replacer = ImagePropertiesTagReplacer(mock_lexer, image_tags_properties, error_handler)
+    get_all_tags_replacer_results(tags_replacer, 1)
     assert len(error_handler.errors) == 1
     assert error_handler.errors == [UnexpectedTagException(TokenType.T_IMAGE_URL, TokenType.T_CHAR)]
 
@@ -26,15 +32,20 @@ def test_given_tag_when_followed_by_another_tag_with_url_then_exception_is_regis
     mock_lexer.get_token.side_effect = [
         Token(TokenType.T_IMAGE_SIZE_TAG, Position(1, 1), "small"),
         Token(TokenType.T_IMAGE_SIZE_TAG, Position(2, 1), "small-2"),
-        Token(TokenType.T_IMAGE_URL, Position(3, 1), "some/url.png"),
+        Token(TokenType.T_IMAGE_URL, Position(3, 1), "(some/url.png)"),
         "",
     ]
     error_handler = ErrorHandler()
-    parser = Parser(mock_lexer, error_handler)
-    result = get_all_parser_results(parser, 2)
+    tags_replacer = ImagePropertiesTagReplacer(mock_lexer, image_tags_properties, error_handler)
+    expected_tokens = [
+        Token(TokenType.T_IMAGE_SIZE_TAG, Position(1, 1), "small"),
+        Token(
+            TokenType.T_IMAGE_URL_WITH_PROPERTIES, Position(3, 1), '(some/url.png){: style="height:110px;width:110px"}'
+        ),
+    ]
+    result = get_all_tags_replacer_results(tags_replacer, 2)
 
     assert len(error_handler.errors) == 1
     assert error_handler.errors == [UnexpectedTagException(TokenType.T_IMAGE_URL, TokenType.T_IMAGE_SIZE_TAG)]
     assert len(result) == 2
-    assert result[0] is False
-    assert result[1] == ("small-2", "some/url.png")
+    assert result == expected_tokens