Leaving blank lines before return statements in blocks

Author: SteveWilkes

ReadableExpressions.UnitTests/WhenFormattingCode.cs

@@ -215,6 +215,7 @@ public void ShouldDeclareAVariableIfUsedBeforeInitialisation()
 string name;
 Func<string> getName = () => name;
 name = ""Fred"";
+
 return getName.Invoke();";
 
             Assert.AreEqual(EXPECTED.TrimStart(), translated);
@@ -414,6 +415,7 @@ public void ShouldVarAssignAVariableUsedInNestedConstructs()
             try
             {
                 var msLength = memoryStream.Length;
+
                 return msLength;
             }
             catch
@@ -432,6 +434,7 @@ public void ShouldVarAssignAVariableUsedInNestedConstructs()
             try
             {
                 var fsLength = fileStream.Length;
+
                 return fsLength;
             }
             catch
@@ -800,6 +803,7 @@ public void ShouldTranslateMultilineBlockSingleMethodArguments()
         var i = 3;
         i = i * 5;
         i = i / 3;
+
         return i;
     }
     catch

ReadableExpressions.UnitTests/WhenTranslatingAssignments.cs

@@ -86,6 +86,7 @@ public void ShouldTranslateAMultiLineCheckedSubtractionAssignment()
     {
         var one = Console.Read();
         var two = Console.Read();
+
         return (one + two);
     }
 }";
@@ -418,12 +419,14 @@ public void ShouldTranslateAMultipleLineTernaryAssignment()
         var one = Console.Read();
         var two = Console.Read();
         var resultOne = one * two;
+
         return resultOne;
     }
     : {
         var three = Console.Read();
         var four = Console.Read();
         var resultTwo = three / four;
+
         return resultTwo;
     }";
             Assert.AreEqual(EXPECTED.TrimStart(), translated);
@@ -504,6 +507,7 @@ public void ShouldTranslateANestedBlockAssignment()
 {
     var one = Console.Read();
     var two = Console.Read();
+
     return (one - two);
 }";
             Assert.AreEqual(EXPECTED.TrimStart(), translated);
@@ -533,6 +537,7 @@ public void ShouldTranslateMultiStatementValueBlockAssignments()
 {
     List<int> ints;
     Console.Read();
+
     return (ints == null)
         ? new List<int>()
         : {
@@ -640,6 +645,7 @@ public void ShouldTranslateAssignmentsOfNestedVariableBlocksWithATernaryReturnVa
 guid =
 {
     var id = value;
+
     Guid guidValue;
     return Guid.TryParse((id != null) ? id.ToString() : null, out guidValue) ? guidValue : default(Guid);
 }";
@@ -687,6 +693,7 @@ public void ShouldTranslateAssignmentsOfNestedVariableBlocksWithANestedTernaryRe
 guid =
 {
     var id = value;
+
     Guid guidValue;
     return (id != null)
         ? Guid.TryParse(id.ToString(), out guidValue) ? guidValue : default(Guid)

ReadableExpressions.UnitTests/WhenTranslatingBlocks.cs

@@ -120,6 +120,7 @@ public void ShouldTranslateAVariableBlockLambdaWithAReturnValue()
 {
     var count = 0;
     ++count;
+
     return count;
 }";
 
@@ -146,6 +147,7 @@ public void ShouldTranslateAVariableBlockLambdaWithAReturnExpression()
             const string EXPECTED = @"() =>
 {
     var list = new List<int> { 1, 2, 3 };
+
     return list.ToArray();
 }";
 
@@ -356,6 +358,7 @@ public void ShouldIncludeAReturnStatementForACoalesce()
 
             const string EXPECTED = @"
 var myString = yourString;
+
 return (myString ?? string.Empty);";
 
             Assert.AreEqual(EXPECTED.TrimStart(), translated);

ReadableExpressions.UnitTests/WhenTranslatingConditionals.cs

@@ -227,11 +227,13 @@ public void ShouldTranslateAMultipleLineNonVoidIfElseStatements()
 {
     Console.WriteLine(""Hello"");
     Console.WriteLine(""Goodbye"");
+
     return i;
 }
 
 Console.WriteLine(""Goodbye"");
 Console.WriteLine(""Hello"");
+
 return i;
 ";
             Assert.AreEqual(EXPECTED.Trim(), translated);
@@ -403,6 +405,7 @@ public void ShouldIncludeReturnKeywordsForConstantsAndCasts()
 
 Console.WriteLine(""One!"");
 Console.WriteLine(""One!"");
+
 return ((long?)1);";
 
             Assert.AreEqual(EXPECTED.TrimStart(), translated);

ReadableExpressions.UnitTests/WhenTranslatingGotos.cs

@@ -187,6 +187,7 @@ public void ShouldTranslateAReturnStatementWithABlock()
     var i = 0;
     i = i + 1;
     i = i + 2;
+
     return i;
 }";
 
@@ -224,6 +225,7 @@ public void ShouldTranslateALabelWithABlockDefaultValue()
 return 
 {
     i = i + 2;
+
     return i;
 };";
 

ReadableExpressions.UnitTests/WhenTranslatingMathsOperations.cs

@@ -123,6 +123,7 @@ public void ShouldTranslateACheckedMultiplicationExpression()
     {
         var one = Console.Read();
         var two = Console.Read();
+
         return (one + two);
     } * i
 }";

ReadableExpressions/Translators/BlockExpressionTranslator.cs

@@ -68,8 +68,10 @@ private static IEnumerable<string> GetBlockStatements(
             for (var i = 0; i < lines.Count; i++)
             {
                 var line = lines[i];
+                var isNotFirstLine = (i > 0);
+                var previousLine = isNotFirstLine ? lines[i - 1] : null;
 
-                if ((i > 0) && LeaveBlankLineBefore(line, lines[i - 1]))
+                if (isNotFirstLine && LeaveBlankLineBefore(line, previousLine))
                 {
                     yield return string.Empty;
                 }
@@ -92,6 +94,11 @@ private static IEnumerable<string> GetBlockStatements(
                     yield break;
                 }
 
+                if (isNotFirstLine && LeaveBlankLineBeforeReturn(line, previousLine))
+                {
+                    yield return string.Empty;
+                }
+
                 if (CodeBlock.IsSingleStatement(line.SplitToLines()))
                 {
                     yield return "return " + line;
@@ -219,5 +226,15 @@ private static bool DoNotAddReturnStatement(BlockExpression block, ICollection<s
         {
             return (lines.Count <= 1) || !block.IsReturnable();
         }
+
+        private static bool LeaveBlankLineBeforeReturn(string line, string previousLine)
+        {
+            if (previousLine.IsComment() || LeaveBlankLineAfter(previousLine, line))
+            {
+                return false;
+            }
+
+            return true;
+        }
     }
 }