ᴀɴᴛᴏɴ ɴᴏᴠᴏᴊɪʟᴏᴠ
3 years ago
committed by
GitHub
commit
35cd704718
@ -0,0 +1,11 @@
|
||||
{
|
||||
"GOLANG": {
|
||||
"ABC": [15, 25, 50, 70],
|
||||
"LOC": [30, 45, 70, 100],
|
||||
"BLOCK_NESTING": [4, 6, 8, 10],
|
||||
"TOO_MANY_IVARS": [50, 75, 100, 150],
|
||||
"TOO_MANY_FUNCTIONS": [64, 128, 256, 512],
|
||||
"TOTAL_LOC": [1500, 3000, 5000, 10000],
|
||||
"TOTAL_COMPLEXITY": [350, 600, 900, 1200]
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,42 @@
|
||||
# Contributor Code of Conduct
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of
|
||||
fostering an open and welcoming community, we pledge to respect all people who
|
||||
contribute through reporting issues, posting feature requests, updating
|
||||
documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in this project a harassment-free
|
||||
experience for everyone, regardless of level of experience, gender, gender
|
||||
identity and expression, sexual orientation, disability, personal appearance,
|
||||
body size, race, ethnicity, age, religion, or nationality.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery
|
||||
* Personal attacks
|
||||
* Trolling or insulting/derogatory comments
|
||||
* Public or private harassment
|
||||
* Publishing other's private information, such as physical or electronic
|
||||
addresses, without explicit permission
|
||||
* Other unethical or unprofessional conduct
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
By adopting this Code of Conduct, project maintainers commit themselves to
|
||||
fairly and consistently applying these principles to every aspect of managing
|
||||
this project. Project maintainers who do not follow or enforce the Code of
|
||||
Conduct may be permanently removed from the project team.
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting a project maintainer at `conduct@essentialkaos.com`. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. Maintainers are
|
||||
obligated to maintain confidentiality with regard to the reporter of an
|
||||
incident.
|
||||
@ -0,0 +1,19 @@
|
||||
# Contributing Guidelines
|
||||
|
||||
**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.**
|
||||
|
||||
### Issues
|
||||
|
||||
1. Provide product version where the problem was found;
|
||||
2. Provide info about your environment;
|
||||
3. Provide detailed info about your problem;
|
||||
4. Provide steps to reproduce the problem;
|
||||
5. Provide actual and expected results.
|
||||
|
||||
### Code
|
||||
|
||||
1. Check your code **before** creating pull request;
|
||||
2. If tests are present in a project, add tests for your code;
|
||||
3. Add inline documentation for your code;
|
||||
4. Apply code style used throughout the project;
|
||||
5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_).
|
||||
@ -0,0 +1,53 @@
|
||||
_Before opening an issue, search for similar bug reports or feature requests on GitHub Issues. If yes, please add a_ 👍 _reaction to the existing issue. If no similar issue can be found, fill out either the "Bug Report" or the "Feature Request" section below. Erase the other section and everything on and above this line._
|
||||
|
||||
### Bug report
|
||||
|
||||
**System info:**
|
||||
|
||||
* **Version used:**
|
||||
* **OS (e.g. from `/etc/*-release`):**
|
||||
* **Kernel (`uname -a`):**
|
||||
* **Install tools:**
|
||||
|
||||
**Steps to reproduce:**
|
||||
|
||||
1. [First Step]
|
||||
2. [Second Step]
|
||||
3. [and so on...]
|
||||
|
||||
**Expected behavior:**
|
||||
|
||||
[What you expected to happen]
|
||||
|
||||
**Actual behavior:**
|
||||
|
||||
[What actually happened]
|
||||
|
||||
**Additional info:**
|
||||
|
||||
[Include gist of relevant config, logs, etc.]
|
||||
|
||||
Please run those if possible and link them from a [gist](http://gist.github.com).
|
||||
|
||||
---
|
||||
|
||||
### Feature Request
|
||||
|
||||
Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them.
|
||||
|
||||
**Proposal:**
|
||||
|
||||
[Description of the feature]
|
||||
|
||||
**Current behavior:**
|
||||
|
||||
[What currently happens]
|
||||
|
||||
**Desired behavior:**
|
||||
|
||||
[What you would like to happen]
|
||||
|
||||
**Use case:**
|
||||
|
||||
[Why is this important (helps with prioritizing requests)]
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
### What did you implement:
|
||||
|
||||
Closes #XXXXX
|
||||
|
||||
### How did you implement it:
|
||||
|
||||
...
|
||||
|
||||
### How can we verify it:
|
||||
|
||||
...
|
||||
|
||||
### TODO's:
|
||||
|
||||
- [ ] Write tests
|
||||
- [ ] Write documentation
|
||||
- [ ] Check that there aren't other open pull requests for the same issue/feature
|
||||
- [ ] Format your source code by `make fmt`
|
||||
- [ ] Provide verification config / commands
|
||||
- [ ] Enable "Allow edits from maintainers" for this PR
|
||||
- [ ] Update the messages below
|
||||
|
||||
**Is this ready for review?:** No
|
||||
**Is it a breaking change?:** No
|
||||
@ -0,0 +1,121 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, develop]
|
||||
pull_request:
|
||||
branches: [master]
|
||||
|
||||
jobs:
|
||||
Go:
|
||||
name: Go
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
env:
|
||||
SRC_DIR: src/github.com/${{ github.repository }}
|
||||
GO111MODULE: auto
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
go: [ '1.15.x', '1.16.x' ]
|
||||
|
||||
steps:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: ${{ matrix.go }}
|
||||
id: go
|
||||
|
||||
- name: Setup PATH
|
||||
run: |
|
||||
echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV"
|
||||
echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH"
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
path: ${{env.SRC_DIR}}
|
||||
|
||||
- name: Download dependencies
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: make deps deps-test
|
||||
|
||||
- name: Download Verdana font
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: curl -L -o 'Verdana.ttf' 'https://github.com/matomo-org/travis-scripts/raw/master/fonts/Verdana.ttf'
|
||||
|
||||
- name: Run tests
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: go test -v -covermode count -coverprofile cover.out ./...
|
||||
|
||||
- name: Install goveralls
|
||||
env:
|
||||
GO111MODULE: off
|
||||
run: go get -v github.com/mattn/goveralls
|
||||
|
||||
- name: Send coverage to Coveralls
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
env:
|
||||
COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: goveralls -service github -coverprofile cover.out
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '14.x'
|
||||
|
||||
- name: Install codeclimate-test-reporter
|
||||
run: npm install -g codeclimate-test-reporter
|
||||
|
||||
- name: Send coverage to Codebeat
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
env:
|
||||
CODECLIMATE_API_HOST: https://codebeat.co/webhooks/code_coverage
|
||||
CODECLIMATE_REPO_TOKEN: ${{ secrets.CODECLIMATE_TOKEN }}
|
||||
run: codeclimate-test-reporter < cover.out
|
||||
|
||||
Aligo:
|
||||
name: Aligo
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
needs: Go
|
||||
|
||||
env:
|
||||
SRC_DIR: src/github.com/${{ github.repository }}
|
||||
GO111MODULE: auto
|
||||
|
||||
steps:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: '1.16.x'
|
||||
id: go
|
||||
|
||||
- name: Setup PATH
|
||||
run: |
|
||||
echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV"
|
||||
echo "GOBIN=${{ github.workspace }}/bin" >> "$GITHUB_ENV"
|
||||
echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH"
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
path: ${{env.SRC_DIR}}
|
||||
|
||||
- name: Download dependencies
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: make deps
|
||||
|
||||
- name: Install Aligo
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: |
|
||||
wget https://apps.kaos.st/aligo/latest/linux/x86_64/aligo
|
||||
chmod +x aligo
|
||||
|
||||
- name: Print Aligo version info
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: ./aligo --version
|
||||
|
||||
- name: Check Go structs alignment info
|
||||
working-directory: ${{env.SRC_DIR}}
|
||||
run: ./aligo check ./...
|
||||
@ -0,0 +1,28 @@
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, develop]
|
||||
pull_request:
|
||||
branches: [master]
|
||||
schedule:
|
||||
- cron: '0 17 * * 1,3,5'
|
||||
|
||||
jobs:
|
||||
analyse:
|
||||
name: Analyse
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v1
|
||||
with:
|
||||
languages: go
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v1
|
||||
@ -0,0 +1,28 @@
|
||||
name: GoDoc
|
||||
|
||||
on:
|
||||
create
|
||||
|
||||
jobs:
|
||||
GoSumDB:
|
||||
name: Trigger GoSum/PkgGoDev
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
env:
|
||||
GO_SUM: https://sum.golang.org/lookup
|
||||
GO_PKG: https://pkg.go.dev/fetch
|
||||
|
||||
steps:
|
||||
- name: Send request to GoSum DB
|
||||
if: ${{ github.ref == refs/tags/* }}
|
||||
run: |
|
||||
full_ver=$(echo ${GITHUB_REF} | cut -f3 -d'/')
|
||||
major_ver=$(echo ${full_ver} | cut -f1 -d'.')
|
||||
curl -s -m 15 ${{env.GO_SUM}}/pkg.re/${{github.repository}}.${major_ver}@${full_ver}+incompatible
|
||||
|
||||
- name: Send request to PkgGoDev
|
||||
if: ${{ github.ref == refs/tags/* }}
|
||||
run: |
|
||||
full_ver=$(echo ${GITHUB_REF} | cut -f3 -d'/')
|
||||
major_ver=$(echo ${full_ver} | cut -f1 -d'.')
|
||||
curl -s -m 5 -X POST ${{env.GO_PKG}}/pkg.re/${{github.repository}}.${major_ver}@${full_ver}+incompatible || exit 0
|
||||
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2020 ESSENTIAL KAOS
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@ -0,0 +1,41 @@
|
||||
################################################################################
|
||||
|
||||
# This Makefile generated by GoMakeGen 1.3.2 using next command:
|
||||
# gomakegen .
|
||||
#
|
||||
# More info: https://kaos.sh/gomakegen
|
||||
|
||||
################################################################################
|
||||
|
||||
.DEFAULT_GOAL := help
|
||||
.PHONY = fmt vet git-config deps deps-test test help
|
||||
|
||||
################################################################################
|
||||
|
||||
git-config: ## Configure git redirects for stable import path services
|
||||
git config --global http.https://pkg.re.followRedirects true
|
||||
|
||||
deps: git-config ## Download dependencies
|
||||
go get -d -v github.com/golang/freetype
|
||||
go get -d -v golang.org/x/image/font
|
||||
|
||||
deps-test: git-config ## Download dependencies for tests
|
||||
go get -d -v pkg.re/essentialkaos/check.v1
|
||||
|
||||
test: ## Run tests
|
||||
go test -covermode=count .
|
||||
|
||||
fmt: ## Format source code with gofmt
|
||||
find . -name "*.go" -exec gofmt -s -w {} \;
|
||||
|
||||
vet: ## Runs go vet over sources
|
||||
go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./...
|
||||
|
||||
help: ## Show this info
|
||||
@echo -e '\n\033[1mSupported targets:\033[0m\n'
|
||||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
|
||||
| awk 'BEGIN {FS = ":.*?## "}; {printf " \033[33m%-12s\033[0m %s\n", $$1, $$2}'
|
||||
@echo -e ''
|
||||
@echo -e '\033[90mGenerated by GoMakeGen 1.3.2\033[0m\n'
|
||||
|
||||
################################################################################
|
||||
@ -1,2 +1,73 @@
|
||||
# go-badge
|
||||
Go package for generating SVG badges
|
||||
<p align="center"><a href="#readme"><img src="https://gh.kaos.st/go-badge.svg"/></a></p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://kaos.sh/g/go-badge.v1"><img src="https://gh.kaos.st/godoc.svg" alt="PkgGoDev" /></a>
|
||||
<a href="https://kaos.sh/w/go-badge/ci"><img src="https://kaos.sh/w/go-badge/ci.svg" alt="GitHub Actions CI Status" /></a>
|
||||
<a href="https://kaos.sh/r/go-badge"><img src="https://kaos.sh/r/go-badge.svg" alt="GoReportCard" /></a>
|
||||
<a href="https://kaos.sh/c/go-badge"><img src="https://kaos.sh/c/go-badge.svg" alt="Coverage Status" /></a>
|
||||
<a href="https://kaos.sh/b/go-badge"><img src="https://kaos.sh/b/0cbded00-9dfb-458b-bdf8-27b2c70ede9b.svg" alt="Codebeat badge" /></a>
|
||||
<a href="https://kaos.sh/w/go-badge/codeql"><img src="https://kaos.sh/w/go-badge/codeql.svg" alt="GitHub Actions CodeQL Status" /></a>
|
||||
<a href="#license"><img src="https://gh.kaos.st/apache2.svg"></a>
|
||||
</p>
|
||||
|
||||
<p align="center"><a href="#installation">Installation</a> • <a href="#usage-example">Usage example</a> • <a href="#build-status">Build Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
|
||||
|
||||
<br/>
|
||||
|
||||
`badge` is a Go package for generating SVG badges.
|
||||
|
||||
### Installation
|
||||
|
||||
Make sure you have a working Go 1.15+ workspace (_[instructions](https://golang.org/doc/install)_), then:
|
||||
|
||||
````bash
|
||||
go get -d pkg.re/essentialkaos/go-badge.v1
|
||||
````
|
||||
|
||||
For update to latest stable release, do:
|
||||
|
||||
```bash
|
||||
go get -d -u pkg.re/essentialkaos/go-badge.v1
|
||||
```
|
||||
|
||||
### Usage example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"pkg.re/essentialkaos/go-badge.v1"
|
||||
)
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
func main() {
|
||||
g, err := badge.NewGenerator("Verdana.ttf")
|
||||
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
fmt.Println(g.GeneratePlastic("status", "ok", "#97ca00"))
|
||||
}
|
||||
```
|
||||
|
||||
### Build Status
|
||||
|
||||
| Branch | Status |
|
||||
|--------|----------|
|
||||
| `master` | [](https://kaos.sh/w/go-badge/ci?query=branch:master) |
|
||||
| `develop` | [](https://kaos.sh/w/go-badge/ci?query=branch:develop) |
|
||||
|
||||
### Contributing
|
||||
|
||||
Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).
|
||||
|
||||
### License
|
||||
|
||||
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
<p align="center"><a href="https://essentialkaos.com"><img src="https://gh.kaos.st/ekgh.svg"/></a></p>
|
||||
|
||||
@ -0,0 +1,36 @@
|
||||
# Security Policies and Procedures
|
||||
|
||||
This document outlines security procedures and general policies for all
|
||||
ESSENTIAL KAOS projects.
|
||||
|
||||
* [Reporting a Bug](#reporting-a-bug)
|
||||
* [Disclosure Policy](#disclosure-policy)
|
||||
|
||||
## Reporting a Bug
|
||||
|
||||
The ESSENTIAL KAOS team and community take all security bugs in our projects
|
||||
very seriously. Thank you for improving the security of our project. We
|
||||
appreciate your efforts and responsible disclosure and will make every effort
|
||||
to acknowledge your contributions.
|
||||
|
||||
Report security bugs by emailing our security team at security@essentialkaos.com.
|
||||
|
||||
The security team will acknowledge your email within 48 hours and will send a
|
||||
more detailed response within 48 hours, indicating the next steps in handling
|
||||
your report. After the initial reply to your report, the security team will
|
||||
endeavor to keep you informed of the progress towards a fix and full
|
||||
announcement, and may ask for additional information or guidance.
|
||||
|
||||
Report security bugs in third-party dependencies to the person or team
|
||||
maintaining the dependencies.
|
||||
|
||||
## Disclosure Policy
|
||||
|
||||
When the security team receives a security bug report, they will assign it to a
|
||||
primary handler. This person will coordinate the fix and release process,
|
||||
involving the following steps:
|
||||
|
||||
* Confirm the problem and determine the affected versions;
|
||||
* Audit code to find any similar potential problems;
|
||||
* Prepare fixes for all releases still under maintenance. These fixes will be
|
||||
released as fast as possible.
|
||||
@ -0,0 +1,109 @@
|
||||
// Package badge provides methods for generating SVG badges
|
||||
package badge
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
// //
|
||||
// Copyright (c) 2021 ESSENTIAL KAOS //
|
||||
// Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0> //
|
||||
// //
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/golang/freetype/truetype"
|
||||
|
||||
"golang.org/x/image/font"
|
||||
)
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
const _TEMPLATE_PLASTIC = `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{WIDTH}" height="18" role="img" aria-label="{LABEL}: {MESSAGE}"><title>{LABEL}: {MESSAGE}</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#fff" stop-opacity=".7"/><stop offset=".1" stop-color="#aaa" stop-opacity=".1"/><stop offset=".9" stop-color="#000" stop-opacity=".3"/><stop offset="1" stop-color="#000" stop-opacity=".5"/></linearGradient><clipPath id="r"><rect width="{WIDTH}" height="18" rx="4" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="{LABEL_WIDTH}" height="18" fill="#555"/><rect x="{LABEL_WIDTH}" width="{MESSAGE_WIDTH}" height="18" fill="{COLOR}"/><rect width="{WIDTH}" height="18" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="{LABEL_X}" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="{LABEL_LENGTH}">{LABEL}</text><text x="{LABEL_X}" y="130" transform="scale(.1)" fill="#fff" textLength="{LABEL_LENGTH}">{LABEL}</text><text aria-hidden="true" x="{MESSAGE_X}" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="{MESSAGE_LENGTH}">{MESSAGE}</text><text x="{MESSAGE_X}" y="130" transform="scale(.1)" fill="#fff" textLength="{MESSAGE_LENGTH}">{MESSAGE}</text></g></svg>`
|
||||
|
||||
const _TEMPLATE_FLAT = `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{WIDTH}" height="20" role="img" aria-label="{LABEL}: {MESSAGE}"><title>{LABEL}: {MESSAGE}</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="{WIDTH}" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="{LABEL_WIDTH}" height="20" fill="#555"/><rect x="{LABEL_WIDTH}" width="{MESSAGE_WIDTH}" height="20" fill="{COLOR}"/><rect width="{WIDTH}" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="{LABEL_X}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="{LABEL_LENGTH}">{LABEL}</text><text x="{LABEL_X}" y="140" transform="scale(.1)" fill="#fff" textLength="{LABEL_LENGTH}">{LABEL}</text><text aria-hidden="true" x="{MESSAGE_X}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="{MESSAGE_LENGTH}">{MESSAGE}</text><text x="{MESSAGE_X}" y="140" transform="scale(.1)" fill="#fff" textLength="{MESSAGE_LENGTH}">{MESSAGE}</text></g></svg>`
|
||||
|
||||
const _TEMPLATE_FLAT_SQUARE = `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{WIDTH}" height="20" role="img" aria-label="{LABEL}: {MESSAGE}"><title>{LABEL}: {MESSAGE}</title><g shape-rendering="crispEdges"><rect width="{LABEL_WIDTH}" height="20" fill="#555"/><rect x="{LABEL_WIDTH}" width="{MESSAGE_WIDTH}" height="20" fill="{COLOR}"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text x="{LABEL_X}" y="140" transform="scale(.1)" fill="#fff" textLength="{LABEL_LENGTH}">{LABEL}</text><text x="{MESSAGE_X}" y="140" transform="scale(.1)" fill="#fff" textLength="{MESSAGE_LENGTH}">{MESSAGE}</text></g></svg>`
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
type Generator struct {
|
||||
Offset int
|
||||
|
||||
drawer *font.Drawer
|
||||
}
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
func NewGenerator(fontFile string) (*Generator, error) {
|
||||
fontData, err := ioutil.ReadFile(fontFile)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
fontTTF, err := truetype.Parse(fontData)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &Generator{
|
||||
Offset: 9,
|
||||
drawer: &font.Drawer{
|
||||
Face: truetype.NewFace(fontTTF, &truetype.Options{
|
||||
Size: 11,
|
||||
DPI: 72,
|
||||
Hinting: font.HintingFull,
|
||||
}),
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
// GeneratePlastic generates SVG badge in plastic style
|
||||
func (g *Generator) GeneratePlastic(label, message, color string) string {
|
||||
return g.generateBadge(_TEMPLATE_PLASTIC, label, message, color)
|
||||
}
|
||||
|
||||
// GenerateFlat generates SVG badge in flat style
|
||||
func (g *Generator) GenerateFlat(label, message, color string) string {
|
||||
return g.generateBadge(_TEMPLATE_FLAT, label, message, color)
|
||||
}
|
||||
|
||||
// GenerateFlatSquare generates SVG badge in flat-square style
|
||||
func (g *Generator) GenerateFlatSquare(label, message, color string) string {
|
||||
return g.generateBadge(_TEMPLATE_FLAT_SQUARE, label, message, color)
|
||||
}
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
// generateBadge generates badge with given template
|
||||
func (g *Generator) generateBadge(template, label, message, color string) string {
|
||||
if !strings.HasPrefix(color, "#") {
|
||||
color = "#" + color
|
||||
}
|
||||
|
||||
lW := int(g.drawer.MeasureString(label)>>6) + g.Offset
|
||||
mW := int(g.drawer.MeasureString(message)>>6) + g.Offset
|
||||
fW := lW + mW
|
||||
lX := ((lW/2 + 1) * 10) + 5
|
||||
mX := ((lW + (mW / 2) - 1) * 10) + 5
|
||||
lL := (lW - 10) * 10
|
||||
mL := (mW - 10) * 10
|
||||
|
||||
badge := strings.ReplaceAll(template, "{LABEL}", label)
|
||||
badge = strings.ReplaceAll(badge, "{MESSAGE}", message)
|
||||
badge = strings.ReplaceAll(badge, "{COLOR}", color)
|
||||
badge = strings.ReplaceAll(badge, "{WIDTH}", strconv.Itoa(fW))
|
||||
badge = strings.ReplaceAll(badge, "{LABEL_WIDTH}", strconv.Itoa(lW))
|
||||
badge = strings.ReplaceAll(badge, "{MESSAGE_WIDTH}", strconv.Itoa(mW))
|
||||
badge = strings.ReplaceAll(badge, "{LABEL_X}", strconv.Itoa(lX))
|
||||
badge = strings.ReplaceAll(badge, "{MESSAGE_X}", strconv.Itoa(mX))
|
||||
badge = strings.ReplaceAll(badge, "{LABEL_LENGTH}", strconv.Itoa(lL))
|
||||
badge = strings.ReplaceAll(badge, "{MESSAGE_LENGTH}", strconv.Itoa(mL))
|
||||
|
||||
return badge
|
||||
}
|
||||
@ -0,0 +1,84 @@
|
||||
package badge
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
// //
|
||||
// Copyright (c) 2021 ESSENTIAL KAOS //
|
||||
// Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0> //
|
||||
// //
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"testing"
|
||||
|
||||
. "pkg.re/essentialkaos/check.v1"
|
||||
)
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
func Test(t *testing.T) { TestingT(t) }
|
||||
|
||||
type BadgeSuite struct {
|
||||
generator *Generator
|
||||
}
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
|
||||
var _ = Suite(&BadgeSuite{})
|
||||
|
||||
// ////////////////////////////////////////////////////////////////////////////////// //
|
||||
func (s *BadgeSuite) SetUpTest(c *C) {
|
||||
var err error
|
||||
|
||||
s.generator, err = NewGenerator("Verdana.ttf")
|
||||
|
||||
if err != nil {
|
||||
c.Fatal(err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func (s *BadgeSuite) TestErrors(c *C) {
|
||||
_, err := NewGenerator("unknown.ttf")
|
||||
|
||||
c.Assert(err, NotNil)
|
||||
|
||||
_, err = NewGenerator("badge.go")
|
||||
|
||||
c.Assert(err, NotNil)
|
||||
}
|
||||
|
||||
func (s *BadgeSuite) TestPlastic(c *C) {
|
||||
srcBadge, err := ioutil.ReadFile("testdata/plastic.svg")
|
||||
|
||||
if err != nil {
|
||||
c.Fatal(err.Error())
|
||||
}
|
||||
|
||||
ourBadge := s.generator.GeneratePlastic("test1", "good", "ff69b4")
|
||||
|
||||
c.Assert(ourBadge, Equals, string(srcBadge))
|
||||
}
|
||||
|
||||
func (s *BadgeSuite) TestFlat(c *C) {
|
||||
srcBadge, err := ioutil.ReadFile("testdata/flat.svg")
|
||||
|
||||
if err != nil {
|
||||
c.Fatal(err.Error())
|
||||
}
|
||||
|
||||
ourBadge := s.generator.GenerateFlat("test1", "good", "ff69b4")
|
||||
|
||||
c.Assert(ourBadge, Equals, string(srcBadge))
|
||||
}
|
||||
|
||||
func (s *BadgeSuite) TestFlatSquare(c *C) {
|
||||
srcBadge, err := ioutil.ReadFile("testdata/flat-square.svg")
|
||||
|
||||
if err != nil {
|
||||
c.Fatal(err.Error())
|
||||
}
|
||||
|
||||
ourBadge := s.generator.GenerateFlatSquare("test1", "good", "ff69b4")
|
||||
|
||||
c.Assert(ourBadge, Equals, string(srcBadge))
|
||||
}
|
||||
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="74" height="20" role="img" aria-label="test1: good"><title>test1: good</title><g shape-rendering="crispEdges"><rect width="37" height="20" fill="#555"/><rect x="37" width="37" height="20" fill="#ff69b4"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">test1</text><text x="545" y="140" transform="scale(.1)" fill="#fff" textLength="270">good</text></g></svg>
|
||||
|
After Width: | Height: | Size: 617 B |
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="74" height="20" role="img" aria-label="test1: good"><title>test1: good</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="74" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="37" height="20" fill="#ff69b4"/><rect width="74" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">test1</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">test1</text><text aria-hidden="true" x="545" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">good</text><text x="545" y="140" transform="scale(.1)" fill="#fff" textLength="270">good</text></g></svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="74" height="18" role="img" aria-label="test1: good"><title>test1: good</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#fff" stop-opacity=".7"/><stop offset=".1" stop-color="#aaa" stop-opacity=".1"/><stop offset=".9" stop-color="#000" stop-opacity=".3"/><stop offset="1" stop-color="#000" stop-opacity=".5"/></linearGradient><clipPath id="r"><rect width="74" height="18" rx="4" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="18" fill="#555"/><rect x="37" width="37" height="18" fill="#ff69b4"/><rect width="74" height="18" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">test1</text><text x="195" y="130" transform="scale(.1)" fill="#fff" textLength="270">test1</text><text aria-hidden="true" x="545" y="140" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">good</text><text x="545" y="130" transform="scale(.1)" fill="#fff" textLength="270">good</text></g></svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
Loading…
Reference in New Issue