Merge branch 'letientai299-type-hint'

Author: heavenshell

.gitignore

@@ -2,3 +2,4 @@
 *~
 .DS_Store
 tags
+vader.vim/

CHANGES.rst

@@ -1,3 +1,11 @@
+Version 0.0.9
+-------------
+Released on Nov 20th 2016
+
+- Add Vader integration tes
+  see https://github.com/heavenshell/vim-pydocstring/pull/14
+  Thx @letientai299
+
 Version 0.0.8
 -------------
 Released on Sep 1th 2016

autoload/pydocstring.vim

@@ -1,6 +1,6 @@
 " Insert Docstring.
 " Author:      Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:     0.0.8
+" Version:     0.0.9
 " License:     This file is placed in the public domain.
 " WebPage:     http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
@@ -11,11 +11,10 @@ let s:save_cpo = &cpo
 set cpo&vim
 
 " Path to docstring template.
-if exists('g:pydocstring_templates_dir')
-  let s:tmpldir = g:pydocstring_templates_dir
-else
-  let s:tmpldir = expand('<sfile>:p:h:h') . '/template/pydocstring/'
+if !exists('g:pydocstring_templates_dir')
+  let g:pydocstring_templates_dir = expand('<sfile>:p:h:h') . '/template/pydocstring/'
 endif
+
 " Use comment.txt when cursor is not on def|class keyword.
 if !exists('g:pydocstring_enable_comment')
   let g:pydocstring_enable_comment = 1
@@ -31,7 +30,13 @@ let s:regexs = {
 \ }
 
 function! s:readtmpl(type)
-  let path = expand(s:tmpldir . a:type . '.txt')
+  let tmpldir = g:pydocstring_templates_dir
+  " Append the back slash if needed.
+  if g:pydocstring_templates_dir !~ '/$'
+    let tmpldir =  tmpldir . '/'
+  endif
+
+  let path = expand(tmpldir . a:type . '.txt')
   if !filereadable(path)
     throw 'Template ' . path . ' is not exists.'
   endif

doc/pydocstring.txt

@@ -1,6 +1,6 @@
 *pydocstring.txt*	Generate Python docstring to your Python code.
 
-Version: 0.0.8
+Version: 0.0.9
 Author: Shinya Ohynagi <sohyanagi@gmail.com>
 Repository: http://github.com/heavenshell/vim-pydocstring/
 License: BSD, see LICENSE for more details.

ftplugin/python/pydocstring.vim

@@ -1,6 +1,6 @@
 " File:     pydocstring.vim
 " Author:   Shinya Ohyanagi <sohyanagi@gmail.com>
-" Version:  0.0.8
+" Version:  0.0.9
 " WebPage:  http://github.com/heavenshell/vim-pydocstriong/
 " Description: Generate Python docstring to your Python script file.
 " License: BSD, see LICENSE for more details.

test/basic.vader

@@ -0,0 +1,151 @@
+# vim:set et sw=4 ts=4 tw=79:
+
+# Test def keyword
+#-------------------------------------------------------------------------------
+Given python (def foo):
+    def foo():
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo():
+        """foo"""
+        pass
+
+Given python (def foo with 1 param):
+    def foo(arg):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg):
+        """foo
+
+        :param arg:
+        """
+        pass
+
+Given python (def foo with 2 params):
+    def foo(arg1, arg2):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1, arg2):
+        """foo
+
+        :param arg1:
+        :param arg2:
+        """
+        pass
+
+Given python (def foo with variadic params):
+    def foo(*arg):
+        pass
+
+Execute:
+    Pydocstring
+Expect python:
+    def foo(*arg):
+        """foo
+
+        :param *arg:
+        """
+        pass
+
+
+# Test class keyword
+#-------------------------------------------------------------------------------
+
+
+Given python (class Foo):
+    class Foo(object):
+        def foo(self):
+            pass
+
+        def arg1(self, arg1):
+            pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    class Foo(object):
+        """Foo"""
+        def foo(self):
+            pass
+
+        def arg1(self, arg1):
+            pass
+
+
+Given python (class Foo):
+    class Foo(object):
+        def foo(self):
+            pass
+
+        def arg1(self, arg1):
+            pass
+
+Do (Put cursor to def foo(self)):
+    j
+
+Then Execute (Execute Pydocstring on def foo(self)):
+    Pydocstring
+
+Expect python:
+    class Foo(object):
+        def foo(self):
+            """foo"""
+            pass
+
+        def arg1(self, arg1):
+            pass
+
+
+Given python (class Foo):
+    class Foo(object):
+        def foo(self):
+            pass
+
+        def arg1(self, arg1):
+            pass
+
+Do (Put cursor to def arg1(self, arg1)):
+    4j
+
+Then Execute (Execute Pydocstring on def arg1(self, arg1)):
+    Pydocstring
+
+Expect python:
+    class Foo(object):
+        def foo(self):
+            pass
+
+        def arg1(self, arg1):
+            """arg1
+
+            :param arg1:
+            """
+            pass
+
+# Test aync/await keyword
+#-------------------------------------------------------------------------------
+Given python (async def foo):
+    async def foo():
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    async def foo():
+        """foo"""
+        pass
+

