Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
arcanedev-maroc committed Dec 22, 2016
1 parent a7f738e commit 2997390
Show file tree
Hide file tree
Showing 14 changed files with 469 additions and 2 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
@@ -0,0 +1,15 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

root = true

[*]
end_of_line = lf
charset = utf-8
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
indent_size = 2
8 changes: 8 additions & 0 deletions .gitattributes
@@ -0,0 +1,8 @@
/_docs export-ignore
/tests export-ignore
/.editorconfig export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.scrutinizer.yml export-ignore
/.travis.yml export-ignore
/phpunit.xml export-ignore
4 changes: 4 additions & 0 deletions .gitignore
@@ -0,0 +1,4 @@
/build/
/vendor/
/composer.lock
/composer.phar
36 changes: 36 additions & 0 deletions .scrutinizer.yml
@@ -0,0 +1,36 @@
filter:
paths: ["src/*"]
excluded_paths: [tests/*, vendor/*]

checks:
php:
code_rating: true
duplication: true
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

tools:
external_code_coverage:
timeout: 600
runs: 9
php_code_sniffer:
enabled: true
config:
standard: PSR2
filter:
paths: ['src']
php_loc:
enabled: true
php_cpd:
enabled: true
31 changes: 31 additions & 0 deletions .travis.yml
@@ -0,0 +1,31 @@
language: php

sudo: false

php:
- 5.6
- 7.0
- 7.1
- nightly

matrix:
allow_failures:
- php: nightly

env:
- TESTBENCH_VERSION=3.1.*
- TESTBENCH_VERSION=3.2.*
- TESTBENCH_VERSION=3.3.*

before_script:
- travis_retry composer self-update
- travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench:${TESTBENCH_VERSION}"

script:
- composer validate
- mkdir -p build/logs
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover

after_script:
- if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then wget https://scrutinizer-ci.com/ocular.phar; fi
- if [ "$TRAVIS_PHP_VERSION" != "nightly" ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,31 @@
# CONTRIBUTING

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

## Guidelines

* Please follow the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) Coding Standard, PHP-FIG Naming Conventions and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard
* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
* Remember that we follow SemVer. If you are changing the behaviour, or the public api, you may need to update the docs.
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
* You may also need to rebase to avoid merge conflicts.

## Running Tests

You will need an install of [Composer](https://getcomposer.org) before continuing.

First, install the dependencies:

```bash
$ composer install
```

Then run phpunit:

```bash
$ vendor/bin/phpunit --coverage-text
```

If the test suite passes on your local machine you should be good to go.

When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/).
21 changes: 21 additions & 0 deletions LICENSE.md
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 ARCANEDEV - Laravel SEO

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.
65 changes: 63 additions & 2 deletions README.md
@@ -1,2 +1,63 @@
# LaravelSeo
SEO package for Laravel 5
# Laravel SEO [![Packagist License][badge_license]](LICENSE.md) [![For Laravel 5][badge_laravel]][link-github-repo]

[![Travis Status][badge_build]][link-travis]
[![Coverage Status][badge_coverage]][link-scrutinizer]
[![Scrutinizer Code Quality][badge_quality]][link-scrutinizer]
[![SensioLabs Insight][badge_insight]][link-insight]
[![Github Issues][badge_issues]][link-github-issues]

[![Packagist][badge_package]][link-packagist]
[![Packagist Release][badge_release]][link-packagist]
[![Packagist Downloads][badge_downloads]][link-packagist]

*By [ARCANEDEV©](http://www.arcanedev.net/)*

This Laravel SEO allows you to add a SEO system into your Laravel project.

## Features

* Coming soon…

## Table of contents

1. [Requirements](_docs/1.Requirements.md)
2. [Installation and Setup](_docs/2.Installation-and-Setup.md)
3. [Configuration](_docs/3.Configuration.md)
4. [Usage](_docs/4.Usage.md)

## TODOS

- [ ] Documentation.

## Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests, please check the [contribution guidelines](CONTRIBUTING.md).

## Security

If you discover any security related issues, please email arcanedev.maroc@gmail.com instead of using the issue tracker.

## Credits

- [ARCANEDEV][link-author]
- [All Contributors][link-contributors]

[badge_laravel]: https://img.shields.io/badge/For-Laravel%205.1|5.2|5.3-orange.svg?style=flat-square
[badge_license]: https://img.shields.io/packagist/l/arcanedev/laravel-seo.svg?style=flat-square
[badge_build]: https://img.shields.io/travis/ARCANEDEV/LaravelSeo.svg?style=flat-square
[badge_coverage]: https://img.shields.io/scrutinizer/coverage/g/ARCANEDEV/LaravelSeo.svg?style=flat-square
[badge_quality]: https://img.shields.io/scrutinizer/g/ARCANEDEV/LaravelSeo.svg?style=flat-square
[badge_insight]: https://img.shields.io/sensiolabs/i/[id].svg?style=flat-square
[badge_issues]: https://img.shields.io/github/issues/ARCANEDEV/LaravelSeo.svg?style=flat-square
[badge_package]: https://img.shields.io/badge/package-arcanedev/laravel--seo-blue.svg?style=flat-square
[badge_release]: https://img.shields.io/packagist/v/arcanedev/laravel-seo.svg?style=flat-square
[badge_downloads]: https://img.shields.io/packagist/dt/arcanedev/laravel-seo.svg?style=flat-square

[link-author]: https://github.com/arcanedev-maroc
[link-github-repo]: https://github.com/ARCANEDEV/LaravelSeo
[link-github-issues]: https://github.com/ARCANEDEV/LaravelSeo/issues
[link-contributors]: https://github.com/ARCANEDEV/LaravelSeo/graphs/contributors
[link-packagist]: https://packagist.org/packages/arcanedev/laravel-seo
[link-travis]: https://travis-ci.org/ARCANEDEV/LaravelSeo
[link-scrutinizer]: https://scrutinizer-ci.com/g/ARCANEDEV/LaravelSeo/?branch=master
[link-insight]: https://insight.sensiolabs.com/projects/[id]
43 changes: 43 additions & 0 deletions composer.json
@@ -0,0 +1,43 @@
{
"name": "arcanedev/laravel-seo",
"description": "SEO Package for Laravel.",
"keywords": ["arcanedev", "laravel", "seo"],
"homepage": "https://github.com/ARCANEDEV/LaravelSeo",
"authors": [
{
"name": "ARCANEDEV",
"email": "arcanedev.maroc@gmail.com",
"homepage": "https://github.com/arcanedev-maroc",
"role": "Developer"
}
],
"type": "library",
"license": "MIT",
"require": {
"php": ">=5.6",
"arcanedev/support": "~3.20"
},
"require-dev": {
"phpunit/phpcov": "~3.0",
"phpunit/phpunit": "~5.0",
"orchestra/testbench": "~3.0"
},
"autoload": {
"psr-4": {
"Arcanedev\\LaravelSeo\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Arcanedev\\LaravelSeo\\Tests\\": "tests/"
}
},
"scripts": {
"testbench": "composer require --dev \"orchestra/testbench=~3.0\""
},
"extra": {
"branch-alias": {
"dev-master": "1.0-dev"
}
}
}
5 changes: 5 additions & 0 deletions config/laravel-seo.php
@@ -0,0 +1,5 @@
<?php

return [
//
];
29 changes: 29 additions & 0 deletions phpunit.xml
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit backupGlobals="false"
backupStaticAttributes="false"
bootstrap="vendor/autoload.php"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false"
>
<testsuites>
<testsuite name="Package Test Suite">
<directory suffix=".php">./tests/</directory>
<exclude>./tests/fixtures/</exclude>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">./src/</directory>
</whitelist>
</filter>
<logging>
<log type="coverage-clover" target="build/logs/clover.xml"/>
<log type="coverage-text" target="build/logs/coverage.txt"/>
<log type="coverage-html" target="build/logs/coverage" charset="UTF-8" yui="true" highlight="true"/>
</logging>
</phpunit>
67 changes: 67 additions & 0 deletions src/LaravelSeoServiceProvider.php
@@ -0,0 +1,67 @@
<?php namespace Arcanedev\LaravelSeo;

use Arcanedev\Support\PackageServiceProvider;

/**
* Class LaravelSeoServiceProvider
*
* @package Arcanedev\LaravelSeo
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*/
class LaravelSeoServiceProvider extends PackageServiceProvider
{
/* ------------------------------------------------------------------------------------------------
| Properties
| ------------------------------------------------------------------------------------------------
*/
/**
* Package name.
*
* @var string
*/
protected $package = 'laravel-seo';

/* ------------------------------------------------------------------------------------------------
| Getters & Setters
| ------------------------------------------------------------------------------------------------
*/
/**
* Get the base path of the package.
*
* @return string
*/
public function getBasePath()
{
return dirname(__DIR__);
}

/* ------------------------------------------------------------------------------------------------
| Main Functions
| ------------------------------------------------------------------------------------------------
*/
/**
* Register the service provider.
*/
public function register()
{
$this->registerConfig();
}

/**
* Boot the service provider.
*/
public function boot()
{
parent::boot();
}

/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
return [];
}
}

0 comments on commit 2997390

Please sign in to comment.