Started v2.0-dev

- Interfaces have been streamlined
- Upgrade to Enum v3
- Dropped PHP 7.2
- Dropped Laravel 5

Author: fulopattila122

.editorconfig

@@ -0,0 +1,18 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://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

.gitattributes

@@ -0,0 +1,9 @@
+* text=auto
+
+/tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+.styleci.yml export-ignore
+phpunit.xml export-ignore

.travis.yml

@@ -4,19 +4,10 @@ cache:
     - "$HOME/.composer/cache"
 
 php:
-  - '7.2'
   - '7.3'
   - '7.4'
 
 env:
-  - LARAVEL=5.5
-  - LARAVEL=5.5 TEST_DB_ENGINE=mysql
-  - LARAVEL=5.5 TEST_DB_ENGINE=pgsql
-  - LARAVEL=5.6
-  - LARAVEL=5.7
-  - LARAVEL=5.8
-  - LARAVEL=5.8 TEST_DB_ENGINE=mysql
-  - LARAVEL=5.8 TEST_DB_ENGINE=pgsql
   - LARAVEL=6.0
   - LARAVEL=6.18
   - LARAVEL=6.18 TEST_DB_ENGINE=mysql
@@ -26,24 +17,16 @@ env:
   - LARAVEL=7.28 TEST_DB_ENGINE=mysql
   - LARAVEL=7.28 TEST_DB_ENGINE=pgsql
   - LARAVEL=8.0
-  - LARAVEL=8.0 TEST_DB_ENGINE=mysql
-  - LARAVEL=8.0 TEST_DB_ENGINE=pgsql
+  - LARAVEL=8.6
+  - LARAVEL=8.6 TEST_DB_ENGINE=mysql
+  - LARAVEL=8.6 TEST_DB_ENGINE=pgsql
 
-matrix:
-  exclude:
-    - php: '7.2'
-      env: 'LARAVEL=8.0'
-    - php: '7.2'
-      env: 'LARAVEL=8.0 TEST_DB_ENGINE=mysql'
-    - php: '7.2'
-      env: 'LARAVEL=8.0 TEST_DB_ENGINE=pgsql'
 
 script:
   - vendor/bin/phpunit --testdox
 before_install:
-  - MINOR=`echo $LARAVEL | sed 's/[5|6|7|8]\.\([0-9]\+\)/\1/'`
-  - '[[ $LARAVEL =~ ^6\.[0-9]+$ ]] && MAJOR=6 || MAJOR=5'
-  - '[[ $LARAVEL =~ ^7\.[0-9]+$ ]] && MAJOR=7 || true'
+  - MINOR=`echo $LARAVEL | sed 's/[6|7|8]\.\([0-9]\+\)/\1/'`
+  - '[[ $LARAVEL =~ ^7\.[0-9]+$ ]] && MAJOR=7 || MAJOR=6'
   - '[[ $LARAVEL =~ ^8\.[0-9]+$ ]] && MAJOR=8 || true'
   - echo "Testing against Laravel ${MAJOR}.${MINOR}"
   - composer require "illuminate/support:${MAJOR}.${MINOR}.*" --no-update -v

Changelog.md

@@ -1,5 +1,13 @@
 # Address Module Changelog
 
+## Unreleased
+##### 2020-XX-YY
+
+- BC: Address, Country and Person interfaces have been extended
+- BC: Enums have been upgraded to v3
+- Dropped Laravel 5 support
+- Dropped PHP 7.2 support
+
 ## 1.3.0
 ##### 2020-09-12
 

composer.json

