proj-flow 0.10.0__tar.gz → 0.11.1__tar.gz

{proj_flow-0.10.0 → proj_flow-0.11.1}/CHANGELOG.rst

@@ -4,6 +4,27 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.11.1 <https://github.com/mzdun/proj-flow/compare/v0.11.0...v0.11.1>`_ (2025-02-19)
+=====================================================================================
+
+Bug Fixes
+---------
+
+- bring back base ext (git initial commit) (`3f97d0a <https://github.com/mzdun/proj-flow/commit/3f97d0a6407b26728f4e99bf8985600e8d41acae>`_)
+
+`0.11.0 <https://github.com/mzdun/proj-flow/compare/v0.10.0...v0.11.0>`_ (2025-02-09)
+=====================================================================================
+
+New Features
+------------
+
+- read config in user directory (`8721d90 <https://github.com/mzdun/proj-flow/commit/8721d90ee9be579f544baadfa466f6d1621366e6>`_)
+
+Bug Fixes
+---------
+
+- bring back cmake and conan initailisation (`8148f52 <https://github.com/mzdun/proj-flow/commit/8148f52e6d3fda66349f552dfb02f524a81ee33c>`_)
+
 `0.10.0 <https://github.com/mzdun/proj-flow/compare/v0.9.4...v0.10.0>`_ (2025-02-09)
 ====================================================================================
 

