Merge pull request #1 from adhocore/develop

Develop Version 0.0.1

Author: adhocore

.editorconfig

@@ -0,0 +1,17 @@
+; http://editorconfig.org
+;
+; Sublime: https://github.com/sindresorhus/editorconfig-sublime
+; Phpstorm: https://plugins.jetbrains.com/plugin/7294-editorconfig
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.md,*.php,composer.json,composer.lock}]
+indent_size = 4

.gitignore

@@ -0,0 +1,7 @@
+# standards
+/.cache/
+/.env
+/.idea/
+/vendor/
+composer.lock
+*.local.*

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+
+install:
+  - composer install --prefer-dist
+
+before_script:
+  - for P in src tests; do find $P -type f -name '*.php' -exec php -l {} \;; done
+
+script:
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

README.md

@@ -0,0 +1,30 @@
+## adhocore/cli
+
+Command Line Interface utilities and helpers for PHP.
+
+... a work in progress ...
+
+[![Latest Version](https://img.shields.io/github/release/adhocore/cli.svg?style=flat-square)](https://github.com/adhocore/cli/releases)
+[![Travis Build](https://img.shields.io/travis/adhocore/cli/master.svg?style=flat-square)](https://travis-ci.org/adhocore/cli?branch=master)
+[![Scrutinizer CI](https://img.shields.io/scrutinizer/g/adhocore/cli.svg?style=flat-square)](https://scrutinizer-ci.com/g/adhocore/cli/?branch=master)
+[![Codecov branch](https://img.shields.io/codecov/c/github/adhocore/cli/master.svg?style=flat-square)](https://codecov.io/gh/adhocore/cli)
+[![StyleCI](https://styleci.io/repos/139012552/shield)](https://styleci.io/repos/139012552)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+
+- Command line arguments parsing made easy
+- Inspired by nodejs [commander](https://github.com/tj/commander.js) (thanks tj)
+- For PHP5.6 or new and for good
+
+(*PS: It is just argv parser and not ditto commander, so spawning new commands or actions are not supported*)
+
+**Bonus**: Text coloring for the cli
+
+## Installation
+```bash
+composer require adhocore/cli
+```
+
+## Usage
+```php
+# coming soon
+```

composer.json

@@ -0,0 +1,32 @@
+{
+    "name": "adhocore/cli",
+    "description": "Command line interface library for PHP",
+    "type": "library",
+    "keywords": [
+        "php", "command", "argv-parser", "cli", "cli-color", "cli-action", "console",
+        "cli-writer", "argument-parser", "cli-option"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Jitendra Adhikari",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Ahc\\Cli\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Ahc\\Cli\\Test\\": "tests/"
+        }
+    },
+    "require": {
+        "php": ">=7.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^6.0"
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+  backupStaticAttributes="false"
+  colors="true"
+  convertErrorsToExceptions="true"
+  convertNoticesToExceptions="true"
+  convertWarningsToExceptions="true"
+  processIsolation="false"
+  stopOnFailure="false"
+  syntaxCheck="false"
+  bootstrap="tests/bootstrap.php"
+>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <filter>
+  <whitelist processUncoveredFilesFromWhitelist="true">
+    <directory suffix=".php">./src</directory>
+  </whitelist>
+</filter>
+</phpunit>

src/Argument.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Ahc\Cli;
+
+/**
+ * Cli Option.
+ *
+ * @author  Jitendra Adhikari <[email protected]>
+ * @license MIT
+ *
+ * @link    https://github.com/adhocore/cli
+ */
+class Argument
+{
+    use InflectsString;
+
+    protected $name;
+
+    protected $rawArg;
+
+    protected $default;
+
+    protected $required = false;
+
+    protected $variadic = false;
+
+    public function __construct(string $arg)
+    {
+        $this->rawArg = $arg;
+
+        $this->parse($arg);
+    }
+
+    protected function parse(string $arg)
+    {
+        $this->required = $arg[0] === '<';
+        $this->variadic = \strpos($arg, '...') !== false;
+        $this->name     = $name = \str_replace(['<', '>', '[', ']', '.'], '', $arg);
+
+        // Format is "name:default+value1,default+value2" ('+'' => ' ')!
+        if (\strpos($name, ':') !== false) {
+            $name                             = \str_replace('+', ' ', $name);
+            list($this->name, $this->default) = \explode(':', $name, 2);
+        }
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function attributeName(): string
+    {
+        return $this->toCamelCase($this->name);
+    }
+
+    public function required(): bool
+    {
+        return $this->required;
+    }
+
+    public function variadic(): bool
+    {
+        return $this->variadic;
+    }
+
+    public function default()
+    {
+        if (!$this->variadic) {
+            return $this->default;
+        }
+
+        return null === $this->default ? [] : \explode(',', $this->default);
+    }
+}