fixes to support composer / packagist

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, 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 webmaster@thetempusproject.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contribution Guidelines for Hermes
+
+Contributing to Hermes is completely voluntary and should follow all of the guidelines listed here in order to ensure the highest probability of acceptance. It is highly recommended to use a php linter to automate more of this process. The project is maintained on github and all contributions need to be submitted via pull request to their specific repository under the `dev` branch. In order to contribute, simply follow the instructions for [creating a pull request](#creating-a-pull-request) below.
+
+## Pull Request Requirements
+
+- All revisions must follow TTP naming conventions (see [Naming Conventions](#naming-conventions) Section)
+- Include a clear and concise explanation of the features or changes included in your revision listed by file.
+- All code must follow [PSR 2](http://www.php-fig.org/psr/psr-2/) standards
+- prefer the use of [] for arrays over array()
+- All functions must be documented with the exception of controller methods (see [Documentation](#documentation) Section)
+- Controller methods may be doc-blocked when necessary for clarity (see [Documentation](#documentation) Section)
+- All new Classes must include a class level doc-block (see [Documentation](#documentation) Section)
+- Any new dependencies will have a longer validation process and should be accompanied by the required information (see [Dependencies](#dependencies) Section)
+
+## Naming Conventions
+
+- File names are to be lower case
+- All class names must be upper case
+- Any data being stored as a file must be saved in the `app/` directory, preferably the `app/config/` directory.
+- Controllers must have a constructor and destructor incorporating the constructor and destructor in the Resources Controller
+- (This will be an interface requirement soon)
+- Views must be named using underscores for separation and must be prefixed with view_
+
+## Dependencies
+
+Whenever a dependency is updated or added, pull requests must include a section that answers the following questions.
+- Why is this dependency required
+- Could this be reasonably accomplished within the app by implementing new features in a later version? explain.
+- What is the latest stable version that can be used
+- What features are absolutely necessary for your feature or modification to work
+
+## Documentation
+
+### Classes
+
+New classes must be prefaced with a doc-block following this style:
+```
+/**
+ * controllers/admin.php
+ *
+ * This is the admin controller.
+ *
+ * @version 3.0
+ * @author  Joey Kimsey <Joey@thetempusproject.com>
+ * @link    https://TheTempusProject.com/Hermes
+ * @license https://opensource.org/licenses/MIT [MIT LICENSE]
+ */
+```
+
+From top to bottom:
+- Filename on the second line
+- A description for the file
+- The TTP version this file was built for
+`@version 1.0`
+- The Authors name or alias and email
+`@author  first last <email@link.com>`
+- A copy of the MIT license
+`@license https://opensource.org/licenses/MIT [MIT LICENSE]`
+- May include a link for more information
+`@link    http://link.com`
+
+### Functions
+
+Functions must be prefaced with a doc-block following this style:
+```
+/**
+ * Intended as a self-destruct session. If the specified session does not
+ * exist, it is created. If the specified session does exist, it will be
+ * destroyed and returned.
+ *
+ * @param string $name   - Session name to be created or checked
+ * @param string $string - The string to be used if session needs to be
+ *                         created. (optional)
+ *
+ * @return bool|string   - Returns bool if creating, and a string if the
+ *                         check is successful.
+ */
+```
+
+From top to bottom:
+- There must be a description of the functions intended usage on the second line
+- All parameters should be documented like this
+`@param [type] $name - description`
+- Any function with a return statement must also be documented as such
+`@return [type] - description`
+
+## Creating a Pull Request
+This is a simple explanation of how to create a pull request for changes to Hermes. You can find a detailed walk-through on how to [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on github.
+
+1. First ensure you have followed all the contributing guidelines
+2. Squash your merge into a single revision. This will make it easier to view the changes as a whole.
+3. You can submit a pull request [here](https://github.com/TheTempusProject/Hermes/compare)
+4. Please submit all pull requests to the dev branch or they will be ignored.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joey Kimsey
+
+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.

bin/autoload.php

@@ -9,7 +9,7 @@
  * @link    https://TheTempusProject.com/TempusDebugger
  * @license https://opensource.org/licenses/MIT [MIT LICENSE]
  */
-namespace TheTempusProject\Canary;
+namespace TheTempusProject\Hermes;
 
 use TheTempusProject\Hermes\Classes\Autoloader;
 

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "thetempusproject/hermes",
+    "type": "library",
+    "description": "Php functions that aid in routing and redirecting; requests and responses.",
+    "license": "MIT",
+    "minimum-stability": "dev",
+    "keywords":
+    [
+        "php",
+        "tools",
+        "routing",
+        "thetempusproject"
+    ],
+    "homepage": "https://git.thetempusproject.com/the-tempus-project/hermes",
+    "authors":
+    [
+        {
+            "name": "Joey Kimsey",
+            "email": "Joey@thetempusproject.com",
+            "homepage": "https://JoeyKimsey.com",
+            "role": "Lead Developer"
+        }
+    ],
+    "require":
+    {
+        "php": ">=8.1.0"
+    },
+    "autoload":
+    {
+        "classmap":
+        [
+            "classes",
+            "functions"
+        ],
+        "files":
+        [
+            "config/constants.php"
+        ]
+    }
+}

composer.lock

@@ -0,0 +1,20 @@
+{
+    "_readme": [
+        "This file locks the dependencies of your project to a known state",
+        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
+        "This file is @generated automatically"
+    ],
+    "content-hash": "d82682b62a8e3d58c3b380eee6f344ec",
+    "packages": [],
+    "packages-dev": [],
+    "aliases": [],
+    "minimum-stability": "dev",
+    "stability-flags": [],
+    "prefer-stable": false,
+    "prefer-lowest": false,
+    "platform": {
+        "php": ">=8.1.0"
+    },
+    "platform-dev": [],
+    "plugin-api-version": "2.3.0"
+}

config/constants.php

@@ -14,4 +14,6 @@ if (!defined('HERMES_REDIRECTS_ENABLED')) {
     define('HERMES_REDIRECTS_ENABLED', true);
 }
 # Tell the app all constants have been loaded.
-define( 'HERMES_CONSTANTS_LOADED', true );
+if ( ! defined('HERMES_CONSTANTS_LOADED' ) ) {
+    define( 'HERMES_CONSTANTS_LOADED', true );
+}

vendor/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore