Skip to content

Commit 6dfb240

Browse files
siguicisiguici
committed
Merge @sikessem/values
2 parents faee822 + 9fa23f4 commit 6dfb240

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+5069
-102
lines changed

‎.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
fail-fast: true
1414
matrix:
1515
os: [ubuntu-latest]
16-
php: [8.1, 8.2]
16+
php: [8.2, 8.3]
1717
dependencies: [lowest, highest]
1818
experimental: [false]
1919
name: 👷 CI PHP-${{ matrix.php }} ${{ matrix.dependencies }} on ${{ matrix.os }}

‎CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Release Notes for the Sikessem Skeleton
1+
# Release Notes for Sikessem
22

3-
All notable changes to [Skeleton](https://github.com/sikessem/skeleton) will be documented in this file.
3+
All notable changes to [Values](https://github.com/sikessem/values) will be documented in this file.
44

5-
## [Unreleased](https://github.com/sikessem/skeleton/compare/v0.0.0...HEAD)
5+
## [Unreleased](https://github.com/sikessem/values/compare/v0.0.0...HEAD)
66

7-
**Full Changelog:** [v0.0.0...v0.x](https://github.com/sikessem/skeleton/compare/v0.0.0...v0.x)
7+
**Full Changelog:** [v0.0.0...v0.x](https://github.com/sikessem/core/compare/v0.0.0...v0.x)

‎CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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+
[ske@sikessem.com](mailto:ske@sikessem.com).
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][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
129+
[Mozilla CoC]: https://github.com/mozilla/diversity
130+
[FAQ]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

‎README.md

+101-18
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,126 @@
1515
</div>
1616

1717
[sikessem-logo]: https://github.com/sikessem/art/blob/HEAD/images/sikessem.svg
18-
[sikessem-link]: https://sikessem.github.io "Sikessem"
18+
[sikessem-link]: https://github.com/sikessem "Sikessem"
1919

2020
[php-icon]: https://img.shields.io/badge/PHP-ccc.svg?style=flat&logo=php
21-
[php-link]: https://github.com/sikessem/skeleton/search?l=php "PHP code"
21+
[php-link]: https://github.com/sikessem/values/search?l=php "PHP code"
2222

23-
[packagist-version-icon]: https://img.shields.io/packagist/v/sikessem/skeleton
24-
[packagist-version-link]: https://packagist.org/packages/sikessem/skeleton "Skeleton Releases"
23+
[packagist-version-icon]: https://img.shields.io/packagist/v/sikessem/values
24+
[packagist-version-link]: https://packagist.org/packages/sikessem/values "Values Releases"
2525

26-
[packagist-download-icon]: https://img.shields.io/packagist/dt/sikessem/skeleton
27-
[packagist-download-link]: https://packagist.org/packages/sikessem/skeleton "Skeleton Downloads"
26+
[packagist-download-icon]: https://img.shields.io/packagist/dt/sikessem/values
27+
[packagist-download-link]: https://packagist.org/packages/sikessem/values "Values Downloads"
2828

29-
[actions-icon]: https://github.com/sikessem/skeleton/workflows/CI/badge.svg
30-
[actions-link]: https://github.com/sikessem/skeleton/actions "Skeleton status"
29+
[actions-icon]: https://github.com/sikessem/values/workflows/CI/badge.svg
30+
[actions-link]: https://github.com/sikessem/values/actions "Values status"
3131

3232
[pr-icon]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=brightgreen
33-
[pr-link]: https://sikessem.github.io/contributions "PRs welcome!"
33+
[pr-link]: https://github.com/sikessem/.github/blob/HEAD/CONTRIBUTING.md "PRs welcome!"
3434

3535
[twitter-icon]: https://img.shields.io/twitter/follow/sikessem.svg?label=@sikessem_tweets
3636
[twitter-link]: https://twitter.com/intent/follow?screen_name=sikessem_tweets "Ping Sikessem"
3737

3838
[license-icon]: https://img.shields.io/badge/license-MIT-blue.svg
39-
[license-link]: https://github.com/sikessem/skeleton/blob/HEAD/LICENSE "Skeleton License"
40-
[conduct-link]: https://sikessem.github.io/code-of-conduct "Sikessem's Code of Conduct"
41-
[discuss-link]: https://github.com/orgs/sikessem/discussions "Sikessem's GitHub discussions"
42-
[docs-link]: https://sikessem.github.io/packages/skeleton "Skeleton Documentation"
39+
[license-link]: https://github.com/sikessem/values/blob/HEAD/LICENSE "Values License"
40+
[conduct-link]: https://github.com/sikessem/values/blob/HEAD/CODE_OF_CONDUCT.md
41+
[discuss-link]: https://github.com/orgs/sikessem/discussions
42+
[docs-link]: https://github.com/sikessem/values#readme "Values Documentation"
4343

4444
***
4545

46-
# 📦️ Sikessem Skeleton
46+
# PHP Value Objects
4747

48-
Create a new [Sikessem][sikessem-link] project based on this template.
48+
Objects with strict types to manage PHP variables and values.
4949

50-
[Read the documentation to learn more][docs-link].
50+
## 🔖 Contents
51+
52+
- [PHP Value Objects](#php-value-objects)
53+
- [🔖 Contents](#-contents)
54+
- [📋 Requirements](#-requirements)
55+
- [🎉 Getting Started](#-getting-started)
56+
- [⚡️ Installation](#️-installation)
57+
- [🧑‍💻 Usage](#-usage)
58+
- [🧪 Testing and debugging](#-testing-and-debugging)
59+
- [📖 Documentation](#-documentation)
60+
- [👏 Contribution](#-contribution)
61+
- [👷 Code of Conduct](#-code-of-conduct)
62+
- [👥 Contributing Guide](#-contributing-guide)
63+
- [🔒️ Good First Issues](#️-good-first-issues)
64+
- [💬 Discussions](#-discussions)
65+
- [🔐 Security Reports](#-security-reports)
66+
- [📄 License](#-license)
67+
68+
## 📋 Requirements
69+
70+
> - **Requires [PHP >=8.0](https://php.net/releases/)** (at least 8.0.30 recommended to avoid potential bugs).
71+
> - **Requires [Composer v2+](https://getcomposer.org/)** to manage PHP dependencies.
72+
73+
## 🎉 Getting Started
74+
75+
### ⚡️ Installation
76+
77+
Use [Composer](https://getcomposer.org/) to install `sikessem/values`:
78+
79+
```bash
80+
composer require sikessem/values
81+
```
82+
83+
### 🧑‍💻 Usage
84+
85+
```php
86+
<?php
87+
88+
use Sikessem\Values\Value;
89+
90+
$two = Value::from(2); // 2
91+
$two->update(fn($val) => $val * $val); // 4
92+
$two->set(5); // 5
93+
```
94+
95+
### 🧪 Testing and debugging
96+
97+
🧹 Keep a modern codebase with **Pint**:
98+
99+
```bash
100+
composer lint
101+
```
102+
103+
⚗️ Run static analysis:
104+
105+
- Using **PHPStan**:
106+
107+
```bash
108+
composer analyse
109+
```
110+
111+
- Using **Psalm**:
112+
113+
```bash
114+
composer inspect
115+
```
116+
117+
✅ Run unit tests using **PEST**
118+
119+
```bash
120+
composer test
121+
```
122+
123+
🐛 Check all code bugs:
124+
125+
```bash
126+
composer debug
127+
```
128+
129+
🚀 Fix the entire code:
130+
131+
```bash
132+
composer fix
133+
```
51134

52135
## 📖 Documentation
53136

54-
The full documentation for the Sikessem Skeleton can be found [here][docs-link].
137+
The full documentation for the Sikessem Values can be found on [this address][docs-link].
55138

56139
## 👏 Contribution
57140

@@ -70,7 +153,7 @@ Read our [**Contributing Guide**][pr-link] to learn about our development proces
70153

71154
We have a list of [good first issues][gfi] that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
72155

73-
[gfi]: https://github.com/sikessem/skeleton/labels/good%20first%20issue
156+
[gfi]: https://github.com/sikessem/values/labels/good%20first%20issue
74157

75158
### 💬 Discussions
76159

‎composer.json

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
"name": "sikessem/skeleton",
3-
"description": "📦️ Sikessem library builder template.",
4-
"homepage": "https://sikessem.github.io/packages/skeleton",
2+
"type": "library",
3+
"name": "sikessem/core",
4+
"description": "Objects with strict types to manage PHP variables and values.",
5+
"homepage": "https://packagist.com/packages/sikessem/core",
56
"license": "MIT",
67
"keywords": [
8+
"php",
79
"sikessem",
8-
"package-skeleton",
9-
"repository-template",
10-
"php"
10+
"core"
1111
],
1212
"authors": [
1313
{
@@ -17,24 +17,24 @@
1717
}
1818
],
1919
"support": {
20-
"source": "https://github.com/sikessem/skeleton",
21-
"issues": "https://github.com/sikessem/skeleton/issues",
20+
"source": "https://github.com/sikessem/core",
21+
"issues": "https://github.com/sikessem/core/issues",
2222
"chat": "https://github.com/orgs/sikessem/discussions"
2323
},
2424
"require": {
25-
"php": "^8.1|^8.2"
25+
"php": "^8.2||^8.3"
2626
},
2727
"require-dev": {
28-
"sikessem/devtools": "^0.4.0"
28+
"sikessem/devtools": "^0.8.0"
2929
},
3030
"autoload": {
3131
"psr-4": {
32-
"Sikessem\\Skeleton\\": "src/"
32+
"Sikessem\\": "src/"
3333
}
3434
},
3535
"autoload-dev": {
3636
"psr-4": {
37-
"Sikessem\\Skeleton\\Tests\\": "tests/"
37+
"Sikessem\\Tests\\": "tests/"
3838
}
3939
},
4040
"scripts": {

0 commit comments

Comments
 (0)