Merge pull request #10 from michalsn/namespace

Change namespace
codeigniter4 · Dec 17, 2023 · 6b9699c · 6b9699c
2 parents 0844c4a + 3f85ca4
commit 6b9699c
Show file tree

Hide file tree

Showing 58 changed files with 306 additions and 172 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing to CodeIgniter4
+
+CodeIgniter is a community driven project and accepts contributions of
+code and documentation from the community.
+
+If you'd like to contribute, please read [Contributing to CodeIgniter](https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/README.md)
+in the [main repository](https://github.com/codeigniter4/CodeIgniter4).
+
+If you are going to contribute to this repository, please report bugs or send PRs
+to this repository instead of the main repository.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2023 Michal Sniatala
+Copyright (c) 2023 CodeIgniter Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -2,17 +2,17 @@
 
 Queues for the CodeIgniter 4 framework.
 
-[![PHPUnit](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpunit.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpunit.yml)
-[![PHPStan](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpstan.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/phpstan.yml)
-[![Deptrac](https://github.com/michalsn/codeigniter-queue/actions/workflows/deptrac.yml/badge.svg)](https://github.com/michalsn/codeigniter-queue/actions/workflows/deptrac.yml)
-[![Coverage Status](https://coveralls.io/repos/github/michalsn/codeigniter-queue/badge.svg?branch=develop)](https://coveralls.io/github/michalsn/codeigniter-queue?branch=develop)
+[![PHPUnit](https://github.com/codeigniter4/queue/actions/workflows/phpunit.yml/badge.svg)](https://github.com/codeigniter4/queue/actions/workflows/phpunit.yml)
+[![PHPStan](https://github.com/codeigniter4/queue/actions/workflows/phpstan.yml/badge.svg)](https://github.com/codeigniter4/queue/actions/workflows/phpstan.yml)
+[![Deptrac](https://github.com/codeigniter4/queue/actions/workflows/deptrac.yml/badge.svg)](https://github.com/codeigniter4/queue/actions/workflows/deptrac.yml)
+[![Coverage Status](https://coveralls.io/repos/github/codeigniter4/queue/badge.svg?branch=develop)](https://coveralls.io/github/codeigniter4/queue?branch=develop)
 
 ![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)
 ![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
 
 ## Installation
 
-    composer require michalsn/codeigniter-queue
+    composer require codeigniter4/queue
 
 Migrate your database:
 
@@ -58,4 +58,4 @@ Run the queue worker:
 
 ## Docs
 
-https://michalsn.github.io/codeigniter-queue/
+https://codeigniter4.github.io/queue/
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,26 @@
+# Security Policy
+
+The development team and community take all security issues seriously. **Please do not make public any uncovered flaws.**
+
+## Reporting a Vulnerability
+
+Thank you for improving the security of our code! Any assistance in removing security flaws will be acknowledged.
+
+**Please report security flaws by emailing the development team directly: [email protected]**.
+
+The lead maintainer will acknowledge your email within 48 hours, and will send a more detailed response within 48 hours indicating
+the next steps in handling your report. After the initial reply to your report, the security team will endeavor to keep you informed of the
+progress towards a fix and full announcement, and may ask for additional information or guidance.
+
+## Disclosure Policy
+
+When the security team receives a security bug report, they will assign it to a primary handler.
+This person will coordinate the fix and release process, involving the following steps:
+
+- Confirm the problem and determine the affected versions.
+- Audit code to find any potential similar problems.
+- Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved please submit a Pull Request.
diff --git a/composer.json b/composer.json
@@ -1,5 +1,5 @@
 {
-    "name": "michalsn/codeigniter-queue",
+    "name": "codeigniter4/queue",
     "description": "Queues for CodeIgniter 4 framework",
     "license": "MIT",
     "type": "library",
@@ -11,20 +11,20 @@
             "role": "Developer"
         }
     ],
-    "homepage": "https://github.com/michalsn/codeigniter-queue",
+    "homepage": "https://github.com/codeigniter4/queue",
     "require": {
         "php": "^8.1"
     },
     "require-dev": {
         "codeigniter4/devkit": "^1.0",
-        "codeigniter4/framework": "^4.4",
+        "codeigniter4/framework": "^4.3",
         "predis/predis": "^2.0"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {
         "psr-4": {
-            "Michalsn\\CodeIgniterQueue\\": "src"
+            "CodeIgniter\\Queue\\": "src"
         }
     },
     "autoload-dev": {

diff --git a/docs/assets/css/codeigniter.css b/docs/assets/css/codeigniter.css
@@ -0,0 +1,18 @@
+[data-md-color-scheme="codeigniter"] {
+    --md-primary-fg-color:        #dd4814;
+    --md-primary-fg-color--light: #ECB7B7;
+    --md-primary-fg-color--dark:  #90030C;
+
+    --md-default-bg-color: #fcfcfc;
+
+    --md-typeset-a-color: #e74c3c;
+    --md-accent-fg-color: #97310e;
+
+    --md-accent-fg-color--transparent: #ECB7B7;
+
+    --md-code-bg-color: #ffffff;
+
+    .md-typeset code {
+        border: 1px solid #e1e4e5;
+    }
+}
diff --git a/docs/assets/css/codeigniter_dark_mode.css b/docs/assets/css/codeigniter_dark_mode.css
@@ -0,0 +1,71 @@
+[data-md-color-scheme="slate"] {
+    --md-primary-fg-color: #b13a10;
+    --md-primary-fg-color--light: #8d7474;
+    --md-primary-fg-color--dark: #6d554d;
+
+    --md-default-bg-color: #1e2129;
+
+    --md-typeset-a-color: #ed6436;
+    --md-accent-fg-color: #f18a67;
+
+    --md-accent-fg-color--transparent: #625151;
+
+    --md-code-bg-color: #282b2d;
+
+    .hljs-title,
+    .hljs-title.class_,
+    .hljs-title.class_.inherited__,
+    .hljs-title.function_ {
+        color: #c9a69b;
+    }
+
+    .hljs-meta .hljs-string,
+    .hljs-regexp,
+    .hljs-string {
+        color: #a3b4c7;
+    }
+
+    .hljs-attr,
+    .hljs-attribute,
+    .hljs-literal,
+    .hljs-meta,
+    .hljs-number,
+    .hljs-operator,
+    .hljs-selector-attr,
+    .hljs-selector-class,
+    .hljs-selector-id,
+    .hljs-variable {
+        color: #c1b79f;
+    }
+
+    .hljs-doctag,
+    .hljs-keyword,
+    .hljs-meta .hljs-keyword,
+    .hljs-template-tag,
+    .hljs-template-variable,
+    .hljs-type,
+    .hljs-variable.language_ {
+        color: #c97100;
+    }
+
+    .hljs-subst {
+        color: #ddba52
+    }
+
+    .md-typeset code {
+        border: 1px solid #3f4547;
+    }
+
+    .md-typeset .admonition.note,
+    .md-typeset details.note {
+        border-color: #2c5293;
+    }
+
+    .md-typeset .note > .admonition-title:before,
+    .md-typeset .note > summary:before {
+        background-color: #2c5293;
+        -webkit-mask-image: var(--md-admonition-icon--note);
+        mask-image: var(--md-admonition-icon--note);
+    }
+
+}
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/github-dark-dimmed.css b/docs/assets/github-dark-dimmed.css
diff --git a/docs/assets/hljs.js b/docs/assets/hljs.js
diff --git a/docs/assets/js/hljs.js b/docs/assets/js/hljs.js
@@ -0,0 +1,3 @@
+document.addEventListener('DOMContentLoaded', (event) => {
+    hljs.highlightAll();
+});
diff --git a/docs/basic_usage.md → docs/basic-usage.md b/docs/basic_usage.md → docs/basic-usage.md
@@ -47,8 +47,8 @@ One of the most popular tasks delegated to a queue is sending email messages. Th
 namespace App\Jobs;
 
 use Exception;
-use Michalsn\CodeIgniterQueue\BaseJob;
-use Michalsn\CodeIgniterQueue\Interfaces\JobInterface;
+use CodeIgniter\Queue\BaseJob;
+use CodeIgniter\Queue\Interfaces\JobInterface;
 
 class Email extends BaseJob implements JobInterface
 {

diff --git a/docs/commands.md b/docs/commands.md
@@ -6,15 +6,15 @@ Here are all the commands you can use with the Queue library.
 
 Available options:
 
-- [queue:publish](#queuePublish)
-- [queue:job](#queueJob)
-- [queue:work](#queueWork)
-- [queue:stop](#queueStop)
-- [queue:clear](#queueClear)
-- [queue:failed](#queueFailed)
-- [queue:retry](#queueRetry)
-- [queue:forget](#queueForget)
-- [queue:flush](#queueFlush)
+- [queue:publish](#queuepublish)
+- [queue:job](#queuejob)
+- [queue:work](#queuework)
+- [queue:stop](#queuestop)
+- [queue:clear](#queueclear)
+- [queue:failed](#queuefailed)
+- [queue:retry](#queueretry)
+- [queue:forget](#queueforget)
+- [queue:flush](#queueflush)
 
 
 ### queue:publish

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -12,16 +12,16 @@ We will get our copy ready for modifications.
 
 Available options:
 
-- [$defaultHandler](#defaultHandler)
+- [$defaultHandler](#defaulthandler)
 - [$handlers](#handlers)
 - [$database](#database)
 - [$redis](#redis)
 - [$predis](#predis)
-- [$keepDoneJobs](#keepDoneJobs)
-- [$keepFailedJobs](#keepFailedJobs)
-- [$queueDefaultPriority](#queueDefaultPriority)
-- [$queuePriorities](#queuePriorities)
-- [$jobHandlers](#jobHandlers)
+- [$keepDoneJobs](#keepdonejobs)
+- [$keepFailedJobs](#keepfailedjobs)
+- [$queueDefaultPriority](#queuedefaultpriority)
+- [$queuePriorities](#queuepriorities)
+- [$jobHandlers](#jobhandlers)
 
 ### $defaultHandler
 

diff --git a/docs/index.md b/docs/index.md
@@ -14,14 +14,14 @@ Listen for queued jobs.
 
 ### Requirements
 
-![PHP](https://img.shields.io/badge/PHP-%5E8.1-blue)
-![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-blue)
+![PHP](https://img.shields.io/badge/PHP-%5E8.1-red)
+![CodeIgniter](https://img.shields.io/badge/CodeIgniter-%5E4.3-red)
 
 ### Table of Contents
 
 * [Installation](installation.md)
 * [Configuration](configuration.md)
-* [Basic usage](basic_usage.md)
-* [Running queues](running_queues.md)
+* [Basic usage](basic-usage)
+* [Running queues](running-queues)
 * [Commands](commands.md)
 * [Troubleshooting](troubleshooting.md)
diff --git a/docs/installation.md b/docs/installation.md
@@ -8,13 +8,13 @@
 
 The only thing you have to do is to run this command, and you're ready to go.
 
-    composer require michalsn/codeigniter-queue
+    composer require codeigniter4/queue
 
 ## Manual Installation
 
 In the example below we will assume, that files from this project will be located in `app/ThirdParty/queue` directory.
 
-Download this project and then enable it by editing the `app/Config/Autoload.php` file and adding the `Michalsn\CodeIgniterQueue` namespace to the `$psr4` array, like in the below example:
+Download this project and then enable it by editing the `app/Config/Autoload.php` file and adding the `CodeIgniter\Queue` namespace to the `$psr4` array, like in the below example:
 
 ```php
 <?php
@@ -24,7 +24,7 @@ Download this project and then enable it by editing the `app/Config/Autoload.php
 public $psr4 = [
     APP_NAMESPACE => APPPATH, // For custom app namespace
     'Config'      => APPPATH . 'Config',
-    'Michalsn\CodeIgniterQueue' => APPPATH . 'ThirdParty/queue/src',
+    'CodeIgniter\Queue' => APPPATH . 'ThirdParty/queue/src',
 ];
 
 // ...

diff --git a/docs/running_queues.md → docs/running-queues.md b/docs/running_queues.md → docs/running-queues.md