Revert "Add ld+json structs"

This reverts commit 9607730.
romanzipp · Jul 9, 2024 · 71dfe47 · 71dfe47
1 parent 88ebaf6
commit 71dfe47
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 140 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -34,23 +34,22 @@ See the [Schema.org integration docs](/schema-org.html) for more information.
 
 ## Cheat Sheet
 
-| Code                                  | Rendered HTML                                                |
-|---------------------------------------|--------------------------------------------------------------|
-| **Shorthand Setters**                 |                                                              |
-| `seo()->title('Laravel')`             | `<title>Laravel</title>`                                     |
-| `seo()->description('Laravel')`       | `<meta name="description" content="Laravel" />`              |
-| `seo()->meta('author', 'Roman Zipp')` | `<meta name="author" content="Roman Zipp" />`                |
-| `seo()->twitter('card', 'summary')`   | `<meta name="twitter:card" content="summary" />`             |
-| `seo()->og('site_name', 'Laravel')`   | `<meta name="og:site_name" content="Laravel" />`             |
-| `seo()->charset()`                    | `<meta charset="utf-8" />`                                   |
-| `seo()->viewport()`                   | `<meta name="viewport" content="width=device-width, ..." />` |
-| `seo()->csrfToken()`                  | `<meta name="csrf-token" content="..." />`                   |
-| `seo()->ldJson([...])`                | `<script type="application/ld+json">...</scrit>`             |
-| **Adding Structs**                    |                                                              |
-| `seo()->add(...)`                     | `<meta name="foo" />`                                        |
-| `seo()->addMany([...])`               | `<meta name="foo" />`                                        |
-| `seo()->addIf(true, ...)`             | `<meta name="foo" />`                                        |
-| **Various**                           |                                                              |
-| `seo()->mix()`                        |                                                              |
-| `seo()->hook()`                       |                                                              |
-| `seo()->render()`                     |                                                              |
+| Code | Rendered HTML |
+|----|----|
+| **Shorthand Setters** | |
+| `seo()->title('Laravel')` | `<title>Laravel</title>` |
+| `seo()->description('Laravel')` | `<meta name="description" content="Laravel" />` |
+| `seo()->meta('author', 'Roman Zipp')` | `<meta name="author" content="Roman Zipp" />` |
+| `seo()->twitter('card', 'summary')` | `<meta name="twitter:card" content="summary" />` |
+| `seo()->og('site_name', 'Laravel')` | `<meta name="og:site_name" content="Laravel" />` |
+| `seo()->charset()` | `<meta charset="utf-8" />` |
+| `seo()->viewport()` | `<meta name="viewport" content="width=device-width, ..." />` |
+| `seo()->csrfToken()` | `<meta name="csrf-token" content="..." />` |
+| **Adding Structs** | |
+| `seo()->add(...)` | `<meta name="foo" />` |
+| `seo()->addMany([...])` | `<meta name="foo" />` |
+| `seo()->addIf(true, ...)` | `<meta name="foo" />` |
+| **Various** | |
+| `seo()->mix()` | |
+| `seo()->hook()` | |
+| `seo()->render()` | |
diff --git a/docs/structs.md b/docs/structs.md
@@ -332,39 +332,6 @@ seo()->add(
 
 </details>
 
-### JSON-LD
-
-```php
-seo()->ldJson(array $data, bool $pretty = false);
-```
-
-<details>
-<summary>same as ...</summary>
-
-```php
-use romanzipp\Seo\Structs\LinkedData;
-
-seo()->add(
-    LinkedData::make()
-        ->data($data, $pretty = false)
-);
-```
-
-</details>
-
-<details>
-<summary>renders to ...</summary>
-
-```html
-<script type="application/ld+json">
-    {
-        "@context": "https://schema.org/"
-    }
-</script>
-```
-
-</details>
-
 ## Adding single structs
 
 If you need to use more advanced elements which are not covered with shorthand setters, you can easily add single structs to your SEO instance the following way.

diff --git a/src/Services/Traits/ShorthandSetterTrait.php b/src/Services/Traits/ShorthandSetterTrait.php
@@ -5,7 +5,6 @@
 use Illuminate\Support\Arr;
 use romanzipp\Seo\Services\SeoService;
 use romanzipp\Seo\Structs\Link\Canonical;
-use romanzipp\Seo\Structs\LinkedData;
 use romanzipp\Seo\Structs\Meta;
 use romanzipp\Seo\Structs\Meta\Charset;
 use romanzipp\Seo\Structs\Meta\CsrfToken;
@@ -246,23 +245,6 @@ public function csrfToken(string $token = null): self
         );
     }
 
