Skip to content

Commit f504fb5

Browse files
katheroinekatheroine
committed
Merge branch 'release-2.0.0'
2 parents eb5fbba + 0a3dd88 commit f504fb5

33 files changed

+1115
-1376
lines changed

‎.github/workflows/php.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: PHP Sniff and Unit Test
2+
3+
on:
4+
push:
5+
branches: [ "master", "develop" ]
6+
pull_request:
7+
branches: [ "master", "develop" ]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
php-versions: [ '8.1', '8.2', '8.3' ]
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Install PHP
21+
uses: shivammathur/setup-php@v2
22+
with:
23+
php-version: ${{ matrix.php-versions }}
24+
- name: Validate composer.json and composer.lock
25+
run: composer validate --strict
26+
- name: Cache Composer packages
27+
id: composer-cache
28+
uses: actions/cache@v3
29+
with:
30+
path: vendor
31+
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
32+
restore-keys: |
33+
${{ runner.os }}-php-
34+
- name: Install dependencies
35+
run: composer install --prefer-dist --no-progress
36+
- name: Run sniffs and unit tests
37+
run: composer check

‎CHANGELOG.md

+14-38
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,14 @@
1-
CHANGELOG
2-
=========
3-
4-
## 1.0 (2015.03.07)
5-
6-
* 8d81dea Exorg\ namespace added, autoloading changed to PSR-4
7-
* b2127d8 Merge pull request #8 from katheroine/issue-2-decapsulator
8-
* d3ad956 ObjectDecapsulator code style fixed (#2)
9-
* 10f1fee Merge pull request #7 from katheroine/issue-2-decapsulator
10-
* 8f7df0d ObjectDecapsulator tests moved to separated directory and namespace (#2)
11-
* 9dec4b0 ObjectDacapsulator magic __construct disabled (#2)
12-
* 305cf16 Tests refactoring. ObjectDecapsulator bugs fixes. (#2)
13-
* c691130 Merge pull request #6 from katheroine/issue-2-decapsulator
14-
* 51bd7d1 ObjectDecapsulator magic __call method implemented (#2)
15-
* 068511c ObjectDecapsulator callMethod method implemented (#2)
16-
* ff680b9 ObjectDecapsulator methodExists method implemented (#2)
17-
* 5f83b91 ObjectDecapsulator magic __get method implemented (#2)
18-
* 15f7307 ObjectDecapsulator getProperty method implemented (#2)
19-
* 4df3f77 ObjectDecapsulator magic __set method implemented (#2)
20-
* 782f7f8 ObjectDecapsulator setProperty method implemented (#2)
21-
* 0895a13 ObjectDecapsulator propertyExists method implemented (#2)
22-
* a0b1330 ObjectDecapsulator buildForObject method implemented (#2)
23-
* 445a8c2 ObjectDecapsulator objectIsValid method implemented (#2)
24-
* 7bbfa79 ObjectDecapsulator createInstanceFromObject method implemented (#2)
25-
* 0535d73 ObjectDecapsulator setUpWithObject method implemented (#2)
26-
* 9c79d60 ObjectDecapsulator setObject method implemented (#2)
27-
* a184695 ObjectDecapsulator setUpReflection method implemented (#2)
28-
* fea6c27 Merge pull request #5 from katheroine/issue-1-composer-config
29-
* 766d1f6 Add PHP_CodeSniffer to the composer configuration (#1)
30-
* 584c283 Merge pull request #4 from katheroine/issue-1-composer-config
31-
* 431ba22 Fix composer config and add PHPUnit config (#1)
32-
* ffdd6c2 Merge pull request #3 from katheroine/issue-1-composer-config
33-
* 0dee43f Fix composer configuration and git ignored files (#1)
34-
* fb0ede8 Add composer configuration and update git ignored files (#1)
35-
* 79d95f8 Create README.md
36-
* 1a4ff5f Create LICENSE.md
37-
38-
1+
# Changes in Decapsulator
2+
All notable changes to this project will be documented in this file.
3+
This project adheres to [Semantic Versioning](http://semver.org/).
4+
5+
## [2.0.0] - 2024-05-04
6+
### Changed
7+
- Basic dependencies
8+
- Coding style, class properties & methods signatures
9+
10+
## [1.0] - 2015.03.07
11+
### Added
12+
- ObjectDecapsulator - magic __set method
13+
- ObjectDecapsulator - magic __get method
14+
- ObjectDecapsulator - magic __call method

‎CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to Decapsulator
2+
3+
To contribute to the project you need to have an account on [GitHub](https://github.com/).
4+
5+
## Workflow
6+
7+
1. Create a fork of this repository
8+
2. Clone repository
9+
3. Ensure you have configured *name* and *email address* in Git
10+
4. Create issue with proper description and label on GitHub within this project
11+
5. Assign yourself to the issue
12+
6. Fork fix or feature branch with proper prefix and number of the issue (e.g. *issue-92-readme-file-update*)
13+
7. Complete work and commit with proper message and number of issue with hash and in parentheses
14+
8. Push branch to your forked project on your GitHub account
15+
9. Create a [pull request](https://help.github.com/articles/using-pull-requests/) to the **develop** branch of the original ExOrg repository
16+
17+
## Standards and conventions
18+
19+
Please follow [PSR-1](http://www.php-fig.org/psr/psr-1/) and [PSR-12](http://www.php-fig.org/psr/psr-12/) coding standards and [PSR-4](http://www.php-fig.org/psr/psr-4/) autoloading standard.
20+
21+
This project uses [PHPCodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) for detecting coding style issues.
22+
23+
To run tests for code style write the following command in your command line inside the main DataCoder project directory
24+
25+
```bash
26+
vendor/bin/phpcs tests/ src/
27+
```
28+
29+
Please take care over consistency of the code and check existing examples before you create your own extensions.
30+
31+
## Automated tests
32+
33+
Write unit tests for your code.
34+
35+
This project uses [PHPUnit](https://phpunit.de/) as unit tests framework.
36+
37+
To run tests, write the following command in your command line inside the main DataCoder project directory
38+
39+
```bash
40+
vendor/bin/phpunit tests/
41+
```

‎LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015 Katarzyna Krasińska
3+
Copyright (c) 2015-2024 Katarzyna Krasińska
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)