Skip to content
This repository has been archived by the owner on Apr 2, 2021. It is now read-only.

Commit

Permalink
Created the initial implementation of the command package
Browse files Browse the repository at this point in the history
  • Loading branch information
mfrankruijter committed Feb 27, 2020
0 parents commit 40ae617
Show file tree
Hide file tree
Showing 38 changed files with 3,518 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/tests export-ignore
/examples export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml export-ignore
/phpcs.xml export-ignore
/PULL_REQUEST_TEMPLATE.md export-ignore
/CODE_OF_CONDUCT.md export-ignore
/CONTRIBUTING.md export-ignore
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
vendor/
composer.lock
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
language: php
php:
- '7.2'
- '7.3'

before_script:
- yes '' | pecl install yaml
- composer install

script:
- composer validate --strict
- vendor/bin/phpunit --coverage-text
- vendor/bin/phpcs src/ tests/

cache:
directories:
- $HOME/.composer/cache
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 1.0.0 - 2020-02-27

### Added
- Created the initial implementation of the command package.

# Versions
- [1.0.0 > Unreleased](https://github.com/ulrack/command/compare/1.0.0...HEAD)
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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 info@jyxon.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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing

To contribute to this package, please keep to these guidelines.

- Fork the package.
- Create a branch per feature.
- Commit your changes to these branches.
- Create a pull request per feature to the master branch of the original repository.

## Pull requests

Pull request should follow these rules, before they can get accepted.

- Follow the [pull request template](PULL_REQUEST_TEMPLATE.md).
- Contains a short but complete description.
- Has passed all test command listed bellow.

## Running Tests

``` bash
$ vendor/bin/phpunit --coverage-text
$ vendor/bin/phpcs src/ tests/
```

## Notes

Multiple commits per feature are allowed, but please provide a good description in your pull request.
This description will be used to squash your feature into the master branch.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Jyxon

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.
18 changes: 18 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# (bugfix / feature / refactor / etc.): Short descriptive title

## Description

Fixes #

Changes proposed in this pull request:
-
-
-

Make sure you can check the following boxes before submitting the pull request:
- [] The proposed changes work with the dependencies from composer.
- [] The proposed changes have been thoroughly tested.
- [] The proposed changes don't alter the code in such a manner that it conflicts with the initial purpose of the package.

Optional checkbox
- [] Backwards incompatible
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
[![Build Status](https://travis-ci.com/ulrack/command.svg?branch=master)](https://travis-ci.com/ulrack/command)

# Ulrack Command

This package supplies command routing for PHP applications.

## Installation

To install the package run the following command:

```
composer require ulrack/command
```

## Usage

### [Command configuration](src/Dao/CommandConfiguration.php)
Command configuration is done through an object.
The main command configuration should be an empty instance of this class.
This main object can then be supplied to the [router](src/Common/Router/RouterInterface.php).

All sub-commands can be added to their respective command configuration instance.
This can be infinitely deep.
All command configuration instances have the `no-interaction` and `help` flag configured by default.
Sub-commands of a parent command can be executed by separating them by a space.

### [Router](src/Component/Router/CommandRouter.php)
The command router performs the routing of commands.
It creates an instance of the `service` and executes it.
This service object must implement the [CommandInterface](src/Common/Command/CommandInterface.php).

To find out more about how services work, see the `ulrack/services` package.

### Input and Output
The [input](src/Component/Command/Input.php) is an object which provides the input to the implementation of the command.
The [output](src/Component/Command/Output.php) provides a standard set of methods for displaying output to the user of the application.
The input instance can be created by providing the `$argv` to the `create` method of the [InputFactory](src/Factory/InputFactory.php).

### Standard commands
The package contains two standard commands for displaying a command [list](src/Command/ListCommandsCommand.php)
and showing a command [explanation](src/Command/HelpCommand.php).

## Examples

An example can be found in the [examples](examples) directory.

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.

## MIT License

Copyright (c) Jyxon

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.
52 changes: 52 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"name": "ulrack/command",
"description": "Command routing for PHP applications.",
"keywords": ["cli", "command"],
"type": "library",
"license": "MIT",
"prefer-stable": true,
"minimum-stability": "stable",
"require": {
"php": "^7.2",
"ulrack/cli": "^1.0",
"ulrack/configuration": "^1.0",
"ulrack/services": "^1.0",
"ulrack/task": "^1.0",
"ulrack/validator": "^1.0"
},
"authors": [{
"name": "Ulrack",
"homepage": "https://www.ulrack.com/",
"role": "Developer"
}],
"config": {
"sort-packages": true
},
"autoload": {
"psr-4": {
"Ulrack\\Command\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Ulrack\\Command\\Tests\\": "tests/"
}
},
"archive": {
"exclude": [
"/examples",
"/tests",
"/.gitignore",
"/.travis.yml",
"/phpunit.xml",
"/phpcs.xml",
"/PULL_REQUEST_TEMPLATE.md",
"/CODE_OF_CONDUCT.md",
"/CONTRIBUTING.md"
]
},
"require-dev": {
"phpunit/phpunit": "^8.0",
"squizlabs/php_codesniffer": "^3.4"
}
}
Loading

0 comments on commit 40ae617

Please sign in to comment.