test/custom-template.vader

@@ -0,0 +1,56 @@
+# vim:set et sw=4 ts=4 tw=79:
+Execute (Setup template dir):
+    Save g:pydocstring_templates_dir
+    let g:pydocstring_templates_dir = './test-template/'
+
+Given python (def foo):
+    def foo():
+        pass
+
+Execute:
+    Pydocstring
+
+
+Expect python:
+    def foo():
+        """foo is """
+        pass
+
+
+Given python (def foo with 1 params):
+    def foo(arg1):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1):
+        """foo
+
+        arg1:
+            arg1 is
+        """
+        pass
+
+
+Given python (def foo with 2 params):
+    def foo(arg1, arg2):
+        pass
+
+Execute:
+    Pydocstring
+
+Expect python:
+    def foo(arg1, arg2):
+        """foo
+
+        arg1:
+            arg1 is
+        arg2:
+            arg2 is
+        """
+        pass
+
+Execute (Clear pydocstring_templates_dir):
+    Restore

test/minimal_vimrc

@@ -0,0 +1,16 @@
+" Minimal vimrc to run tests
+" --------------------------
+
+set nocompatible
+set nu
+filetype off
+" Clear all rtp
+set rtp=$VIMRUNTIME
+
+
+" Add vader.vim to rtp
+set rtp+=./vader.vim
+
+" Add pydocstring folder into rtp
+set rtp+=../
+filetype plugin indent on

test/nodemon.json

@@ -0,0 +1,13 @@
+{
+  "watch": "../",
+  "ignore": [
+    ".git",
+    "node_modules/**/node_modules",
+    "vader.vim"
+  ],
+  "verbose": true,
+  "ext": "vader vim",
+  "execMap": {
+    "vader": "./run-single-test-file.sh"
+  }
+}

test/readme.md

@@ -0,0 +1,46 @@
+Test cases for vim-pydocstring
+==========================================
+
+Prerequisite
+------------
+
+- [vader.vim](https://github.com/junegunn/vader.vim)
+
+Before running test, clone vader into this directory with:
+
+```
+git clone https://github.com/junegunn/vader.vim
+```
+
+
+Run
+---
+
+```
+./run.sh
+```
+
+Note that the command need to be executed under `test` folder.
+
+Use TDD during development (optional)
+-------------------------------------
+
+You need [nodemon](https://github.com/remy/nodemon) to watch for files
+change and re-run the test cases in given file. Here I already provide
+nodemon configuration (see `nodemon.json`.)
+
+Run (again, this need to be executed under `test` folder)
+
+```
+nodemon <test-file>.vader
+```
+
+Now, if you modify the `vader` or `vim` files in this project, nodemon will
+re-run all the test cases (via `run-single-test-file.sh`).
+
+
+### Know issue
+
+Vim warns `Input is not from a terminal` when we run tests with
+`nodemon`. Neovim doesn't. That why in the scripts, we prefer to use
+`nvim` if it is found on path.