Add Pre-commit configuration and Github Action workflow

Author: Brian Obot

.github/workflows/create_pull_requests.yml

@@ -0,0 +1,64 @@
+name: Quality Check & PR to Master
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11' # You can change this to your preferred version
+          cache: 'pip'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install pytest # Ensures pytest is available even if not in requirements.txt
+
+      # - name: Create .env file
+      #   run: |
+
+      # - name: Run Tests
+      #   run: |
+      #     mkdir logs
+      #     pytest -s
+
+  create_pull_request:
+      runs-on: ubuntu-latest
+      needs: test  # This creates the dependency link
+      if: github.actor == 'brianobot'
+      permissions:
+        contents: write
+        pull-requests: write
+      env:
+        GITHUB_TOKEN: ${{ secrets.MY_PERSONAL_TOKEN }}
+      steps:
+        - name: Checkout Code
+          uses: actions/checkout@v4
+
+        - name: Create Pull Request
+          run: |
+            # Check if a PR already exists from dev to master
+            PR_EXISTS=$(gh pr list --head dev --base master --state open --json number -q '.[0].number')
+
+            if [ -z "$PR_EXISTS" ]; then
+              echo "No open PR found. Creating a new one..."
+              gh pr create \
+                --head dev \
+                --base master \
+                --title "Auto-PR: Dev to Master" \
+                --body "Automated PR triggered by push from ${{ github.actor }}" \
+                --assignee "${{ github.actor }}"
+            else
+              echo "PR already exists: #$PR_EXISTS. Skipping creation."
+            fi

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-added-large-files
+
+  # 1. Sort Imports (Isort)
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+
+  # 2. Format Code (Black)
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+
+  # 3. Linting (Ruff - extremely fast linter)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.6
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+
+  # 4. Type Checking (Mypy)
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pydantic
+          - types-requests  # If you use requests
+          - types-setuptools # This usually replaces what pkg-resources needed
+          - types-PyYAML     # If you use YAML configs

_2024/day_1.rs

@@ -4,47 +4,56 @@ use std::fs;
 
 #[allow(dead_code)]
 fn calculate_total_distance_diff(locations_a: Vec<u32>, locations_b: Vec<u32>) -> u32 {
+    /*
+    Takes 2 list of integers and calculates the difference between each ordered element from each list
+    and return the total difference from the calculation.
+    */
     let mut location_a = locations_a.clone();
     let mut location_b = locations_b.clone();
-    
+
     // Sort both list first
     location_a.sort();
     location_b.sort();
-    
+
     let mut total = 0;
     for (a, b) in location_a.iter().zip(location_b.iter()) {
         total += cmp::max(a, b) - cmp::min(a, b);
     }
-    
+
     total
  }
- 
- 
+
+
  fn calculate_total_similarity_score(locations_a: Vec<i32>, locations_b: Vec<i32>) -> i32 {
+     /*
+     Takes 2 list of integers and calculates the total similarity score for each value in the first list
+     the similarity score is the product of the item in the first list and the number of occurrence of that value
+     in the second list.
+     */
      let mut total = 0;
-     
+
      for location_id in locations_a {
          let similarity_score = locations_b.iter().filter(|item| **item == location_id).count() as i32 * location_id;
          total += similarity_score;
      }
-     
-     total 
+
+     total
  }
- 
+
 
  fn main() {
      let mut list_a = Vec::new();
      let mut list_b = Vec::new();
-     
+
      let content = fs::read_to_string("_2024/data/day_1_input.txt").expect("Failed to Read Input File");
-     
+
      for line in content.lines() {
          let numbers = line.split_whitespace().map(|item| item.parse::<i32>().expect("Fail to convert to integer")).collect::<Vec<_>>();
-         
+
          list_a.push(numbers[0]);
          list_b.push(numbers[1]);
      }
-     
+
      let result = calculate_total_similarity_score(list_a, list_b);
      println!("Result = {result}");
- }
+ }