Merge pull request #1 from karam-mustafa/main

Update package files

Author: karam-mustafa

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,23 @@
+name: Check & fix styling
+
+on: [push,pull_request]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP Code Style Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php-cs-fixer.dist.php --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling

.github/workflows/php.yml

@@ -0,0 +1,35 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+    # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
+    # Docs: https://getcomposer.org/doc/articles/scripts.md
+
+    # - name: Run test suite
+    #   run: composer run-script test

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Run tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        php: [7.4, 8.0]
+        laravel: [8.*,7.*]
+        dependency-version: [prefer-stable]
+        include:
+          - testbench: ^6.23
+            laravel: 8.*
+
+          - testbench: 5.20
+            laravel: 7.*
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+
+    steps:
+      -   name: Checkout code
+          uses: actions/checkout@v2
+
+      -   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
+            coverage: none
+
+      -   name: Install dependencies
+          run: |
+            composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+            composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+      -   name: Execute tests
+          run: vendor/bin/phpunit

.github/workflows/update-changelog.yml

@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

README.md

@@ -1,12 +1,9 @@
 ![logo](assets/logo.png)
 
-#Add your package badges
 
-[![PHP Composer](https://github.com/Syrian-Open-Source/laravel-package-template/actions/workflows/php.yml/badge.svg)](https://github.com/syrian-open-source/laravel-multi-process/actions/workflows/php.yml)
-[![Run tests](https://github.com/Syrian-Open-Source/laravel-package-template/actions/workflows/tests.yml/badge.svg)](https://github.com/syrian-open-source/laravel-multi-process/actions/workflows/tests.yml)
+[![PHP Composer](https://github.com/Syrian-Open-Source/laravel-relational-metrics/actions/workflows/php.yml/badge.svg)](https://github.com/syrian-open-source/laravel-multi-process/actions/workflows/php.yml)
+[![Run tests](https://github.com/Syrian-Open-Source/laravel-relational-metrics/actions/workflows/tests.yml/badge.svg)](https://github.com/syrian-open-source/laravel-multi-process/actions/workflows/tests.yml)
 
-Design a simple and expressive logo with the same model you see above,
-the logo design helps to unify the visual identity and further develop the optimal packages to increase the quality of the software we develop
 
 # Relational Metrics
 This package will help you to make your metrics easier, You could get metrics about your Models, Models depending on their relations, or even metrics about your models depending on multiple conditions!!
@@ -17,16 +14,16 @@ It would be a very easy to get the number of your stores which has products has
 The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:
 
 ```shell
-composer require syrian-open-source/relational-metrics
+composer require syrian-open-source/laravel-relational-metrics
 ```
 
 
 Usage
 ---------
-The Basic Usage of this package is the same of geting count of some model instances, but with a styled response 
+The Basic Usage of this package is the same of getting count of some model instances, but with a styled response 
 
 ```php
-        $instance = (new RelationalMetrics(ModelName)); 
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
         // EX: new RelationalMetrics(Store);
         $metrics = $instance->getBasicMetrics();
         /*
@@ -43,7 +40,7 @@ What you can do next, you could get the metrics of a model depending on one of i
 Let's assume we want to get the number of stores that has products with price more than 500
 
 ```php
-        $instance = (new RelationalMetrics(ModelName)); 
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
         // EX: new RelationalMetrics(Store);
         $metrics = $instance->getRelationalMetrics($relationName, $relationColumn, $value);
         // EX: $instance->getRelationalMetrics('products, 'price', 500);
@@ -63,7 +60,7 @@ And last but not least, You could get the metrics about a model depending on any
 
 
 ```php
-        $instance = (new RelationalMetrics(ModelName)); 
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
         // EX: new RelationalMetrics(Store);
         $metrics = $instance->getRelationalMetrics($conditions);
         // EX: $instance->getRelationalMetrics(
@@ -87,15 +84,15 @@ At the previous Example the Package will return the number of the stores where t
 
 Changelog
 ---------
-Please see the [CHANGELOG](https://github.com/syrian-open-source/laravel-package-template/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
+Please see the [CHANGELOG](https://github.com/syrian-open-source/laravel-relational-metrics/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
 
 Security
 --------
-If you discover any security related issues, please email them first to "your email", 
+If you discover any security related issues, please email them first to "zainaldeenfayod@gmail.com", 
 if we do not fix it within a short period of time please open a new issue describing your problem. 
 
 Credits
 -------
 * [zainaldeenfayod@gmail.com](https://github.com/zainaldeen/laravel-relational-metrics-1)
-* [All contributors](https://github.com/syrian-open-source/laravel-package-template/graphs/contributors)
+* [All contributors](https://github.com/syrian-open-source/laravel-relational-metrics/graphs/contributors)
 

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "syrian-open-source/relational-metrics",
+    "name": "syrian-open-source/laravel-relational-metrics",
     "description": "This package will help you to get your model metrics, and their related models' metrics which will help you to avoid writing to many requests or queries.",
     "license": "MIT",
     "keywords": [