Merge pull request hamcrest#227 from tumbarumba/master

sf105 · web-flow · commit 9c53a793fed1 · 2018-11-08T10:09:29.000Z
Move wiki pages to docs
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1 @@
+markdown: kramdown
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -7,4 +7,5 @@
   <meta name="date" content="2018-11-01"/>
   <title>{{ page.title }}</title>
   <link href="css/hamcrest.css" rel="stylesheet" type="text/css">
+  <link href="css/pygments-default.css" rel="stylesheet" type="text/css">
 </head>
diff --git a/docs/css/pygments-default.css b/docs/css/pygments-default.css
@@ -0,0 +1,61 @@
+.highlight .hll { background-color: #ffffcc }
+.highlight .c { color: #408080; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
+.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #808080 } /* Generic.Output */
+.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0040D0 } /* Generic.Traceback */
+.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #008000 } /* Keyword.Pseudo */
+.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #B00040 } /* Keyword.Type */
+.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #7D9029 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #A0A000 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
+.highlight .sc { color: #BA2121 } /* Literal.String.Char */
+.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
+.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.highlight .sx { color: #008000 } /* Literal.String.Other */
+.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
+.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
+.highlight .ss { color: #19177C } /* Literal.String.Symbol */
+.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #19177C } /* Name.Variable.Class */
+.highlight .vg { color: #19177C } /* Name.Variable.Global */
+.highlight .vi { color: #19177C } /* Name.Variable.Instance */
+.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
diff --git a/docs/distributables.md b/docs/distributables.md
@@ -0,0 +1,107 @@
+---
+title: Hamcrest Distributables
+layout: default
+---
+[Java Hamcrest Home](index)
+
+# Hamcrest Distributables
+{:.no_toc}
+
+## Introduction
+{:.no_toc}
+
+Hamcrest consists of different jars matching the different needs of
+applications. This document describes these distributables and the
+functionality contained in each of them.
+
+## Table of Contents
+{:.no_toc}
+
+* TOC
+{:toc}
+
+## The Java Hamcrest Jars
+
+### `hamcrest-core.jar`
+
+This is the core API to be used by third-party framework providers.
+This includes a foundation set of matcher implementations for common
+operations. This API is stable and will rarely change. You will
+need this library as a minimum.
+
+### `hamcrest-library.jar`
+
+The library of Matcher implementations which are based on the core 
+functionality in hamcrest-core.jar.
+
+### `hamcrest-integration.jar`
+
+Provides integration between Hamcrest and other testing tools, such as jMock
+and EasyMock. Uses hamcrest-core.jar and hamcrest-library.jar.
+
+### `hamcrest-generator.jar`
+
+A tool to allow many Matcher implementations to be combined into
+a single class with static methods returning the different matchers 
+so users don't have to remember many classes/packages to import. 
+Generates code. This library is only used internally at compile time.
+It is not necessary for the use of any of the other hamcrest libraries 
+at runtime.
+
+### `hamcrest-all.jar`
+
+One jar containing all classes of all the other jars.
+
+
+## Adding Hamcrest to your Project
+
+The dependencies of the jars (`hamcrest-integration` uses `hamcrest-library`
+which uses `hamcrest-core`) is represented by the Maven dependency mechanism.
+There is no `hamcrest-all` library in the Maven repo prior to version 1.3. Just
+use hamcrest-integration which references all the other hamcrest libraries.
+ 
+
+### Gradle
+
+Add `"org.hamcrest:hamcrest-library:1.3"` to the dependencies section of your
+`build.gradle`, for example:
+
+```gradle
+apply plugin: 'java'
+
+dependencies {
+    testImplementation 'org.hamcrest:hamcrest-library:1.3'
+}
+```
+
+Note: older versions of Gradle use the `testCompile` configuration
+instead of the `testImplementation` configuration.
+
+### Maven
+
+Add the following dependency declaration to your `pom.xml`:
+
+```xml
+<dependency>
+    <groupId>org.hamcrest</groupId>
+    <artifactId>hamcrest-library</artifactId>
+    <version>1.3</version>
+    <scope>test</scope>
+</dependency>
+```
+
+### Download
+
+You can download the jars directly from Maven Central. At a minimum, you will
+need `hamcrest-core.jar`, though most people will also use
+`hamcrest-library.jar` too. If you want to integrate Hamcrest Matchers with
+other test tools, such as jMock or EasyMock, download `hamcrest-integration.jar`, too.
+
+You can find the jars by searching Maven Central for groupId `org.hamcrest`
+using the following link:
+
+> [https://search.maven.org/search?q=g:org.hamcrest](https://search.maven.org/search?q=g:org.hamcrest) 
+
+Maven central has some extra artifacts called `java-hamcrest` and `hamcrest-java`,
+with a version of `2.0.0.0`. Please do not use these, as they are an aborted effort
+at repackaging the different jars.
diff --git a/docs/index.md b/docs/index.md
@@ -8,15 +8,15 @@ layout: default
 
 ### Documentation
 
-* [Getting Started](https://github.com/hamcrest/JavaHamcrest/wiki/The-Hamcrest-Tutorial)
+* [Getting Started](tutorial)
 * [API Documentation (JavaDoc)](javadoc/)
 
 ### Downloads
 
-* [Distributables and Dependency Configuration](https://github.com/hamcrest/JavaHamcrest/wiki/Hamcrest-Distributables)
+* [Distributables and Dependency Configuration](distributables)
 * [Source Repository](http://github.com/hamcrest/JavaHamcrest)
 * [Project License](http://opensource.org/licenses/BSD-3-Clause)
-* [Extensions](https://github.com/hamcrest/JavaHamcrest/wiki/Related-Projects)
+* [Extensions and Related Projects](related)
 
 ### User Support
 
diff --git a/docs/related.md b/docs/related.md
@@ -0,0 +1,29 @@
+---
+title: Hamcrest Related Projects
+layout: default
+---
+[Java Hamcrest Home](index)
+
+# Related Projects
+
+Here are some projects that provide additional features and matchers
+
+* [Hamcrest Text Patterns](http://code.google.com/p/hamcrest-text-patterns/)
+* [Hamcrest Java Extras](https://github.com/sf105/hamcrest-java-extras) (currently only a couple of Json matchers)
+* [Hamcrest JSON](https://github.com/hertzsprung/hamcrest-json) (for comparing entire JSON documents)
+* [Hamcrest Date](https://github.com/modularit/hamcrest-date) (for comparing dates)
+* [Hamcrest Path](https://github.com/seinesoftware/hamcrest-path) (for testing path existence and permissions) 
+* [Hamcrest HAR](https://github.com/roydekleijn/har-assert) (for HTTP archive files)
+* [Hamcrest avro](https://github.com/Byhiras/avro-utils)
+* [Hamcrest 1.3 Utility Matchers](https://github.com/NitorCreations/matchers) (Java matchers like CollectionMatchers, MapMatchers, FieldMatcher, SerializableMatcher etc)
+* [Hamcrest Querydsl](https://github.com/beloglazov/hamcrest-querydsl) (for checking query results: hasResultSize, hasColumnRange, hasColumnMax, hasColumnMin, hasColumnContainingAll, hasColumnContainingAny)
+* [JsonUnit](https://github.com/lukas-krecan/JsonUnit) (for comparing JSON structures jsonEquals, jsonPartEquals)
+* [json-path-matchers](https://github.com/jayway/JsonPath/tree/master/json-path-assert) (for evaluating JSON path expressions)
+* [EZ Testing](https://github.com/EZGames/ez-testing) (contains base classes for defining chainable matchers that have a similar style to AssertJ)
+* [valid4j](https://github.com/valid4j/valid4j) (assertion and validation library, i.e supporting design-by-contract style and/or recoverable input validation)
+* [http-matchers](https://github.com/valid4j/http-matchers) (Matchers to test your web service via the standard Java API for RESTful Services (JAX-RS))
+* [Awaitility](https://github.com/jayway/awaitility) (a DSL that allows you to express expectations of an asynchronous system in a concise and easy to read manner)
+* [Proboscis](https://github.com/sf105/proboscis) (a tiny java library for polling for a result, originally intended for tested asynchronous systems)
+* [hamcrest-pojo-matcher-generator](https://github.com/yandex-qatools/hamcrest-pojo-matcher-generator) (Annotation processor to generate feature-matchers based on your POJOs)
+* [Spotify's hamcrest matchers](https://github.com/spotify/java-hamcrest) (Matchers for POJOs, JSON, and some of the types introduced in Java 8)
+* [Shazamcrest](https://github.com/shazam/shazamcrest) (Matchers for beans with custom field matching and nice failure messages)
diff --git a/docs/tutorial.md b/docs/tutorial.md
