Validate composer.json 👷 and more...

mehdichaouch · mehdichaouch · commit 5867f10e7cf5 · 2022-03-21T00:29:36.000+01:00
diff --git a/Block/Snowflake.php b/Block/Snowflake.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
 declare(strict_types=1);
 
 namespace Opengento\Snowflake\Block;
@@ -9,62 +13,65 @@
 
 class Snowflake extends Template
 {
-    protected ScopeConfigInterface $snowflakeConfig;
-    protected SnowflakeConfig $config;
+    protected SnowflakeConfig $snowflakeConfig;
+    protected ScopeConfigInterface $scopeConfig;
 
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        SnowflakeConfig $snowflakeConfig,
         Template\Context $context,
+        SnowflakeConfig $snowflakeConfig,
         array $data = []
     ) {
-        $this->SnowflakeConfig = $snowflakeConfig;
-        $this->scopeConfig = $scopeConfig;
+        $this->snowflakeConfig = $snowflakeConfig;
         parent::__construct($context, $data);
     }
 
     public function getSnowflakeChar(): string
     {
-        return $this->SnowflakeConfig->getSnowflakeChar();
+        return $this->snowflakeConfig->getSnowflakeChar();
+    }
+
+    public function getSnowflakeVSpeed(): string
+    {
+        return $this->snowflakeConfig->getSnowflakeVSpeed();
     }
 
-    public function getSnowflakeVSpeed() : string
+    public function getSnowflakeHSpeed(): string
     {
-        return $this->SnowflakeConfig->getSnowflakeVSpeed();
+        return $this->snowflakeConfig->getSnowflakeHSpeed();
     }
 
-    public function getSnowflakeHSpeed() : string
+    public function getSnowflakeRotSpeed(): string
     {
-        return $this->SnowflakeConfig->getSnowflakeHSpeed();
+        return $this->snowflakeConfig->getSnowflakeRotSpeed();
     }
 
-    public function getSnowflakeRotSpeed() : string
+    public function getSnowflakeQty(): int
     {
-        return $this->SnowflakeConfig->getSnowflakeRotSpeed();
+        return (int)$this->snowflakeConfig->getSnowflakeQty();
     }
 
-    public function getSnowflakeQty() : int
+    public function getSnowflakeMinSize(): int
     {
-        return (int)$this->SnowflakeConfig->getSnowflakeQty();
+        return (int)$this->snowflakeConfig->getSnowflakeMinSize();
     }
 
-    public function getSnowflakeMinSize() : int
+    public function getSnowflakeMaxSize(): int
     {
-        return (int)$this->SnowflakeConfig->getSnowflakeMinSize();
+        return (int)$this->snowflakeConfig->getSnowflakeMaxSize();
     }
 
-    public function getSnowflakeMaxSize() : int
+    public function isForceSnow(): bool
     {
-        return (int)$this->SnowflakeConfig->getSnowflakeMaxSize();
+        return $this->snowflakeConfig->isForceSnow();
     }
 
-    public function getSnowflakeForce() : string
+    public function isApiEnable(): bool
     {
-        return $this->SnowflakeConfig->getSnowflakeForce();
+        return $this->snowflakeConfig->isApiEnable();
     }
 
     public function getAjaxUrl(): string
     {
-        return $this->SnowflakeConfig->getAjaxUrl();
+        return $this->snowflakeConfig->getAjaxUrl();
     }
 }
diff --git a/Controller/Api/Meteo.php b/Controller/Api/Meteo.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Opengento\Snowflake\Controller\Index;
+namespace Opengento\Snowflake\Controller\Api;
 
 use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\Action\Context;
@@ -32,11 +32,15 @@ public function __construct(
      */
     public function execute()
     {
-        $lat = $this->getRequest()->getParam('lat');
-        $lon = $this->getRequest()->getParam('lon');
+        $isSnowing = ['is_snowing' => '0'];
 
-        return $this->resultJsonFactory->create()->setData(
-            ['is_snowing' => $this->api->isSnowing($lat, $lon)]
-        );
+        $lat = $this->getRequest()->getParam('lat') ?? '';
+        $lon = $this->getRequest()->getParam('lon') ?? '';
+
+        if ($lat && $lon) {
+            $isSnowing = ['is_snowing' => $this->api->isSnowing($lat, $lon)];
+        }
+
+        return $this->resultJsonFactory->create()->setData($isSnowing);
     }
 }
diff --git a/Model/Config/Backend/EmojiConverter.php b/Model/Config/Backend/EmojiConverter.php
@@ -1,11 +1,16 @@
 <?php
