Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0 #3

Merged
merged 5 commits into from
Sep 9, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add support of Laravel 5.5. Update namespace
  • Loading branch information
antonkomarev committed Jul 29, 2017
commit b9e9fddb803213d7e78e4ee8291cbc781568f6b8
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sudo: false
php:
- 7.0
- 7.1
- 7.2

env:
global:
Expand Down
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

All notable changes to `laravel-optimus` will be documented in this file.

## [2.0.0] - 2017-07-29

### Added

- Laravel 5.5 support
- Service provider and facade auto-discovery

### Changed

- Namespace `Cog\Optimus` renamed to `Cog\Laravel\Optimus`

## 1.0.0 - 2017-01-01

Initial release

[2.0.0]: https://github.com/cybercog/laravel-optimus/compare/1.0.0...2.0.0
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![cog-laravel-optimus-3](https://cloud.githubusercontent.com/assets/1849174/21738350/6c08b624-d494-11e6-9895-94e7d5f39010.png)
![cog-laravel-optimus](https://user-images.githubusercontent.com/1849174/28744713-5b28fffa-746f-11e7-8ca2-0e2a612bc19c.png)

<p align="center">
<a href="https://travis-ci.org/cybercog/laravel-optimus"><img src="https://img.shields.io/travis/cybercog/laravel-optimus/master.svg?style=flat-square" alt="Build Status"></a>
Expand All @@ -16,6 +16,7 @@ Laravel wrapper for the [Optimus Library](https://github.com/jenssegers/optimus)
- Designed to work with Laravel Eloquent models.
- Configurable multiple connections support.
- Following PHP Standard Recommendations:
- [PSR-1 (Basic Coding Standard)](http://www.php-fig.org/psr/psr-1/).
- [PSR-2 (Coding Style Guide)](http://www.php-fig.org/psr/psr-2/).
- [PSR-4 (Autoloading Standard)](http://www.php-fig.org/psr/psr-4/).
- Covered with unit tests.
Expand All @@ -32,15 +33,15 @@ And then include the service provider within `app/config/app.php`.

```php
'providers' => [
Cog\Optimus\Providers\OptimusServiceProvider::class,
Cog\Laravel\Optimus\Providers\OptimusServiceProvider::class,
],
```

If you want you can use the [facade](http://laravel.com/docs/facades). Add the reference in `config/app.php` to your aliases array.

```php
'aliases' => [
'Optimus' => Cog\Optimus\Facades\Optimus::class,
'Optimus' => Cog\Laravel\Optimus\Facades\Optimus::class,
],
```

Expand All @@ -49,7 +50,7 @@ If you want you can use the [facade](http://laravel.com/docs/facades). Add the r
Laravel Optimus requires connection configuration. To get started, you'll need to publish config file:

```sh
$ php artisan vendor:publish --provider="Cog\Optimus\Providers\OptimusServiceProvider" --tag="config"
$ php artisan vendor:publish --provider="Cog\Laravel\Optimus\Providers\OptimusServiceProvider" --tag="config"
```

This will create a `config/optimus.php` file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
Expand Down Expand Up @@ -99,21 +100,21 @@ Here you can see an example of just how simple this package is to use. Out of th
#### Encode ID

```php
Cog\Optimus\Facades\Optimus::encode(20); // 1535832388
Cog\Laravel\Optimus\Facades\Optimus::encode(20); // 1535832388
```

#### Decode ID

```php
Cog\Optimus\Facades\Optimus::decode(1535832388); // 20
Cog\Laravel\Optimus\Facades\Optimus::decode(1535832388); // 20
```

#### Alter Optimus connection

The Optimus manager will behave like it is a `Jenssegers\Optimus\Optimus`. If you want to call specific connections, you can do that with the connection method:

```php
use Cog\Optimus\Facades\Optimus;
use Cog\Laravel\Optimus\Facades\Optimus;

// Writing this…
Optimus::connection('main')->encode($id);
Expand All @@ -136,7 +137,7 @@ Optimus::setDefaultConnection('alternative'); // The default is now alternative.
If you prefer to use dependency injection over facades like me, then you can inject the manager:

```php
use Cog\Optimus\OptimusManager;
use Cog\Laravel\Optimus\OptimusManager;

class Foo
{
Expand Down
28 changes: 19 additions & 9 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,27 +34,27 @@
"docs": "https://github.com/cybercog/laravel-optimus/wiki"
},
"require": {
"graham-campbell/manager": "^2.5",
"illuminate/contracts": "~5.2.0|~5.3.0|~5.4.0",
"illuminate/support": "~5.2.0|~5.3.0|~5.4.0",
"jenssegers/optimus": "^0.2.2",
"php": "^7.0"
"php": "^7.0",
"graham-campbell/manager": "^3.0",
"illuminate/contracts": "~5.2|~5.3|~5.4|~5.5",
"illuminate/support": "~5.2|~5.3|~5.4|~5.5",
"jenssegers/optimus": "^0.2.2"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^1.11",
"graham-campbell/testbench": "^3.3",
"graham-campbell/testbench": "^4.0",
"mockery/mockery": "^0.9.8",
"orchestra/testbench": "~3.4.0",
"phpunit/phpunit": "^5.7"
"phpunit/phpunit": "^6.2"
},
"autoload": {
"psr-4": {
"Cog\\Optimus\\": "src/"
"Cog\\Laravel\\Optimus\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Cog\\Optimus\\Tests\\": "tests/"
"Cog\\Laravel\\Optimus\\Tests\\": "tests/"
}
},
"scripts": {
Expand All @@ -63,6 +63,16 @@
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"Cog\\Laravel\\Optimus\\Providers\\OptimusServiceProvider"
],
"aliases": {
"Optimus": "Cog\\Laravel\\Optimus\\Facades\\Optimus"
}
}
},
"minimum-stability": "dev",
"prefer-stable" : true
}
4 changes: 2 additions & 2 deletions src/Facades/Optimus.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

declare(strict_types=1);

namespace Cog\Optimus\Facades;
namespace Cog\Laravel\Optimus\Facades;

use Illuminate\Support\Facades\Facade;

/**
* Class Optimus.
*
* @package Cog\Optimus\Facades
* @package Cog\Laravel\Optimus\Facades
*/
class Optimus extends Facade
{
Expand Down
4 changes: 2 additions & 2 deletions src/OptimusFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

declare(strict_types=1);

namespace Cog\Optimus;
namespace Cog\Laravel\Optimus;

use Jenssegers\Optimus\Optimus;

/**
* Class OptimusFactory.
*
* @package Cog\Optimus
* @package Cog\Laravel\Optimus
*/
class OptimusFactory
{
Expand Down
10 changes: 5 additions & 5 deletions src/OptimusManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

declare(strict_types=1);

namespace Cog\Optimus;
namespace Cog\Laravel\Optimus;

use Jenssegers\Optimus\Optimus;
use GrahamCampbell\Manager\AbstractManager;
Expand All @@ -20,22 +20,22 @@
/**
* Class OptimusManager.
*
* @package Cog\Optimus
* @package Cog\Laravel\Optimus
*/
class OptimusManager extends AbstractManager
{
/**
* The factory instance.
*
* @var \Cog\Optimus\OptimusFactory
* @var \Cog\Laravel\Optimus\OptimusFactory
*/
private $factory;

/**
* Create a new Optimus manager instance.
*
* @param \Illuminate\Contracts\Config\Repository $config
* @param \Cog\Optimus\OptimusFactory $factory
* @param \Cog\Laravel\Optimus\OptimusFactory $factory
* @return void
*/
public function __construct(Repository $config, OptimusFactory $factory)
Expand Down Expand Up @@ -69,7 +69,7 @@ protected function getConfigName() : string
/**
* Get the factory instance.
*
* @return \Cog\Optimus\OptimusFactory
* @return \Cog\Laravel\Optimus\OptimusFactory
*/
public function getFactory() : OptimusFactory
{
Expand Down
8 changes: 4 additions & 4 deletions src/Providers/OptimusServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

declare(strict_types=1);

namespace Cog\Optimus\Providers;
namespace Cog\Laravel\Optimus\Providers;

use Cog\Optimus\OptimusFactory;
use Cog\Optimus\OptimusManager;
use Cog\Laravel\Optimus\OptimusFactory;
use Cog\Laravel\Optimus\OptimusManager;
use Jenssegers\Optimus\Optimus;
use Illuminate\Support\ServiceProvider;
use Illuminate\Contracts\Container\Container;
Expand All @@ -24,7 +24,7 @@
/**
* Class OptimusServiceProvider.
*
* @package Cog\Optimus
* @package Cog\Laravel\Optimus\Providers
*/
class OptimusServiceProvider extends ServiceProvider
{
Expand Down
6 changes: 3 additions & 3 deletions tests/AbstractTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@

declare(strict_types=1);

namespace Cog\Optimus\Tests;
namespace Cog\Laravel\Optimus\Tests;

use Cog\Optimus\Providers\OptimusServiceProvider;
use Cog\Laravel\Optimus\Providers\OptimusServiceProvider;
use GrahamCampbell\TestBench\AbstractPackageTestCase;

/**
* Class AbstractTestCase.
*
* @package Cog\Optimus\Tests
* @package Cog\Laravel\Optimus\Tests
*/
abstract class AbstractTestCase extends AbstractPackageTestCase
{
Expand Down
10 changes: 5 additions & 5 deletions tests/Facades/OptimusTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@

declare(strict_types=1);

namespace Cog\Optimus\Tests\Facades;
namespace Cog\Laravel\Optimus\Tests\Facades;

use Cog\Optimus\OptimusManager;
use Cog\Optimus\Facades\Optimus;
use Cog\Optimus\Tests\AbstractTestCase;
use Cog\Laravel\Optimus\OptimusManager;
use Cog\Laravel\Optimus\Facades\Optimus;
use Cog\Laravel\Optimus\Tests\AbstractTestCase;
use GrahamCampbell\TestBenchCore\FacadeTrait;

/**
* Class OptimusTest.
*
* @package Cog\Optimus\Tests\Facades
* @package Cog\Laravel\Optimus\Tests\Facades
*/
class OptimusTest extends AbstractTestCase
{
Expand Down
6 changes: 3 additions & 3 deletions tests/OptimusFactoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@

declare(strict_types=1);

namespace Cog\Optimus\Tests;
namespace Cog\Laravel\Optimus\Tests;

use Cog\Optimus\OptimusFactory;
use Cog\Laravel\Optimus\OptimusFactory;
use Jenssegers\Optimus\Optimus;

/**
* Class OptimusFactoryTest.
*
* @package Cog\Optimus\Tests
* @package Cog\Laravel\Optimus\Tests
*/
class OptimusFactoryTest extends AbstractTestCase
{
Expand Down
8 changes: 4 additions & 4 deletions tests/OptimusManagerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@

declare(strict_types=1);

namespace Cog\Optimus\Tests;
namespace Cog\Laravel\Optimus\Tests;

use Mockery;
use Cog\Optimus\OptimusFactory;
use Cog\Optimus\OptimusManager;
use Cog\Laravel\Optimus\OptimusFactory;
use Cog\Laravel\Optimus\OptimusManager;
use Jenssegers\Optimus\Optimus;
use Illuminate\Contracts\Config\Repository;
use GrahamCampbell\TestBench\AbstractTestCase as AbstractTestBenchTestCase;

/**
* Class OptimusManagerTest.
*
* @package Cog\Optimus\Tests
* @package Cog\Laravel\Optimus\Tests
*/
class OptimusManagerTest extends AbstractTestBenchTestCase
{
Expand Down
8 changes: 4 additions & 4 deletions tests/Providers/ServiceProviderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@

declare(strict_types=1);

namespace Cog\Optimus\Tests;
namespace Cog\Laravel\Optimus\Tests;

use Cog\Optimus\OptimusFactory;
use Cog\Optimus\OptimusManager;
use Cog\Laravel\Optimus\OptimusFactory;
use Cog\Laravel\Optimus\OptimusManager;
use Jenssegers\Optimus\Optimus;
use GrahamCampbell\TestBenchCore\ServiceProviderTrait;

/**
* Class ServiceProviderTest.
*
* @package Cog\Optimus\Tests\Providers
* @package Cog\Laravel\Optimus\Tests\Providers
*/
class ServiceProviderTest extends AbstractTestCase
{
Expand Down