Merge pull request #31 from ChanceNCounter/feature/bak-diff

Implements 'bak diff', closes #12

Author: ChanceNCounter

README.md

@@ -24,6 +24,7 @@ Don't worry, they're easy to remember after a minute:
 
 ## Additional commands and flags
 `bak down --keep my_file` - Restores from .bakfile, does not delete .bakfile  
+`bak diff my_file` Compare a .bakfile using `diff` (will become configurable)
 `bak show my_file` View a .bakfile in $PAGER  
 `bak show --using exec my_file` View a .bakfile using `exec`  (alias `--in`)
 
@@ -44,7 +45,6 @@ example:
 
 `bak list` - List all .bakfiles, with a bit of metadata to help with disambiguation  
 `bak list my_file` - List all .bakfiles *of the specified file*, with metadata  
-`bak diff my_file <bakfile>` - Self-explanatory. Without .bakfile argument, diffs `my_file` against its most recent .bakfile. By default, uses [ydiff](https://github.com/ymattw/ydiff). Can be configured to use the difftool of your choice.
 
 ## Current state (updated Oct. 31, 2020)
 This is a very pre-alpha version, as in, this is a spaghetti proof-of-concept. Perhaps ~~5-6~~ 12-15 hours have been spent on development so far. As such, it's only "working" in the strictest sense.

bak/__main__.py

@@ -5,8 +5,6 @@
 from click_default_group import DefaultGroup
 
 from . import commands
-# from . import data
-# # import data
 
 
 def __print_help():
@@ -84,5 +82,11 @@ def bak_get(to_where_you_once_belonged):
     commands.bak_getfile_cmd(to_where_you_once_belonged)
 
 
+@bak.command("diff")
+@click.argument("filename", required=True, type=click.Path(exists=True))
+def bak_diff(filename):
+    commands.bak_diff_cmd(filename)
+
+
 if __name__ == "__main__":
     bak()

bak/commands/__init__.py

@@ -48,7 +48,7 @@ def _assemble_bakfile(filename):
     # TODO #26 get bakfile directory from config
     bakfile_path = os.path.join(bak_dir, bakfile_name)
 
-    new_bak_entry = bakfile.BakFile(filename,
+    new_bak_entry = bakfile.BakFile(os.path.basename(filename),
                                     os.path.abspath(filename),
                                     bakfile_path,
                                     time_now,
@@ -60,7 +60,7 @@ def _assemble_bakfile(filename):
 
 
 def _get_bakfile_entry(filename, select_prompt=default_select_prompt, err=False):
-    entries = db_handler.get_bakfile_entries(filename)
+    entries = db_handler.get_bakfile_entries(expandpath(filename))
     if not entries or len(entries) == 0:
         return None
     return entries[0] if len(entries) == 1 else _do_select_bakfile(entries, select_prompt, err)
@@ -128,7 +128,7 @@ def create_bakfile(filename: str):
         # TODO descriptive failure
         return False
     new_bakfile = _assemble_bakfile(filename)
-    copy2(new_bakfile.original_file, new_bakfile.bakfile_loc)
+    copy2(new_bakfile.orig_abspath, new_bakfile.bakfile_loc)
     db_handler.create_bakfile_entry(new_bakfile)
 
 
@@ -245,3 +245,9 @@ def bak_getfile_cmd(bak_to_get: (str, bakfile.BakFile)):
         if not bak_to_get:
             return  # _get_bakfile_entry() handles failures, so just exit
         click.echo(bak_to_get.bakfile_loc)
+
+
+def bak_diff_cmd(filename):
+    # TODO configurable diff executable
+    bak_to_diff = _get_bakfile_entry(expandpath(filename))
+    call(['diff', bak_to_diff.bakfile_loc, bak_to_diff.orig_abspath])

bak/data/bak_db.py

@@ -34,8 +34,8 @@ def del_bakfile_entry(self, bak_entry: BakFile):
         with sqlite3.connect(self.db_loc) as db_conn:
             db_conn.execute(
                 """
-                DELETE FROM bakfiles WHERE original_file=:orig
-                """, (bak_entry.original_file,))
+                DELETE FROM bakfiles WHERE original_abspath=:orig
+                """, (bak_entry.orig_abspath,))
             db_conn.commit()
 
     def update_bakfile_entry(self,

requirements.txt

@@ -1,4 +1,3 @@
 click==7.1.2
 click-default-group==1.2.2
-rich==9.1.0
-ydiff==1.2
+rich==9.1.0

setup.py

@@ -2,8 +2,7 @@
 
 require = ['click==7.1.2',
            'click-default-group==1.2.2',
-           'rich==9.1.0',
-           'ydiff==1.2']
+           'rich==9.1.0']
 
 setup(name='bak',
       version='0.0.1a',