Merge pull request #11 from lsv/feature/3.0

Feature/4.0

Author: lsv

.gitattributes

@@ -2,7 +2,8 @@
 /tests                  export-ignore
 /.gitattributes         export-ignore
 /.gitignore             export-ignore
-/.php_cs.dist           export-ignore
+/.php-cs-fixer.dist.php export-ignore
 /.travis.yml            export-ignore
 /phpstan.neon           export-ignore
 /phpunit.xml.dist       export-ignore
+/infection.json.dist    export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  ci:
+    strategy:
+      matrix:
+        php-versions: [ '8.0', '8.1' ]
+        composer-versions: ['update --prefer-dist', 'update --prefer-lowest']
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: xdebug
+
+      - name: Validate composer
+        run: composer validate --no-check-publish
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+      - name: Setup composer versions
+        run: composer ${{ matrix.composer-versions }}
+
+      - name: Run phpcsfixer
+        run: vendor/bin/php-cs-fixer fix --dry-run --diff
+
+      - name: Phpstan
+        run: vendor/bin/phpstan
+
+      - name: Run tests
+        run: vendor/bin/phpunit --coverage-text --coverage-clover=.build/clover.xml --coverage-xml=.build/coverage --log-junit=.build/coverage/junit.xml
+
+      - name: Require 100% coverage
+        run: vendor/bin/coverage-check .build/clover.xml 100
+
+      - name: Run infection
+        run: vendor/bin/infection --skip-initial-tests --threads=8 --coverage=.build/coverage
+
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v2
+
+      - name: Install markdown checker
+        run: npm install markdown-link-check
+
+      - name: Check links
+        run: node_modules/.bin/markdown-link-check README.md

.gitignore

@@ -1,2 +1,4 @@
+.phpunit.result.cache
+.php-cs-fixer.cache
 /vendor
 /.build

.php-cs-fixer.dist.php

@@ -0,0 +1,17 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/tests');
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+    '@Symfony' => true,
+    'strict_param' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    '@PHP80Migration:risky' => true,
+    'php_unit_construct' => true,
+    'php_unit_strict' => true,
+])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);

.php_cs.dist

@@ -0,0 +1,7 @@
+# Changelog
+
+- *4.0*
+  - PHP 8 is required
+  - All requests (request method) parameters has moved to the constructor
+  - All responses now only has public parameters, no getters (only a few one exists)
+  - Client needs to be added before running any requests

.travis.yml

@@ -1,25 +1,44 @@
 Rejseplanen - PHP API
 ---------------------
 
