Add support for .gitignore (#32)

* Add GitIgnore
* Rename *Mixin -> *MixIn
* Add {Project,Dir}.subpaths() to get an iterable of string subpaths
* Add {Dir,File}.parent to get the {Project,Dir} the object is contained within
* Update checklist and example in README
* Fix windows style separators (\) in GitIgnore
* Bump version to 1.6.0

Author: eganjs

.github/workflows/publish.yml

@@ -61,8 +61,8 @@ jobs:
         run: make dist
       - name: check tag matches version
         run: ls dist/synth-a-py-${{ steps.tag.outputs.tag }}.tar.gz
-          dist/synth-a-py-1.5.0.tar.gz dist/synth_a_py-${{ steps.tag.outputs.tag
-          }}-py3-none-any.whl dist/synth_a_py-1.5.0-py3-none-any.whl
+          dist/synth-a-py-1.6.0.tar.gz dist/synth_a_py-${{ steps.tag.outputs.tag
+          }}-py3-none-any.whl dist/synth_a_py-1.6.0-py3-none-any.whl
       - name: create release
         id: create_release
         uses: actions/create-release@v1
@@ -79,8 +79,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: dist/synth-a-py-1.5.0.tar.gz
-          asset_name: synth-a-py-1.5.0.tar.gz
+          asset_path: dist/synth-a-py-1.6.0.tar.gz
+          asset_name: synth-a-py-1.6.0.tar.gz
           asset_content_type: application/gzip
       - name: publish to pypi
         env:

.projenrc.js

@@ -532,7 +532,7 @@ class PoetryProject extends Project {
 
 const project = new PoetryProject({
   name: "synth-a-py",
-  version: "1.5.0",
+  version: "1.6.0",
   description: "Project configuration as code",
   authors: ["Joseph Egan <joseph.s.egan@gmail.com>"],
   repository: "https://github.com/eganjs/synth-a-py",

Makefile

@@ -22,9 +22,9 @@ publish: dist
 	poetry publish
 
 .PHONY: dist
-dist: dist/synth-a-py-1.5.0.tar.gz dist/synth_a_py-1.5.0-py3-none-any.whl
+dist: dist/synth-a-py-1.6.0.tar.gz dist/synth_a_py-1.6.0-py3-none-any.whl
 
-dist/synth-a-py-1.5.0.tar.gz dist/synth_a_py-1.5.0-py3-none-any.whl: $(shell find synth_a_py -type f -name '*.py')
+dist/synth-a-py-1.6.0.tar.gz dist/synth_a_py-1.6.0-py3-none-any.whl: $(shell find synth_a_py -type f -name '*.py')
 	poetry build
 
 .venv: poetry.lock

README.md

@@ -14,7 +14,7 @@ Project configuration as code
       - [ ] GitHub Action workflow?
     - [x] INI (for flake8/mypy config)
     - [ ] Makefile
-    - [ ] .gitignore
+    - [x] .gitignore
   - Add ./synth.py
 - Templates:
   - [ ] Poetry
@@ -72,20 +72,17 @@ with spec:
 
     License.MIT("2020", ", ".join(authors))
 
-    SimpleFile(
-        ".gitignore",
-        dedent(
-            """\
-            *.egg
-            *.egg-info/
-            *.pyc
-            .cache/
-            .idea/
-            .mypy_cache/
-            .venv/
-            dist/
-            """
-        ),
+    GitIgnore(
+      ignore=[
+        "*.egg",
+        "*.egg-info/",
+        "*.pyc",
+        ".cache/",
+        ".idea/",
+        ".mypy_cache/",
+        ".venv/",
+        "dist/",
+      ],
     )
 
     SimpleFile(

poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "synth-a-py"
-version = "1.5.0"
+version = "1.6.0"
 description = "Project configuration as code"
 authors = [ "Joseph Egan <joseph.s.egan@gmail.com>" ]
 license = "MIT"

pyproject.toml

@@ -1,7 +1,8 @@
-__version__ = "1.5.0"
+__version__ = "1.6.0"
 
 from .base import Dir, File, Project
 from .file import EmptyFile, SimpleFile
+from .gitignore import GitIgnore
 from .ini import IniFile
 from .license import License
 from .toml import TomlFile
@@ -11,6 +12,7 @@
     "Dir",
     "EmptyFile",
     "File",
+    "GitIgnore",
     "IniFile",
     "License",
     "Project",

synth_a_py/__init__.py

@@ -6,6 +6,8 @@
 
 from returns.functions import compose
 
+from .utils import init_mix_ins
+
 __all__ = [
     "File",
     "Project",
@@ -16,7 +18,7 @@
 PathResolver = Callable[[Path], Path]
 
 
-class _FileContainerMixin:
+class _FileContainerMixIn:
     def __init__(self) -> None:
         self.__store: Dict[str, Union[File, Dir]] = dict()
 
@@ -37,30 +39,33 @@ def path_resolver(path: Path) -> Path:
                 for subpath_resolver, subitem in item.walk():
                     yield compose(path_resolver, subpath_resolver), subitem
 
+    def subpaths(self) -> Iterator[str]:
+        return (str(path_resolver(Path("."))) for path_resolver, _ in self.walk())
+
 
 if TYPE_CHECKING:
-    _ContextToken = Token[Optional[_FileContainerMixin]]
+    _ContextToken = Token[Optional[_FileContainerMixIn]]
 else:
     _ContextToken = Token
 
-__context: ContextVar[Optional[_FileContainerMixin]] = ContextVar(
+__context: ContextVar[Optional[_FileContainerMixIn]] = ContextVar(
     "__context", default=None
 )
 
 
-def _context_get() -> _FileContainerMixin:
+def _context_get() -> _FileContainerMixIn:
     project = __context.get()
     assert project is not None
     return project
 
 
-def _context_set_root(value: _FileContainerMixin) -> _ContextToken:
+def _context_set_root(value: _FileContainerMixIn) -> _ContextToken:
     project = __context.get()
     assert project is None
     return __context.set(value)
 
 
-def _context_set(value: _FileContainerMixin) -> _ContextToken:
+def _context_set(value: _FileContainerMixIn) -> _ContextToken:
     project = __context.get()
     assert project is not None
     return __context.set(value)
@@ -72,20 +77,27 @@ def _context_reset(token: _ContextToken) -> None:
     __context.reset(token)
 
 
-class File:
-    def __init__(self, name: str):
+class _ChildMixIn:
+    def __init__(self) -> None:
+        self.parent = _context_get()
+        assert isinstance(self, File) or isinstance(self, Dir)
+        self.parent.add(self)
+
+
+class File(_ChildMixIn):
+    def __init__(self, name: str) -> None:
         self.name = name
-        _context_get().add(self)
+        init_mix_ins(self, File)
 
     @abstractmethod
     def synth_content(self) -> str:
         ...
 
 
-class _ContextMixin(_FileContainerMixin):
+class _ContextMixIn(_FileContainerMixIn):
     def __init__(self) -> None:
-        super().__init__()
         self.__context_token: Optional[_ContextToken] = None
+        init_mix_ins(self, _ContextMixIn)
 
     def __enter__(self) -> None:
         assert self.__context_token is None
@@ -105,7 +117,7 @@ def __exit__(
         self.__context_token = None
 
 
-class Project(_ContextMixin):
+class Project(_ContextMixIn):
     def synth(self, root: Optional[Path] = None) -> None:
         if root is None:
             root = Path.cwd()
@@ -126,8 +138,7 @@ def synth(self, root: Optional[Path] = None) -> None:
             path.chmod(0o444)
 
 
-class Dir(_ContextMixin):
+class Dir(_ContextMixIn, _ChildMixIn):
     def __init__(self, name: str) -> None:
-        super().__init__()
         self.name = name
-        _context_get().add(self)
+        init_mix_ins(self, Dir)

synth_a_py/base.py

@@ -0,0 +1,32 @@
+from pathlib import Path
+from typing import List, Optional
+
+from .base import File
+from .utils import ensure_nl
+
+__all__ = ["GitIgnore"]
+
+
+class GitIgnore(File):
+    def __init__(
+        self,
+        ignore: Optional[List[str]] = None,
+        allow: Optional[List[str]] = None,
+    ):
+        super().__init__(".gitignore")
+        self.ignore = ignore or []
+        self.allow = allow or []
+
+    def synth_content(self) -> str:
+        return ensure_nl(
+            "\n".join(
+                [
+                    *self.ignore,
+                    *(
+                        f"!{'/'.join(Path(path).parts)}"
+                        for path in self.parent.subpaths()
+                    ),
+                    *(f"!{path}" for path in self.allow),
+                ]
+            )
+        )

synth_a_py/gitignore.py

@@ -1,7 +1,27 @@
 __all__ = [
     "ensure_nl",
+    "init_mix_ins",
 ]
 
+from inspect import Parameter, Signature, signature
+from typing import Any
+
+from typing_extensions import Final
+
 
 def ensure_nl(s: str) -> str:
     return s.rstrip() + "\n"
+
+
+no_param_init: Final[Signature] = Signature(
+    (Parameter("self", Parameter.POSITIONAL_OR_KEYWORD),),
+    return_annotation=None,
+)
+
+
+def init_mix_ins(self: Any, t: type) -> None:
+    bases = t.__bases__
+    for base in bases:
+        init = getattr(base, "__init__")
+        if signature(init) == no_param_init:
+            init(self)