Review code (#44)

* add tests files in linter
* encapsulate Exception into SessionException
* add tests about SessionException
* explain codeCoverageIgnore
* remove token for codecov
* remove option --no-suggest from github action
* use multiple php versions (7.4, 8.0) for github action
* add functions setLengthSessionID and getLengthSessionID
* update README with session options
* update comments on Session handler

Author: rancoud

.editorconfig

@@ -1,24 +1,37 @@
 name: test
 
 on:
-    push:
-    pull_request:
+  push:
+  pull_request:
 
 jobs:
-    test:
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v2
-            - name: Pull
-              run: docker-compose pull --quiet
-            - name: Build
-              run: docker-compose build
-            - name: Test
-              run: docker-compose run lib composer ci
-            - name: Upload coverage
-              uses: codecov/codecov-action@v1.3.2
-              if: success()
-              with:
-                  token: ${{ secrets.CODECOV_TOKEN }}
-                  file: ./coverage/clover.xml
+  test:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        php-version:
+          - '7.4'
+          - '8.0'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Pull
+        run: docker-compose pull --quiet
+
+      - name: Build
+        run: docker-compose build --build-arg PHPVERSION=${{ matrix.php-version }}
+
+      - name: Test
+        run: docker-compose run lib composer ci
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1.3.2
+        if: success()
+        with:
+          file: ./coverage/clover.xml

.github/workflows/test.yml

@@ -1,6 +1,7 @@
 <?php
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/tests')
 ;
 return PhpCsFixer\Config::create()
     ->setRiskyAllowed(true)

.php_cs

@@ -15,7 +15,7 @@ WORKDIR /app
 COPY composer.json .
 COPY composer.lock .
 RUN composer validate
-RUN composer install --no-interaction --no-progress --no-suggest
+RUN composer install --no-interaction --no-progress
 
 COPY . .
 

Dockerfile

@@ -90,7 +90,7 @@ Session::useCurrentRedisDriver($redis);
 Session::set('key', 'value');
 $value = Session::get('key');
 ```
-With your own driver implementing SessionHandlerInterface
+With your own driver implementing `SessionHandlerInterface` and/or `SessionUpdateTimestampHandlerInterface`
 ```php
 $driver = new MyCustomDriver();
 Session::useCustomDriver($driver);
@@ -147,28 +147,72 @@ When flash data is restore, it will be delete in $_SESSION.
 #### Static PHP Session Default Driver
 * useDefaultDriver(): void  
 * useDefaultEncryptionDriver(key: string, [method: string|null = null]): void  
+* setLengthSessionID(length: int): void  
+* getLengthSessionID(): int  
 
 #### Static File Driver
 * useFileDriver(): void  
 * useFileEncryptionDriver(key: string, [method: string|null = null]): void  
 * setPrefixForFile(prefix: string): void  
+* setLengthSessionID(length: int): void
+* getLengthSessionID(): int
 
 #### Static Database Driver
 * useNewDatabaseDriver(configuration: \Rancoud\Database\Configurator|array): void  
 * useCurrentDatabaseDriver(databaseInstance: \Rancoud\Database\Database): void  
 * useNewDatabaseEncryptionDriver(configuration: \Rancoud\Database\Configurator|array, key: string, [method: string = null]): void  
 * useCurrentDatabaseEncryptionDriver(databaseInstance: \Rancoud\Database\Database, key: string, [method: string = null]): void  
 * setUserIdForDatabase(userId: int): void  
+* setLengthSessionID(length: int): void
+* getLengthSessionID(): int
 
 #### Static Redis Driver
 * useNewRedisDriver(configuration: array|string): void  
 * useCurrentRedisDriver(redisInstance: \Predis\Client): void  
 * useNewRedisEncryptionDriver(configuration: array|string, key: string, [method: string = null]): void  
 * useCurrentRedisEncryptionDriver(redisInstance: \Predis\Client, key: string, [method: string = null]): void  
+* setLengthSessionID(length: int): void
+* getLengthSessionID(): int
 
 #### Static Custom Driver
 * useCustomDriver(customDriver: \SessionHandlerInterface): void  
 
+## Session options
+List of session options you can change:  
+* save_path
+* name
+* save_handler
+* auto_start
+* gc_probability
+* gc_divisor
+* gc_maxlifetime
+* serialize_handler
+* cookie_lifetime
+* cookie_path
+* cookie_domain
+* cookie_secure
+* cookie_httponly
+* cookie_samesite
+* use_strict_mode
+* use_cookies
+* use_only_cookies
+* referer_check
+* cache_limiter
+* cache_expire
+* use_trans_sid
+* trans_sid_tags
+* trans_sid_hosts
+* sid_length
+* sid_bits_per_character
+* upload_progress.enabled
+* upload_progress.cleanup
+* upload_progress.prefix
+* upload_progress.name
+* upload_progress.freq
+* upload_progress.min_freq
+* lazy_write
+* read_and_close
+
 ## Driver Informations
 ### Default
 Use SessionHandler

README.md

@@ -15,9 +15,16 @@
             "Rancoud\\Session\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "tests\\": "tests"
+        }
+    },
     "require": {
         "php": ">=7.4.0",
-        "ext-openssl": ">=7.4.0"
+        "ext-openssl": "*",
+        "ext-session": "*",
+        "ext-mbstring": "*"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",
@@ -36,7 +43,7 @@
             "php-cs-fixer fix"
         ],
         "test": [
-            "phpdbg -qrr vendor/bin/phpunit --colors --coverage-text --coverage-clover ./coverage/clover.xml"
+            "phpdbg -qrr vendor/bin/phpunit --colors --coverage-html ./coverage --coverage-text --coverage-clover ./coverage/clover.xml"
         ]
     }
 }

composer.json

@@ -6,6 +6,7 @@
     <arg value="p"/>
 
     <file>src</file>
+    <file>tests</file>
 
     <rule ref="PSR2"/>