initial commit

Author: ottosmops

.gitignore

@@ -0,0 +1,4 @@
+build/
+composer.lock
+docs
+vendor/

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

.travis.yml

@@ -0,0 +1,13 @@
+language: php
+
+php:
+  - '7.1'
+  - '7.2'
+  - '7.3'
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update --no-interaction --prefer-source
+
+script:
+  - vendor/bin/phpunit

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2016 kr <[email protected]>
+
+> 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

@@ -0,0 +1,31 @@
+# Parse ids to an array 
+
+[![Software License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.md)
+[![Latest Stable Version](https://img.shields.io/badge/Version-stable-blue.svg?format=flat-square)](https://packagist.org/packages/ottosmops/ids)
+[![Build Status](https://travis-ci.com/ottosmops/ids.svg?branch=master)](https://travis-ci.com/ottosmops/ids)
+[![SensioLabsInsight](https://insight.sensiolabs.com/projects/248db8b3-4969-48c5-9a61-9c7346832ff0/mini.png)](https://insight.sensiolabs.com/projects/248db8b3-4969-48c5-9a61-9c7346832ff0)
+[![Packagist Downloads](https://img.shields.io/packagist/dt/ottosmops/ids.svg?style=flat-square)](https://packagist.org/packages/ottosmops/ids)
+
+
+## Idea
+For PHP CLI or Api, if you want to have an option for one or more ids (integers), this very small package is a helper, which parses a string to an array of ids.
+
+| Input | Output |
+|:----:|:----:|
+|1|[1]|
+|1,2|[1,2]|
+|1-3 | [1,2,3] |
+| 1-5,7,8 | [1,2,3,4,5,7,8] |
+
+## Usage
+The usage is very simple:
+
+```php 
+$ids = '1-3';
+$array = Ids::parse($ids); // [1,2,3]
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+

composer.json

@@ -0,0 +1,43 @@
+{
+    "name": "ottosmops/ids",
+    "description": "parse an ids-string to an array",
+    "keywords": [
+        "ottosmops",
+        "CLI",
+        "Api",
+        "Helper"
+    ],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "ak",
+            "email": "[email protected]",
+            "homepage": "https://wwwk-r.ch"
+        }
+    ],
+    "homepage": "https://github.com/ottosmops/ottosmops/ids",
+    "minimum-stability": "stable",
+    "require": {
+        "php" : ">=7.1"
+    },
+    "autoload": {
+        "psr-4": {
+            "Ottosmops\\Ids\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Ottosmops\\Ids\\Test\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": "phpunit",
+        "check-style": "phpcs -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests",
+        "fix-style": "phpcbf -p --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.5"
+    }
+
+}

phpunit.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.0/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         verbose="true"
+         colors="true">
+    <testsuite name="default">
+        <directory suffix="Test.php">tests</directory>
+    </testsuite>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Ids.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Ottosmops\Ids;
+
+class Ids
+{
+    static public function parse(string $ids) : array
+    {
+        if (!static::isValid($ids)) {
+            throw new \InvalidArgumentException('Is not a valid ids-string: ' . $ids);
+        }
+
+        if (strpos($ids, '-') && strpos($ids, ',')) {
+            $array = explode(',', $ids);
+            $return = [];
+            foreach($array as $v) {
+                if (strpos($v, '-')) {
+                    $return = array_merge($return, static::createRange($v));
+                } else {
+                    $return[] = $v;
+                }
+            }
+            return $return;
+        }
+
+        if (strpos($ids, '-')) {
+            return static::createRange($ids);
+        }
+
+        if (strpos($ids, ',')) {
+            return explode(',', $ids);
+        }
+
+        return [$ids];
+    }
+
+    static public function isValid(string $string): bool
+    {
+        return  preg_match('/^[0-9].*/', $string) &&
+                preg_match('/.*[0-9]$/', $string) &&
+                !preg_match('/(--|,,|,-|-,|[a-zA-Z&%$§!*_:.;\/])/', $string) &&
+                preg_match('/[1-9][1-9,-]*/', $string);
+    }
+
+    static private function createRange(string $string): array
+    {
+        list($start, $end) = explode('-', $string);
+        return range(trim($start), trim($end));
+    }
+}

tests/ParseIdsTest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Ottosmops\Ids\Test;
+
+use Ottosmops\Ids\Ids;
+use PHPUnit\Framework\TestCase;
+
+class ParseIdsTest extends TestCase
+{
+    /** test */
+    public function test_it_parses_a_single_integer()
+    {
+        $expected = [3];
+        $actual = Ids::parse("3");
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_it_parses_a_two_integers()
+    {
+        $expected = [3,4];
+        $actual = Ids::parse("3, 4");
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_it_parses_a_range()
+    {
+        $expected = [3,4,5];
+        $actual = Ids::parse("3-5");
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_it_something_complicated()
+    {
+        $expected = [3,4,5,7,9,10,11];
+        $actual = Ids::parse("3-5, 7, 9-11");
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_it_thows_a_invalid_argument_exception()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        Ids::parse("5--3");
+    }
+
+    public function test_it_thows_a_invalid_argument_exception2()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        Ids::parse("hallo");
+    }
+
+    public function test_it_thows_a_invalid_argument_exception3()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        Ids::parse("3&5");
+    }
+
+}