]> git.madduck.net Git - etc/vim.git/blobdiff - spec/indent/indent_spec.rb

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

tests: explicitly enable old "should" syntax to fix deprecation warnings (#92)
[etc/vim.git] / spec / indent / indent_spec.rb
index 77b94ef4c36ad8055cf24bfe0483ee78f3db1077..23c16293e953532190ff1273a01029a5b6ed5f7c 100644 (file)
@@ -2,7 +2,16 @@ require "spec_helper"
 
 shared_examples_for "vim" do
 
-  before(:each) { vim.normal 'gg"_dG' }  # clear buffer
+  before(:each) {
+    # clear buffer
+    vim.normal 'gg"_dG'
+
+    # Insert two blank lines.
+    # The first line is a corner case in this plugin that would shadow the
+    # correct behaviour of other tests. Thus we explicitly jump to the first
+    # line when we require so.
+    vim.feedkeys 'i\<CR>\<CR>\<ESC>'
+  }
 
   describe "when using the indent plugin" do
     it "sets the indentexpr and indentkeys options" do
@@ -17,11 +26,11 @@ shared_examples_for "vim" do
   end
 
   describe "when entering the first line" do
-    before { vim.feedkeys 'ipass' }
+    before { vim.feedkeys '0ggipass' }
 
     it "does not indent" do
-      proposed_indent.should == 0
       indent.should == 0
+      proposed_indent.should == 0
     end
 
     it "does not indent when using '=='" do
@@ -67,6 +76,41 @@ shared_examples_for "vim" do
     end
   end
 
+  describe "when after an '{' that is followed by a comment" do
+    before { vim.feedkeys 'imydict = {  # comment\<CR>' }
+
+    it "indent by one level" do
+      indent.should == shiftwidth
+      vim.feedkeys '1: 1,\<CR>'
+      indent.should == shiftwidth
+    end
+
+    it "lines up the closing parenthesis" do
+      vim.feedkeys '}'
+      indent.should == 0
+    end
+  end
+
+  describe "when using gq to reindent a '(' that is" do
+    before { vim.feedkeys 'itest(' }
+    it "something and has a string without spaces at the end" do
+      vim.feedkeys 'something_very_long_blaaaaaaaaa, "some_very_long_string_blaaaaaaaaaaaaaaaaaaaa"\<esc>gqq'
+      indent.should == 5
+    end
+  end
+
+  describe "when after multiple parens of different types" do
+    it "indents by one level" do
+      vim.feedkeys 'if({\<CR>'
+      indent.should == shiftwidth
+    end
+
+    it "lines up with the last paren" do
+      vim.feedkeys 'ifff({123: 456,\<CR>'
+      indent.should == 5
+    end
+  end
+
   describe "when '#' is contained in a string that is followed by a colon" do
     it "indents by one level" do
         vim.feedkeys 'iif "some#thing" == "test":#test\<CR>pass'
@@ -81,6 +125,77 @@ shared_examples_for "vim" do
     end
   end
 
+  describe "when inside an unfinished string" do
+    it "does not indent" do
+      vim.feedkeys 'i"test:\<ESC>'
+      vim.echo('synIDattr(synID(line("."), col("."), 0), "name")'
+              ).downcase.should include 'string'
+      vim.feedkeys 'a\<CR>'
+      proposed_indent.should == 0
+      indent.should == 0
+    end
+
+    it "does not dedent" do
+      vim.feedkeys 'iif True:\<CR>"test:\<ESC>'
+      vim.echo('synIDattr(synID(line("."), col("."), 0), "name")'
+              ).downcase.should include 'string'
+      proposed_indent.should == shiftwidth
+      indent.should == shiftwidth
+    end
+  end
+
+  describe "when the previous line has a colon in a string" do
+    before { vim.feedkeys 'itest(":".join(["1","2"]))\<CR>' }
+    it "does not indent" do
+      vim.feedkeys 'if True:'
+      indent.should == 0
+      proposed_indent.should == 0
+    end
+  end
+
+  describe "when the previous line has a list slice" do
+    it "does not indent" do
+      vim.feedkeys 'ib = a[2:]\<CR>'
+      indent.should == 0
+      proposed_indent.should == 0
+    end
+  end
+
+  describe "when line is empty inside a block" do
+    it "is indented like the previous line" do
+      vim.feedkeys 'idef a():\<CR>1\<CR>\<CR>2\<ESC>kcc'
+      indent.should == shiftwidth
+    end
+  end
+
+  describe "when an empty line is after empty line / before non-empty" do
+    it "is indented like the next line" do
+      vim.feedkeys 'idef a():\<CR>1\<CR>\<CR>\<CR>2\<ESC><<kcc'
+      indent.should == 0
+    end
+  end
+
+  describe "when an empty line is after empty line / before non-empty (nested)" do
+    it "is indented like the next line" do
+      vim.feedkeys 'idef a():\<CR>1\<CR>\<CR>\<CR>\<ESC>0i\<TAB>2\<ESC>kcc'
+      indent.should == shiftwidth
+    end
+  end
+
+  describe "when line is empty inside a block following multi-line statement" do
+    it "is indented like the previous line" do
+      vim.feedkeys 'idef a():\<CR>x = (1 +\<CR>2)\<CR>\<CR>y\<ESC>kcc'
+      indent.should == shiftwidth
+    end
+  end
+
+  describe "when line is empty inside a block following stop statement" do
+    it "is indented like the previous line minus shiftwidth" do
+      vim.feedkeys 'iif x:\<CR>if y:\<CR>pass\<CR>\<CR>z\<ESC>kcc'
+      indent.should == shiftwidth
+    end
+  end
+
   describe "when using simple control structures" do
       it "indents shiftwidth spaces" do
           vim.feedkeys 'iwhile True:\<CR>pass'
@@ -88,6 +203,73 @@ shared_examples_for "vim" do
       end
   end
 
+  describe "when using a function definition" do
+      it "indents shiftwidth spaces" do
+          vim.feedkeys 'idef long_function_name(\<CR>arg'
+          indent.should == shiftwidth * 2
+      end
+  end
+
+  describe "when using a class definition" do
+      it "indents shiftwidth spaces" do
+          vim.feedkeys 'iclass Foo(\<CR>'
+          indent.should == shiftwidth * 2
+      end
+  end
+
+  describe "when writing an 'else' block" do
+    it "aligns to the preceeding 'for' block" do
+      vim.feedkeys 'ifor x in "abc":\<CR>pass\<CR>else:'
+      indent.should == 0
+    end
+
+    it "aligns to the preceeding 'if' block" do
+      vim.feedkeys 'ifor x in "abc":\<CR>if True:\<CR>pass\<CR>else:'
+      indent.should == shiftwidth
+    end
+  end
+
+  describe "when using parens and control statements" do
+    it "avoids ambiguity by using extra indentation" do
+      vim.feedkeys 'iif (111 and\<CR>'
+      if shiftwidth == 4
+        indent.should == shiftwidth * 2
+      else
+        indent.should == 4
+      end
+      vim.feedkeys '222):\<CR>'
+      indent.should == shiftwidth
+      vim.feedkeys 'pass\<CR>'
+      indent.should == 0
+    end
+
+    it "still aligns parens properly if not ambiguous" do
+      vim.feedkeys 'iwhile (111 and\<CR>'
+      indent.should == 7
+      vim.feedkeys '222):\<CR>'
+      indent.should == shiftwidth
+      vim.feedkeys 'pass\<CR>'
+      indent.should == 0
+    end
+
+    it "still handles multiple parens correctly" do
+      vim.feedkeys 'iif (111 and (222 and 333\<CR>'
+      indent.should == 13
+      vim.feedkeys 'and 444\<CR>'
+      indent.should == 13
+      vim.feedkeys ')\<CR>'
+      if shiftwidth == 4
+        indent.should == shiftwidth * 2
+      else
+        indent.should == 4
+      end
+      vim.feedkeys 'and 555):\<CR>'
+      indent.should == shiftwidth
+      vim.feedkeys 'pass\<CR>'
+      indent.should == 0
+    end
+  end
+
   describe "when a line breaks with a manual '\\'" do
     it "indents shiftwidth spaces on normal line" do
         vim.feedkeys 'ivalue = test + \\\\\<CR>'
@@ -106,7 +288,7 @@ shared_examples_for "vim" do
   end
 
   describe "when current line is dedented compared to previous line" do
-     before { vim.feedkeys 'i\<TAB>\<TAB>if x:\<CR>return True\<CR>\<ESC>' }
+     before { vim.feedkeys 'i\<TAB>\<TAB>if x:\<CR>y = True\<CR>\<ESC>' }
      it "and current line has a valid indentation (Part 1)" do
         vim.feedkeys '0i\<TAB>if y:'
         proposed_indent.should == -1
@@ -123,6 +305,14 @@ shared_examples_for "vim" do
      end
   end
 
+  describe "when current line is dedented compared to the last non-empty line" do
+     before { vim.feedkeys 'i\<TAB>\<TAB>if x:\<CR>y = True\<CR>\<CR>\<ESC>' }
+     it "and current line has a valid indentation" do
+        vim.feedkeys '0i\<TAB>if y:'
+        proposed_indent.should == -1
+     end
+  end
+
   describe "when an 'if' is followed by" do
      before { vim.feedkeys 'i\<TAB>\<TAB>if x:\<CR>' }
      it "an elif, it lines up with the 'if'" do
@@ -136,6 +326,23 @@ shared_examples_for "vim" do
      end
   end
 
+  describe "when an 'if' contains a try-except" do
+     before {
+       vim.feedkeys 'iif x:\<CR>try:\<CR>pass\<CR>except:\<CR>pass\<CR>'
+       indent.should == shiftwidth
+     }
+     it "an 'else' should be indented to the try" do
+       vim.feedkeys 'else:'
+       indent.should == shiftwidth
+       proposed_indent.should == shiftwidth
+     end
+     it "an 'else' should keep the indent of the 'if'" do
+       vim.feedkeys 'else:\<ESC><<'
+       indent.should == 0
+       proposed_indent.should == 0
+     end
+  end
+
   describe "when a 'for' is followed by" do
      before { vim.feedkeys 'i\<TAB>\<TAB>for x in y:\<CR>' }
      it "an 'else', it lines up with the 'for'" do
@@ -144,6 +351,15 @@ shared_examples_for "vim" do
      end
   end
 
+  describe "when an 'else' is followed by" do
+     before { vim.feedkeys 'i\<TAB>\<TAB>else:\<CR>XXX\<CR>' }
+     it "a 'finally', it lines up with the 'else'" do
+        vim.feedkeys 'finally:'
+        indent.should == shiftwidth * 2
+     end
+  end
+
+
   describe "when a 'try' is followed by" do
      before { vim.feedkeys 'i\<TAB>\<TAB>try:\<CR>' }
      it "an 'except', it lines up with the 'try'" do
@@ -180,25 +396,121 @@ shared_examples_for "vim" do
      end
   end
 
-  def shiftwidth
-    @shiftwidth ||= vim.echo("exists('*shiftwidth') ? shiftwidth() : &sw").to_i
+  describe "when an else is used inside of a nested if" do
+    before { vim.feedkeys 'iif foo:\<CR>\<TAB>if bar:\<CR>\<TAB>\<TAB>pass\<CR>' }
+    it "indents an else to the inner if" do
+      vim.feedkeys 'else:'
+      indent.should == shiftwidth * 2
+    end
+  end
+
+  describe "when jedi-vim call signatures are used" do
+    before { vim.command 'syn match jediFunction "JEDI_CALL_SIGNATURE" keepend extend' }
+
+    it "ignores the call signature after a colon" do
+      vim.feedkeys 'iif True:  JEDI_CALL_SIGNATURE\<CR>'
+      indent.should == shiftwidth
+    end
+
+    it "ignores the call signature after a function" do
+      vim.feedkeys 'idef f(  JEDI_CALL_SIGNATURE\<CR>'
+      indent.should == shiftwidth * 2
+    end
+  end
+end
+
+shared_examples_for "multiline strings" do
+  before(:each) {
+    # clear buffer
+    vim.normal 'gg"_dG'
+
+    # Insert two blank lines.
+    # The first line is a corner case in this plugin that would shadow the
+    # correct behaviour of other tests. Thus we explicitly jump to the first
+    # line when we require so.
+    vim.feedkeys 'i\<CR>\<CR>\<ESC>'
+  }
+
+  describe "when after an '(' that is followed by an unfinished string" do
+    before { vim.feedkeys 'itest("""' }
+
+    it "it indents the next line" do
+      vim.feedkeys '\<CR>'
+      expected_proposed, expected_indent = multiline_indent(0, shiftwidth)
+      proposed_indent.should == expected_proposed
+      indent.should == expected_indent
+    end
+
+    it "with contents it indents the second line to the parenthesis" do
+      vim.feedkeys 'second line\<CR>'
+      expected_proposed, expected_indent = multiline_indent(0, 5)
+      proposed_indent.should == expected_proposed
+      indent.should == expected_indent
+    end
+  end
+
+  describe "when after assigning an unfinished string" do
+    before { vim.feedkeys 'itest = """' }
+
+    it "it indents the next line" do
+      vim.feedkeys '\<CR>'
+      expected_proposed, expected_indent = multiline_indent(0, shiftwidth)
+      proposed_indent.should == expected_proposed
+      indent.should == expected_indent
+    end
+  end
+
+  describe "when after assigning an unfinished string" do
+    before { vim.feedkeys 'i    test = """' }
+
+    it "it indents the next line" do
+      vim.feedkeys '\<CR>'
+      expected_proposed, expected_indent = multiline_indent(4, shiftwidth + 4)
+      proposed_indent.should == expected_proposed
+      indent.should == expected_indent
+    end
   end
-  def tabstop
-    @tabstop ||= vim.echo("&tabstop").to_i
+
+  describe "when after assigning a finished string" do
+    before { vim.feedkeys 'i    test = ""' }
+
+    it "it does indent the next line" do
+      vim.feedkeys '\<CR>'
+      indent.should == 4
+    end
+
+    it "and writing a new string, it does indent the next line" do
+      vim.feedkeys '\<CR>""'
+      indent.should == 4
+    end
   end
-  def indent
-    vim.echo("indent('.')").to_i
+
+  describe "when after a docstring" do
+    before { vim.feedkeys 'i    """' }
+    it "it does indent the next line to the docstring" do
+      vim.feedkeys '\<CR>'
+      indent.should == 4
+      proposed_indent.should == 4
+    end
   end
-  def previous_indent
-    pline = vim.echo("line('.')").to_i - 1
-    vim.echo("indent('#{pline}')").to_i
+
+  describe "when after a docstring with contents" do
+    before { vim.feedkeys 'i    """First line' }
+    it "it does indent the next line to the docstring" do
+      vim.feedkeys '\<CR>'
+      indent.should == 4
+      proposed_indent.should == 4
+    end
   end
-  def proposed_indent
-    line = vim.echo("line('.')")
-    col = vim.echo("col('.')")
-    indent_value = vim.echo("GetPythonPEPIndent(line('.'))").to_i
-    vim.command("call cursor(#{line}, #{col})")
-    return indent_value
+
+  describe "when breaking a string after opening parenthesis" do
+    before { vim.feedkeys 'i    foo("""bar<Left><Left><Left>' }
+    it "it does indent the next line as after an opening multistring" do
+      vim.feedkeys '\<CR>'
+      expected_proposed, expected_indent = multiline_indent(4, 4 + shiftwidth)
+      indent.should == expected_indent
+      proposed_indent.should == expected_proposed
+    end
   end
 end
 
@@ -206,14 +518,72 @@ describe "vim when using width of 4" do
   before {
     vim.command("set sw=4 ts=4 sts=4 et")
   }
+  it_behaves_like "vim"
+end
 
+describe "vim when using width of 3" do
+  before {
+    vim.command("set sw=3 ts=3 sts=3 et")
+  }
   it_behaves_like "vim"
 end
 
-describe "vim when using width of 8" do
+describe "vim when not using python_pep8_indent_multiline_string" do
   before {
-    vim.command("set sw=8 ts=8 sts=8 et")
+    vim.command("set sw=4 ts=4 sts=4 et")
+    vim.command("unlet! g:python_pep8_indent_multiline_string")
   }
+  it_behaves_like "multiline strings"
+end
 
-  it_behaves_like "vim"
+describe "vim when using python_pep8_indent_multiline_first=0" do
+  before {
+    vim.command("set sw=4 ts=4 sts=4 et")
+    vim.command("let g:python_pep8_indent_multiline_string=0")
+  }
+  it_behaves_like "multiline strings"
+end
+
+describe "vim when using python_pep8_indent_multiline_string=-1" do
+  before {
+    vim.command("set sw=4 ts=4 sts=4 et")
+    vim.command("let g:python_pep8_indent_multiline_string=-1")
+  }
+  it_behaves_like "multiline strings"
+end
+
+describe "vim when using python_pep8_indent_multiline_string=-2" do
+  before {
+    vim.command("set sw=4 ts=4 sts=4 et")
+    vim.command("let g:python_pep8_indent_multiline_string=-2")
+  }
+  it_behaves_like "multiline strings"
+end
+
+describe "vim for cython" do
+  before {
+    vim.command "enew"
+    vim.command "set ft=cython"
+    vim.command "runtime indent/python.vim"
+
+    # Insert two blank lines.
+    # The first line is a corner case in this plugin that would shadow the
+    # correct behaviour of other tests. Thus we explicitly jump to the first
+    # line when we require so.
+    vim.feedkeys 'i\<CR>\<CR>\<ESC>'
+  }
+
+  describe "when using a cdef function definition" do
+      it "indents shiftwidth spaces" do
+          vim.feedkeys 'icdef long_function_name(\<CR>arg'
+          indent.should == shiftwidth * 2
+      end
+  end
+
+  describe "when using a cpdef function definition" do
+      it "indents shiftwidth spaces" do
+          vim.feedkeys 'icpdef long_function_name(\<CR>arg'
+          indent.should == shiftwidth * 2
+      end
+  end
 end