Merge pull request #19 from bizley/quill-local-composer

3.0.0

Author: Bizley

.github/workflows/tests.yml

@@ -1,6 +1,6 @@
 name: Tests
 
-on: [push, pull_request]
+on: [pull_request]
 
 env:
   DEFAULT_COMPOSER_FLAGS: "--prefer-dist --no-interaction --no-progress --optimize-autoloader"
@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.0', '7.1', '7.2', '7.3', '7.4']
+        php: ['7.1', '7.2', '7.3', '7.4']
 
     steps:
       - name: Checkout
@@ -34,15 +34,5 @@ jobs:
           restore-keys: ${{ runner.os }}-composer-
       - name: Install dependencies
         run: composer update $DEFAULT_COMPOSER_FLAGS
-      - name: PHP Unit tests for PHP 7.4
-        run: vendor/bin/phpunit -v --coverage-clover coverage.clover
-        if: matrix.php == '7.4'
-      - name: PHP Unit tests for PHP 7.0 - 7.3
-        run: vendor/bin/phpunit -v
-        if: matrix.php == '7.3' || matrix.php == '7.2' || matrix.php == '7.1' || matrix.php == '7.0'
-      - name: Code coverage
-        run: |
-          wget https://scrutinizer-ci.com/ocular.phar
-          php ocular.phar code-coverage:upload --format=php-clover coverage.clover
-        if: matrix.php == '7.4'
-        continue-on-error: true # if is fork
+      - name: PHP Unit tests
+        run: vendor/bin/phpunit --verbose

README.md

