fix(#668): Auto instantiate when requesting files

Author: kristijanhusak

lua/orgmode/api/agenda.lua

@@ -1,10 +1,10 @@
 local Date = require('orgmode.objects.date')
 local orgmode = require('orgmode')
 
----@class OrgAgenda
+---@class OrgApiAgenda
 local OrgAgenda = {}
 
----@alias OrgAgendaFilter string see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
+---@alias OrgApiAgendaFilter string see Filters to apply to the current view. See `:help orgmode-org_agenda_filter` for more information
 
 local function get_date(date, name)
   if not date then
@@ -20,60 +20,47 @@ local function get_date(date, name)
   error(('Invalid format for "%s" date in Org Agenda'):format(name))
 end
 
----@return table
-local function org_instance()
-  local org = orgmode.instance()
-  if not org then
-    error('Orgmode was not set up. Run require("orgmode").setup() first.')
-  end
-  org:init()
-  return org
-end
-
----@class OrgAgendaOptions
----@field filters? OrgAgendaFilter
+---@class OrgApiAgendaOptions
+---@field filters? OrgApiAgendaFilter
 ---@field from? string | OrgDate
 ---@field span? number | 'day' | 'week' | 'month' | 'year'
 
----@param options? OrgAgendaOptions
+---@param options? OrgApiAgendaOptions
 function OrgAgenda.agenda(options)
   options = options or {}
-  local org = org_instance()
   if options.filters and options.filters ~= '' then
-    org.agenda.filters:parse(options.filters, true)
+    orgmode.agenda.filters:parse(options.filters, true)
   end
   local from = get_date(options.from, 'from')
-  org.agenda:agenda({
+  orgmode.agenda:agenda({
     from = from,
     span = options.span,
   })
 end
 
 ---@class OrgAgendaTodosOptions
----@field filters? OrgAgendaFilter
+---@field filters? OrgApiAgendaFilter
 
 ---@param options? OrgAgendaTodosOptions
 function OrgAgenda.todos(options)
   options = options or {}
-  local org = org_instance()
   if options.filters and options.filters ~= '' then
-    org.agenda.filters:parse(options.filters, true)
+    orgmode.agenda.filters:parse(options.filters, true)
   end
-  org.agenda:todos()
+  orgmode.agenda:todos()
 end
 
 ---@class OrgAgendaTagsOptions
----@field filters? OrgAgendaFilter
+---@field filters? OrgApiAgendaFilter
 ---@field todo_only? boolean
 
 ---@param options? OrgAgendaTagsOptions
 function OrgAgenda.tags(options)
   options = options or {}
-  local org = org_instance()
   if options.filters and options.filters ~= '' then
-    org.agenda.filters:parse(options.filters, true)
+    orgmode.agenda.filters:parse(options.filters, true)
   end
-  org.agenda:tags({
+  orgmode.agenda:tags({
     todo_only = options.todo_only,
   })
 end

lua/orgmode/init.lua

@@ -1,7 +1,7 @@
 _G.orgmode = _G.orgmode or {}
 local ts_revision = 'f8c6b1e72f82f17e41004e04e15f62a83ecc27b0'
 local setup_ts_grammar_used = false
----@type Org
+---@type Org | nil
 local instance = nil
 
 local auto_instance_keys = {
@@ -23,16 +23,16 @@ local auto_instance_keys = {
 ---@field org_mappings OrgMappings
 ---@field notifications OrgNotifications
 local Org = {}
-
-function Org:new()
-  local data = {}
-  setmetatable(data, self)
-  self.__index = function(tbl, key)
-    if auto_instance_keys[key] and not instance then
+setmetatable(Org, {
+  __index = function(tbl, key)
+    if auto_instance_keys[key] then
       Org.instance()
     end
     return rawget(tbl, key)
-  end
+  end,
+})
+
+function Org:new()
   self.initialized = false
   self:setup_autocmds()
   return self
@@ -142,7 +142,7 @@ function Org.setup(opts)
   config:setup_ts_predicates()
   vim.defer_fn(function()
     if config.notifications.enabled and #vim.api.nvim_list_uis() > 0 then
-      Org.instance().files:load():next(vim.schedule_wrap(function()
+      Org.files:load():next(vim.schedule_wrap(function()
         instance.notifications = require('orgmode.notifications')
           :new({
             files = Org.files,
@@ -209,11 +209,11 @@ function Org.cron(opts)
   if not config.notifications.cron_enabled then
     return vim.cmd([[qa!]])
   end
-  Org.instance().files:load():next(vim.schedule_wrap(function()
+  Org.files:load():next(vim.schedule_wrap(function()
     ---@diagnostic disable-next-line: inject-field
     instance.notifications = require('orgmode.notifications')
       :new({
-        files = instance.files,
+        files = Org.files,
       })
       :cron()
   end))
@@ -227,6 +227,13 @@ function Org.instance()
   return instance
 end
 
+function Org.destroy()
+  if instance then
+    instance = nil
+    collectgarbage()
+  end
+end
+
 function _G.orgmode.statusline()
   if not instance or not instance.initialized then
     return ''

tests/plenary/autoload_spec.lua

@@ -0,0 +1,21 @@
+local orgmode = require('orgmode')
+
+describe('Autoload', function()
+  it('should autoload dependencies when requested', function()
+    local org = orgmode.setup({
+      org_agenda_files = vim.fn.getcwd() .. '/tests/plenary/fixtures/*',
+      org_default_notes_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org',
+    })
+    assert.is.False(org.initialized)
+    assert.is.Nil(rawget(org, 'files'))
+    assert.is.Nil(rawget(org, 'agenda'))
+    assert.is.Nil(rawget(org, 'capture'))
+    assert.is.Nil(rawget(org, 'org_mappings'))
+    org.files:all()
+    assert.is.True(org.initialized)
+    assert.is.Not.Nil(rawget(org, 'files'))
+    assert.is.Not.Nil(rawget(org, 'agenda'))
+    assert.is.Not.Nil(rawget(org, 'capture'))
+    assert.is.Not.Nil(rawget(org, 'org_mappings'))
+  end)
+end)

tests/plenary/init_spec.lua

@@ -10,15 +10,15 @@ describe('Init', function()
     local todo_archive_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/todo.org_archive'
     local refile_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/refile.org'
     local txt_file = vim.fn.getcwd() .. '/tests/plenary/fixtures/text_notes.txt'
-    assert.is.Nil(org.files)
-    assert.is.Nil(org.agenda)
-    assert.is.Nil(org.capture)
-    assert.is.Nil(org.org_mappings)
+    assert.is.Nil(rawget(org, 'files'))
+    assert.is.Nil(rawget(org, 'agenda'))
+    assert.is.Nil(rawget(org, 'capture'))
+    assert.is.Nil(rawget(org, 'org_mappings'))
     org:init()
-    assert.is.Not.Nil(org.files)
-    assert.is.Not.Nil(org.agenda)
-    assert.is.Not.Nil(org.capture)
-    assert.is.Not.Nil(org.org_mappings)
+    assert.is.Not.Nil(rawget(org, 'files'))
+    assert.is.Not.Nil(rawget(org, 'agenda'))
+    assert.is.Not.Nil(rawget(org, 'capture'))
+    assert.is.Not.Nil(rawget(org, 'org_mappings'))
     assert.is.error(function()
       return org.files:get(txt_file)
     end)