Escape quotations in Open Graph description when smart quotes are disabled. (#49)

* Escape quotation marks when smart quotes are disabled

* Add tests

* Reformat with Black

Author: ItayZiv

sphinxext/opengraph/descriptionparser.py

@@ -124,4 +124,5 @@ def get_description(
 
     mcv = DescriptionParser(description_length, known_titles, document)
     doctree.walkabout(mcv)
-    return mcv.description
+    # Parse quotation so they won't break html tags if smart quotes are disabled
+    return mcv.description.replace('"', """)

tests/roots/test-quotation-marks/conf.py

@@ -0,0 +1,10 @@
+extensions = ["sphinxext.opengraph"]
+
+master_doc = "index"
+exclude_patterns = ["_build"]
+
+html_theme = "basic"
+
+smartquotes = False
+
+ogp_site_url = "http://example.org/"

tests/roots/test-quotation-marks/index.rst

@@ -0,0 +1 @@
+"This text should appear in escaped quotation marks" This text should still appear as well "while this is once again in quotations"

tests/test_options.py

@@ -149,6 +149,17 @@ def test_skip_code_block(og_meta_tags):
     )
 
 
+@pytest.mark.sphinx("html", testroot="quotation-marks")
+def test_quotation_marks(og_meta_tags):
+    # If smart quotes are disabled and the quotes aren't properly escaped, bs4 will fail to parse the tag and the content will be a empty string
+    description = get_tag_content(og_meta_tags, "description")
+
+    assert (
+        description
+        == '"This text should appear in escaped quotation marks" This text should still appear as well "while this is once again in quotations"'
+    )
+
+
 # use same as simple, as configuration is identical to overriden
 @pytest.mark.sphinx("html", testroot="simple")
 def test_rtd_override(app: Sphinx, monkeypatch):