Skip to content

Commit

Permalink
#237 Merge remote-tracking branch 'remotes/origin/develop'
Browse files Browse the repository at this point in the history
# Conflicts:
#	.travis.yml
#	README.md
#	composer.json
#	src/Notifynder/Builder/NotifynderBuilder.php
#	src/Notifynder/Models/Notification.php
#	src/Notifynder/Notifable.php
#	src/Notifynder/Notifications/NotificationManager.php
#	src/Notifynder/NotifynderServiceProvider.php
#	tests/integration/Notifable/NotifableTest.php
#	tests/integration/Notifications/NotificationTest.php
  • Loading branch information
Gummibeer committed Jan 4, 2017
2 parents 2f25c9a + 17a8c70 commit 4c0020c
Show file tree
Hide file tree
Showing 139 changed files with 3,437 additions and 9,399 deletions.
2 changes: 1 addition & 1 deletion .gitignore
@@ -1,3 +1,3 @@
/vendor
composer.lock
.idea
/build
9 changes: 9 additions & 0 deletions .scrutinizer.yml
@@ -0,0 +1,9 @@
checks:
php: true
filter:
paths: ["src/Notifynder/*"]
excluded_paths:
- tests/*
build:
environment:
php: 7.0.6
8 changes: 7 additions & 1 deletion .travis.yml
Expand Up @@ -24,6 +24,12 @@ 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:
Expand All @@ -38,8 +44,8 @@ before_script:

## Run test Scripts
script:
- vendor/bin/phpspec run
- vendor/bin/phpunit
- php CoverageChecker.php build/logs/clover.xml 80

after_script:
- vendor/bin/test-reporter
Expand Down
111 changes: 63 additions & 48 deletions README.md
@@ -1,111 +1,126 @@
Notifynder 3.2 - 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)](https://travis-ci.org/fenos/Notifynder/branches)
[![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)](https://scrutinizer-ci.com/g/fenos/Notifynder/?branch=master)
[![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)
[![Code Climate](https://img.shields.io/codeclimate/issues/github/fenos/Notifynder.svg?style=flat-square)](https://codeclimate.com/github/fenos/Notifynder/issues)
[![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-notifynder-orange.svg?style=flat-square)](https://notifynder.slack.com)
[![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)

Version 4 is under development and we recommend to use this version for new projects. We won't add new features to v3.

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`

"fenos/notifynder": "^3.2"
```
"fenos/notifynder": "^4.0"
```

and run

composer update
```
composer update
```

or run

composer require fenos/notifynder
```
composer require fenos/notifynder
```


### Step 2 ###
### Step 2

Add the following string to `config/app.php`

**Providers array:**

Fenos\Notifynder\NotifynderServiceProvider::class,
```
Fenos\Notifynder\NotifynderServiceProvider::class,
```

**Aliases array:**

'Notifynder' => Fenos\Notifynder\Facades\Notifynder::class,
```
'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"
```
php artisan vendor:publish --provider="Fenos\Notifynder\NotifynderServiceProvider"
```

Run the migration

php artisan migrate
```
php artisan migrate
```

### Quick Usage ###
## Usage

Set up category of notification, think about it as the
body of the notification:
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.

php artisan notifynder:create:category "user.following" "{from.username} started to follow you"
### ToDo

To send a notification with notifynder, that's all
you have to do.
Tasks we have to do until this version is ready for a stable release:

```php
Notifynder::category('user.following')
->from($from_user_id)
->to($to_user_id)
->url('http://www.yourwebsite.com/page')
->send();
```
* add unittests for parser and models
* complete the new documentation

**Retrieving Notifications**

```php
// @return Collection
Notifynder::getAll($user_id,$limit,$paginateBool);
```
## Versioning

**Reading Notifications:**
```php
// @return number of notifications read
Notifynder::readAll($user_id);
```
Starting with `v4.0.0` we are following the [Semantic Versioning Standard](http://semver.org).

To know more, such as the advance usage of Notifynder Visit the **[Notifynder Wiki](https://github.com/fenos/Notifynder/wiki)**.
### Summary

#### Contributors ####
Given a version number `MAJOR`.`MINOR`.`PATCH`, increment the:

Thanks for everyone who contributed to Notifynder and a special thanks for the most active contributors
* **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.

Additional labels for pre-release (`alpha`, `beta`, `rc`) are available as extensions to the `MAJOR`.`MINOR`.`PATCH` format.

## Contributors

Thanks for everyone [who contributed](https://github.com/fenos/Notifynder/graphs/contributors) to Notifynder and a special thanks for the most active contributors

- [Gummibeer](https://github.com/Gummibeer)

## Services

* [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)
60 changes: 0 additions & 60 deletions change.log

This file was deleted.

20 changes: 15 additions & 5 deletions composer.json
Expand Up @@ -8,32 +8,42 @@
"name": "Fabrizio Fenoglio",
"email": "fabri_feno@yahoo.it",
"role": "Developer"
},
{
"name": "Tom Witkowski",
"email": "dev.gummibeer@gmail.com",
"role": "Developer"
}
],
"require": {
"php": ">=5.5.0",
"illuminate/support": "~5.0",
"doctrine/dbal": "^2.5"
"illuminate/support": "~5.0"
},
"require-dev": {
"laravel/framework": "~5.0",
"phpunit/phpunit": "~4.0",
"phpspec/phpspec": "~2.1",
"laracasts/testdummy": "~2.0",
"orchestra/testbench": "~3.0",
"codeclimate/php-test-reporter": "^0.3.2"
"doctrine/dbal": "^2.5",
"codeclimate/php-test-reporter": "^0.3.2",
"satooshi/php-coveralls": "^1.0"
},
"autoload": {
"classmap": [

],
"psr-4": {
"Fenos\\Notifynder\\": "src/Notifynder"
}
},
"files": [

"src/Notifynder/Helpers/helpers.php"
]
},
"autoload-dev": {
"classmap": [
"tests/TestCaseDB.php"
"tests/NotifynderTestCase.php"
],
"psr-4": {
"Fenos\\Tests\\": "tests/models"
Expand Down
8 changes: 7 additions & 1 deletion phpunit.xml
Expand Up @@ -16,8 +16,14 @@
</testsuites>
<filter>
<whitelist addUncoveredFilesFromWhitelist="true">
<directory suffix=".php">./src</directory>
<directory suffix=".php">./src/Notifynder</directory>
</whitelist>
<exclude>
<directory>./vendor</directory>
<directory>./tests</directory>
<directory>./spec</directory>
<directory>./build</directory>
</exclude>
</filter>
<logging>
<log type="coverage-html" target="./build/coverage" title="Retail Barometer Code Coverage Results" charset="UTF-8" yui="true" highlight="true" lowUpperBound="50" highLowerBound="75"/>
Expand Down
Empty file added spec/.gitkeep
Empty file.

0 comments on commit 4c0020c

Please sign in to comment.