Skip to content

Commit 77c2891

Browse files
pmatseykanetspmatseykanets
committed
Initial commit.
0 parents  commit 77c2891

15 files changed

+911
-0
lines changed

‎.editorconfig

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.gitattributes export-ignore
6+
/.gitignore export-ignore
7+
/.styleci.yml export-ignore
8+
/.travis.yml export-ignore
9+
/phpunit.xml.dist export-ignore
10+
/tests export-ignore

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/vendor
2+
composer.lock

‎.styleci.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
preset: laravel
2+
3+
linting: true

‎.travis.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
language: php
2+
3+
php:
4+
- 5.6
5+
- 7.0
6+
- 7.1
7+
8+
env:
9+
matrix:
10+
- COMPOSER_FLAGS="--prefer-lowest"
11+
- COMPOSER_FLAGS=""
12+
13+
before_script:
14+
- travis_retry composer self-update
15+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
16+
17+
script:
18+
- phpunit --coverage-text --coverage-clover=coverage.clover

‎CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to `pmatseykanets/laravel-hipchat-slash` will be documented in this file
4+
5+
## [Unreleased]
6+
7+
## [0.1.0] - 2016-09-02
8+
Experimental release.

‎CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
42+
43+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
44+
45+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
46+
47+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
48+
49+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
50+
51+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
52+
53+
**Happy coding**!

‎LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) Peter Matseykanets <pmatseykanets@gmail.com>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

‎README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# PostrgeSQL Full Text Search Engine for Laravel Scout [WIP]
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/pmatseykanets/laravel-scout-postgres.svg?style=flat-square)](https://packagist.org/packages/pmatseykanets/laravel-scout-postgres)
4+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5+
[![Build Status](https://img.shields.io/travis/pmatseykanets/laravel-scout-postgres/master.svg?style=flat-square)](https://travis-ci.org/pmatseykanets/laravel-scout-postgres)
6+
7+
This package makes it easy to use native PostgreSQL Full Text Search capabilities with [Laravel Scout](http://laravel.com/docs/master/scout).
8+
9+
## Contents
10+
11+
- [Installation](#installation)
12+
- [Setting up the HipChat Service](#setting-up-the-hipchat-service)
13+
- [Usage](#usage)
14+
- [Available Message methods](#available-message-methods)
15+
- [Changelog](#changelog)
16+
- [Testing](#testing)
17+
- [Security](#security)
18+
- [Contributing](#contributing)
19+
- [Credits](#credits)
20+
- [License](#license)
21+
22+
## Installation
23+
24+
You can install the package via composer:
25+
26+
``` bash
27+
composer require pmatseykanets/laravel-scout-postgres
28+
```
29+
30+
You must install the service provider:
31+
32+
```php
33+
// config/app.php
34+
'providers' => [
35+
...
36+
ScoutEngines\PostgresEngineServiceProvider::class,
37+
],
38+
```
39+
40+
Specify the database connection that should be used to access indexed documents in the Laravel Scout configuration file `config/scout.php`:
41+
42+
```php
43+
// config/scout.php
44+
...
45+
'pgsql' => [
46+
// Connection to use. See config/database.php
47+
'connection' => env('DB_CONNECTION', 'pgsql'),
48+
// You may want to update index documents directly in PostgreSQL (i.e. via triggers).
49+
// In this case you can set this value to false.
50+
'maintain_index' => true,
51+
],
52+
...
53+
```
54+
55+
## Configuration
56+
57+
TBD
58+
59+
## Usage
60+
61+
Please see the [official documentation](http://laravel.com/docs/master/scout) on how to use Laravel Scout.
62+
63+
64+
## Testing
65+
66+
``` bash
67+
$ composer test
68+
```
69+
70+
## Security
71+
72+
If you discover any security related issues, please email pmatseykanets@gmail.com instead of using the issue tracker.
73+
74+
## Changelog
75+
76+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
77+
78+
## Contributing
79+
80+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
81+
82+
## Credits
83+
84+
- [Peter Matseykanets](https://github.com/pmatseykanets)
85+
- [All Contributors](../../contributors)
86+
87+
## License
88+
89+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

‎composer.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"name": "pmatseykanets/laravel-scout-postgres",
3+
"description": "PostgreSQL FTS driver for Laravel Scout",
4+
"keywords": [
5+
"laravel",
6+
"laravel scout",
7+
"search",
8+
"postgresql",
9+
"full text search"
10+
],
11+
"homepage": "https://github.com/pmatseykanets/laravel-scout-postgresql",
12+
"license": "MIT",
13+
"authors": [
14+
{
15+
"name": "Peter Matseykanets",
16+
"email": "pmatseykanets@gmail.com",
17+
"homepage": "https://github.com/pmatseykanets",
18+
"role": "Developer"
19+
}
20+
],
21+
"require": {
22+
"php": ">=5.6.4",
23+
"illuminate/contracts": "~5.3",
24+
"illuminate/database": "~5.3",
25+
"illuminate/support": "~5.3",
26+
"laravel/scout": "^1.0"
27+
},
28+
"require-dev": {
29+
"phpunit/phpunit": "5.*",
30+
"mockery/mockery": "^0.9.5"
31+
},
32+
"autoload": {
33+
"psr-4": {
34+
"ScoutEngines\\Postgres\\": "src"
35+
}
36+
},
37+
"autoload-dev": {
38+
"psr-4": {
39+
"ScoutEngines\\Postgres\\Test\\": "tests"
40+
}
41+
},
42+
"scripts": {
43+
"test": "vendor/bin/phpunit"
44+
}
45+
}

0 commit comments

Comments
 (0)