separate API from implementation

Author: xabbuh

.travis.yml

@@ -34,6 +34,3 @@ install:
 
 script:
   - vendor/bin/phpspec run
-  - if [[ "$xdebug" = "yes" ]]; then phpunit --coverage-clover=coverage.clover; else phpunit; fi
-  - if [[ "$xdebug" = "yes" ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
-  - if [[ "$xdebug" = "yes" ]]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

CHANGELOG.md

@@ -4,8 +4,34 @@ CHANGELOG
 0.4.0
 -----
 
-* Added a `SerializerFactoryInterface` with a default implementation in
-  `SerializerFactory` that abstracts the creation of serializer instances.
+* The serializer implementation has been separated from its API definition.
+  This package now no longer ships with an implementation.
+
+  The Symfony Serializer component integration has been moved to the separate
+  [php-xapi/symfony-serializer package](https://github.com/php-xapi/symfony-serializer).
+
+  A default implementation of the `SerializerRegistryInterface` is still part
+  of the `php-xapi/serializer` package though.
+
+  This package ships with the following interfaces that must be implemented
+  by packages that want to provide the xAPI serialization functionality:
+
+  * `ActorSerializerInterface`
+  * `DocumentDataSerializerInterface`
+  * `StatementResultSerializerInterface`
+  * `StatementSerializerInterface`
+  * `StatementFactoryInterface`
+
+  Implementors of the API provided by this package are advised to add the
+  `php-xapi/serializer-implementation` package to the `provide` section of
+  their `composer.json` file.
+
+  The `Tests` subnamespace of this package contains a set of base abstract
+  PHPUnit test classes integrators can use to make sure that their implementation
+  adheres to the API specified by the `php-xapi/serializer` package.
+
+* Added a `SerializerFactoryInterface` that abstracts the creation of serializer
+  instances.
 
 * The `SerializerRegistry` class is now final. If you need custom behavior
   inside the serializer registry, create your own implementation of the

UPGRADE.md

@@ -4,6 +4,32 @@ UPGRADE
 Upgrading from 0.3 to 0.4
 -------------------------
 
+* The serializer implementation has been separated from its API definition.
+  This package now no longer ships with an implementation.
+
+  The Symfony Serializer component integration has been moved to the separate
+  [php-xapi/symfony-serializer package](https://github.com/php-xapi/symfony-serializer).
+
+  A default implementation of the `SerializerRegistryInterface` is still part
+  of the `php-xapi/serializer` package though.
+
+  This package ships with the following interfaces that must be implemented
+  by packages that want to provide the xAPI serialization functionality:
+
+  * `ActorSerializerInterface`
+  * `DocumentDataSerializerInterface`
+  * `StatementResultSerializerInterface`
+  * `StatementSerializerInterface`
+  * `StatementFactoryInterface`
+
+  Implementors of the API provided by this package are advised to add the
+  `php-xapi/serializer-implementation` package to the `provide` section of
+  their `composer.json` file.
+
+  The `Tests` subnamespace of this package contains a set of base abstract
+  PHPUnit test classes integrators can use to make sure that their implementation
+  adheres to the API specified by the `php-xapi/serializer` package.
+
 * The `SerializerRegistry` class is now final. If you need custom behavior
   inside the serializer registry, create your own implementation of the
   `SerializerRegistryInterface`.

composer.json

@@ -13,24 +13,20 @@
     ],
     "require": {
         "php": ">=5.3.0",
+        "php-xapi/json-test-fixtures": "^0.2.3",
         "php-xapi/model": "^0.5.0",
-        "symfony/serializer": "~2.8|~3.0"
+        "php-xapi/test-fixtures": "^0.5.0"
     },
     "require-dev": {
-        "php-xapi/json-test-fixtures": "^0.2.3",
-        "php-xapi/test-fixtures": "^0.5.0",
         "phpspec/phpspec": "^2.3"
     },
     "conflict": {
         "xabbuh/xapi-serializer": "*"
     },
     "autoload": {
         "psr-4": {
-            "Xabbuh\\XApi\\Serializer\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
+            "spec\\Xabbuh\\XApi\\Serializer\\": "spec/",
+            "Xabbuh\\XApi\\Serializer\\": "src/",
             "Xabbuh\\XApi\\Serializer\\Tests\\": "tests/"
         }
     },