acpt: add Hyperlink properties scenarios

scanny · scanny · commit 7868f3edaa7a · 2023-10-01T20:08:33.000-07:00
diff --git a/features/hlk-props.feature b/features/hlk-props.feature
@@ -0,0 +1,39 @@
+Feature: Access hyperlink properties
+  In order to access the URL and other details for a hyperlink
+  As a developer using python-docx
+  I need properties on Hyperlink
+
+
+  @wip
+  Scenario: Hyperlink.address has the URL of the hyperlink
+    Given a hyperlink
+     Then hyperlink.address is the URL of the hyperlink
+
+
+  @wip
+  Scenario Outline: Hyperlink.contains_page_break reports presence of page-break
+    Given a hyperlink having <zero-or-more> rendered page breaks
+     Then hyperlink.contains_page_break is <value>
+
+    Examples: Hyperlink.contains_page_break cases
+      | zero-or-more | value |
+      | no           | False |
+      | one          | True  |
+
+
+  @wip
+  Scenario Outline: Hyperlink.runs contains Run for each run in hyperlink
+    Given a hyperlink having <zero-or-more> runs
+     Then hyperlink.runs has length <value>
+      And hyperlink.runs contains only Run instances
+
+    Examples: Hyperlink.runs cases
+      | zero-or-more | value |
+      | one          |   1   |
+      | two          |   2   |
+
+
+  @wip
+  Scenario: Hyperlink.text has the visible text of the hyperlink
+    Given a hyperlink
+     Then hyperlink.text is the visible text of the hyperlink
diff --git a/features/steps/hyperlink.py b/features/steps/hyperlink.py
@@ -0,0 +1,88 @@
+"""Step implementations for hyperlink-related features."""
+
+from __future__ import annotations
+
+from behave import given, then
+from behave.runner import Context
+
+from docx import Document
+
+from helpers import test_docx
+
+# given ===================================================
+
+
+@given("a hyperlink")
+def given_a_hyperlink(context: Context):
+    document = Document(test_docx("par-hyperlinks"))
+    context.hyperlink = document.paragraphs[1].hyperlinks[0]
+
+
+@given("a hyperlink having {zero_or_more} rendered page breaks")
+def given_a_hyperlink_having_rendered_page_breaks(context: Context, zero_or_more: str):
+    paragraph_idx = {
+        "no": 1,
+        "one": 2,
+    }[zero_or_more]
+    document = Document(test_docx("par-hyperlinks"))
+    paragraph = document.paragraphs[paragraph_idx]
+    context.hyperlink = paragraph.hyperlinks[0]
+
+
+@given("a hyperlink having {one_or_more} runs")
+def given_a_hyperlink_having_one_or_more_runs(context: Context, one_or_more: str):
+    paragraph_idx, hyperlink_idx = {
+        "one": (1, 0),
+        "two": (2, 1),
+    }[one_or_more]
+    document = Document(test_docx("par-hyperlinks"))
+    paragraph = document.paragraphs[paragraph_idx]
+    context.hyperlink = paragraph.hyperlinks[hyperlink_idx]
+
+
+# then =====================================================
+
+
+@then("hyperlink.address is the URL of the hyperlink")
+def then_hyperlink_address_is_the_URL_of_the_hyperlink(context: Context):
+    actual_value = context.hyperlink.address
+    expected_value = "http://yahoo.com/"
+    assert (
+        actual_value == expected_value
+    ), f"expected: {expected_value}, got: {actual_value}"
+
+
+@then("hyperlink.contains_page_break is {value}")
+def then_hyperlink_contains_page_break_is_value(context: Context, value: str):
+    actual_value = context.hyperlink.contains_page_break
+    expected_value = {"True": True, "False": False}[value]
+    assert (
+        actual_value == expected_value
+    ), f"expected: {expected_value}, got: {actual_value}"
+
+
+@then("hyperlink.runs contains only Run instances")
+def then_hyperlink_runs_contains_only_Run_instances(context: Context):
+    actual_value = [type(item).__name__ for item in context.hyperlink.runs]
+    expected_value = ["Run" for _ in context.hyperlink.runs]
+    assert (
+        actual_value == expected_value
+    ), f"expected: {expected_value}, got: {actual_value}"
+
+
+@then("hyperlink.runs has length {value}")
+def then_hyperlink_runs_has_length(context: Context, value: str):
+    actual_value = len(context.hyperlink.runs)
+    expected_value = int(value)
+    assert (
+        actual_value == expected_value
+    ), f"expected: {expected_value}, got: {actual_value}"
+
+
+@then("hyperlink.text is the visible text of the hyperlink")
+def then_hyperlink_text_is_the_visible_text_of_the_hyperlink(context: Context):
+    actual_value = context.hyperlink.text
+    expected_value = "awesome hyperlink"
+    assert (
+        actual_value == expected_value
+    ), f"expected: {expected_value}, got: {actual_value}"
