add MapEntyAssertionSamples in infix package #911

kacmacuna · 2021-05-22T11:17:29Z

I confirm that I have read the Contributor Agreements v1.0, agree to be bound on them and confirm that my contribution is compliant.

...infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryExpectations.kt

...test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/deprecated/MapEntryAssertionSamples.kt

robstoll · 2021-05-22T19:30:16Z

...test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/deprecated/MapEntryAssertionSamples.kt

+class MapEntryAssertionSamples {
+
+    @Test
+    fun isKeyValue() {


you forgot to add the @sample in the KDoc in mapEntryExpectations.kt

Thanks for adding this documentation in addition (next to MapExpectationSamples). You need to add the @sample tag to the functions in mapEntryAssertions.kt (as you need to do it for mapEntryExpectations.kt) if you want that the users of Atrium actually see it in the docs

...test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/deprecated/MapEntryAssertionSamples.kt

codecov · 2021-05-22T19:39:52Z

Codecov Report

Merging #911 (e90e491) into MapEntyAssertionSamples (c053551) will increase coverage by 0.14%.
The diff coverage is 100.00%.

❗ Current head e90e491 differs from pull request most recent head 4cc8765. Consider uploading reports for the commit 4cc8765 to get more accurate results

@@                     Coverage Diff                     @@
##           MapEntyAssertionSamples     #911      +/-   ##
===========================================================
+ Coverage                    91.01%   91.16%   +0.14%     
===========================================================
  Files                          420      426       +6     
  Lines                         4141     4209      +68     
  Branches                       210      210              
===========================================================
+ Hits                          3769     3837      +68     
  Misses                         323      323              
  Partials                        49       49

Flag	Coverage Δ
bbc	`80.96% <20.00%> (-1.33%)`	⬇️
bc	`80.87% <20.00%> (-1.33%)`	⬇️
current	`88.02% <100.00%> (-1.26%)`	⬇️
current_windows	`87.07% <100.00%> (-1.24%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...eli/atrium/api/infix/en_GB/mapEntryExpectations.kt	`100.00% <100.00%> (ø)`
...nerated/kotlin/ch/tutteli/atrium/logic/mapEntry.kt	`100.00% <100.00%> (ø)`
...eli/atrium/logic/impl/DefaultMapEntryAssertions.kt	`100.00% <100.00%> (ø)`
...trium/api/infix/en_GB/chronoLocalDateAssertions.kt	`100.00% <0.00%> (ø)`
...rium/api/fluent/en_GB/chronoLocalDateAssertions.kt	`100.00% <0.00%> (ø)`
...m/api/infix/en_GB/chronoLocalDateTimeAssertions.kt	`100.00% <0.00%> (ø)`
...m/api/infix/en_GB/chronoZonedDateTimeAssertions.kt	`100.00% <0.00%> (ø)`
.../api/fluent/en_GB/chronoLocalDateTimeAssertions.kt	`100.00% <0.00%> (ø)`
.../api/fluent/en_GB/chronoZonedDateTimeAssertions.kt	`100.00% <0.00%> (ø)`
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c053551...4cc8765. Read the comment docs.

robstoll · 2021-05-26T18:27:27Z

...infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryExpectations.kt

 *
 * @return an [Expect] for the subject of `this` expectation.
 *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.MapEntryExpectationSamples.toEqualKeyValue


same same for other methods, also add the @sample tag to the key and value overloads. You can check if it works by holding ALT + clicking with your middle mouse on the method name

robstoll · 2021-05-26T18:33:13Z

...mmon/src/test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/MapEntryExpectationSamples.kt

+        // subject here is of type Int (actually 1)
+        expect(mapOf(1 to "a").entries.first()).key toEqual 1


IMO this is misleading as one does not know if you mean the initial subject map(1 to "a") or the one after key. I suggest you re-format it to the following (also in other places):

Suggested change

// subject here is of type Int (actually 1)

expect(mapOf(1 to "a").entries.first()).key toEqual 1

expect(mapOf(1 to "a").entries.first()).key toEqual 1

// | subject is now of type Int (actually 1)

And to make it even more obvious, could also add an extra line (up to you which one you prefer)

Suggested change

// subject here is of type Int (actually 1)

expect(mapOf(1 to "a").entries.first()).key toEqual 1

expect(mapOf(1 to "a").entries.first()).key toEqual 1

// | | subject is now of type Int (actually 1)

// | subject is of type Map<Int, String>

robstoll · 2021-05-26T18:35:19Z

...test/kotlin/ch/tutteli/atrium/api/infix/en_GB/samples/deprecated/MapEntryAssertionSamples.kt

+class MapEntryAssertionSamples {
+
+    @Test
+    fun isKeyValue() {


Thanks for adding this documentation in addition (next to MapExpectationSamples). You need to add the @sample tag to the functions in mapEntryAssertions.kt (as you need to do it for mapEntryExpectations.kt) if you want that the users of Atrium actually see it in the docs

...i-infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

...infix-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/mapEntryExpectations.kt

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryExpectations.kt

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

robstoll · 2021-05-31T10:08:46Z

@kacmacuna going to fix the last point myself. Thanks for your first contribution to Atrium 👍

add MapEntyAssertionSamples in infix package

e90e491

kacmacuna requested a review from robstoll as a code owner May 22, 2021 11:17

robstoll requested changes May 22, 2021

View reviewed changes

kacmacuna added 2 commits May 24, 2021 15:35

apply pr feedback

04eb2ec

fix @sample text

9c5b9c9

kacmacuna requested a review from robstoll May 24, 2021 12:18

add MapEntrySamples

1121fa0

robstoll requested changes May 26, 2021

View reviewed changes

kacmacuna added 2 commits May 31, 2021 13:54

apply pr feedback

c5345a8

remove unnecessary parentheses

bbd2e18

kacmacuna requested a review from robstoll May 31, 2021 10:03

robstoll requested changes May 31, 2021

View reviewed changes

robstoll added 4 commits May 31, 2021 12:07

Update apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin…

1ae1051

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryExpectations.kt

Update apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin…

85e8b7d

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

Update apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin…

79b7b93

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

Update apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin…

cf3634f

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

robstoll changed the base branch from master to MapEntyAssertionSamples May 31, 2021 10:07

Update apis/infix-en_GB/atrium-api-infix-en_GB-common/src/main/kotlin…

4cc8765

…/ch/tutteli/atrium/api/infix/en_GB/mapEntryAssertions.kt

robstoll merged commit 37b8749 into robstoll:MapEntyAssertionSamples May 31, 2021

		// subject here is of type Int (actually 1)
		expect(mapOf(1 to "a").entries.first()).key toEqual 1

Uh oh!

add MapEntyAssertionSamples in infix package #911

add MapEntyAssertionSamples in infix package #911

Uh oh!

Conversation

kacmacuna commented May 22, 2021

Uh oh!

Uh oh!

Uh oh!

robstoll May 22, 2021

Choose a reason for hiding this comment

Uh oh!

robstoll May 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

robstoll May 26, 2021

Choose a reason for hiding this comment

Uh oh!

robstoll May 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robstoll May 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

robstoll commented May 31, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

robstoll May 26, 2021 •

edited

Loading

codecov bot commented May 22, 2021 •

edited

Loading

robstoll May 26, 2021 •

edited

Loading

robstoll May 26, 2021 •

edited

Loading