Skip to content

Commit

Permalink
Revert "fix: action mt so we can again concat actions from two differ…
Browse files Browse the repository at this point in the history
…ent tables (nvim-telescope#1143)" (nvim-telescope#1486)

This reverts commit 6daf35c.
  • Loading branch information
Conni2461 authored Nov 23, 2021
1 parent 7695d22 commit 1c57cc6
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 179 deletions.
64 changes: 12 additions & 52 deletions lua/telescope/actions/mt.lua
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,7 @@ local run_replace_or_original = function(replacements, original_func, ...)
return original_func(...)
end

local append_action_copy = function(new, v, old)
table.insert(new, v)
new._func[v] = old._func[v]
new._static_pre[v] = old._static_pre[v]
new._pre[v] = old._pre[v]
new._replacements[v] = old._replacements[v]
new._static_post[v] = old._static_post[v]
new._post[v] = old._post[v]
end

--TODO(conni2461): Not a fan of this solution/hack. Needs to be addressed
local all_mts = {}

--- an action is metatable which allows replacement(prepend or append) of the function
---@class Action
---@field _func table<string, function>: the original action function
---@field _static_pre table<string, function>: will allways run before the function even if its replaced
---@field _pre table<string, function>: the functions that will run before the action
---@field _replacements table<string, function>: the function that replaces this action
---@field _static_post table<string, function>: will allways run after the function even if its replaced
---@field _post table<string, function>: the functions that will run after the action
action_mt.create = function()
action_mt.create = function(mod)
local mt = {
__call = function(t, ...)
local values = {}
Expand All @@ -48,7 +27,7 @@ action_mt.create = function()
end

local result = {
run_replace_or_original(t._replacements[action_name], t._func[action_name], ...),
run_replace_or_original(t._replacements[action_name], mod[action_name], ...),
}
for _, res in ipairs(result) do
table.insert(values, res)
Expand All @@ -66,23 +45,18 @@ action_mt.create = function()
end,

__add = function(lhs, rhs)
local new_action = setmetatable({}, action_mt.create())
local new_actions = {}
for _, v in ipairs(lhs) do
append_action_copy(new_action, v, lhs)
table.insert(new_actions, v)
end

for _, v in ipairs(rhs) do
append_action_copy(new_action, v, rhs)
end
new_action.clear = function()
lhs.clear()
rhs.clear()
table.insert(new_actions, v)
end

return new_action
return setmetatable(new_actions, getmetatable(lhs))
end,

_func = {},
_static_pre = {},
_pre = {},
_replacements = {},
Expand Down Expand Up @@ -146,47 +120,33 @@ action_mt.create = function()
return self
end

table.insert(all_mts, mt)
return mt
end

action_mt.transform = function(k, mt, _, v)
action_mt.transform = function(k, mt, mod, v)
local res = setmetatable({ k }, mt)
if type(v) == "table" then
res._static_pre[k] = v.pre
res._static_post[k] = v.post
res._func[k] = v.action
else
res._func[k] = v
mod[k] = v.action
end
return res
end

action_mt.transform_mod = function(mod)
local mt = action_mt.create(mod)

-- Pass the metatable of the module if applicable.
-- This allows for custom errors, lookups, etc.
local redirect = setmetatable({}, getmetatable(mod) or {})

for k, v in pairs(mod) do
local mt = action_mt.create()
redirect[k] = action_mt.transform(k, mt, _, v)
redirect[k] = action_mt.transform(k, mt, mod, v)
end

redirect._clear = function()
for k, v in pairs(redirect) do
if k ~= "_clear" then
pcall(v.clear)
end
end
end
redirect._clear = mt.clear

return redirect
end

action_mt.clear_all = function()
for _, v in ipairs(all_mts) do
pcall(v.clear)
end
end

return action_mt
10 changes: 4 additions & 6 deletions lua/telescope/mappings.lua
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ mappings.apply_keymap = function(prompt_bufnr, attach_mappings, buffer_keymap)
end
end
end

vim.cmd(
string.format([[autocmd BufDelete %s :lua require('telescope.mappings').clear(%s)]], prompt_bufnr, prompt_bufnr)
)
end

mappings.execute_keymap = function(prompt_bufnr, keymap_identifier)
Expand All @@ -233,12 +237,6 @@ mappings.execute_keymap = function(prompt_bufnr, keymap_identifier)
end

mappings.clear = function(prompt_bufnr)
require("telescope.actions.mt").clear_all()
-- TODO(conni2461): This seems like the better solution but it won't clear actions that were never mapped
-- for _, v in ipairs(keymap_store[prompt_bufnr]) do
-- pcall(v.clear)
-- end

keymap_store[prompt_bufnr] = nil
end

Expand Down
8 changes: 7 additions & 1 deletion lua/telescope/pickers.lua
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ local channel = require("plenary.async.control").channel
local popup = require "plenary.popup"

local actions = require "telescope.actions"
local action_set = require "telescope.actions.set"
local config = require "telescope.config"
local debounce = require "telescope.debounce"
local deprecated = require "telescope.deprecated"
Expand Down Expand Up @@ -47,6 +48,12 @@ function Picker:new(opts)
error "layout_strategy and get_window_options are not compatible keys"
end

-- Reset actions for any replaced / enhanced actions.
-- TODO: Think about how we could remember to NOT have to do this...
-- I almost forgot once already, cause I'm not smart enough to always do it.
actions._clear()
action_set._clear()

deprecated.options(opts)

local layout_strategy = get_default(opts.layout_strategy, config.values.layout_strategy)
Expand Down Expand Up @@ -1288,7 +1295,6 @@ function pickers.on_close_prompt(prompt_bufnr)
end

picker.close_windows(status)
mappings.clear(prompt_bufnr)
end

function pickers.on_resize_window(prompt_bufnr)
Expand Down
123 changes: 3 additions & 120 deletions lua/tests/automated/action_spec.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ local action_set = require "telescope.actions.set"

local transform_mod = require("telescope.actions.mt").transform_mod

local eq = assert.are.same
local eq = function(a, b)
assert.are.same(a, b)
end

describe("actions", function()
it("should allow creating custom actions", function()
Expand Down Expand Up @@ -205,29 +207,6 @@ describe("actions", function()
eq(true, called_post)
end)

it("static_pre static_post", function()
local called_pre = false
local called_post = false
local static_post = 0
local a = transform_mod {
x = {
pre = function()
called_pre = true
end,
action = function()
return "x"
end,
post = function()
called_post = true
end,
},
}

eq("x", a.x())
eq(true, called_pre)
eq(true, called_post)
end)

it("can call both", function()
local a = transform_mod {
x = function()
Expand Down Expand Up @@ -319,102 +298,6 @@ describe("actions", function()
eq("modified: 5", a.x(5))
end)

it("handles add with two different tables", function()
local count_a = 0
local count_b = 0
local a = transform_mod {
x = function()
count_a = count_a + 1
end,
}
local b = transform_mod {
y = function()
count_b = count_b + 1
end,
}

local called_count = 0
local count_inc = function()
called_count = called_count + 1
end

a.x:enhance {
post = count_inc,
}
b.y:enhance {
post = count_inc,
}

local x_plus_y = a.x + b.y
x_plus_y()

eq(2, called_count)
eq(1, count_a)
eq(1, count_b)
end)

it("handles tripple concat with static pre post", function()
local count_a = 0
local count_b = 0
local count_c = 0
local static_pre = 0
local static_post = 0
local a = transform_mod {
x = {
pre = function()
static_pre = static_pre + 1
end,
action = function()
count_a = count_a + 1
end,
post = function()
static_post = static_post + 1
end,
},
}
local b = transform_mod {
y = {
pre = function()
static_pre = static_pre + 1
end,
action = function()
count_b = count_b + 1
end,
post = function()
static_post = static_post + 1
end,
},
}
local c = transform_mod {
z = {
pre = function()
static_pre = static_pre + 1
end,
action = function()
count_c = count_c + 1
end,
post = function()
static_post = static_post + 1
end,
},
}

local replace_count = 0
a.x:replace(function()
replace_count = replace_count + 1
end)

local x_plus_y_plus_z = a.x + b.y + c.z
x_plus_y_plus_z()

eq(0, count_a)
eq(1, count_b)
eq(1, count_c)
eq(1, replace_count)
eq(3, static_pre)
eq(3, static_post)
end)

describe("action_set", function()
it("can replace `action_set.edit`", function()
action_set.edit:replace(function(_, arg)
Expand Down

0 comments on commit 1c57cc6

Please sign in to comment.