{proj_flow-0.10.0 → proj_flow-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.10.0
+Version: 0.11.1
 Summary: C++ project maintenance, automated
 Project-URL: Changelog, https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/__init__.py

@@ -6,4 +6,4 @@ The **proj_flow** contains only ``__version__`` to be updated, nothing more.
 This is in an attempt to make this module easy to load initially.
 """
 
-__version__ = "0.10.0"
+__version__ = "0.11.1"

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/api/env.py

@@ -23,6 +23,7 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import Any, Callable, Dict, List, Optional, Union, cast
 
+from proj_flow.api import ctx
 from proj_flow.base import plugins, uname
 
 platform = uname.uname()[0]
@@ -115,6 +116,59 @@ class RunAlias:
         return RunAlias(name, doc, steps)
 
 
+def _merge_dicts(dst: dict, src: dict):
+    for key in src:
+        if key not in dst:
+            dst[key] = src[key]
+            continue
+
+        src_val = src[key]
+        dst_val = dst[key]
+
+        if isinstance(src_val, dict):
+            if isinstance(dst_val, dict):
+                _merge_dicts(dst_val, src_val)
+                continue
+
+        dst[key] = src_val
+
+
+def _flatten_dict(dst: ctx.SettingsType, defaults: Dict[str, Any], prefix=""):
+    for key, val in defaults.items():
+        this_key = f"{prefix}{key}"
+
+        if isinstance(val, dict):
+            _flatten_dict(dst, val, f"{this_key}.")
+            continue
+
+        if val is None:
+            dst[this_key] = ""
+            continue
+
+        if isinstance(val, bool):
+            dst[this_key] = val
+            continue
+
+        dst[this_key] = str(val)
+
+
+def _merge(cfg: dict, defaults: ctx.SettingsType, path: str):
+    config = plugins.load_data(path)
+    if not isinstance(config, dict):
+        return
+
+    stored_defaults = config.get("defaults", {})
+    try:
+        del config["defaults"]
+    except KeyError:
+        pass
+
+    _merge_dicts(cfg, config)
+
+    if isinstance(stored_defaults, dict):
+        _flatten_dict(defaults, stored_defaults)
+
+
 class FlowConfig:
     _cfg: dict
     steps: list = []
@@ -129,9 +183,18 @@ class FlowConfig:
             self.root = cfg.root
         else:
             self.root = os.path.abspath(root)
-            self._cfg = plugins.load_data(
-                os.path.join(self.root, ".flow", "config.json")
+            defaults: ctx.SettingsType = {}
+            dest: dict = {}
+
+            _merge(
+                dest,
+                defaults,
+                os.path.join(os.path.expanduser("~"), ".config", "proj-flow.json"),
             )
+            _merge(dest, defaults, os.path.join(self.root, ".flow", "config.json"))
+
+            self._cfg = dest
+            self._cfg["defaults"] = defaults
 
             self._propagate_compilers()
             self._load_extensions()

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/api/init.py

@@ -11,6 +11,9 @@ from proj_flow.api.env import Runtime
 
 
 class InitStep:
+    def priority(self):
+        return 100
+
     def platform_dependencies(self) -> List[str]:
         return []
 

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/base/registry.py

@@ -99,6 +99,14 @@ class Registry(typing.Generic[T]):
 _debug_copies: typing.List[Registry] = []
 
 
+def quoted(s: str) -> str:
+    if '"' in s:
+        return "'{}'".format(s.replace("\\", r"\\").replace("'", r"\'"))
+    if "'" in s or " " in s:
+        return '"{}"'.format(s)
+    return s
+
+
 def verbose_info():
     for registry in _debug_copies:
         for item in registry.container:
@@ -107,12 +115,12 @@ def verbose_info():
             kw = OrderedDict()
 
             if hasattr(item, "name"):
-                kw["name"] = getattr(item, "name")
+                kw["name"] = quoted(getattr(item, "name"))
             elif hasattr(item, "__name__"):
-                kw["name"] = getattr(item, "__name__")
+                kw["name"] = quoted(getattr(item, "__name__"))
 
             if hasattr(item, "id"):
-                kw["id"] = getattr(item, "id")
+                kw["id"] = quoted(getattr(item, "id"))
 
             items = ", ".join([f"{key}={value}" for key, value in kw.items()])
             if len(items) > 0:

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/ext/cplusplus/cmake/__init__.py

@@ -7,6 +7,6 @@ The **proj_flow.ext.cplusplus.cmake** provides ``"CMake"``, ``"Build"``,
 context.
 """
 
-from . import context, parser, steps, version
+from . import parser, steps, version
 
-__all__ = ["context", "parser", "steps", "version"]
+__all__ = ["parser", "steps", "version"]

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/ext/cplusplus/cmake/steps.py

@@ -11,8 +11,7 @@ from typing import Dict, List, cast
 
 from proj_flow import api
 from proj_flow.api import env, step
-
-from .__version__ import CMAKE_VERSION
+from proj_flow.base.__cmake_version__ import CMAKE_VERSION
 
 
 class CMakeBase(api.step.Step):

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/ext/cplusplus/conan/__init__.py

@@ -63,8 +63,3 @@ class ConanConfig:
         if not rt.dry_run and os.path.exists("CMakeUserPresets.json"):
             os.remove("CMakeUserPresets.json")
         return 0
-
-
-cplusplus.project.register_switch(
-    "with_conan", "Use Conan for dependency manager", True
-)

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/minimal/__init__.py

@@ -6,6 +6,6 @@ The **proj_flow.minimal** defines minimal extension package: ``bootstrap``
 and ``run`` commands, with basic set of steps.
 """
 
-from . import bootstrap, init, list, run, system
+from . import base, bootstrap, init, list, run, system
 
-__all__ = ["bootstrap", "init", "list", "run", "system"]
+__all__ = ["base", "bootstrap", "init", "list", "run", "system"]

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/minimal/base.py

@@ -6,10 +6,15 @@ The **proj_flow.minimal.base** provides basic initialization setup for all
 new projects.
 """
 
+import sys
+
 from proj_flow import __version__, api
 
 
 class GitInit(api.init.InitStep):
+    def priority(self):
+        return sys.maxsize
+
     def platform_dependencies(self):
         return ["git"]
 

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/minimal/init.py

@@ -79,7 +79,7 @@ def main(
                 print(f"proj-flow: {error}", file=sys.stderr)
         return 1
 
-    context = current_project.get_context(not non_interactive)
+    context = current_project.get_context(not non_interactive, rt)
     if not non_interactive and not rt.silent:
         print()
 
@@ -104,5 +104,8 @@ def main(
         with open(".gitignore", "ab") as ignoref:
             ignoref.write("\n/.context.yaml\n".encode("UTF-8"))
 
-    for step in init.__steps:
+    current_project.append_extensions(context)
+
+    steps = sorted((step.priority(), i, step) for i, step in enumerate(init.__steps))
+    for _, _, step in steps:
         step.postprocess(rt, context)

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/project/api.py

@@ -9,7 +9,7 @@ from abc import ABC, abstractmethod
 from typing import Any, List, NamedTuple, Optional
 
 from proj_flow import base
-from proj_flow.api import ctx
+from proj_flow.api import ctx, env
 from proj_flow.project import interact
 
 
@@ -30,8 +30,25 @@ class ProjectType(ABC):
     def register_init_setting(self, *settings: ctx.Setting, is_hidden=False):
         ctx.register_init_setting(*settings, is_hidden=is_hidden, project=self.id)
 
-    def get_context(self, interactive: bool):
-        return interact.get_context(interactive, self.id)
+    def get_context(self, interactive: bool, rt: env.Runtime):
+        return interact.get_context(interactive, self.id, rt)
+
+    def append_extensions(self, context: dict):
+        extensions = self.get_extension_list(context)
+        if len(extensions) == 0:
+            return
+        text = "".join(f"\n  - {ext}" for ext in extensions)
+        text = f"extensions:{text}\n\n"
+
+        with open(".flow/config.yml", encoding="UTF-8") as config_file:
+            content = config_file.read()
+
+        with open(".flow/config.yml", "w", encoding="UTF-8") as config_file:
+            config_file.write(text)
+            config_file.write(content)
+
+    @abstractmethod
+    def get_extension_list(self, context: dict) -> List[str]: ...
 
 
 project_type = base.registry.Registry[ProjectType]("ProjectType")

proj_flow-0.11.1/src/proj_flow/project/cplusplus/__init__.py

@@ -0,0 +1,10 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.project.cplusplus** registers a ``"C++"`` projects support.
+"""
+
+from proj_flow.project.cplusplus import cmake_context, conan_context
+
+__all__ = ["cmake_context", "conan_context"]

proj_flow-0.10.0/src/proj_flow/ext/cplusplus/cmake/context.py → proj_flow-0.11.1/src/proj_flow/project/cplusplus/cmake_context.py

@@ -12,9 +12,9 @@ import uuid
 import chevron
 
 from proj_flow import api, project
-from proj_flow.project import cplusplus
-
-from .__version__ import CMAKE_VERSION
+from proj_flow.base.__cmake_version__ import CMAKE_VERSION
+from proj_flow.project import data
+from proj_flow.project.cplusplus import project
 
 config_json_mustache = """
 {{#with_cmake}}
@@ -23,7 +23,6 @@ cmake:
     {{NAME_PREFIX}}_COVERAGE: "?config:coverage"
     {{NAME_PREFIX}}_SANITIZE: "?config:sanitizer"
     {{NAME_PREFIX}}_CUTDOWN_OS: "?runtime:cutdown_os"
-
 {{/with_cmake}}
 """
 
@@ -35,7 +34,7 @@ class CMakeInit(api.init.InitStep):
             return
 
         with open(".flow/config.yml", encoding="UTF-8") as config_file:
-            patched = re.split(r"(\nshortcuts:\n)", config_file.read())
+            patched = re.split(r"(\n\nshortcuts:\n)", config_file.read())
 
         if len(patched) != 3:
             return
@@ -50,23 +49,23 @@ class CMakeInit(api.init.InitStep):
 def _list_cmake_types():
     return api.ctx.move_to_front(
         "console-application",
-        sorted(key for key in project.data.get_internal("cmake").keys() if key),
+        sorted(key for key in data.get_internal("cmake").keys() if key),
     )
 
 
 api.init.register_init_step(CMakeInit())
 
-cplusplus.project.register_init_setting(
+project.cxx.register_init_setting(
     api.ctx.Setting("PROJECT.TYPE", "CMake project type", _list_cmake_types)
 )
-cplusplus.project.register_init_setting(
+project.cxx.register_init_setting(
     api.ctx.Setting("cmake", fix="{PROJECT.TYPE$map:cmake}"),
     api.ctx.Setting("CMAKE_VERSION", value=CMAKE_VERSION),
     api.ctx.Setting("PROJECT.WIX.UPGRADE_GUID", value=lambda: str(uuid.uuid4())),
     is_hidden=True,
 )
-cplusplus.project.register_switch("with_cmake", "Use CMake", True)
-cplusplus.project.register_internal(
+project.cxx.register_switch("with_cmake", "Use CMake", True)
+project.cxx.register_internal(
     "cmake",
     {
         "": {"cmd": "add_executable", "type": ""},

proj_flow-0.11.1/src/proj_flow/project/cplusplus/conan_context.py

@@ -0,0 +1,10 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.cplusplus.conan** provides the ``"Conan"`` step.
+"""
+
+from proj_flow.project.cplusplus import project
+
+project.cxx.register_switch("with_conan", "Use Conan for dependency manager", True)

proj_flow-0.11.1/src/proj_flow/project/cplusplus/project.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2025 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.project.cplusplus** registers a ``"C++"`` projects support.
+"""
+
+from proj_flow.project import api
+
+CPP_EXTENSIONS = [
+    "proj_flow.ext.cplusplus",
+    "proj_flow.ext.sign",
+    "proj_flow.ext.store",
+]
+
+
+@api.project_type.add
+class CPlusPlus(api.ProjectType):
+    def __init__(self):
+        super().__init__("C++ plus CMake plus Conan", "cxx")
+
+    def get_extension_list(self, context: dict):
+        with_github_actions = not not context.get("with_github_actions")
+        if with_github_actions:
+            return [*CPP_EXTENSIONS, "proj_flow.ext.github"]
+        return CPP_EXTENSIONS
+
+
+cxx = api.get_project_type("cxx")

{proj_flow-0.10.0 → proj_flow-0.11.1}/src/proj_flow/project/interact.py

@@ -15,7 +15,7 @@ from prompt_toolkit.formatted_text.base import AnyFormattedText
 from prompt_toolkit.shortcuts import CompleteStyle
 from prompt_toolkit.validation import Validator
 
-from proj_flow.api import ctx
+from proj_flow.api import ctx, env
 
 
 @dataclass
@@ -25,8 +25,18 @@ class _Question:
     value: ctx.Values
 
     @classmethod
-    def load_default(cls, default: ctx.Setting, previous: ctx.SettingsType):
+    def load_default(
+        cls,
+        default: ctx.Setting,
+        previous: ctx.SettingsType,
+        override: Optional[ctx.StrOrBool],
+    ):
         value = default.calc_value(previous)
+        if override is not None:
+            if isinstance(value, (str, bool)) and type(value) == type(override):
+                value = override
+            elif isinstance(value, list) and isinstance(override, str):
+                value = ctx.move_to_front(override, value)
         return cls(default.json_key, default.prompt, value)
 
     def interact(self, counter: int, size: int) -> ctx.StrOrBool:
@@ -123,7 +133,9 @@ def _project_filter(project: Optional[str]):
     return impl
 
 
-def _prompt(wanted: Callable[[ctx.Setting], bool]) -> ctx.SettingsType:
+def _prompt(
+    wanted: Callable[[ctx.Setting], bool], overrides: ctx.SettingsType
+) -> ctx.SettingsType:
     settings: ctx.SettingsType = {}
 
     defaults = [setting for setting in ctx.defaults if wanted(setting)]
@@ -132,22 +144,19 @@ def _prompt(wanted: Callable[[ctx.Setting], bool]) -> ctx.SettingsType:
     size = len(defaults) + len(switches)
     counter = 1
 
-    for setting in defaults:
-        loaded = _Question.load_default(setting, settings)
-        value = loaded.interact(counter, size)
-        settings[loaded.key] = value
-        counter += 1
-
-    for setting in switches:
-        loaded = _Question.load_default(setting, settings)
-        value = loaded.interact(counter, size)
-        settings[loaded.key] = value
-        counter += 1
+    for coll in [defaults, switches]:
+        for setting in coll:
+            loaded = _Question.load_default(
+                setting, settings, overrides.get(setting.json_key)
+            )
+            value = loaded.interact(counter, size)
+            settings[loaded.key] = value
+            counter += 1
 
     return settings
 
 
-def _all_default(wanted: Callable[[ctx.Setting], bool]):
+def _all_default(wanted: Callable[[ctx.Setting], bool], overrides: ctx.SettingsType):
     """
     Chooses default answers for all details of newly-crated project.
 
@@ -160,13 +169,13 @@ def _all_default(wanted: Callable[[ctx.Setting], bool]):
     defaults = [setting for setting in ctx.defaults if wanted(setting)]
     switches = [setting for setting in ctx.switches if wanted(setting)]
 
-    for setting in defaults:
-        value = _get_default(setting, settings)
-        settings[setting.json_key] = value
-
-    for setting in switches:
-        value = _get_default(setting, settings)
-        settings[setting.json_key] = value
+    for coll in [defaults, switches]:
+        for setting in coll:
+            if setting.json_key in overrides:
+                settings[setting.json_key] = overrides[setting.json_key]
+            else:
+                value = _get_default(setting, settings)
+                settings[setting.json_key] = value
 
     return settings
 
@@ -217,19 +226,30 @@ def _fixup_context(settings: ctx.SettingsType, wanted: Callable[[ctx.Setting], b
     return result
 
 
-def get_context(interactive: bool, project: Optional[str]):
+def get_context(interactive: bool, project: Optional[str], rt: env.Runtime):
     """
     Prompts user to provide details of newly-crated project. If `interactive`
     is true, however, this functions skips the prompts and chooses all the
     default answers.
 
     :param interactive: Selects, if the initialization process is done through
-        prompts, or not
+        prompts, or not.
+
+    :param project: Alows to select questions for any given language.
+
+    :param rt: Runtime with config loaded in.
 
     :returns: Dictionary with answers to all interactive settings and switches.
     """
 
+    overrides = rt._cfg.get("defaults", {})
+
     wanted = _project_filter(project)
     return _fixup_context(
-        _all_default(wanted) if not interactive else _prompt(wanted), wanted
+        (
+            _all_default(wanted, overrides)
+            if not interactive
+            else _prompt(wanted, overrides)
+        ),
+        wanted,
     )

proj_flow-0.10.0/src/proj_flow/project/cplusplus.py

@@ -1,17 +0,0 @@
-# Copyright (c) 2025 Marcin Zdun
-# This code is licensed under MIT license (see LICENSE for details)
-
-"""
-The **proj_flow.project.cplusplus** registers a ``"C++"`` projects support.
-"""
-
-from proj_flow.project import api
-
-
-@api.project_type.add
-class CPlusPlus(api.ProjectType):
-    def __init__(self):
-        super().__init__("C++ + CMake + Conan", "cxx")
-
-
-project = api.get_project_type("cxx")