♻️ Massive refactor / organization (#840)

References to "config" are now "workspace"

Organize files:

- `cli/utils.py` functions moved to `workspace/finders.py`
- `config.py` split between:
  - `workspace/finders.py`
  - `workspace/freezer.py`
  - `workspace/importers.py`
  - `workspace/validation.py`

- `workspacebuilder.py` split into:
  - `workspace/builder.py`
  - `workspace/freezer.py`
  
    `config.inline` moved to freezer

Tests:
- `tests/fixtures/{workspacebuilder,workspacefreezer}` -> `tests/fixtures/workspace/{builder,freezer}`
- `tests/test_import_{teamocil,tmuxinator}.py` -> `tests/workspace/test_import_{teamocil,tmuxinator}.py`

Author: tony

CHANGES

@@ -21,6 +21,34 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
+### Internal refactoring (#840)
+
+#### Rename config to workspace
+
+Reference to "config" are now "workspace"
+
+#### Organize files
+
+- `cli/utils.py` functions moved to `workspace/finders.py`
+- `config.py` split between:
+
+  - `workspace/finders.py`
+  - `workspace/freezer.py`
+  - `workspace/importers.py`
+  - `workspace/validation.py`
+
+- `workspacebuilder.py` split into:
+
+  - `workspace/builder.py`
+  - `workspace/freezer.py`
+
+    `config.inline` moved to freezer
+
+#### Tests
+
+- `tests/fixtures/{workspacebuilder,workspacefreezer}` -> `tests/fixtures/workspace/{builder,freezer}`
+- `tests/test_import_{teamocil,tmuxinator}.py` -> `tests/workspace/test_import_{teamocil,tmuxinator}.py`
+
 ## tmuxp 1.17.3 (2022-10-30)
 
 **Maintenance release, no features or fixes**

conftest.py

@@ -15,7 +15,7 @@
 
 from libtmux.test import namer
 from tests.fixtures import utils as test_utils
-from tmuxp.cli.utils import get_config_dir
+from tmuxp.workspace.finders import get_workspace_dir
 
 if t.TYPE_CHECKING:
     from libtmux.session import Session
@@ -56,7 +56,7 @@ def tmuxp_configdir_default(
     monkeypatch: pytest.MonkeyPatch, tmuxp_configdir: pathlib.Path
 ) -> None:
     monkeypatch.setenv("TMUXP_CONFIGDIR", str(tmuxp_configdir))
-    assert get_config_dir() == str(tmuxp_configdir)
+    assert get_workspace_dir() == str(tmuxp_configdir)
 
 
 @pytest.fixture(scope="function")

docs/about.md

@@ -94,7 +94,7 @@ from JSON and YAML.
 - `$ tmuxp -2`, `$ tmuxp -8` for forcing term colors a la
   {term}`tmux(1)`.
 - `$ tmuxp -L<socket-name>`, `$ tmuxp -S<socket-path>` for sockets and
-  `$ tmuxp -f<config-file>` for config file.
+  `$ tmuxp -f <workspace-file>` for config file.
 
 [attempt at 1.7 test]: https://travis-ci.org/tmux-python/tmuxp/jobs/12348263
 [mit-licensed]: http://opensource.org/licenses/MIT

docs/api.md

@@ -45,10 +45,6 @@ If you need an internal API stabilized please [file an issue](https://github.com
 
 ## CLI
 
-```{eval-rst}
-.. automethod:: tmuxp.cli.utils.get_config_dir
-```
-
 ```{eval-rst}
 .. automethod:: tmuxp.cli.import_config.get_teamocil_dir
 ```
@@ -65,50 +61,54 @@ If you need an internal API stabilized please [file an issue](https://github.com
 .. automethod:: tmuxp.cli.load._reattach
 ```
 
-## Configuration
+## Workspace files
 
 ### Finding
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.is_config_file
+.. automethod:: tmuxp.workspace.finders.is_workspace_file
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.in_dir
+.. automethod:: tmuxp.workspace.finders.in_dir
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.in_cwd
+.. automethod:: tmuxp.workspace.finders.in_cwd
 ```
 
-### Import and export
-
 ```{eval-rst}
-.. automethod:: tmuxp.config.validate_schema
+.. automethod:: tmuxp.workspace.finders.get_workspace_dir
 ```
 
+### Validation
+
 ```{eval-rst}
-.. automethod:: tmuxp.config.expandshell
+.. autofunction:: tmuxp.workspace.validation.validate_schema
 ```
 
+### Processing
+
 ```{eval-rst}
-.. automethod:: tmuxp.config.expand
+.. automethod:: tmuxp.workspace.loader.expandshell
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.inline
+.. automethod:: tmuxp.workspace.loader.expand
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.trickle
+.. automethod:: tmuxp.workspace.loader.trickle
 ```
 
+## Workspace importers
+
 ```{eval-rst}
-.. automethod:: tmuxp.config.import_teamocil
+.. automethod:: tmuxp.workspace.importers.import_teamocil
 ```
 
 ```{eval-rst}
-.. automethod:: tmuxp.config.import_tmuxinator
+.. automethod:: tmuxp.workspace.importers.import_tmuxinator
 ```
 
 ## Configuration reader
@@ -120,22 +120,28 @@ If you need an internal API stabilized please [file an issue](https://github.com
 ## Workspace Builder
 
 ```{eval-rst}
-.. autoclass:: tmuxp.workspacebuilder.WorkspaceBuilder
+.. autoclass:: tmuxp.workspace.builder.WorkspaceBuilder
    :members:
 ```
 
+## Workspace Freezer
+
+```{eval-rst}
+.. automethod:: tmuxp.workspace.freezer.freeze
+```
+
 ```{eval-rst}
-.. automethod:: tmuxp.workspacebuilder.freeze
+.. automethod:: tmuxp.workspace.freezer.inline
 ```
 
 ## Exceptions
 
 ```{eval-rst}
-.. autoexception:: tmuxp.exc.EmptyConfigException
+.. autoexception:: tmuxp.exc.EmptyWorkspaceException
 ```
 
 ```{eval-rst}
-.. autoexception:: tmuxp.exc.ConfigError
+.. autoexception:: tmuxp.exc.WorkspaceError
 ```
 
 ```{eval-rst}

docs/cli/freeze.md

@@ -34,4 +34,4 @@ Tmuxp will offer to save your session state to `.json` or `.yaml`.
 
 If no session is specified, it will default to the attached session.
 
-If the `--force` argument is passed, it will overwrite any existing config file with the same name.
+If the `--force` argument is passed, it will overwrite any existing workspace file with the same name.

docs/cli/load.md

@@ -84,9 +84,9 @@ $ tmuxp load [filename]
 
 ## Inside sessions
 
-If you try to load a config file from within a tmux session, it will ask you
+If you try to load a workspace file from within a tmux session, it will ask you
 if you want to load and attach to the new session, or just load detached.
-You can also load a config file and append the windows to the current active session.
+You can also load a workspace file and append the windows to the current active session.
 
 ```
 Already inside TMUX, switch to session? yes/no

docs/configuration/examples.md

@@ -699,7 +699,7 @@ Edit this page.
 - <https://github.com/tony/sphinxcontrib-github/blob/master/.tmuxp.yaml>
 
 You can use `start_directory: ./` to make the directories relative to
-the config file / project root.
+the workspace file / project root.
 
 ## Bonus: pipenv auto-bootstrapping
 
@@ -761,8 +761,8 @@ windows:
 
 tmuxp sessions can be scripted in python. The first way is to use the
 ORM in the {ref}`API`. The second is to pass a {py:obj}`dict` into
-{class}`~tmuxp.workspacebuilder.WorkspaceBuilder` with a correct schema.
-See: {meth}`tmuxp.config.validate_schema`.
+{class}`~tmuxp.workspace.builder.WorkspaceBuilder` with a correct schema.
+See: {meth}`tmuxp.validation.validate_schema`.
 
 :::
 

docs/configuration/index.md

@@ -4,7 +4,7 @@
 
 # Configuration
 
-tmuxp loads your terminal workspace into tmux using config files.
+tmuxp loads your terminal workspace into tmux using workspace files.
 
 The configuration file can be JSON or YAML. It's declarative style resembles tmux's object hierarchy: session, window and wanes.
 
@@ -24,7 +24,7 @@ tmuxp will offers to assist when:
 - _When inside a tmux client_, `tmuxp` will let you create a new session and switch to it, or append the windows to your existing
   session.
 
-## What's in a config file?
+## What's in a workspace file?
 
 1. A session name
 2. A list of _windows_
@@ -98,14 +98,14 @@ Breaking down the basic configuration into sections:
              # command options
    ```
 
-## Where do I store config files?
+## Where do I store workspace files?
 
 ### Direct
 
 You can create a configuration and load it from anywhere in your file system.
 
 ```console
-$ tmuxp load [config_file]
+$ tmuxp load [workspace-file]
 ```
 
 ````{tab} Relative

docs/configuration/top-level.md

@@ -12,7 +12,7 @@ Used for:
 
 Notes:
 
-- Session names may differ from config filename.
+- Session names may differ from workspace filename.
 
   e.g. _apple.yaml_:
 

docs/developing.md

@@ -159,19 +159,19 @@ $ env PYTEST_ADDOPTS="-verbose" make start
 Pick a file:
 
 ```console
-$ env PYTEST_ADDOPTS="tests/test_workspacebuilder.py" poetry run make start
+$ env PYTEST_ADDOPTS="tests/workspace/test_builder.py" poetry run make start
 ```
 
-Drop into `test_automatic_rename_option()` in `tests/test_workspacebuilder.py`:
+Drop into `test_automatic_rename_option()` in `tests/workspace/test_builder.py`:
 
 ```console
-$ env PYTEST_ADDOPTS="-s -x -vv tests/test_workspacebuilder.py" poetry run make start
+$ env PYTEST_ADDOPTS="-s -x -vv tests/workspace/test_builder.py" poetry run make start
 ```
 
-Drop into `test_automatic_rename_option()` in `tests/test_workspacebuilder.py` and stop on first error:
+Drop into `test_automatic_rename_option()` in `tests/workspace/test_builder.py` and stop on first error:
 
 ```console
-$ env PYTEST_ADDOPTS="-s -x -vv tests/test_workspacebuilder.py::test_automatic_rename_option" poetry run make start
+$ env PYTEST_ADDOPTS="-s -x -vv tests/workspace/test_builder.py::test_automatic_rename_option" poetry run make start
 ```
 
 Drop into `pdb` on first error:
@@ -237,7 +237,7 @@ Create two terminals:
   version of tmuxp above. Then:
 
   ```console
-  $ py.test tests/test_workspacebuilder.py
+  $ py.test tests/workspace/test_builder.py
   ```
 
 Terminal 1 should have flickered and built the session before your eyes.