refactor: Use more expressive and consistend variable names

Author: alerque

autoload/ledger.vim

@@ -478,11 +478,11 @@ function! s:transaction.parse_body(...) abort dict
     return []
   endif
 
-  let lnum = head
+  let line_number = head
   let tags = {}
   let postings = []
-  while lnum <= tail
-    let line = split(getline(lnum), '\s*\%(\t\|  \);', 1)
+  while line_number <= tail
+    let line = split(getline(line_number), '\s*\%(\t\|  \);', 1)
 
     if line[0] =~# '^\s\+[^[:blank:];]'
       " posting
@@ -511,18 +511,18 @@ function! s:transaction.parse_body(...) abort dict
     let comment = join(line[1:], '  ;')
     if comment =~# '^\s*:'
       " tags without values
-      for t in s:findall(comment, ':\zs[^:[:blank:]]\([^:]*[^:[:blank:]]\)\?\ze:')
-        let tag_container[t] = ''
+      for tag in s:findall(comment, ':\zs[^:[:blank:]]\([^:]*[^:[:blank:]]\)\?\ze:')
+        let tag_container[tag] = ''
       endfor
     elseif comment =~# '^\s*[^:[:blank:]][^:]\+:'
       " tag with value
       let key = matchstr(comment, '^\s*\zs[^:]\+\ze:')
       if ! empty(key)
-        let val = matchstr(comment, ':\s*\zs.*\ze\s*$')
-        let tag_container[key] = val
+        let value = matchstr(comment, ':\s*\zs.*\ze\s*$')
+        let tag_container[key] = value
       endif
     endif
-    let lnum += 1
+    let line_number += 1
   endwhile
   return [tags, postings]
 endfunction
@@ -667,19 +667,19 @@ function! s:goto_col(pos, min_spaces) abort
 endfunction
 
 " Return character position of decimal separator (multibyte safe)
-function! s:decimalpos(expr) abort
+function! s:decimal_position(expression) abort
   " Remove trailing comments
-  let l:expr = substitute(a:expr, '\v +;.*$', '', '')
+  let l:expr = substitute(a:expression, '\v +;.*$', '', '')
   " Find first or last possible decimal separator candidate
   if b:ledger_align_last
     let pos = matchend(l:expr, '\v.*[' . b:ledger_decimal_sep . ']')
     if pos > 0
-      let pos = strchars(a:expr[:pos]) + 1
+      let pos = strchars(a:expression[:pos]) + 1
     endif
   else
     let pos = match(l:expr, '\v[' . b:ledger_decimal_sep . ']')
     if pos > 0
-      let pos = strchars(a:expr[:pos]) - 1
+      let pos = strchars(a:expression[:pos]) - 1
     endif
   endif
   return pos
@@ -716,7 +716,7 @@ function! ledger#align_commodity() abort
       let pos = 0
     elseif b:ledger_decimal_sep !=# ''
       " Find the position of the first decimal separator:
-      let pos = s:decimalpos(rhs)
+      let pos = s:decimal_position(rhs)
     endif
     if pos < 0
       " Find the position after the first digits
@@ -753,7 +753,7 @@ function! ledger#align_amount_at_cursor() abort
   " Select and cut text:
   normal! viWd
   " Find the position of the decimal separator
