Added default timezone instanciation

Author: toonvandenbos

.gitignore

@@ -0,0 +1,8 @@
+/vendor
+.idea
+.DS_Store
+Thumbs.db
+composer.lock
+.phpunit.result.cache
+.swp
+*.map

README.md

@@ -1 +1,15 @@
-# laravel-timezones
+# Laravel Timezones
+
+## Usage
+
+All database dates should be stored using the `app.timezone` config setting. We highly suggest keeping it as `UTC` since it's a global standard for dates storage.
+
+For in-app date manipulation and display, you can define the timezone all dates should cast to using one of the following methods. Depending on you app's context, choose the one that best suits your situation.
+
+### 1. Using middleware
+
+Useful when the app's timezone should be set by ther user's settings.
+
+### 2. Using a Service Provider
+
+Useful when the app's timezone should be set by the application itself.

composer.json

@@ -0,0 +1,50 @@
+{
+    "name": "whitecube/laravel-prices",
+    "description": "Store UTC dates in the database and work with custom timezones in the application.",
+    "keywords": [
+        "whitecube",
+        "laravel",
+        "utc",
+        "local",
+        "time",
+        "conversion"
+    ],
+    "authors": [
+        {
+            "name": "Whitecube",
+            "email": "hello@whitecube.be"
+        },
+        {
+            "name": "Toon Van den Bos",
+            "email": "toon@whitecube.be"
+        }
+    ],
+    "require": {
+        "php": ">=8.1",
+        "laravel/framework": "^9",
+        "nesbot/carbon": "^2.64"
+    },
+    "autoload": {
+        "psr-4": {
+            "Whitecube\\LaravelTimezones\\": "src/",
+            "Whitecube\\LaravelTimezones\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Whitecube\\LaravelTimezones\\ServiceProvider"
+            ]
+        }
+    },
+    "require-dev": {
+        "pestphp/pest": "^1.22"
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./app</directory>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/ServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Whitecube\LaravelTimezones;
+
+use Whitecube\LaravelTimezones\Timezone;
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+
+class ServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton(Timezone::class, function ($app) {
+            return new Timezone(config('app.timezone'));
+        });
+    }
+}

src/Timezone.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Whitecube\LaravelTimezones;
+
+use Carbon\CarbonTimeZone;
+
+class Timezone
+{
+    /**
+     * The app's current display & manipulation timezone
+     *
+     * @var \Carbon\CarbonTimeZone
+     */
+    protected CarbonTimeZone $current;
+    /**
+     * The app's current storage timezone
+     *
+     * @var \Carbon\CarbonTimeZone
+     */
+    protected CarbonTimeZone $storage;
+
+    public static function set($timezone = null)
+    {
+        static::instance()->setCurrent($timezone);
+    }
+
+    public static function current(): CarbonTimeZone
+    {
+        return static::instance()->getCurrent();
+    }
+
+    public static function storage(): CarbonTimeZone
+    {
+        return static::instance()->getStorage();
+    }
+
+    public function instance(): static
+    {
+        return app()->make(self::class);
+    }
+
+    public function __construct(string $default)
+    {
+        $this->setStorage($default);
+        $this->setCurrent($default);
+    }
+
+    public function setCurrent($timezone)
+    {
+        $this->current = $this->makeTimezone($timezone);
+    }
+
+    public function getCurrent(): CarbonTimeZone
+    {
+        return $this->current;
+    }
+
+    public function setStorage($timezone)
+    {
+        $this->storage = $this->makeTimezone($timezone);
+    }
+
+    public function getStorage(): CarbonTimeZone
+    {
+        return $this->storage;
+    }
+
+    protected function makeTimezone($value): CarbonTimeZone
+    {
+        if(! is_a($value, CarbonTimeZone::class)) {
+            $value = new CarbonTimeZone($value);
+        }
+
+        return $value;
+    }
+}

tests/Pest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+// uses(Tests\TestCase::class)->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+// expect()->extend('toBeOne', function () {
+//     return $this->toBe(1);
+// });
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+// function something()
+// {
+//     // ..
+// }

tests/TimezoneSingletonTest.php

@@ -0,0 +1,11 @@
+<?php
+
+use Carbon\CarbonTimeZone;
+use Whitecube\LaravelTimezones\Timezone;
+
+it('can create a default Timezone instance and access its current & storage settings', function() {
+    $instance = new Timezone('Europe/Brussels');
+
+    expect($instance->getCurrent())->toBeInstanceOf(CarbonTimeZone::class);
+    expect($instance->getStorage())->toBeInstanceOf(CarbonTimeZone::class);
+});