Enforcing PSR 12 code style (#12)

* adding PHPCS and the rules for using PSR-12

* small modification to fix the code style

Co-authored-by: Beau Simensen <[email protected]>

Author: zaherg

.github/workflows/tests.yml

@@ -6,33 +6,57 @@ on:
 
 jobs:
 
-    phpunit:
-        name: PHPUnit on ${{ matrix.php }} ${{ matrix.composer-flags }}
-        runs-on: ubuntu-latest
-        strategy:
-            matrix:
-                php: ['7.4', '8.0', '8.1']
-
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v3
-              with:
-                fetch-depth: 1
-
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php }}
-                  extensions: curl
-                  coverage: pcov
-
-            - name: Install Composer dependencies
-              uses: ramsey/composer-install@v2
-              with:
-                  composer-options: "--no-progress --prefer-dist --optimize-autoloader"
-
-            - name: Configure matchers
-              uses: mheap/phpunit-matcher-action@v1
-
-            - name: PHPUnit
-              run: ./vendor/bin/phpunit --coverage-text --teamcity
+  phpunit:
+    name: PHPUnit on ${{ matrix.php }} ${{ matrix.composer-flags }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['7.4', '8.0', '8.1']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+            php-version: ${{ matrix.php }}
+            extensions: curl
+            coverage: pcov
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+        with:
+            composer-options: "--no-progress --prefer-dist --optimize-autoloader"
+
+      - name: Configure matchers
+        uses: mheap/phpunit-matcher-action@v1
+
+      - name: PHPUnit
+        run: ./vendor/bin/phpunit --coverage-text --teamcity
+
+  phpcs:
+    name: phpcs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          tools: cs2pr
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          composer-options: "--no-progress --prefer-dist --optimize-autoloader"
+
+      - name: phpcs
+        run: ./vendor/bin/phpcs -q --report=checkstyle | cs2pr              

.gitignore

@@ -1,3 +1,4 @@
 .phpunit.result.cache
+.phpcs-cache
 composer.lock
 vendor

composer.json

@@ -24,7 +24,8 @@
     },
     "require-dev": {
         "symfony/yaml": "^5.4 || ^6.0",
-        "phpunit/phpunit": "^9.3"
+        "phpunit/phpunit": "^9.3",
+        "squizlabs/php_codesniffer": "^3.5"        
     },
     "suggest": {
         "symfony/yaml": "Required for using the YAML Configuration Builders"

phpcs.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+
+    <!-- Ignore warnings, show progress of the run and show sniff names -->
+    <arg value="nps"/>
+
+    <!-- Directories to be checked -->
+    <file>src</file>
+    <file>tests</file>
+
+    <rule ref="PSR12"/>
+</ruleset>

src/Dflydev/DotAccessConfiguration/AbstractConfiguration.php

@@ -166,7 +166,7 @@ protected function resolveValues(&$input = null)
     protected function data()
     {
         if (null === $this->data) {
-            $this->data = new Data;
+            $this->data = new Data();
         }
 
         return $this->data;

src/Dflydev/DotAccessConfiguration/AbstractConfigurationBuilder.php

@@ -38,7 +38,7 @@ public function setConfigurationFactory(ConfigurationFactoryInterface $configura
     protected function configurationFactory()
     {
         if (null === $this->configurationFactory) {
-            $this->configurationFactory = new ConfigurationFactory;
+            $this->configurationFactory = new ConfigurationFactory();
         }
 
         return $this->configurationFactory;

src/Dflydev/DotAccessConfiguration/AbstractPlaceholderResolverFactory.php

@@ -2,7 +2,7 @@
 
 /*
  * This file is a part of dflydev/dot-access-configuration.
- * 
+ *
  * (c) Dragonfly Development Inc.
  *
  * For the full copyright and license information, please view the LICENSE
@@ -25,10 +25,10 @@ public function create(ConfigurationInterface $configuration)
 
     /**
      * Internal create
-     * 
+     *
      * @param ConfigurationInterface $configuration
      * @param DataSourceInterface $dataSource
-     * 
+     *
      * @return PlaceholderResolverInterface
      */
     abstract protected function createInternal(ConfigurationInterface $configuration, DataSourceInterface $dataSource);

src/Dflydev/DotAccessConfiguration/ConfigurationDataSource.php

@@ -2,7 +2,7 @@
 
 /*
  * This file is a part of dflydev/dot-access-configuration.
- * 
+ *
  * (c) Dragonfly Development Inc.
  *
  * For the full copyright and license information, please view the LICENSE
@@ -19,7 +19,7 @@ class ConfigurationDataSource implements DataSourceInterface
 
     /**
      * Constructor
-     * 
+     *
      * @param ConfigurationInterface $configuration
      */
     public function __construct(ConfigurationInterface $configuration)
@@ -53,9 +53,9 @@ public function get($key, $system = false)
 
     /**
      * Set Configuration
-     * 
+     *
      * @param ConfigurationInterface $configuration
-     * 
+     *
      * @return ConfigurationDataSource
      */
     public function setConfiguration(ConfigurationInterface $configuration)

src/Dflydev/DotAccessConfiguration/ConfigurationFactory.php

@@ -18,6 +18,6 @@ class ConfigurationFactory implements ConfigurationFactoryInterface
      */
     public function create()
     {
-        return new Configuration;
+        return new Configuration();
     }
 }

src/Dflydev/DotAccessConfiguration/ConfigurationInterface.php

@@ -2,7 +2,7 @@
 
 /*
  * This file is a part of dflydev/dot-access-configuration.
- * 
+ *
  * (c) Dragonfly Development Inc.
  *
  * For the full copyright and license information, please view the LICENSE
@@ -18,93 +18,93 @@ interface ConfigurationInterface
 {
     /**
      * Get a value (with placeholders unresolved)
-     * 
+     *
      * @param string $key
-     * 
+     *
      * @return mixed
      */
     public function getRaw($key);
 
     /**
      * Get a value (with placeholders resolved)
-     * 
+     *
      * @param string $key
-     * 
+     *
      * @return mixed
      */
     public function get($key);
 
     /**
      * Set a value
-     * 
+     *
      * @param string $key
      * @param mixed $value
      */
     public function set($key, $value = null);
 
     /**
      * Append a value
-     * 
+     *
      * Will force key to be an array if it is only a string
-     * 
+     *
      * @param string $key
      * @param mixed $value
      */
     public function append($key, $value = null);
 
     /**
      * Export configuration data as an associtaive array (with placeholders unresolved)
-     * 
+     *
      * @return array
-     */    
+     */
     public function exportRaw();
 
     /**
      * Export configuration data as an associtaive array (with placeholders resolved)
-     * 
+     *
      * @return array
-     */    
+     */
     public function export();
 
     /**
      * Underlying Data representation
-     * 
+     *
      * Will have all placeholders resolved.
-     * 
+     *
      * @return Data
      */
     public function exportData();
 
     /**
      * Import another Configuration
-     * 
+     *
      * @param array $imported
      * @param bool $clobber
-     */    
+     */
     public function importRaw($imported, $clobber = true);
 
     /**
      * Import another Configuration
-     * 
+     *
      * @param ConfigurationInterface $imported
      * @param bool $clobber
-     */    
+     */
     public function import(ConfigurationInterface $imported, $clobber = true);
 
     /**
      * Resolve placeholders in value from configuration
-     * 
+     *
      * @param string|null $value
-     * 
+     *
      * @return string
      */
     public function resolve($value = null);
 
     /**
      * Set Placeholder Resolver
-     * 
+     *
      * @param PlaceholderResolver $placeholderResolver
-     * 
+     *
      * @return ConfigurationInterface
      */
     public function setPlaceholderResolver(PlaceholderResolverInterface $placeholderResolver);