Merge pull request #10 from clnt/2.0.1-dev

clnt · web-flow · commit 957ba67ac5b8 · 2021-11-11T20:01:27.000Z
PHP 8.0 Support + macOS Monterey Support
diff --git a/README.md b/README.md
@@ -8,7 +8,10 @@ Adapted from [Alfred VueJS Docs](https://github.com/vmitchell85/alfred-vuejs-doc
 
 ## Installation
 
-1. [Download the latest version](https://github.com/clnt/alfred-tailwindcss-docs/releases/download/v2.0.0/TailwindCSSDocs.alfredworkflow)
+
+> **macOS Monterey:** PHP is no longer shipped with macOS, before attempting to use this workflow ensure you have installed the php binary via Homebrew.
+
+1. [Download the latest version](https://github.com/clnt/alfred-tailwindcss-docs/releases/download/v2.0.1/TailwindCSSDocs.alfredworkflow)
 2. Install the workflow by double-clicking the `.alfredworkflow` file
 3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.
 
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "clnt/alfred-tailwindcss-docs",
-    "description": "An ultra-fast TailwindCSS docs search workflow for Alfred 3.",
-    "version": "1.1.0",
+    "description": "An ultra-fast TailwindCSS docs search workflow for Alfred 4.",
+    "version": "2.0.1",
     "keywords": ["alfred", "alfred-workflow", "tailwindcss", "algolia"],
     "homepage": "https://github.com/clnt",
     "support": {
@@ -11,7 +11,6 @@
     "license": "MIT",
     "require": {
         "joetannenbaum/alfred-workflow": "^0.1.0",
-        "algolia/algoliasearch-client-php": "^1.27",
-        "erusev/parsedown": "^1.7"
+        "algolia/algoliasearch-client-php": "^2.7"
     }
 }
diff --git a/functions.php b/functions.php
@@ -0,0 +1,50 @@
+<?php
+
+function getResults($algolia, $indexName, $query)
+{
+    $index = $algolia->initIndex($indexName);
+
+    return $index->search($query)['hits'];
+}
+
+function getTitle($hit)
+{
+    if (isset($hit['hierarchy']['lvl6'])) {
+        return [$hit['hierarchy']['lvl6'], 6];
+    }
+
+    if (isset($hit['hierarchy']['lvl5'])) {
+        return [$hit['hierarchy']['lvl5'], 5];
+    }
+
+    if (isset($hit['hierarchy']['lvl4'])) {
+        return [$hit['hierarchy']['lvl4'], 4];
+    }
+
+    if (isset($hit['hierarchy']['lvl3'])) {
+        return [$hit['hierarchy']['lvl3'], 3];
+    }
+
+    if (isset($hit['hierarchy']['lvl2'])) {
+        return [$hit['hierarchy']['lvl2'], 2];
+    }
+
+    if (isset($hit['hierarchy']['lvl1'])) {
+        return [$hit['hierarchy']['lvl1'], 1];
+    }
+
+    return [null, null];
+}
+
+function getSubtitle($hit, $titleLevel)
+{
+    $currentLevel = 0;
+    $subtitle = $hit['hierarchy']['lvl0'];
+
+    while ($currentLevel < $titleLevel) {
+        $currentLevel++;
+        $subtitle .= ' » ' . $hit['hierarchy']['lvl' . $currentLevel];
+    }
+
+    return $subtitle;
+}
diff --git a/info.plist b/info.plist
@@ -105,7 +105,13 @@
 				<key>runningsubtext</key>
 				<string>Searching docs for "{query}"...</string>
 				<key>script</key>
-				<string>php tailwindcss.php "{query}"</string>
+				<string>if [ -f "/opt/homebrew/bin/php" ]; then
+    /opt/homebrew/bin/php tailwindcss.php "{query}"
+elif [ -f "/usr/local/bin/php" ]; then
+    /usr/local/bin/php tailwindcss.php "{query}"
+elif [ -f "/usr/bin/php" ]; then
+    /usr/bin/php tailwindcss.php "{query}"
+fi</string>
 				<key>scriptargtype</key>
 				<integer>0</integer>
 				<key>scriptfile</key>
@@ -173,7 +179,13 @@
 				<key>runningsubtext</key>
 				<string>Searching docs for "{query}"...</string>
 				<key>script</key>
-				<string>php v0_tailwindcss.php "{query}"</string>
+				<string>if [ -f "/opt/homebrew/bin/php" ]; then
+    /opt/homebrew/bin/php v0_tailwindcss.php "{query}"
+elif [ -f "/usr/local/bin/php" ]; then
+    /usr/local/bin/php v0_tailwindcss.php "{query}"
+elif [ -f "/usr/bin/php" ]; then
+    /usr/bin/php v0_tailwindcss.php "{query}"
+fi</string>
 				<key>scriptargtype</key>
 				<integer>0</integer>
 				<key>scriptfile</key>
@@ -241,7 +253,13 @@
 				<key>runningsubtext</key>
 				<string>Searching docs for "{query}"...</string>
 				<key>script</key>
-				<string>php v1_tailwindcss.php "{query}"</string>
+				<string>if [ -f "/opt/homebrew/bin/php" ]; then
+    /opt/homebrew/bin/php v1_tailwindcss.php "{query}"
+elif [ -f "/usr/local/bin/php" ]; then
+    /usr/local/bin/php v1_tailwindcss.php "{query}"
+elif [ -f "/usr/bin/php" ]; then
+    /usr/bin/php v1_tailwindcss.php "{query}"
+fi</string>
 				<key>scriptargtype</key>
 				<integer>0</integer>
 				<key>scriptfile</key>
@@ -335,7 +353,7 @@ Either press `⌘Y` to Quick Look the result, or press `&lt;enter&gt;` to open i
 	<key>variablesdontexport</key>
 	<array/>
 	<key>version</key>
-	<string>2.0.0</string>
+	<string>2.0.1</string>
 	<key>webaddress</key>
 	<string>https://github.com/clnt/alfred-tailwindcss-docs</string>
 </dict>
diff --git a/tailwindcss.php b/tailwindcss.php
@@ -2,72 +2,48 @@
 
 use Alfred\Workflows\Workflow;
 
-use AlgoliaSearch\Client as Algolia;
-use AlgoliaSearch\Version as AlgoliaUserAgent;
+use Algolia\AlgoliaSearch\SearchClient as Algolia;
+use Algolia\AlgoliaSearch\Support\UserAgent as AlgoliaUserAgent;
 
 require __DIR__ . '/vendor/autoload.php';
+require __DIR__ . '/functions.php';
 
 $query = $argv[1];
-//$branch = empty($_ENV['branch']) ? 'master' : $_ENV['branch'];
-//$subtext = empty($_ENV['alfred_theme_subtext']) ? '0' : $_ENV['alfred_theme_subtext'];
 
 $workflow = new Workflow;
-$parsedown = new Parsedown;
-$algolia = new Algolia('R90K1756AM', 'a6e52654d6b591febdf42b07e0e7374a');
+$algolia = Algolia::create('R90K1756AM', 'a6e52654d6b591febdf42b07e0e7374a');
 
-AlgoliaUserAgent::addSuffixUserAgentSegment('TailwindCSS Alfred Workflow', '2.0.0');
+AlgoliaUserAgent::addCustomUserAgent('TailwindCSS Alfred Workflow', '2.0.1');
 
-$index = $algolia->initIndex('v2_tailwindcss');
-$search = $index->search($query);
-$results = $search['hits'];
-
-$subtextSupported = $subtext === '0' || $subtext === '2';
+$results = getResults($algolia, 'v2_tailwindcss', $query);
 
 if (empty($results)) {
-    if (empty($results)) {
-        $workflow->result()
-            ->title('No matches')
-            ->icon('google.png')
-            ->subtitle("No match found in the docs. Search Google for: \"TailwindCSS+{$query}\"")
-            ->arg("https://www.google.com/search?q=tailwindcss+{$query}")
-            ->quicklookurl("https://www.google.com/search?q=tailwindcss+{$query}")
-            ->valid(true);
+    $workflow->result()
+        ->title('No matches')
+        ->icon('google.png')
+        ->subtitle("No match found in the docs. Search Google for: \"TailwindCSS+{$query}\"")
+        ->arg("https://www.google.com/search?q=tailwindcss+{$query}")
+        ->quicklookurl("https://www.google.com/search?q=tailwindcss+{$query}")
+        ->valid(true);
 
-        echo $workflow->output();
-        exit;
-    }
+    echo $workflow->output();
     exit;
 }
 
-$urls = [];
-
-
 foreach ($results as $hit) {
-    $highestLvl = $hit['hierarchy']['lvl6'] ? 6 : (
-        $hit['hierarchy']['lvl5'] ? 5 : (
-            $hit['hierarchy']['lvl4'] ? 4 : (
-                $hit['hierarchy']['lvl3'] ? 3 : (
-                    $hit['hierarchy']['lvl2'] ? 2 : (
-                        $hit['hierarchy']['lvl1'] ? 1 : 0
-                    )
-                )
-            )
-        )
-    );
+    list($title, $titleLevel) = getTitle($hit);
 
-    $title = $hit['hierarchy']['lvl' . $highestLvl];
-    $currentLvl = 0;
-    $subtitle = $hit['hierarchy']['lvl0'];
-    while ($currentLvl < $highestLvl) {
-        $currentLvl = $currentLvl + 1;
-        $subtitle = $subtitle . ' » ' . $hit['hierarchy']['lvl' . $currentLvl];
+    if ($title === null) {
+        continue;
     }
 
+    $title = html_entity_decode($title);
+
     $workflow->result()
         ->uid($hit['objectID'])
         ->title($title)
         ->autocomplete($title)
-        ->subtitle($subtitle)
+        ->subtitle(html_entity_decode(getSubtitle($hit, $titleLevel)))
         ->arg($hit['url'])
         ->quicklookurl($hit['url'])
         ->valid(true);
diff --git a/v0_tailwindcss.php b/v0_tailwindcss.php
@@ -2,72 +2,48 @@
 
 use Alfred\Workflows\Workflow;
 
-use AlgoliaSearch\Client as Algolia;
-use AlgoliaSearch\Version as AlgoliaUserAgent;
+use Algolia\AlgoliaSearch\SearchClient as Algolia;
+use Algolia\AlgoliaSearch\Support\UserAgent as AlgoliaUserAgent;
 
 require __DIR__ . '/vendor/autoload.php';
+require __DIR__ . '/functions.php';
 
 $query = $argv[1];
-//$branch = empty($_ENV['branch']) ? 'master' : $_ENV['branch'];
-//$subtext = empty($_ENV['alfred_theme_subtext']) ? '0' : $_ENV['alfred_theme_subtext'];
 
 $workflow = new Workflow;
-$parsedown = new Parsedown;
-$algolia = new Algolia('R90K1756AM', 'a6e52654d6b591febdf42b07e0e7374a');
+$algolia = Algolia::create('R90K1756AM', 'a6e52654d6b591febdf42b07e0e7374a');
 
-AlgoliaUserAgent::addSuffixUserAgentSegment('TailwindCSS Alfred Workflow', '2.0.0');
+AlgoliaUserAgent::addCustomUserAgent('TailwindCSS Alfred Workflow', '2.0.1');
 
-$index = $algolia->initIndex('v0_tailwindcss');
-$search = $index->search($query);
-$results = $search['hits'];
-
-$subtextSupported = $subtext === '0' || $subtext === '2';
+$results = getResults($algolia, 'v0_tailwindcss', $query);
 
 if (empty($results)) {
-    if (empty($results)) {
-        $workflow->result()
-            ->title('No matches')
-            ->icon('google.png')
-            ->subtitle("No match found in the docs. Search Google for: \"TailwindCSS+{$query}\"")
-            ->arg("https://www.google.com/search?q=tailwindcss+{$query}")
-            ->quicklookurl("https://www.google.com/search?q=tailwindcss+{$query}")
-            ->valid(true);
+    $workflow->result()
+        ->title('No matches')
+        ->icon('google.png')
+        ->subtitle("No match found in the docs. Search Google for: \"TailwindCSS+{$query}\"")
+        ->arg("https://www.google.com/search?q=tailwindcss+{$query}")
+        ->quicklookurl("https://www.google.com/search?q=tailwindcss+{$query}")
+        ->valid(true);
 
-        echo $workflow->output();
-        exit;
-    }
+    echo $workflow->output();
     exit;
 }
 
-$urls = [];
-
-
 foreach ($results as $hit) {
-    $highestLvl = $hit['hierarchy']['lvl6'] ? 6 : (
-        $hit['hierarchy']['lvl5'] ? 5 : (
-            $hit['hierarchy']['lvl4'] ? 4 : (
-                $hit['hierarchy']['lvl3'] ? 3 : (
-                    $hit['hierarchy']['lvl2'] ? 2 : (
-                        $hit['hierarchy']['lvl1'] ? 1 : 0
-                    )
-                )
-            )
-        )
-    );
+    list($title, $titleLevel) = getTitle($hit);
 
-    $title = $hit['hierarchy']['lvl' . $highestLvl];
-    $currentLvl = 0;
-    $subtitle = $hit['hierarchy']['lvl0'];
-    while ($currentLvl < $highestLvl) {
-        $currentLvl = $currentLvl + 1;
-        $subtitle = $subtitle . ' » ' . $hit['hierarchy']['lvl' . $currentLvl];
+    if ($title === null) {
+        continue;
     }
 
+    $title = html_entity_decode($title);
+
     $workflow->result()
         ->uid($hit['objectID'])
         ->title($title)
         ->autocomplete($title)
-        ->subtitle($subtitle)
+        ->subtitle(html_entity_decode(getSubtitle($hit, $titleLevel)))
         ->arg($hit['url'])
         ->quicklookurl($hit['url'])
         ->valid(true);
diff --git a/v1_tailwindcss.php b/v1_tailwindcss.php

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "clnt/alfred-tailwindcss-docs",`
`3`		`- "description": "An ultra-fast TailwindCSS docs search workflow for Alfred 3.",`
`4`		`- "version": "1.1.0",`
	`3`	`+ "description": "An ultra-fast TailwindCSS docs search workflow for Alfred 4.",`
	`4`	`+ "version": "2.0.1",`
`5`	`5`	`"keywords": ["alfred", "alfred-workflow", "tailwindcss", "algolia"],`
`6`	`6`	`"homepage": "https://github.com/clnt",`
`7`	`7`	`"support": {`
`@@ -11,7 +11,6 @@`
`11`	`11`	`"license": "MIT",`
`12`	`12`	`"require": {`
`13`	`13`	`"joetannenbaum/alfred-workflow": "^0.1.0",`
`14`		`- "algolia/algoliasearch-client-php": "^1.27",`
`15`		`- "erusev/parsedown": "^1.7"`
	`14`	`+ "algolia/algoliasearch-client-php": "^2.7"`
`16`	`15`	`}`
`17`	`16`	`}`