Improve formatting of multidimensional arrays (#991) by DmitriyMaksimov · Pull Request #1044 · fluentassertions/fluentassertions

DmitriyMaksimov · 2019-05-13T12:55:10Z

Implemented formatting of multidimensional arrays (MultidimensionalArrayFormatter)
Added unit test for the formatter
Supported formatting of multidimensional arrays with bounds
Supported formatting of n-ary dimensional arrays

DmitriyMaksimov · 2019-05-13T13:03:03Z

Test When_no_exception_should_be_thrown_after_wait_time_but_it_was_it_should_throw failed - think the test is "blinking" it has failed on my PC few times as well. Don't see why my changes could affect the test.

dennisdoomen

Thanks for the work you've done. IMHO, it needs a bit of cleaning. I hope you're willing to spend a bit more time on this.

dennisdoomen · 2019-05-13T14:16:02Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+
+            var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();
+
+            bool IsFirstIteration(int index, int dimention)


Please don't use local functions. This method is already extremely long and quite difficult to follow.

dennisdoomen · 2019-05-13T14:16:14Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+        {
+            var arr = (Array)value;
+
+            if (arr.Length <= 0)


Can this ever be negative?

dennisdoomen · 2019-05-13T14:17:11Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+        }
+
+        /// <inheritdoc />
+        public string Format(object value, FormattingContext context, FormatChild formatChild)


Any chance you can break it down into smaller methods so that the algorithm is more clearer?

dennisdoomen · 2019-05-13T14:17:43Z

Tests/Shared.Specs/FormatterSpecs.cs

+            result.Should().Match("{{{'1-5-7', '1-5-8', '1-5-9', '1-5-10'}, {'1-6-7', '1-6-8', '1-6-9', '1-6-10'}, {'1-7-7', '1-7-8', '1-7-9', '1-7-10'}}, {{'2-5-7', '2-5-8', '2-5-9', '2-5-10'}, {'2-6-7', '2-6-8', '2-6-9', '2-6-10'}, {'2-7-7', '2-7-8', '2-7-9', '2-7-10'}}}".Replace("'", "\""));
+        }
+
+        public static IEnumerable<object[]> MultiDimentionalArrayData =>


Please put this directly below the test method that needs it.

dennisdoomen · 2019-05-13T14:19:26Z

Tests/Shared.Specs/FormatterSpecs.cs


+        [Theory]
+        [MemberData(nameof(MultiDimentionalArrayData))]
+        public void When_formatting_a_multi_dimentional_array_it_should_show_structure(object value, string expected)


Can you please move these into a dedicated specs class? Most of what's here is pretty old and still needs to be split.

* Unit tests moved into a dedicated specs class * MemberData moved directly below the test method that needs it * Use private methods instead of local functions

DmitriyMaksimov · 2019-05-15T11:28:15Z

@dennisdoomen Thanks for your code review!
I made requested changes except "Any chance you can break it down into smaller methods so that the algorithm is more clearer?" - it's a tricky one. Actually it's a while loop which emulates n-ary loop - have no idea how to split it. Saying that, I moved local functions out, so now the method is 58 lines and half of them are empty lines/brackets, so not as bad as used to be.
Please let me know if you spot another issue(s).

jnyrup

The implemented algorithm and tests looks good to me.
I especially liked that you cover the case, where the array does not start at index 0.

I've given some comments which I think could help making the intent of the algorithm more clear.

jnyrup · 2019-05-15T11:44:21Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+
+            var sb = new StringBuilder();
+
+            var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();


How about dimensionIndices?

jnyrup · 2019-05-15T11:44:45Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+
+            var sb = new StringBuilder();
+
+            var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();


dimention ->dimension

jnyrup · 2019-05-15T11:45:34Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+            return sb.ToString();
+        }
+
+        private bool IsFirstIteration(Array arr, int index, int dimention)


dimention ->dimension

jnyrup · 2019-05-15T11:45:39Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+            return index == arr.Rank - 1;
+        }
+
+        private bool IsLastIteration(Array arr, int index, int dimention)


dimention ->dimension

