Refactor modules

Author: Andrey Danilov

.github/workflows/publish.yml

@@ -0,0 +1,90 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: Build Distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Upgrade `pip`
+      run: pip install --upgrade pip
+    - name: Install Build Tool
+      run: python -m pip install build --user
+    - name: Install Wheel
+      run: python -m pip install wheel --user
+    - name: Install Dependencies
+      run: pip install -r requirements.txt
+    - name: Generate Wheel
+      run: python setup.py bdist_wheel
+    - name: Upload Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/inaSpeechSegmenter-client
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download Artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Sign and Release on GitHub
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+    - name: Download Artifacts
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign Artifacts
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ''
+    - name: Upload to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}'
+        dist/**
+        --repo '${{ github.repository }}'

.gitignore

@@ -1,2 +1,4 @@
 /.venv/
 **/__pycache__/
+/*.egg-info/
+/dist/

.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "code4swipe.py",
+      "console": "integratedTerminal"
+    }
+  ]
+}

README.md

@@ -1,6 +1,6 @@
 # `code4swipe`: The Dopamine CLI for Coders
 
-`code4swipe` is a command-line interface (CLI) tool that gamifies your coding process by rewarding you with an automatic "swipe up" action (like the satisfying gesture on TikTok or other social media feeds) whenever you introduce new changes to your local git repository.
+`code4swipe` is a CLI tool that gamifies your coding process by rewarding you with an automatic "swipe up" action (like the satisfying gesture on TikTok or other social media feeds) whenever you introduce new changes to your local git repository.
 
 It monitors your current working directory's `git diff` and triggers a **swipe** via a chosen provider (currently, **ADB** for Android devices) to give you a quick, satisfying break or a virtual "pat on the back" for your new lines of code.
 
@@ -9,7 +9,7 @@ It monitors your current working directory's `git diff` and triggers a **swipe**
 - **Git Diff Monitoring:** Continuously monitors your local repository's uncommitted changes.
 - **Two Detection Strategies:**
   - **`exact` (Default):** Triggers on **ANY** change to the git diff (additions, deletions, modifications).
-  - **`linecount`:** Triggers only if the total number of lines in the git diff has **increased** since the last check (focused on rewarding additions).
+  - **`linecount`:** Triggers only if the total number of lines in the git diff has changed.
 - **ADB Swipe Provider:** Uses the **Android Debug Bridge (ADB)** to execute a simulated "swipe up" on a connectedAndroid device.
 - **Customizable:** Set your preferred repository path and polling interval.
 
@@ -29,72 +29,41 @@ Before installation, ensure you have the following ready:
 
 ## Installation
 
-You can install `code4swipe` either globally for easy access or within a Python Virtual Environment (`.venv`) for isolated usage.
+### Install Globally
 
-### 1\. Global Installation (Recommended for quick use)
-
-The script depends on the `click` package for its CLI functionality.
+To install `code4swipe`, use the following command:
 
 ```bash
-# Install the required package
-pip install click
+pip install code4swipe
 ```
 
-For a global installation, copy the script file (let's assume you save it as `code4swipe.py`) and make it executable.
+This will install the package and its dependencies, making the `code4swipe` command available globally.
 
-1. **Save the script:**
+### Install in Virtual Environment
 
-   ```bash
-   # Save the script contents to a file
-   wget -O code4swipe.py https://raw.githubusercontent.com/Danand/code4swipe/refs/heads/main/code4swipe.md
-   # OR
-   # Create the file and paste the content
-   ```
+Using a virtual environment is the recommended way to manage Python dependencies for development.
 
-2. **Make it executable:**
+1. Clone and `cd` in repo.
 
-   ```bash
-   chmod +x code4swipe.py
-   ```
-
-3. **Move to a PATH directory:**
+2. **Create and activate the environment:**
 
    ```bash
-   # For Linux/macOS
-   sudo mv code4swipe.py /usr/local/bin/code4swipe
-   # For Windows, you'd place it in a directory listed in your PATH and rename
-   # it, or call it directly with `python code4swipe.py`.
+   python3.11 -m venv .venv
+   source .venv/bin/activate  # On Windows, use: .venv\Scripts\activate
    ```
 
-Now you can run it from any directory using the command `code4swipe`.
-
-### 3\. Virtual Environment (`.venv`) Installation
-
-Using a virtual environment is the recommended way to manage Python dependencies for development.
-
-1. **Create and activate the environment:**
+3. **Install requirements:**
 
    ```bash
-   python3 -m venv .venv
-   source .venv/bin/activate  # On Windows, use: .venv\Scripts\activate
+   pip install -r requirements.txt
    ```
 
-2. **Install requirements:**
+4. **Make script executable:**
 
    ```bash
-   pip install click
+   chmod +x code4swipe.py
    ```
 
-3. **Save the script:** Save the script contents as `code4swipe.py` inside your project directory.
-
-4. **Run the script:**
-
-    ```bash
-    python code4swipe.py
-    ```
-
-    *(You'll need to run this command from the directory containing `code4swipe.py` or specify the full path.)*
-
 -----
 
 ## Usage
@@ -105,18 +74,17 @@ Run the tool from within the git repository you want to monitor.
 
 The simplest way to run `code4swipe` is from the root of your git repository.
 
+If installed **globally**:
+
 ```bash
-code4swipe
-# OR if using venv:
-python code4swipe.py
+python3 -m code4swipe
 ```
 
-This will:
+If installed in **virtual environment**:
 
-- Monitor the current directory (`--repo .`).
-- Use the `adb` provider (`--provider adb`).
-- Use the `exact` change detection strategy (`--changes exact`).
-- Check for changes every 5 seconds (`--poll-interval 5.0`).
+```bash
+./code4swipe.py --repo /path/to/my/other/project
+```
 
 ### Options
 
@@ -130,22 +98,22 @@ This will:
 
 ### Examples
 
-#### 1\. Reward only for code additions (linecount strategy)
+#### Reward only for code additions (linecount strategy)
 
 ```bash
-code4swipe --changes linecount
+python3 -m code4swipe --changes linecount
 ```
 
-#### 2\. Monitor a different repository with a longer interval
+#### Monitor a different repository with a longer interval
 
 ```bash
-code4swipe --repo /path/to/my/other/project --poll-interval 10
+python3 -m code4swipe --repo /path/to/my/other/project --poll-interval 10
 ```
 
-#### 3\. Debug ADB connection issues
+#### Debug ADB connection issues
 
 ```bash
-code4swipe --verbose
+python3 -m code4swipe --verbose
 ```
 
 -----
@@ -174,4 +142,4 @@ If you see this warning, your Python version is too old. You must upgrade to **P
 
 1. **Check your device:** Make sure the Android device is unlocked and the screen is on, ready to receive input.
 2. **Check the git diff:** The script only reacts to uncommitted changes. Try making a small change to a file in the monitored repo. Run `git diff` manually to confirm you have changes.
-3. **Check the strategy:** If using `--changes linecount`, ensure your new code *increases* the total line count of the diff (i.e., you haven't just deleted lines).
+3. **Check the strategy:** If using `--changes linecount`, ensure your new code changes the total line count of the diff.

base/git_diff_changes_detector_base.py

@@ -0,0 +1,34 @@
+import abc
+import pathlib
+import typing
+
+class GitDiffChangesDetectorBase(abc.ABC):
+    """
+    Abstract base class for all git diff change detectors.
+
+    Defines the contract for determining if a "rewardable" amount
+    of new work has occurred since the last check.
+    """
+
+    def __init__(self, repo_path: pathlib.Path) -> None:
+        """Initializes the detector with the repository path."""
+        self.repo_path = repo_path
+        self._last_state = self.get_current_state()
+
+    @abc.abstractmethod
+    def get_current_state(self) -> typing.Any:
+        """Calculates and returns the current state of the diff."""
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def check_for_new_work(self) -> bool:
+        """
+        Checks for new work, updates the internal state, and returns True
+        if a reward should be triggered.
+        """
+        raise NotImplementedError
+
+    @property
+    def initial_status_message(self) -> str:
+        """Returns a string describing the initial state."""
+        return f"Initial state: {self._last_state}. Waiting for new code..."

base/git_diff_provider_base.py

@@ -0,0 +1,20 @@
+import abc
+import pathlib
+
+class GitDiffProviderBase(abc.ABC):
+    """
+    Abstract base class for providing git diffs.
+    """
+
+    @abc.abstractmethod
+    def get_current_git_diff(self, repo_path: pathlib.Path) -> str:
+        """
+        Runs git diff and returns the entire output string.
+
+        Args:
+            repo_path: The path to the repository.
+
+        Returns:
+            The full output of git diff as a string.
+        """
+        raise NotImplementedError

base/impl_factory_base.py

@@ -0,0 +1,62 @@
+import abc
+import typing
+
+from enum import StrEnum
+
+import click
+
+TBaseClass = typing.TypeVar("TBaseClass", bound=abc.ABC)
+TImplName = typing.TypeVar("TImplName", bound=StrEnum)
+
+class ImplFactoryBase(abc.ABC, typing.Generic[TBaseClass, TImplName]):
+    """
+    Base class for implementation factories.
+    """
+
+    @property
+    @abc.abstractmethod
+    def impl_name_class(self) -> type[TImplName]:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def get_impl_map(self) -> typing.Dict[TImplName, typing.Callable[[], TBaseClass]]:
+        """
+        Returns a map of implementation names to their factory functions.
+        """
+        raise NotImplementedError
+
+    def get_impl_instance(self, impl_name_str: str) -> TBaseClass:
+        """
+        Gets an instance of the implementation based on the provided name.
+
+        Args:
+            impl_name: The name of the implementation to retrieve.
+
+        Returns:
+            An instance of the implementation.
+
+        Raises:
+            click.Abort: If the implementation name is not found.
+        """
+        impl_map = self.get_impl_map()
+
+        impl_name = self.impl_name_class(impl_name_str.lower())
+
+        instance_factory = impl_map.get(impl_name)
+
+        if not instance_factory:
+            click.echo(
+                f"Error: Unknown implementation {impl_name}. "
+                f"Available: {self.get_instance_names_list()}",
+                err=True,
+            )
+
+            raise click.Abort()
+
+        return instance_factory()
+
+    def get_instance_names_list(self) -> typing.List[str]:
+        """
+        Returns a list of available implementation names.
+        """
+        return [name.value for name in self.get_impl_map().keys()]