Updated table mode

- Bumped version
- Added new mapping \t? to echo current cells representation for
  defining formulas.
- Updated docs

CHANGELOG.md

@@ -1,4 +1,15 @@
 # Change Log
+## Version 3.3.1
+* Improved logic to ignore table borders (add as many as you'd like), the
+  first row is not treated special, it is row # 1. Keep that in mind while
+  defining Formulas
+* Improved test coverage
+
+## Version 3.3
+* Dropped +- mapping to create table border instead now using ||
+* You can now have a top table border (before header) as well as a bottom
+  table border.
+
 ## Version 3.2
 * Added tests to test various use cases using <a
   href='https://github.com/kana/vim-vspec'>Vspec</a>..

Gemfile.lock

@@ -6,7 +6,7 @@ GEM
       blankslate (~> 2.0)
     rake (10.1.0)
     thor (0.18.1)
-    vim-flavor (1.1.2)
+    vim-flavor (1.1.3)
       parslet (~> 1.0)
       thor (~> 0.14)
 

README.md

@@ -1,4 +1,4 @@
-# VIM Table Mode [![Build Status](https://travis-ci.org/dhruvasagar/soulmate_rails.png?branch=master)](https://travis-ci.org/dhruvasagar/soulmate_rails)
+# VIM Table Mode [![Build Status](https://travis-ci.org/dhruvasagar/vim-table-mode.png?branch=master)](https://travis-ci.org/dhruvasagar/vim-table-mode)
 
 An awesome automatic table creator & formatter allowing one to create neat
 tables as you type.

autoload/tablemode.vim

@@ -4,10 +4,9 @@
 " Author:        Dhruva Sagar <http://dhruvasagar.com/>
 " License:       MIT (http://www.opensource.org/licenses/MIT)
 " Website:       http://github.com/dhruvasagar/vim-table-mode
-" Version:       3.3
+" Version:       3.3.2
 " Note:          This plugin was heavily inspired by the 'CucumberTables.vim'
-"                (https://gist.github.com/tpope/287147) plugin by Tim Pope and
+"                (https://gist.github.com/tpope/287147) plugin by Tim Pope.
-"                uses a small amount of code from it.
 "
 " Copyright Notice:
 "                Permission is hereby granted to use and distribute this code,
@@ -67,11 +66,11 @@ function! s:Sum(list) "{{{2
   let result = 0.0
   for item in a:list
     if type(item) == type(1) || type(item) == type(1.0)
-      let result = result + item
+      let result += item
     elseif type(item) == type('')
-      let result = result + str2float(item)
+      let result += str2float(item)
     elseif type(item) == type([])
-      let result = result + s:Sum(item)
+      let result += s:Sum(item)
     endif
   endfor
   return result
@@ -257,9 +256,10 @@ function! s:GetFirstRow(line) "{{{2
   if tablemode#IsATableRow(a:line)
     let line = s:Line(a:line)
 
-    while tablemode#IsATableRow(line - s:RowGap())
+    while tablemode#IsATableRow(line - s:RowGap()) || tablemode#IsATableHeader(line - s:RowGap())
-      let line = line - s:RowGap()
+      let line -= s:RowGap()
     endwhile
+    if tablemode#IsATableHeader(line) | let line += s:RowGap() | endif
 
     return line
   endif
@@ -275,9 +275,10 @@ function! s:GetLastRow(line) "{{{2
   if tablemode#IsATableRow(a:line)
     let line = s:Line(a:line)
 
-    while tablemode#IsATableRow(line+ s:RowGap())
+    while tablemode#IsATableRow(line + s:RowGap()) || tablemode#IsATableHeader(line + s:RowGap())
-      let line = line + s:RowGap()
+      let line += s:RowGap()
     endwhile
+    if tablemode#IsATableHeader(line) | let line -= s:RowGap() | endif
 
     return line
   endif
@@ -289,6 +290,23 @@ function! s:MoveToLastRow() "{{{2
   endif
 endfunction
 
+function! s:LineNr(row) "{{{2
+  if tablemode#IsATableRow('.')
+    let line = s:GetFirstRow('.')
+    let row_nr = 0
+
+    while tablemode#IsATableRow(line + s:RowGap()) || tablemode#IsATableHeader(line + s:RowGap())
+      if tablemode#IsATableRow(line)
+        let row_nr += 1
+        if row ==# row_nr | break | endif
+      endif
+      let line += s:RowGap()
+    endwhile
+
+    return line
+  endif
+endfunction
+
 function! s:MoveToStartOfCell() "{{{2
   if getline('.')[col('.')-1] ==# g:table_mode_separator && !s:IsLastCell()
     normal! 2l
@@ -313,21 +331,28 @@ function! s:GetCells(line, ...) abort
       let [row, colm] = a:000
     endif
 
+    let first_row = s:GetFirstRow(line)
     if row == 0
       let values = []
-      let line = s:GetFirstRow(line)
+      let line = first_row
-      while tablemode#IsATableRow(line)
+      while tablemode#IsATableRow(line) || tablemode#IsATableHeader(line)
+        if tablemode#IsATableRow(line)
           let row_line = getline(line)[stridx(getline(line), g:table_mode_separator):strridx(getline(line), g:table_mode_separator)]
           call add(values, s:Strip(get(split(row_line, g:table_mode_separator), colm>0?colm-1:colm, '')))
-        let line = line + s:RowGap()
+        endif
+        let line += s:RowGap()
       endwhile
       return values
     else
-      if row > 0
+      let row_nr = 0
-        let line =  line + (row - tablemode#RowNr(line)) * s:RowGap()
+      let line = first_row
-      else
+      while tablemode#IsATableRow(line) || tablemode#IsATableHeader(line)
-        let line = line + row * s:RowGap()
+        if tablemode#IsATableRow(line)
+          let row_nr += 1
+          if row ==# row_nr | break | endif
         endif
+        let line += s:RowGap()
+      endwhile
 
       let row_line = getline(line)[stridx(getline(line), g:table_mode_separator):strridx(getline(line), g:table_mode_separator)]
       if colm == 0
@@ -585,8 +610,6 @@ function! s:Align(lines) "{{{3
   return lines
 endfunction
 
-
-
 " Public API {{{1
 
 function! tablemode#sid() "{{{2
@@ -638,7 +661,7 @@ function! tablemode#TableizeRange(...) range "{{{2
   while lnum < (a:firstline + (a:lastline - a:firstline + 1)*s:RowGap())
     call s:Tableizeline(lnum, a:1)
     undojoin
-    let lnum = lnum + s:RowGap()
+    let lnum += s:RowGap()
   endwhile
 
   call tablemode#TableRealign(lnum - s:RowGap())
@@ -662,28 +685,28 @@ function! tablemode#TableRealign(line) "{{{2
 
   let [lnums, lines] = [[], []]
   let [tline, blines] = [line, []]
-  while tablemode#IsATableRow(tline) || getline(tline) =~# s:HeaderBorderExpr()
+  while tablemode#IsATableRow(tline) || tablemode#IsATableHeader(tline)
-    if getline(tline) =~# s:HeaderBorderExpr()
+    if tablemode#IsATableHeader(tline)
       call insert(blines, tline)
-      let tline = tline - s:RowGap()
+      let tline -= s:RowGap()
       continue
     endif
     call insert(lnums, tline)
     call insert(lines, getline(tline))
-    let tline = tline - s:RowGap()
+    let tline -= s:RowGap()
   endwhile
 
   let tline = line + s:RowGap()
 
-  while tablemode#IsATableRow(tline) || getline(tline) =~# s:HeaderBorderExpr()
+  while tablemode#IsATableRow(tline) || tablemode#IsATableHeader(tline)
-    if getline(tline) =~# s:HeaderBorderExpr()
+    if tablemode#IsATableHeader(tline)
       call insert(blines, tline)
-      let tline = tline + s:RowGap()
+      let tline += s:RowGap()
       continue
     endif
     call add(lnums, tline)
     call add(lines, getline(tline))
-    let tline = tline + s:RowGap()
+    let tline += s:RowGap()
   endwhile
 
   let lines = s:Align(lines)
@@ -708,29 +731,22 @@ function! tablemode#IsATableHeader(line) "{{{2
 endfunction
 
 function! tablemode#LineNr(row) "{{{2
-  if tablemode#IsATableRow('.')
+  return s:LineNr(row)
-    let line = s:Line('.')
-    let row = tablemode#RowNr('.')
-    if a:row != row
-      let line += a:row - row
-    endif
-    return line
-  endif
 endfunction
 
 function! tablemode#RowCount(line) "{{{2
   let line = s:Line(a:line)
 
   let [tline, totalRowCount] = [line, 0]
-  while tablemode#IsATableRow(tline)
+  while tablemode#IsATableRow(tline) || tablemode#IsATableHeader(tline)
-    let totalRowCount += 1
+    if tablemode#IsATableRow(tline) | let totalRowCount += 1 | endif
-    let tline = tline - s:RowGap()
+    let tline -= s:RowGap()
   endwhile
 
   let tline = line + s:RowGap()
-  while tablemode#IsATableRow(tline)
+  while tablemode#IsATableRow(tline) || tablemode#IsATableHeader(tline)
-    let totalRowCount += 1
+    if tablemode#IsATableRow(tline) | let totalRowCount += 1 | endif
-    let tline = tline + s:RowGap()
+    let tline += s:RowGap()
   endwhile
 
   return totalRowCount
@@ -740,9 +756,9 @@ function! tablemode#RowNr(line) "{{{2
   let line = s:Line(a:line)
 
   let rowNr = 0
-  while tablemode#IsATableRow(line)
+  while tablemode#IsATableRow(line) || tablemode#IsATableHeader(line)
-    let rowNr += 1
+    if tablemode#IsATableRow(line) | let rowNr += 1 | endif
-    let line = line - s:RowGap()
+    let line -= s:RowGap()
   endwhile
 
   return rowNr
@@ -771,7 +787,7 @@ function! tablemode#TableMotion(direction) "{{{2
   if tablemode#IsATableRow('.')
     if a:direction ==# 'l'
       if s:IsLastCell()
-        if !tablemode#IsATableHeader(line('.') + s:RowGap()) && !tablemode#IsATableRow(line('.') + s:RowGap())
+        if !tablemode#IsATableRow(line('.') + s:RowGap()) || (tablemode#IsATableHeader(line('.') + s:RowGap()) && tablemode#IsATableRow(line('.') + 2 * s:RowGap()))
           return
         endif
         call tablemode#TableMotion('j')
@@ -786,7 +802,7 @@ function! tablemode#TableMotion(direction) "{{{2
       endif
     elseif a:direction ==# 'h'
       if s:IsFirstCell()
-        if !tablemode#IsATableHeader(line('.') - s:RowGap()) && !tablemode#IsATableRow(line('.') - s:RowGap())
+        if !tablemode#IsATableRow(line('.') - s:RowGap()) || (tablemode#IsATableHeader(line('.') - s:RowGap()) && tablemode#IsATableRow(line('.') - 2 * s:RowGap()))
           return
         endif
         call tablemode#TableMotion('k')
@@ -801,15 +817,15 @@ function! tablemode#TableMotion(direction) "{{{2
       endif
     elseif a:direction ==# 'j'
       if tablemode#IsATableRow(line('.') + s:RowGap())
-        execute 'normal ' . s:RowGap() . 'j'
+        execute 'normal! ' . s:RowGap() . 'j'
-      elseif tablemode#IsATableHeader(line('.') + s:RowGap())
+      elseif tablemode#IsATableHeader(line('.') + s:RowGap()) && tablemode#IsATableRow(line('.') + 2 * s:RowGap())
-        execute 'normal ' . (s:RowGap() + 1) . 'j'
+        execute 'normal! ' . (s:RowGap() + 1) . 'j'
       endif
     elseif a:direction ==# 'k'
       if tablemode#IsATableRow(line('.') - s:RowGap())
-        execute 'normal ' . s:RowGap() . 'k'
+        execute 'normal! ' . s:RowGap() . 'k'
-      elseif tablemode#IsATableHeader(line('.') - s:RowGap())
+      elseif tablemode#IsATableHeader(line('.') - s:RowGap()) && tablemode#IsATableRow(line('.') - 2 * s:RowGap())
-        execute 'normal ' . (s:RowGap() + 1) . 'k'
+        execute 'normal! ' . (s:RowGap() + 1) . 'k'
       endif
     endif
   endif
@@ -832,21 +848,7 @@ function! tablemode#DeleteColumn() "{{{2
   if tablemode#IsATableRow('.')
     for i in range(v:count1)
       call s:MoveToStartOfCell()
-
-      if tablemode#IsATableRow(line('.') + 1)
       call s:MoveToFirstRow()
-        " If we have a header delete it first
-        if tablemode#IsATableRow(line('.')-2)
-          call cursor(line('.')-2, col('.'))
-          silent! execute "normal! h\<C-V>f" . g:table_mode_separator
-          normal! jdjj
-        endif
-      else " We're already on the header
-        silent! execute "normal! h\<C-V>f" . g:table_mode_separator
-        normal! jdjj
-      endif
-
-      call s:MoveToStartOfCell()
       silent! execute "normal! h\<C-V>f" . g:table_mode_separator
       call s:MoveToLastRow()
       normal! d
@@ -912,7 +914,7 @@ function! tablemode#AddFormula() "{{{2
   if fr !=# ''
     let fr = '$' . row . ',' . colm . '=' . fr
     let fline = tablemode#GetLastRow('.') + s:RowGap()
-    if getline(fline) =~# s:HeaderBorderExpr() | let fline += s:RowGap() | endif
+    if tablemode#IsATableHeader(fline) | let fline += s:RowGap() | endif
     let cursor_pos = [line('.'), col('.')]
     if getline(fline) =~# 'tmf: '
       " Comment line correctly
@@ -1002,13 +1004,13 @@ function! tablemode#EvaluateFormulaLine() abort "{{{2
   if tablemode#IsATableRow('.') " We're inside the table
     let line = s:GetLastRow('.')
     let fline = line + s:RowGap()
-    if getline(fline) =~# s:HeaderBorderExpr() | let fline += s:RowGap() | endif
+    if tablemode#IsATableHeader(fline) | let fline += s:RowGap() | endif
     if getline(fline) =~# 'tmf: '
       let exprs = split(matchstr(getline(fline), matchexpr), ';')
     endif
   elseif getline('.') =~# 'tmf: ' " We're on the formula line
     let line = line('.') - s:RowGap()
-    if getline(line) =~# s:HeaderBorderExpr() | let line -= s:RowGap() | endif
+    if tablemode#IsATableHeader(line) | let line -= s:RowGap() | endif
     if tablemode#IsATableRow(line)
       let exprs = split(matchstr(getline('.'), matchexpr), ';')
     endif

doc/table-mode.txt

@@ -1,7 +1,7 @@
-*table-mode.txt*			Table Mode for easy table formatting. v3.3
+*table-mode.txt*			Table Mode for easy table formatting. v3.3.2
 ===============================================================================
 	Table Mode, THE AWESOME AUTOMATIC TABLE CREATOR & FORMATTER
-				 VERSION 3.3
+				 VERSION 3.3.2
 
 		Author: Dhruva Sagar <http://dhruvasagar.com/>
 		License: MIT <http://opensource.org/licenses/MIT/>
@@ -272,6 +272,12 @@ g:table_mode_eval_expr_map			*table-mode-eval-expr-map*
 	NOTE you will need to use the |table-mode-map-prefix| before this to
 	get the desired effect.
 
+g:table_mode_echo_cell_map                            *table-mode-echo-cell-map*
+	Use this option to define the mapping for echoing current cells
+        representation for defining formulas. >
+        	let g:table_mode_echo_cell_map = '?'
+<
+
 ===============================================================================
 MAPPINGS						*table-mode-mappings*
 
@@ -300,6 +306,9 @@ MAPPINGS						*table-mode-mappings*
 						*table-mode-mappings-realign*
 <Leader>tr	Realigns table columns
 
+<Leader>t?      Echo the current table cells representation for defining
+                formulas.
+
 						*table-mode-mappings-motions*
 <Leader>t[hjkl]	Move to previous | below | above | right cell in the table.
 
@@ -397,4 +406,4 @@ REPORT ISSUES					      *table-mode-report-issues*
 If you discover any issues, please report them at
 http://github.com/dhruvasagar/table-mode/issues.
 
- vim:tw=78:ts=8:ft=help:norl:ai
+ vim:tw=78:ts=8:ft=help:norl:ai:et

plugin/table-mode.vim

@@ -4,10 +4,9 @@
 " Author:        Dhruva Sagar <http://dhruvasagar.com/>
 " License:       MIT (http://www.opensource.org/licenses/MIT)
 " Website:       http://github.com/dhruvasagar/vim-table-mode
-" Version:       3.3
+" Version:       3.3.2
 " Note:          This plugin was heavily inspired by the 'CucumberTables.vim'
-"                (https://gist.github.com/tpope/287147) plugin by Tim Pope and
+"                (https://gist.github.com/tpope/287147) plugin by Tim Pope.
-"                uses a small amount of code from it.
 "
 " Copyright Notice:
 "                Permission is hereby granted to use and distribute this code,
@@ -51,6 +50,7 @@ call s:SetGlobalOptDefault('table_mode_delete_row_map', 'dd')
 call s:SetGlobalOptDefault('table_mode_delete_column_map', 'dc')
 call s:SetGlobalOptDefault('table_mode_add_formula_map', 'fa')
 call s:SetGlobalOptDefault('table_mode_eval_expr_map', 'fe')
+call s:SetGlobalOptDefault('table_mode_echo_cell_map', '?')
 
 function! s:TableMotion() "{{{1
   let direction = nr2char(getchar())
@@ -59,6 +59,12 @@ function! s:TableMotion() "{{{1
   endfor
 endfunction
 
+function! s:TableEchoCell() "{{{1
+  if tablemode#IsATableRow('.')
+    echomsg '$' . tablemode#RowNr('.') . ',' . tablemode#ColumnNr('.')
+  endif
+endfunction
+
 " Define Commands & Mappings {{{1
 if !g:table_mode_always_active "{{{2
   exec "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_toggle_map .
@@ -102,6 +108,8 @@ execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_add_formul
       \ " :TableAddFormula<CR>"
 execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_eval_expr_map .
       \ " :TableEvalFormulaLine<CR>"
+execute "nnoremap <silent> " . g:table_mode_map_prefix . g:table_mode_echo_cell_map .
+      \ " :call <SID>TableEchoCell()<CR>"
 
 " Avoiding side effects {{{1
 let &cpo = s:save_cpo

t/tablemode.vim

@@ -1,3 +1,4 @@
+" vim: fdm=indent
 let g:table_mode_corner = '+'
 let g:table_mode_separator = '|'
 let g:table_mode_fillchar = '-'
@@ -50,9 +51,10 @@ describe 'tablemode'
 
   describe 'API'
     before
+      new
       normal! ggdG
       call tablemode#TableModeEnable()
-      normal! i
+      normal i
 |test11|test12|
 |test21|test22|
     end
@@ -129,8 +131,9 @@ describe 'tablemode'
     end
   end
 
+  describe 'Tableize'
     before
-    before
+      new
       normal! ggdG
       normal i
 asd,asd;asd,asd
@@ -149,14 +152,101 @@ describe 'tablemode'
       Expect tablemode#IsATableRow(2) to_be_true
       Expect tablemode#RowCount(2) == 2
       Expect tablemode#ColumnCount(2) == 2
-    end
+    end
-  end
+  end
+
+  describe 'Motions'
+    describe 'left or right'
+      before
+        new
+        normal! ggdG
+        call tablemode#TableModeEnable()
+        normal i|test11|test12|
+|test21|test22|
+        call cursor(1, 3)
+      end
+
+      it 'should move left when not on first column'
+        call cursor(1, 12)
+        Expect tablemode#ColumnNr('.') == 2
+        call tablemode#TableMotion('h')
+        Expect tablemode#ColumnNr('.') == 1
+      end
+
+      it 'should move to the previous row last column if it exists when on first column'
+        call cursor(2, 3)
+        Expect tablemode#RowNr('.') == 2
+        Expect tablemode#ColumnNr('.') == 1
+        call tablemode#TableMotion('h')
+        Expect tablemode#RowNr('.') == 1
+        Expect tablemode#ColumnNr('.') == 2
+      end
+
+      it 'should move right when not on last column'
+        Expect tablemode#ColumnNr('.') == 1
+        call tablemode#TableMotion('l')
+        Expect tablemode#ColumnNr('.') == 2
+      end
+
+      it 'should move to the next row first column if it exists when on last column'
+        call cursor(1, 12)
+        Expect tablemode#RowNr('.') == 1
+        Expect tablemode#ColumnNr('.') == 2
+        call tablemode#TableMotion('l')
+        Expect tablemode#RowNr('.') == 2
+        Expect tablemode#ColumnNr('.') == 1
+      end
+    end
+
+    describe 'up or down'
+      before
+        new
+        normal! ggdG
+        call tablemode#TableModeEnable()
+        normal i|test11|test12|
+|test21|test22|
+        call cursor(1, 3)
+      end
+
+      it 'should move a row up unless on first row'
+        call cursor(2, 3)
+        Expect tablemode#RowNr('.') == 2
+        call tablemode#TableMotion('k')
+        Expect tablemode#RowNr('.') == 1
+      end
+
+      it 'should remain on first row when trying to move up'
+        Expect tablemode#RowNr('.') == 1
+        call tablemode#TableMotion('k')
+        Expect tablemode#RowNr('.') == 1
+      end
+
+      it 'should move a row down unless on last row'
+        Expect tablemode#RowNr('.') == 1
+        call tablemode#TableMotion('j')
+        Expect tablemode#RowNr('.') == 2
+      end
 
       it 'should remain on last row when trying to move down'
         Expect tablemode#RowNr('.') == 1
         call tablemode#TableMotion('k')
-    end
+        Expect tablemode#RowNr('.') == 1
-  end
+      end
+    end
+  end
+
+  describe 'Manipulations'
+    before
+      new
+      normal! ggdG
+      normal i|test11|test12|
+|test21|test22|
+      call cursor(1, 3)
+    end
+
+    it 'should delete a row successfully'
+      Expect tablemode#RowCount('.') == 2
+      call tablemode#DeleteRow()
       Expect tablemode#RowCount('.') == 1
     end