Show diff report in accessible colors and reveal hidden line characters #126

noahnu · 2020-02-09T02:22:46Z

Description

Refactors the diff reporter to improve accessibility and show diff on newlines and carriage returns.

Related Issues

Closes Syrupy assertion diff does not show missing carriage return #116 \r\n
Closes Account for accessibility and readability in snapshot outputs #120 a11y

Checklist

This PR has sufficient test coverage.
I have updated the CHANGELOG.md.

Additional Comments

No additional comments.

* wip * wip * wip * wip * wip * wip * wip

codecov · 2020-03-06T14:43:03Z

Codecov Report

Merging #126 into master will not change coverage by %.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #126   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines          757       847   +90     
=========================================
+ Hits           757       847   +90

iamogbz · 2020-03-06T14:53:35Z

src/syrupy/extensions/base.py

+
+    @property
+    def _context_line_count(self) -> int:
+        return 1


Previous implementation is equivalent to setting this to 0

noahnu · 2020-03-06T15:08:10Z

src/syrupy/extensions/amber.py

@@ -28,7 +29,7 @@ class DataSerializer:

    class MarkerDepthMax:
        def __repr__(self) -> str:
-            return "..."
+            return SYMBOL_ELLIPSIS


Even though we use the same symbol for context & max depth, semantically they're different and could theoretically change.

Sure, but then we could split the symbols apart at that point

iamogbz · 2020-03-06T16:56:53Z

src/syrupy/extensions/base.py

+                count_leading_whitespace: Callable[[str], int] = (
+                    lambda s: len(s) - len(s.lstrip())  # noqa: E731
+                )
+                if self._context_line_count:
+                    num_space = (
+                        count_leading_whitespace(lines[self._context_line_count - 1])
+                        + count_leading_whitespace(lines[-self._context_line_count])
+                    ) // 2
+                else:
+                    num_space = count_leading_whitespace(lines[num_lines // 2])


Simpler to reason about but leaves room for ... having weird indentation

Suggested change

count_leading_whitespace: Callable[[str], int] = (

lambda s: len(s) - len(s.lstrip()) # noqa: E731

)

if self._context_line_count:

num_space = (

count_leading_whitespace(lines[self._context_line_count - 1])

+ count_leading_whitespace(lines[-self._context_line_count])

) // 2

else:

num_space = count_leading_whitespace(lines[num_lines // 2])

mid_line = lines[num_lines // 2]

num_space = len(mid_line) - len(mid_line.lstrip())

noahnu · 2020-03-06T23:16:15Z

src/syrupy/extensions/base.py

+            is_diff_line = line[0] == "?"
+
+            if is_context_line or is_diff_line:
+                line = self.__strip_ends(line)


I was originally thinking of only showing the new line endings (i.e. the symbols) if necessary. So if the line endings are the only change.

noahnu · 2020-03-06T23:27:43Z

tests/test_extension_base.py

+        [
+            (
+                "line 0\nline 1\nline 02\nline 3\nline 4\r\nline 5\nline 6\nline 7",
+                "line 0\nline 1\nline 2\r\nline 3\nline 04\nline 5\nline 6\nline 7",


more cases:

trailing newlines

where the difference between 2 sets is extra whitespace (space, tab) at the end

different number of lines (additions + deletions)

noahnu · 2020-03-07T00:25:32Z

LGTM

iamogbz

LGTM

## [0.3.4](v0.3.3...v0.3.4) (2020-03-08) ### Bug Fixes * show hidden line characters and accessible colors ([#126](#126)) ([fa442df](fa442df)), closes [#150](#150)

syrupy-bot · 2020-03-08T04:22:30Z

🎉 This PR is included in version 0.3.4 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

noahnu added 3 commits February 15, 2020 19:25

wip: rewrite assertion diff report

cab5bdd

wip: add colours, more context?

d37c57c

wip: refactor staged line logic

b8c69c4

noahnu force-pushed the improved_assertion_diff branch from 088e331 to b8c69c4 Compare February 16, 2020 00:54

wip: linting

4fa30e5

noahnu requested a review from iamogbz February 16, 2020 01:03

noahnu mentioned this pull request Feb 22, 2020

Account for accessibility and readability in snapshot outputs #120

Closed

iamogbz added 2 commits March 6, 2020 03:06

Merge branch 'master' into improved_assertion_diff

383e5bf

wip: rewrite assertion diff report (#150)

bb6f98a

* wip * wip * wip * wip * wip * wip * wip

iamogbz changed the title ~~wip: rewrite assertion diff report~~ Show diff report in accessible colors and reveal hidden line characters Mar 6, 2020

iamogbz reviewed Mar 6, 2020

View reviewed changes

noahnu commented Mar 6, 2020

View reviewed changes

Emmanuel Ogbizi added 3 commits March 6, 2020 11:31

refactor: replace generator type with iterator

622dbe9

refactor: limit context using generators

5a548ca

refactor: reduce diff

eb6a40b

iamogbz reviewed Mar 6, 2020

View reviewed changes

iamogbz force-pushed the improved_assertion_diff branch from e897763 to eb6a40b Compare March 6, 2020 16:58

Emmanuel Ogbizi added 6 commits March 6, 2020 12:32

refactor: add note about impossible cases

2199f22

test: hidden characters

ebeebf7

chore: update changelog

4fac91d

chore: update changelog

b82baec

test: diff reporter

5f5fa0d

lint: shorten line

3538777

iamogbz marked this pull request as ready for review March 6, 2020 22:39

noahnu self-assigned this Mar 6, 2020

noahnu commented Mar 6, 2020

View reviewed changes

Emmanuel Ogbizi added 2 commits March 6, 2020 18:55

test: more snapshot test cases

9c4e4f6

fix: allow context style to work in all backgrounds

df9ed53

iamogbz approved these changes Mar 7, 2020

View reviewed changes

iamogbz merged commit fa442df into master Mar 7, 2020

iamogbz deleted the improved_assertion_diff branch March 7, 2020 00:27

syrupy-bot pushed a commit that referenced this pull request Mar 8, 2020

chore(release): 0.3.4 [skip ci]

3380f87

## [0.3.4](v0.3.3...v0.3.4) (2020-03-08) ### Bug Fixes * show hidden line characters and accessible colors ([#126](#126)) ([fa442df](fa442df)), closes [#150](#150)

syrupy-bot added the released label Mar 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show diff report in accessible colors and reveal hidden line characters #126

Show diff report in accessible colors and reveal hidden line characters #126

noahnu commented Feb 9, 2020 •

edited by iamogbz

Loading

codecov bot commented Mar 6, 2020 •

edited

Loading

iamogbz Mar 6, 2020

noahnu Mar 6, 2020

iamogbz Mar 6, 2020

iamogbz Mar 6, 2020

noahnu Mar 6, 2020

noahnu Mar 6, 2020

noahnu commented Mar 7, 2020

iamogbz left a comment

syrupy-bot commented Mar 8, 2020

Show diff report in accessible colors and reveal hidden line characters #126

Show diff report in accessible colors and reveal hidden line characters #126

Conversation

noahnu commented Feb 9, 2020 • edited by iamogbz Loading

Description

Related Issues

Checklist

Additional Comments

codecov bot commented Mar 6, 2020 • edited Loading

Codecov Report

iamogbz Mar 6, 2020

Choose a reason for hiding this comment

noahnu Mar 6, 2020

Choose a reason for hiding this comment

iamogbz Mar 6, 2020

Choose a reason for hiding this comment

iamogbz Mar 6, 2020

Choose a reason for hiding this comment

noahnu Mar 6, 2020

Choose a reason for hiding this comment

noahnu Mar 6, 2020

Choose a reason for hiding this comment

noahnu commented Mar 7, 2020

iamogbz left a comment

Choose a reason for hiding this comment

syrupy-bot commented Mar 8, 2020

noahnu commented Feb 9, 2020 •

edited by iamogbz

Loading

codecov bot commented Mar 6, 2020 •

edited

Loading