@@ -15,10 +15,10 @@
         "issues": "https://github.com/artkonekt/address"
     },
     "require": {
-        "php": "^7.2",
+        "php": "^7.3",
         "doctrine/dbal": "~2.3, !=2.10.3",
-        "konekt/concord": "~1.5",
-        "konekt/enum": "~2.1",
+        "konekt/concord": "~1.6",
+        "konekt/enum": "~3.0",
         "konekt/enum-eloquent": "~1.5"
     },
     "autoload": {
@@ -29,8 +29,8 @@
     },
     "require-dev": {
         "ext-sqlite3": "*",
-        "orchestra/testbench": "~3.5|~4.0|~5.0|~6.0",
-        "phpunit/phpunit" : "6.2 - 7.5|~8.0|~9.0",
+        "orchestra/testbench": "~4.0|~5.0|~6.0",
+        "phpunit/phpunit" : "~8.0|~9.0",
         "mockery/mockery": "^1.1"
     },
     "autoload-dev": {

phpunit.xml.dist

@@ -11,6 +11,11 @@
 
 namespace Konekt\Address\Contracts;
 
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
 interface Address
 {
+    public function country(): BelongsTo;
+
+    public function province(): BelongsTo;
 }

src/Contracts/Address.php

@@ -11,6 +11,9 @@
 
 namespace Konekt\Address\Contracts;
 
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
 interface Country
 {
+    public function provinces(): HasMany;
 }

src/Contracts/Country.php

@@ -15,8 +15,6 @@ interface Person
 {
     /**
      * Returns the full name of the person (in appropriate name order)
-     *
-     * @return string
      */
-    public function getFullName();
+    public function getFullName(): string;
 }

src/Contracts/Person.php

@@ -12,6 +12,7 @@
 namespace Konekt\Address\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Konekt\Address\Contracts\Address as AddressContract;
 use Konekt\Enum\Eloquent\CastsEnums;
 
@@ -43,22 +44,12 @@ class Address extends Model implements AddressContract
      */
     protected $table = 'addresses';
 
-    /**
-     * Relationship to the country the address belongs to
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function country()
+    public function country(): BelongsTo
     {
         return $this->belongsTo(CountryProxy::modelClass(), 'country_id');
     }
 
-    /**
-     * Relationship to the province the address belongs to
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-     */
-    public function province()
+    public function province(): BelongsTo
     {
         return $this->belongsTo(ProvinceProxy::modelClass(), 'province_id');
     }

src/Models/Address.php

@@ -26,7 +26,7 @@
  */
 class AddressType extends Enum implements AddressTypeContract
 {
-    const __default = self::UNDEFINED;
+    const __DEFAULT = self::UNDEFINED;
 
     /** To display on Invoices */
     const BILLING = 'billing';

src/Models/AddressType.php

@@ -12,6 +12,7 @@
 namespace Konekt\Address\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 use Konekt\Address\Contracts\Country as CountryContract;
 
@@ -50,7 +51,7 @@ class Country extends Model implements CountryContract
         'is_eu_member' => 'bool'
     ];
 
-    public function provinces()
+    public function provinces(): HasMany
     {
         return $this->hasMany(ProvinceProxy::modelClass(), 'country_id', 'id');
     }

src/Models/Country.php

@@ -16,7 +16,7 @@
 
 class NameOrder extends Enum implements NameOrderContract
 {
-    const __default = self::WESTERN;
+    const __DEFAULT = self::WESTERN;
 
     const WESTERN   = 'western';
     const EASTERN   = 'eastern';

src/Models/NameOrder.php

@@ -61,7 +61,7 @@ class Person extends Model implements PersonContract
     /**
      * @inheritdoc
      */
-    public function getFullName()
+    public function getFullName(): string
     {
         if ($this->nameorder && $this->nameorder->isEastern()) {
             return sprintf('%s %s', $this->lastname, $this->firstname);

src/Models/Person.php

@@ -27,7 +27,7 @@
  */
 class ProvinceType extends Enum implements ProvinceTypeContract
 {
-    const __default        = self::PROVINCE;
+    const __DEFAULT        = self::PROVINCE;
 
     const STATE            = 'state';
     const REGION           = 'region';

src/Models/ProvinceType.php

@@ -2,5 +2,5 @@
 
 return [
     'name'    => 'Konekt Address Module',
-    'version' => '1.3.0'
+    'version' => '2.0-dev'
 ];

src/resources/manifest.php

@@ -24,7 +24,7 @@ public function can_be_instantiated()
         $type = new AddressType();
 
         $this->assertNotNull($type);
-        $this->assertEquals(AddressType::__default, $type->value());
+        $this->assertEquals(AddressType::defaultValue(), $type->value());
 
         $shipping = AddressType::SHIPPING();
         $this->assertTrue($shipping->equals(AddressTypeProxy::SHIPPING()));