first commit

denisdulici · denisdulici · commit 0b09086100ad · 2022-02-23T10:59:58.000+03:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,18 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,25 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text eol=lf
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.c text
+*.h text
+
+# Declare files that will always have CRLF line endings on checkout.
+*.sln text eol=crlf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.otf binary
+*.eot binary
+*.svg binary
+*.ttf binary
+*.woff binary
+*.woff2 binary
+
+*.css linguist-vendored
+*.scss linguist-vendored
+*.js linguist-vendored
+CHANGELOG.md export-ignore
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,37 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+
+    name: PHP ${{ matrix.php }}
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ['8.0', '8.1']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Cache composer
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache/files
+          key: php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extension-csv: bcmath, ctype, dom, fileinfo, intl, gd, json, mbstring, pdo, pdo_sqlite, openssl, sqlite, xml, zip
+          coverage: none
+
+      - name: Install composer
+        run: composer install --no-interaction --no-scripts --no-suggest --prefer-source
+
+      - name: Execute tests
+        run: php artisan test --parallel
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+/.idea
+/.history
+/.vscode
+/tests/databases
+/vendor
+.DS_Store
+.phpunit.result.cache
+composer.phar
+composer.lock
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,19 @@
+filter:
+    excluded_paths:
+        - tests/*
+
+checks:
+    php:
+        code_rating: true
+
+tools:
+    external_code_coverage: true
+    php_analyzer: true
+    php_changetracking: true
+    php_code_sniffer:
+        config:
+            standard: "PSR2"
+    php_cpd: true
+    php_mess_detector: true
+    php_pdepend: true
+    sensiolabs_security_checker: true
diff --git a/.styleci.yml b/.styleci.yml
@@ -0,0 +1,4 @@
+preset: psr2
+
+enabled:
+ - concat_with_spaces
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Akaunting
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,64 @@
+# Mutable observer package for Laravel
+
+![Downloads](https://img.shields.io/packagist/dt/akaunting/laravel-mutable-observer)
+![Tests](https://img.shields.io/github/workflow/status/akaunting/laravel-mutable-observer/Tests?label=tests)
+[![StyleCI](https://github.styleci.io/repos/442271942/shield?style=flat&branch=master)](https://styleci.io/repos/442271942)
+[![Quality](https://img.shields.io/scrutinizer/quality/g/akaunting/laravel-mutable-observer?label=quality)](https://scrutinizer-ci.com/g/akaunting/laravel-mutable-observer)
+[![License](https://img.shields.io/github/license/akaunting/laravel-mutable-observer)](LICENSE.md)
+
+This package allows you to `mute` and `unmute` a specific observer at will. It ships with a trait that adds mutable methods to your observer.
+
+## Installation
+
+Run the following command:
+
+```bash
+composer require akaunting/laravel-mutable-observer
+```
+
+## Usage
+
+All you have to do is use the `Mutable` trait inside your observer.
+
+```php
+namespace App\Observers;
+
+use Akaunting\MutableObserver\Traits\Mutable;
+
+class UserObserver
+{
+    use Mutable;
+}
+```
+
+Now you can `mute` and `unmute` the observer as needed:
+
+```php
+UserObserver::mute();
+
+// Some logic, i.e. test
+
+UserObserver::unmute();
+```
+
+## Changelog
+
+Please see [Releases](../../releases) for more information what has changed recently.
+
+## Contributing
+
+Pull requests are more than welcome. You must follow the PSR coding standards.
+
+## Security
+
+Please review [our security policy](https://github.com/akaunting/laravel-sortable/security/policy) on how to report security vulnerabilities.
+
+## Credits
+
+- [Denis Duliçi](https://github.com/denisdulici)
+- [Stephen Lewis](https://github.com/monooso)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Security Policy
+
+**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
+
+## Reporting a Vulnerability
+
+If you discover any security related issues, please email security@akaunting.com instead of using the issue tracker.
diff --git a/composer.json b/composer.json
@@ -0,0 +1,45 @@
+{
+    "name": "akaunting/laravel-mutable-observer",
+    "description": "Mutable observer package for Laravel",
+    "keywords": [
+        "laravel",
+        "observer",
+        "mutable",
+        "mute",
+        "unmute"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Denis Duliçi",
+            "email": "info@akaunting.com",
+            "homepage": "https://akaunting.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.0",
+        "laravel/framework": ">=8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": ">=9.0",
+        "orchestra/testbench": ">=7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Akaunting\\MutableObserver\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Akaunting\\MutableObserver\\Tests\\": "tests"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Akaunting\\MutableObserver\\Provider"
+            ]
+        }
+    }
+}
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnError="false"
+         stopOnFailure="false"
+         verbose="true"
+>
+    <testsuites>
+        <testsuite name="Package Test Suite">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+    <php>
+        <env name="CACHE_DRIVER" value="array"/>
+        <env name="SESSION_DRIVER" value="array"/>
+        <env name="QUEUE_DRIVER" value="sync"/>
+        <env name="QUEUE_CONNECTION" value="sync"/>
+        <env name="MAIL_DRIVER" value="array"/>
+        <env name="MAIL_MAILER" value="array"/>
+    </php>
+</phpunit>
diff --git a/src/Provider.php b/src/Provider.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Akaunting\MutableObserver;
+
+use Illuminate\Contracts\Support\DeferrableProvider;
+use Illuminate\Support\ServiceProvider;
+
+class Provider extends ServiceProvider implements DeferrableProvider
+{
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton(ProxyManager::class, function ($app) {
+            return new ProxyManager($app);
+        });
+
+        $this->app->bind(Proxy::class, function ($app, $parameters) {
+            return new Proxy($parameters['target'], $parameters['events']);
+        });
+    }
+}
diff --git a/src/Proxy.php b/src/Proxy.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Akaunting\MutableObserver;
+
+use BadMethodCallException;
+
+class Proxy
+{
+    /** @var object */
+    private $target;
+
+    /** @var array */
+    private $events;
+
+    public function __construct($target, array $events = [])
+    {
+        $this->target = $target;
+        $this->events = $events;
+    }
+
+    public function __call($name, $arguments)
+    {
+        if ($this->isMuted($name)) {
+            return null;
+        }
+
+        if (method_exists($this->target, $name)) {
+            return $this->target->$name(...$arguments);
+        }
+
+        throw new BadMethodCallException(sprintf(
+            'Unknown method [%s@%s]',
+            get_class($this->target),
+            $name
+        ));
+    }
+
+    protected function isMuted($name): bool
+    {
+        return (in_array('*', $this->events) || in_array($name, $this->events));
+    }
+}
diff --git a/src/ProxyManager.php b/src/ProxyManager.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Akaunting\MutableObserver;
+
+use Illuminate\Contracts\Container\Container;
+
+class ProxyManager
+{
+    /** @var Container */
+    private $app;
+
+    public function __construct(Container $app)
+    {
+        $this->app = $app;
+    }
+
+    public function register($target, array $events)
+    {
+        $proxy = $this->app->make(Proxy::class, ['target' => $target, 'events' => $events]);
+
+        $this->app->instance(get_class($target), $proxy);
+    }
+
+    public function unregister($target)
+    {
+        $this->app->instance(get_class($target), $target);
+    }
+}
diff --git a/src/Traits/Mutable.php b/src/Traits/Mutable.php
diff --git a/tests/MutableTest.php b/tests/MutableTest.php
diff --git a/tests/ProxyManagerTest.php b/tests/ProxyManagerTest.php
diff --git a/tests/ProxyTest.php b/tests/ProxyTest.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +# Security Policy
++
 +**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
++
 +## Reporting a Vulnerability
++
 +If you discover any security related issues, please email [email protected] instead of using the issue tracker.