-[![Build Status](https://travis-ci.org/lsv/rejseplan-php-api.svg?branch=master)](https://travis-ci.org/lsv/rejseplan-php-api) 
-[![codecov](https://codecov.io/gh/lsv/rejseplan-php-api/branch/master/graph/badge.svg)](https://codecov.io/gh/lsv/rejseplan-php-api)
-
 PHP wrapper for Rejseplanen.dk API
 
 ### Install
 
-`composer require lsv/rejseplan-php-api`
+```bash
+composer require lsv/rejseplan-php-api
+
+# Add a PSR-18 client, fx
+composer require symfony/http-client
+# If you add another PSR18 client, then look below on how to use other PSR 18 clients
+```
+
+
+### Usage
+
+```php
+$client = new \Symfony\Component\HttpClient\HttpClient(); // Any PSR-18 http client can be used
+\Lsv\Rejseplan\AbstractRequest::setClient($client);
+
+$location = '123'; // Location should be either a string, integer or a StopLocation
+$board = new \Lsv\Rejseplan\ArrivalBoard($location);
+$response = $board->request();
+// $response is now a ArrivalBoardResponse
+```
+
+See [ArrivalBoard](docs/ArrivalBoard.md) for more
 
-### Usages
+### More usages
 
-| Request | Description | 
-| --- | --- |
-| [ArrivalBoard](ArrivalBoard.md) | To get arrival board for a station |
-| [DepartureBoard](DepartureBoard.md) | To get departure board for a station |
-| [Journey](Journey.md) | This will get you a full journey report for a vehicle |
-| [Location](Location.md) | With this you can find stops, POI or addresses from a user input |
-| [NearbyStops](NearbyStops.md) | This will deliver all stops within a radius of a given coordinate. |
-| [Trip](Trip.md) | With this you can calculate a trip |
+| Request                             | Description                                                        | 
+|-------------------------------------|--------------------------------------------------------------------|
+| [Client](docs/Client.md)            | Set HTTP client                                                    |
+| [ArrivalBoard](docs/ArrivalBoard.md)     | To get arrival board for a station                                 |
+| [DepartureBoard](docs/DepartureBoard.md) | To get departure board for a station                               |
+| [Journey](docs/Journey.md)               | This will get you a full journey report for a vehicle              |
+| [Location](docs/Location.md)             | With this you can find stops, POI or addresses from a user input   |
+| [NearbyStops](docs/NearbyStops.md)       | This will deliver all stops within a radius of a given coordinate. |
+| [Trip](docs/Trip.md)                     | With this you can calculate a trip                                 |
 
 ### License
 

CHANGELOG.md

@@ -15,36 +15,39 @@
     }
   },
   "require": {
+    "php": "^8.0",
     "ext-json": "*",
-    "php": "^7.3",
-    "symfony/http-client": "^4.3",
-    "symfony/options-resolver": "^4.3",
-    "symfony/serializer": "^4.3",
-    "symfony/property-access": "^4.3",
-    "symfony/property-info": "^4.3",
-    "phpdocumentor/reflection-docblock": "^4.3"
+    "symfony/options-resolver": "^6.0",
+    "symfony/serializer": "^6.0",
+    "symfony/property-access": "^6.0",
+    "symfony/property-info": "^6.0",
+    "psr/http-client": "^1.0",
+    "nyholm/psr7": "^1.4"
   },
   "autoload-dev": {
     "psr-4": {
       "Lsv\\RejseplanTest\\": "tests"
     }
   },
   "require-dev": {
-    "symfony/phpunit-bridge": "^4.0"
+    "symfony/phpunit-bridge": "^6.0",
+    "phpunit/phpunit": "^9.5",
+    "friendsofphp/php-cs-fixer": "^3.5",
+    "sebastian/phpcpd": "^6.0",
+    "phpstan/phpstan": "^1.4",
+    "symfony/http-client": "^6.0",
+    "php-http/mock-client": "^1.5",
+    "symfony/var-dumper": "^6.0",
+    "infection/infection": "^0.26.1",
+    "rregeer/phpunit-coverage-check": "^0.3.1"
   },
   "scripts": {
     "fix": [
-      "curl -OL https://get.sensiolabs.org/security-checker.phar && php security-checker.phar security:check composer.lock && rm security-checker.phar",
-      "curl -OL https://cs.sensiolabs.org/download/php-cs-fixer-v2.phar && php php-cs-fixer-v2.phar fix --using-cache false --allow-risky=yes && rm php-cs-fixer-v2.phar",
-      "curl -OL https://phar.phpunit.de/phpcpd.phar && php phpcpd.phar src/ --min-lines=50 && rm phpcpd.phar",
-      "curl -o phpstan.phar -OL https://phpstan-downloader.aarhof.eu && php phpstan.phar analyse src -l 7 && rm phpstan.phar",
-      "vendor/bin/simple-phpunit"
-    ],
-    "test": [
-      "curl -OL https://get.sensiolabs.org/security-checker.phar && php security-checker.phar security:check composer.lock && rm security-checker.phar",
-      "curl -OL https://cs.sensiolabs.org/download/php-cs-fixer-v2.phar && php php-cs-fixer-v2.phar fix --dry-run --using-cache false --diff --allow-risky=yes && rm php-cs-fixer-v2.phar",
-      "curl -OL https://phar.phpunit.de/phpcpd.phar && php phpcpd.phar src/ --min-lines=50 && rm phpcpd.phar",
-      "curl -o phpstan.phar -OL https://phpstan-downloader.aarhof.eu && php phpstan.phar analyse src -l 7 && rm phpstan.phar"
+      "php-cs-fixer fix",
+      "phpstan",
+      "simple-phpunit --coverage-text --coverage-clover=.build/clover.xml --coverage-xml=.build/coverage --log-junit=.build/coverage/junit.xml",
+      "coverage-check .build/clover.xml 100",
+      "infection --skip-initial-tests --threads=8 --coverage=.build/coverage"
     ]
   }
 }