Skip to content

Commit 9de07cc

Browse files
smnandresmnandre
committed
Initial
0 parents  commit 9de07cc

17 files changed

+695
-0
lines changed

‎.gitattributes‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/.git* export-ignore
2+
/.php-cs-fixer.dist.php export-ignore
3+
/phpstan.dist.neon export-ignore
4+
/phpunit.dist.xml export-ignore
5+
/tests/ export-ignore

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [smnandre]

‎.github/workflows/CI.yaml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: "CI"
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
15+
dep:
16+
name: "Dependencies"
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: "Git: checkout"
20+
uses: actions/checkout@v4
21+
- name: "PHP: setup 8.3 "
22+
uses: shivammathur/setup-php@v2
23+
with:
24+
php-version: '8.3'
25+
coverage: none
26+
tools: composer
27+
- name: "Composer: cache config"
28+
id: composer-cache
29+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
30+
- name: "Composer: cache restore"
31+
uses: actions/cache@v4
32+
with:
33+
path: ${{ steps.composer-cache.outputs.dir }}
34+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
35+
restore-keys: ${{ runner.os }}-composer-
36+
- name: "Composer: validate"
37+
run: composer validate --strict
38+
- name: "Composer: install"
39+
run: composer install --prefer-dist --no-progress --no-suggest
40+
- name: "Composer: audit"
41+
run: composer audit
42+
43+
cs:
44+
name: "Code style"
45+
runs-on: ubuntu-latest
46+
steps:
47+
- name: "Git: checkout"
48+
uses: actions/checkout@v4
49+
- name: "PHP: setup 8.3"
50+
uses: shivammathur/setup-php@v2
51+
with:
52+
php-version: '8.3'
53+
coverage: none
54+
tools: php-cs-fixer
55+
- name: "Php-CS-Fixer: version"
56+
run: php-cs-fixer -V
57+
- name: "Php-CS-Fixer: check"
58+
run: php-cs-fixer check --diff
59+
60+
sa:
61+
name: "Static Analysis"
62+
runs-on: ubuntu-latest
63+
steps:
64+
- name: "Git: checkout"
65+
uses: actions/checkout@v4
66+
- name: "PHP: setup ${{ matrix.php-version }}"
67+
uses: shivammathur/setup-php@v2
68+
with:
69+
php-version: '8.3'
70+
coverage: none
71+
tools: phpstan
72+
- name: "Composer: cache config"
73+
id: composer-cache
74+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
75+
- name: "Composer: cache restore"
76+
uses: actions/cache@v4
77+
with:
78+
path: ${{ steps.composer-cache.outputs.dir }}
79+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
80+
restore-keys: ${{ runner.os }}-composer-
81+
- name: "Composer: validate"
82+
run: composer validate --strict
83+
- name: "Composer: install"
84+
run: composer install --prefer-dist --no-progress --no-suggest
85+
- name: "PHPStan: version"
86+
run: phpstan --version
87+
- name: "PHPStan: analyse"
88+
run: phpstan analyse src/
89+
90+
tests:
91+
name: "Tests (PHP ${{ matrix.php-version }})"
92+
runs-on: ubuntu-latest
93+
strategy:
94+
matrix:
95+
php-version:
96+
- '8.3'
97+
fail-fast: false
98+
steps:
99+
- name: "Git: Checkout"
100+
uses: actions/checkout@v4
101+
- name: "PHP: setup ${{ matrix.php-version }}"
102+
uses: shivammathur/setup-php@v2
103+
with:
104+
php-version: ${{ matrix.php-version }}
105+
coverage: xdebug
106+
ini-values: xdebug.mode=coverage
107+
- name: "PHP: php matcher"
108+
run: |
109+
echo "::add-matcher::${{ runner.tool_cache }}/php.json"
110+
- name: "Composer: cache config"
111+
id: composer-cache
112+
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
113+
- name: "Composer: cache restore"
114+
uses: actions/cache@v4
115+
with:
116+
path: ${{ steps.composer-cache.outputs.dir }}
117+
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
118+
restore-keys: ${{ runner.os }}-composer-
119+
- name: "Composer: validate"
120+
run: composer validate --strict
121+
- name: "Composer: install"
122+
run: composer install --prefer-dist --no-progress --no-suggest
123+
- name: "PHPUnit: version"
124+
run: ./vendor/bin/phpunit --version
125+
- name: "PHPUnit: tests"
126+
run: ./vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml
127+
- name: "Codecov: upload"
128+
uses: codecov/[email protected]
129+
with:
130+
token: ${{ secrets.CODECOV_TOKEN }}

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/.phpunit.cache/
2+
/vendor/
3+
/.php-cs-fixer.cache
4+
/composer.lock
5+
/phpstan.neon
6+
/phpunit.xml

‎.php-cs-fixer.dist.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
$licence = <<<'EOF'
4+
This file is part of the easing/functions package.
5+
6+
(c) Simon Andre <[email protected]>
7+
8+
For the full copyright and license information, please view the LICENSE
9+
file that was distributed with this source code.
10+
EOF;
11+
12+
$finder = (new PhpCsFixer\Finder())
13+
->in(__DIR__);
14+
15+
return (new PhpCsFixer\Config())
16+
->setRiskyAllowed(true)
17+
->setRules([
18+
'@PSR12' => true,
19+
'declare_strict_types' => true,
20+
'header_comment' => ['header' => $licence],
21+
])
22+
->setFinder($finder);

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
email.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024-present Simon André
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 all
13+
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 THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Easing & Timing Functions
2+
3+
[![PHP Version](https://img.shields.io/badge/%C2%A0php-%3E%3D%208.3-777BB4.svg?logo=php&logoColor=white)](https://github.com/smnandre/easing-functions/blob/main/composer.json)
4+
[![CI](https://github.com/smnandre/easing-functions/actions/workflows/CI.yaml/badge.svg)](https://github.com/smnandre/easing-functions/actions)
5+
[![Release](https://img.shields.io/github/v/release/smnandre/easing-functions)](https://github.com/smnandre/easing-functions/releases)
6+
[![License](https://img.shields.io/github/license/smnandre/easing-functions?color=cc67ff)](https://github.com/smnandre/easing-functions/blob/main/LICENSE)
7+
[![Codecov](https://codecov.io/gh/smnandre/easing-functions/graph/badge.svg?token=RC8Z6F4SPC)](https://codecov.io/gh/smnandre/easing-functions)
8+
9+
10+
11+
## Installation
12+
13+
```shell
14+
composer require smnandre/easing-functions
15+
```
16+
17+
## Usage
18+
19+
20+
21+
## Functions
22+
23+
| Function | Description | Example | A | B | C | D |
24+
|----------|--------------------------------------------------|---------| - | - | - | - |
25+
| `easeInCubic` | ![easeInOutCubic2.svg](img/easeInOutCubic2.svg) |
26+
| `easeInCubic` | ![easeInOutCubic2.svg](img/easeInOutCubic2.svg) |
27+
28+
29+
### Linear Function
30+
31+
### Cubic Bezier Function
32+
33+
### Step Function
34+
35+
36+
## Contributing
37+
38+
## License
39+

0 commit comments

Comments
 (0)