jnyrup · 2019-05-15T11:46:34Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+            return index == arr.GetLowerBound(dimention);
+        }
+
+        private bool IsMostInnerLoop(Array arr, int index)


IsMostInnerLoop -> IsInnerMostLoop

jnyrup · 2019-05-15T11:47:18Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+            return index >= arr.GetUpperBound(dimention);
+        }
+
+        private bool IsNotLastIteration(Array arr, int index, int dimention)


🙃 I would leave out that function and just use !IsLastIteration directly.

jnyrup · 2019-05-15T12:10:57Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+            // Emulate n-ary loop
+            while (currentLoopIndex >= 0)
+            {
+                var loopValue = indecies[currentLoopIndex];


Would currentDimensionIndex be a more describing name for loopValue?

jnyrup · 2019-05-15T12:25:36Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+                    sb.Append(formatChild(string.Join("-", indecies), enumerator.Current));
+                    if (IsNotLastIteration(arr, loopValue, currentLoopIndex))
+                        sb.Append(", ");
+                    ++indecies[currentLoopIndex];       // Increment loop variable


Please put comments right above the statement.

jnyrup · 2019-05-15T12:41:04Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+                    if (currentLoopIndex < 0)
+                        break;
+
+                    // update loopValue and loopMaxValue


loopMaxValue does not exist.
From CSharpGuidelines

Try to focus comments on the why and what of a code block and not the how. Avoid explaining the statements in words, but instead help the reader understand why you chose a certain solution or algorithm and what you are trying to achieve. If applicable, also mention that you chose an alternative solution because you ran into a problem with the obvious solution. ...

jnyrup · 2019-05-15T12:54:21Z

Src/FluentAssertions/Formatting/MultidimensionalArrayFormatter.cs

+
+            var sb = new StringBuilder();
+
+            var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();


We prefer not using var, unless the type is explicitly specified.
https://github.com/dennisdoomen/CSharpGuidelines/blob/master/_pages/1500_MaintainabilityGuidelines.md#-only-use-var-when-the-type-is-very-obvious-av1520-

* Renamed variables * Removed redundant comments * Use explicit type instead of `var`

DmitriyMaksimov · 2019-05-15T19:40:15Z

@jnyrup Thanks for your comments!
I made requested changes - they are improved code readability significantly.
Please review when you have a chance.

jnyrup · 2019-05-15T19:56:48Z

@DmitriyMaksimov Thanks for the contribution - Fluent Assertions just got one tad better.
Look out for your name in the next release.

DmitriyMaksimov · 2019-05-15T20:27:54Z

Happy to contribute 😄
It's my first, but hope not last contribution into FluentAssertions.
Thank you very much for guiding me along the process!

Improve formatting of multidimensional arrays (#991)

0aee1d7

dennisdoomen requested changes May 13, 2019

View reviewed changes

Changes requested on code review:

b960a24

* Unit tests moved into a dedicated specs class * MemberData moved directly below the test method that needs it * Use private methods instead of local functions

dennisdoomen approved these changes May 15, 2019

View reviewed changes

jnyrup requested changes May 15, 2019

View reviewed changes

Changes requested on code review:

a408bcd

* Renamed variables * Removed redundant comments * Use explicit type instead of `var`

jnyrup approved these changes May 15, 2019

View reviewed changes

jnyrup merged commit 0ed6bbd into fluentassertions:master May 15, 2019

jnyrup mentioned this pull request May 15, 2019

Improve formatting of multidimensional arrays #991

Closed


		var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();

		bool IsFirstIteration(int index, int dimention)


		var sb = new StringBuilder();

		var indecies = Enumerable.Range(0, arr.Rank).Select(dimention => arr.GetLowerBound(dimention)).ToArray();

Conversation

DmitriyMaksimov commented May 13, 2019

Uh oh!

DmitriyMaksimov commented May 13, 2019

Uh oh!

dennisdoomen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DmitriyMaksimov commented May 15, 2019

Uh oh!

jnyrup left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DmitriyMaksimov commented May 15, 2019

Uh oh!

jnyrup commented May 15, 2019

Uh oh!

DmitriyMaksimov commented May 15, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants