Diffs for arrays of multiline strings don't make much sense

[myronmarston]

Given:

expect(["a\nb", "c\nd"]).to eq([])

This is the failure output:

     Failure/Error: expect(["a\nb", "c\nd"]).to eq([])

       expected: []
            got: ["a\nb", "c\nd"]

       (compared using ==)

       Diff:
       @@ -1 +1,4 @@
       +a
       +b,c
       +d

The diff doesn't make much sense here. I think the solution is to diff the arrays as objects, not strings, but my first attempt to make that change (e.g. by removing the flatten calls in fail_with) broke some other things. Overall, all the flattening in fail_with feels hacky and is confusing, but I'm not sure what the right fix is yet.

[fables-tales]

@myronmarston could the strings be escaped before being passed into diff when expecting with collections/arrays? That is the diff would look like:

Diff:
@@ -1, +1,3 @@
+"a\nb"
+"c\nd"

(and similar for sets)

[myronmarston]

Maybe. Want to take a stab at it?

[fables-tales]

I can't immediately, but I'm going to have more time in a couple of weeks, so I could probably take a look then.

[fables-tales]

@myronmarston so I got bored in a lecture and hacked this together:

  1) faces fails
     Failure/Error: expect(["a\nb", "c\nd"]).to eq([])

       expected: []
            got: ["a\nb", "c\nd"]

       (compared using ==)

       Diff:
       @@ -1 +1,3 @@
       +"a\nb"
       +"c\nd"

  2) faces bacon
     Failure/Error: expect(["a\nb", ["c\nd"]]).to eq([])

       expected: []
            got: ["a\nb", ["c\nd"]]

       (compared using ==)

       Diff:
       @@ -1 +1,3 @@
       +"a\nb"
       +["c\nd"]

is this what we want?

[fables-tales]

Another example:

  3) faces cows
     Failure/Error: expect(["a\nb", ["c,\nd", "asdf"]]).to eq([])

       expected: []
            got: ["a\nb", ["c,\nd", "asdf"]]

       (compared using ==)

       Diff:
       @@ -1 +1,3 @@
       +a\nb
       +["c,\nd", "asdf"]

[myronmarston]

That's definitely a big improvement. We can always start there and iterate on it.

[fables-tales]

Aight, I'll build some specs and fire off a pr.

[fables-tales]

This should be closed now right?

[myronmarston]

Yep. As usual, I forgot to close it...