-    /**
-     * Add a JSON-LD script.
-     *
-     * @see https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data
-     *
-     * @param array<string, array|string> $structuredData
-     * @param bool $pretty
-     *
-     * @return $this
-     */
-    public function ldJson(array $structuredData, bool $pretty = false): self
-    {
-        return $this->add(
-            LinkedData::make()->data($structuredData, $pretty)
-        );
-    }
-
     abstract public function add(Struct $struct): SeoService;
 
     abstract public function addIf(bool $boolean, Struct $struct): SeoService;

diff --git a/src/Structs/LinkedData.php b/src/Structs/LinkedData.php
diff --git a/tests/RenderTest.php b/tests/RenderTest.php
@@ -4,7 +4,6 @@
 
 use Illuminate\Support\HtmlString;
 use romanzipp\Seo\Builders\StructBuilder;
-use romanzipp\Seo\Structs\LinkedData;
 use romanzipp\Seo\Structs\Meta;
 use romanzipp\Seo\Structs\Title;
 
@@ -208,27 +207,4 @@ public function testTagSyntaxUnknown()
 
         $this->assertEquals('<meta name="1" />', seo()->render()->toHtml());
     }
-
-    public function testTagLinkedData()
-    {
-        seo()->add(
-            LinkedData::make()->data([
-                '@context' => 'https://schema.org/',
-                '@type' => 'Recipe',
-                'name' => 'Party Coffee Cake',
-                'author' => [
-                    '@type' => 'Person',
-                    'name' => 'Mary Stone',
-                ],
-                'datePublished' => '2018-03-10',
-                'description' => 'This coffee cake is awesome and perfect for parties.',
-                'prepTime' => 'PT20M',
-            ])
-        );
-
-        $this->assertEquals(
-            '<script type="application/ld+json">{"@context":"https://schema.org/","@type":"Recipe","name":"Party Coffee Cake","author":{"@type":"Person","name":"Mary Stone"},"datePublished":"2018-03-10","description":"This coffee cake is awesome and perfect for parties.","prepTime":"PT20M"}</script>',
-            seo()->render()->toHtml()
-        );
-    }
 }
diff --git a/tests/ShorthandSettersTest.php b/tests/ShorthandSettersTest.php
@@ -3,7 +3,6 @@
 namespace romanzipp\Seo\Test;
 
 use romanzipp\Seo\Structs\Link\Canonical;
-use romanzipp\Seo\Structs\LinkedData;
 use romanzipp\Seo\Structs\Meta;
 use romanzipp\Seo\Structs\Meta\Charset;
 use romanzipp\Seo\Structs\Meta\OpenGraph;
@@ -152,15 +151,4 @@ public function testCanonicalSetter()
 
         $this->assertInstanceOf(Canonical::class, seo()->getStructs()[0]);
     }
-
-    public function testLinkedDataSetter()
-    {
-        seo()->ldJson(['@context' => 'https://schema.org/']);
-
-        $contents = seo()->render()->toArray();
-
-        $this->assertCount(1, $contents);
-
-        $this->assertInstanceOf(LinkedData::class, seo()->getStructs()[0]);
-    }
 }
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -37,7 +37,6 @@ public static function assertMatchesRegularExpressionCustom(string $pattern, str
         // If parent has method assertMatchesRegularExpression, call it
         if (method_exists(BaseTestCase::class, 'assertMatchesRegularExpression')) {
             parent::assertMatchesRegularExpression($pattern, $string, $message);
-
             return;
         }