starred/github-profile-views-counter
1
0
Fork 0
mirror of https://github.com/antonkomarev/github-profile-views-counter.git synced 2026-08-04 19:15:11 -04:00
Code Issues 24 Packages Projects Releases Wiki Activity

Make label and color customizable (#9)

Browse Source 
Make label and color customizable
This commit is contained in:
Anton Komarev
2020-07-20 23:35:08 +03:00
committed by GitHub
parent e292af7e80
commit 0950427786
4 changed files with 69 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -38,9 +38,40 @@ You need to add counter in README.md file in your profile repository via Markdow
### Customization
#### Color
You can use any valid HEX color or pick from a predefined set of named colors (`blue` is the default).
| color | demo |
| ----- | ---- |
| `brightgreen` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=44cc11) |
| `green` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=97ca00) |
| `yellow` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=dfb317) |
| `yellowgreen` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=a4a61d) |
| `orange` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=fe7d37) |
| `red` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=e05d44) |
| `blue` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=007ec6) |
| `grey` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=555555) |
| `lightgray` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=9f9f9f) |
| `ff69b4` | ![](https://img.shields.io/static/v1?label=Profile+views&message=1234567890&color=ff69b4) |
**Named color**
```markdown
![](https://komarev.com/ghpvc/?username=your-github-username&color=green)
```
**Hex color**
```markdown
![](https://komarev.com/ghpvc/?username=your-github-username&color=dc143c)
```
> **NOTE**: HEX colors should be used without `#` symbol prefix.
#### Styles
The following styles are available (`flat` is the default):
The following styles are available (`flat` is the default).
| style | demo |
| ----- | ---- |
@@ -52,7 +83,17 @@ The following styles are available (`flat` is the default):
![](https://komarev.com/ghpvc/?username=your-github-username&style=flat-square)
```
For example
#### Label
You can overwrite default `Profile views` text with your own label.
![](https://img.shields.io/static/v1?label=PROFILE+VIEWS&message=1234567890&color=007ec6)
```markdown
![](https://komarev.com/ghpvc/?username=your-github-username&label=PROFILE+VIEWS)
```
> **NOTE**: Replace whitespace with `+` character in multi-word labels.
## Is it safe to place tracking image?

8
public/file-repository.php
View File

@@ -38,6 +38,8 @@ try {
$storagePath = $_ENV['FILE_STORAGE_PATH'];
}
$badgeLabel = $_GET['label'] ?? 'Profile views';
$badgeMessageBackgroundFill = $_GET['color'] ?? 'blue';
$badgeStyle = $_GET['style'] ?? 'flat';
if (!in_array($badgeStyle, ['flat', 'flat-square', 'plastic'])) {
$badgeStyle = 'flat';
@@ -46,7 +48,7 @@ try {
$username = trim($username);
if ($username === '') {
echo $badgeImageRenderer->renderBadgeWithError($badgeStyle, 'Invalid query parameter: username');
echo $badgeImageRenderer->renderBadgeWithError($badgeLabel, 'Invalid query parameter: username', $badgeStyle);
exit;
}
@@ -65,9 +67,9 @@ try {
$count = $counterRepository->getViewsCountByUsername($username);
echo $badgeImageRenderer->renderBadgeWithCount($badgeStyle, $count);
echo $badgeImageRenderer->renderBadgeWithCount($badgeLabel, $count, $badgeMessageBackgroundFill, $badgeStyle);
exit;
} catch (Exception $exception) {
echo $badgeImageRenderer->renderBadgeWithError($badgeStyle, $exception->getMessage());
echo $badgeImageRenderer->renderBadgeWithError($badgeLabel, $exception->getMessage(), $badgeStyle);
exit;
}

10
public/pdo-repository.php
View File

@@ -42,6 +42,8 @@ try {
$httpUserAgent = $_SERVER['HTTP_USER_AGENT'];
$badgeLabel = $_GET['label'] ?? 'Profile views';
$badgeMessageBackgroundFill = $_GET['color'] ?? 'blue';
$badgeStyle = $_GET['style'] ?? 'flat';
if (!in_array($badgeStyle, ['flat', 'flat-square', 'plastic'])) {
$badgeStyle = 'flat';
@@ -50,7 +52,7 @@ try {
$username = trim($username);
if ($username === '') {
echo $badgeImageRenderer->renderBadgeWithError($badgeStyle, 'Invalid query parameter: username');
echo $badgeImageRenderer->renderBadgeWithError($badgeLabel, 'Invalid query parameter: username', $badgeStyle);
exit;
}
@@ -78,12 +80,12 @@ try {
$count = $counterRepository->getViewsCountByUsername($username);
echo $badgeImageRenderer->renderBadgeWithCount($badgeStyle, $count);
echo $badgeImageRenderer->renderBadgeWithCount($badgeLabel, $count, $badgeMessageBackgroundFill, $badgeStyle);
exit;
} catch (InvalidPathException $exception) {
echo $badgeImageRenderer->renderBadgeWithError($badgeStyle, 'Application environment file is missing');
echo $badgeImageRenderer->renderBadgeWithError($badgeLabel, 'Application environment file is missing', $badgeStyle);
exit;
} catch (Exception $exception) {
echo $badgeImageRenderer->renderBadgeWithError($badgeStyle, $exception->getMessage());
echo $badgeImageRenderer->renderBadgeWithError($badgeLabel, $exception->getMessage(), $badgeStyle);
exit;
}

28
src/BadgeImageRendererService.php
View File

@@ -24,32 +24,34 @@ final class BadgeImageRendererService
public function __construct()
{
$this->poser = new Poser([new SvgRender(), new SvgFlatRender(), new SvgFlatSquareRender()]);
$this->poser = new Poser([
new SvgRender(),
new SvgFlatRender(),
new SvgFlatSquareRender(),
]);
}
public function renderBadgeWithCount($badgeStyle, int $count): string
public function renderBadgeWithCount(string $label, int $count, string $messageBackgroundFill, string $badgeStyle): string
{
$message = (string) $count;
$messageBackgroundFill = '007ec6';
return $this->renderBadge($badgeStyle, $message, $messageBackgroundFill);
return $this->renderBadge($label, $message, $messageBackgroundFill, $badgeStyle);
}
public function renderBadgeWithError($badgeStyle, string $message): string
public function renderBadgeWithError(string $label, string $message, string $badgeStyle): string
{
$messageBackgroundFill = 'e05d44';
$messageBackgroundFill = 'red';
return $this->renderBadge($badgeStyle, $message, $messageBackgroundFill);
}
private function renderBadge($badgeStyle, string $message, string $messageBackgroundFill): string
{
return (string) $this->poser->generate('Profile views', $message, $messageBackgroundFill, $badgeStyle);
return $this->renderBadge($label, $message, $messageBackgroundFill, $badgeStyle);
}
public function renderPixel(): string
{
return '<svg xmlns="http://www.w3.org/2000/svg" width="1" height="1"/>';
}
private function renderBadge(string $label, string $message, string $messageBackgroundFill, string $badgeStyle): string
{
return (string) $this->poser->generate($label, $message, $messageBackgroundFill, $badgeStyle);
}
}