test: Move inline to freezer

Author: tony

docs/api.md

@@ -131,7 +131,7 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.workspace.config.inline
+.. automethod:: tmuxp.workspace.freezer.inline
 ```
 
 ## Exceptions

src/tmuxp/cli/freeze.py

@@ -9,8 +9,7 @@
 from tmuxp.exc import TmuxpException
 
 from .. import util
-from ..workspace import config
-from ..workspace.freezer import freeze
+from ..workspace import freezer
 from .utils import get_config_dir, prompt, prompt_choices, prompt_yes_no
 
 if t.TYPE_CHECKING:
@@ -110,8 +109,8 @@ def command_freeze(
         print(e)
         return
 
-    sconf = freeze(session)
-    newconfig = config.inline(sconf)
+    sconf = freezer.freeze(session)
+    newconfig = freezer.inline(sconf)
     configparser = ConfigReader(newconfig)
 
     if not args.quiet:

src/tmuxp/workspace/config.py

@@ -133,49 +133,6 @@ def expandshell(_path):
     return os.path.expandvars(os.path.expanduser(_path))
 
 
-def inline(workspace_dict):
-    """
-    Return config in inline form, opposite of :meth:`config.expand`.
-
-    Parameters
-    ----------
-    workspace_dict : dict
-
-    Returns
-    -------
-    dict
-        configuration with optional inlined configs.
-    """
-
-    if (
-        "shell_command" in workspace_dict
-        and isinstance(workspace_dict["shell_command"], list)
-        and len(workspace_dict["shell_command"]) == 1
-    ):
-        workspace_dict["shell_command"] = workspace_dict["shell_command"][0]
-
-        if len(workspace_dict.keys()) == int(1):
-            workspace_dict = workspace_dict["shell_command"]
-    if (
-        "shell_command_before" in workspace_dict
-        and isinstance(workspace_dict["shell_command_before"], list)
-        and len(workspace_dict["shell_command_before"]) == 1
-    ):
-        workspace_dict["shell_command_before"] = workspace_dict["shell_command_before"][
-            0
-        ]
-
-    # recurse into window and pane config items
-    if "windows" in workspace_dict:
-        workspace_dict["windows"] = [
-            inline(window) for window in workspace_dict["windows"]
-        ]
-    if "panes" in workspace_dict:
-        workspace_dict["panes"] = [inline(pane) for pane in workspace_dict["panes"]]
-
-    return workspace_dict
-
-
 def expand_cmd(p: Dict) -> Dict:
     if isinstance(p, str):
         p = {"shell_command": [p]}

src/tmuxp/workspace/freezer.py

@@ -1,3 +1,46 @@
+def inline(workspace_dict):
+    """
+    Return config in inline form, opposite of :meth:`config.expand`.
+
+    Parameters
+    ----------
+    workspace_dict : dict
+
+    Returns
+    -------
+    dict
+        configuration with optional inlined configs.
+    """
+
+    if (
+        "shell_command" in workspace_dict
+        and isinstance(workspace_dict["shell_command"], list)
+        and len(workspace_dict["shell_command"]) == 1
+    ):
+        workspace_dict["shell_command"] = workspace_dict["shell_command"][0]
+
+        if len(workspace_dict.keys()) == int(1):
+            workspace_dict = workspace_dict["shell_command"]
+    if (
+        "shell_command_before" in workspace_dict
+        and isinstance(workspace_dict["shell_command_before"], list)
+        and len(workspace_dict["shell_command_before"]) == 1
+    ):
+        workspace_dict["shell_command_before"] = workspace_dict["shell_command_before"][
+            0
+        ]
+
+    # recurse into window and pane config items
+    if "windows" in workspace_dict:
+        workspace_dict["windows"] = [
+            inline(window) for window in workspace_dict["windows"]
+        ]
+    if "panes" in workspace_dict:
+        workspace_dict["panes"] = [inline(pane) for pane in workspace_dict["panes"]]
+
+    return workspace_dict
+
+
 def freeze(session):
     """
     Freeze live tmux session and Return session config :py:obj:`dict`.

tests/workspace/conftest.py

@@ -0,0 +1,23 @@
+import types
+
+import pytest
+
+from ..fixtures.structures import WorkspaceTestData
+
+
+@pytest.fixture
+def config_fixture():
+    """Deferred import of tmuxp.tests.fixtures.*
+
+    pytest setup (conftest.py) patches os.environ["HOME"], delay execution of
+    os.path.expanduser until here.
+    """
+    from ..fixtures import workspace as test_workspace_data
+
+    return WorkspaceTestData(
+        **{
+            k: v
+            for k, v in test_workspace_data.__dict__.items()
+            if isinstance(v, types.ModuleType)
+        }
+    )

tests/workspace/test_config.py

@@ -1,7 +1,6 @@
 """Test for tmuxp configuration import, inlining, expanding and export."""
 import os
 import pathlib
-import types
 import typing
 from typing import Union
 
@@ -17,25 +16,6 @@
     from ..fixtures.structures import WorkspaceTestData
 
 
-@pytest.fixture
-def config_fixture():
-    """Deferred import of tmuxp.tests.fixtures.*
-
-    pytest setup (conftest.py) patches os.environ["HOME"], delay execution of
-    os.path.expanduser until here.
-    """
-    from ..fixtures import workspace as test_workspace_data
-    from ..fixtures.structures import WorkspaceTestData
-
-    return WorkspaceTestData(
-        **{
-            k: v
-            for k, v in test_workspace_data.__dict__.items()
-            if isinstance(v, types.ModuleType)
-        }
-    )
-
-
 def load_yaml(path: Union[str, pathlib.Path]) -> str:
     return ConfigReader._from_file(
         pathlib.Path(path) if isinstance(path, str) else path
@@ -61,22 +41,6 @@ def test_export_json(tmp_path: pathlib.Path, config_fixture: "WorkspaceTestData"
     assert config_fixture.sample_workspace.sample_workspace_dict == new_workspace_data
 
 
-def test_export_yaml(tmp_path: pathlib.Path, config_fixture: "WorkspaceTestData"):
-    yaml_workspace_file = tmp_path / "config.yaml"
-
-    sample_workspace = config.inline(
-        config_fixture.sample_workspace.sample_workspace_dict
-    )
-    configparser = ConfigReader(sample_workspace)
-
-    yaml_workspace_data = configparser.dump("yaml", indent=2, default_flow_style=False)
-
-    yaml_workspace_file.write_text(yaml_workspace_data, encoding="utf-8")
-
-    new_workspace_data = load_workspace(str(yaml_workspace_file))
-    assert config_fixture.sample_workspace.sample_workspace_dict == new_workspace_data
-
-
 def test_scan_workspace(tmp_path: pathlib.Path):
     configs = []
 
@@ -123,49 +87,6 @@ def test_workspace_expand2(config_fixture: "WorkspaceTestData"):
     assert config.expand(unexpanded_dict) == expanded_dict
 
 
-"""Tests for :meth:`config.inline()`."""
-
-ibefore_workspace = {  # inline config
-    "session_name": "sample workspace",
-    "start_directory": "~",
-    "windows": [
-        {
-            "shell_command": ["top"],
-            "window_name": "editor",
-            "panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
-            "layout": "main-verticle",
-        },
-        {
-            "window_name": "logging",
-            "panes": [{"shell_command": ["tail -F /var/log/syslog"]}],
-        },
-        {"options": {"automatic-rename": True}, "panes": [{"shell_command": ["htop"]}]},
-    ],
-}
-
-iafter_workspace = {
-    "session_name": "sample workspace",
-    "start_directory": "~",
-    "windows": [
-        {
-            "shell_command": "top",
-            "window_name": "editor",
-            "panes": ["vim", 'cowsay "hey"'],
-            "layout": "main-verticle",
-        },
-        {"window_name": "logging", "panes": ["tail -F /var/log/syslog"]},
-        {"options": {"automatic-rename": True}, "panes": ["htop"]},
-    ],
-}
-
-
-def test_inline_workspace():
-    """:meth:`config.inline()` shell commands list to string."""
-
-    test_workspace = config.inline(ibefore_workspace)
-    assert test_workspace == iafter_workspace
-
-
 """Test config inheritance for the nested 'start_command'."""
 
 inheritance_workspace_before = {

tests/workspace/test_freezer.py

@@ -1,13 +1,17 @@
 """Tests for freezing tmux sessions with tmuxp."""
+import pathlib
 import time
+import typing
 
 from tmuxp.config_reader import ConfigReader
-from tmuxp.workspace import config
+from tmuxp.workspace import config, freezer
 from tmuxp.workspace.builder import WorkspaceBuilder
-from tmuxp.workspace.freezer import freeze
 
 from ..fixtures import utils as test_utils
 
+if typing.TYPE_CHECKING:
+    from ..fixtures.structures import WorkspaceTestData
+
 
 def test_freeze_config(session):
     session_config = ConfigReader._from_file(
@@ -21,7 +25,7 @@ def test_freeze_config(session):
     time.sleep(0.50)
 
     session = session
-    new_config = freeze(session)
+    new_config = freezer.freeze(session)
 
     config.validate_schema(new_config)
 
@@ -30,7 +34,66 @@ def test_freeze_config(session):
     ConfigReader._dump(format="yaml", content=new_config)
 
     # Inline configs should also dump without an error
-    compact_config = config.inline(new_config)
+    compact_config = freezer.inline(new_config)
 
     ConfigReader._dump(format="json", content=compact_config)
     ConfigReader._dump(format="yaml", content=compact_config)
+
+
+"""Tests for :meth:`freezer.inline()`."""
+
+ibefore_workspace = {  # inline config
+    "session_name": "sample workspace",
+    "start_directory": "~",
+    "windows": [
+        {
+            "shell_command": ["top"],
+            "window_name": "editor",
+            "panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
+            "layout": "main-verticle",
+        },
+        {
+            "window_name": "logging",
+            "panes": [{"shell_command": ["tail -F /var/log/syslog"]}],
+        },
+        {"options": {"automatic-rename": True}, "panes": [{"shell_command": ["htop"]}]},
+    ],
+}
+
+iafter_workspace = {
+    "session_name": "sample workspace",
+    "start_directory": "~",
+    "windows": [
+        {
+            "shell_command": "top",
+            "window_name": "editor",
+            "panes": ["vim", 'cowsay "hey"'],
+            "layout": "main-verticle",
+        },
+        {"window_name": "logging", "panes": ["tail -F /var/log/syslog"]},
+        {"options": {"automatic-rename": True}, "panes": ["htop"]},
+    ],
+}
+
+
+def test_inline_workspace():
+    """:meth:`freezer.inline()` shell commands list to string."""
+
+    test_workspace = freezer.inline(ibefore_workspace)
+    assert test_workspace == iafter_workspace
+
+
+def test_export_yaml(tmp_path: pathlib.Path, config_fixture: "WorkspaceTestData"):
+    yaml_workspace_file = tmp_path / "config.yaml"
+
+    sample_workspace = freezer.inline(
+        config_fixture.sample_workspace.sample_workspace_dict
+    )
+    configparser = ConfigReader(sample_workspace)
+
+    yaml_workspace_data = configparser.dump("yaml", indent=2, default_flow_style=False)
+
+    yaml_workspace_file.write_text(yaml_workspace_data, encoding="utf-8")
+
+    new_workspace_data = ConfigReader._from_file(yaml_workspace_file)
+    assert config_fixture.sample_workspace.sample_workspace_dict == new_workspace_data