Update namespacesUpdate namespaces

AlexanderPoellmann · AlexanderPoellmann · commit 8b8df0c0a657 · 2016-10-22T16:09:47.000+02:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Alexander Manfred Poellmann
+Copyright (c) 2015-2016 Alexander Manfred Poellmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,5 +18,4 @@ 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.
-
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,49 +1,46 @@
-[![Latest Stable Version](https://poser.pugx.org/vendocrat/laravel-followers/v/stable)](https://packagist.org/packages/vendocrat/laravel-followers)
-[![Total Downloads](https://poser.pugx.org/vendocrat/laravel-followers/downloads)](https://packagist.org/packages/vendocrat/laravel-followers)
-[![License](https://poser.pugx.org/vendocrat/laravel-followers/license)](https://packagist.org/packages/vendocrat/laravel-followers)
+[![Latest Stable Version](https://poser.pugx.org/lecturize/laravel-followers/v/stable)](https://packagist.org/packages/lecturize/laravel-followers)
+[![Total Downloads](https://poser.pugx.org/lecturize/laravel-followers/downloads)](https://packagist.org/packages/lecturize/laravel-followers)
+[![License](https://poser.pugx.org/lecturize/laravel-followers/license)](https://packagist.org/packages/lecturize/laravel-followers)
 
 # Laravel Followers
 
 Build a poly-morph Follower system or simply associate Eloquent models in Laravel 5.
 
-**Attention:** This package is a work in progress, please use with care and be sure to report any issues!
+## Important Notice
+
+**This package is a work in progress**, please use with care and feel free to report any issues or ideas you may have!
+
+We've transferred this package to a new owner and therefor updated the namespaces to **Lecturize\Followers**. The config file is now `config/lecturize.php`.
 
 ## Installation
 
 Require the package from your `composer.json` file
 
 ```php
 "require": {
-	"vendocrat/laravel-followers": "dev-master"
+	"lecturize/laravel-followers": "dev-master"
 }
 ```
 
-and run `$ composer update` or both in one with `$ composer require vendocrat/laravel-followers`.
+and run `$ composer update` or both in one with `$ composer require lecturize/laravel-followers`.
 
 Next register the service provider and (optional) facade to your `config/app.php` file
 
 ```php
 'providers' => [
     // Illuminate Providers ...
     // App Providers ...
-    vendocrat\Followers\FollowersServiceProvider::class
-];
-```
-
-```php
-'providers' => [
-	// Illuminate Facades ...
-    'Followers' => vendocrat\Followers\Facades\Followers::class
+    Lecturize\Followers\FollowersServiceProvider::class
 ];
 ```
 
 ## Configuration & Migration
 
 ```bash
-$ php artisan vendor:publish --provider="vendocrat\Followers\FollowersServiceProvider"
+$ php artisan vendor:publish --provider="Lecturize\Followers\FollowersServiceProvider"
 ```
 
-This will create a `config/followers.php` and a migration file. In the config file you can customize the table names, finally you'll have to run migration like so:
+This will create a `config/lecturize.php` and a migration file. In the config file you can customize the table names, finally you'll have to run migration like so:
 
 ```bash
 $ php artisan migrate
@@ -55,4 +52,4 @@ Licensed under [MIT license](http://opensource.org/licenses/MIT).
 
 ## Author
 
-**Handcrafted with love by [Alexander Manfred Poellmann](http://twitter.com/AMPoellmann) for [vendocrat](https://vendocr.at) in Vienna &amp; Rome.**
+**Handcrafted with love by [Alexander Manfred Poellmann](http://twitter.com/AMPoellmann) for [Lecturize](https://lecturize.com) in Vienna &amp; Rome.**
diff --git a/config/config.php b/config/config.php
@@ -1,16 +1,21 @@
 <?php
 
 return [
-	/**
-	 * Pivot Table to relate Follower and Followables
-	 */
-	'table' => 'followables',
+    /*
+     * Contacts
+     */
+    'follower' => [
+        /*
+         * Relationship table for followers and followables
+         */
+        'table' => 'followables',
 
-	/**
-	 * Cache follower/following counts
-	 */
-	'cache' => [
-		'enable' => true,
-		'expiry' => 10,
-	]
+        /*
+         * Cache follower/following counts
+         */
+        'cache' => [
+            'enable' => true,
+            'expiry' => 10,
+        ]
+    ],
 ];
diff --git a/database/migrations/create_followers_table.php.stub b/database/migrations/create_followers_table.php.stub
@@ -15,7 +15,7 @@ class FollowersTable extends Migration
      */
     public function __construct()
     {
-        $this->table = config('followers.table');
+        $this->table = config('lecturize.followers.table', 'followables');
     }
 
     /**
diff --git a/src/Contracts/CanFollowInterface.php b/src/Contracts/CanFollowInterface.php
@@ -1,6 +1,9 @@
-<?php namespace vendocrat\Followers\Contracts;
+<?php namespace Lecturize\Followers\Contracts;
 
 interface CanFollowInterface
 {
+    /**
+     * @return mixed
+     */
 //	public function following();
 }
diff --git a/src/Contracts/FollowableInterface.php b/src/Contracts/FollowableInterface.php
@@ -1,6 +1,9 @@
-<?php namespace vendocrat\Followers\Contracts;
+<?php namespace Lecturize\Followers\Contracts;
 
 interface FollowableInterface
 {
+    /**
+     * @return mixed
+     */
 //	public function followers();
 }
diff --git a/src/Exceptions/AlreadyFollowingException.php b/src/Exceptions/AlreadyFollowingException.php
@@ -1,4 +1,4 @@
-<?php namespace vendocrat\Followers\Exceptions;
+<?php namespace Lecturize\Followers\Exceptions;
 
 class AlreadyFollowingException extends \Exception
 {
diff --git a/src/Exceptions/CannotBeFollowedException.php b/src/Exceptions/CannotBeFollowedException.php
@@ -1,4 +1,4 @@
-<?php namespace vendocrat\Followers\Exceptions;
+<?php namespace Lecturize\Followers\Exceptions;
 
 class CannotBeFollowedException extends \Exception
 {
diff --git a/src/Exceptions/FollowerNotFoundException.php b/src/Exceptions/FollowerNotFoundException.php
@@ -1,4 +1,4 @@
-<?php namespace vendocrat\Followers\Exceptions;
+<?php namespace Lecturize\Followers\Exceptions;
 
 class FollowerNotFoundException extends \Exception
 {
diff --git a/src/Facades/Follower.php b/src/Facades/Follower.php
@@ -1,17 +1,14 @@
-<?php namespace vendocrat\Followers\Facades;
+<?php namespace Lecturize\Followers\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use vendocrat\Followers\Followers;
 
 class Follower extends Facade
 {
 	/**
-	 * Get the registered name of the component.
-	 *
-	 * @return string
+     * @inheritdoc
 	 */
 	protected static function getFacadeAccessor()
 	{
-		return Followers::class;
+		return 'followers';
 	}
 }
diff --git a/src/Followers.php b/src/Followers.php
diff --git a/src/FollowersServiceProvider.php b/src/FollowersServiceProvider.php
@@ -1,28 +1,22 @@
-<?php namespace vendocrat\Followers;
+<?php namespace Lecturize\Followers;
 
 use Illuminate\Support\ServiceProvider;
 
 class FollowersServiceProvider extends ServiceProvider
 {
+    protected $migrations = [
+        'CreateFollowersTable' => 'create_followers_table'
+    ];
+
 	/**
 	 * Boot the service provider.
 	 *
 	 * @return void
 	 */
 	public function boot()
 	{
-		$this->publishes([
-			__DIR__ .'/../config/config.php' => config_path('followers.php')
-		], 'config');
-
-		if ( ! class_exists('CreateMediaTable') ) {
-			$timestamp = date('Y_m_d_His', time());
-
-			$this->publishes([
-				__DIR__ .'/../database/migrations/create_media_table.php.stub' =>
-					database_path('migrations/'. $timestamp .'_create_followers_table.php')
-			], 'migrations');
-		}
+        $this->handleConfig();
+        $this->handleMigrations();
 	}
 
 	/**
@@ -32,25 +26,47 @@ public function boot()
 	 */
 	public function register()
 	{
-		$this->mergeConfigFrom(
-			__DIR__ .'/../config/config.php',
-			'followers'
-		);
-
-		$this->app->singleton(Followers::class, function ($app) {
-			return new Followers($app);
-		});
+	//  $this->app->singleton(Lecturize::class);
 	}
 
 	/**
-	 * Get the services provided by the provider.
-	 *
-	 * @return string[]
+     * @inheritdoc
 	 */
 	public function provides()
 	{
-		return [
-			Followers::class
-		];
+		return [];
 	}
-}
+
+    /**
+     * Publish and merge the config file
+     *
+     * @return void
+     */
+    private function handleConfig()
+    {
+        $configPath = __DIR__ . '/../config/config.php';
+
+        $this->publishes([$configPath => config_path('lecturize.php')]);
+
+        $this->mergeConfigFrom($configPath, 'lecturize');
+    }
+
+    /**
+     * Publish migrations
+     *
+     * @return void
+     */
+    private function handleMigrations()
+    {
+        foreach ( $this->migrations as $class => $file ) {
+            if ( ! class_exists($class) ) {
+                $timestamp = date('Y_m_d_His', time());
+
+                $this->publishes([
+                    __DIR__ .'/../database/migrations/'. $file .'.php.stub' =>
+                        database_path('migrations/'. $timestamp .'_'. $file .'.php')
+                ], 'migrations');
+            }
+        }
+    }
+}
diff --git a/src/Models/Followable.php b/src/Models/Followable.php
@@ -1,51 +1,37 @@
-<?php namespace vendocrat\Followers\Models;
+<?php namespace Lecturize\Followers\Models;
 
 use Illuminate\Database\Eloquent\Model;
 
 /**
  * Class Followable
- * @package vendocrat\Followers\Models
+ * @package Lecturize\Followers\Models
  */
 class Followable extends Model
 {
-	/**
-	 * The database table used by the model.
-	 *
-	 * @var string
-	 */
+    /**
+     * @todo make this editable via config file
+     * @inheritdoc
+     */
 	protected $table = 'followables';
 
-	/**
-	 * The attributes that are mass assignable.
-	 *
-	 * @var array
-	 */
+    /**
+     * @inheritdoc
+     */
 	protected $fillable = [
 		'follower_id',
 		'follower_type',
 		'followable_id',
 		'followable_type',
 	];
 
-	/**
-	 * The attributes excluded from the model's JSON form.
-	 *
-	 * @var array
-	 */
-	protected $hidden = [];
-
-	/**
-	 * The attributes that should be mutated to dates.
-	 *
-	 * @var array
-	 */
+    /**
+     * @inheritdoc
+     */
 	protected $dates = ['deleted_at'];
 
-	/**
-	 * The relations to eager load on every query.
-	 *
-	 * @var array
-	 */
+    /**
+     * @inheritdoc
+     */
 	protected $with = ['followable', 'follower'];
 
 	/**
diff --git a/src/Traits/CanFollowTrait.php b/src/Traits/CanFollowTrait.php
diff --git a/src/Traits/FollowableTrait.php b/src/Traits/FollowableTrait.php

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class FollowersTable extends Migration`
`15`	`15`	`*/`
`16`	`16`	`public function __construct()`
`17`	`17`	`{`
`18`		`- $this->table = config('followers.table');`
	`18`	`+ $this->table = config('lecturize.followers.table', 'followables');`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`		`-<?php namespace vendocrat\Followers\Contracts;`
	`1`	`+<?php namespace Lecturize\Followers\Contracts;`
`2`	`2`
`3`	`3`	`interface CanFollowInterface`
`4`	`4`	`{`
	`5`	`+ /**`
	`6`	`+ * @return mixed`
	`7`	`+ */`
`5`	`8`	`// public function following();`
`6`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<?php namespace vendocrat\Followers\Exceptions;`
	`1`	`+<?php namespace Lecturize\Followers\Exceptions;`
`2`	`2`
`3`	`3`	`class AlreadyFollowingException extends \Exception`
`4`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,14 @@`
`1`		`-<?php namespace vendocrat\Followers\Facades;`
	`1`	`+<?php namespace Lecturize\Followers\Facades;`
`2`	`2`
`3`	`3`	`use Illuminate\Support\Facades\Facade;`
`4`		`-use vendocrat\Followers\Followers;`
`5`	`4`
`6`	`5`	`class Follower extends Facade`
`7`	`6`	`{`
`8`	`7`	`/**`
`9`		`- * Get the registered name of the component.`
`10`		`- *`
`11`		`- * @return string`
	`8`	`+ * @inheritdoc`
`12`	`9`	`*/`
`13`	`10`	`protected static function getFacadeAccessor()`
`14`	`11`	`{`
`15`		`- return Followers::class;`
	`12`	`+ return 'followers';`
`16`	`13`	`}`
`17`	`14`	`}`