Add Emoji class and integrate into tests and rendering

Author: MatthewCane

ca_slack_block_kit/__init__.py

@@ -11,6 +11,10 @@
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 
+from .emoji import Emoji  # type: ignore[import]
+
+__all__ = ["Emoji"]
+
 
 def render_blocks(blocks: list["Block"]) -> list[dict]:
     """Render a list of Block objects into a list of dictionaries compatible with the Slack SDK client chat_postMessage function.

ca_slack_block_kit/emoji.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Emoji:
+    """Various emojis for easy use with Slack messages."""
+
+    THUMBS_UP = ":thumbsup:"
+    THUMBS_DOWN = ":thumbsdown:"
+    PARTY_POPPER = ":tada:"
+    WARNING = ":warning:"
+    CHECK_MARK = ":white_check_mark:"
+    CROSS_MARK = ":x:"
+    INFO = ":information_source:"
+    ROCKET = ":rocket:"
+    EYES = ":eyes:"
+    FIRE = ":fire:"
+    STAR = ":star:"
+    HEART = ":heart:"
+    CLAP = ":clap:"
+    LIGHT_BULB = ":bulb:"
+    HOURGLASS = ":hourglass_flowing_sand:"
+    BUG = ":bug:"
+    SPARKLES = ":sparkles:"

tests/integration_test.py

@@ -1,34 +1,36 @@
-from slack_sdk import WebClient
-from dotenv import load_dotenv
 from os import environ
+
+from dotenv import load_dotenv
+from slack_sdk import WebClient
+
 from ca_slack_block_kit import (
-    Block,
+    CodeBlock,
     Divider,
+    Emoji,
     Header,
     MarkdownSection,
-    render_blocks,
     MarkdownSectionFields,
-    CodeBlock,
+    render_blocks,
 )
 
 load_dotenv()
 client = WebClient(environ["SLACK_TOKEN"])
 TEST_CNANNEL_ID = "C07AGEKN0CB"
 TEST_MESSAGE_TITLE = "CA Stack Block Kit Integration Test"
-TEST_MARKDOWN_TEXT = """
+TEST_MARKDOWN_TEXT = f"""
 *This is a test markdown section*
 
-- Bullet point 1 :smile:
-- Bullet point 2 :tada:
-- Bullet point 3 :rocket:
+- Bullet point 1 {Emoji.THUMBS_UP}
+- Bullet point 2 {Emoji.HEART}
+- Bullet point 3 {Emoji.ROCKET}
 
 `Inline code`
 """.strip()
 TEST_MARKDOWN_FIELDS = [
-    "*Field 1*: Value 1 :star:",
-    "*Field 2*: Value 2 :heart:",
-    "*Field 3*: Value 3 :fire:",
-    "*Field 4*: Value 4 :thumbsup:",
+    "*Field 1*: Value 1 " + Emoji.STAR,
+    "*Field 2*: Value 2 " + Emoji.HEART,
+    "*Field 3*: Value 3 " + Emoji.CLAP,
+    "*Field 4*: Value 4 " + Emoji.BUG,
 ]
 TEST_CODE_SNIPPET = """
 # This is a code snippet
@@ -37,7 +39,7 @@ def hello_world():
 """.strip()
 
 
-def test_message():
+def test_message() -> None:
     blocks = []
 
     blocks.append(Header(text=TEST_MESSAGE_TITLE))

tests/unit_test.py

@@ -1,7 +1,21 @@
-from ca_slack_block_kit import Divider
+from ca_slack_block_kit import Divider, Emoji
 
 
 def test_divider_render() -> None:
     divider = Divider()
     expected_output = {"type": "divider"}
     assert divider.render() == expected_output
+
+
+def test_emoji_constants() -> None:
+    assert Emoji.THUMBS_UP == ":thumbsup:"
+    assert Emoji.THUMBS_DOWN == ":thumbsdown:"
+    assert Emoji.PARTY_POPPER == ":tada:"
+    assert Emoji.WARNING == ":warning:"
+    assert Emoji.CHECK_MARK == ":white_check_mark:"
+    assert Emoji.CROSS_MARK == ":x:"
+    assert Emoji.INFO == ":information_source:"
+    assert Emoji.ROCKET == ":rocket:"
+    assert Emoji.EYES == ":eyes:"
+    assert Emoji.FIRE == ":fire:"
+    assert Emoji.STAR == ":star:"