feature: add random verse querying

README.md

@@ -110,6 +110,8 @@ echo 'export SWORD_PATH="${HOME}/.sword" >> ~/.zshrc'
 | `:BibleVerse`    | `require("bible-verse").cmd()`    | Execute default behaviour set as per `config.default_behaviour`.|
 | `:BibleVerseQuery` or `:BibleVerse query`    | `require("bible-verse").cmd("query")`    | Query Bible verse and display it on the screen as a popup. |
 | `:BibleVerseInsert` or `:BibleVerse insert`    | `require("bible-verse").cmd("insert")`    | Query Bible verse and insert it below the cursor in the current buffer. |
+| `:BibleVerseRandom`    | `:BibleVerse random` | `require("bible-verse").cmd("random")`    | Query random Bible verse and returns a table containing the Book with chapter, the verse and translation name. |
+| `:BibleVerseQueryRandom` or `:BibleVerse queryRandom`    | `require("bible-verse").cmd("queryRandom")`    | Query random Bible verse and display it on the screen as a popup. |
 
 #### Key Bindings
 

lua/bible-verse/commands.lua

@@ -1,6 +1,7 @@
 local Config = require("bible-verse.config")
+local Core = require("bible-verse.core")
 
----@alias BibleVerseCmd "query"|"insert"
+---@alias BibleVerseCmd "query"|"insert"|"random"|"queryRandom"
 ---@alias BibleVerseCmdFunc fun(): nil
 
 local M = {}
@@ -21,11 +22,17 @@ end
 function M.setup()
 	M.commands = {
 		query = function()
-			require("bible-verse.core").query_and_show()
+			Core.query_and_show()
 		end,
 		insert = function()
-			require("bible-verse.core").query_and_insert()
+			Core.query_and_insert()
 		end,
+		random = function()
+			Core.random_query()
+		end,
+		queryRandom = function()
+			Core.query_and_show_random()
+		end
 	}
 
 	-- Check that config is sane
@@ -39,7 +46,7 @@ function M.setup()
 		local command = vim.trim(args.args or "")
 		M.cmd(command)
 	end, {
-		nargs = "?",
+		nargs = "*",
 		desc = "Query bible verses",
 		complete = function(_, line)
 			-- Completed word

lua/bible-verse/core/init.lua

@@ -6,6 +6,7 @@ local Utils = require("bible-verse.utils")
 local Diatheke = require("bible-verse.core.diatheke")
 local Ui = require("bible-verse.core.ui")
 local Highlight = require("bible-verse.core.highlight")
+local random_verse = require("bible-verse.core.random-verse")
 
 local M = {}
 
@@ -110,4 +111,32 @@ function M.query_and_insert()
 	Ui:input(input_conf, on_submit)
 end
 
+--- Returns a random verse
+function M.random_query()
+	return process_query(random_verse(), Config.options.query_format, 0)
+end
+
+--- Query and shows a random verse
+function M.query_and_show_random()
+	local popup_conf = vim.deepcopy(Config.options.ui.popup)
+	local relative_size = Utils.get_relative_size(popup_conf.relative)
+
+	local popup_width = math.ceil(
+		math.min(
+			relative_size.width * popup_conf.size.max_width_percentage,
+			relative_size.width * popup_conf.size.width_percentage
+		)
+	)
+	local popup_max_height = math.ceil(relative_size.height * popup_conf.size.max_height_percentage)
+
+	local query_result = M.random_query()
+
+	popup_conf.size.width = popup_width
+	popup_conf.size.height = Utils.clamp(#query_result, 1, popup_max_height)
+
+	Ui:popup(popup_conf, query_result, function(bufnr, first, last)
+		Highlight.highlight_buf(bufnr, Config.options.highlighter[Config.options.query_format], first, last)
+	end)
+end
+
 return M