refactor!: Move kaptan to ConfigReader

Author: tony

docs/about.md

@@ -97,7 +97,6 @@ from JSON and YAML.
   `$ tmuxp -f<config-file>` for config file.
 
 [attempt at 1.7 test]: https://travis-ci.org/tmux-python/tmuxp/jobs/12348263
-[kaptan]: https://github.com/emre/kaptan
 [mit-licensed]: http://opensource.org/licenses/MIT
 [tmuxinator]: https://github.com/aziz/tmuxinator
 [teamocil]: https://github.com/remiprev/teamocil

docs/glossary.md

@@ -13,8 +13,8 @@ tmux(1)
     The tmux binary. Used internally to distinguish tmuxp is only a
     layer on top of tmux.
 
-kaptan
-    configuration management library, see [kaptan on github](https://github.com/emre/kaptan).
+ConfigReader
+    configuration management class.
 
 Server
     Tmux runs in the background of your system as a process.

src/tmuxp/cli/convert.py

@@ -1,7 +1,9 @@
 import os
+import pathlib
 
 import click
-import kaptan
+
+from tmuxp.config_reader import ConfigReader
 
 from .utils import ConfigPath
 
@@ -25,20 +27,18 @@ def command_convert(confirmed, config):
             f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])"
         )
 
-    configparser = kaptan.Kaptan()
-    configparser.import_config(config)
-    newfile = config.replace(ext, ".%s" % to_filetype)
+    configparser = ConfigReader.from_file(pathlib.Path(config))
+    newfile = config.replace(ext, f".{to_filetype}")
 
-    export_kwargs = {"default_flow_style": False} if to_filetype == "yaml" else {}
-    newconfig = configparser.export(to_filetype, indent=2, **export_kwargs)
+    new_config = configparser.dump(format=to_filetype)
 
     if not confirmed:
         if click.confirm(f"convert to <{config}> to {to_filetype}?"):
-            if click.confirm("Save config to %s?" % newfile):
+            if click.confirm(f"Save config to {newfile}?"):
                 confirmed = True
 
     if confirmed:
         buf = open(newfile, "w")
-        buf.write(newconfig)
+        buf.write(new_config)
         buf.close()
-        print("New config saved to <%s>." % newfile)
+        print(f"New config saved to <{newfile}>.")

src/tmuxp/cli/freeze.py

@@ -2,9 +2,9 @@
 import sys
 
 import click
-import kaptan
 
 from libtmux.server import Server
+from tmuxp.config_reader import ConfigReader
 from tmuxp.exc import TmuxpException
 
 from .. import config, util
@@ -71,9 +71,8 @@ def command_freeze(
         return
 
     sconf = freeze(session)
-    configparser = kaptan.Kaptan()
     newconfig = config.inline(sconf)
-    configparser.import_config(newconfig)
+    configparser = ConfigReader(newconfig)
 
     if not quiet:
         print(
@@ -126,11 +125,11 @@ def command_freeze(
             )
 
     if config_format == "yaml":
-        newconfig = configparser.export(
-            "yaml", indent=2, default_flow_style=False, safe=True
+        newconfig = configparser.dump(
+            format="yaml", indent=2, default_flow_style=False, safe=True
         )
     elif config_format == "json":
-        newconfig = configparser.export("json", indent=2)
+        newconfig = configparser.dump(format="json", indent=2)
 
     if yes or click.confirm("Save to %s?" % dest):
         destdir = os.path.dirname(dest)

src/tmuxp/cli/import_config.py

@@ -1,8 +1,10 @@
 import os
+import pathlib
 import sys
 
 import click
-import kaptan
+
+from tmuxp.config_reader import ConfigReader
 
 from .. import config
 from .utils import ConfigPath, _validate_choices, get_abs_path, tmuxp_echo
@@ -58,25 +60,22 @@ def command_import():
 
 
 def import_config(configfile, importfunc):
-    configparser = kaptan.Kaptan(handler="yaml")
-
-    configparser.import_config(configfile)
-    newconfig = importfunc(configparser.get())
-    configparser.import_config(newconfig)
+    existing_config = ConfigReader._from_file(pathlib.Path(configfile))
+    new_config = ConfigReader(importfunc(existing_config))
 
     config_format = click.prompt(
         "Convert to", value_proc=_validate_choices(["yaml", "json"]), default="yaml"
     )
 
     if config_format == "yaml":
-        newconfig = configparser.export("yaml", indent=2, default_flow_style=False)
+        new_config = new_config.dump("yaml", indent=2, default_flow_style=False)
     elif config_format == "json":
-        newconfig = configparser.export("json", indent=2)
+        new_config = new_config.dump("json", indent=2)
     else:
         sys.exit("Unknown config format.")
 
     tmuxp_echo(
-        newconfig + "---------------------------------------------------------------"
+        new_config + "---------------------------------------------------------------"
         "\n"
         "Configuration import does its best to convert files.\n"
     )
@@ -94,7 +93,7 @@ def import_config(configfile, importfunc):
                 dest = dest_path
 
         buf = open(dest, "w")
-        buf.write(newconfig)
+        buf.write(new_config)
         buf.close()
 
         tmuxp_echo("Saved to %s." % dest)
@@ -138,12 +137,11 @@ def command_convert(confirmed, config):
             f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])"
         )
 
