don't change indent of doc blocks, strings, and comments

Fixes #505 Fixes #346

Author: jbodah

autoload/elixir/indent.vim

@@ -21,6 +21,7 @@ function! elixir#indent#indent(lnum)
 
  let handlers = [
  \'top_of_file',
+ \'starts_with_string_continuation',
  \'following_trailing_binary_operator',
  \'starts_with_pipe',
  \'starts_with_binary_operator',
@@ -31,9 +32,14 @@ function! elixir#indent#indent(lnum)
  \]
  for handler in handlers
  call s:debug('testing handler elixir#indent#handle_'.handler)
- let context = {'lnum': lnum, 'text': text, 'prev_nb_lnum': prev_nb_lnum, 'prev_nb_text': prev_nb_text}
+ let context = {'lnum': lnum, 'text': text, 'first_nb_char_idx': match(text, '\w'), 'prev_nb_lnum': prev_nb_lnum, 'prev_nb_text': prev_nb_text}
  let indent = function('elixir#indent#handle_'.handler)(context)
- if indent != -1
+ if indent == -2
+ " Keep indent the same
+ call s:debug('line '.lnum.': elixir#indent#handle_'.handler.' returned -2; returning indent of -1')
+ call cursor(curs_lnum, curs_col)
+ return -1
+ elseif indent != -1
  call s:debug('line '.lnum.': elixir#indent#handle_'.handler.' returned '.indent)
  call cursor(curs_lnum, curs_col)
  return indent
@@ -98,7 +104,11 @@ endfunction
 " Returns 0 or 1 based on whether or not the given line number and column
 " number pair is a string or comment
 function! s:is_string_or_comment(line, col)
- return synIDattr(synID(a:line, a:col, 1), "name") =~ '\%(String\|Comment\)'
+ return s:syntax_name(a:line, a:col) =~ '\%(String\|Comment\)'
+endfunction
+
+function! s:syntax_name(line, col)
+ return synIDattr(synID(a:line, a:col, 1), "name")
 endfunction
 
 " Skip expression for searchpair. Returns 0 or 1 based on whether the value
@@ -154,6 +164,14 @@ function! elixir#indent#handle_top_of_file(context)
  end
 endfunction
 
+function! elixir#indent#handle_starts_with_string_continuation(context)
+ if s:syntax_name(a:context.lnum, a:context.first_nb_char_idx) =~ '\(String\|Comment\)$'
+ return -2
+ else
+ return -1
+ end
+endfunction
+
 function! elixir#indent#handle_follow_prev_nb(context)
  return s:get_base_indent(a:context.prev_nb_lnum, a:context.prev_nb_text)
 endfunction

spec/indent/comment_spec.rb

@@ -41,5 +41,16 @@ def run(task) when task in [:t1, :t2] do
  {:error, :timed_out_waiting_for_lock}
  end
  EOF
+
+ it "bulk indenting comments" do
+ expect(<<~EOF).to be_elixir_indentation
+ defmodule Test do
+ # SELECT *
+ # FROM table
+ # WHERE column = 123
+ # AND another_column = 456
+ end
+ EOF
+ end
 end
 

spec/indent/documentation_spec.rb

@@ -10,4 +10,25 @@
  """
  end
  EOF
+
+ it "bulk indenting doc blocks" do
+ expect(<<~EOF).to be_elixir_indentation
+ defmodule Test do
+ @doc """
+ do not reindent
+ any indent that i do
+ please
+ """
+ end
+ EOF
+ end
+
+ i <<~EOF
+ defmodule Test do
+ @doc """
+ it should
+ have reasonable
+ default start indent when typed
+ """
+ EOF
 end

spec/indent/string_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Indenting strings' do
+ it "bulk indenting strings" do
+ expect(<<~EOF).to be_elixir_indentation
+ defp sql do
+ """
+ SELECT *
+ FROM table
+ WHERE column = 123
+ AND another_column = 456
+ """
+ end
+ EOF
+ end
+end

spec/spec_helper.rb

@@ -13,7 +13,8 @@ def initialize(vim, type)
 
  def reindent(content)
  with_file content do
- cmd = 'ggVG999<<' # remove all indentation
+ min_indent = content.each_line.map { |line| line[/\s*/].size }.min
+ cmd = "ggVG:s/\\s\\{0,#{min_indent}}//" # remove all indentation
  cmd += 'gg=G' # force vim to indent the file
  @vim.normal cmd
  end
@@ -144,6 +145,8 @@ def self.new
  to be indented as
 
  #{code}
+
+ when typed
  EOM
  end
 end
@@ -169,6 +172,8 @@ def self.new
  to be indented as
 
  #{code}
+
+ when bulk indented
  EOM
  end
  end
@@ -284,14 +289,7 @@ def ip(str)
 
  def gen_tests(method, str)
  send method, "\n#{str}" do
- reload = -> do
- VIM.add_plugin(File.expand_path('..', __dir__), 'ftdetect/elixir.vim')
- received = ExBuffer.new.reindent(str)
- puts received
- str == received
- end
- actual = ExBuffer.new.reindent(str)
- expect(actual).to eq(str)
+ expect(str).to be_elixir_indentation
  end
 
  send method, "typed: \n#{str}" do