Update from 'Structured Headers' to 'Structured Fields'

gapple · gapple · commit fa589c0df6f9 · 2020-07-02T10:02:30.000-07:00
- Update namespace and create compatibility classes
- Update composer.json
- Update Readme
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
-    "name": "gapple/structured-headers",
-    "description": "Parser for Structured Headers for HTTP",
+    "name": "gapple/structured-fields",
+    "description": "Parser for Structured Field Values for HTTP",
     "type": "library",
     "license": [
         "MIT",
@@ -12,13 +12,14 @@
         }
     ],
     "support": {
-        "source": "https://github.com/gapple/structured-headers",
-        "issues": "https://github.com/gapple/structured-headers/issues"
+        "source": "https://github.com/gapple/structured-fields",
+        "issues": "https://github.com/gapple/structured-fields/issues"
     },
     "autoload": {
         "psr-4": {
-            "gapple\\StructuredHeaders\\": "src/",
-            "gapple\\Tests\\StructuredHeaders\\": "tests/"
+            "gapple\\StructuredFields\\": "src/",
+            "gapple\\Tests\\StructuredFields\\": "tests/",
+            "gapple\\StructuredHeaders\\": "src/headers-compat"
         }
     },
     "scripts": {
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset name="structured-headers">
-  <description>Default PHP CodeSniffer configuration for gapple/structured-headers.</description>
+<ruleset name="structured-fields">
+  <description>Default PHP CodeSniffer configuration for gapple/structured-fields.</description>
 
   <file>src</file>
   <file>tests</file>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -6,7 +6,7 @@
     failOnWarning="true"
 >
     <testsuites>
-        <testsuite name="structured-headers tests">
+        <testsuite name="structured-fields tests">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
diff --git a/readme.md b/readme.md
@@ -1,10 +1,10 @@
-Structured Headers parser for PHP
+Structured Field Values Parser for PHP
 =======================================
 
-Parser and serializer for the [Structured Headers for HTTP][1] specification.
+Parser and serializer for the [Structured Field Values for HTTP][1] specification.
 
-[![Build Status](https://github.com/gapple/structured-headers/workflows/PHP%20Composer/badge.svg)](https://github.com/gapple/structured-headers/actions)
-[![codecov](https://codecov.io/gh/gapple/structured-headers/branch/master/graph/badge.svg)](https://codecov.io/gh/gapple/structured-headers)
+[![Build Status](https://github.com/gapple/structured-fields/workflows/PHP%20Composer/badge.svg)](https://github.com/gapple/structured-fields/actions)
+[![codecov](https://codecov.io/gh/gapple/structured-fields/branch/master/graph/badge.svg)](https://codecov.io/gh/gapple/structured-fields)
 
 
 Installation
@@ -13,7 +13,7 @@ Installation
 Using composer:
 
 ```
-composer require gapple/structured-headers
+composer require gapple/structured-fields
 ```
 
 API
@@ -24,7 +24,7 @@ API
 The `Parser::parseItem()` method returns a `[value, parameters]` tuple.
 
 ```php
-print_r(\gapple\StructuredHeaders\Parser::parseItem("42"));
+print_r(\gapple\StructuredFields\Parser::parseItem("42"));
 
 // Array
 // (
@@ -40,7 +40,7 @@ print_r(\gapple\StructuredHeaders\Parser::parseItem("42"));
 The `Parser::parseList()` method returns an array of `[value, parameters]` tuples.
 
 ```php
-print_r(\gapple\StructuredHeaders\Parser::parseList("1, 42;towel;panic=?0"));
+print_r(\gapple\StructuredFields\Parser::parseList("1, 42;towel;panic=?0"));
 
 // Array
 // (
@@ -68,7 +68,7 @@ print_r(\gapple\StructuredHeaders\Parser::parseList("1, 42;towel;panic=?0"));
 The `Parser::parseDictionary()` method returns a `\stdClass` object with `[value, parameters]` tuples.
 
 ```php
-print_r(\gapple\StructuredHeaders\Parser::parseDictionary("towel, panic=?0"));
+print_r(\gapple\StructuredFields\Parser::parseDictionary("towel, panic=?0"));
 
 // stdClass Object
 // (
@@ -95,16 +95,16 @@ print_r(\gapple\StructuredHeaders\Parser::parseDictionary("towel, panic=?0"));
 The `Serializer::serializeItem()` method.
 
 ```php
-print_r(\gapple\StructuredHeaders\Serializer::serializeItem(true));
+print_r(\gapple\StructuredFields\Serializer::serializeItem(true));
 // ?1
 
-print_r(\gapple\StructuredHeaders\Serializer::serializeItem(42));
+print_r(\gapple\StructuredFields\Serializer::serializeItem(42));
 // 42
 
-print_r(\gapple\StructuredHeaders\Serializer::serializeItem("42"));
+print_r(\gapple\StructuredFields\Serializer::serializeItem("42"));
 // "42"
 
-print_r(\gapple\StructuredHeaders\Serializer::serializeItem(new \gapple\StructuredHeaders\Bytes('🙂')));
+print_r(\gapple\StructuredHeStructuredFieldsaders\Serializer::serializeItem(new \gapple\StructuredFields\Bytes('🙂')));
 // :8J+Zgg==:
 ```
 
@@ -113,7 +113,7 @@ print_r(\gapple\StructuredHeaders\Serializer::serializeItem(new \gapple\Structur
 The `Serializer::serializeList()` method.
 
 ```php
-print_r(\gapple\StructuredHeaders\Serializer::serializeList([
+print_r(\gapple\StructuredFields\Serializer::serializeList([
     [1, (object) []],
     [42, (object) ['towel' => true, 'panic' => false]],
 ]));
@@ -126,7 +126,7 @@ print_r(\gapple\StructuredHeaders\Serializer::serializeList([
 The `Serializer::serializeDictionary()` method.
 
 ```php
-print_r(\gapple\StructuredHeaders\Serializer::serializeDictionary((object) [
+print_r(\gapple\StructuredFields\Serializer::serializeDictionary((object) [
     'towel' => [true, (object) []],
     'panic' => [false, (object) []],
 ]));
diff --git a/src/Bytes.php b/src/Bytes.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class Bytes
 {
diff --git a/src/ParseException.php b/src/ParseException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class ParseException extends \RuntimeException
 {
diff --git a/src/Parser.php b/src/Parser.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class Parser
 {
@@ -152,7 +152,7 @@ private static function doParseItem(string &$string): array
     /**
      * @param string $string
      *
-     * @return bool|float|int|string|\gapple\StructuredHeaders\Bytes|\gapple\StructuredHeaders\Token
+     * @return bool|float|int|string|\gapple\StructuredFields\Bytes|\gapple\StructuredFields\Token
      */
     private static function parseBareItem(string &$string)
     {
@@ -294,7 +294,7 @@ private static function parseToken(string &$string): Token
      *
      * @param string $string
      *
-     * @return \gapple\StructuredHeaders\Bytes
+     * @return \gapple\StructuredFields\Bytes
      */
     private static function parseByteSequence(string &$string): Bytes
     {
diff --git a/src/SerializeException.php b/src/SerializeException.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class SerializeException extends \RuntimeException
 {
diff --git a/src/Serializer.php b/src/Serializer.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class Serializer
 {
diff --git a/src/Token.php b/src/Token.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\StructuredHeaders;
+namespace gapple\StructuredFields;
 
 class Token
 {
diff --git a/src/headers-compat/Bytes.php b/src/headers-compat/Bytes.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\Bytes as FieldsBytes;
+
+/**
+ * @deprecated
+ */
+class Bytes extends FieldsBytes
+{
+
+}
diff --git a/src/headers-compat/ParseException.php b/src/headers-compat/ParseException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\ParseException as FieldsParseException;
+
+/**
+ * @deprecated
+ */
+class ParseException extends FieldsParseException
+{
+
+}
diff --git a/src/headers-compat/Parser.php b/src/headers-compat/Parser.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\Parser as FieldsParser;
+
+/**
+ * @deprecated
+ */
+class Parser extends FieldsParser
+{
+
+}
diff --git a/src/headers-compat/SerializeException.php b/src/headers-compat/SerializeException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\SerializeException as FieldsSerializeException;
+
+/**
+ * @deprecated
+ */
+class SerializeException extends FieldsSerializeException
+{
+
+}
diff --git a/src/headers-compat/Serializer.php b/src/headers-compat/Serializer.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\Serializer as FieldsSerializer;
+
+/**
+ * @deprecated
+ */
+class Serializer extends FieldsSerializer
+{
+
+}
diff --git a/src/headers-compat/Token.php b/src/headers-compat/Token.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace gapple\StructuredHeaders;
+
+use gapple\StructuredFields\Token as FieldsToken;
+
+/**
+ * @deprecated
+ */
+class Token extends FieldsToken
+{
+
+}
diff --git a/tests/RulesetBinaryTest.php b/tests/RulesetBinaryTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetBinaryTest extends RulesetTest
 {
diff --git a/tests/RulesetBooleanTest.php b/tests/RulesetBooleanTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetBooleanTest extends RulesetTest
 {
diff --git a/tests/RulesetDictionaryTest.php b/tests/RulesetDictionaryTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetDictionaryTest extends RulesetTest
 {
diff --git a/tests/RulesetItemTest.php b/tests/RulesetItemTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetItemTest extends RulesetTest
 {
diff --git a/tests/RulesetKeyGeneratedTest.php b/tests/RulesetKeyGeneratedTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetKeyGeneratedTest extends RulesetTest
 {
diff --git a/tests/RulesetLargeGeneratedTest.php b/tests/RulesetLargeGeneratedTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetLargeGeneratedTest extends RulesetTest
 {
diff --git a/tests/RulesetListListTest.php b/tests/RulesetListListTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetListListTest extends RulesetTest
 {
diff --git a/tests/RulesetListTest.php b/tests/RulesetListTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetListTest extends RulesetTest
 {
diff --git a/tests/RulesetNumberGeneratedTest.php b/tests/RulesetNumberGeneratedTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetNumberGeneratedTest extends RulesetTest
 {
diff --git a/tests/RulesetNumberTest.php b/tests/RulesetNumberTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetNumberTest extends RulesetTest
 {
diff --git a/tests/RulesetParamDictTest.php b/tests/RulesetParamDictTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetParamDictTest extends RulesetTest
 {
diff --git a/tests/RulesetParamListListTest.php b/tests/RulesetParamListListTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetParamListListTest extends RulesetTest
 {
diff --git a/tests/RulesetParamListTest.php b/tests/RulesetParamListTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetParamListTest extends RulesetTest
 {
diff --git a/tests/RulesetSerializationKeyGeneratedTest.php b/tests/RulesetSerializationKeyGeneratedTest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace gapple\Tests\StructuredHeaders;
+namespace gapple\Tests\StructuredFields;
 
 class RulesetSerializationKeyGeneratedTest extends RulesetTest
 {
diff --git a/tests/RulesetSerializationNumberTest.php b/tests/RulesetSerializationNumberTest.php
diff --git a/tests/RulesetSerializationStringGeneratedTest.php b/tests/RulesetSerializationStringGeneratedTest.php
diff --git a/tests/RulesetSerializationTokenGeneratedTest.php b/tests/RulesetSerializationTokenGeneratedTest.php
diff --git a/tests/RulesetStringGeneratedTest.php b/tests/RulesetStringGeneratedTest.php
diff --git a/tests/RulesetStringTest.php b/tests/RulesetStringTest.php
diff --git a/tests/RulesetTest.php b/tests/RulesetTest.php
diff --git a/tests/RulesetTokenGeneratedTest.php b/tests/RulesetTokenGeneratedTest.php
diff --git a/tests/RulesetTokenTest.php b/tests/RulesetTokenTest.php
diff --git a/tests/SerializeItemTest.php b/tests/SerializeItemTest.php
diff --git a/tests/SerializeStringTest.php b/tests/SerializeStringTest.php
diff --git a/tests/SerializeTokenTest.php b/tests/SerializeTokenTest.php

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`failOnWarning="true"`
`7`	`7`	`>`
`8`	`8`	`<testsuites>`
`9`		`- <testsuite name="structured-headers tests">`
	`9`	`+ <testsuite name="structured-fields tests">`
`10`	`10`	`<directory>./tests/</directory>`
`11`	`11`	`</testsuite>`
`12`	`12`	`</testsuites>`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace gapple\StructuredHeaders;`
	`3`	`+namespace gapple\StructuredFields;`
`4`	`4`
`5`	`5`	`class Bytes`
`6`	`6`	`{`