⬆️ Add support for Flask 2.0.x

Author: techouse

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Klemen Tušar
+Copyright (c) 2022 Klemen Tušar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -24,9 +24,14 @@ flask jsonify
 
 Either press `⌘Y` to Quick Look the result, or press `<enter>` to open it in your web browser.
 
-## Supported Branches
+## Changing Branches
 
-Currently the app indexes branch __1.0__ only.
+The workflow supports searching the documentation all the active branches, that is `v0.12`, `v1`, `v1.1`, and `v2`.
+By default, it searches the `v2` branch. To search branch `v1.1` simply type `v1.1` **anywhere** in your query, like so:
+
+```
+flask jsonify v1.1
+```
 
 ### Note
 

flask-docs-v1.0.5.alfredworkflow

@@ -9,6 +9,9 @@ class Config(object):
     # Icon
     FLASK_ICON = "icon.png"
     GOOGLE_ICON = "google.png"
+    # supported docs
+    SUPPORTED_FLASK_VERSIONS = {"2", "1.1", "1", "0.12"}
+    DEFAULT_FLASK_VERSION = "2"
     # Algolia credentials
     ALGOLIA_APP_ID = "WODHKE4WZG"
     ALGOLIA_SEARCH_ONLY_API_KEY = "7456cdd91ba8d4f87846549697397759"

flask-docs-v1.0.6.alfredworkflow

@@ -21,13 +21,13 @@
 log = None
 
 
-def cache_key(query):
+def cache_key(query, version=Config.DEFAULT_FLASK_VERSION):
     """Make filesystem-friendly cache key"""
-    key = query
+    key = query + "_" + version
     key = key.lower()
     key = re.sub(r"[^a-z0-9-_;.]", "-", key)
     key = re.sub(r"-+", "-", key)
-    # log.debug("Cache key : {!r} -> {!r}".format(query, key))
+    # log.debug("Cache key : {!r} {!r} -> {!r}".format(query, version, key))
     return key
 
 
@@ -41,9 +41,18 @@ def handle_result(api_dict):
     return result
 
 
-def search(query=None, limit=Config.RESULT_COUNT):
+def search(
+    query=None, version=Config.DEFAULT_FLASK_VERSION, limit=Config.RESULT_COUNT
+):
     if query:
-        results = index.search(query, {"page": 0, "hitsPerPage": limit})
+        results = index.search(
+            query,
+            {
+                "facetFilters": ["version:{}".format(version)],
+                "page": 0,
+                "hitsPerPage": limit,
+            },
+        )
         if results is not None and "hits" in results:
             return results["hits"]
     return []
@@ -61,6 +70,10 @@ def main(wf):
 
     query = wf.args[0].strip()
 
+    # Tag prefix only. Treat as blank query
+    if query == "v":
+        query = ""
+
     if not query:
         wf.add_item("Search the Flask docs...")
         wf.send_feedback()
@@ -69,16 +82,26 @@ def main(wf):
     # Parse query into query string and tags
     words = query.split(" ")
 
-    query = " ".join(words)
+    query = []
+    version = Config.DEFAULT_FLASK_VERSION
+
+    for word in words:
+        if word.replace("v", "") in Config.SUPPORTED_FLASK_VERSIONS:
+            version = word.replace("v", "")
+        else:
+            query.append(word)
+
+    query = " ".join(query)
 
-    log.debug("query : {!r}".format(query))
+    # log.debug("version: {!r}".format(version))
+    # log.debug("query: {!r}".format(query))
 
-    key = cache_key(query)
+    key = cache_key(query, version)
 
     results = [
         handle_result(result)
         for result in wf.cached_data(
-            key, functools.partial(search, query), max_age=Config.CACHE_MAX_AGE
+            key, functools.partial(search, query, version), max_age=Config.CACHE_MAX_AGE
         )
     ]
 

src/config.py

@@ -123,7 +123,7 @@
 	<key>variablesdontexport</key>
 	<array/>
 	<key>version</key>
-	<string>1.0.5</string>
+	<string>1.0.6</string>
 	<key>webaddress</key>
 	<string>https://github.com/techouse</string>
 </dict>

src/docs.py

@@ -1,8 +1,8 @@
-Alfred-Workflow==1.37.2
-algoliasearch==2.0.4
-certifi==2019.6.16
-chardet==3.0.4
-idna==2.8
-requests==2.22.0
-typing==3.7.4
-urllib3==1.26.5
+Alfred-Workflow>=1.40.0
+algoliasearch>=2.6.1
+certifi>=2021.10.8
+chardet>=4.0.0
+idna>=2.10
+requests>=2.26.0
+typing>=3.10.0.0
+urllib3>=1.26.7

src/info.plist

@@ -1 +1 @@
-1.0.5
+1.0.6