Merge pull request #18 from diego-ninja/feature/improved_score_calculation

Feature/improved score calculation

Author: diego-ninja

.github/workflows/code-style.yml

@@ -0,0 +1,29 @@
+name: Code Style
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pint:
+    runs-on: ubuntu-latest
+    name: Laravel Pint
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          extensions: dom, curl, libxml, mbstring, zip
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --prefer-stable --prefer-dist --no-interaction
+
+      - name: Check code style
+        run: composer run cs:check

.github/workflows/pest.yml

@@ -0,0 +1,36 @@
+name: Security Audit
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  security-audit:
+    runs-on: ubuntu-latest
+    name: Security Audit
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          extensions: mbstring, dom, fileinfo
+
+      - name: Cache Composer packages
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-8.4-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-8.4-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Security audit
+        run: composer audit

.github/workflows/phpstan.yml

@@ -0,0 +1,29 @@
+name: Static Analysis
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+    name: PHPStan
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          extensions: dom, curl, libxml, mbstring, zip
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --prefer-stable --prefer-dist --no-interaction
+
+      - name: Run PHPStan
+        run: composer run analyse

.github/workflows/pint.yml

@@ -0,0 +1,53 @@
+name: Pest Tests
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: ['8.3', '8.4']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, dom, fileinfo, mysql, redis
+          coverage: xdebug
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-${{ matrix.php-version }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run PEST tests
+        run: composer run test
+
+      - name: Run PEST with coverage
+        if: matrix.php-version == '8.4'
+        run: composer run test:coverage-clover
+
+      - name: Upload coverage reports to Coveralls
+        if: matrix.php-version == '8.4'
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./coverage/clover.xml

.github/workflows/security.yml

@@ -6,3 +6,4 @@ composer.lock
 /.phpunit.result.cache
 /tester.php
 /node_modules
+/coverage-report/

.github/workflows/static-analysis.yml

@@ -4,25 +4,29 @@
     <img src="./.github/assets/logo.png" alt="Sentinel Logo"/>
 </p>
 
-[![Laravel Package](https://img.shields.io/badge/Laravel%2010+%20Package-red?logo=laravel&logoColor=white)](https://www.laravel.com)
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/diego-ninja/sentinel.svg?style=flat&color=blue)](https://packagist.org/packages/diego-ninja/sentinel)
-[![Total Downloads](https://img.shields.io/packagist/dt/diego-ninja/sentinel.svg?style=flat&color=blue)](https://packagist.org/packages/diego-ninja/sentinel)
-![PHP Version](https://img.shields.io/packagist/php-v/diego-ninja/sentinel.svg?style=flat&color=blue)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-![GitHub last commit](https://img.shields.io/github/last-commit/diego-ninja/sentinel?color=blue)
-[![PHPStan Level](https://img.shields.io/badge/phpstan-level%2010-blue?logo=php)]()
+[![Laravel Package](https://img.shields.io/badge/Laravel%2010+%20Package-red?logo=laravel&logoColor=white&style=flat-square)](https://www.laravel.com)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/diego-ninja/sentinel.svg?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)](https://packagist.org/packages/diego-ninja/sentinel)
+[![Total Downloads](https://img.shields.io/packagist/dt/diego-ninja/sentinel.svg?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)](https://packagist.org/packages/diego-ninja/sentinel)
+![PHP Version](https://img.shields.io/packagist/php-v/diego-ninja/sentinel.svg?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)](https://opensource.org/licenses/MIT)
+![GitHub last commit](https://img.shields.io/github/last-commit/diego-ninja/sentinel?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)
+[![wakatime](https://wakatime.com/badge/user/bd65f055-c9f3-4f73-92aa-3c9810f70cc3/project/7b950600-2e9e-4660-906a-e8f65f555778.svg?style=flat-square&color=blue&logoColor=%23949ca4&labelColor=%233f4750)](https://wakatime.com/badge/user/bd65f055-c9f3-4f73-92aa-3c9810f70cc3/project/7b950600-2e9e-4660-906a-e8f65f555778)
 
-# Introduction
+[![Tests](https://img.shields.io/github/actions/workflow/status/diego-ninja/sentinel/tests.yml?branch=main&style=flat-square&logo=github&label=Pest%20Tests&logoColor=%23949ca4&labelColor=%233f4750)]()
+[![Static Analysis](https://img.shields.io/github/actions/workflow/status/diego-ninja/sentinel/static-analysis.yml?branch=main&style=flat-square&logo=github&label=PHPStan%2010&logoColor=%23949ca4&labelColor=%233f4750)]()
+[![Code Style](https://img.shields.io/github/actions/workflow/status/diego-ninja/sentinel/code-style.yml?branch=main&style=flat-square&logo=github&label=Pint%3A%20PER&logoColor=%23949ca4&labelColor=%233f4750)]()
+[![Coveralls](https://img.shields.io/coverallsCoverage/github/diego-ninja/sentinel?branch=main&style=flat-square&logo=coveralls&logoColor=%23949ca4&labelColor=%233f4750&link=https%3A%2F%2Fcoveralls.io%2Fgithub%2Fdiego-ninja%2Fgranite)]()
 
-A powerful and flexible content analysis package for Laravel 10+ applications. Analyze and filter offensive content using multiple services, local dictionaries, and advanced detection strategies.
+## 🚀 Introduction
 
-This documentation has been generated almost in its entirety using 🦠 [Claude 3.5 Sonnet](https://claude.ai/) based on source code analysis. Some sections may be incomplete, outdated or may contain documentation for planned or not-released features. For the most accurate information, please refer to the source code or open an issue on the package repository.
+Sentinel is an advanced, flexible, and powerful content analysis package for Laravel applications. It provides comprehensive protection against offensive content through multiple detection strategies, context-aware analysis, and multilingual support.
+
+This documentation has been generated almost in its entirety using 🦠 [Claude 3.5 Haiku](https://claude.ai/) based on source code analysis. Some sections may be incomplete, outdated or may contain documentation for planned or not-released features. For the most accurate information, please refer to the source code or open an issue on the package repository.
 
 ## ❤️ Features
 
 - Multiple service providers support:
     - Local dictionary-based analysis
-    - [PurgoMalum](https://www.purgomalum.com/)
     - [Tisane AI](https://tisane.ai/)
     - [Prism LLM](https://prism.echolabs.dev/) (with support for multiple LLMs)
     - [Azure AI](https://azure.microsoft.com/en-us/pricing/details/cognitive-services/content-safety/)
@@ -34,6 +38,11 @@ This documentation has been generated almost in its entirety using 🦠 [Claude
     - Variation detection for obfuscated content
     - Repeated character detection
     - Levenshtein distance matching
+    - Alphanumeric variation detection
+    - Phonetic matching
+    - Zero-width character detection
+    - Reversed word detection
+  
 - Rich analysis results:
     - Sentiment analysis
     - Content categorization

.github/workflows/tests.yml

@@ -41,6 +41,15 @@
         "laravel/octane": "^2.6",
         "wulfheart/laravel-actions-ide-helper": "^0.8.0"
     },
+    "scripts": {
+      "test": "pest",
+      "test:unit": "pest --testsuite=Unit",
+      "test:coverage": "pest --coverage-clover coverage/clover.xml --coverage-html coverage/html --coverage-text coverage/coverage.txt",
+      "test:coverage-clover": "pest --coverage-clover coverage/clover.xml",
+      "analyse": "phpstan analyse",
+      "cs:check": "pint --test src tests",
+      "cs:fix": "pint src tests"
+    },
     "autoload": {
         "psr-4": {
             "Ninja\\Sentinel\\": "src/"