Skip to content

Commit 34ce4dd

Browse files
freekmurzefreekmurze
committed
initial commit v3
0 parents  commit 34ce4dd

16 files changed

+372
-0
lines changed

‎.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.gitattributes export-ignore
6+
/.gitignore export-ignore
7+
/.travis.yml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/tests export-ignore

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor

‎.scrutinizer.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
4+
checks:
5+
php:
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true
19+

‎.travis.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
language: php
2+
3+
php:
4+
- 5.5
5+
- 5.6
6+
- 7.0
7+
8+
env:
9+
matrix:
10+
- PREFER_LOWEST="--prefer-lowest"
11+
- PREFER_LOWEST=""
12+
13+
before_script:
14+
- travis_retry composer self-update
15+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
16+
17+
script:
18+
- phpunit --coverage-text --coverage-clover=coverage.clover
19+
20+
after_script:
21+
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

‎CHANGELOG.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changelog
2+
3+
All Notable changes to `:package_name` will be documented in this file
4+
5+
## NEXT - YYYY-MM-DD
6+
7+
### Added
8+
- Nothing
9+
10+
### Deprecated
11+
- Nothing
12+
13+
### Fixed
14+
- Nothing
15+
16+
### Removed
17+
- Nothing
18+
19+
### Security
20+
- Nothing

‎CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/spatie/:package_name).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
23+
24+
25+
## Running Tests
26+
27+
``` bash
28+
$ phpunit
29+
```
30+
31+
32+
**Happy coding**!

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2016 Spatie bvba <[email protected]>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

