Added package skeleton
Added modified version of thephpleague/skeleton as skeleton of package.
This commit is contained in:
parent
b3edcd23a4
commit
8d8503661f
15
.editorconfig
Normal file
15
.editorconfig
Normal file
@ -0,0 +1,15 @@
|
||||
; This file is for unifying the coding style for different editors and IDEs.
|
||||
; More information at http://editorconfig.org
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_size = 4
|
||||
indent_style = space
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
11
.gitattributes
vendored
Normal file
11
.gitattributes
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
* text=auto
|
||||
|
||||
/.github export-ignore
|
||||
/tests export-ignore
|
||||
.editorconfig export-ignore
|
||||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
.travis.yml export-ignore
|
||||
.scrutinizer.yml export-ignore
|
||||
phpcs.xml.dist export-ignore
|
||||
phpunit.xml.dist export-ignore
|
32
.github/CONTRIBUTING.md
vendored
Normal file
32
.github/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
# Contributing
|
||||
|
||||
Contributions are **welcome** and will be fully **credited**.
|
||||
|
||||
We accept contributions via Pull Requests on [Github](https://github.com/yusufkandemir/microdata-parser).
|
||||
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
|
||||
|
||||
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
|
||||
|
||||
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
|
||||
|
||||
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
|
||||
|
||||
- **Create feature branches** - Don't ask us to pull from your master branch.
|
||||
|
||||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
|
||||
|
||||
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
|
||||
|
||||
|
||||
## Running Tests
|
||||
|
||||
``` bash
|
||||
$ composer test
|
||||
```
|
||||
|
||||
|
||||
**Happy coding**!
|
27
.github/ISSUE_TEMPLATE.md
vendored
Normal file
27
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
<!-- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Detailed description
|
||||
|
||||
Provide a detailed description of the change or addition you are proposing.
|
||||
|
||||
Make it clear if the issue is a bug, an enhancement or just a question.
|
||||
|
||||
## Context
|
||||
|
||||
Why is this change important to you? How would you use it?
|
||||
|
||||
How can it benefit other users?
|
||||
|
||||
## Possible implementation
|
||||
|
||||
Not obligatory, but suggest an idea for implementing addition or change.
|
||||
|
||||
## Your environment
|
||||
|
||||
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
|
||||
|
||||
* Version used (e.g. PHP 7.2, HHVM 3):
|
||||
* Operating system and version (e.g. Ubuntu 16.04, Windows 10):
|
||||
* Link to your project:
|
||||
* ...
|
||||
* ...
|
43
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
43
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,43 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
|
||||
Describe your changes in detail.
|
||||
|
||||
## Motivation and context
|
||||
|
||||
Why is this change required? What problem does it solve?
|
||||
|
||||
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
|
||||
or `closes #num`, the issue will be automatically closed when the pull is accepted.)
|
||||
|
||||
## How has this been tested?
|
||||
|
||||
Please describe in detail how you tested your changes.
|
||||
|
||||
Include details of your testing environment, and the tests you ran to
|
||||
see how your change affects other areas of the code, etc.
|
||||
|
||||
## Screenshots (if appropriate)
|
||||
|
||||
## Types of changes
|
||||
|
||||
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
|
||||
## Checklist:
|
||||
|
||||
Go over all the following points, and put an `x` in all the boxes that apply.
|
||||
|
||||
Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our [continuous integration](http://www.phptherightway.com/#continuous-integration) server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/).
|
||||
|
||||
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
|
||||
- [ ] My pull request addresses exactly one patch/feature.
|
||||
- [ ] I have created a branch for this patch/feature.
|
||||
- [ ] Each individual commit in the pull request is meaningful.
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
|
||||
|
||||
If you're unsure about any of these, don't hesitate to ask. We're here to help!
|
5
.gitignore
vendored
Normal file
5
.gitignore
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
build
|
||||
composer.lock
|
||||
vendor
|
||||
phpcs.xml
|
||||
phpunit.xml
|
31
.scrutinizer.yml
Normal file
31
.scrutinizer.yml
Normal file
@ -0,0 +1,31 @@
|
||||
build:
|
||||
nodes:
|
||||
analysis:
|
||||
project_setup:
|
||||
override: true
|
||||
tests:
|
||||
override: [php-scrutinizer-run]
|
||||
|
||||
filter:
|
||||
excluded_paths: [tests/*]
|
||||
|
||||
checks:
|
||||
php:
|
||||
remove_extra_empty_lines: true
|
||||
remove_php_closing_tag: true
|
||||
remove_trailing_whitespace: true
|
||||
fix_use_statements:
|
||||
remove_unused: true
|
||||
preserve_multiple: false
|
||||
preserve_blanklines: true
|
||||
order_alphabetically: true
|
||||
fix_php_opening_tag: true
|
||||
fix_linefeed: true
|
||||
fix_line_ending: true
|
||||
fix_identation_4spaces: true
|
||||
fix_doc_comments: true
|
||||
|
||||
tools:
|
||||
external_code_coverage:
|
||||
timeout: 600
|
||||
runs: 3
|
1
.styleci.yml
Normal file
1
.styleci.yml
Normal file
@ -0,0 +1 @@
|
||||
preset: psr2
|
38
.travis.yml
Normal file
38
.travis.yml
Normal file
@ -0,0 +1,38 @@
|
||||
dist: trusty
|
||||
language: php
|
||||
|
||||
php:
|
||||
- 5.6
|
||||
- 7.0
|
||||
- 7.1
|
||||
- 7.2
|
||||
- 7.3
|
||||
- hhvm
|
||||
|
||||
# This triggers builds to run on the new TravisCI infrastructure.
|
||||
# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
|
||||
sudo: false
|
||||
|
||||
## Cache composer
|
||||
cache:
|
||||
directories:
|
||||
- $HOME/.composer/cache
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- php: 5.6
|
||||
env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
|
||||
|
||||
before_script:
|
||||
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
|
||||
|
||||
script:
|
||||
- vendor/bin/phpcs --standard=psr2 src/
|
||||
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
|
||||
|
||||
after_script:
|
||||
- |
|
||||
if [[ "$TRAVIS_PHP_VERSION" != 'hhvm' && "$TRAVIS_PHP_VERSION" != '7.0' ]]; then
|
||||
wget https://scrutinizer-ci.com/ocular.phar
|
||||
php ocular.phar code-coverage:upload --format=php-clover coverage.clover
|
||||
fi
|
8
CHANGELOG.md
Normal file
8
CHANGELOG.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to `microdata-parser` will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com)
|
||||
|
||||
## 0.1.0 - 2018-11-11
|
||||
Initial public release
|
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
@ -0,0 +1,21 @@
|
||||
# The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Yusuf Kandemir <yusuf.kandemir@outlook.com.tr>
|
||||
|
||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
> of this software and associated documentation files (the "Software"), to deal
|
||||
> in the Software without restriction, including without limitation the rights
|
||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
> copies of the Software, and to permit persons to whom the Software is
|
||||
> furnished to do so, subject to the following conditions:
|
||||
>
|
||||
> The above copyright notice and this permission notice shall be included in
|
||||
> all copies or substantial portions of the Software.
|
||||
>
|
||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
> THE SOFTWARE.
|
65
README.md
Normal file
65
README.md
Normal file
@ -0,0 +1,65 @@
|
||||
# microdata-parser
|
||||
|
||||
[![Latest Version on Packagist][ico-version]][link-packagist]
|
||||
[![Software License][ico-license]](LICENSE.md)
|
||||
[![Build Status][ico-travis]][link-travis]
|
||||
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
|
||||
[![Quality Score][ico-code-quality]][link-code-quality]
|
||||
[![Total Downloads][ico-downloads]][link-downloads]
|
||||
|
||||
This package aims to implement [W3C Microdata Specification](https://www.w3.org/TR/microdata/).
|
||||
|
||||
**microdata-parser** extracts microdata from documents.
|
||||
|
||||
## Installation
|
||||
|
||||
Via Composer
|
||||
|
||||
``` bash
|
||||
$ composer require yusufkandemir/microdata-parser
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
``` php
|
||||
$parser = new YusufKandemir\MicrodataParser();
|
||||
$microdata = $parser->extractMicrodata();
|
||||
```
|
||||
|
||||
## Change log
|
||||
|
||||
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
|
||||
|
||||
## Testing
|
||||
|
||||
``` bash
|
||||
$ composer test
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
|
||||
|
||||
## Credits
|
||||
|
||||
- [Yusuf Kandemir][link-author]
|
||||
- [All Contributors][link-contributors]
|
||||
|
||||
## License
|
||||
|
||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||
|
||||
[ico-version]: https://img.shields.io/packagist/v/yusufkandemir/microdata-parser.svg?style=flat-square
|
||||
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
||||
[ico-travis]: https://img.shields.io/travis/yusufkandemir/microdata-parser/master.svg?style=flat-square
|
||||
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/yusufkandemir/microdata-parser.svg?style=flat-square
|
||||
[ico-code-quality]: https://img.shields.io/scrutinizer/g/yusufkandemir/microdata-parser.svg?style=flat-square
|
||||
[ico-downloads]: https://img.shields.io/packagist/dt/yusufkandemir/microdata-parser.svg?style=flat-square
|
||||
|
||||
[link-packagist]: https://packagist.org/packages/yusufkandemir/microdata-parser
|
||||
[link-travis]: https://travis-ci.org/yusufkandemir/microdata-parser
|
||||
[link-scrutinizer]: https://scrutinizer-ci.com/g/yusufkandemir/microdata-parser/code-structure
|
||||
[link-code-quality]: https://scrutinizer-ci.com/g/yusufkandemir/microdata-parser
|
||||
[link-downloads]: https://packagist.org/packages/yusufkandemir/microdata-parser
|
||||
[link-author]: https://github.com/yusufkandemir
|
||||
[link-contributors]: ../../contributors
|
52
composer.json
Normal file
52
composer.json
Normal file
@ -0,0 +1,52 @@
|
||||
{
|
||||
"name": "yusufkandemir/microdata-parser",
|
||||
"type": "library",
|
||||
"description": "Parse microdata from document with ease. PHP Implementation of W3C Microdata Specification.",
|
||||
"keywords": [
|
||||
"yusufkandemir",
|
||||
"microdata-parser",
|
||||
"Microdata",
|
||||
"HTML Microdata",
|
||||
"PHP Microdata Parser"
|
||||
],
|
||||
"homepage": "https://github.com/yusufkandemir/microdata-parser",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Yusuf Kandemir",
|
||||
"email": "yusuf.kandemir@outlook.com.tr",
|
||||
"homepage": "https://github.com/yusufkandemir",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php" : "~7.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit" : ">=5.4.3",
|
||||
"squizlabs/php_codesniffer": "^3.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"YusufKandemir\\MicrodataParser\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"YusufKandemir\\MicrodataParser\\Tests\\": "tests"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"test": "phpunit",
|
||||
"check-style": "phpcs src tests",
|
||||
"fix-style": "phpcbf src tests"
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "1.0-dev"
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"sort-packages": true
|
||||
}
|
||||
}
|
14
phpcs.xml.dist
Normal file
14
phpcs.xml.dist
Normal file
@ -0,0 +1,14 @@
|
||||
<?xml version="1.0"?>
|
||||
<ruleset name="microdata-parser">
|
||||
<description>The coding standard of microdata-parser package</description>
|
||||
<arg value="p" />
|
||||
|
||||
<config name="ignore_warnings_on_exit" value="1" />
|
||||
<config name="ignore_errors_on_exit" value="1" />
|
||||
|
||||
<arg name="colors" />
|
||||
<arg value="s" />
|
||||
|
||||
<!-- Use the PSR2 Standard-->
|
||||
<rule ref="PSR2" />
|
||||
</ruleset>
|
25
phpunit.xml.dist
Normal file
25
phpunit.xml.dist
Normal file
@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit bootstrap="vendor/autoload.php"
|
||||
backupGlobals="false"
|
||||
backupStaticAttributes="false"
|
||||
colors="true"
|
||||
verbose="true"
|
||||
convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true"
|
||||
convertWarningsToExceptions="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="Test Suite">
|
||||
<directory>tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<filter>
|
||||
<whitelist>
|
||||
<directory suffix=".php">src/</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
<logging>
|
||||
<log type="coverage-html" target="build/coverage"/>
|
||||
</logging>
|
||||
</phpunit>
|
Loading…
Reference in New Issue
Block a user