Add {left, "."}, {left, ";"} to no_space; add {right, ";"} to operator_spaces (#470)

* Add `left, .` to `no_space` (default)

* Add `left, ;` to `no_space` (default)

* Add `right, ;` to `operator_spaces` (default)

* Act on self-review: more doc

* Handle left-of better

* Test further

Author: paulo-ferraz-oliveira

doc_rules/elvis_style/no_space.md

@@ -32,10 +32,12 @@ codebase.
 
 - `rules :: [{right | left, string()}]`
   - default: `[{right, "("}, {left, ")"}, {left, ","}, {left, ":"}, {right, "#"}, {right, "?"},
-  {right, "?"}]`
+  {right, "?"}, {left, "."}, {left, ";"}]`
 
 `{right, "#"}, {right, "?"}` was added in [4.0.0](https://github.com/inaka/elvis_core/releases/tag/4.0.0).
 
+`{left, "."}, {left, ";"}` was added in [4.1.0](https://github.com/inaka/elvis_core/releases/tag/4.1.0).
+
 ## Example configuration
 
 ```erlang
@@ -46,6 +48,8 @@ codebase.
                                    , {right, "#"}
                                    , {right, "?"}
                                    , {right, "?"}
+                                   , {left, "."}
+                                   , {left, ";"}
                                     ]
                                 }}
 ```

doc_rules/elvis_style/operator_spaces.md

@@ -34,15 +34,15 @@ compromised without adequate spacing.
          , {right, "<="}, {left, "<="}, {right, "||"}, {left, "||"}
          , {right, "|"}, {left, "|"}, {right, "::"}, {left, "::"}
          , {right, "->"}, {left, "->"}, {right, ","}, {right, "!"}
-         , {left, "!"}, {right, "?="}, {left, "?="}
+         , {left, "!"}, {right, "?="}, {left, "?="}, {right, ";"}
           ]
 ```
 
 `rules` was `[{right, ","}, {right, "++"}, {left, "++"}]` until [1.5.0](https://github.com/inaka/elvis_core/releases/tag/1.5.0).
 
 `{right, "!"}, {left, "!"}` was added in [4.0.0](https://github.com/inaka/elvis_core/releases/tag/4.0.0).
 
-`{right, "?="}, {left, "?="}` was added in [4.1.0](https://github.com/inaka/elvis_core/releases/tag/4.1.0).
+`{right, "?="}, {left, "?="}, {right, ";"}` was added in [4.1.0](https://github.com/inaka/elvis_core/releases/tag/4.1.0).
 
 ## Example configuration
 
@@ -59,7 +59,7 @@ compromised without adequate spacing.
                                           , {right, "<="}, {left, "<="}, {right, "||"}, {left, "||"}
                                           , {right, "|"}, {left, "|"}, {right, "::"}, {left, "::"}
                                           , {right, "->"}, {left, "->"}, {right, ","}, {right, "!"}
-                                          , {left, "!"}, {right, "?="}, {left, "?="}
+                                          , {left, "!"}, {right, "?="}, {left, "?="}, {right, ";"}
                                            ]
                                 }}
 ```

src/elvis_style.erl

@@ -343,10 +343,12 @@ default(operator_spaces) ->
                 {right, "!"},
                 {left, "!"},
                 {right, "?="},
-                {left, "?="}
+                {left, "?="},
+                {right, ";"}
             ]
     };
 default(no_space) ->
+    % ) one can happen at the start of lines; all others can't
     #{
         rules =>
             [
@@ -356,7 +358,9 @@ default(no_space) ->
                 {left, ":"},
                 {right, ":"},
                 {right, "#"},
-                {right, "?"}
+                {right, "?"},
+                {left, "."},
+                {left, ";"}
             ]
     };
 default(nesting_level) ->
@@ -2434,7 +2438,10 @@ macro_as_atom(false, [Type | OtherTypes], MacroNodeValue) ->
 % _ is re:mp()
 
 check_spaces(Lines, UnfilteredNodes, {Position, Text}, Encoding, {How0, _} = How) ->
-    FilterFun = fun(Node) -> ktn_code:attr(text, Node) =:= Text end,
+    FilterFun = fun(Node) ->
+        ktn_code:attr(text, Node) =:= Text orelse
+            (ktn_code:type(Node) =:= dot andalso Text =:= ".")
+    end,
     Nodes = lists:filter(FilterFun, UnfilteredNodes),
     SpaceChar = $\s,
     FlatFun =
@@ -2508,16 +2515,20 @@ character_at_location(
     SpaceChar = $\s,
 
     case {ColToCheck, Position, length(TextLineStr)} of
-        {0, _, _} when How =:= should_have ->
+        {0, _, _} when Text =/= ")" ->
             SpaceChar;
-        {0, _, _} when How =:= should_not_have ->
-            "";
         {_, right, LenLine} when How =:= should_have, ColToCheck > LenLine ->
             SpaceChar;
         {_, right, LenLine} when How =:= should_not_have, ColToCheck > LenLine ->
             "";
-        _ when How =:= should_have; TextRegex =:= nomatch ->
+        _ when How =:= should_have; TextRegex =:= nomatch, ColToCheck > 1 ->
             lists:nth(ColToCheck, TextLineStr);
+        _ when
+            How =:= should_not_have,
+            ColToCheck > 1,
+            (Text =:= ":" orelse Text =:= "." orelse Text =:= ";")
+        ->
+            lists:nth(ColToCheck - 1, TextLineStr);
         _ ->
             ""
     end.

test/examples/fail_no_space.erl

@@ -17,8 +17,8 @@
         , unicode_characters/0
         , windows_newlines/0
         , this/0
-        , this/2
-        , use_record/0
+, this/2
+        , use_record/0, dot_alone_1/0, dot_alone_2/0, dot_alone/1, colon_hurrah/0, colon_hurrah_2/0
         ]).
 
 -define(MACRO, "Brujo loves these").
@@ -91,7 +91,7 @@ tag_filters(DocName, #{conn := Conn} = State ) ->
   Values = [],
   case {Conn, Sql, Values} of
     {ok, Maps, _} ->
-      {ok, {raw, Maps}, State};
+      {ok, {raw, Maps}, State} ;
     {error, Error, _} ->
       {error, Error, State}
   end.
@@ -118,4 +118,29 @@ this(shouldnt_either, _A)
 - 2, A, $ . 
 
 use_record() ->
-    # a{one = 1, two = ? MACRO}.
+    # a{one = 1, two = ? MACRO} .
+
+dot_alone_1() ->
+    "The dot is in the next line"
+.
+
+dot_alone_2() ->
+    "The dot is in the next line"
+    .
+
+dot_alone(a) ->
+    "The ; is in the next line"
+;
+dot_alone(b) ->
+    "The ; is in the next line"
+    ;
+dot_alone(c) ->
+    ok.
+
+colon_hurrah() ->
+    m
+:a().
+
+colon_hurrah_2() ->
+    m
+  :a().

test/examples/fail_operator_spaces.erl

@@ -68,7 +68,7 @@ function8() ->
 function9() ->
     [X|| X <- [fail]] ++ [X ||X <- [fail]] ++ [X || X <- [notfail]].
 
-tag_filters(DocName, #{conn := Conn} = State) ->
+tag_filters(DocName, #{conn := Conn} = State) when is_list(DocName);is_binary(DocName) ->
   TableName = atom_to_list(DocName),
   Sql = ["SELECT "
          " 'tag' AS \"type\", "
@@ -82,10 +82,10 @@ tag_filters(DocName, #{conn := Conn} = State) ->
          "ORDER BY tag_name "],
   Values = [],
   case {Conn, Sql, Values} of
-    {ok, Maps, _} ->
+    {ok, Maps, _} when Maps=:=#{};Conn=:=established ->
       {ok, {raw, Maps}, State};
     {error, Error, _} ->
-      {error, Error, State}
+      {error, Error, State};{finally, this, _} -> nok
   end.
 
 unicode_characters() ->

test/style_SUITE.erl

@@ -652,6 +652,9 @@ verify_operator_spaces(Config) ->
         #{info := [left, "|" | _]},
         #{info := [right, "||" | _]},
         #{info := [left, "||" | _]},
+        #{info := [right, ";" | _]},
+        #{info := [right, ";" | _]},
+        #{info := [right, ";" | _]},
         #{info := [right, "::" | _]},
         #{info := [left, "::" | _]},
         #{info := [right, "->" | _]},
@@ -720,15 +723,25 @@ verify_no_space(Config) ->
     Path1 = "fail_no_space." ++ Ext,
     [
         #{info := [right, "(", 3]},
+        #{info := [left, ",", 20]},
         #{info := [right, "(", 36]},
         #{info := [right, "(", 52]},
         #{info := [left, ")", 52]},
         #{info := [left, ",", 76]},
         #{info := [left, ")", 79]},
+        #{info := [left, ";", 94]},
         #{info := [right, "(", 109]},
         #{info := [left, ")", 109]},
+        #{info := [left, ".", 118]},
         #{info := [right, "#", 121]},
-        #{info := [right, "?", 121]}
+        #{info := [right, "?", 121]},
+        #{info := [left, ".", 121]},
+        #{info := [left, ".", 125]},
+        #{info := [left, ".", 129]},
+        #{info := [left, ";", 133]},
+        #{info := [left, ";", 136]},
+        #{info := [left, ":", 142]},
+        #{info := [left, ":", 146]}
     ] =
         elvis_core_apply_rule(
             Config,