feat: ready for symfony 5.3, add github actions, merged from orginal repo suncat2000#143, suncat2000#144, suncat2000#135, suncat2000#133

Author: Chris53897

.github/workflows/code_checks.yaml

@@ -0,0 +1,37 @@
+# .github/workflows/code_checks.yaml
+name: Code_Checks
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.2', '7.3', '7.4', '8.0']
+        stability: [ prefer-lowest, prefer-stable ]
+
+    name: PHP ${{ matrix.php }} - ${{ matrix.stability }} tests
+    steps:
+      # basically git clone
+      - uses: actions/checkout@v2
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      # use PHP of specific version
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: pcov, dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite
+          coverage: pcov # none, disable xdebug, pcov
+
+      - name: Install dependencies
+        run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: vendor/bin/phpunit --verbose

.github/workflows/code_coverage.yaml

@@ -0,0 +1,23 @@
+# .github/workflows/code_coverage.yaml
+name: Code_Coverage
+
+on: ["push", "pull_request"]
+
+jobs:
+  code_coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          coverage: pcov
+
+      - run: composer install --no-progress
+
+      - run: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+
+      - uses: codecov/codecov-action@v1.3.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: build/logs/clover.xml

.gitignore

@@ -3,4 +3,9 @@ build/
 composer.phar
 composer.lock
 phpunit.xml
+.php_cs.cache
+.phpcs-cache
+.phpunit.result.cache
 release.sh
+.idea/
+_gsdata_/

.travis.yml

@@ -9,38 +9,33 @@ cache:
 
 php:
     - hhvm
+    - 7.1
     - 7.2
-    - 7.3
 
 dist: trusty
 
 matrix:
     allow_failures:
-        -   php: hhvm
+        - php: hhvm
     fast_finish: true
     include:
-        -   php: 7.2
-            env: SYMFONY_VERSION='4.4.*'
-        -   php: 7.2
-            env: SYMFONY_VERSION='5.1.*'
-        -   php: 7.2
-            env: SYMFONY_VERSION='5.2.*'
-        -   php: 7.3
-            env: SYMFONY_VERSION='4.4.*'
-        -   php: 7.3
-            env: SYMFONY_VERSION='5.1.*'
-        -   php: 7.3
-            env: SYMFONY_VERSION='5.2.*'
-        -   php: 7.4
-            env: SYMFONY_VERSION='4.4.*'
-        -   php: 7.4
-            env: SYMFONY_VERSION='5.1.*'
-        -   php: 7.4
-            env: SYMFONY_VERSION='5.2.*'
+        - php: 7.1
+          env: SYMFONY_VERSION='4.0.*'
+        - php: 7.2
+          env: SYMFONY_VERSION='4.0.*'
+        - php: 7.2
+          env: SYMFONY_VERSION='5.0.*'
 
 before_install:
-    - if [[ "$TRAVIS_PHP_VERSION" != "hhvm" ]]; then phpenv config-rm xdebug.ini; fi
+    - if [[ "$TRAVIS_PHP_VERSION" != "5.6" && "$TRAVIS_PHP_VERSION" != "hhvm" ]]; then phpenv config-rm xdebug.ini; fi
     - composer self-update
     - if [ "$SYMFONY_VERSION" != "" ]; then composer require --dev --no-update symfony/framework-bundle:${SYMFONY_VERSION}; fi
 
 install: composer update $COMPOSER_FLAGS --dev --no-interaction --prefer-dist
+
+script:
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then mkdir -p build/logs; fi
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then vendor/bin/phpunit --coverage-clover build/logs/clover.xml; else vendor/bin/phpunit; fi
+
+after_script:
+    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then php vendor/bin/coveralls -v; fi

composer.json

@@ -21,14 +21,14 @@
     ],
     "require": {
         "php": ">=7.2",
-        "symfony/framework-bundle": "4.*|5.*",
+        "symfony/framework-bundle": "^4.4|^5.0|^6.0",
         "mobiledetect/mobiledetectlib": "^2.8",
         "twig/twig": "2.*|3.*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.4",
-        "symfony/phpunit-bridge": "4.*|5.*",
-        "satooshi/php-coveralls": "^2.0.0"
+        "phpunit/phpunit": "^8.4|^9.0",
+        "symfony/phpunit-bridge": "^4.4|^5.0|^6.0",
+        "php-coveralls/php-coveralls": "^2.0.0"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -11,23 +11,42 @@
          stopOnError="false"
          stopOnIncomplete="false"
          stopOnSkipped="false"
-         syntaxCheck="false"
          bootstrap="tests/bootstrap.php"
     >
+
+    <php>
+        <ini name="error_reporting" value="-1" />
+        <server name="APP_ENV" value="test" force="true" />
+        <server name="SHELL_VERBOSITY" value="-1" />
+        <server name="SYMFONY_PHPUNIT_REMOVE" value="" />
+        <server name="SYMFONY_PHPUNIT_VERSION" value="9" />
+
+        <server name="KERNEL_CLASS" value="App\Tests\App\AppKernel"/>
+        <server name="KERNEL_DIR" value="./Tests/App"/>
+        <ini name="zend.enable_gc" value="0"/>
+    </php>
+
     <testsuites>
         <testsuite name="MobileDetectBundle Test Suite">
             <directory>Tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">./</directory>
+
+
+        <coverage processUncoveredFiles="false">
+            <include>
+                <directory suffix=".php">./</directory>
+            </include>
             <exclude>
+                <directory>.github</directory>
                 <directory>./src/Resources</directory>
                 <directory>./Tests</directory>
                 <directory>./vendor</directory>
                 <file>./tests/bootstrap.php</file>
             </exclude>
-        </whitelist>
-    </filter>
+            <report>
+                <clover outputFile="build/logs/clover.xml"/>
+            </report>
+        </coverage>
+
 </phpunit>

src/DataCollector/DeviceDataCollector.php

@@ -11,7 +11,6 @@
 
 namespace SunCat\MobileDetectBundle\DataCollector;
 
-use Exception;
 use SunCat\MobileDetectBundle\EventListener\RequestResponseListener;
 use SunCat\MobileDetectBundle\Helper\DeviceView;
 use Symfony\Component\HttpFoundation\Request;
@@ -50,9 +49,9 @@ public function __construct(DeviceView $deviceView)
     /**
      * Collects data for the given Request and Response.
      *
-     * @param Request    $request   A Request instance
-     * @param Response   $response  A Response instance
-     * @param Exception $exception An Exception instance
+     * @param Request $request A Request instance
+     * @param Response $response A Response instance
+     * @param Throwable|null $exception An Exception instance
      *
      * @api
      */
@@ -96,25 +95,17 @@ public function collect(
         );
     }
 
