Skip to content

Commit

Permalink
Publishing the package
Browse files Browse the repository at this point in the history
  • Loading branch information
arcanedev-maroc committed May 12, 2017
1 parent 45c63b5 commit de81284
Show file tree
Hide file tree
Showing 32 changed files with 2,121 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
* text=auto

/.github export-ignore
/_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.dist export-ignore
CONTRIBUTING.md export-ignore
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- LaravelImpersonator Version: #.#.#
- Laravel Version: #.#.#
- PHP Version: #.#.#

### Description:

### Steps To Reproduce:
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/build/
/vendor/
composer.lock
composer.phar
35 changes: 35 additions & 0 deletions .scrutinizer.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
filter:
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: 3
php_code_sniffer:
enabled: true
config:
standard: PSR2
filter:
paths: ['src']
php_loc:
enabled: true
php_cpd:
enabled: true
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
language: php

sudo: false

php:
- 5.6
- 7.0
- 7.1
- nightly

matrix:
allow_failures:
- php: nightly

env:
- TESTBENCH_VERSION=3.4.*

before_script:
- travis_retry composer self-update
- travis_retry composer require --prefer-source --no-interaction --dev "orchestra/testbench-browser-kit:${TESTBENCH_VERSION}" "orchestra/database:${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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2017 | ARCANEDEV <[email protected]> - LaravelImpersonator

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.
47 changes: 47 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"name": "arcanedev/laravel-settings",
"description": "This package allows you to persists configs/settings for Laravel projects.",
"homepage": "https://github.com/ARCANEDEV/LaravelSettings",
"keywords": [
"arcanedev", "laravel", "config", "settings", "json", "array", "database", "db"
],
"authors": [
{
"name": "ARCANEDEV",
"email": "[email protected]",
"homepage": "https://github.com/arcanedev-maroc",
"role": "Developer"
}
],
"type": "library",
"license": "MIT",
"require": {
"php": ">=5.6",
"arcanedev/support": "~4.0"
},
"require-dev": {
"phpunit/phpcov": "~3.0",
"phpunit/phpunit": "~5.0"
},
"autoload": {
"psr-4": {
"Arcanedev\\LaravelSettings\\": "src/"
},
"files": ["helpers.php"]
},
"autoload-dev": {
"psr-4": {
"Arcanedev\\LaravelSettings\\Tests\\": "tests/"
}
},
"scripts": {
"testbench": "composer require --dev \"orchestra/testbench-browser-kit=~3.0\" \"orchestra/database=~3.0\""
},
"extra": {
"branch-alias": {
"dev-master": "1.0-dev"
}
},
"minimum-stability": "dev",
"prefer-stable" : true
}
43 changes: 43 additions & 0 deletions config/settings.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

return [

/* -----------------------------------------------------------------
| Default drivers
| -----------------------------------------------------------------
| Supported: 'array', 'json', 'database'
*/

'default' => 'json',

/* -----------------------------------------------------------------
| Drivers
| -----------------------------------------------------------------
*/

'drivers' => [

'array' => [
'driver' => Arcanedev\LaravelSettings\Stores\ArrayStore::class,
],

'json' => [
'driver' => Arcanedev\LaravelSettings\Stores\JsonStore::class,

'options' => [
'path' => storage_path('settings.json'),
],
],

'database' => [
'driver' => Arcanedev\LaravelSettings\Stores\DatabaseStore::class,

'options' => [
'connection' => null,
'table' => 'settings',
'model' => \Arcanedev\LaravelSettings\Models\Setting::class,
]
],

],
];
17 changes: 17 additions & 0 deletions helpers.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

if ( ! function_exists('settings')) {
/**
* Get the settings manager instance.
*
* @param string|null $driver
*
* @return \Arcanedev\LaravelSettings\Contracts\Manager|\Arcanedev\LaravelSettings\Contracts\Store
*/
function settings($driver = null) {
/** @var \Arcanedev\LaravelSettings\Contracts\Manager $manager */
$manager = app(Arcanedev\LaravelSettings\Contracts\Manager::class);

return $driver ? $manager->driver($driver) : $manager;
}
}
33 changes: 33 additions & 0 deletions phpunit.xml.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?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>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">./src/</directory>
</whitelist>
</filter>
<php>
<env name="APP_ENV" value="testing"/>
<env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
<env name="SESSION_DRIVER" value="array"/>
</php>
<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>
55 changes: 55 additions & 0 deletions src/Contracts/Manager.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php namespace Arcanedev\LaravelSettings\Contracts;

use Closure;

/**
* Interface SettingsManager
*
* @package Arcanedev\LaravelSettings\Contracts
* @author ARCANEDEV <[email protected]>
*/
interface Manager
{
/* -----------------------------------------------------------------
| Getters & Setters
| -----------------------------------------------------------------
*/

/**
* Get the default driver name.
*
* @return string
*/
public function getDefaultDriver();

/**
* Get all of the created "drivers".
*
* @return array
*/
public function getDrivers();

/* -----------------------------------------------------------------
| Main Methods
| -----------------------------------------------------------------
*/

/**
* Get a driver instance.
*
* @param string|null $driver
*
* @return \Arcanedev\LaravelSettings\Contracts\Store
*/
public function driver($driver = null);

/**
* Register a custom driver creator Closure.
*
* @param string $driver
* @param \Closure $callback
*
* @return \Arcanedev\LaravelSettings\Contracts\Manager
*/
public function extend($driver, Closure $callback);
}
Loading

0 comments on commit de81284

Please sign in to comment.