Skip to content

Commit 00bad93

Browse files
mpociotmpociot
committed
Initial commit
0 parents  commit 00bad93

22 files changed

+769
-0
lines changed

‎.editorconfig

+15
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

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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+
/.travis.yml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/tests export-ignore
11+
/.editorconfig export-ignore

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor
5+
coverage

‎.scrutinizer.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
4+
checks:
5+
php:
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true
19+

‎.styleci.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
preset: laravel
2+
3+
disabled:
4+
- single_class_element_per_statement

‎.travis.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
language: php
2+
3+
php:
4+
- 7.1
5+
- 7.2
6+
7+
env:
8+
matrix:
9+
- COMPOSER_FLAGS="--prefer-lowest"
10+
- COMPOSER_FLAGS=""
11+
12+
before_script:
13+
- travis_retry composer self-update
14+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
15+
16+
script:
17+
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
18+
19+
after_script:
20+
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to `laravel-favicon` will be documented in this file
4+
5+
## 1.0.0 - 201X-XX-XX
6+
7+
- initial release

‎CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[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](https://pear.php.net/package/PHP_CodeSniffer).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **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](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54+
55+
**Happy coding**!

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Beyond Code GmbH <[email protected]>
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

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Laravel Favicon
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-favicon.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-favicon)
4+
[![Build Status](https://img.shields.io/travis/beyondcode/laravel-favicon/master.svg?style=flat-square)](https://travis-ci.org/beyondcode/laravel-favicon)
5+
[![Quality Score](https://img.shields.io/scrutinizer/g/beyondcode/laravel-favicon.svg?style=flat-square)](https://scrutinizer-ci.com/g/beyondcode/laravel-favicon)
6+
[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-favicon.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-favicon)
7+
8+
Create dynamic favicons based on your environment settings.
9+
10+
![](https://beyondco.de/github/favicons/screenshot.png)
11+
12+
## Installation
13+
14+
You can install the package via composer:
15+
16+
```bash
17+
composer require beyondcode/laravel-favicon
18+
```
19+
20+
The service provider for this package will be automatically registered for you.
21+
22+
## Usage
23+
24+
To make use of this package, make use of the `favicon` helper function that this package provides.
25+
26+
You can simply wrap the function around your favicon icon names, like this:
27+
28+
```html
29+
<link rel="icon" type="image/png" sizes="32x32" href="{{ favicon(asset('favicon-32x32.png')) }}">
30+
31+
<link rel="shortcut icon" href="{{ favicon('favicon.ico') }}" />
32+
```
33+
34+
## Customization
35+
36+
You can completely customize which environments you want to have enabled for the favicon generation, as well as the font and colors that will be used.
37+
38+
To modify the default values, publish the package configuration file using:
39+
40+
```
41+
php artisan vendor:publish --provider='BeyondCode\LaravelFavicon\FaviconServiceProvider' --tag='config'
42+
```
43+
44+
This will publish the `config/favicon.php` file.
45+
46+
This is what the default content looks like:
47+
48+
```php
49+
return [
50+
51+
/*
52+
* The list of enabled environments for the dynamic favicon
53+
* generation. You can specify the text to display as well
54+
* as the font and background color for the text.
55+
*
56+
* If no background color is specified, the text will be
57+
* on a transparent background.
58+
*/
59+
'enabled_environments' => [
60+
'local' => [
61+
'text' => 'DEV',
62+
'color' => '#000000',
63+
'background_color' => '#ffffff',
64+
],
65+
],
66+
67+
/*
68+
* The dynamic favicon text padding to apply.
69+
*/
70+
'padding' => [
71+
'x' => 2,
72+
'y' => 2,
73+
],
74+
75+
/*
76+
* The font file to use for the dynamic favicon generation.
77+
* The default value will use OpenSans Regular.
78+
*/
79+
'font' => null,
80+
81+
/*
82+
* Intervention Image supports "GD Library" and "Imagick" to process images
83+
* internally. You may choose one of them according to your PHP
84+
* configuration. By default PHP's "GD Library" implementation is used.
85+
*
86+
* If you want to convert ICO files, you need to use imagick.
87+
*
88+
* Supported: "gd", "imagick"
89+
*
90+
*/
91+
'image_driver' => 'gd',
92+
93+
/*
94+
* The prefix to use for the dynamic favicon URL.
95+
*/
96+
'url_prefix' => 'laravel-favicon',
97+
98+
/*
99+
* The favicon generator class to use. The default generator
100+
* makes use of the environment settings defined in this file.
101+
* But you can create your own favicon generator if you want.
102+
*/
103+
'generator' => \BeyondCode\LaravelFavicon\Generators\EnvironmentGenerator::class,
104+
105+
106+
];
107+
```
108+
109+
Modify the settings to suit your needs.
110+
111+
## Custom generator
112+
113+
The default favicon generator will write the text on the bottom-right corner of your favicon, in the desired color, font and background-color.
114+
If you want to generate a completely custom favicon, you can create your own FaviconGenerator implementation class and set it in the configuration file.
115+
116+
This is the interface that the generator should implement:
117+
118+
```php
119+
interface FaviconGenerator
120+
{
121+
public function generate(string $icon): Response;
122+
123+
public function shouldGenerateFavicon(): bool;
124+
}
125+
```
126+
127+
The `generate` method receives the icon url/filename and expects you to return an illuminate HTTP response.
128+
129+
The `shouldGenerateFavicon` method can be used to determine if a custom favicon should get generated.
130+
131+
## FAQ
132+
133+
- My ICO files are not working, why?
134+
135+
In order to modify ICO files, you need the Imagick PHP library installed and enabled in your `config/favicon.php` file.
136+
137+
- Is there a performance impact when I'm using this package?
138+
139+
No - the default generator only modifies your favicon when the specified environment is enabled. This means, that production environments only see the static assets that you already have.
140+
141+
### Changelog
142+
143+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
144+
145+
## Contributing
146+
147+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
148+
149+
### Security
150+
151+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
152+
153+
## Credits
154+
155+
- [Marcel Pociot](https://github.com/mpociot)
156+
- [All Contributors](../../contributors)
157+
158+
## License
159+
160+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

‎composer.json

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"name": "beyondcode/laravel-favicon",
3+
"description": "Create dynamic favicons based on your environment settings.",
4+
"keywords": [
5+
"beyondcode",
6+
"laravel-favicon"
7+
],
8+
"homepage": "https://github.com/beyondcode/laravel-favicon",
9+
"license": "MIT",
10+
"authors": [
11+
{
12+
"name": "Marcel Pociot",
13+
"email": "[email protected]",
14+
"homepage": "https://beyondcode.de",
15+
"role": "Developer"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.1",
20+
"guzzlehttp/guzzle": "^6.3",
21+
"illuminate/http": "5.6.*|5.7.*",
22+
"illuminate/support": "5.6.*|5.7.*",
23+
"intervention/image": "^2.4"
24+
},
25+
"require-dev": {
26+
"phpunit/phpunit": "^7.0",
27+
"orchestra/testbench": "3.7.*"
28+
},
29+
"autoload": {
30+
"psr-4": {
31+
"BeyondCode\\LaravelFavicon\\": "src"
32+
},
33+
"files": [
34+
"src/helpers.php"
35+
]
36+
},
37+
"autoload-dev": {
38+
"psr-4": {
39+
"BeyondCode\\LaravelFavicon\\Tests\\": "tests"
40+
}
41+
},
42+
"scripts": {
43+
"test": "vendor/bin/phpunit",
44+
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
45+
46+
},
47+
"config": {
48+
"sort-packages": true
49+
},
50+
"extra": {
51+
"laravel": {
52+
"providers": [
53+
"BeyondCode\\LaravelFavicon\\FaviconServiceProvider"
54+
]
55+
}
56+
}
57+
}

0 commit comments

Comments
 (0)