spacevim/bundle/telescope.nvim-0.1.8/lua/tests/automated/telescope_spec.lua

local picker = require "telescope.pickers"
local Path = require "plenary.path"

local eq = assert.are.same

local function new_path(unix_path)
  return Path:new(unpack(vim.split(unix_path, "/"))).filename
end

describe("telescope", function()
  describe("Picker", function()
    describe("window_dimensions", function()
      it("", function()
        assert(true)
      end)
    end)

    describe("attach_mappings", function()
      local new_picker = function(a, b)
        a.finder = true
        return picker.new(a, b)
      end

      it("should allow for passing in a function", function()
        local p = new_picker({}, {
          attach_mappings = function()
            return 1
          end,
        })
        eq(1, p.attach_mappings())
      end)

      it("should override an attach mappings passed in by opts", function()
        local called_order = {}
        local p = new_picker({
          attach_mappings = function()
            table.insert(called_order, "opts")
          end,
        }, {
          attach_mappings = function()
            table.insert(called_order, "default")
          end,
        })

        p.attach_mappings()

        eq({ "default", "opts" }, called_order)
      end)
    end)
  end)

  describe("Sorters", function()
    describe("generic_fuzzy_sorter", function()
      it("sort matches well", function()
        local sorter = require("telescope.sorters").get_generic_fuzzy_sorter()

        local exact_match = sorter:score("hello", { ordinal = "hello" })
        local no_match = sorter:score("abcdef", { ordinal = "ghijkl" })
        local ok_match = sorter:score("abcdef", { ordinal = "ab" })

        assert(exact_match < no_match, "exact match better than no match")
        assert(exact_match < ok_match, "exact match better than ok match")
        assert(ok_match < no_match, "ok match better than no match")
      end)

      it("sorts multiple finds better", function()
        local sorter = require("telescope.sorters").get_generic_fuzzy_sorter()

        local multi_match = sorter:score("generics", "exercises/generics/generics2.rs")
        local one_match = sorter:score("abcdef", "exercises/generics/README.md")

        -- assert(multi_match < one_match)
      end)
    end)

    describe("fuzzy_file", function()
      it("sort matches well", function()
        local sorter = require("telescope.sorters").get_fuzzy_file()

        local exact_match = sorter:score("abcdef", { ordinal = "abcdef" })
        local no_match = sorter:score("abcdef", { ordinal = "ghijkl" })
        local ok_match = sorter:score("abcdef", { ordinal = "ab" })

        assert(exact_match < no_match, string.format("Exact match better than no match: %s %s", exact_match, no_match))
        assert(exact_match < ok_match, string.format("Exact match better than OK match: %s %s", exact_match, ok_match))
        assert(ok_match < no_match, "OK match better than no match")
      end)

      it("sorts matches after last os sep better", function()
        local sorter = require("telescope.sorters").get_fuzzy_file()

        local better_match = sorter:score("aaa", { ordinal = new_path "bbb/aaa" })
        local worse_match = sorter:score("aaa", { ordinal = new_path "aaa/bbb" })

        assert(better_match < worse_match, "Final match should be stronger")
      end)

      pending("sorts multiple finds better", function()
        local sorter = require("telescope.sorters").get_fuzzy_file()

        local multi_match = sorter:score("generics", { ordinal = "exercises/generics/generics2.rs" })
        local one_match = sorter:score("abcdef", { ordinal = "exercises/generics/README.md" })

        assert(multi_match < one_match)
      end)
    end)

    describe("fzy", function()
      local sorter = require("telescope.sorters").get_fzy_sorter()
      local function score(prompt, line)
        line = new_path(line)
        return sorter:score(prompt, { ordinal = line }, function(val)
          return val
        end, function()
          return -1
        end)
      end

      describe("matches", function()
        it("exact matches", function()
          assert.True(score("a", "a") >= 0)
          assert.True(score("a.bb", "a.bb") >= 0)
        end)
        it("ignore case", function()
          assert.True(score("AbB", "abb") >= 0)
          assert.True(score("abb", "ABB") >= 0)
        end)
        it("partial matches", function()
          assert.True(score("a", "ab") >= 0)
          assert.True(score("a", "ba") >= 0)
          assert.True(score("aba", "baabbaab") >= 0)
        end)
        it("with delimiters between", function()
          assert.True(score("abc", "a|b|c") >= 0)
        end)
        it("with empty query", function()
          assert.True(score("", "") >= 0)
          assert.True(score("", "a") >= 0)
        end)
        it("rejects non-matches", function()
          assert.True(score("a", "") < 0)
          assert.True(score("a", "b") < 0)
          assert.True(score("aa", "a") < 0)
          assert.True(score("ba", "a") < 0)
          assert.True(score("ab", "a") < 0)
        end)
      end)

      describe("scoring", function()
        it("prefers beginnings of words", function()
          assert.True(score("amor", "app/models/order") < score("amor", "app/models/zrder"))
        end)
        it("prefers consecutive letters", function()
          assert.True(score("amo", "app/models/foo") < score("amo", "app/m/foo"))
          assert.True(score("erf", "perfect") < score("erf", "terrific"))
        end)
        it("prefers contiguous over letter following period", function()
          assert.True(score("gemfil", "Gemfile") < score("gemfil", "Gemfile.lock"))
        end)
        it("prefers shorter matches", function()
          assert.True(score("abce", "abcdef") < score("abce", "abc de"))
          assert.True(score("abc", "    a b c ") < score("abc", " a  b  c "))
          assert.True(score("abc", " a b c    ") < score("abc", " a  b  c "))
        end)
        it("prefers shorter candidates", function()
          assert.True(score("test", "tests") < score("test", "testing"))
        end)
        it("prefers matches at the beginning", function()
          assert.True(score("ab", "abbb") < score("ab", "babb"))
          assert.True(score("test", "testing") < score("test", "/testing"))
        end)
        it("prefers matches at some locations", function()
          assert.True(score("a", "/a") < score("a", "ba"))
          assert.True(score("a", "bA") < score("a", "ba"))
          assert.True(score("a", ".a") < score("a", "ba"))
        end)
      end)

      local function positions(prompt, line)
        return sorter:highlighter(prompt, new_path(line))
      end

      describe("positioning", function()
        it("favors consecutive positions", function()
          assert.same({ 1, 5, 6 }, positions("amo", "app/models/foo"))
        end)
        it("favors word beginnings", function()
          assert.same({ 1, 5, 12, 13 }, positions("amor", "app/models/order"))
        end)
        it("works when there are no bonuses", function()
          assert.same({ 2, 4 }, positions("as", "tags"))
          assert.same({ 3, 8 }, positions("as", "examples.txt"))
        end)
        it("favors smaller groupings of positions", function()
          assert.same({ 3, 5, 7 }, positions("abc", "a/a/b/c/c"))
          assert.same({ 3, 5 }, positions("ab", "caacbbc"))
        end)
        it("handles exact matches", function()
          assert.same({ 1, 2, 3 }, positions("foo", "foo"))
        end)
        it("ignores empty requests", function()
          assert.same({}, positions("", ""))
          assert.same({}, positions("", "foo"))
          assert.same({}, positions("foo", ""))
        end)
      end)
    end)

    describe("layout_strategies", function()
      describe("center", function()
        it("should handle large terminals", function()
          -- TODO: This could call layout_strategies.center w/ some weird edge case.
          -- and then assert stuff about the dimensions.
        end)
      end)
    end)
  end)
end)