Add AssertJ Guava assertions guide (#46)

* Add ByteSource, Multimap and Multiset assertions

* Use autowidth for tables

* Use parameterized javadoc url

* Add Optional assertions

* Just use latest version

* Add Range, RangeMap and Table assertions

* Add RangeSet assertions

src/docs/asciidoc/link-attributes.adoc

@@ -1,4 +1,5 @@
 :javadoc-root:                           https://www.javadoc.io/doc/org.assertj/assertj-core/
+:assertj-guava-javadoc-root:             https://www.javadoc.io/doc/org.assertj/assertj-guava/latest/
 //
 :assertj-core-repo:                      https://github.com/joel-costigliola/assertj-core
 :assertj-guava-repo:                     https://github.com/joel-costigliola/assertj-guava

src/docs/asciidoc/user-guide/assertj-guava-assertions-guide.adoc

@@ -0,0 +1,272 @@
+[[assertj-guava-assertions-guide]]
+=== Assertions Guide
+
+This section describes the assertions provided by AssertJ Guava.
+
+==== ByteSource
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/ByteSourceAssert.html#hasSameContentAs(com.google.common.io.ByteSource)[`hasSameContentAs`]
+|Verifies that the actual `ByteSource` has the same content as the provided one.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/ByteSourceAssert.html#hasSize(long)[`hasSize`]
+|Verifies that the size of the actual `ByteSource` is equal to the given one.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/ByteSourceAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `ByteSource` is empty.
+|===
+
+==== Multimap
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#contains(org.assertj.core.data.MapEntry...)[`contains`]
+|Verifies that the actual `Multimap` contains the given entries.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#containsAllEntriesOf(com.google.common.collect.Multimap)[`containsAllEntriesOf`]
+|Verifies that the actual `Multimap` contains all entries of the given one (it might contain more entries).
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#containsKeys(K...)[`containsKeys`]
+|Verifies that the actual `Multimap` contains the given keys.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#containsValues(V...)[`containsValues`]
+|Verifies that the actual `Multimap` contains the given values for any key.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#hasSameEntriesAs(com.google.common.collect.Multimap)[`hasSameEntriesAs`]
+|Verifies that the actual `Multimap` has the same entries as the given one.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#hasSize(int)[`hasSize`]
+|Verifies that the number of values in the actual `Multimap` is equal to the given one.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `Multimap` is empty.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultimapAssert.html#isNotEmpty()[`isNotEmpty`]
+|Verifies that the actual `Multimap` is not empty.
+|===
+
+==== Multiset
+
+In addition to `Iterable` link:#assertj-core-iterable-assertions[assertions], the following are also available.
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultisetAssert.html#contains(int,T)[`contains`]
+|Verifies the actual `Multiset` contains the given value *exactly* the given number of times.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultisetAssert.html#containsAtLeast(int,T)[`containsAtLeast`]
+|Verifies the actual `Multiset` contains the given value *at least* the given number of times.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/MultisetAssert.html#containsAtMost(int,T)[`containsAtMost`]
+|Verifies the actual `Multiset` contains the given value *at most* the given number of times.
+|===
+
+==== Optional
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/OptionalAssert.html#contains(java.lang.Object)[`contains`]
+|Verifies that the actual `Optional` contains the given value.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/OptionalAssert.html#extractingCharSequence()[`extractingCharSequence`]
+|Chain assertion on the content of the `Optional`.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/OptionalAssert.html#extractingValue()[`extractingValue`]
+|Chain assertion on the content of the `Optional`.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/OptionalAssert.html#isAbsent()[`isAbsent`]
+|Verifies that the actual `Optional` contained instance is absent/null.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/OptionalAssert.html#isPresent()[`isPresent`]
+|Verifies that the actual `Optional` contains a (non-null) instance.
+|===
+
+==== Range
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#contains(T...)[`contains`]
+|Verifies that the actual `Range` contains the given values.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#doesNotContain(T...)[`doesNotContain`]
+|Verifies that the actual `Range` does not contain the given values.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasClosedLowerBound()[`hasClosedLowerBound`]
+|Verifies that the actual `Range` lower bound is closed.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasClosedUpperBound()[`hasClosedUpperBound`]
+|Verifies that the actual `Range` upper bound is closed.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasLowerEndpointEqualTo(T)[`hasLowerEndpointEqualTo`]
+|Verifies that the actual `Range` lower endpoint is equal to the given value.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasOpenedLowerBound()[`hasOpenedLowerBound`]
+|Verifies that the actual `Range` lower bound is opened.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasOpenedUpperBound()[`hasOpenedUpperBound`]
+|Verifies that the actual `Range` upper bound is opened.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#hasUpperEndpointEqualTo(T)[`hasUpperEndpointEqualTo`]
+|Verifies that the actual `Range` upper endpoint is equal to the given value.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `Range` is empty.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeAssert.html#isNotEmpty()[`isNotEmpty`]
+|Verifies that the actual `Range` is not empty.
+|===
+
+==== RangeMap
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeMapAssert.html#contains(org.assertj.core.data.MapEntry...)[`contains`]
+|Verifies that the actual `RangeMap` contains the given entries.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeMapAssert.html#containsKeys(K...)[`containsKeys`]
+|Verifies that the actual `RangeMap` contains the given keys.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeMapAssert.html#containsValues(V...)[`containsValues`]
+|Verifies that the actual `RangeMap` contains the given values.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeMapAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `RangeMap` is empty.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeMapAssert.html#isNotEmpty()[`isNotEmpty`]
+|Verifies that the actual `RangeMap` is not empty.
+|===
+
+==== RangeSet
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#contains(T...)[`contains`]
+|Verifies that the given `RangeSet` contains the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#containsAll(java.lang.Iterable)[`containsAll`]
+|Verifies that the given `RangeSet` contains all the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#containsAnyOf(T...)[`containsAnyOf`]
+|Verifies that the given `RangeSet` contains at least one of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#containsAnyRangesOf(java.lang.Iterable)[`containsAnyRangesOf`]
+|Verifies that the given `RangeSet` contains at least one of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotContain(T...)[`doesNotContain`]
+|Verifies that the given `RangeSet` does not contain any of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotContainAll(java.lang.Iterable)[`doesNotContainAll`]
+|Verifies that the given `RangeSet` does not contain any of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotEnclose(com.google.common.collect.Range...)[`doesNotEnclose`]
+|Verifies that the given `RangeSet` does not enclose the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotEncloseAnyRangesOf(com.google.common.collect.RangeSet)[`doesNotEncloseAnyRangesOf`]
+|Verifies that the given `RangeSet` does not enclose any range from the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotEncloseAnyRangesOf(java.lang.Iterable)[`doesNotEncloseAnyRangesOf`]
+|Verifies that the given `RangeSet` does not enclose any of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotIntersect(com.google.common.collect.Range...)[`doesNotIntersect`]
+|Verifies that the given `RangeSet` does not intersect the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotIntersectAnyRangeFrom(com.google.common.collect.RangeSet)[`doesNotIntersectAnyRangeFrom`]
+|Verifies that the given `RangeSet` does not intersect ranges from the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#doesNotIntersectAnyRangeFrom(java.lang.Iterable)[`doesNotIntersectAnyRangeFrom`]
+|Verifies that the given `RangeSet` does not intersect all the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#encloses(com.google.common.collect.Range...)[`encloses`]
+|Verifies that the given `RangeSet` encloses the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#enclosesAll(com.google.common.collect.RangeSet)[`enclosesAll`]
+|Verifies that the given `RangeSet` encloses all ranges from the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#enclosesAll(java.lang.Iterable)[`enclosesAll`]
+|Verifies that the given `RangeSet` encloses all the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#enclosesAnyOf(com.google.common.collect.Range...)[`enclosesAnyOf`]
+|Verifies that the given `RangeSet` encloses at least one of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#enclosesAnyRangesOf(com.google.common.collect.RangeSet)[`enclosesAnyRangesOf`]
+|Verifies that the given `RangeSet` encloses at least one range from the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#enclosesAnyRangesOf(java.lang.Iterable)[`enclosesAnyRangesOf`]
+|Verifies that the given `RangeSet` encloses at least one range of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#hasSize(int)[`hasSize`]
+|Verifies that the given `RangeSet` has specific `size` of disconnected `Range` elements.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersects(com.google.common.collect.Range...)[`intersects`]
+|Verifies that the given `RangeSet` intersects all the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersectsAll(com.google.common.collect.RangeSet)[`intersectsAll`]
+|Verifies that the given `RangeSet` intersects all the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersectsAll(java.lang.Iterable)[`intersectsAll`]
+|Verifies that the given `RangeSet` intersects all the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersectsAnyOf(com.google.common.collect.Range...)[`intersectsAnyOf`]
+|Verifies that the given `RangeSet` intersects at least one of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersectsAnyRangesOf(com.google.common.collect.RangeSet)[`intersectsAnyRangesOf`]
+|Verifies that the given `RangeSet` intersects at least one range of the given range set.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#intersectsAnyRangesOf(java.lang.Iterable)[`intersectsAnyRangesOf`]
+|Verifies that the given `RangeSet` intersects at least one of the given ranges.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `RangeSet` is empty.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#isNotEmpty()[`isNotEmpty`]
+|Verifies that the actual `RangeSet` is not empty.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/RangeSetAssert.html#isNullOrEmpty()[`isNullOrEmpty`]
+|Verifies that the actual `RangeSet` is null or empty.
+|===
+
+==== Table
+
+[%autowidth]
+|===
+|Assertion |Description
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#containsCell(R,C,V)[`containsCell`]
+|Verifies that the actual `Table` contains the mapping of row/column to value.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#containsColumns(C...)[`containsColumns`]
+|Verifies that the actual `Table` contains the given columns.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#containsRows(R...)[`containsRows`]
+|Verifies that the actual `Table` contains the given rows.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#containsValues(V...)[`containsValues`]
+|Verifies that the actual `Table` contains the given values for any key.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#hasColumnCount(int)[`hasColumnCount`]
+|Verifies that the actual `Table` has the expected number of columns.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#hasRowCount(int)[`hasRowCount`]
+|Verifies that the actual `Table` has the expected number of rows.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#hasSize(int)[`hasSize`]
+|Verifies that the actual `Table` has the expected number of cells.
+
+|{assertj-guava-javadoc-root}org/assertj/guava/api/TableAssert.html#isEmpty()[`isEmpty`]
+|Verifies that the actual `Table` is empty.
+|===

src/docs/asciidoc/user-guide/assertj-guava.adoc

@@ -1,4 +1,6 @@
 [[assertj-guava]]
 == AssertJ Guava
 
+include::assertj-guava-assertions-guide.adoc[]
+
 include::assertj-guava-release-notes.adoc[]