Introduce a functional claim (#20)

Author: Douglas Lassance

README.md

@@ -59,19 +59,24 @@ git -C project add local.png
 git -C project commit -m "Add local.png"
 
 # Updating tracked commits with current local changes.
-# Because we specified `track_uncommitted`. Uncommitted changes will be stored as sha-less commit.
-# Update permissions of all files based on track commits.
-# Because `modify_permssions` was passed this will update all permissions of tracked files.
-# Permission updates currently comes at high performance cost and is not recommended.
+# Because we passed `--track-uncommitted`, uncommitted changes will be stored as sha-less commit.
+# Because we passed `--modify-permssions` the file permissions will be updated.
+# When passing `--update-hooks`, the update will happen automatically on the following hooks:
+# applypatch, post-checkout, post-commit, post-rewrite.
 gitalong -C project update
 
 # Checking the status for the files we created.
 # Each status will show <spread> <filename> <commit> <local-branches> <remote-branches> <host> <author>.
-# Spread flags represent where the commit live.
-# It will be displayed in the following order:
+# Spread flags represent where the commit lives. It will be displayed in the following order:
 # <mine-uncommitted><mine-active-branch><mine-other-branch><remote-matching-branch><remote-other-branch><other-other-branch><other-matching-branch><other-uncomitted>
 # A `+` sign means is true, while a `-` sign means false or unknown.
-gitalong -C project untracked.txt status uncommited.png local.png current.jpg remote.jpg
+gitalong -C project status untracked.txt uncommited.png local.png current.jpg remote.jpg
+
+# Claiming the files to modify them.
+# If the file cannot be claimed the "blocking" commit will be returned.
+# Since we passed `--modify-permissions`, the claimed file will be made writeable.
+# These claimed files will be released automatically on the next update if not modified.
+gitalong -C project claim untracked.txt uncommited.png local.png current.jpg remote.jpg
 ```
 
 ### Python

gitalong/batch.py

@@ -5,7 +5,7 @@
 # import datetime
 
 # from turtle import write
-from typing import List, Coroutine
+from typing import List, Coroutine, Optional
 
 # from unittest import result
 
@@ -49,6 +49,70 @@ async def _run_command(args: List[str], safe: bool = False) -> str:
     return stdout.decode().strip()
 
 
+async def get_local_only_commits(
+    repository: Repository, claims: Optional[List[str]] = None
+) -> list:
+    """
+    Returns:
+        list:
+            Commits that are not on remote branches. Includes a commit that
+            represents uncommitted changes.
+        claims (list, optional):
+            List of files that we want to claim.
+            They'll be store as uncommitted changes.
+    """
+    local_commits = []
+    for branch in repository.branches:
+        await accumulate_local_only_commits(repository, branch.commit, local_commits)
+    if repository.config.get("track_uncommitted"):
+        uncommitted_changes_commit = repository.get_uncommitted_changes_commit(
+            claims=claims
+        )
+
+        # Adding file we want to claim to the uncommitted changes commit.
+        for claim in claims or []:
+            claim = repository.get_absolute_path(claim)
+            if os.path.isfile(claim):
+                uncommitted_changes_commit.setdefault("changes", []).append(
+                    repository.get_relative_path(claim).replace("\\", "/")
+                )
+
+        if uncommitted_changes_commit:
+            local_commits.insert(0, uncommitted_changes_commit)
+    local_commits.sort(key=lambda commit: commit.get("date"), reverse=True)
+    return local_commits
+
+
+async def accumulate_local_only_commits(
+    repository, start: git.Commit, local_commits: List[dict]
+):
+    """Accumulates a list of local only commit starting from the provided commit.
+
+    Args:
+        local_commits (list): The accumulated local commits.
+        start (git.objects.Commit):
+            The commit that we start peeling from last commit.
+    """
+    if repository.is_remote_commit(start.hexsha):
+        return
+
+    commit = Commit(repository)
+    commit.update_with_sha(start.hexsha)
+    commit.update_context()
+
+    changes = await get_commits_changes([commit])
+    commit["changes"] = changes[0]
+
+    branches_list = await get_commits_branches([commit])
+    branches = branches_list[0] if branches_list else []
+    commit["branches"] = {"local": branches}
+
+    if commit not in local_commits:
+        local_commits.append(commit)
+    for parent in start.parents:
+        await accumulate_local_only_commits(repository, parent, local_commits)
+
+
 async def get_files_last_commits(  # pylint: disable=too-many-branches,too-many-locals,too-many-statements
     filenames: List[str], prune: bool = True
 ) -> List[Commit]:
@@ -271,21 +335,14 @@ async def update_files_permissions(filenames: List[str]):
     write_permissions = []
     for filename, last_commit in zip(filenames, last_commits):
         repository = Repository.from_filename(os.path.dirname(filename))
-        spread = last_commit.commit_spread if repository else 0
+        if not repository:
+            continue
+        spread = last_commit.commit_spread
         if not spread:
             continue
-        is_uncommitted = (
-            spread & CommitSpread.MINE_UNCOMMITTED == CommitSpread.MINE_UNCOMMITTED
-        )
-        is_local = (
-            spread & CommitSpread.MINE_ACTIVE_BRANCH == CommitSpread.MINE_ACTIVE_BRANCH
-        )
-        is_current = (
-            spread
-            & (CommitSpread.MINE_ACTIVE_BRANCH | CommitSpread.REMOTE_MATCHING_BRANCH)
-            == CommitSpread.MINE_ACTIVE_BRANCH | CommitSpread.REMOTE_MATCHING_BRANCH
-        )
-        write_permission = is_uncommitted or is_local or is_current
+        is_uncommitted = spread == CommitSpread.MINE_UNCOMMITTED
+        is_local = spread == CommitSpread.MINE_ACTIVE_BRANCH
+        write_permission = is_uncommitted or is_local
         write_permissions.append(write_permission)
         tasks.append(_set_write_permission(filename, write_permission))
     await asyncio.gather(*tasks)
@@ -294,8 +351,7 @@ async def update_files_permissions(filenames: List[str]):
 async def _set_write_permission(
     filename: str, write_permission: bool, safe: bool = False
 ) -> bool:
-    """
-    Set the write permission of a file asynchronously.
+    """Set the write permission of a file asynchronously.
 
     Args:
         filename (str): The path to the file.
@@ -324,3 +380,87 @@ async def _set_write_permission(
             return True
         raise
     return True
+
+
+async def get_updated_tracked_commits(
+    repository: Repository, claims: Optional[List[str]] = None
+) -> list:
+    """
+    Returns:
+        list:
+            Local commits for all clones with local commits and uncommitted changes
+            from this clone.
+    """
+    tracked_commits = []
+    for commit in repository.store.commits:
+        remote = repository.remote.url
+        is_other_remote = commit.get("remote") != remote
+        if is_other_remote or not commit.is_issued_commit():
+            tracked_commits.append(commit)
+            continue
+
+    for commit in await get_local_only_commits(repository, claims=claims):
+        tracked_commits.append(commit)
+    return tracked_commits
+
+
+async def update_tracked_commits(
+    repository: Repository, claims: Optional[List[str]] = None
+):
+    """Pulls the tracked commits from the store and updates them."""
+    repository.store.commits = await get_updated_tracked_commits(
+        repository, claims=claims
+    )
+    absolute_filenames = []
+    if repository.config.get("modify_permissions"):
+        print("Updating permissions")
+        for filename in repository.files:
+            absolute_filenames.append(repository.get_absolute_path(filename))
+        await repository.batch.update_files_permissions(absolute_filenames)
+
+
+async def claim_files(
+    filenames: List[str],
+    prune: bool = True,
+) -> List[Commit]:
+    """If the file is available for changes, temporarily communicates files as changed.
+    By communicate we mean the file will be marked as a local change until the next
+    update of the tracked commits. Also makes the files writable if the configured is
+    set to affect permissions.
+
+    Args:
+        filename (str):
+            A list of absolute filenames to claim.
+        prune (bool, optional): Prune branches if a fetch is necessary.
+
+    Returns:
+        List[Commit]: The blocking commits for the file we want to claim.
+    """
+    blocking_commits = []
+    last_commits = await get_files_last_commits(filenames, prune=prune)
+    for last_commit in last_commits:
+        spread = last_commit.commit_spread
+        is_local_commit = (
+            spread & CommitSpread.MINE_ACTIVE_BRANCH == CommitSpread.MINE_ACTIVE_BRANCH
+        )
+        is_uncommitted = (
+            spread & CommitSpread.MINE_UNCOMMITTED == CommitSpread.MINE_UNCOMMITTED
+        )
+        blocking_commits.append(
+            Commit(None) if is_local_commit or is_uncommitted else last_commit
+        )
+
+    # Collect all repositories and corresponding file updates.
+    filenames_by_repository = {}
+    for filename_ in filenames:
+        repository = Repository.from_filename(filename_)
+        filenames_by_repository.setdefault(repository, []).append(filename_)
+
+    # Updating the tracked commits for each repository affected.
+    for repository in filenames_by_repository:
+        if repository:
+            await update_tracked_commits(
+                repository,
+                claims=filenames_by_repository.get(repository, []),
+            )
+    return blocking_commits

gitalong/cli.py

@@ -7,21 +7,21 @@
 from .__info__ import __version__
 from .enums import CommitSpread
 from .repository import Repository
-from .batch import get_files_last_commits
+from .batch import get_files_last_commits, claim_files, update_tracked_commits
 
 
 def get_status_string(filename: str, commit: dict, spread: int) -> str:
     """Generate a status string for a file and its commit."""
-    prop = "+" if spread & CommitSpread.MINE_UNCOMMITTED else "-"
-    prop += "+" if spread & CommitSpread.MINE_ACTIVE_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.MINE_OTHER_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.REMOTE_MATCHING_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.REMOTE_OTHER_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.THEIR_OTHER_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.THEIR_MATCHING_BRANCH else "-"
-    prop += "+" if spread & CommitSpread.THEIR_UNCOMMITTED else "-"
+    spread_string = "+" if spread & CommitSpread.MINE_UNCOMMITTED else "-"
+    spread_string += "+" if spread & CommitSpread.MINE_ACTIVE_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.MINE_OTHER_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.REMOTE_MATCHING_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.REMOTE_OTHER_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.THEIR_OTHER_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.THEIR_MATCHING_BRANCH else "-"
+    spread_string += "+" if spread & CommitSpread.THEIR_UNCOMMITTED else "-"
     splits = [
-        prop,
+        spread_string,
         filename,
         commit.get("sha", "-"),
         ",".join(commit.get("branches", {}).get("local", ["-"])) or "-",
@@ -70,9 +70,8 @@ def config(ctx, prop):  # pylint: disable=missing-function-docstring
 def update(ctx):
     """Update tracked commits with local changes."""
     repository = Repository.from_filename(ctx.obj.get("REPOSITORY", ""))
-    if not repository:
-        return
-    repository.update_tracked_commits()
+    if repository:
+        asyncio.run(update_tracked_commits(repository))
 
 
 @click.command(
@@ -107,16 +106,47 @@ def status(ctx, filename, profile=False):  # pylint: disable=missing-function-do
 
 
 def run_status(ctx, filename):  # pylint: disable=missing-function-docstring
-    file_status = []
-    commits = asyncio.run(get_files_last_commits(filename))
-    for _filename, commit in zip(filename, commits):
-        repository = Repository.from_filename(ctx.obj.get("REPOSITORY", _filename))
-        absolute_filename = (
-            repository.get_absolute_path(_filename) if repository else _filename
+    absolute_filenames = []
+    for filename_ in filename:
+        repository = Repository.from_filename(ctx.obj.get("REPOSITORY", filename_))
+        absolute_filenames.append(
+            repository.get_absolute_path(filename_) if repository else filename_
+        )
+    file_statuses = []
+    last_commits = asyncio.run(get_files_last_commits(absolute_filenames))
+    for filename_, last_commit in zip(filename, last_commits):
+        file_statuses.append(
+            get_status_string(filename_, last_commit, last_commit.commit_spread)
+        )
+    click.echo("\n".join(file_statuses), err=False)
+
+
+@click.command(
+    help=(
+        "Make provided files writeable if possible. Return error code 1 if one or more "
+        "files cannot be made writeable."
+    )
+)
+@click.argument(
+    "filename",
+    nargs=-1,
+    # help="The path to the file that should be made writable."
+)
+@click.pass_context
+def claim(ctx, filename):  # pylint: disable=missing-function-docstring
+    absolute_filenames = []
+    for filename_ in filename:
+        repository = Repository.from_filename(ctx.obj.get("REPOSITORY", filename_))
+        absolute_filenames.append(
+            repository.get_absolute_path(filename_) if repository else filename_
+        )
+    file_statuses = []
+    blocking_commits = asyncio.run(claim_files(absolute_filenames))
+    for filename_, blocking_commit in zip(filename, blocking_commits):
+        file_statuses.append(
+            get_status_string(filename_, blocking_commit, blocking_commit.commit_spread)
         )
-        spread = commit.commit_spread if repository else 0
-        file_status.append(get_status_string(absolute_filename, commit, spread))
-    click.echo("\n".join(file_status), err=False)
+    click.echo("\n".join(file_statuses), err=False)
 
 
 @click.command(help="Setup Gitalong in a repository.")
@@ -259,6 +289,7 @@ def cli(ctx, repository, git_binary):  # pylint: disable=missing-function-docstr
 cli.add_command(update)
 cli.add_command(setup)
 cli.add_command(status)
+cli.add_command(claim)
 cli.add_command(version)
 
 

gitalong/functions.py

@@ -41,16 +41,21 @@ def is_binary_string(string: str) -> bool:
     return bool(string.translate(None, textchars))  # pyright: ignore[reportCallIssue]
 
 
-def is_writeable(filename: str) -> bool:
+def is_writeable(filename: str, safe=True) -> bool:
     """
     Args:
         filename (str): The absolute filename of the file to check.
 
     Returns:
         bool: Whether the file is read only.
     """
-    stat_ = os.stat(filename)
-    return bool(stat_.st_mode & stat.S_IWUSR)
+    try:
+        stat_ = os.stat(filename)
+        return bool(stat_.st_mode & stat.S_IWUSR)
+    except FileNotFoundError:
+        if safe:
+            return False
+        raise
 
 
 def get_real_path(filename: str) -> str:
@@ -125,3 +130,15 @@ def get_filenames_from_move_string(move_string: str) -> tuple:
             rights.append(splits[-1])
     pair = {move_string.format(*lefts), move_string.format(*rights)}
     return tuple(sorted(pair))
+
+
+def touch_file(filename: str) -> None:
+    """
+    Args:
+        filename (str): The file to touch.
+    """
+    if not os.path.exists(os.path.dirname(filename)):
+        os.makedirs(os.path.dirname(filename))
+    with open(filename, "a", encoding="utf-8"):
+        pass
+    os.utime(filename)