Add phpcs workflow (#8)

mhdcodes · web-flow · commit 15b2d41ccd47 · 2022-03-20T12:19:48.000+01:00
diff --git a/.github/workflows/cron.yml b/.github/workflows/cron.yml
@@ -1,4 +1,4 @@
-name: Check Package
+name: packagist
 
 on:
   schedule:
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -0,0 +1,23 @@
+name: stylefix
+
+on: [push]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP CS Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php_cs.dist.php --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -1,4 +1,4 @@
-name: Tests
+name: tests
 
 on: [push, pull_request]
 
diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
@@ -0,0 +1,28 @@
+name: update-changelog
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md
diff --git a/.php_cs.dist.php b/.php_cs.dist.php
@@ -0,0 +1,40 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method' => 'one',
+            ],
+        ],
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+        'single_trait_insert_per_statement' => true,
+    ])
+    ->setFinder($finder);
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # OpenCF
 
-![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
-[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
+[![tests](https://github.com/phpjuice/opencf/actions/workflows/php.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/php.yml)
+[![packagist](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
 [![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
 [![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
@@ -144,8 +144,8 @@ the [tags on this repository](https://github.com/PHPJuice/opencf/tags).
 
 license. Please see the [Licence](https://github.com/phpjuice/opencf/blob/main/LICENSE) for more information.
 
-![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
-[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
+[![tests](https://github.com/phpjuice/opencf/actions/workflows/php.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/php.yml)
+[![packagist](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
 [![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
 [![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 # OpenCF
 
-![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
-[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
+[![tests](https://github.com/phpjuice/opencf/actions/workflows/php.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/php.yml)
+[![packagist](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg?branch=main)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
 [![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
 [![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
@@ -69,10 +69,3 @@ This should produce the following results:
   "nautilus" => 0.1
 ];
 ```
-
-![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
-[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
-[![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
-[![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
-[![License](http://poser.pugx.org/phpjuice/opencf/license)](https://packagist.org/packages/phpjuice/opencf)
diff --git a/src/Algorithms/Recommender.php b/src/Algorithms/Recommender.php
@@ -67,6 +67,7 @@ public function buildModel(): self
                     $this->dataset[$k1],
                     $this->dataset[$k2]
                 );
+
                 try {
                     // save the measure to the model
                     $this->model[$k1][$k2] =
@@ -95,6 +96,7 @@ public function predict(array $userRatings): array
             if (isset($userRatings[$key])) {
                 continue;
             }
+
             try {
                 $predictions[$key] = $this->predictor
                     ->getPrediction($userRatings, $key);
diff --git a/src/RecommenderService.php b/src/RecommenderService.php
@@ -73,7 +73,7 @@ public function setDataset(array $dataset = []): self
 
     public function weightedSlopeone(): IRecommender
     {
-        if (!in_array(WeightedSlopeone::class, $this->recommenders)) {
+        if (! in_array(WeightedSlopeone::class, $this->recommenders)) {
             $this->registerRecommender(WeightedSlopeone::class);
         }
 
@@ -85,16 +85,22 @@ public function registerRecommender(string $recommender): self
         try {
             $rf = new ReflectionClass($recommender);
         } catch (ReflectionException $e) {
-            throw new NotSupportedSchemeException(sprintf('Recommendation engine "%s" must implement "%s" interface',
-                $recommender, IRecommender::class));
+            throw new NotSupportedSchemeException(sprintf(
+                'Recommendation engine "%s" must implement "%s" interface',
+                $recommender,
+                IRecommender::class
+            ));
         }
 
-        if (!$rf->implementsInterface(IRecommender::class)) {
-            throw new NotSupportedSchemeException(sprintf('Recommendation engine "%s" must implement "%s" interface',
-                $recommender, IRecommender::class));
+        if (! $rf->implementsInterface(IRecommender::class)) {
+            throw new NotSupportedSchemeException(sprintf(
+                'Recommendation engine "%s" must implement "%s" interface',
+                $recommender,
+                IRecommender::class
+            ));
         }
 
-        if (!in_array($recommender, $this->recommenders)) {
+        if (! in_array($recommender, $this->recommenders)) {
             $this->recommenders[$recommender] = new $recommender($this->dataset);
         }
 
@@ -103,17 +109,19 @@ public function registerRecommender(string $recommender): self
 
     public function getRecommender(string $recommender): IRecommender
     {
-        if (!array_key_exists($recommender, $this->recommenders)) {
-            throw new NotRegisteredRecommenderException(sprintf('The Recommendation engine "%s" is not registered in the Recommender Service',
-                $recommender));
+        if (! array_key_exists($recommender, $this->recommenders)) {
+            throw new NotRegisteredRecommenderException(sprintf(
+                'The Recommendation engine "%s" is not registered in the Recommender Service',
+                $recommender
+            ));
         }
 
         return $this->recommenders[$recommender]->buildModel();
     }
 
     public function weightedCosine(): IRecommender
     {
-        if (!in_array(WeightedCosine::class, $this->recommenders)) {
+        if (! in_array(WeightedCosine::class, $this->recommenders)) {
             $this->registerRecommender(WeightedCosine::class);
         }
 
@@ -122,7 +130,7 @@ public function weightedCosine(): IRecommender
 
     public function cosine(): IRecommender
     {
-        if (!in_array(Cosine::class, $this->recommenders)) {
+        if (! in_array(Cosine::class, $this->recommenders)) {
             $this->registerRecommender(Cosine::class);
         }
 
diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -7,24 +7,24 @@
         "user1" => [
             "squid" => 1,
             "cuttlefish" => 0.5,
-            "octopus" => 0.2
+            "octopus" => 0.2,
         ],
         "user2" => [
             "squid" => 1,
             "octopus" => 0.5,
-            "nautilus" => 0.2
+            "nautilus" => 0.2,
         ],
         "user3" => [
             "squid" => 0.2,
             "octopus" => 1,
             "cuttlefish" => 0.4,
-            "nautilus" => 0.4
+            "nautilus" => 0.4,
         ],
         "user4" => [
             "cuttlefish" => 0.9,
             "octopus" => 0.4,
-            "nautilus" => 0.5
-        ]
+            "nautilus" => 0.5,
+        ],
     ]);
 
     // Create an instance
@@ -35,12 +35,12 @@
 
     // Predict future ratings
     $results = $recommender->predict([
-        'squid' => 0.4
+        'squid' => 0.4,
     ]);
 
     expect($results)->toBe([
         "cuttlefish" => 0.25,
         "octopus" => 0.23,
-        "nautilus" => 0.1
+        "nautilus" => 0.1,
     ]);
 });
diff --git a/tests/RecommenderServiceTest.php b/tests/RecommenderServiceTest.php
@@ -27,7 +27,7 @@
     $recommenderService = new RecommenderService($dataset);
 
     // instance of cosine
-    $class = new class() implements IRecommender {
+    $class = new class () implements IRecommender {
         public function name(): string
         {
             return 'Test Recommender';

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Check Package`
	`1`	`+name: packagist`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`schedule:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Tests`
	`1`	`+name: tests`
`2`	`2`
`3`	`3`	`on: [push, pull_request]`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function setDataset(array $dataset = []): self`
`73`	`73`
`74`	`74`	`public function weightedSlopeone(): IRecommender`
`75`	`75`	`{`
`76`		`- if (!in_array(WeightedSlopeone::class, $this->recommenders)) {`
	`76`	`+ if (! in_array(WeightedSlopeone::class, $this->recommenders)) {`
`77`	`77`	`$this->registerRecommender(WeightedSlopeone::class);`
`78`	`78`	`}`
`79`	`79`
`@@ -85,16 +85,22 @@ public function registerRecommender(string $recommender): self`
`85`	`85`	`try {`
`86`	`86`	`$rf = new ReflectionClass($recommender);`
`87`	`87`	`} catch (ReflectionException $e) {`
`88`		`- throw new NotSupportedSchemeException(sprintf('Recommendation engine "%s" must implement "%s" interface',`
`89`		`- $recommender, IRecommender::class));`
	`88`	`+ throw new NotSupportedSchemeException(sprintf(`
	`89`	`+ 'Recommendation engine "%s" must implement "%s" interface',`
	`90`	`+ $recommender,`
	`91`	`+ IRecommender::class`
	`92`	`+ ));`
`90`	`93`	`}`
`91`	`94`
`92`		`- if (!$rf->implementsInterface(IRecommender::class)) {`
`93`		`- throw new NotSupportedSchemeException(sprintf('Recommendation engine "%s" must implement "%s" interface',`
`94`		`- $recommender, IRecommender::class));`
	`95`	`+ if (! $rf->implementsInterface(IRecommender::class)) {`
	`96`	`+ throw new NotSupportedSchemeException(sprintf(`
	`97`	`+ 'Recommendation engine "%s" must implement "%s" interface',`
	`98`	`+ $recommender,`
	`99`	`+ IRecommender::class`
	`100`	`+ ));`
`95`	`101`	`}`
`96`	`102`
`97`		`- if (!in_array($recommender, $this->recommenders)) {`
	`103`	`+ if (! in_array($recommender, $this->recommenders)) {`
`98`	`104`	`$this->recommenders[$recommender] = new $recommender($this->dataset);`
`99`	`105`	`}`
`100`	`106`
`@@ -103,17 +109,19 @@ public function registerRecommender(string $recommender): self`
`103`	`109`
`104`	`110`	`public function getRecommender(string $recommender): IRecommender`
`105`	`111`	`{`
`106`		`- if (!array_key_exists($recommender, $this->recommenders)) {`
`107`		`- throw new NotRegisteredRecommenderException(sprintf('The Recommendation engine "%s" is not registered in the Recommender Service',`
`108`		`- $recommender));`
	`112`	`+ if (! array_key_exists($recommender, $this->recommenders)) {`
	`113`	`+ throw new NotRegisteredRecommenderException(sprintf(`
	`114`	`+ 'The Recommendation engine "%s" is not registered in the Recommender Service',`
	`115`	`+ $recommender`
	`116`	`+ ));`
`109`	`117`	`}`
`110`	`118`
`111`	`119`	`return $this->recommenders[$recommender]->buildModel();`
`112`	`120`	`}`
`113`	`121`
`114`	`122`	`public function weightedCosine(): IRecommender`
`115`	`123`	`{`
`116`		`- if (!in_array(WeightedCosine::class, $this->recommenders)) {`
	`124`	`+ if (! in_array(WeightedCosine::class, $this->recommenders)) {`
`117`	`125`	`$this->registerRecommender(WeightedCosine::class);`
`118`	`126`	`}`
`119`	`127`
`@@ -122,7 +130,7 @@ public function weightedCosine(): IRecommender`
`122`	`130`
`123`	`131`	`public function cosine(): IRecommender`
`124`	`132`	`{`
`125`		`- if (!in_array(Cosine::class, $this->recommenders)) {`
	`133`	`+ if (! in_array(Cosine::class, $this->recommenders)) {`
`126`	`134`	`$this->registerRecommender(Cosine::class);`
`127`	`135`	`}`
`128`	`136`