Add search for word / selection under cursor (#22)

* Add search for word / selection under cursor

* lint everything

Author: chrishrb

README.md

@@ -10,6 +10,7 @@
 * open plugins in the browser with a single command (e.g. in lazy, packer you can hover over a plugin name, simply press `gx` and you get to the github page of the plugin)
 * open github issues directly in the browser (e.g. `Fixes #22` opens `https://github.com/chrishrb/gx.nvim/issues/22`)
 * dependencies from `package.json` (e.g. line `"express": "^4.18.2",` in the `package.json` opens `https://www.npmjs.com/package/express`)
+* if there is no url found under the cursor, the word/selection is automatically searched on the web
 * support for macOS, Linux and Windows
 * more to come (jira issues, ..)
 
@@ -39,6 +40,10 @@ require("lazy").setup({
         plugin = true, -- open plugin links in lua (e.g. packer, lazy, ..)
         github = true, -- open github issues
         package_json = true, -- open dependencies from package.json
+        search = true, -- search the web/selection on the web if nothing else is found
+      },
+      handler_options = {
+        search_engine = "google", -- you can select between google, bing and duckduckgo
       },
     } end,
   },

lua/gx/handler.lua

@@ -5,6 +5,7 @@ local url_handler = require("gx.handlers.url")
 local github_handler = require("gx.handlers.github")
 local commit_handler = require("gx.handlers.commit")
 local markdown_handler = require("gx.handlers.markdown")
+local search_handler = require("gx.handlers.search")
 
 local M = {}
 
@@ -20,7 +21,7 @@ local function add_handler(handlers, handler, active)
 end
 
 -- handler function
-function M.get_url(mode, line, activated_handlers)
+function M.get_url(mode, line, activated_handlers, handler_options)
   local url
   local handlers = {}
   local tkeys = {}
@@ -32,6 +33,7 @@ function M.get_url(mode, line, activated_handlers)
   add_handler(handlers, commit_handler, activated_handlers.github)
   add_handler(handlers, markdown_handler, true)
   add_handler(handlers, url_handler, true)
+  add_handler(handlers, search_handler, activated_handlers.search)
   -- ###
 
   for k in pairs(handlers) do
@@ -40,7 +42,7 @@ function M.get_url(mode, line, activated_handlers)
   table.sort(tkeys)
 
   for _, k in ipairs(tkeys) do
-    url = handlers[k].handle(mode, line)
+    url = handlers[k].handle(mode, line, handler_options)
 
     if url then
       break

lua/gx/handlers/commit.lua

@@ -8,7 +8,7 @@ M.filetype = nil
 M.filename = nil
 
 -- navigate to github url for commit
-function M.handle(mode, line)
+function M.handle(mode, line, _)
   local pattern = "(%x%x%x%x%x%x%x+)"
   local commit_hash = helper.find(line, mode, pattern)
   if not commit_hash or #commit_hash > 40 then

lua/gx/handlers/github.lua

@@ -8,7 +8,7 @@ M.filetype = nil
 M.filename = nil
 
 -- navigate to neovim github plugin url
-function M.handle(mode, line)
+function M.handle(mode, line, _)
   local pattern = "%a*%s#(%d*)"
   local github_issue = helper.find(line, mode, pattern)
   if not github_issue then

lua/gx/handlers/markdown.lua

@@ -8,7 +8,7 @@ M.filetype = { "markdown" }
 M.filename = nil
 
 -- navigate to neovim github plugin url
-function M.handle(mode, line)
+function M.handle(mode, line, _)
   local pattern = "%[.*%]%((https?://[a-zA-Z0-9_/%-%.~@\\+#=?&]+)%)"
   local url = helper.find(line, mode, pattern)
   return url

lua/gx/handlers/package_json.lua

@@ -7,7 +7,7 @@ M.filetype = { "json" }
 M.filename = "package.json"
 
 -- navigate to neovim github plugin url
-function M.handle(mode, line)
+function M.handle(mode, line, _)
   local pattern = '["]([^%s]*)["]:'
   local npm_package = helper.find(line, mode, pattern)
   if not npm_package then

lua/gx/handlers/plugin.lua

@@ -7,7 +7,7 @@ M.filetype = { "lua", "vim" }
 M.filename = nil
 
 -- navigate to neovim github plugin url
-function M.handle(mode, line)
+function M.handle(mode, line, _)
   local pattern = "[\"']([^%s~/]*/[^%s~/]*)[\"']"
   local username_repo = helper.find(line, mode, pattern)
   if username_repo then

lua/gx/handlers/search.lua

@@ -0,0 +1,29 @@
+local helper = require("gx.helper")
+local notfier = require("gx.notfier")
+
+local M = {}
+
+-- every filetype and filename
+M.filetype = nil
+M.filename = nil
+
+-- navigate to github url for commit
+function M.handle(mode, line, handler_options)
+  local search_pattern
+
+  if mode == "v" then
+    search_pattern = line
+  else
+    search_pattern = vim.fn.expand("<cword>")
+  end
+
+  local search_engine_url = helper.get_search_url_from_engine(handler_options.search_engine)
+  if search_engine_url == nil then
+    notfier.error("search engine " .. handler_options.search_engine .. " not found!")
+    return
+  end
+
+  return search_engine_url .. helper.urlencode(search_pattern)
+end
+
+return M

lua/gx/handlers/url.lua

@@ -7,13 +7,13 @@ M.filetype = nil
 M.filename = nil
 
 -- get url from line (with http/s)
-function M.handle(mode, line)
-  local pattern = "(https?://[a-zA-Z0-9_/%-%.~@\\+#=?&]+)"
+function M.handle(mode, line, _)
+  local pattern = "(https?://[a-zA-Z0-9_/%-%.~@\\+#=?&:]+)"
   local url = helper.find(line, mode, pattern)
 
   -- match url without http(s)
   if not url then
-    pattern = "([a-zA-Z0-9_/%-%.~@\\+#]+%.[a-zA-Z0-9_/%-%.~@\\+#%=?&]+)"
+    pattern = "([a-zA-Z0-9_/%-%.~@\\+#]+%.[a-zA-Z0-9_/%-%.~@\\+#%=?&:]+)"
     url = helper.find(line, mode, pattern)
     if url then
       return "https://" .. url

lua/gx/helper.lua

@@ -107,4 +107,28 @@ function M.check_filename(handler_filename)
   return false
 end
 
+local char_to_hex = function(c)
+  return string.format("%%%02X", string.byte(c))
+end
+
+function M.urlencode(url)
+  if url == nil then
+    return
+  end
+  url = url:gsub("\n", "\r\n")
+  url = string.gsub(url, "([^%w _%%%-%.~])", char_to_hex)
+  url = url:gsub(" ", "+")
+  return url
+end
+
+function M.get_search_url_from_engine(engine)
+  local search_url = {
+    google = "https://www.google.com/search?q=",
+    bing = "https://www.bing.com/search?q=",
+    duckduckgo = "https://duckduckgo.com/?q=",
+  }
+
+  return search_url[engine]
+end
+
 return M