‎README.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# :package_name
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
4+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5+
[![Build Status](https://img.shields.io/travis/spatie/:package_name/master.svg?style=flat-square)](https://travis-ci.org/spatie/:package_name)
6+
[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/xxxxxxxxx.svg?style=flat-square)](https://insight.sensiolabs.com/projects/xxxxxxxxx)
7+
[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/:package_name)
8+
[![Total Downloads](https://img.shields.io/packagist/dt/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
9+
10+
**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line.
11+
12+
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
13+
PSRs you support to avoid any confusion with users and contributors.
14+
15+
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
16+
17+
## Install
18+
19+
**Note:** Remove this paragraph if you are building a public package
20+
This package is custom built for [Spatie](https://spatie.be) projects and is therefore not registered on packagist.
21+
In order to install it via composer you must specify this extra repository in `composer.json`:
22+
23+
```json
24+
"repositories": [ { "type": "composer", "url": "https://satis.spatie.be/" } ]
25+
```
26+
27+
You can install the package via composer:
28+
``` bash
29+
$ composer require spatie/:package_name
30+
```
31+
32+
## Usage
33+
34+
``` php
35+
$skeleton = new Spatie\Skeleton();
36+
echo $skeleton->echoPhrase('Hello, Spatie!');
37+
```
38+
39+
## Changelog
40+
41+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
42+
43+
## Testing
44+
45+
``` bash
46+
$ composer test
47+
```
48+
49+
## Contributing
50+
51+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
52+
53+
## Security
54+
55+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
56+
57+
## Credits
58+
59+
- [:author_name](https://github.com/:author_username)
60+
- [All Contributors](../../contributors)
61+
62+
## About Spatie
63+
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
64+
65+
## License
66+
67+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

‎composer.json

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"name": "spatie/:package_name",
3+
"description": ":package_description",
4+
"keywords": [
5+
"spatie",
6+
":package_name"
7+
],
8+
"homepage": "https://github.com/spatie/:package_name",
9+
"license": "MIT",
10+
"authors": [
11+
{
12+
"name": ":author_name",
13+
"email": ":author_email",
14+
"homepage": "https://spatie.be",
15+
"role": "Developer"
16+
}
17+
],
18+
"require": {
19+
"php" : ">=7.0"
20+
},
21+
"require-dev": {
22+
"phpunit/phpunit": "4.*"
23+
},
24+
"autoload": {
25+
"psr-4": {
26+
"Spatie\\Skeleton\\": "src"
27+
}
28+
},
29+
"autoload-dev": {
30+
"psr-4": {
31+
"Spatie\\Skeleton\\Test\\": "tests"
32+
}
33+
},
34+
"scripts": {
35+
"test": "phpunit"
36+
}
37+
}

‎config/.gitkeep

Whitespace-only changes.

‎phpunit.xml.dist

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="vendor/autoload.php"
3+
backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
verbose="true"
7+
convertErrorsToExceptions="true"
8+
convertNoticesToExceptions="true"
9+
convertWarningsToExceptions="true"
10+
processIsolation="false"
11+
stopOnFailure="false">
12+
<testsuites>
13+
<testsuite name="Spatie Test Suite">
14+
<directory>tests</directory>
15+
</testsuite>
16+
</testsuites>
17+
<filter>
18+
<whitelist>
19+
<directory suffix=".php">src/</directory>
20+
</whitelist>
21+
</filter>
22+
<logging>
23+
<log type="tap" target="build/report.tap"/>
24+
<log type="junit" target="build/report.junit.xml"/>
25+
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26+
<log type="coverage-text" target="build/coverage.txt"/>
27+
<log type="coverage-clover" target="build/logs/clover.xml"/>
28+
</logging>
29+
</phpunit>

‎src/SkeletonClass.php

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
namespace Spatie\Skeleton;
4+
5+
class SkeletonClass
6+
{
7+
/**
8+
* Create a new Skeleton Instance
9+
*/
10+
public function __construct()
11+
{
12+
// constructor body
13+
}
14+
15+
/**
16+
* Friendly welcome
17+
*
18+
* @param string $phrase Phrase to return
19+
*
20+
* @return string Returns the phrase passed in
21+
*/
22+
public function echoPhrase($phrase)
23+
{
24+
return $phrase;
25+
}
26+
}

‎src/SkeletonFacade.php

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
namespace Spatie\Skeleton;
4+
5+
use Illuminate\Support\Facades\Facade;
6+
7+
/**
8+
* @see \Spatie\Skeleton\SkeletonClass
9+
*/
10+
class SkeletonFacade extends Facade
11+
{
12+
/**
13+
* Get the registered name of the component.
14+
*
15+
* @return string
16+
*/
17+
protected static function getFacadeAccessor()
18+
{
19+
return 'skeleton';
20+
}
21+
}

‎src/SkeletonServiceProvider.php

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?php
2+
3+
namespace Spatie\Skeleton;
4+
5+
use Illuminate\Support\ServiceProvider;
6+
7+
class SkeletonServiceProvider extends ServiceProvider
8+
{
9+
/**
10+
* Bootstrap the application services.
11+
*/
12+
public function boot()
13+
{
14+
$this->publishes([
15+
__DIR__.'/../config/skeleton.php' => config_path('skeleton.php'),
16+
], 'config');
17+
18+
/*
19+
$this->loadViewsFrom(__DIR__.'/../resources/views', 'skeleton');
20+
21+
$this->publishes([
22+
__DIR__.'/../resources/views' => base_path('resources/views/vendor/skeleton'),
23+
], 'views');
24+
*/
25+
}
26+
27+
/**
28+
* Register the application services.
29+
*/
30+
public function register()
31+
{
32+
$this->mergeConfigFrom(__DIR__.'/../config/config.php', 'skeleton');
33+
}
34+
}

‎tests/ExampleTest.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
namespace Spatie\Skeleton\Test;
4+
5+
class ExampleTest extends \PHPUnit_Framework_TestCase
6+
{
7+
8+
9+
/**
10+
* Test that true does in fact equal true
11+
*/
12+
public function testTrueIsTrue()
13+
{
14+
$this->assertTrue(true);
15+
}
16+
}

0 commit comments

Comments
 (0)