Merge pull request #8 from datamweb/develop

1.x.x Ready code

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,112 @@
+name: Bug report
+description: Create a report to help us improve CodeIgniter DEA Rule
+title: "Bug: "
+labels: ['bug']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+
+        Before you begin, **please ensure that there are no existing issues,
+        whether still open or closed, related to your report**.
+        If there is, your report will be closed promptly.
+
+        ---
+
+  - type: input
+    id: php-version
+    attributes:
+      label: PHP Version
+      description: |
+        e.g. 8.2.6
+    validations:
+      required: true
+
+  - type: input
+    id: codeigniter-version
+    attributes:
+      label: CodeIgniter4 Version
+      description: |
+        e.g. 4.4.3
+    validations:
+      required: true
+
+  - type: input
+    id: dea-rule-version
+    attributes:
+      label: CodeIgniter DEA Rule Version
+      description: |
+        e.g. 1.0.0-beta.1
+        If you are not using the [latest version](https://github.com/datamweb/codeigniter-dea-rule/releases), please
+        check to see if the problem occurs with the latest version.
+    validations:
+      required: true
+
+  - type: dropdown
+    id: operating-systems
+    attributes:
+      label: Which operating systems have you tested for this bug?
+      description: You may select more than one.
+      multiple: true
+      options:
+        - macOS
+        - Windows
+        - Linux
+    validations:
+      required: true
+
+  - type: dropdown
+    id: server
+    attributes:
+      label: Which server did you use?
+      options:
+        - apache
+        - cli
+        - cli-server (PHP built-in webserver)
+        - cgi-fcgi
+        - fpm-fcgi
+        - phpdbg
+    validations:
+      required: true
+
+  - type: input
+    id: database
+    attributes:
+      label: Database
+      description: e.g. MySQL 5.6, MariaDB 10.2, PostgreSQL 9.6
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Output
+      description: What do you expect to happen instead of this filed bug?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/datamweb/codeigniter-dea-rule/discussions
+    about: Please ask your support questions in the Discussions. Thanks!
+
+  - name: CodeIgniter Slack channel
+    url: https://join.slack.com/t/codeigniterchat/shared_invite/zt-244xrrslc-l_I69AJSi5y2a2RVN~xIdQ
+    about: Engage with other members of the community in our Slack channel.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,11 @@
+---
+name: Feature request
+about: How to submit a feature request
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please submit feature requests to [Discussions](https://github.com/datamweb/codeigniter-dea-rule/discussions/categories/ideas).
+We use GitHub Issues to track bugs and planned work.

.github/ISSUE_TEMPLATE/planned-work.md

@@ -0,0 +1,10 @@
+---
+name: Planned work
+about: Approved work planning
+title: 'Dev: '
+labels: dev
+assignees: ''
+
+---
+
+Repo maintainers will create "issues" for planned work, so it can be tracked.

.github/dependabot.yml

@@ -0,0 +1,32 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "08:30"
+    timezone: "Asia/Tehran"
+  open-pull-requests-limit: 5
+  target-branch: "develop"
+  reviewers:
+   - "datamweb"
+  assignees:
+  - "datamweb"
+  labels:
+   - "dependa bot"
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "08:30"
+    timezone: "Asia/Tehran"
+  open-pull-requests-limit: 5
+  target-branch: "develop"
+  reviewers:
+   - "datamweb"
+  assignees:
+  - "datamweb"
+  labels:
+   - "dependa bot"
+

.github/release.yml

@@ -0,0 +1,26 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+  categories:
+    - title: Breaking Changes
+      labels:
+        - 'breaking change'
+    - title: Fixed Bugs
+      labels:
+        - bug
+    - title: New Features
+      labels:
+        - 'new feature'
+    - title: Enhancements
+      labels:
+        - enhancement
+    - title: Translations
+      labels:
+        - lang
+    - title: Refactoring
+      labels:
+        - refactor
+    - title: Others (Only for checking. Remove this category)
+      labels:
+        - "*"

.github/workflows/deptrac.yml

@@ -0,0 +1,72 @@
+name: Deptrac
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - 'depfile.yaml'
+      - '.github/workflows/deptrac.yml'
+  push:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - 'depfile.yaml'
+      - '.github/workflows/deptrac.yml'
+
+jobs:
+  build:
+    name: Dependency Tracing
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: phive
+          extensions: intl, json, mbstring, xml
+          coverage: none
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Create Deptrac cache directory
+        run: mkdir -p build/
+
+      - name: Cache Deptrac results
+        uses: actions/cache@v3
+        with:
+          path: build
+          key: ${{ runner.os }}-deptrac-${{ github.sha }}
+          restore-keys: ${{ runner.os }}-deptrac-
+
+      - name: Install dependencies
+        run: |
+          if [ -f composer.lock ]; then
+            composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          else
+            composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          fi
+
+      - name: Trace dependencies
+        run: |
+          sudo phive --no-progress install --global --trust-gpg-keys B8F640134AB1782E,A98E898BB53EB748 qossmic/deptrac
+          deptrac analyze --cache-file=build/deptrac.cache

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: docs
+on:
+  push:
+    branches:
+      - develop
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - name: Install Dependencies
+        run: |
+          pip3 install mkdocs-material
+          pip3 install mkdocs-git-revision-date-localized-plugin
+      - name: Publish codeigniter DEA Rule Documentation
+        run: mkdocs gh-deploy --force

.github/workflows/phpcpd.yml

@@ -0,0 +1,36 @@
+name: PHPCPD
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - '.github/workflows/phpcpd.yml'
+  push:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - '.github/workflows/phpcpd.yml'
+
+jobs:
+  build:
+    name: Code Copy-Paste Detection
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          tools: phpcpd
+          extensions: dom, mbstring
+          coverage: none
+
+      - name: Detect duplicate code
+        run: phpcpd src/ tests/