-  let pos = s:decimalpos(@") " Returns zero when the separator is the empty string
+  let pos = s:decimal_position(@") " Returns zero when the separator is the empty string
   if pos <= 0
     let pos = len(@")
   endif

ftplugin/ledger.vim

@@ -43,37 +43,37 @@ highlight default link LedgerPending Todo
 highlight default link LedgerTarget Statement
 highlight default link LedgerImproperPerc Special
 
-let s:cursym = '[[:alpha:]¢$€£]\+'
-let s:valreg = '\('.
+let s:currency_symbol = '[[:alpha:]¢$€£]\+'
+let s:value_regex = '\('.
              \   '\%([0-9]\+\)'.
              \   '\%([,.][0-9]\+\)*'.
              \ '\|'.
              \   '[,.][0-9]\+'.
              \ '\)'
-let s:optsgn = '[+-]\?'
-let s:cursgn = '\('.
-             \   s:optsgn.
+let s:optional_sign = '[+-]\?'
+let s:currency_sign = '\('.
+             \   s:optional_sign.
              \   '\s*'.
-             \   s:cursym.
+             \   s:currency_symbol.
              \ '\|'.
-             \   s:cursym.
+             \   s:currency_symbol.
              \   '\s*'.
-             \   s:optsgn.
+             \   s:optional_sign.
              \ '\)'
 
-let s:optional_balance_assertion = '\(\s*=\s*'.s:cursgn.'\s*'.s:valreg.'\)\?'
+let s:optional_balance_assertion = '\(\s*=\s*'.s:currency_sign.'\s*'.s:value_regex.'\)\?'
 
-let s:rx_amount = s:valreg.
+let s:rx_amount = s:value_regex.
                 \ s:optional_balance_assertion.
-                \ '\s*\%('.s:cursym.'\s*\)\?'.
+                \ '\s*\%('.s:currency_symbol.'\s*\)\?'.
                 \ '\%(\s*;.*\)\?$'
 
 function! LedgerFoldText()
   " find amount
   let amount = ''
-  let lnum = v:foldstart + 1
-  while lnum <= v:foldend
-    let line = getline(lnum)
+  let line_number = v:foldstart + 1
+  while line_number <= v:foldend
+    let line = getline(line_number)
 
     " Skip metadata/leading comment
     if line !~# '^\%(\s\+;\|\d\)'
@@ -84,7 +84,7 @@ function! LedgerFoldText()
         break
       endif
     endif
-    let lnum += 1
+    let line_number += 1
   endwhile
 
   " strip whitespace at beginning and end of line
@@ -143,55 +143,55 @@ endfunction
 
 function! LedgerComplete(findstart, base)
   if a:findstart
-    let lnum = line('.')
+    let line_number = line('.')
     let line = getline('.')
-    let b:compl_context = ''
+    let b:completion_context = ''
     if line =~# '^\s\+[^[:blank:];]'
       " only allow completion when in or at end of account name
       if matchend(line, '^\s\+\%(\S \S\|\S\)\+') >= col('.') - 1
         " the start of the first non-blank character
         " (excluding virtual-transaction and 'cleared' marks)
         " is the beginning of the account name
-        let b:compl_context = 'account'
+        let b:completion_context = 'account'
         return matchend(line, '^\s\+[*!]\?\s*[\[(]\?')
       endif
     elseif line =~# '^account '
-        let pre = matchend(line, '^account ')
-        let b:compl_context = 'account'
-        return pre
+        let prefix = matchend(line, '^account ')
+        let b:completion_context = 'account'
+        return prefix
     elseif line =~# '^\d'
-      let pre = matchend(line, '^\d\S\+\%\(\s\(([^\)]*)\|[*?!]\)\)\?\s\+')
-      if pre <= col('.') - 1
-        let b:compl_context = 'description'
-        if pre == -1
+      let prefix = matchend(line, '^\d\S\+\%\(\s\(([^\)]*)\|[*?!]\)\)\?\s\+')
+      if prefix <= col('.') - 1
+        let b:completion_context = 'description'
+        if prefix == -1
           return -3
         endif
-        return pre
+        return prefix
       endif
     elseif b:ledger_is_hledger && line =~# '^payee '
-      let pre = matchend(line, '^payee ')
-      let b:compl_context = 'description'
-      return pre
+      let prefix = matchend(line, '^payee ')
+      let b:completion_context = 'description'
+      return prefix
     elseif line =~# '^$'
-      let b:compl_context = 'new'
+      let b:completion_context = 'new'
       return 0
     endif
     return -3
   else
-    if ! exists('b:compl_cache')
-      let b:compl_cache = s:collect_completion_data()
-      let b:compl_cache['#'] = changenr()
+    if ! exists('b:completion_cache')
+      let b:completion_cache = s:collect_completion_data()
+      let b:completion_cache['#'] = changenr()
     endif
     let update_cache = 0
 
     let results = []
-    if b:compl_context ==# 'account'
+    if b:completion_context ==# 'account'
       let hierarchy = split(a:base, ':')
       if a:base =~# ':$'
         call add(hierarchy, '')
       endif
 
-      let results = ledger#find_in_tree(b:compl_cache.accounts, hierarchy)
+      let results = ledger#find_in_tree(b:completion_cache.accounts, hierarchy)
       let exacts = filter(copy(results), 'v:val[1]')
 
       if len(exacts) < 1
@@ -206,19 +206,19 @@ function! LedgerComplete(findstart, base)
       call map(results, 'v:val[0]')
 
       if b:ledger_fuzzy_account_completion
-        let results = matchfuzzy(b:compl_cache.flat_accounts, a:base, {'matchseq':1})
+        let results = matchfuzzy(b:completion_cache.flat_accounts, a:base, {'matchseq':1})
       elseif b:ledger_detailed_first
         let results = reverse(sort(results, 's:sort_accounts_by_depth'))
       else
         let results = sort(results)
       endif
-    elseif b:compl_context ==# 'description'
-      let results = ledger#filter_items(b:compl_cache.descriptions, a:base)
+    elseif b:completion_context ==# 'description'
+      let results = ledger#filter_items(b:completion_cache.descriptions, a:base)
 
       if len(results) < 1
         let update_cache = 1
       endif
-    elseif b:compl_context ==# 'new'
+    elseif b:completion_context ==# 'new'
       return [strftime(b:ledger_date_format)]
     endif
 
@@ -228,11 +228,11 @@ function! LedgerComplete(findstart, base)
     endif
 
     " no completion (apart from a:base) found. update cache if file has changed
-    if update_cache && b:compl_cache['#'] != changenr()
-      unlet b:compl_cache
+    if update_cache && b:completion_cache['#'] != changenr()
+      unlet b:completion_cache
       return LedgerComplete(a:findstart, a:base)
     else
-      unlet! b:compl_context
+      unlet! b:completion_context
       return results
     endif
   endif
@@ -246,9 +246,9 @@ function! s:collect_completion_data()
   let cache.flat_accounts = accounts
   let cache.descriptions = s:get_descriptions_list()
 
-  for xact in transactions
-    let [t, postings] = xact.parse_body()
-    let tagdicts = [t]
+  for transaction in transactions
+    let [tags, postings] = transaction.parse_body()
+    let tagdicts = [tags]
 
     " collect account names (only when not using ledger binary)
     if b:ledger_bin ==# v:false
@@ -345,15 +345,15 @@ function! s:count_expression(text, expression)
   return len(split(a:text, a:expression, 1))-1
 endfunction
 
-function! s:autocomplete_account_or_payee(argLead, cmdLine, cursorPos)
-  if a:argLead =~# '^@'
+function! s:autocomplete_account_or_payee(argument_lead, command_line, cursor_position)
+  if a:argument_lead =~# '^@'
     let payees = s:get_descriptions_list()
-    let pattern = strpart(a:argLead, 1)
+    let pattern = strpart(a:argument_lead, 1)
     return map(filter(payees, "v:val =~? '" . pattern . "' && v:val !~? '^Warning: '"),
              \ '"@" . escape(v:val, " ")')
   else
     let accounts = s:get_accounts_list()
-    return map(filter(accounts, "v:val =~? '" . a:argLead . "' && v:val !~? '^Warning: '"),
+    return map(filter(accounts, "v:val =~? '" . a:argument_lead . "' && v:val !~? '^Warning: '"),
              \ 'escape(v:val, " ")')
   endif
 endfunction