-    configparser = kaptan.Kaptan()
-    configparser.import_config(config)
+    configparser = ConfigReader.from_file(config)
     newfile = config.replace(ext, ".%s" % to_filetype)
 
     export_kwargs = {"default_flow_style": False} if to_filetype == "yaml" else {}
-    newconfig = configparser.export(to_filetype, indent=2, **export_kwargs)
+    new_config = configparser.dump(format=to_filetype, indent=2, **export_kwargs)
 
     if not confirmed:
         if click.confirm(f"convert to <{config}> to {to_filetype}?"):
@@ -152,7 +150,7 @@ def command_convert(confirmed, config):
 
     if confirmed:
         buf = open(newfile, "w")
-        buf.write(newconfig)
+        buf.write(new_config)
         buf.close()
         print("New config saved to <%s>." % newfile)
 

src/tmuxp/cli/load.py

@@ -13,10 +13,10 @@
 from typing import List
 
 import click
-import kaptan
 
 from libtmux.common import has_gte_version
 from libtmux.server import Server
+from tmuxp import config_reader
 
 from .. import config, exc, log, util
 from ..workspacebuilder import WorkspaceBuilder
@@ -266,7 +266,7 @@ def load_workspace(
     Notes
     -----
 
-    tmuxp will check and load a configuration file. The file will use kaptan
+    tmuxp will check and load a configuration file. The file will use ConfigReader
     to load a JSON/YAML into a :py:obj:`dict`. Then :func:`config.expand` and
     :func:`config.trickle` will be used to expand any shorthands, template
     variables, or file paths relative to where the config/script is executed
@@ -333,18 +333,18 @@ def load_workspace(
        Accessed April 8th, 2018.
     """
     # get the canonical path, eliminating any symlinks
-    config_file = os.path.realpath(config_file)
+    if isinstance(config_file, str):
+        config_file = pathlib.Path(config_file)
 
     tmuxp_echo(
         click.style("[Loading] ", fg="green")
-        + click.style(config_file, fg="blue", bold=True)
+        + click.style(str(config_file), fg="blue", bold=True)
     )
 
-    # kaptan allows us to open a yaml or json file as a dict
-    sconfig = kaptan.Kaptan()
-    sconfig = sconfig.import_config(config_file).get()
+    # ConfigReader allows us to open a yaml or json file as a dict
+    raw_config = config_reader.ConfigReader._from_file(config_file)
     # shapes configurations relative to config / profile file location
-    sconfig = config.expand(sconfig, os.path.dirname(config_file))
+    sconfig = config.expand(raw_config, cwd=os.path.dirname(config_file))
     # Overwrite session name
     if new_session_name:
         sconfig["session_name"] = new_session_name

src/tmuxp/config.py

@@ -225,7 +225,7 @@ def expand(session_config, cwd=None, parent=None):
 
         'shell_command': 'htop'
 
-    Kaptan will load JSON/YAML files into python dicts for you.
+    ConfigReader will load JSON/YAML files into python dicts for you.
 
     Parameters
     ----------