add several aliases for Actions and Questions.

ScreenPyHQ · May 15, 2024 · 443fb20 · 443fb20
1 parent be1b50f
commit 443fb20
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 3 deletions.
diff --git a/docs/extended_api/actions.rst b/docs/extended_api/actions.rst
@@ -11,6 +11,9 @@ see ScreenPy's :external+screenpy:ref:`actions api` reference.
 Click
 -----
 
+**Aliases:**
+``Clicks``
+
 .. autoclass:: Click
     :members:
     :exclude-members: on
@@ -19,6 +22,9 @@ Click
 Enter
 -----
 
+**Aliases:**
+``Enters``
+
 .. autoclass:: Enter
     :members:
     :exclude-members: into, the_password
@@ -27,7 +33,12 @@ Enter
 Open
 ----
 
-**Aliases:** ``Visit``
+**Aliases:**
+``GoTo``,
+``GoesTo``,
+``Opens``,
+``Visit``
+``Visits``,
 
 .. autoclass:: Open
     :members:
@@ -36,13 +47,23 @@ Open
 RefreshThePage
 --------------
 
+**Aliases:**
+``RefreshesThePage``,
+``Refresh``,
+``Refreshes``
+
 .. autoclass:: RefreshThePage
     :members:
 
 
 SaveScreenshot
 --------------
 
+**Aliases:**
+``SavesScreenshot``,
+``SaveAScreenshot``,
+``SavesAScreenshot``,
+
 .. autoclass:: SaveScreenshot
     :members:
     :exclude-members: and_attach_it_with
@@ -51,6 +72,9 @@ SaveScreenshot
 Scroll
 ------
 
+**Aliases:**
+``Scrolls``
+
 .. autoclass:: Scroll
     :members:
     :exclude-members: direction_to_log
@@ -59,6 +83,9 @@ Scroll
 Select
 ------
 
+**Aliases:**
+``Selects``
+
 .. autoclass:: Select
     :members:
     :exclude-members: the_options, from_
diff --git a/docs/extended_api/questions.rst b/docs/extended_api/questions.rst
@@ -6,36 +6,52 @@ These are the Questions added in ScreenPy Playwright.
 
 .. module:: screenpy_playwright.questions
 
+
 Attribute
 ---------
 
+**Aliases:**
+``TheAttribute``
+
 .. autoclass:: Attribute
     :members:
 
 
 BrowserURL
 ----------
 
+**Aliases:**
+``TheBrowserURL``
+
 .. autoclass:: BrowserURL
     :members:
 
 
 Element
 -------
 
+**Aliases:**
+``TheElement``
+
 .. autoclass:: Element
     :members:
 
 
 Number
 ------
 
+**Aliases:**
+``TheNumber``
+
 .. autoclass:: Number
     :members:
 
 
 Text
 ----
 
+**Aliases:**
+``TheText``
+
 .. autoclass:: Text
     :members:
diff --git a/screenpy_playwright/actions/__init__.py b/screenpy_playwright/actions/__init__.py
@@ -8,17 +8,35 @@
 from .scroll import Scroll
 from .select import Select
 
-# Natural-language-enabling syntactic sugar
-Visit = Open
+# Natural-language-enabling aliases
+Clicks = Click
+Enters = Enter
+GoTo = GoesTo = Visit = Visits = Opens = Open
+Refresh = Refreshes = RefreshesThePage = RefreshThePage
+SavesScreenshot = SavesAScreenshot = SaveAScreenshot = SaveScreenshot
+Scrolls = Scroll
+Selects = Select
 
 
 __all__ = [
     "Click",
+    "Clicks",
     "Enter",
+    "Enters",
+    "GoTo",
+    "GoesTo",
     "Open",
+    "Opens",
     "RefreshThePage",
+    "RefreshesThePage",
     "SaveScreenshot",
+    "SaveAScreenshot",
+    "SavesScreenshot",
+    "SavesAScreenshot",
     "Scroll",
+    "Scrolls",
     "Select",
+    "Selects",
     "Visit",
+    "Visits",
 ]
diff --git a/screenpy_playwright/questions/__init__.py b/screenpy_playwright/questions/__init__.py
@@ -6,10 +6,22 @@
 from .number import Number
 from .text import Text
 
+# Natural-language-enabling aliases
+TheAttribute = Attribute
+TheBrowserURL = BrowserURL
+TheElement = Element
+TheNumber = Number
+TheText = Text
+
 __all__ = [
     "Attribute",
     "BrowserURL",
     "Element",
     "Number",
     "Text",
+    "TheAttribute",
+    "TheBrowserURL",
+    "TheElement",
+    "TheNumber",
+    "TheText",
 ]
diff --git a/tests/test_namespace.py b/tests/test_namespace.py
@@ -7,22 +7,39 @@ def test_screenpy_playwright() -> None:
         "BrowserURL",
         "BrowseTheWebSynchronously",
         "Click",
+        "Clicks",
         "Element",
         "Enter",
+        "Enters",
+        "GoesTo",
+        "GoTo",
         "IsVisible",
         "NoPageError",
         "Number",
         "Open",
+        "Opens",
         "PageObject",
+        "RefreshesThePage",
         "RefreshThePage",
+        "SaveAScreenshot",
+        "SavesAScreenshot",
         "SaveScreenshot",
+        "SavesScreenshot",
         "Scroll",
+        "Scrolls",
         "Select",
+        "Selects",
         "Target",
         "TargetingError",
         "Text",
+        "TheAttribute",
+        "TheBrowserURL",
+        "TheElement",
+        "TheNumber",
+        "TheText",
         "Visible",
         "Visit",
+        "Visits",
     ]
     assert sorted(screenpy_playwright.__all__) == sorted(expected)
 
@@ -37,13 +54,25 @@ def test_abilities() -> None:
 def test_actions() -> None:
     expected = [
         "Click",
+        "Clicks",
         "Enter",
+        "Enters",
+        "GoTo",
+        "GoesTo",
         "Open",
+        "Opens",
         "RefreshThePage",
+        "RefreshesThePage",
         "SaveScreenshot",
+        "SaveAScreenshot",
+        "SavesScreenshot",
+        "SavesAScreenshot",
         "Scroll",
+        "Scrolls",
         "Select",
+        "Selects",
         "Visit",
+        "Visits",
     ]
     assert sorted(screenpy_playwright.actions.__all__) == sorted(expected)
 
@@ -55,6 +84,11 @@ def test_questions() -> None:
         "Element",
         "Number",
         "Text",
+        "TheAttribute",
+        "TheBrowserURL",
+        "TheElement",
+        "TheNumber",
+        "TheText",
     ]
     assert sorted(screenpy_playwright.questions.__all__) == sorted(expected)