Setup ci and tests

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  unit_tests:
+    name: unit tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04]
+        rev: [stable]
+        include:
+          - os: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.rev }}
+
+      - name: Prepare
+        run: |
+          make prepare
+
+      - name: Run tests
+        run: |
+          nvim --version
+          make test
+

.github/workflows/lint.yml

@@ -27,4 +27,4 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
-          args: --color always --check lua/
+          args: --color always --check lua/ test/

Makefile

@@ -1,4 +1,10 @@
-.PHONY: lint
+.PHONY: prepare test lint
+
+prepare:
+	git clone --depth 1 https://github.com/nvim-lua/plenary.nvim .ci/vendor/pack/vendor/start/plenary.nvim
+
+test:
+	nvim --headless --clean -u scripts/minimal_init.lua -c "PlenaryBustedDirectory test/ { minimal_init = 'scripts/minimal_init.lua', sequential = true }"
 
 lint:
 	luacheck lua/toggle

lua/toggle/mapping.lua

@@ -11,7 +11,7 @@ M.__get_mapping = function(word)
 end
 
 M.__register = function(list)
-    for i, value in ipairs(list) do
+    for i, value in ipairs(list or {}) do
         if i == #list then
             mapping[value] = list[1]
         else

scripts/minimal_init.lua

@@ -0,0 +1,9 @@
+vim.opt.runtimepath:append('.')
+
+local cwd = vim.fn.getcwd()
+vim.cmd(string.format([[set packpath=%s/.ci/vendor]], cwd))
+vim.cmd([[packloadall]])
+
+vim.o.swapfile = false
+vim.bo.swapfile = false
+

test/defaults_spec.lua

@@ -0,0 +1,16 @@
+local defaults = require('toggle.defaults')
+
+describe('defaults', function()
+    it('no duplicates in mappings', function()
+        local seen = {}
+        for _, mapping in ipairs(defaults) do
+            for _, word in ipairs(mapping) do
+                if seen[word] then
+                    assert(false)
+                else
+                    seen[word] = true
+                end
+            end
+        end
+    end)
+end)

test/mapping_spec.lua

@@ -0,0 +1,57 @@
+local mapping = require('toggle.mapping')
+
+describe('mapping', function()
+    it('__reset clears mapping', function()
+        mapping.__register({ 'foo', 'bar' })
+        mapping.__reset()
+        assert(mapping.__has_mapping('foo') == false)
+        assert(mapping.__has_mapping('bar') == false)
+    end)
+
+    it('__get_mapping - existing mapping', function()
+        mapping.__reset()
+        mapping.__register({ 'foo', 'bar' })
+        assert(mapping.__get_mapping('foo') == 'bar')
+        assert(mapping.__get_mapping('bar') == 'foo')
+    end)
+
+    it('__get_mapping - chain of mappings', function()
+        mapping.__reset()
+        mapping.__register({ 'foo', 'bar', 'zoo' })
+        assert(mapping.__get_mapping('foo') == 'bar')
+        assert(mapping.__get_mapping('bar') == 'zoo')
+        assert(mapping.__get_mapping('zoo') == 'foo')
+    end)
+
+    it('__get_mapping - non-existing mapping', function()
+        mapping.__reset()
+        assert(mapping.__get_mapping('non-existing') == nil)
+    end)
+
+    it('__register - empty', function()
+        mapping.__register({})
+    end)
+
+    it('__register - null', function()
+        mapping.__register(nil)
+    end)
+
+    it('__register - happy path', function()
+        mapping.__reset()
+        mapping.__register({ 'foo', 'bar', 'zoo' })
+        assert(mapping.__has_mapping('foo'))
+        assert(mapping.__has_mapping('bar'))
+        assert(mapping.__has_mapping('zoo'))
+    end)
+
+    it('__has_mapping - existing map', function()
+        mapping.__reset()
+        mapping.__register({ 'foo', 'bar' })
+        assert(mapping.__has_mapping('foo'))
+        assert(mapping.__has_mapping('bar'))
+    end)
+
+    it('__has_mapping - nil', function()
+        assert(mapping.__has_mapping(nil) == false)
+    end)
+end)

test/test_files/test_1.txt

@@ -0,0 +1,3 @@
+false
+false,
+<

test/toggle_spec.lua

@@ -0,0 +1,38 @@
+local toggle = require('toggle')
+
+local function open_file_at(file_to_open, row, column, callback)
+    local full_path = vim.fs.joinpath(vim.fn.getcwd(), file_to_open)
+    vim.api.nvim_command('edit ' .. full_path)
+    vim.api.nvim_win_set_cursor(0, { row, column })
+    callback()
+    vim.cmd(':bd!')
+end
+
+local function get_character_under_cursor()
+    local coords = vim.api.nvim_win_get_cursor(0)
+    local line = vim.api.nvim_get_current_line()
+    return line:sub(coords[2] + 1, coords[2] + 1)
+end
+
+describe('toggle', function()
+    it('toggle cword', function()
+        open_file_at('test/test_files/test_1.txt', 1, 1, function()
+            toggle.toggle()
+            assert(vim.fn.expand('<cword>') == 'true')
+        end)
+    end)
+
+    it('toggle cWORD', function()
+        open_file_at('test/test_files/test_1.txt', 2, 1, function()
+            toggle.toggle()
+            assert(vim.fn.expand('<cword>') == 'true')
+        end)
+    end)
+
+    it('toggle char', function()
+        open_file_at('test/test_files/test_1.txt', 3, 1, function()
+            toggle.toggle()
+            assert(get_character_under_cursor() == '>')
+        end)
+    end)
+end)