Merge pull request #795 from claremacrae/issue-791-sort-uncategorized-plugins

Fix #791: enable sorting of uncategorized plugins

Author: claremacrae

.github/scripts/plugins.py

@@ -16,7 +16,10 @@
 class Plugin:
 
     def __init__(self, data: PluginStorage):
-        self.__data = data
+        # Make a copy to avoid modifying the original input data
+        self.__data = data.copy()
+
+        self.sanitize_description()
 
     def repo(self) -> str:
         return str(self.__data.get("repo"))
@@ -77,6 +80,8 @@ def collect_data_for_plugin_and_manifest(self, manifest: PluginManifest, file_gr
 
         self.__data.update(mobile=mobile, user=user, **manifest)
         update_author_name_for_manual_exceptions(self.__data)
+        
+        self.sanitize_description()
 
         return plugin_is_valid
 
@@ -93,3 +98,9 @@ def validate_plugin_ids(self, manifest: PluginManifest, repo: str, file_groups:
             add_file_group(file_groups, "error", f"{releases_id}/{manifest_id}")
             ids_match = False
         return ids_match
+
+    def sanitize_description(self) -> None:
+        # Sanitize the description in place.
+        # See https://github.com/obsidian-community/obsidian-hub/issues/791
+        if 'description' in self.__data:
+            self.__data['description'] = self.__data['description'].replace('\n', ' ')

.github/scripts/tests/approved_files/test_plugins.test_description_contains_newline.approved.md

@@ -0,0 +1,13 @@
+{
+    "author": "chenfeicqq",
+    "authorUrl": "https://github.com/chenfeicqq",
+    "description": "Attachment folder name binding note name, automatically rename, automatically delete, show/hide. \u9644\u4ef6\u6587\u4ef6\u5939\u540d\u79f0\u7ed1\u5b9a\u7b14\u8bb0\u540d\u3001\u81ea\u52a8\u91cd\u547d\u540d\u3001\u81ea\u52a8\u5220\u9664\u3001\u663e\u793a/\u9690\u85cf\u3002",
+    "id": "attachment-manager",
+    "isDesktopOnly": true,
+    "minAppVersion": "0.12.17",
+    "mobile": "[[Desktop-only plugins|No]]",
+    "name": "Attachment Manager",
+    "repo": "chenfeicqq/obsidian-attachment-manager",
+    "user": "chenfeicqq",
+    "version": "1.2.2"
+}

.github/scripts/tests/test_plugins.py

@@ -3,15 +3,22 @@
 import plugins
 
 from helpers_for_testing import verify_in_json_format_to_markdown
+from plugins import Plugin
+from tests.helpers_for_testing import verify_in_json_format_to_markdown
 from utils import FileGroups
 
 
 def verify_plugin(manifest_as_json: str, plugin_as_json: str) -> None:
+    plugin = process_plugin(manifest_as_json, plugin_as_json)
+    verify_in_json_format_to_markdown(plugin.data())
+
+
+def process_plugin(manifest_as_json: str, plugin_as_json: str) -> Plugin:
     plugin = plugins.Plugin(json.loads(plugin_as_json))
     manifest = json.loads(manifest_as_json)
     file_groups: FileGroups = dict()
     result = plugin.collect_data_for_plugin_and_manifest(manifest, file_groups)
-    verify_in_json_format_to_markdown(plugin.data())
+    return plugin
 
 
 def test_author_augmented_for_ryanjamurphy() -> None:
@@ -65,3 +72,39 @@ def test_author_missing_from_manifest() -> None:
     }
     '''
     verify_plugin(manifest_as_json, plugin_as_json)
+
+
+def test_description_contains_newline() -> None:
+    # See https://github.com/obsidian-community/obsidian-hub/issues/791
+    # This plugin's manifest.json has a newline character in the description.
+    # This test verifies that this situation is handled correctly.
+    plugin_as_json = '''
+    {
+        "id": "attachment-manager",
+        "name": "Attachment Manager",
+        "author": "chenfeicqq",
+        "description": "Attachment Manager: Attachment folder name binding note name, automatically rename, automatically delete, show/hide.\\n附件管理器：附件文件夹名称绑定笔记名、自动重命名、自动删除、显示/隐藏。",
+        "repo": "chenfeicqq/obsidian-attachment-manager"
+    }
+    '''
+    plugin_from_obsidian_releases = plugins.Plugin(json.loads(plugin_as_json))
+    assert plugin_from_obsidian_releases.data()['description'] == "Attachment Manager: Attachment folder name binding note name, automatically rename, automatically delete, show/hide. 附件管理器：附件文件夹名称绑定笔记名、自动重命名、自动删除、显示/隐藏。"
+
+    manifest_as_json = '''
+    {
+        "id": "attachment-manager",
+        "name": "Attachment Manager",
+        "version": "1.2.2",
+        "minAppVersion": "0.12.17",
+        "description": "Attachment folder name binding note name, automatically rename, automatically delete, show/hide.\\n附件文件夹名称绑定笔记名、自动重命名、自动删除、显示/隐藏。",
+        "author": "chenfeicqq",
+        "authorUrl": "https://github.com/chenfeicqq",
+        "isDesktopOnly": true
+    }
+    '''
+
+    plugin_from_obsidian_releases_and_manifest = process_plugin(manifest_as_json, plugin_as_json)
+    assert plugin_from_obsidian_releases_and_manifest.data()['description'] == "Attachment folder name binding note name, automatically rename, automatically delete, show/hide. 附件文件夹名称绑定笔记名、自动重命名、自动删除、显示/隐藏。"
+
+    verify_plugin(manifest_as_json, plugin_as_json)
+