From f2ca9d73c9dafd0504a8b7a3cf68113324f66616 Mon Sep 17 00:00:00 2001 From: Roberto Butti Date: Thu, 4 Apr 2024 23:44:41 +0200 Subject: [PATCH] First Commit --- .github/workflows/main.yml | 43 +++++++++++++++++++++++++ .gitignore | 8 +++++ CHANGELOG.md | 7 ++++ CONTRIBUTING.md | 55 ++++++++++++++++++++++++++++++++ LICENSE.md | 21 ++++++++++++ composer.json | 56 ++++++++++++++++++++++++++++++++ config/config.php | 8 +++++ src/Fusion.php | 8 +++++ src/FusionFacade.php | 21 ++++++++++++ src/FusionServiceProvider.php | 60 +++++++++++++++++++++++++++++++++++ 10 files changed, 287 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 composer.json create mode 100644 config/config.php create mode 100644 src/Fusion.php create mode 100644 src/FusionFacade.php create mode 100644 src/FusionServiceProvider.php diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..4524a89 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,43 @@ +name: run-tests + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + test: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: [ubuntu-latest, windows-latest] + php: [8.3, 8.2] + laravel: [11.*] + stability: [prefer-lowest, prefer-stable] + include: + - laravel: 11.* + testbench: ^9 + + name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo + coverage: none + + - name: Setup problem matchers + run: | + echo "::add-matcher::${{ runner.tool_cache }}/php.json" + echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + - name: Install dependencies + run: | + composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update + composer update --${{ matrix.stability }} --prefer-dist --no-interaction diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..269432d --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/.idea/ +/vendor/ +/tests/database/database.sqlite +.phpunit.result.cache +composer.lock +/tests/cache/ +.vscode/settings.json +.phpunit.cache \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f4d344a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `fusion` will be documented in this file + +## 0.0.1 - 2024-04-XX + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **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](https://semver.org/). Randomly breaking public APIs is not an option. + +- **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](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..264f1f3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Roberto B + +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. \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..a1115d8 --- /dev/null +++ b/composer.json @@ -0,0 +1,56 @@ +{ + "name": "hi-folks/fusion", + "description": "Empowering Markdown and Frontmatter for Structured, Database-free Content Management", + "keywords": [ + "hi-folks", + "fusion", + "markdown", + "eloquent", + "laravel" + ], + "homepage": "https://github.com/hi-folks/fusion", + "license": "MIT", + "type": "library", + "authors": [ + { + "name": "Roberto B", + "email": "roberto.butti@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": "^8.2|^8.3", + "illuminate/support": "^11.0" + }, + "require-dev": { + "orchestra/testbench": "^9.0" + }, + "autoload": { + "psr-4": { + "HiFolks\\Fusion\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "HiFolks\\Fusion\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage" + + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "HiFolks\\Fusion\\FusionServiceProvider" + ], + "aliases": { + "Fusion": "HiFolks\\Fusion\\FusionFacade" + } + } + } +} diff --git a/config/config.php b/config/config.php new file mode 100644 index 0000000..48d0ee9 --- /dev/null +++ b/config/config.php @@ -0,0 +1,8 @@ +loadTranslationsFrom(__DIR__.'/../resources/lang', 'fusion'); + // $this->loadViewsFrom(__DIR__.'/../resources/views', 'fusion'); + // $this->loadMigrationsFrom(__DIR__.'/../database/migrations'); + // $this->loadRoutesFrom(__DIR__.'/routes.php'); + + if ($this->app->runningInConsole()) { + $this->publishes([ + __DIR__.'/../config/config.php' => config_path('fusion.php'), + ], 'config'); + + // Publishing the views. + /*$this->publishes([ + __DIR__.'/../resources/views' => resource_path('views/vendor/fusion'), + ], 'views');*/ + + // Publishing assets. + /*$this->publishes([ + __DIR__.'/../resources/assets' => public_path('vendor/fusion'), + ], 'assets');*/ + + // Publishing the translation files. + /*$this->publishes([ + __DIR__.'/../resources/lang' => resource_path('lang/vendor/fusion'), + ], 'lang');*/ + + // Registering package commands. + // $this->commands([]); + } + } + + /** + * Register the application services. + */ + public function register() + { + // Automatically apply the package configuration + $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'fusion'); + + // Register the main class to use with the facade + $this->app->singleton('fusion', function () { + return new Fusion; + }); + } +}