diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml new file mode 100644 index 0000000..5008b48 --- /dev/null +++ b/.github/workflows/pull_request.yml @@ -0,0 +1,48 @@ +name: "Pull Request Checks" + +on: [pull_request] + +jobs: + lint: + name: Run Linter + runs-on: ubuntu-latest + + steps: + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + + - name: Checkout repository + uses: actions/checkout@v3 + with: + fetch-depth: 2 + + - run: git checkout HEAD^2 + + - name: Install dependencies + run: composer update --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-dist + + - run: composer lint + + tests: + name: Run Unit Tests + runs-on: ubuntu-latest + + steps: + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '8.0' + + - name: Checkout repository + uses: actions/checkout@v3 + with: + fetch-depth: 2 + + - run: git checkout HEAD^2 + + - name: Install dependencies + run: composer update --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-dist + + - run: composer test \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b9c8066 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +composer.lock +/vendor/ +/.idea/ +*.cache \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..adc8fec --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity, expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +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. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at team@appwrite.io. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f0afbdf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,101 @@ +# Contributing + +We would ❤️ for you to contribute to Utopia-php and help make it better! We want contributing to Utopia-php to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more. + +## How to Start? + +If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you! + +## Code of Conduct + +Help us keep Utopia-php open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). + +## Submit a Pull Request 🚀 + +Branch naming convention is as following + +`TYPE-ISSUE_ID-DESCRIPTION` + +example: + +``` +doc-548-submit-a-pull-request-section-to-contribution-guide +``` + +When `TYPE` can be: + +- **feat** - is a new feature +- **doc** - documentation only changes +- **cicd** - changes related to CI/CD system +- **fix** - a bug fix +- **refactor** - code change that neither fixes a bug nor adds a feature + +**All PRs must include a commit message with the changes description!** + +For the initial start, fork the project and use git clone command to download the repository to your computer. A standard procedure for working on an issue would be to: + +1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date. + +``` +$ git pull +``` + +2. Create new branch from `master` like: `doc-548-submit-a-pull-request-section-to-contribution-guide`
+ +``` +$ git checkout -b [name_of_your_new_branch] +``` + +3. Work - commit - repeat ( be sure to be in your branch ) + +4. Push changes to GitHub + +``` +$ git push origin [name_of_your_new_branch] +``` + +5. Submit your changes for review + If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. +6. Start a Pull Request + Now submit the pull request and click on `Create pull request`. +7. Get a code review approval/reject +8. After approval, merge your PR +9. GitHub will automatically delete the branch after the merge is done. (they can still be restored). + +## Introducing New Features + +We would 💖 you to contribute to Utopia-php, but we would also like to make sure Utopia-php is as great as possible and loyal to its vision and mission statement 🙏. + +For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request. + +This will allow the Utopia-php community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. + +This is also important for the Utopia-php lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc). + +## Other Ways to Help + +Pull requests are great, but there are many other areas where you can help Utopia-php. + +### Blogging & Speaking + +Blogging, speaking about, or creating tutorials about one of Utopia-php’s many features is great way to contribute and help our project grow. + +### Presenting at Meetups + +Presenting at meetups and conferences about your Utopia-php projects. Your unique challenges and successes in building things with Utopia-php can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help! + +### Sending Feedbacks & Reporting Bugs + +Sending feedback is a great way for us to understand your different use cases of Utopia-php better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA). + +### Submitting New Ideas + +If you think Utopia-php could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature. + +### Improving Documentation + +Submitting documentation updates, enhancements, designs, or bug fixes. Spelling or grammar fixes will be very much appreciated. + +### Helping Someone + +Searching for Utopia-php, GitHub or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Utopia-php's repo! \ No newline at end of file diff --git a/README.md b/README.md index 0bb7505..fb59011 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# dsn -Lite & fast micro PHP library for handling Data Source Names (DSNs) that is **easy to use**. +# Utopia DSN + +![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/dsn.svg) +[![Discord](https://img.shields.io/discord/564160730845151244)](https://appwrite.io/discord) + +Utopia DSN library is simple and lite library for parsing and managing Data Source Names or DSNs. This library aims to be as simple and easy to learn and use as possible. This library is maintained by the [Appwrite team](https://appwrite.io). + +Although the library was built for the [Utopia Framework](https://github.com/utopia-php/framework) project, it is completely independent, **dependency-free** and can be used with any other PHP project or framework. + +## Getting Started + +Install using composer: +```bash +composer require utopia-php/dsn +``` + +```php +getScheme(); // mariadb +$user = $dsn->getUser(); // user +$password = $dsn->getPassword(); // password +$host = $dsn->getHost(); // localhost +$port = $dsn->getPort(); // 3306 +$path = $dsn->getPath(); // database +$query = $dsn->getQuery(); // charset=utf8&timezone=UTC +$charset = $dsn->getParam('charset') // utf8 +$timezone = $dsn->getParam('timezone') // UTC +``` + +## Tests + +To run all unit tests, use the following Docker command: + +```bash +docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) php:8.0-cli-alpine sh -c "vendor/bin/phpunit --configuration phpunit.xml tests" +``` + +To run the linter, use the following composer command: + +```bash +composer lint + +# Or if you do not have composer installed +docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) composer sh -c "composer lint" +``` + +To fix the errors raised by the linter, use the following command: + +```php +composer format + +# Or if you do not have composer installed +docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) composer sh -c "composer format" +``` + +## System Requirements + +Utopia DSN requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible. + +## Copyright and license + +The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php) \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..8db0b4d --- /dev/null +++ b/composer.json @@ -0,0 +1,25 @@ +{ + "name": "utopia-php/dsn", + "description": "A simple library for parsing and managing Data Source Names ( DSNs )", + "type": "library", + "keywords": ["php","framework", "upf", "utopia", "dsn"], + "license": "MIT", + "minimum-stability": "stable", + "autoload": { + "psr-4": {"Utopia\\DSN\\": "src/DSN"} + }, + "scripts": { + "lint": "./vendor/bin/pint --test", + "format": "./vendor/bin/pint", + "test": "./vendor/bin/phpunit --configuration phpunit.xml tests" + }, + "require": { + "php": ">=8.0" + }, + "require-dev": { + "phpunit/phpunit": "^9.3", + "vimeo/psalm": "4.0.1", + "laravel/pint": "1.2.*", + "squizlabs/php_codesniffer": "^3.6" + } +} \ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..10d408c --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,16 @@ + + + + ./tests/ + + + \ No newline at end of file diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..b5d5891 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,15 @@ + + + + + + + + + \ No newline at end of file diff --git a/src/DSN/DSN.php b/src/DSN/DSN.php new file mode 100644 index 0000000..fb5d732 --- /dev/null +++ b/src/DSN/DSN.php @@ -0,0 +1,160 @@ +scheme = $parts['scheme'] ?? null; + $this->user = $parts['user'] ?? null; + $this->password = $parts['pass'] ?? null; + $this->host = $parts['host'] ?? null; + $this->port = $parts['port'] ?? null; + $this->path = $parts['path'] ?? null; + $this->query = $parts['query'] ?? null; + } + + /** + * Return the scheme. + * + * @return string + */ + public function getScheme(): string + { + return $this->scheme; + } + + /** + * Return the user. + * + * @return ?string + */ + public function getUser(): ?string + { + return $this->user; + } + + /** + * Return the password. + * + * @return ?string + */ + public function getPassword(): ?string + { + return $this->password; + } + + /** + * Return the host + * + * @return string + */ + public function getHost(): string + { + return $this->host; + } + + /** + * Return the port + * + * @return ?string + */ + public function getPort(): ?string + { + return $this->port; + } + + /** + * Return the path + * + * @return ?string + */ + public function getPath(): ?string + { + return ltrim($this->path, '/'); + } + + /** + * Return the query string + * + * @return ?string + */ + public function getQuery(): ?string + { + return $this->query; + } + + /** + * Return a query parameter by its key + * + * @return string + */ + public function getParam(string $key, string $default = ''): string + { + if (isset($this->params[$key])) { + return $this->params[$key]; + } + + if (! $this->query) { + return $default; + } + + parse_str($this->query, $this->params); + + return $this->params[$key] ?? $default; + } +} diff --git a/tests/DSN/DSNTest.php b/tests/DSN/DSNTest.php new file mode 100644 index 0000000..be6ff0d --- /dev/null +++ b/tests/DSN/DSNTest.php @@ -0,0 +1,123 @@ +assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertEquals('password', $dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertEquals('3306', $dsn->getPort()); + $this->assertEquals('database', $dsn->getPath()); + $this->assertEquals('charset=utf8&timezone=UTC', $dsn->getQuery()); + $this->assertEquals('utf8', $dsn->getParam('charset')); + $this->assertEquals('UTC', $dsn->getParam('timezone')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + + $dsn = new DSN('mariadb://user@localhost:3306/database?charset=utf8&timezone=UTC'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertNull($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertEquals('3306', $dsn->getPort()); + $this->assertEquals('database', $dsn->getPath()); + $this->assertEquals('charset=utf8&timezone=UTC', $dsn->getQuery()); + $this->assertEquals('utf8', $dsn->getParam('charset')); + $this->assertEquals('UTC', $dsn->getParam('timezone')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + + $dsn = new DSN('mariadb://user@localhost/database?charset=utf8&timezone=UTC'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertNull($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertNull($dsn->getPort()); + $this->assertEquals('database', $dsn->getPath()); + $this->assertEquals('charset=utf8&timezone=UTC', $dsn->getQuery()); + $this->assertEquals('utf8', $dsn->getParam('charset')); + $this->assertEquals('UTC', $dsn->getParam('timezone')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + + $dsn = new DSN('mariadb://user@localhost?charset=utf8&timezone=UTC'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertNull($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertNull($dsn->getPort()); + $this->assertEmpty($dsn->getPath()); + $this->assertEquals('charset=utf8&timezone=UTC', $dsn->getQuery()); + $this->assertEquals('utf8', $dsn->getParam('charset')); + $this->assertEquals('UTC', $dsn->getParam('timezone')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + + $dsn = new DSN('mariadb://user@localhost'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertNull($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertNull($dsn->getPort()); + $this->assertEmpty($dsn->getPath()); + $this->assertNull($dsn->getQuery()); + + $dsn = new DSN('mariadb://user:@localhost'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertEmpty($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertNull($dsn->getPort()); + $this->assertEmpty($dsn->getPath()); + $this->assertNull($dsn->getQuery()); + + $dsn = new DSN('mariadb://localhost'); + $this->assertEquals('mariadb', $dsn->getScheme()); + $this->assertEmpty($dsn->getUser()); + $this->assertEmpty($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertEmpty($dsn->getPort()); + $this->assertEmpty($dsn->getPath()); + $this->assertEmpty($dsn->getQuery()); + + $dsn = new DSN('mysql://localhost:3306'); + $this->assertEquals('mysql', $dsn->getScheme()); + $this->assertEmpty($dsn->getUser()); + $this->assertEmpty($dsn->getPassword()); + $this->assertEquals('localhost', $dsn->getHost()); + $this->assertEquals(3306, $dsn->getPort()); + $this->assertEmpty($dsn->getPath()); + $this->assertEmpty($dsn->getQuery()); + + $dsn = new DSN('s3://user:secret@host:3306/bucket?region=us-east-1'); + $this->assertEquals('s3', $dsn->getScheme()); + $this->assertEquals('user', $dsn->getUser()); + $this->assertEquals('secret', $dsn->getPassword()); + $this->assertEquals('host', $dsn->getHost()); + $this->assertEquals(3306, $dsn->getPort()); + $this->assertEquals('bucket', $dsn->getPath()); + $this->assertEquals('region=us-east-1', $dsn->getQuery()); + $this->assertEquals('us-east-1', $dsn->getParam('region')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + } + + public function testGetParam(): void + { + $dsn = new DSN('mariadb://user:password@localhost:3306/database?charset=utf8&timezone=UTC'); + $this->assertEquals('utf8', $dsn->getParam('charset')); + $this->assertEquals('UTC', $dsn->getParam('timezone')); + $this->assertEmpty($dsn->getParam('doesNotExist')); + $this->assertEquals('us-east-1', $dsn->getParam('region', 'us-east-1')); + $this->assertEquals('us-east-2', $dsn->getParam('region', 'us-east-2')); + } + + public function testFail(): void + { + $this->expectException(\InvalidArgumentException::class); + new DSN('mariadb://'); + } +}