-declare(strict_types = 1);
+/**
+ * Copyright © OpenGento, All rights reserved.
+ * See LICENSE bundled with this library for license details.
+ */
+declare(strict_types=1);
 
 namespace Opengento\Snowflake\Model\Config\Backend;
 
-use Magento\Config\Model\Config\Backend\Serialized\ArraySerialized;
+use Magento\Framework\App\Config\Data\ProcessorInterface;
+use Magento\Framework\App\Config\Value;
 
-class EmojiConverter extends \Magento\Framework\App\Config\Value  implements \Magento\Framework\App\Config\Data\ProcessorInterface
+class EmojiConverter extends Value implements ProcessorInterface
 {
     /**
      * Unset array element with '__empty' key
diff --git a/Model/Config/Snowflake.php b/Model/Config/Snowflake.php
@@ -12,18 +12,19 @@
 
 class Snowflake
 {
-    public const AJAX_URL = 'opengento_snowflake/index/meteo';
+    public const AJAX_URL = 'opengento_snowflake/api/meteo';
 
-    private const CONFIG_PATH_SNOWFLAKE_ENABLE = 'opengento/snowflake/enable';
+    private const CONFIG_PATH_SNOWFLAKE_ENABLE = 'snowflake/general/enable';
     private const CONFIG_PATH_SNOWFLAKE_CHAR  = 'snowflake/general/icon';
     private const CONFIG_PATH_SNOWFLAKE_V_SPEED  = 'snowflake/general/vspeed';
     private const CONFIG_PATH_SNOWFLAKE_H_SPEED  = 'snowflake/general/hspeed';
     private const CONFIG_PATH_SNOWFLAKE_ROT_SPEED  = 'snowflake/general/rotspeed';
-    private const CONFIG_PATH_SNOWFLAKE_OPENWEATHERMAP_API_KEY = 'opengento/snowflake/api_key';
+    private const CONFIG_PATH_SNOWFLAKE_OPENWEATHERMAP_ENABLE = 'snowflake/general/enable_api';
+    private const CONFIG_PATH_SNOWFLAKE_OPENWEATHERMAP_API_KEY = 'snowflake/general/api_key';
     private const CONFIG_PATH_SNOWFLAKE_MIN_SIZE = 'snowflake/general/max_size';
     private const CONFIG_PATH_SNOWFLAKE_MAX_SIZE = 'snowflake/general/min_size';
     private const CONFIG_PATH_SNOWFLAKE_QTY = 'snowflake/general/qty';
-    private const CONFIG_PATH_SNOWFLAKE_FORCE = 'snowflake/api/force';
+    private const CONFIG_PATH_SNOWFLAKE_FORCE = 'snowflake/general/force';
 
     private ScopeConfigInterface $scopeConfig;
 
@@ -72,9 +73,18 @@ public function getSnowflakeMaxSize(?int $scopeId = null): string
         return $this->scopeConfig->getValue(self::CONFIG_PATH_SNOWFLAKE_MAX_SIZE, ScopeInterface::SCOPE_STORE, $scopeId) ?? '';
     }
 
-    public function getSnowflakeForce(?int $scopeId = null): string
+    public function isForceSnow(?int $scopeId = null): bool
     {
-        return (string)$this->scopeConfig->getValue(self::CONFIG_PATH_SNOWFLAKE_FORCE, ScopeInterface::SCOPE_STORE, $scopeId);
+        return $this->scopeConfig->isSetFlag(self::CONFIG_PATH_SNOWFLAKE_FORCE, ScopeInterface::SCOPE_STORE, $scopeId);
+    }
+
+    public function isApiEnable(?int $scopeId = null): bool
+    {
+        return $this->scopeConfig->isSetFlag(
+            self::CONFIG_PATH_SNOWFLAKE_OPENWEATHERMAP_ENABLE,
+            ScopeInterface::SCOPE_STORE,
+            $scopeId
+        );
     }
 
     public function getApiKey(?int $scopeId = null): string
diff --git a/README.md b/README.md
@@ -5,11 +5,11 @@
 [![Packagist](https://img.shields.io/packagist/dt/opengento/module-snowflake.svg?style=flat-square)](https://packagist.org/packages/opengento/module-snowflake/stats)
 [![Packagist](https://img.shields.io/packagist/dm/opengento/module-snowflake.svg?style=flat-square)](https://packagist.org/packages/opengento/module-snowflake/stats)
 
-This module adds ❄️️ based on local meteo.
+This fun module adds ❄️️ on your website all the time or based on your visitor outside weather.
 
 - [Setup](#setup)
     - [Composer installation](#composer-installation)
-    - [Setup the module](#setup-the-snowflake)
+    - [Setup the module](#setup-the-module)
 - [Features](#features)
 - [Settings](#settings)
 - [Documentation](#documentation)
@@ -21,19 +21,19 @@ This module adds ❄️️ based on local meteo.
 
 Magento 2 Open Source or Commerce edition is required.
 
-###  Composer installation
+### Composer installation
 
 Run the following composer command:
 
-```
+```shell
 composer require opengento/module-snowflake
 ```
 
 ### Setup the module
 
 Run the following magento command:
 
-```
+```shell
 bin/magento setup:upgrade
 ```
 
@@ -45,21 +45,27 @@ bin/magento setup:upgrade
 
 Do you like the snow? Do you like to feel the same weather on your favorite website? Try this plugin and get the snow along your local meteo!
 
-## Settings
+Require: [OpenWeatherMap API key](https://openweathermap.org/).
+
+### Force Snowflake
 
-The configuration for this module is available in `Stores > Configuration > General > Snowflake`.
+It doesn't snow everywhere, so you can force snow.
 
-## Documentation
+### Hacking Snowflake
+
+You don't like snow, no problem, Snowflake can make it rain [cookies](https://twitter.com/MehdiChch/status/1505649692755079169), [hot-dog](https://twitter.com/MehdiChch/status/1505258061249884160) or whatever you want.
+
+## Settings
 
-Enable the module in the configuration panel to enable the snowflake based on the local meteo.
+The configuration for this module is available in `Stores > Configuration > General > ❄️ Snowflake`.
 
 ## Support
 
 Raise a new [request](https://github.com/opengento/magento2-snowflake/issues) to the issue tracker.
 
 ## Authors
 
-- **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)
+- **OpenGento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)
 - **Contributors** - *Contributor* - [![GitHub contributors](https://img.shields.io/github/contributors/opengento/magento2-snowflake.svg?style=flat-square)](https://github.com/opengento/magento2-snowflake/graphs/contributors)
 
 ## License
diff --git a/Service/OpenWeatherMapApi.php b/Service/OpenWeatherMapApi.php
@@ -14,6 +14,10 @@
 
 class OpenWeatherMapApi
 {
+    // Manage all Group 6xx: Snow
+    // https://openweathermap.org/weather-conditions
+    public const WEATHER_CONDITION = 'snow';
+
     // Language of data (try your own language here!):
     protected string $lang = 'en';
 
@@ -31,7 +35,7 @@ public function __construct(
     /**
      * @throws OpenWeatherMap\Exception
      */
-    public function isSnowing($lat, $lon): bool
+    public function isSnowing(string $lat, string $lon): bool
     {
         $apiKey = $this->config->getApiKey();
 
@@ -42,6 +46,6 @@ public function isSnowing($lat, $lon): bool
 
         $weather = $owm->getWeather(['lat' => $lat, 'lon' => $lon], $this->lang, $this->units);
 
-        return 'snow' === $weather->weather->description;
+        return static::WEATHER_CONDITION === $weather->weather->description;
     }
 }
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
diff --git a/etc/config.xml b/etc/config.xml
diff --git a/view/frontend/templates/snowflake.phtml b/view/frontend/templates/snowflake.phtml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`	`1`	`<?php`
	`2`	`+/**`
	`3`	`+ * Copyright © OpenGento, All rights reserved.`
	`4`	`+ * See LICENSE bundled with this library for license details.`
	`5`	`+ */`
`2`	`6`	`declare(strict_types=1);`
`3`	`7`
`4`	`8`	`namespace Opengento\Snowflake\Block;`
`@@ -9,62 +13,65 @@`
`9`	`13`
`10`	`14`	`class Snowflake extends Template`
`11`	`15`	`{`
`12`		`- protected ScopeConfigInterface $snowflakeConfig;`
`13`		`- protected SnowflakeConfig $config;`
	`16`	`+ protected SnowflakeConfig $snowflakeConfig;`
	`17`	`+ protected ScopeConfigInterface $scopeConfig;`
`14`	`18`
`15`	`19`	`public function __construct(`
`16`		`- ScopeConfigInterface $scopeConfig,`
`17`		`- SnowflakeConfig $snowflakeConfig,`
`18`	`20`	`Template\Context $context,`
	`21`	`+ SnowflakeConfig $snowflakeConfig,`
`19`	`22`	`array $data = []`
`20`	`23`	`) {`
`21`		`- $this->SnowflakeConfig = $snowflakeConfig;`
`22`		`- $this->scopeConfig = $scopeConfig;`
	`24`	`+ $this->snowflakeConfig = $snowflakeConfig;`
`23`	`25`	`parent::__construct($context, $data);`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`public function getSnowflakeChar(): string`
`27`	`29`	`{`
`28`		`- return $this->SnowflakeConfig->getSnowflakeChar();`
	`30`	`+ return $this->snowflakeConfig->getSnowflakeChar();`
	`31`	`+ }`
	`32`	`+`
	`33`	`+ public function getSnowflakeVSpeed(): string`
	`34`	`+ {`
	`35`	`+ return $this->snowflakeConfig->getSnowflakeVSpeed();`
`29`	`36`	`}`
`30`	`37`
`31`		`- public function getSnowflakeVSpeed() : string`
	`38`	`+ public function getSnowflakeHSpeed(): string`
`32`	`39`	`{`
`33`		`- return $this->SnowflakeConfig->getSnowflakeVSpeed();`
	`40`	`+ return $this->snowflakeConfig->getSnowflakeHSpeed();`
`34`	`41`	`}`
`35`	`42`
`36`		`- public function getSnowflakeHSpeed() : string`
	`43`	`+ public function getSnowflakeRotSpeed(): string`
`37`	`44`	`{`
`38`		`- return $this->SnowflakeConfig->getSnowflakeHSpeed();`
	`45`	`+ return $this->snowflakeConfig->getSnowflakeRotSpeed();`
`39`	`46`	`}`
`40`	`47`
`41`		`- public function getSnowflakeRotSpeed() : string`
	`48`	`+ public function getSnowflakeQty(): int`
`42`	`49`	`{`
`43`		`- return $this->SnowflakeConfig->getSnowflakeRotSpeed();`
	`50`	`+ return (int)$this->snowflakeConfig->getSnowflakeQty();`
`44`	`51`	`}`
`45`	`52`
`46`		`- public function getSnowflakeQty() : int`
	`53`	`+ public function getSnowflakeMinSize(): int`
`47`	`54`	`{`
`48`		`- return (int)$this->SnowflakeConfig->getSnowflakeQty();`
	`55`	`+ return (int)$this->snowflakeConfig->getSnowflakeMinSize();`
`49`	`56`	`}`
`50`	`57`
`51`		`- public function getSnowflakeMinSize() : int`
	`58`	`+ public function getSnowflakeMaxSize(): int`
`52`	`59`	`{`
`53`		`- return (int)$this->SnowflakeConfig->getSnowflakeMinSize();`
	`60`	`+ return (int)$this->snowflakeConfig->getSnowflakeMaxSize();`
`54`	`61`	`}`
`55`	`62`
`56`		`- public function getSnowflakeMaxSize() : int`
	`63`	`+ public function isForceSnow(): bool`
`57`	`64`	`{`
`58`		`- return (int)$this->SnowflakeConfig->getSnowflakeMaxSize();`
	`65`	`+ return $this->snowflakeConfig->isForceSnow();`
`59`	`66`	`}`
`60`	`67`
`61`		`- public function getSnowflakeForce() : string`
	`68`	`+ public function isApiEnable(): bool`
`62`	`69`	`{`
`63`		`- return $this->SnowflakeConfig->getSnowflakeForce();`
	`70`	`+ return $this->snowflakeConfig->isApiEnable();`
`64`	`71`	`}`
`65`	`72`
`66`	`73`	`public function getAjaxUrl(): string`
`67`	`74`	`{`
`68`		`- return $this->SnowflakeConfig->getAjaxUrl();`
	`75`	`+ return $this->snowflakeConfig->getAjaxUrl();`
`69`	`76`	`}`
`70`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,10 @@`
`14`	`14`
`15`	`15`	`class OpenWeatherMapApi`
`16`	`16`	`{`
	`17`	`+ // Manage all Group 6xx: Snow`
	`18`	`+ // https://openweathermap.org/weather-conditions`
	`19`	`+ public const WEATHER_CONDITION = 'snow';`
	`20`	`+`
`17`	`21`	`// Language of data (try your own language here!):`
`18`	`22`	`protected string $lang = 'en';`
`19`	`23`
`@@ -31,7 +35,7 @@ public function __construct(`
`31`	`35`	`/**`
`32`	`36`	`* @throws OpenWeatherMap\Exception`
`33`	`37`	`*/`
`34`		`- public function isSnowing($lat, $lon): bool`
	`38`	`+ public function isSnowing(string $lat, string $lon): bool`
`35`	`39`	`{`
`36`	`40`	`$apiKey = $this->config->getApiKey();`
`37`	`41`
`@@ -42,6 +46,6 @@ public function isSnowing($lat, $lon): bool`
`42`	`46`
`43`	`47`	`$weather = $owm->getWeather(['lat' => $lat, 'lon' => $lon], $this->lang, $this->units);`
`44`	`48`
`45`		`- return 'snow' === $weather->weather->description;`
	`49`	`+ return static::WEATHER_CONDITION === $weather->weather->description;`
`46`	`50`	`}`
`47`	`51`	`}`