Initial commit (#1)

yii2-extensions · Oct 26, 2023 · b1eb2d6 · b1eb2d6
1 parent 352d72e
commit b1eb2d6
Show file tree

Hide file tree

Showing 20 changed files with 1,030 additions and 75 deletions.
diff --git a/.github/workflows/build.yml → .github/workflows/gmagick.yml b/.github/workflows/build.yml → .github/workflows/gmagick.yml
@@ -19,12 +19,13 @@ on:
       - 'infection.json.dist'
       - 'psalm.xml'
 
-name: build
+name: gmagick
 
 jobs:
   phpunit:
     uses: yiisoft/actions/.github/workflows/phpunit.yml@master
     with:
+      extensions: intl, gmagick
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-

diff --git a/.github/workflows/imagick.yml b/.github/workflows/imagick.yml
@@ -0,0 +1,32 @@
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'psalm.xml'
+
+  push:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'psalm.xml'
+
+name: imagick
+
+jobs:
+  phpunit:
+    uses: yiisoft/actions/.github/workflows/phpunit.yml@master
+    with:
+      extensions: intl, imagick
+      os: >-
+        ['ubuntu-latest', 'windows-latest']
+      php: >-
+        ['8.1', '8.2', '8.3']
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <p align="center">
-    <a href="https://github.com/yii2-extensions/template" target="_blank">
+    <a href="https://github.com/yii2-extensions/imagine" target="_blank">
         <img src="https://www.yiiframework.com/image/yii_logo_light.svg" height="100px;">
     </a>
-    <h1 align="center">Yii2-Template.</h1>
+    <h1 align="center">Imagine</h1>
     <br>
 </p>
 
@@ -13,32 +13,57 @@
     <a href="https://github.com/yiisoft/yii2/tree/2.2" target="_blank">
         <img src="https://img.shields.io/badge/Yii2%20version-2.2-blue" alt="yii2-version">
     </a>
-    <a href="https://github.com/yii2-extensions/template/actions/workflows/build.yml" target="_blank">
-        <img src="https://github.com/yii2-extensions/template/actions/workflows/build.yml/badge.svg" alt="PHPUnit">
+    <a href="https://github.com/yii2-extensions/imagine/actions/workflows/build.yml" target="_blank">
+        <img src="https://github.com/yii2-extensions/imagine/actions/workflows/build.yml/badge.svg" alt="PHPUnit">
     </a>
-    <a href="https://codecov.io/gh/yii2-extensions/template" target="_blank">
-        <img src="https://codecov.io/gh/yii2-extensions/template/branch/main/graph/badge.svg?token=MF0XUGVLYC" alt="Codecov">
-    </a>
-    <a href="https://github.com/yii2-extensions/template/actions/workflows/static.yml" target="_blank">
+    <a href="https://codecov.io/gh/yii2-extensions/imagine" target="_blank"> 
+        <img src="https://codecov.io/gh/yii2-extensions/imagine/graph/badge.svg?token=Sx1GlGe8n2" alt="Codecov"> 
+    </a>    
+    <a href="https://github.com/yii2-extensions/imagine/actions/workflows/static.yml" target="_blank">
         <img src="https://github.com/yii2-extensions/gii/actions/workflows/static.yml/badge.svg" alt="PHPStan">
     </a>
-    <a href="https://github.com/yii2-extensions/template/actions/workflows/static.yml" target="_blank">
-        <img src="https://img.shields.io/badge/PHPStan%20level-2-blue" alt="PHPStan level">
-    </a>    
-    <a href="https://github.styleci.io/repos/698621511?branch=main" target="_blank">
-        <img src="https://github.styleci.io/repos/698621511/shield?branch=main" alt="Code style">
+    <a href="https://github.com/yii2-extensions/imagine/actions/workflows/static.yml" target="_blank">
+        <img src="https://img.shields.io/badge/PHPStan%20level-3-blue" alt="PHPStan level">
+    </a>
+    <a href="https://github.styleci.io/repos/708447136?branch=main" target="_blank">
+        <img src="https://github.styleci.io/repos/708447136/shield?branch=main" alt="Code style">
     </a>        
 </p>
 
-## Requirements
+## Installation
+
+The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
+
+Either run
 
-The minimun version of `PHP` required by this package is `PHP 8.1`.
+```
+php composer.phar require --dev --prefer-dist yii2-extensions/imagine
+```
 
-For install this package, you need [composer](https://getcomposer.org/).
+or add
+
+```
+"yii2-extensions/imagine": "dev-main"
+```
+
+to the require-dev section of your `composer.json` file.
 
 ## Usage
 
-[Check the documentation docs](/docs/README.md) to learn about usage.
+This extension is a wrapper to the [Imagine](https://imagine.readthedocs.org/) and also adds the most commonly used
+image manipulation methods.
+
+The following example shows how to use this extension:
+
+```php
+use yii\imagine\Image;
+
+// frame, rotate and save an image
+Image::frame('path/to/image.jpg', 5, '666', 0)
+    ->rotate(-8)
+    ->save('path/to/destination/image.jpg', ['jpeg_quality' => 50]);
+```
+
 
 ## Testing
 

diff --git a/composer.json b/composer.json
@@ -1,15 +1,19 @@
 {
-    "name": "yii2/template",
-    "type": "library",
-    "description": "_____",
+    "name": "yii2-extensions/imagine",
+    "type": "yii2-extension",
+    "description": "The Imagine integration for the Yii framework.",
     "keywords": [
-        "_____"
+        "yii2",
+        "imagine",
+        "image",
+        "helper"
     ],
     "license": "mit",
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
         "php": ">=8.1",
+        "imagine/imagine": "^1.3",
         "yiisoft/yii2": "^2.2"
     },
     "require-dev": {
@@ -19,12 +23,12 @@
     },
     "autoload": {
         "psr-4": {
-            "yii\\template\\": "src"
+            "yii\\imagine\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "yii\\template\\tests\\": "tests"
+            "yiiunit\\imagine\\": "tests"
         }
     },
     "extra": {

diff --git a/phpstan.neon b/phpstan.neon
@@ -8,7 +8,7 @@ parameters:
         - YII_ENV_PROD
         - YII_ENV_TEST
 
-    level: 2
+    level: 3
 
     paths:
         - src

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
-    bootstrap="vendor/autoload.php"
-    cacheDirectory=".phpunit.cache"
-    colors="true"
-    executionOrder="depends,defects"
-    failOnRisky="true"
-    failOnWarning="true"
-    stopOnFailure="false"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
+  bootstrap="tests/bootstrap.php"
+  cacheDirectory=".phpunit.cache"
+  colors="true"
+  executionOrder="depends,defects"
+  failOnRisky="true"
+  failOnWarning="true"
+  stopOnFailure="false"
 >
-    <testsuites>
-        <testsuite name="Template">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
+  <testsuites>
+    <testsuite name="Yii2-Imagine">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
 
-    <source>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </source>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>