chore(meta): update renovate.json

* Upgrade runner php to 8.3, phpunit to 11
* Fix tests, tweaked the code, added missing ext- to composer.json
* Fix exception related code smells

.editorconfig

@@ -0,0 +1,11 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4

.github/workflows/php.yml

@@ -0,0 +1,39 @@
+name: PHP Composer
+
+on:
+    push:
+        branches: ["master"]
+    pull_request:
+        branches: ["master"]
+
+permissions:
+    contents: read
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - uses: shivammathur/setup-php@1a18b2267f80291a81ca1d33e7c851fe09e7dfc4
+              with:
+                  php-version: "8.3"
+
+            - name: Validate composer.json and composer.lock
+              run: composer validate --strict
+
+            - name: Cache Composer packages
+              id: composer-cache
+              uses: actions/cache@v4
+              with:
+                  path: vendor
+                  key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+                  restore-keys: |
+                      ${{ runner.os }}-php-
+
+            - name: Install dependencies
+              run: composer install --prefer-dist --no-progress
+
+            - name: Run test suite
+              run: composer run-script test

.gitignore

@@ -1,2 +1,5 @@
 *.json
+composer.lock
 !composer.json
+vendor
+build

.travis.yml

@@ -0,0 +1,22 @@
+language: php
+php:
+    - 8.3
+    - nightly
+matrix:
+    allow_failures:
+        - php: nightly
+    fast_finish: true
+cache:
+    directories:
+        - $HOME/.composer/cache/files
+before_script:
+    - phpenv global "$TRAVIS_PHP_VERSION"
+    - composer config extra.platform.php $TRAVIS_PHP_VERSION
+    - composer require php-coveralls/php-coveralls
+install:
+    - flags="--ansi --prefer-dist --no-interaction --optimize-autoloader --no-suggest --no-progress"
+    - composer install $flags
+script:
+    - ./vendor/bin/phpunit -c phpunit.xml --coverage-clover build/logs/clover.xml
+after_script:
+    - php vendor/bin/coveralls -v

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ivuorinen@me.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ivuorinen@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 Ismo Vuorinen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,38 @@
-palette
+Palette [![Build Status](https://travis-ci.org/ivuorinen/palette.svg?branch=master)](https://travis-ci.org/ivuorinen/palette)
 =======
+
+Palette is a PHP class that takes your images and returns used colors, sorts them by usage and saves the results.
+
+## Usage ##
+
+After adding Palette to your ``composer.json`` file and installed to your vendor folder, you can use the class like this:
+
+### With default settings ###
+
+```php
+$image = "example/example.jpg";
+$palette = new \ivuorinen\Palette\Palette($image);
+print_r($palette->colorsArray);
+
+```
+
+### With custom settings ###
+
+```php
+$palette = new \ivuorinen\Palette\Palette();
+
+$palette->filename     = "example/example.jpg"; // Our image
+$palette->precision    = 10; // Precision of color collection
+$palette->returnColors = 10; // How many colors we want
+$palette->destination  = './data/' . md5($palette->filename) . '.json';
+
+// Do the work (same as ``Palette::run()``)
+$this->getPalette();
+$this->save(); // Not needed, but caching results <3
+
+// We now have ``./data/7233c3b944f5299c6983c77c94e75dce.json`` (if everything went smoothly)
+// and we can test against it before running palette generation. Which you should do really.
+
+print_r($palette->colorsArray);
+```
+

composer.json

@@ -1,6 +1,12 @@
 {
     "name": "ivuorinen/palette",
-    "keywords": ["image", "colors", "palette", "psr-2"],
+    "description": "Get most used colors from an image",
+    "keywords": [
+        "image",
+        "colors",
+        "palette",
+        "psr-2"
+    ],
     "homepage": "https://github.com/ivuorinen/palette",
     "type": "library",
     "license": "MIT",
@@ -14,12 +20,28 @@
         "source": "https://github.com/ivuorinen/palette",
         "issues": "https://github.com/ivuorinen/palette/issues"
     },
-    "require": {
+    "autoload": {
-        "php": ">=5.2.0"
+        "psr-4": {
-    },
+            "ivuorinen\\Palette\\": "src/"
-    "extra": {
-        "branch-alias": {
-            "dev-master": "master"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "ivuorinen\\Palette\\Tests\\": "tests/"
+        }
+    },
+    "require": {
+        "php": "^8.3",
+        "ext-gd": "*",
+        "ext-exif": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^11",
+        "squizlabs/php_codesniffer": "^3"
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "lint": "vendor/bin/phpcs",
+        "lint-fix": "vendor/bin/phpcbf"
     }
 }

example/example.php

@@ -1,49 +0,0 @@
-<?php
-error_reporting(E_ALL);
-require '../palette.php';
-
-$testimages_full_process = array(
-    'example.gif',
-    'example.jpg',
-    'example.png'
-);
-
-$testimages_controlled_process = array(
-    'example.gif',
-    'example.jpg',
-    'example.png'
-);
-
-echo "<h1>Full process (creates palette, saves to same dir as palette.php)</h1>\n";
-foreach ($testimages_full_process as $image) {
-
-    // Initiation with image triggers Palette::run()
-    $test = new \ivuorinen\Palette\Palette($image);
-
-    echo "<pre>"
-       . "Processing {$test->filename}\n"
-       . print_r($test->colorsArray, true)
-       . "</pre>\n";
-}
-
-echo "<h1>Controlled process</h1>\n";
-foreach ($testimages_controlled_process as $image) {
-    $test = new \ivuorinen\Palette\Palette();
-
-    // We set the image, precision and amount of colors to return
-    $test->filename     = $image;   // Full, or relative path to our image
-    $test->precision    = 10;       // Bigger is faster, smaller returns more colors
-    $test->returnColors = 5;        // How many colors we want in our array at most
-
-    // Get the colors as an array
-    $colors = $test->getPalette();
-
-    echo "<pre>"
-       . "Processing {$test->filename}\n"
-       . print_r($colors, true)
-       . "</pre>\n";
-
-}
-
-echo "<h1>This one fails</h1>\n";
-$test = new \ivuorinen\Palette\Palette('/bin/sh');

palette.php

@@ -1,313 +0,0 @@
-<?php
-/**
-* Palette
-* Parses image and returns most used colors
-*
-* PHP version 5
-*
-* @category Default
-* @package  Palette
-* @author   Ismo Vuorinen <ivuorinen@me.com>
-* @license  http://opensource.org/licenses/gpl-license.php GNU Public License
-* @link     https://github.com/ivuorinen/palette
-*/
-
-namespace ivuorinen\Palette;
-
-/**
- * Palette
- *
- * @category Default
- * @package  Palette
- * @author   Ismo Vuorinen <ivuorinen@me.com>
- * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
- * @link     https://github.com/ivuorinen/palette
- * @version  1.0.0
- * @example  example/example.php Usage examples
- **/
-class Palette
-{
-    /**
-     * Precision of palette, higher is more precise
-     * @var int
-     */
-    public $precision;
-
-    /**
-     * Number of colors to return
-     * @var int
-     */
-    public $returnColors;
-
-    /**
-     * Array of colors we use internally
-     * @var array
-     */
-    public $colorsArray;
-
-    /**
-     * Full path to image file name
-     * @var string
-     */
-    public $filename;
-
-    /**
-     * Destination for .json-file, full path and filename
-     *
-     * @var string
-     **/
-    public $destination;
-
-    /**
-     * Constructor
-     *
-     * If you have specified $filename, Palette::run() gets triggered.
-     * Palette::run() uses default parameters and processes given image
-     * and saves the result as an json-file to datafiles -folder.
-     *
-     * @param string $filename Full path to image
-     **/
-    public function __construct($filename = null)
-    {
-        // Define shortcut to directory separator
-        if (! defined('DS')) {
-            define("DS", DIRECTORY_SEPARATOR);
-        }
-
-        $this->precision    = 10;
-        $this->returnColors = 10;
-        $this->colorsArray  = array();
-        $this->filename     = $filename;
-        $this->destination  = dirname(__FILE__)
-                                . DS . 'datafiles'
-                                . DS . basename($filename) . '.json';
-
-        if (! empty($this->filename)) {
-            $this->run();
-        }
-    }
-
-    /**
-     * run the process
-     *
-     * if you want to change parameters you can init new Palette, then change
-     * settings and after that run the palette generation and saving
-     *
-     * @return bool Returns true always
-     */
-    public function run()
-    {
-        if (empty($this->destination)) {
-            throw new Exception("No destination provided, can't save.");
-        }
-
-        $this->getPalette();
-        $this->save();
-
-        return true;
-    }
-
-    /**
-     * getPalette
-     * Returns colors used in an image specified in $filename
-     *
-     * @return array|bool If we get array that has colors return the array
-     **/
-    public function getPalette()
-    {
-        // We check for input
-        try {
-            if (empty($this->filename)) {
-                return false;
-            }
-        } catch (\Exception $e) {
-            throw new \Exception("Image was not provided");
-        }
-
-        // We check for readability
-        try {
-            if (! is_readable($this->filename)) {
-                throw new \Exception("Image {$this->filename} is not readable");
-                return false;
-            }
-        } catch (\Exception $e) {
-            user_error($e->getMessage(), E_USER_ERROR);
-        }
-
-
-        $this->colorsArray = $this->countColors();
-
-        if (! empty($this->colorsArray) and is_array($this->colorsArray)) {
-            return $this->colorsArray;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * countColors returns an array of colors in the image
-     *
-     * @return array Array of colors sorted by times used
-     */
-    private function countColors()
-    {
-        $this->precision = max(1, abs((int) $this->precision));
-        $colors          = array();
-
-        // Test for image type
-        $img = $this->imageTypeToResource();
-
-        if (! $img && $img !== null) {
-            user_error("Unable to open: {$this->filename}", E_USER_ERROR);
-            return false;
-        }
-
-        // Get image size and check if it's really an image
-        $size            = @getimagesize($this->filename);
-
-        if ($size === false) {
-            user_error("Unable to get image size data: {$this->filename}", E_USER_ERROR);
-            return false;
-        }
-
-        for ($x = 0; $x < $size[0]; $x += $this->precision) {
-            for ($y = 0; $y < $size[1]; $y += $this->precision) {
-                $thisColor  = imagecolorat($img, $x, $y);
-                $rgb        = imagecolorsforindex($img, $thisColor);
-                $red        = round(round(($rgb['red']      / 0x33)) * 0x33);
-                $green      = round(round(($rgb['green']    / 0x33)) * 0x33);
-                $blue       = round(round(($rgb['blue']     / 0x33)) * 0x33);
-                $thisRGB    = sprintf('%02X%02X%02X', $red, $green, $blue);
-
-                if (array_key_exists($thisRGB, $colors)) {
-                    $colors[$thisRGB]++;
-                } else {
-                    $colors[$thisRGB] = 1;
-                }
-            }
-        }
-        arsort($colors);
-        return array_slice($colors, 0, $this->returnColors, true);
-    }
-
-    /**
-     * save
-     * Get array of colors, json_encode it and save to destination
-     *
-     * @param string $destination Where to save json-file
-     *
-     * @return false
-     **/
-    public function save()
-    {
-        try {
-            if (empty($this->destination)) {
-                throw new \Exception("No destination given for save");
-            }
-        } catch (\Exception $e) {
-            user_error($e->getMessage(), E_USER_ERROR);
-        }
-
-        try {
-            $this->checkDestination();
-        } catch (\Exception $e) {
-            user_error($e->getMessage(), E_USER_ERROR);
-        }
-
-        try {
-            if (empty($this->colorsArray)) {
-                throw new \Exception("Couldn't detect colors from image: {$this->filename}");
-            }
-        } catch (\Exception $e) {
-            user_error($e->getMessage(), E_USER_ERROR);
-        }
-
-        // Encode for saving
-        $colorsData = json_encode($this->colorsArray);
-
-        // Save and return the result of save operation
-        file_put_contents($this->destination, $colorsData);
-        if (is_readable($this->destination)) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * imageTypeToResource returns image resource
-     *
-     * Function takes $this->filename and returns
-     * imagecreatefrom{gif|jpeg|png} for further processing
-     *
-     * @return resource Image resource based on content
-     */
-    private function imageTypeToResource()
-    {
-        $type = exif_imagetype($this->filename);
-        switch ($type) {
-            case '1': // IMAGETYPE_GIF
-                $img = @imagecreatefromgif($this->filename);
-                break;
-            case '2': // IMAGETYPE_JPEG
-                $img = @imagecreatefromjpeg($this->filename);
-                break;
-            case '3': // IMAGETYPE_PNG
-                $img = @imagecreatefrompng($this->filename);
-                break;
-            default:
-                $image_type_code = image_type_to_mime_type($type);
-                user_error("Unknown image type: {$image_type_code} ({$type}): {$this->filename}");
-                return false;
-                break;
-        }
-
-        return $img;
-    }
-
-    /**
-     * checkDestination tries to make sure you have directory to save to
-     *
-     * Tests done:
-     * - Does the destination folder exists?
-     * - Is it writable?
-     * - Can it be made writable?
-     *
-     * @return bool|exception True or false, with exceptions
-     */
-    private function checkDestination()
-    {
-        $destination_dir = dirname($this->destination);
-
-        // Test if we have destination directory
-        try {
-            if (! file_exists($destination_dir)) {
-                mkdir($destination_dir, 0755);
-            }
-
-            if (! file_exists($destination_dir)) {
-                throw new \Exception("Couldn't create missing destination dir: {$destination_dir}");
-            }
-        } catch (Exception $e) {
-            user_error($e->getMessage());
-            return false;
-        }
-
-        // Test if we can write to it
-        try {
-            if (! is_writable($destination_dir)) {
-                chmod($destination_dir, 0755);
-            } else {
-                return true;
-            }
-
-            if (! is_writable($destination_dir)) {
-                throw new \Exception("Destination directory not writable: {$destination_dir}");
-            }
-        } catch (\Exception $e) {
-            user_error($e->getMessage());
-        }
-
-        return true;
-    }
-}

phpcs.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset
+        name="PHP_CodeSniffer"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"
+>
+    <description>PHP Code Sniffer configuration file.</description>
+
+    <file>.</file>
+
+    <arg name="basepath" value="."/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="10"/>
+
+    <!-- base rule: set to PSR12-->
+    <!-- https://www.php-fig.org/psr/psr-12/ -->
+    <rule ref="PSR12">
+        <exclude-pattern>*/vendor/*</exclude-pattern>
+    </rule>
+</ruleset>

phpunit.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory suffix="Test.php">./tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src/</directory>
+    </include>
+  </source>
+</phpunit>

src/Exceptions/GenericException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace ivuorinen\Palette\Exceptions;
+
+use ErrorException;
+use Throwable;
+
+class GenericException extends ErrorException
+{
+    public function __construct(string $message, int $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/Palette.php

@@ -0,0 +1,287 @@
+<?php
+
+/**
+ * Palette
+ * Parses image and returns most used colors
+ *
+ * MIT License
+ * ===========
+ *
+ * Copyright (c) 2013 Ismo Vuorinen <ivuorinen@me.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ *
+ * @author     Ismo Vuorinen <ivuorinen@me.com>
+ * @license    http://www.opensource.org/licenses/mit-license.php  MIT License
+ * @copyright  2013 Ismo Vuorinen
+ * @link       https://github.com/ivuorinen/palette
+ */
+
+namespace ivuorinen\Palette;
+
+use GdImage;
+use ivuorinen\Palette\Exceptions\GenericException;
+
+/**
+ * Palette
+ *
+ * @author   Ismo Vuorinen <ivuorinen@me.com>
+ * @license  http://www.opensource.org/licenses/mit-license.php  MIT License
+ * @link     https://github.com/ivuorinen/palette
+ **/
+class Palette
+{
+    /** @var int Precision of palette, higher is more precise */
+    public int $precision;
+
+    /** @var int Number of colors to return */
+    public int $returnColors;
+
+    /** @var array Array of colors we use internally */
+    public array $colorsArray;
+
+    /** @var string Full path to image file name */
+    public ?string $filename;
+
+    /** @var string Destination for .json-file, full path and filename */
+    public string $destination;
+
+    /**
+     * Constructor
+     *
+     * If you have specified $filename, Palette::run() gets triggered.
+     * Palette::run() uses default parameters and processes given image
+     * and saves the result as an json-file to datafiles -folder.
+     *
+     * @param string $filename Full path to image
+     *
+     * @throws \Exception
+     */
+    public function __construct(string $filename)
+    {
+        // Define shortcut to directory separator
+        if (!defined('DS')) {
+            define('DS', DIRECTORY_SEPARATOR);
+        }
+
+        $this->precision = 10;
+        $this->returnColors = 10;
+        $this->colorsArray = array();
+        $this->filename = $filename;
+        $this->destination = __DIR__
+            . DS . 'datafiles'
+            . DS . basename($filename) . '.json';
+
+        if (!empty($this->filename)) {
+            $this->run();
+        }
+    }
+
+    /**
+     * run the process
+     *
+     * if you want to change parameters you can init new Palette, then change
+     * settings and after that run the palette generation and saving
+     *
+     * @return bool Returns true always
+     * @throws \Exception
+     */
+    public function run(): bool
+    {
+        if (empty($this->destination)) {
+            throw new GenericException("No destination provided, can't save.");
+        }
+
+        $this->getPalette();
+        $this->save();
+
+        return true;
+    }
+
+    /**
+     * getPalette
+     * Returns colors used in an image specified in $filename
+     *
+     * @return array|bool If we get array that has colors return the array
+     * @throws \Exception
+     */
+    public function getPalette(): array|bool
+    {
+        // We check for input
+        if (empty($this->filename)) {
+            throw new GenericException('Image was not provided');
+        }
+
+        // We check for readability
+        if (!is_readable($this->filename)) {
+            throw new GenericException("Image {$this->filename} is not readable");
+        }
+
+        $this->colorsArray = $this->countColors();
+
+        if (!empty($this->colorsArray) && is_array($this->colorsArray)) {
+            return $this->colorsArray;
+        }
+
+        return false;
+    }
+
+    /**
+     * countColors returns an array of colors in the image
+     *
+     * @return array Array of colors sorted by times used
+     * @throws GenericException
+     */
+    private function countColors(): array
+    {
+        $this->precision = max(1, abs($this->precision));
+        $colors = array();
+
+        // Test for image type
+        $img = $this->imageTypeToResource();
+
+        // Get image size and check if it's really an image
+        $size = @getimagesize($this->filename);
+
+        if ($size === false) {
+            throw new GenericException("Unable to get image size data: {$this->filename}");
+        }
+
+        // This is pretty naive approach,
+        // but looping through the image is the only way I thought of
+        for ($x = 0; $x < $size[0]; $x += $this->precision) {
+            for ($y = 0; $y < $size[1]; $y += $this->precision) {
+                $thisColor = imagecolorat($img, $x, $y);
+                $rgb = imagecolorsforindex($img, $thisColor);
+                $red = round(round($rgb['red'] / 0x33) * 0x33);
+                $green = round(round($rgb['green'] / 0x33) * 0x33);
+                $blue = round(round($rgb['blue'] / 0x33) * 0x33);
+                $thisRGB = sprintf('%02X%02X%02X', $red, $green, $blue);
+
+                if (array_key_exists($thisRGB, $colors)) {
+                    $colors[$thisRGB]++;
+                } else {
+                    $colors[$thisRGB] = 1;
+                }
+            }
+        }
+        arsort($colors);
+
+        return array_slice($colors, 0, $this->returnColors, true);
+    }
+
+    /**
+     * save
+     * Get array of colors, json_encode it and save to destination
+     *
+     * @return bool
+     * @throws \Exception
+     */
+    public function save(): bool
+    {
+        // Check for destination
+        if (empty($this->destination)) {
+            throw new \InvalidArgumentException('No destination given for save');
+        }
+
+        // Check destination for write permissions
+        $this->checkDestination();
+
+        // Check for data we should write
+        if (empty($this->colorsArray)) {
+            throw new GenericException("Couldn't detect colors from image: {$this->filename}");
+        }
+
+        // Encode for saving
+        $colorsData = json_encode($this->colorsArray, JSON_THROW_ON_ERROR);
+
+        // Save and return the result of save operation
+        file_put_contents($this->destination, $colorsData);
+
+        return is_readable($this->destination);
+    }
+
+    /**
+     * imageTypeToResource returns image resource
+     *
+     * Function takes $this->filename and returns
+     * imagecreatefrom{gif|jpeg|png} for further processing
+     *
+     * @return GdImage Image resource based on content
+     * @throws GenericException
+     */
+    private function imageTypeToResource(): GdImage
+    {
+        try {
+            if (filesize($this->filename) < 12) {
+                throw new GenericException('File size smaller than 12');
+            }
+            $type = exif_imagetype($this->filename);
+        } catch (\Exception $e) {
+            throw new GenericException($e->getMessage());
+        }
+
+        switch ($type) {
+            case '1': // IMAGETYPE_GIF
+                return @\imagecreatefromgif($this->filename);
+            case '2': // IMAGETYPE_JPEG
+                return @\imagecreatefromjpeg($this->filename);
+            case '3': // IMAGETYPE_PNG
+                return @\imagecreatefrompng($this->filename);
+            default:
+                $image_type_code = image_type_to_mime_type($type);
+                throw new GenericException("Unknown image type: {$image_type_code} ({$type}): {$this->filename}");
+        }
+    }
+
+    /**
+     * checkDestination tries to make sure you have directory to save to
+     *
+     * Tests done:
+     * - Does the destination folder exists?
+     * - Is it writable?
+     * - Can it be made writable?
+     *
+     * @return boolean True or false, with exceptions
+     * @throws \Exception
+     */
+    private function checkDestination(): bool
+    {
+        $destination_dir = dirname($this->destination);
+
+        // Test if we have destination directory
+        if (!@mkdir($destination_dir, 0755) && !is_dir($destination_dir)) {
+            throw new GenericException("Couldn't create missing destination dir: {$destination_dir}");
+        }
+
+        // Test if we can write to it
+        if (is_writable($destination_dir)) {
+            return true;
+        }
+        chmod($destination_dir, 0755);
+
+        if (!is_writable($destination_dir)) {
+            throw new GenericException("Destination directory not writable: {$destination_dir}");
+        }
+
+        return true;
+    }
+}

tests/PaletteTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace ivuorinen\Palette\Tests;
+
+use PHPUnit\Framework\TestCase;
+
+class PaletteTest extends TestCase
+{
+    public function testClassIsFoundAndHasDefaultAttributes(): void
+    {
+        $palette = new \ivuorinen\Palette\Palette('');
+        $this->assertInstanceOf('ivuorinen\Palette\Palette', $palette);
+
+        $this->assertIsInt($palette->precision);
+        $this->assertIsInt($palette->returnColors);
+        $this->assertIsArray($palette->colorsArray);
+        $this->assertIsString($palette->filename);
+        $this->assertIsString($palette->destination);
+    }
+
+    public function testKnownImagesWithOneColor(): void
+    {
+        $location = __DIR__ . DIRECTORY_SEPARATOR . 'assets' . DIRECTORY_SEPARATOR;
+        $images = ['black.png' => '000000', 'red.png' => 'CC3333'];
+
+        foreach ($images as $imageFile => $hex) {
+            $image = $location . $imageFile;
+            $this->assertFileExists($image);
+
+            $palette = new \ivuorinen\Palette\Palette($image);
+            $this->assertCount(1, $palette->colorsArray);
+            $this->assertArrayHasKey($hex, $palette->colorsArray);
+            $this->assertEquals($image, $palette->filename);
+        }
+    }
+
+    public function testKnownImagesWithManyColors(): void
+    {
+        $location = __DIR__ . DIRECTORY_SEPARATOR . 'assets' . DIRECTORY_SEPARATOR;
+        $images = ['example.gif', 'example.jpg', 'example.png'];
+
+        foreach ($images as $imageFile) {
+            $image = $location . $imageFile;
+            $this->assertFileExists($image);
+
+            $palette = new \ivuorinen\Palette\Palette($image);
+            $this->assertCount(10, $palette->colorsArray);
+            $this->assertEquals($image, $palette->filename);
+        }
+    }
+
+    public function testFailureNoImage(): void
+    {
+        $palette = new \ivuorinen\Palette\Palette('');
+        $this->expectException(\ErrorException::class);
+        $this->expectExceptionMessage('Image was not provided');
+        $palette->getPalette();
+    }
+
+    public function testFailureNotAnImage(): void
+    {
+        $this->expectException(\ErrorException::class);
+
+        $palette = new \ivuorinen\Palette\Palette('NOT_HERE');
+        $this->expectExceptionMessage('Image ' . $palette->filename . ' is not readable');
+
+        $palette->getPalette();
+    }
+}