refactor: change name to octamp

cydrickn · Feb 9, 2023 · edcaa2c · edcaa2c
1 parent a13d555
commit edcaa2c
Show file tree

Hide file tree

Showing 29 changed files with 108 additions and 103 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 composer.phar
 /vendor/
+/build/
 /examples/
 .phpunit.result.cache
 .phpunit.cache

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# SWamp Client
-SWamp Client is an open source client for [WAMP (Web Application Messaging Protocol)](https://wamp-proto.org/), for PHP.
+# Octamp Client
+Octamp Client is an open source client for [WAMP (Web Application Messaging Protocol)](https://wamp-proto.org/), for PHP.
 
-SWamp Client uses [Open Swoole](https://openswoole.com/docs), is a high-performance network framework based on an event-driven, asynchronous, non-blocking I/O coroutine programming model for PHP.
+Octamp Client uses [Open Swoole](https://openswoole.com/docs), is a high-performance network framework based on an event-driven, asynchronous, non-blocking I/O coroutine programming model for PHP.
 
-We also design the SWamp Client functions to be identical to [AutobahnJS](https://github.com/crossbario/autobahn-js)
+We also design the Octamp Client functions to be identical to [AutobahnJS](https://github.com/crossbario/autobahn-js)
 
-The name SWamp is from Swoole + WAMP
+The name Octamp is from Octopus + WAMP
 
 ## Supported WAMP Features
 
@@ -23,17 +23,17 @@ The name SWamp is from Swoole + WAMP
 ## Installation
 
 ```sh
-composer require swamp/client
+composer require octamp/client
 ```
 
 ## Example
 
 ```php
 <?php
 
-use SWamp\Client\Auth\WampcraAuthenticator;
-use SWamp\Client\Peer;
-use SWamp\Client\Session;
+use Octamp\Client\Auth\WampcraAuthenticator;
+use Octamp\Client\Peer;
+use Octamp\Client\Session;
 
 require_once __DIR__ . '/../../vendor/autoload.php';
 
@@ -46,11 +46,11 @@ $client->onOpen(function (Session $session) {
     });
 
     // publish
-    $session->publish('hello', ['hello swamp'], [], ['exclude_me' => false]);
+    $session->publish('hello', ['hello octamp'], [], ['exclude_me' => false]);
 
     // publish with acknowledgement
     $session
-        ->publish('hello', ['hello swamp with acknowledgement'], [], ['acknowledge' => true, 'exclude_me' => false])
+        ->publish('hello', ['hello octamp with acknowledgement'], [], ['acknowledge' => true, 'exclude_me' => false])
         ->then(
             function () {
                 echo 'Publish Acknowledged!' . PHP_EOL;

diff --git a/bin/phpunit.php b/bin/phpunit.php
@@ -1,3 +1,4 @@
+#!/usr/bin/env php
 <?php
 
 

diff --git a/composer.json b/composer.json
@@ -1,11 +1,11 @@
 {
-    "name": "swamp/client",
+    "name": "octamp/client",
     "description": "WAMP client for PHP Swoole",
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "SWamp\\Client\\": "src/",
-            "SWamp\\Client\\Tests\\": "tests/"
+            "Octamp\\Client\\": "src/",
+            "Octamp\\Client\\Tests\\": "tests/"
         },
         "files": ["src/helpers.php"]
     },
@@ -23,5 +23,8 @@
     "require": {
         "php": ">=8.1",
         "voryx/thruway-common": "^1.0"
+    },
+    "scripts": {
+        "test": "./bin/phpunit.php"
     }
 }
diff --git a/src/Auth/WampcraAuthenticator.php b/src/Auth/WampcraAuthenticator.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Auth;
+namespace Octamp\Client\Auth;
 
 use Thruway\Message\ChallengeMessage;
 use Thruway\Message\AuthenticateMessage;

diff --git a/src/EventDispatcher.php b/src/EventDispatcher.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client;
+namespace Octamp\Client;
 
 use Swoole\Coroutine;
 

diff --git a/src/Peer.php b/src/Peer.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace SWamp\Client;
+namespace Octamp\Client;
 
 use Co\Http\Client as SwooleClient;
-use SWamp\Client\Roles\AbstractRole;
-use SWamp\Client\Roles\Callee;
-use SWamp\Client\Roles\Caller;
-use SWamp\Client\Roles\Publisher;
-use SWamp\Client\Roles\Subscriber;
+use Octamp\Client\Roles\AbstractRole;
+use Octamp\Client\Roles\Callee;
+use Octamp\Client\Roles\Caller;
+use Octamp\Client\Roles\Publisher;
+use Octamp\Client\Roles\Subscriber;
 use Swoole\Coroutine;
 use Swoole\WebSocket\Frame;
 use Thruway\Message\AbortMessage;
@@ -73,7 +73,7 @@ public function open(): void
         });
     }
 
-    protected function startSession()
+    protected function startSession(): void
     {
         $this->roles['publisher'] = new Publisher();
         $this->roles['subscriber'] = new Subscriber();

diff --git a/src/Promise/CancellablePromiseInterface.php b/src/Promise/CancellablePromiseInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 interface CancellablePromiseInterface extends PromiseInterface
 {

diff --git a/src/Promise/Deferred.php b/src/Promise/Deferred.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 class Deferred
 {

diff --git a/src/Promise/ProgressPromise.php b/src/Promise/ProgressPromise.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 use Swoole\Coroutine;
 

diff --git a/src/Promise/ProgressablePromiseInterface.php b/src/Promise/ProgressablePromiseInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 interface ProgressablePromiseInterface extends PromiseInterface
 {

diff --git a/src/Promise/Promise.php b/src/Promise/Promise.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 use Co\Channel;
 use Swoole\ArrayObject;

diff --git a/src/Promise/PromiseInterface.php b/src/Promise/PromiseInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Promise;
+namespace Octamp\Client\Promise;
 
 interface PromiseInterface
 {

diff --git a/src/Result.php b/src/Result.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client;
+namespace Octamp\Client;
 
 class Result
 {

diff --git a/src/Roles/AbstractRole.php b/src/Roles/AbstractRole.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace SWamp\Client\Roles;
+namespace Octamp\Client\Roles;
 
-use SWamp\Client\Session;
+use Octamp\Client\Session;
 use Thruway\Message\Message;
 
 abstract class AbstractRole

diff --git a/src/Roles/Callee.php b/src/Roles/Callee.php
@@ -1,15 +1,15 @@
 <?php
 
-namespace SWamp\Client\Roles;
-
-use SWamp\Client\Peer;
-use SWamp\Client\Promise\CancellablePromiseInterface;
-use SWamp\Client\Promise\Deferred;
-use SWamp\Client\Promise\ProgressablePromiseInterface;
-use SWamp\Client\Promise\ProgressPromise;
-use SWamp\Client\Promise\PromiseInterface;
-use SWamp\Client\Result;
-use SWamp\Client\Session;
+namespace Octamp\Client\Roles;
+
+use Octamp\Client\Peer;
+use Octamp\Client\Promise\CancellablePromiseInterface;
+use Octamp\Client\Promise\Deferred;
+use Octamp\Client\Promise\ProgressablePromiseInterface;
+use Octamp\Client\Promise\ProgressPromise;
+use Octamp\Client\Promise\PromiseInterface;
+use Octamp\Client\Result;
+use Octamp\Client\Session;
 use Thruway\Common\Utils;
 use Thruway\Message\ErrorMessage;
 use Thruway\Message\InterruptMessage;

diff --git a/src/Roles/Caller.php b/src/Roles/Caller.php
@@ -1,12 +1,12 @@
 <?php
 
-namespace SWamp\Client\Roles;
+namespace Octamp\Client\Roles;
 
-use SWamp\Client\Promise\Deferred;
-use SWamp\Client\Promise\ProgressablePromiseInterface;
-use SWamp\Client\Promise\ProgressPromise;
-use SWamp\Client\Result;
-use SWamp\Client\Session;
+use Octamp\Client\Promise\Deferred;
+use Octamp\Client\Promise\ProgressablePromiseInterface;
+use Octamp\Client\Promise\ProgressPromise;
+use Octamp\Client\Result;
+use Octamp\Client\Session;
 use Thruway\Common\Utils;
 use Thruway\Message\CallMessage;
 use Thruway\Message\ErrorMessage;

diff --git a/src/Roles/Publisher.php b/src/Roles/Publisher.php
@@ -1,10 +1,10 @@
 <?php
 
-namespace SWamp\Client\Roles;
+namespace Octamp\Client\Roles;
 
-use SWamp\Client\Promise\Deferred;
-use SWamp\Client\Promise\PromiseInterface;
-use SWamp\Client\Session;
+use Octamp\Client\Promise\Deferred;
+use Octamp\Client\Promise\PromiseInterface;
+use Octamp\Client\Session;
 use Thruway\Common\Utils;
 use Thruway\Message\ErrorMessage;
 use Thruway\Message\Message;

diff --git a/src/Roles/Subscriber.php b/src/Roles/Subscriber.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace SWamp\Client\Roles;
+namespace Octamp\Client\Roles;
 
-use SWamp\Client\Promise\Deferred;
-use SWamp\Client\Session;
+use Octamp\Client\Promise\Deferred;
+use Octamp\Client\Session;
 use Thruway\Common\Utils;
 use Thruway\Message\ErrorMessage;
 use Thruway\Message\EventMessage;

diff --git a/src/Session.php b/src/Session.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace SWamp\Client;
+namespace Octamp\Client;
 
-use SWamp\Client\Promise\PromiseInterface;
+use Octamp\Client\Promise\PromiseInterface;
 use Thruway\Message\Message;
 
 class Session

diff --git a/src/helpers.php b/src/helpers.php
@@ -3,10 +3,10 @@
 
 function await(mixed $callback): mixed
 {
-    return (new \SWamp\Client\Promise\Promise($callback))->wait();
+    return (new \Octamp\Client\Promise\Promise($callback))->wait();
 }
 
-function promise(callable $callback): \SWamp\Client\Promise\Promise
+function promise(callable $callback): \Octamp\Client\Promise\Promise
 {
-    return new \SWamp\Client\Promise\Promise($callback);
+    return new \Octamp\Client\Promise\Promise($callback);
 }
diff --git a/tests/AssertCoroutine.php b/tests/AssertCoroutine.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace SWamp\Client\Tests;
+namespace Octamp\Client\Tests;
 
 class AssertCoroutine
 {

diff --git a/tests/Unit/Auth/WampcraAuthenticatorTest.php b/tests/Unit/Auth/WampcraAuthenticatorTest.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace SWamp\Client\Tests\Unit\Auth;
+namespace Octamp\Client\Tests\Unit\Auth;
 
-use SWamp\Client\Auth\WampcraAuthenticator;
-use SWamp\Client\Tests\Unit\TestCase;
+use Octamp\Client\Auth\WampcraAuthenticator;
+use Octamp\Client\Tests\Unit\TestCase;
 use Thruway\Message\AuthenticateMessage;
 use Thruway\Message\ChallengeMessage;
 

diff --git a/tests/Unit/Promise/DeferredTest.php b/tests/Unit/Promise/DeferredTest.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace SWamp\Client\Tests\Unit\Auth;
+namespace Octamp\Client\Tests\Unit\Auth;
 
 use Co\Scheduler;
 use Co\WaitGroup;
-use SWamp\Client\Promise\Deferred;
-use SWamp\Client\Promise\ProgressablePromiseInterface;
-use SWamp\Client\Tests\AssertCoroutine;
-use SWamp\Client\Tests\Unit\TestCase;
+use Octamp\Client\Promise\Deferred;
+use Octamp\Client\Promise\ProgressablePromiseInterface;
+use Octamp\Client\Tests\AssertCoroutine;
+use Octamp\Client\Tests\Unit\TestCase;
 use Swoole\Coroutine;
 
 class DeferredTest extends TestCase
@@ -18,10 +18,10 @@ public function testResolve()
         $this->assertInstanceOf(ProgressablePromiseInterface::class, $deferred->promise());
 
         $promise = $deferred->promise();
-        $deferred->resolve('hello swamp');
+        $deferred->resolve('hello Octamp');
         $result = $promise->wait();
 
-        $this->assertSame('hello swamp', $result);
+        $this->assertSame('hello Octamp', $result);
     }
 
     public function testReject()
@@ -30,10 +30,10 @@ public function testReject()
         $this->assertInstanceOf(ProgressablePromiseInterface::class, $deferred->promise());
 
         $promise = $deferred->promise();
-        $deferred->reject('hello swamp');
+        $deferred->reject('hello Octamp');
         $result = $promise->wait();
 
-        $this->assertSame('hello swamp', $result);
+        $this->assertSame('hello Octamp', $result);
     }
 
     public function testProgress()

diff --git a/tests/Unit/Promise/ProgressPromiseTest.php b/tests/Unit/Promise/ProgressPromiseTest.php
@@ -1,11 +1,11 @@
 <?php
 
-namespace SWamp\Client\Tests\Unit\Auth;
+namespace Octamp\Client\Tests\Unit\Auth;
 
-use SWamp\Client\Promise\ProgressPromise;
-use SWamp\Client\Promise\Promise;
-use SWamp\Client\Tests\AssertCoroutine;
-use SWamp\Client\Tests\Unit\TestCase;
+use Octamp\Client\Promise\ProgressPromise;
+use Octamp\Client\Promise\Promise;
+use Octamp\Client\Tests\AssertCoroutine;
+use Octamp\Client\Tests\Unit\TestCase;
 
 class ProgressPromiseTest extends TestCase
 {