Initial commit

Author: stidges

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.phar
+composer.lock
+.DS_STORE

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Stidges <info@stidges.com>
+
+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.

README.md

@@ -0,0 +1,92 @@
+Laravel DB Normalizer
+=====================
+
+This [Laravel](http://www.laravel.com) package allows you to easily swap out your repository implementations, by providing a unified interface to your database / persistance layer results.
+
+It intercepts your results and turns them into collections and entities. That way, whether you are using Eloquent, the Query Builder or any other implementation, the results will be the same!
+
+![Result](http://i.imgur.com/Y0rEyYq.jpg)
+
+## Getting Started
+
+This package can be installed through [Composer](http://www.getcomposer.org), just add it to your composer.json file:
+
+```json
+{
+    "require": {
+        "stidges/laravel-db-normalizer": "0.*"
+    }
+}
+```
+
+After you have added it to your composer.json file, make sure you update your dependencies:
+
+```sh
+composer install
+```
+
+Next, you can do either of these two:
+
+##### 1. Enable auto-normalization:
+
+By registering this package's ServiceProvider class, all the queries you run will be automatically normalized to the unified `Collection` and `Entity` classes. Add the following line to your `app/config/app.php` file:
+
+```php
+'Stidges\LaravelDbNormalizer\DbNormalizerServiceProvider',
+```
+
+When using Eloquent models, they should extend the `NormalizableModel` class:
+
+```php
+use Stidges\LaravelDbNormalizer\NormalizableModel;
+
+class User extends NormalizableModel
+{
+    // ...
+}
+```
+
+
+##### 2. Disable auto-normalization:
+
+If you would rather want some more control, don't register the ServiceProvider. That way you can control when the results get cast to the classes. To do this, `use` the Normalizer class. **Make sure you always pass an array to the normalizer!**
+
+```php
+use Stidges\LaravelDbNormalizer\Normalizer;
+
+//...
+
+// Example using the query builder
+$result = DB::table('users')->get();
+// ... Do stuff with the result.
+$normalized = with(new Normalizer)->normalize($result);
+
+// Example using Eloquent
+$user = User::find(1);
+// ... Do stuff with the user.
+$normalized = with(new Normalizer)->normalize($user->toArray());
+
+// Example using Eloquent collection
+$users = User::all();
+// ... Do stuff with the users.
+$normalized = with(new Normalizer)->normalize($users->toArray());
+```
+
+## Using the normalized results
+
+This package provides 2 classes:
+
+1. A `Collection` class. As it currently stand, this class just extends Laravel's  `Illuminate\Support\Collection` class.
+2. An `Entity` class. This class can contain nested entities and collections (relations). It provides a fluent interface to accessing the attributes of the entity, and can be cast to an array or JSON using the familiar `toJson` and `toArray` methods. On top of that, it provides a `getDirtyAttributes()` function, which allows you to get all the attributes that were changed after creation.
+
+## Example usage
+
+For examples on how to use the package, please view the `examples` directory!
+
+## Contributing
+
+All suggestions and pull requests are welcome! If you make any substantial changes, please provide tests along with your pull requests!
+
+## License
+
+Copyright (c) 2014 Stidges - Released under the [MIT license](LICENSE).

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "stidges/laravel-db-normalizer",
+    "description": "Normalize all database results to one unified interface, to make swapping repositories a breeze.",
+    "version": "0.1.0",
+    "homepage": "https://github.com/stidges/laravel-db-normalizer",
+    "authors": [
+        {
+            "name": "Stidges",
+            "email": "info@stidges.com",
+            "homepage": "http://twitter.com/stidges"
+        }
+    ],
+    "keywords": [
+        "db",
+        "normalizer",
+        "laravel",
+        "eloquent",
+        "repositories"
+    ],
+    "require": {
+        "php": ">=5.4.0",
+        "illuminate/database": "4.1.*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "4.0.*",
+        "mockery/mockery": "dev-master"
+    },
+    "autoload": {
+        "psr-4": {
+            "Stidges\\LaravelDbNormalizer\\": "src/"
+        }
+    },
+    "config": {
+        "preferred-install": "dist"
+    },
+    "minimum-stability": "stable",
+    "license": "MIT"
+}

examples/AutoNormalized/DbUserRepository.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Stidges\Examples\AutoNormalized;
+
+use Stidges\Examples\UserRepositoryInterface;
+use Illuminate\Database\DatabaseManager;
+use Stidges\LaravelDbNormalizer\Normalizer;
+
+class DbUserRepository implements UserRepositoryInterface
+{
+    /**
+     * DatabaseManager instance.
+     *
+     * @var \Illuminate\Database\DatabaseManager
+     */
+    protected $db;
+
+    /**
+     * The table name for the users.
+     *
+     * @var string
+     */
+    protected $table = 'users';
+
+    /**
+     * The fields that are fillable.
+     *
+     * @var array
+     */
+    protected $fillable = [ 'name', 'email' ];
+
+    /**
+     * Create a new user repository.
+     *
+     * @param  \Illuminate\Database\DatabaseManager  $db
+     * @return void
+     */
+    public function __construct(DatabaseManager $db)
+    {
+        $this->db = $db;
+    }
+
+    /**
+     * Get all users.
+     *
+     * @return \Stidges\LaravelDbNormalizer\Collection
+     */
+    public function getAll()
+    {
+        return $this->db->table($this->table)
+                        ->get();
+    }
+
+    /**
+     * Get a user by its ID.
+     *
+     * @param  mixed  $id
+     * @return \Stidges\LaravelDbNormalizer\Entity
+     */
+    public function getById($id)
+    {
+        return $this->db->table($this->table)
+                        ->where('id', $id)
+                        ->first();
+    }
+
+    /**
+     * Create a new user.
+     *
+     * @param  \Stidges\LaravelDbNormalizer\Entity  $user
+     * @return bool
+     */
+    public function create(Entity $user)
+    {
+        $data = array_only($user->toArray(), $this->fillable);
+
+        return $this->db->table($this->table)
+                        ->insert($data);
+    }
+
+    /**
+     * Update an existing user.
+     *
+     * @param  \Stidges\LaravelDbNormalizer\Entity  $user
+     * @return bool
+     */
+    public function update(Entity $user)
+    {
+        $data = array_only($user->toArray(), $this->fillable);
+
+        return (bool) $this->db->table($this->table)
+                               ->where('id', $user->id)
+                               ->update($data);
+    }
+}

examples/AutoNormalized/EloquentUserRepository.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Stidges\Examples\AutoNormalized;
+
+use Stidges\Examples\User;
+use Stidges\Examples\UserRepositoryInterface;
+
+class EloquentUserRepository implements UserRepositoryInterface
+{
+    /**
+     * User model.
+     *
+     * @var \Stidges\Examples\User
+     */
+    protected $model;
+
+    /**
+     * Create a new user repository.
+     *
+     * @param  \Stidges\Examples\User  $model
+     * @return void
+     */
+    public function __construct(User $model)
+    {
+        $this->model = $model;
+    }
+
+    /**
+     * Get all users.
+     *
+     * @return \Stidges\LaravelDbNormalizer\Collection
+     */
+    public function getAll()
+    {
+        return $this->model->all();
+    }
+
+    /**
+     * Get a user by its ID.
+     *
+     * @param  mixed  $id
+     * @return \Stidges\LaravelDbNormalizer\Entity
+     */
+    public function getById($id)
+    {
+        return $this->model->find($id);
+    }
+
+    /**
+     * Create a new user.
+     *
+     * @param  \Stidges\LaravelDbNormalizer\Entity  $user
+     * @return bool
+     */
+    public function create(Entity $user)
+    {
+        $model = $this->model->newInstance($user->toArray());
+
+        return $model->save();
+    }
+
+    /**
+     * Update an existing user.
+     *
+     * @param  \Stidges\LaravelDbNormalizer\Entity  $user
+     * @return bool
+     */
+    public function update(Entity $user)
+    {
+        $model = $this->model->newInstance($user->toArray(), true);
+        $model->id = $user->id;
+
+        return $user->getDirtyAttributes() ? $model->save() : $model->touch();
+    }
+}