-    /**
-     * @return string
-     */
+
     public function getCurrentView(): string
     {
         return $this->data['currentView'];
     }
 
-    /**
-     * @return array
-     */
     public function getViews(): array
     {
         return $this->data['views'];
     }
 
-    /**
-     * @param array $redirectConfig
-     */
     public function setRedirectConfig(array $redirectConfig)
     {
         $this->redirectConfig = $redirectConfig;
@@ -123,22 +114,14 @@ public function setRedirectConfig(array $redirectConfig)
     /**
      * Returns the name of the collector.
      *
-     * @return string The collector name
-     *
      * @api
      */
     public function getName(): string
     {
         return 'device.collector';
     }
 
-    /**
-     * @param $view
-     * @param $host
-     *
-     * @return bool
-     */
-    protected function canUseView($view, $host): bool
+    protected function canUseView(string $view, ?string $host): bool
     {
         if (!is_array($this->redirectConfig)) {
             return true;
@@ -174,17 +157,11 @@ protected function canUseView($view, $host): bool
         return true;
     }
 
-    /**
-     * @param Request $request
-     * @param         $view
-     *
-     * @return string
-     */
-    private function generateSwitchLink(
-        Request $request,
-        $view
-    ) {
+
+    private function generateSwitchLink(Request $request, string $view): ?string
+    {
         $requestSwitchView = $request->duplicate();
+
         $requestSwitchView->query->set($this->deviceView->getSwitchParam(), $view);
         $requestSwitchView->server->set(
             'QUERY_STRING',

src/DependencyInjection/Configuration.php

@@ -30,7 +30,8 @@ class Configuration implements ConfigurationInterface
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('mobile_detect');
-        $rootNode = $treeBuilder->getRootNode();
+        # Fallback-Solution for symfony 4
+        $rootNode = method_exists(TreeBuilder::class, 'getRootNode') ? $treeBuilder->getRootNode() : $treeBuilder->root('mobile_detect');
 
         $rootNode
             ->children()

src/DeviceDetector/MobileDetector.php

@@ -19,6 +19,6 @@
  * @author suncat2000 <nikolay.kotovsky@gmail.com>
  *
  */
-class MobileDetector extends MobileDetect
+class MobileDetector extends MobileDetect implements MobileDetectorInterface
 {
 }

src/DeviceDetector/MobileDetectorInterface.php

@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the MobileDetectBundle.
+ *
+ * (c) Nikolay Ivlev <nikolay.kotovsky@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SunCat\MobileDetectBundle\DeviceDetector;
+
+/**
+ * MobileDetectorInterface interface
+ *
+ * @author pierrickmartos <pierrick.martos@gmail.com>
+ *
+ */
+interface MobileDetectorInterface
+{
+    /**
+     * Check if the device is mobile.
+     * Returns true if any type of mobile device detected, including special ones
+     * @param  null $userAgent   deprecated
+     * @param  null $httpHeaders deprecated
+     * @return bool
+     */
+    public function isMobile($userAgent = null, $httpHeaders = null);
+
+    /**
+     * Check if the device is a tablet.
+     * Return true if any type of tablet device is detected.
+     *
+     * @param  string $userAgent   deprecated
+     * @param  array  $httpHeaders deprecated
+     * @return bool
+     */
+    public function isTablet($userAgent = null, $httpHeaders = null);
+
+    /**
+     * This method checks for a certain property in the
+     * userAgent.
+     * @todo: The httpHeaders part is not yet used.
+     *
+     * @param  string        $key
+     * @param  string        $userAgent   deprecated
+     * @param  string        $httpHeaders deprecated
+     * @return bool|int|null
+     */
+    public function is($key, $userAgent = null, $httpHeaders = null);
+
+    /**
+     * Some detection rules are relative (not standard),
+     * because of the diversity of devices, vendors and
+     * their conventions in representing the User-Agent or
+     * the HTTP headers.
+     *
+     * This method will be used to check custom regexes against
+     * the User-Agent string.
+     *
+     * @param $regex
+     * @param  string $userAgent
+     * @return bool
+     *
+     * @todo: search in the HTTP headers too.
+     */
+    public function match($regex, $userAgent = null);
+
+    /**
+     * Retrieve the mobile grading, using self::MOBILE_GRADE_* constants.
+     *
+     * @return string One of the self::MOBILE_GRADE_* constants.
+     */
+    public function mobileGrade();
+}