Permalink
Browse files

add skeleton

  • Loading branch information...
0 parents commit c00ec5c958b900b1a770a7fce75a566a36b6171f @freekmurze freekmurze committed Jan 9, 2017
Showing with 392 additions and 0 deletions.
  1. +15 −0 .editorconfig
  2. +10 −0 .gitattributes
  3. +4 −0 .gitignore
  4. +19 −0 .scrutinizer.yml
  5. +6 −0 .styleci.yml
  6. +20 −0 .travis.yml
  7. +7 −0 CHANGELOG.md
  8. +55 −0 CONTRIBUTING.md
  9. +21 −0 LICENSE.md
  10. +72 −0 README.md
  11. +40 −0 composer.json
  12. 0 config/.gitkeep
  13. +29 −0 phpunit.xml.dist
  14. +25 −0 src/SkeletonClass.php
  15. +21 −0 src/SkeletonFacade.php
  16. +36 −0 src/SkeletonServiceProvider.php
  17. +12 −0 tests/ExampleTest.php
@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
@@ -0,0 +1,10 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.travis.yml export-ignore
+/phpunit.xml.dist export-ignore
+/.scrutinizer.yml export-ignore
+/tests export-ignore
@@ -0,0 +1,4 @@
+build
+composer.lock
+docs
+vendor
@@ -0,0 +1,19 @@
+filter:
+ excluded_paths: [tests/*]
+
+checks:
+ php:
+ remove_extra_empty_lines: true
+ remove_php_closing_tag: true
+ remove_trailing_whitespace: true
+ fix_use_statements:
+ remove_unused: true
+ preserve_multiple: false
+ preserve_blanklines: true
+ order_alphabetically: true
+ fix_php_opening_tag: true
+ fix_linefeed: true
+ fix_line_ending: true
+ fix_identation_4spaces: true
+ fix_doc_comments: true
+
@@ -0,0 +1,6 @@
+preset: laravel
+
+linting: true
+
+disabled:
+ - single_class_element_per_statement
@@ -0,0 +1,20 @@
+language: php
+
+php:
+ - 7.0
+ - 7.1
+
+env:
+ matrix:
+ - COMPOSER_FLAGS="--prefer-lowest"
+ - COMPOSER_FLAGS=""
+
+before_script:
+ - travis_retry composer self-update
+ - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+ - phpunit --coverage-text --coverage-clover=coverage.clover
+
+after_script:
+ - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover
@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `:package_name` will be documented in this file
+
+## 1.0.0 - 201X-XX-XX
+
+- initial release
@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[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).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **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.
+
+**Happy coding**!
@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) Spatie bvba <info@spatie.be>
+
+> 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.
@@ -0,0 +1,72 @@
+# Very short description of the package
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://img.shields.io/travis/spatie/:package_name/master.svg?style=flat-square)](https://travis-ci.org/spatie/:package_name)
+[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/xxxxxxxxx.svg?style=flat-square)](https://insight.sensiolabs.com/projects/xxxxxxxxx)
+[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/:package_name)
+[![Total Downloads](https://img.shields.io/packagist/dt/spatie/:package_name.svg?style=flat-square)](https://packagist.org/packages/spatie/:package_name)
+
+**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.
+
+This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
+
+## Postcardware
+
+You're free to use this package (it's [MIT-licensed](LICENSE.md)), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
+
+Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
+
+The best postcards will get published on the open source page on our website.
+
+## Installation
+
+**Note:** Remove this paragraph if you are building a public package
+This package is custom built for [Spatie](https://spatie.be) projects and is therefore not registered on packagist. In order to install it via composer you must specify this extra repository in `composer.json`:
+
+```json
+"repositories": [ { "type": "composer", "url": "https://satis.spatie.be/" } ]
+```
+
+You can install the package via composer:
+
+``` bash
+composer require spatie/:package_name
+```
+
+## Usage
+
+``` php
+$skeleton = new Spatie\Skeleton();
+echo $skeleton->echoPhrase('Hello, Spatie!');
+```
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Security
+
+If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
+
+## Credits
+
+- [:author_name](https://github.com/:author_username)
+- [All Contributors](../../contributors)
+
+## About Spatie
+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).
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
@@ -0,0 +1,40 @@
+{
+ "name": "spatie/:package_name",
+ "description": ":package_description",
+ "keywords": [
+ "spatie",
+ ":package_name"
+ ],
+ "homepage": "https://github.com/spatie/:package_name",
+ "license": "MIT",
+ "authors": [
+ {
+ "name": ":author_name",
+ "email": ":author_email",
+ "homepage": "https://spatie.be",
+ "role": "Developer"
+ }
+ ],
+ "require": {
+ "php": "^7.0"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "5.*"
+ },
+ "autoload": {
+ "psr-4": {
+ "Spatie\\Skeleton\\": "src"
+ }
+ },
+ "autoload-dev": {
+ "psr-4": {
+ "Spatie\\Skeleton\\Test\\": "tests"
+ }
+ },
+ "scripts": {
+ "test": "vendor/bin/phpunit"
+ },
+ "config": {
+ "sort-packages": true
+ }
+}
No changes.
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+ backupGlobals="false"
+ backupStaticAttributes="false"
+ colors="true"
+ verbose="true"
+ convertErrorsToExceptions="true"
+ convertNoticesToExceptions="true"
+ convertWarningsToExceptions="true"
+ processIsolation="false"
+ stopOnFailure="false">
+ <testsuites>
+ <testsuite name="Spatie Test Suite">
+ <directory>tests</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist>
+ <directory suffix=".php">src/</directory>
+ </whitelist>
+ </filter>
+ <logging>
+ <log type="tap" target="build/report.tap"/>
+ <log type="junit" target="build/report.junit.xml"/>
+ <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+ <log type="coverage-text" target="build/coverage.txt"/>
+ <log type="coverage-clover" target="build/logs/clover.xml"/>
+ </logging>
+</phpunit>
@@ -0,0 +1,25 @@
+<?php
+
+namespace Spatie\Skeleton;
+
+class SkeletonClass
+{
+ /**
+ * Create a new Skeleton Instance.
+ */
+ public function __construct()
+ {
+ // constructor body
+ }
+
+ /**
+ * Friendly welcome.
+ *
+ * @param string $phrase Phrase to return
+ * @return string Returns the phrase passed in
+ */
+ public function echoPhrase($phrase)
+ {
+ return $phrase;
+ }
+}
@@ -0,0 +1,21 @@
+<?php
+
+namespace Spatie\Skeleton;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @see \Spatie\Skeleton\SkeletonClass
+ */
+class SkeletonFacade extends Facade
+{
+ /**
+ * Get the registered name of the component.
+ *
+ * @return string
+ */
+ protected static function getFacadeAccessor()
+ {
+ return 'skeleton';
+ }
+}
@@ -0,0 +1,36 @@
+<?php
+
+namespace Spatie\Skeleton;
+
+use Illuminate\Support\ServiceProvider;
+
+class SkeletonServiceProvider extends ServiceProvider
+{
+ /**
+ * Bootstrap the application services.
+ */
+ public function boot()
+ {
+ if ($this->app->runningInConsole()) {
+ $this->publishes([
+ __DIR__.'/../config/skeleton.php' => config_path('skeleton.php'),
+ ], 'config');
+
+ /*
+ $this->loadViewsFrom(__DIR__.'/../resources/views', 'skeleton');
+
+ $this->publishes([
+ __DIR__.'/../resources/views' => base_path('resources/views/vendor/skeleton'),
+ ], 'views');
+ */
+ }
+ }
+
+ /**
+ * Register the application services.
+ */
+ public function register()
+ {
+ $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'skeleton');
+ }
+}
Oops, something went wrong.

0 comments on commit c00ec5c

Please sign in to comment.