Sort likeable models by likes count (#15)

* Add scope to fetch likeable models by likes count

Author: Pe Ell

.gitattributes

@@ -4,6 +4,8 @@
 /.gitattributes export-ignore
 /.gitignore export-ignore
 /.php_cs export-ignore
+/.styleci.yml export-ignore
+/.travis.yml export-ignore
 /CODE_OF_CONDUCT.md export-ignore
 /CONTRIBUTING.md export-ignore
 /phpunit.xml.dist export-ignore

.travis.yml

@@ -1,12 +1,21 @@
 language: php
 
+sudo: false
+
 php:
   - 5.6
   - 7.0
   - 7.1
 
+env:
+  global:
+    - setup=basic
+
 before_script:
-  - travis_retry composer self-update
-  - travis_retry composer install --no-interaction
+  - composer config discard-changes true
+  - if [[ $setup = 'basic' ]]; then travis_retry composer install --prefer-dist --no-interaction; fi
+  - if [[ $setup = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable; fi
+  - if [[ $setup = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable; fi
 
-script: vendor/bin/phpunit --verbose
+script:
+  - ./vendor/bin/phpunit -c phpunit.xml.dist --verbose

CHANGELOG.md

@@ -2,34 +2,40 @@
 
 All notable changes to `laravel-likeable` will be documented in this file.
 
-## 2.1.0 - 2017-02-20
+## [2.2.0] - 2017-04-09
+
+### Added
+
+- `Article::sortedByLikesCount('asc')` scope for the model. Uses `desc` as default order direction.
+
+## [2.1.0] - 2017-02-20
 
 ### Added
 
 - Laravel 5.4 support.
 
-## 2.0.1 - 2017-01-11
+## [2.0.1] - 2017-01-11
 
 - Removed unused properties in `LikeObserver` #12
 - Foreign key in migration commented out #11
 
-## 2.0.0 - 2016-09-11
+## [2.0.0] - 2016-09-11
 
 - Renamed `FollowableService` methods to follow code style consistency:
     - `incrementLikeCount()` to `incrementLikesCount()`
     - `decrementLikeCount()` to `decrementLikesCount()`
     - `decrementDislikeCount()` to `decrementDislikesCount()`
     - `incrementDislikeCount()` to `incrementDislikesCount()`
 
-## 1.1.2 - 2016-09-07
+## [1.1.2] - 2016-09-07
 
 - Fix enum like types
 
-## 1.1.1 - 2016-09-07
+## [1.1.1] - 2016-09-07
 
 - Fix likeable enums database default value
 
-## 1.1.0 - 2016-09-07
+## [1.1.0] - 2016-09-07
 
 - Renamed `HasLikes` trait methods to follow code style consistency:
     - `likeCounter()` to `likesCounter()`
@@ -39,6 +45,7 @@ All notable changes to `laravel-likeable` will be documented in this file.
 
 - Initial release
 
+[2.2.0]: https://github.com/cybercog/laravel-likeable/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/cybercog/laravel-likeable/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/cybercog/laravel-likeable/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/cybercog/laravel-likeable/compare/1.1.2...2.0.0

CONTRIBUTING.md

@@ -21,15 +21,15 @@ Due to time constraints, we are not always able to respond as quickly as we woul
 
 This project comes with a configuration file for php-cs-fixer (.php_cs) that you can use to (re)format your sourcecode for compliance with this project's coding guidelines:
 
-```shell
+```sh
 vendor/bin/php-cs-fixer fix
 ```
 
 ## PHPUnit tests
 
 The phpunit script can be used to invoke the PHPUnit test runner:
 
-```shell
+```sh
 vendor/bin/phpunit
 ```
 

README.md

@@ -9,7 +9,27 @@
 
 ## Introduction
 
-Trait for Laravel Eloquent models to allow easy implementation of a `like` & `dislike` features.
+Laravel Likeable simplify management of Eloquent model's likes & dislikes. Make any model `likeable` & `dislikeable` in a minutes!
+
+## Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Prepare likeable model](#prepare-likeable-model)
+    - [Available methods](#available-methods)
+    - [Scopes](#scopes)
+    - [Events](#events)
+    - [Console commands](#console-commands)
+- [Extending](#extending)
+- [Change log](#change-log)
+- [Contributing](#contributing)
+- [Testing](#testing)
+- [Security](#security)
+- [Credits](#credits)
+- [Alternatives](#alternatives)
+- [License](#license)
+- [About CyberCog](#about-cybercog)
 
 ## Features
 
@@ -20,14 +40,15 @@ Trait for Laravel Eloquent models to allow easy implementation of a `like` & `di
 - Has Artisan command `likeable:recount {model?} {type?}` to re-fetch likes counters.
 - Likeable model can has Likes and Dislikes.
 - Likes and Dislikes for one model are mutually exclusive.
+- Get Likeable models ordered by likes count.
 - Events for `like`, `unlike`, `dislike`, `undislike` methods.
 - Covered with unit tests.
 
 ## Installation
 
 First, pull in the package through Composer.
 
-```shell
+```sh
 composer require cybercog/laravel-likeable
 ```
 
@@ -41,7 +62,7 @@ And then include the service provider within `app/config/app.php`.
 
 At last you need to publish and run database migrations.
 
-```shell
+```sh
 php artisan vendor:publish --provider="Cog\Likeable\Providers\LikeableServiceProvider" --tag=migrations
 php artisan migrate
 ```
@@ -62,7 +83,7 @@ class Article extends Model implements HasLikesContract {
 }
 ```
 
-### Available functions
+### Available methods
 
 #### Likes
 
@@ -222,6 +243,17 @@ $article->likesAndDislikes();
 $article->likesAndDislikes;
 ```
 
+### Scopes
+
+##### Fetch Likeable models by likes count
+
+```php
+$sortedArticles = Article::sortedByLikesCount()->get();
+$sortedArticles = Article::sortedByLikesCount('asc')->get();
+```
+
+*Uses `desc` as default order direction.*
+
 ### Events
 
 On each like added `\Cog\Likeable\Events\ModelWasLiked` event is fired.
@@ -236,49 +268,49 @@ On each dislike removed `\Cog\Likeable\Events\ModelWasUndisliked` event is fired
 
 ##### Recount likes and dislikes of all model types
 
-```shell
+```sh
 likeable:recount
 ```
 
 ##### Recount likes and dislikes of concrete model type (using morph map alias)
 
-```shell
+```sh
 likeable:recount --model="article"
 ```
 
 ##### Recount likes and dislikes of concrete model type (using fully qualified class name)
 
-```shell
+```sh
 likeable:recount --model="App\Models\Article"
 ```
 
 ##### Recount only likes of all model types
 
-```shell
+```sh
 likeable:recount --type="like"
 ```
 
 ##### Recount only likes of concrete model type (using morph map alias)
 
-```shell
+```sh
 likeable:recount --model="article" --type="like"
 ```
 
 ##### Recount only likes of concrete model type (using fully qualified class name)
 
-```shell
+```sh
 likeable:recount --model="App\Models\Article" --type="like"
 ```
 
 ##### Recount only dislikes of all model types
 
-```shell
+```sh
 likeable:recount --type="dislike"
 ```
 
 ##### Recount only dislikes of concrete model type (using morph map alias)
 
-```shell
+```sh
 likeable:recount --model="article" --type="dislike"
 ```
 
@@ -325,31 +357,31 @@ $model = app(\Cog\Likeable\Contracts\Like::class);
 $service = app(\Cog\Likeable\Contracts\LikeableService::class);
 ```
 
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
 ## Testing
 
 You can run the tests with:
 
-```shell
+```sh
 vendor/bin/phpunit
 ```
 
-## Contributing
-
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
-
 ## Security
 
-If you discover any security related issues, please email a.komarev@cybercog.su instead of using the issue tracker.
+If you discover any security related issues, please email oss@cybercog.su instead of using the issue tracker.
 
 ## Credits
 
 - [Anton Komarev](https://github.com/a-komarev)
 - [All Contributors](../../contributors)
 
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-
 ## Alternatives
 
 - [rtconner/laravel-likeable](https://github.com/rtconner/laravel-likeable)

composer.json

@@ -4,17 +4,20 @@
     "type": "library",
     "license": "MIT",
     "keywords": [
-        "trait",
+        "cybercog",
+        "cog",
         "laravel",
         "eloquent",
+        "trait",
         "likeable",
         "likable",
         "like",
         "dislike",
         "favorite",
         "favourite",
         "rate",
-        "rating"
+        "rating",
+        "emotion"
     ],
     "authors": [
         {
@@ -26,7 +29,7 @@
     ],
     "homepage": "https://github.com/cybercog/laravel-likeable",
     "support": {
-        "email": "a.komarev@cybercog.su",
+        "email": "oss@cybercog.su",
         "issues": "https://github.com/cybercog/laravel-likeable/issues",
         "wiki": "https://github.com/cybercog/laravel-likeable/wiki",
         "source": "https://github.com/cybercog/laravel-likeable",
@@ -39,7 +42,7 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^1.11",
-        "mockery/mockery": "^0.9.5",
+        "mockery/mockery": "^0.9.8",
         "orchestra/database": "~3.4.0",
         "orchestra/testbench": "~3.4.0",
         "phpunit/phpunit": "^5.7"
@@ -54,6 +57,9 @@
             "Cog\\Likeable\\Tests\\": "tests/"
         }
     },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
     "config": {
         "sort-packages": true
     },

src/Contracts/HasLikes.php

@@ -11,6 +11,8 @@
 
 namespace Cog\Likeable\Contracts;
 
+use Illuminate\Database\Eloquent\Builder;
+
 /**
  * Interface HasLikes.
  *
@@ -91,24 +93,33 @@ public function getLikesDiffDislikesCountAttribute();
     /**
      * Fetch records that are liked by a given user id.
      *
-     * @param \Illuminate\Database\Query\Builder $query
+     * @param \Illuminate\Database\Eloquent\Builder $query
      * @param int|null $userId
-     * @return \Illuminate\Database\Query\Builder
+     * @return \Illuminate\Database\Eloquent\Builder
      *
      * @throws \Cog\Likeable\Exceptions\LikerNotDefinedException
      */
-    public function scopeWhereLikedBy($query, $userId = null);
+    public function scopeWhereLikedBy(Builder $query, $userId = null);
 
     /**
      * Fetch records that are disliked by a given user id.
      *
-     * @param \Illuminate\Database\Query\Builder $query
+     * @param \Illuminate\Database\Eloquent\Builder $query
      * @param int|null $userId
-     * @return \Illuminate\Database\Query\Builder
+     * @return \Illuminate\Database\Eloquent\Builder
      *
      * @throws \Cog\Likeable\Exceptions\LikerNotDefinedException
      */
-    public function scopeWhereDislikedBy($query, $userId = null);
+    public function scopeWhereDislikedBy(Builder $query, $userId = null);
+
+    /**
+     * Fetch records sorted by likes count.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param string $sortDirection
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeSortedByLikesCount(Builder $query, $sortDirection = 'desc');
 
     /**
      * Add a like for model by the given user.