@@ -3,9 +3,6 @@
 ![Latest Stable Version](https://img.shields.io/packagist/v/bizley/quill.svg)
 [![Total Downloads](https://img.shields.io/packagist/dt/bizley/quill.svg)](https://packagist.org/packages/bizley/quill)
 ![License](https://img.shields.io/packagist/l/bizley/quill.svg)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bizley/yii2-quill/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bizley/yii2-quill/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/bizley/yii2-quill/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/bizley/yii2-quill/?branch=master)
-[![Build Status](https://scrutinizer-ci.com/g/bizley/yii2-quill/badges/build.png?b=master)](https://scrutinizer-ci.com/g/bizley/yii2-quill/build-status/master)
 
 *Yii 2 implementation of Quill, modern WYSIWYG editor.*
 
@@ -24,15 +21,15 @@ You can find Quill at https://quilljs.com/
 Run console command
 
 ```
-composer require bizley/quill:^2.7
+composer require bizley/quill:^3.0
 ```
 
 Or add the package to your `composer.json`:
 
 ```json
 {
     "require": {
-        "bizley/quill": "^2.7"
+        "bizley/quill": "^3.0"
     }
 }
 ```
@@ -109,7 +106,7 @@ lines are added.
 
 By default Quill is provided through the CDN (https://cdn.quilljs.com). You can change the Quill's version set with the 
 current yii2-quill's release by changing `'quillVersion'` parameter but some options may not work correctly in this case. 
-Starting from version 2.7.0 you can use local assets for Quill provided through NPM packet manager - to do 
+Starting from version 3.0.0 you can use local assets for Quill provided through NPM packet manager - to do 
 so run
 
 ```
@@ -163,7 +160,7 @@ To add this option configure widget with [Formula module](https://quilljs.com/do
 ```
 
 By default KaTeX is provided through the CDN (https://cdn.jsdelivr.net). You can change the version of KaTeX by setting 
-the `'katexVersion'` parameter. Starting from version 2.7.0 you can use local assets for KaTeX provided through NPM 
+the `'katexVersion'` parameter. Starting from version 3.0.0 you can use local assets for KaTeX provided through NPM 
 packet manager - to do so run
 
 ```
@@ -197,7 +194,7 @@ To add this option configure widget with [Syntax Highlighter module](https://qui
 ```
 
 By default highlight.js is provided through the CDN (https://cdn.jsdelivr.net). You can change the version of 
-highlight.js by setting the `'highlightVersion'` parameter. Starting from version 2.7.0 you can use local assets for 
+highlight.js by setting the `'highlightVersion'` parameter. Starting from version 3.0.0 you can use local assets for 
 highlight.js provided through NPM packet manager - to do so run
 
 ```

composer.json

@@ -2,7 +2,7 @@
   "name": "bizley/quill",
   "description": "Quill editor implementation for Yii 2.",
   "type": "yii2-extension",
-  "keywords": ["yii2","quill","wysiwyg","widget","editor"],
+  "keywords": ["yii2","quill","wysiwyg","widget","editor","katex","highlight.js"],
   "license": "Apache-2.0",
   "authors": [
     {
@@ -14,7 +14,7 @@
     "source": "https://github.com/bizley/yii2-quill"
   },
   "require": {
-    "php": "^7.0",
+    "php": "^7.1",
     "yiisoft/yii2": "^2.0.0"
   },
   "require-dev": {
@@ -25,8 +25,9 @@
     "roave/security-advisories": "dev-master"
   },
   "suggest": {
-    "npm-asset/highlight.js": "To use syntax highlighting",
-    "npm-asset/katex": "To use formula module"
+    "npm-asset/highlight.js": "For local highlight.js assets",
+    "npm-asset/katex": "For local KaTeX assets",
+    "npm-asset/quill": "For local Quill assets"
   },
   "autoload": {
     "psr-4": {

src/Quill.php

@@ -29,7 +29,7 @@
  * See the documentation for more details.
  *
  * @author Paweł Bizley Brzozowski
- * @version 2.7.0
+ * @version 3.0.0
  * @license Apache 2.0
  * https://github.com/bizley/yii2-quill
  *
@@ -77,7 +77,7 @@ class Quill extends InputWidget
      * ['bold' => '<i class="fa fa-bold" aria-hidden="true"></i>']
      * will overwrite default icon for "bold" button.
      * @see https://github.com/quilljs/quill/issues/1099
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public $icons = [];
 
@@ -174,7 +174,7 @@ class Quill extends InputWidget
      * See https://github.com/isagalaev/highlight.js/tree/master/src/styles
      * Used when Syntax module is added.
      * Provide just the name of stylesheet (skip ".css" or ".min.css").
-     * Since 2.7.0 this property works also for $localAssets set to true.
+     * Since 3.0.0 this property works also for $localAssets set to true.
      * @since 2.0.0
      */
     public $highlightStyle = 'default';
@@ -254,7 +254,7 @@ public function init()
     /**
      * Returns Quill configuration.
      * @return array
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function getConfig()
     {
@@ -265,7 +265,7 @@ public function getConfig()
      * Adds new value to Quill configuration.
      * @param string $name
      * @param mixed $value
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function addConfig($name, $value)
     {
@@ -276,7 +276,7 @@ public function addConfig($name, $value)
      * Adds new module to Quill configuration.
      * @param string $name
      * @param mixed $config
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function addModule($name, $config)
     {
@@ -298,7 +298,7 @@ public function addModule($name, $config)
     /**
      * Sets Quill configuration.
      * @param array $config
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function setConfig($config)
     {
@@ -311,7 +311,7 @@ public function setConfig($config)
     /**
      * Checks whether the Katex needs to be added.
      * @return bool
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function isKatex()
     {
@@ -321,11 +321,11 @@ public function isKatex()
     /**
      * Sets Katex flag.
      * @param bool $katex
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function setKatex($katex)
     {
-        $this->_katex = (bool)$katex;
+        $this->_katex = (bool) $katex;
     }
 
     /** @var bool */
@@ -334,7 +334,7 @@ public function setKatex($katex)
     /**
      * Checks whether the Highlight.js needs to be added.
      * @return bool
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function isHighlightJs()
     {
@@ -344,11 +344,11 @@ public function isHighlightJs()
     /**
      * Sets Highlight.js flag.
      * @param bool $highlightJs
-     * @since 2.7.0
+     * @since 3.0.0
      */
     public function setHighlightJs($highlightJs)
     {
-        $this->_highlightJs = (bool)$highlightJs;
+        $this->_highlightJs = (bool) $highlightJs;
     }
 
     /** Prepares Quill configuration */
@@ -389,7 +389,7 @@ protected function prepareOptions()
                 $this->addConfig('formats', $this->formats);
             }
 
-            if ($this->readOnly !== null && (bool)$this->readOnly) {
+            if ($this->readOnly !== null && (bool) $this->readOnly) {
                 $this->addConfig('readOnly', true);
             }