v4.0.0-rc

.codeclimate.yml

@@ -0,0 +1,28 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        php:
+          mass_threshold: 40
+  fixme:
+    enabled: true
+  phpmd:
+    enabled: true
+    checks:
+      CleanCode/StaticAccess:
+        enabled: false
+      CleanCode/BooleanArgumentFlag:
+        enabled: false
+      Design/TooManyPublicMethods:
+        enabled: false
+      Design/CouplingBetweenObjects:
+        enabled: false
+ratings:
+  paths:
+    - "src/Notifynder/**.php"
+exclude_paths:
+  - tests/
+  - spec/
+  - src/migrations/
+  - src/config/

.coveralls.yml

@@ -0,0 +1,3 @@
+coverage_clover: build/logs/clover.xml
+json_path: build/logs/coveralls-upload.json
+service_name: travis-ci

.gitignore

@@ -1,3 +1,3 @@
 /vendor
 composer.lock
-.idea
+/build

.scrutinizer.yml

@@ -0,0 +1,9 @@
+checks:
+  php: true
+filter:
+  paths: ["src/Notifynder/*"]
+  excluded_paths:
+    - tests/*
+build:
+  environment:
+    php: 7.0.6

.styleci.yml

@@ -0,0 +1,5 @@
+preset: laravel
+
+risky: false
+
+linting: true

.travis.yml

@@ -1,15 +1,59 @@
 language: php
 
+## Run on container environment
+sudo: false
+
+## Cache composer bits
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+## Addons used by this package
+addons:
+  code_climate:
+    repo_token: ${CC_TOKEN}
+
+## List all PHP versions to test with
 php:
   - 5.5
   - 5.6
-  - hhvm
+  - 7.0
 
-before_script:
+## Define all ENV vars to test with
+env:
+  - LARAVEL_VERSION="5.0.*"
+  - LARAVEL_VERSION="5.1.*"
+  - LARAVEL_VERSION="5.2.*"
+  - LARAVEL_VERSION="5.3.*"
+
+matrix:
+  exclude:
+  - php: 5.5
+    env: LARAVEL_VERSION="5.3.*"
+
+## Install Dependencies
+install:
   - composer self-update
-  - composer install --prefer-source --no-interaction
+  - if [ -n "$GH_TOKEN" ]; then composer config github-oauth.github.com ${GH_TOKEN}; fi;
+  - composer require laravel/framework:${LARAVEL_VERSION} --no-update --no-interaction
+  - composer install --prefer-dist --no-interaction
+
+## Run Scripts before Tests
+before_script:
   - composer dump-autoload -o
 
+## Run test Scripts
 script:
-  - vendor/bin/phpspec run
-  - vendor/bin/phpunit
+  - vendor/bin/phpunit
+  - php CoverageChecker.php build/logs/clover.xml 80
+
+after_script:
+  - vendor/bin/test-reporter
+  - export CI_BUILD_NUMBER="$TRAVIS_BUILD_NUMBER"
+  - export CI_PULL_REQUEST="$TRAVIS_PULL_REQUEST"
+  - export CI_BRANCH="$TRAVIS_BRANCH"
+  - vendor/bin/coveralls -v
+
+## Send Build Notifications to Slack
+notifications:
+  slack: notifynder:CnF7P2xaZuJTJ4VzNOy6ksDH

CoverageChecker.php

@@ -0,0 +1,33 @@
+<?php
+
+$inputFile = $argv[1];
+$percentage = min(100, max(0, (int) $argv[2]));
+
+if (! file_exists($inputFile)) {
+    echo $inputFile." isn't present.";
+    exit(0);
+}
+
+if (! $percentage) {
+    echo $percentage." isn't percentage.";
+    exit(0);
+}
+
+$xml = new SimpleXMLElement(file_get_contents($inputFile));
+$metrics = $xml->xpath('//metrics');
+$totalElements = 0;
+$checkedElements = 0;
+
+foreach ($metrics as $metric) {
+    $totalElements += (int) $metric['elements'];
+    $checkedElements += (int) $metric['coveredelements'];
+}
+
+$coverage = ($checkedElements / $totalElements) * 100;
+
+if ($coverage < $percentage) {
+    echo 'Code coverage is '.$coverage.'%, which is below the accepted '.$percentage.'%'.PHP_EOL;
+    exit(1);
+}
+
+echo 'Code coverage is '.$coverage.'% - OK!'.PHP_EOL;

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Fabrizio
+
+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

@@ -1,95 +1,126 @@
-Notifynder 3.0 - Laravel 5
-==========
+# Notifynder 4 - Laravel 5
+
+[![GitHub release](https://img.shields.io/github/release/fenos/Notifynder.svg?style=flat-square)](https://github.com/fenos/Notifynder/releases)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/fenos/Notifynder/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/fenos/Notifynder.svg?style=flat-square)](https://github.com/fenos/Notifynder/issues)
+[![Total Downloads](https://img.shields.io/packagist/dt/fenos/notifynder.svg?style=flat-square)](https://packagist.org/packages/fenos/notifynder)
+
+[![Travis branch](https://img.shields.io/travis/fenos/Notifynder/master.svg?style=flat-square&label=TravisCI)](https://travis-ci.org/fenos/Notifynder/branches)
+[![StyleCI](https://styleci.io/repos/18425539/shield)](https://styleci.io/repos/18425539)
+[![Scrutinizer Build](https://img.shields.io/scrutinizer/build/g/fenos/Notifynder.svg?style=flat-square&label=ScrutinizerCI)](https://scrutinizer-ci.com/g/fenos/Notifynder/?branch=master)
+
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/fenos/Notifynder.svg?style=flat-square)](https://scrutinizer-ci.com/g/fenos/Notifynder/?branch=master)
+[![Code Climate](https://img.shields.io/codeclimate/github/fenos/Notifynder.svg?style=flat-square)](https://codeclimate.com/github/fenos/Notifynder)
+[![Coveralls](https://img.shields.io/coveralls/fenos/Notifynder.svg?style=flat-square)](https://coveralls.io/github/fenos/Notifynder)
+
+[![Slack Team](https://img.shields.io/badge/slack-astrotomic-orange.svg?style=flat-square)](https://astrotomic.slack.com)
+[![Slack join](https://img.shields.io/badge/slack-join-green.svg?style=social)](https://notifynder.signup.team)
 
-[![Build Status](https://travis-ci.org/fenos/Notifynder.svg?branch=master)](https://travis-ci.org/fenos/Notifynder)
-[![ProjectStatus](http://stillmaintained.com/fenos/Notifynder.png)](http://stillmaintained.com/fenos/Notifynder)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fenos/Notifynder/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fenos/Notifynder/?branch=master)
-[![Total Downloads](https://poser.pugx.org/fenos/notifynder/downloads.svg)](https://packagist.org/packages/fenos/notifynder)
-[![License](https://poser.pugx.org/fenos/Notifynder/license.png)](https://packagist.org/packages/fenos/Notifynder)
-[![Latest Stable Version](https://poser.pugx.org/fenos/notifynder/v/stable.png)](https://packagist.org/packages/fenos/notifynder)
 
 Notifynder is designed to manage notifications in a powerful and easy way.
 With the flexibility that Notifynder offer, It provide a complete API to work with your notifications,
-such as storing, retriving, and organise your codebase to handle hundreds of notifications.
+such as storing, retrieving, and organise your codebase to handle hundreds of notifications.
 You get started in a couple of minutes to "enable" notifications in your Laravel Project.
 
 Compatible DBs: **MySql** - **PostgresSql** - **Sqlite**
 
-Documentation: **[Notifynder Wiki](https://github.com/fenos/Notifynder/wiki)**
-- - -
+Documentation: **[Notifynder Docu](http://notifynder.info)**
+
+-----
 
-## Installation ##
+## Installation
 
-### Step 1 ###
+### Step 1
 
-Add it on your composer.json
+Add it on your `composer.json`
 
-~~~
-"fenos/notifynder": "3.*"
-~~~
+```
+"fenos/notifynder": "^4.0"
+```
 
-and run **composer update**
+and run 
 
+```
+composer update
+```
 
-### Step 2 ###
+or run
 
-Add the following string to **config/app.php**
+```
+composer require fenos/notifynder
+```
+
+
+### Step 2
+
+Add the following string to `config/app.php`
 
 **Providers array:**
 
-~~~
-'Fenos\Notifynder\NotifynderServiceProvider'
-~~~
+```
+Fenos\Notifynder\NotifynderServiceProvider::class,
+```
 
 **Aliases array:**
 
-~~~
-'Notifynder'    => 'Fenos\Notifynder\Facades\Notifynder'
-~~~
+```
+'Notifynder' => Fenos\Notifynder\Facades\Notifynder::class,
+```
+
 
-### Step 3 ###
+### Step 3
 
-#### Migration ####
+#### Migration & Config
 
 Publish the migration as well as the configuration of notifynder with the following command:
 
-~~~
+```
 php artisan vendor:publish --provider="Fenos\Notifynder\NotifynderServiceProvider"
-~~~
+```
+
+Run the migration
+
+```
+php artisan migrate
+```
+
+## Usage
+
+This Branch isn't ready for any kind of usage! It's development in progress and will bring a whole new code-base for this package.
+Everyone is welcome to support us or give feedback for the new major version in our Slack Team.
+
+### ToDo
+
+Tasks we have to do until this version is ready for a stable release:
+
+* add unittests for parser and models
+* complete the new documentation
+
+
+## Versioning
 
-Don't forget to migrate.
+Starting with `v4.0.0` we are following the [Semantic Versioning Standard](http://semver.org).
 
-### Quick Usage ###
+### Summary
 
-Set up category of notification, think about it as the
-body of the notification:
+Given a version number `MAJOR`.`MINOR`.`PATCH`, increment the:
 
-~~~
-php artisan notifynder:create:category "user.following" "{from.username} started to follow you"
-~~~
+* **MAJOR** version when you make incompatible API changes,
+* **MINOR** version when you add functionality in a backwards-compatible manner, and
+* **PATCH** version when you make backwards-compatible bug fixes.
 
-To send a notification with notifynder, that's all
-you have to do.
+Additional labels for pre-release (`alpha`, `beta`, `rc`) are available as extensions to the `MAJOR`.`MINOR`.`PATCH` format.
 
-~~~
-Notifynder::category('user.following')
-            ->from($from_user_id)
-            ->to($to_user_id)
-            ->url('http://www.yourwebsite.com/page')
-            ->send();
-~~~
+## Contributors
 
-**Retrieving Notifications**
+Thanks for everyone [who contributed](https://github.com/fenos/Notifynder/graphs/contributors) to Notifynder and a special thanks for the most active contributors
 
-~~~
-// @return Collection
-Notifynder::getAll($user_id,$limit,$paginateBool);
-~~~
+- [Gummibeer](https://github.com/Gummibeer)
 
-**Reading Notifications:**
-~~~
-// @return number of notifications read
-Notifynder::ReadAll($user_id);
-~~~
+## Services
 
-To know more, such as the advance usage of Notifynder Visit the **[Notifynder Wiki](https://github.com/fenos/Notifynder/wiki)**.
+* [Travis CI](https://travis-ci.org/fenos/Notifynder)
+* [Style CI](https://styleci.io/repos/18425539)
+* [Code Climate](https://codeclimate.com/github/fenos/Notifynder)
+* [Scrutinizer](https://scrutinizer-ci.com/g/fenos/Notifynder)
+* [Coveralls](https://coveralls.io/github/fenos/Notifynder)