Merge pull request #3 from YakDriver/delete-extras

Add removal function

Author: YakDriver

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.3
+current_version = 0.2.0
 commit = False
 tag = False
 tag_name = {new_version}

README.md

@@ -1,6 +1,6 @@
 ![scratch relax tv](https://github.com/YakDriver/scratchrelaxtv/raw/master/assets/srt.gif "Extract HCL Vars")
 
-Terraform developer tool to extract variables and create `variables.tf` files.
+Terraform module development tool. Extract variables from  `variables.tf` files 
 
 
 ## simply
@@ -29,11 +29,31 @@ By default, it looks for `main.tf` and will keep variables in the resulting `var
 
 *scratchrelaxtv* can also be used to generate a module usage stub. By default, it looks for `variables.tf` and will keep variables in the resulting `modstub.tf` in the order found in the `variables.tf`. If variables are included more than once, they will only be listed once in the resulting `modstub.tf`. If you do not `--force` overwriting, *scratchrelaxtv* will create new `modstub.tf` files with each run: `modstub.1.tf`, `modstub.2.tf` and so on.
 
+### remove files
+
+*scratchrelaxtv* can also tidy up your directories by removing its own extra generated files. Presumably it will only remove files you no longer need but be careful. This chart shows examples of what would be deleted or not.
+
+*scratchrelaxtv* removes files in the current directory _and subdirectories_.
+
+| Filename | Deleted? |
+| -------- | ------ |
+| variables.tf | no |
+| modstub.tf | yes |
+| modstub.1.tf | yes |
+| variables.1.tf | yes |
+| xyz.abc | no |
+| variables.a.tf | no |
+| variables.43.tf | yes |
+| modstub | no |
+| modstub..tf | no |
+
+### help
+
 *scratchrelaxtv* includes help:
 
 ```console
 $ scratchrelaxtv --help
-usage: scratchrelaxtv [-h] [-i INPUT] [-o OUTPUT] [-f] [-m] [-n MODNAME]
+usage: scratchrelaxtv [-h] [-i INPUT] [-o OUTPUT] [-f] [-m] [-n MODNAME] [-r]
                       [-a | -d]
 
 optional arguments:
@@ -46,6 +66,7 @@ optional arguments:
   -m, --modstub         create module usage stub
   -n MODNAME, --modname MODNAME
                         name to use in module stub
+  -r, --remove          remove all modstub.tf and variables.x.tf files
   -a, --asc             sort output variables in ascending order
   -d, --desc            sort output variables in descending order
 ```

scratchrelaxtv/__init__.py

@@ -18,7 +18,7 @@
 import re
 
 
-__version__ = "0.1.3"
+__version__ = "0.2.0"
 EXIT_OKAY = 0
 EXIT_NOT_OKAY = 1
 
@@ -32,6 +32,14 @@ def remove_prefix(text, prefix):
     return text[text.startswith(prefix) and len(prefix):]
 
 
+def remove_files():
+    """Remove files from the os that look like scratchrelaxtv files."""
+    pattern = r'^(variables\.\d+|modstub(\.\d+|))\.tf$'
+    for root, _, files in os.walk(os.getcwd()):
+        for file in filter(lambda x: re.match(pattern, x), files):
+            os.remove(os.path.join(root, file))
+
+
 class BassExtractor():
     """
     A class that extracts variables from Terraform HCL files to make creating

scratchrelaxtv/cli.py

@@ -31,6 +31,8 @@ def parse_args(args):
     parser.add_argument("-m", "--modstub", default=False, action="store_true",
                         help="create module usage stub")
     parser.add_argument("-n", "--modname", help="name to use in module stub")
+    parser.add_argument("-r", "--remove", default=False, action="store_true",
+                        help="remove all modstub.tf and variables.x.tf files")
     group = parser.add_mutually_exclusive_group()
     group.add_argument("-a", "--asc", action="store_true",
                        help="sort output variables in ascending order")
@@ -45,7 +47,9 @@ def main():
     args = parse_args(sys.argv[1:])
 
     extractor = None
-    if not args.modstub:
+    if args.remove:
+        scratchrelaxtv.remove_files()
+    elif not args.modstub:
         extractor = scratchrelaxtv.VarExtractor(args)
     else:
         extractor = scratchrelaxtv.StubMaker(args)

setup.cfg

@@ -3,7 +3,7 @@ name = scratchrelaxtv
 description = Terraform developer tool to extract variables and create variables.tf files.
 long_description = file: README.md, CHANGELOG.md
 long_description_content_type = text/markdown
-version = 0.1.3
+version = 0.2.0
 author = YakDriver
 author_email = [email protected]
 url = https://github.com/YakDriver/scratchrelaxtv

tests/test_scratchrelaxtv.py

@@ -5,7 +5,8 @@
 
 import os
 from contextlib import contextmanager
-from scratchrelaxtv import cli, StubMaker, VarExtractor, EXIT_OKAY
+from scratchrelaxtv import cli, StubMaker, VarExtractor, EXIT_OKAY, \
+    remove_files
 
 
 @contextmanager
@@ -89,3 +90,33 @@ def test_same_content_maker():
             second_list = file_handle.read().splitlines()
         assert first_list == second_list
         os.remove(filename)
+
+
+def test_removal():
+    """Test removing files."""
+    with change_dir("tests"):
+        tmpdir = "tmpdir"
+        os.mkdir(tmpdir)
+
+        with open(os.path.join(tmpdir, "modstub.tf"), "w") as file_handle:
+            file_handle.write("hello")
+
+        with open(os.path.join(tmpdir, "variables.5.tf"), "w") as file_handle:
+            file_handle.write("hello")
+
+        with open(os.path.join(tmpdir, "modstub.2.tf"), "w") as file_handle:
+            file_handle.write("hello")
+
+        with open(os.path.join(tmpdir, "dont_delete.tf"), "w") as file_handle:
+            file_handle.write("hello")
+
+        with change_dir(tmpdir):
+            remove_files()
+
+        assert not os.path.isfile(os.path.join(tmpdir, "modstub.tf"))
+        assert not os.path.isfile(os.path.join(tmpdir, "variables.5.tf"))
+        assert not os.path.isfile(os.path.join(tmpdir, "modstub.2.tf"))
+        assert os.path.isfile(os.path.join(tmpdir, "dont_delete.tf"))
+
+        os.remove(os.path.join(tmpdir, "dont_delete.tf"))
+        os.rmdir(tmpdir)