Removed redundant anonymizer.

Added documentation link to the header of the homepage. Added list of available anonymizers to the documentation.
realrolfje · Feb 14, 2020 · be1109e · be1109e
1 parent 30a115e
commit be1109e
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 144 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -9,6 +9,7 @@ exclude: [ruby, Gemfile, Gemfile.lock, serve_local_jekyll_site.sh]
 github:
   zip_url: https://github.com/realrolfje/anonimatron/releases/latest
   repository_url: https://github.com/realrolfje/anonimatron/tree/master
+  documentation_url: /documentation
 
 plugins:
   - jekyll-mentions

diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -22,14 +22,17 @@
   <body>
     <header class="page-header" role="banner">
       <div class="logo">
-          <h1 class="project-name">{{ site.title | default: site.github.repository_name }}</h1>
+        <h1 class="project-name"><a href="/" style="color: inherit">{{ site.title | default: site.github.repository_name }}</a></h1>
           <h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
-        {% if site.github.is_project_page %}
+      {% if site.github.is_project_page %}
         <a href="{{ site.github.repository_url }}" class="btn github">View on GitHub</a>
       {% endif %}
       {% if site.show_downloads %}
         <a href="{{ site.github.zip_url }}" class="btn zip">Download .zip</a>
       {% endif %}
+        {% if site.github.is_project_page %}
+        <a href="{{ site.github.documentation_url }}" class="btn documentation">Documentation</a>
+      {% endif %}
     </div>
   </header>
 

diff --git a/docs/assets/css/book-flat-30.png b/docs/assets/css/book-flat-30.png
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -17,6 +17,13 @@
     padding-left: 47px;
 }
 
+.btn.documentation {
+    background-image: url(book-flat-30.png);
+    background-repeat: no-repeat;
+    background-position: 10px;
+    padding-left: 47px;
+}
+
 .logo {
     background-image: url(anonimatron-logo-a.png);
     background-repeat: no-repeat;

diff --git a/docs/documentation/index.md b/docs/documentation/index.md
@@ -0,0 +1,26 @@
+# Anonimatron documentation
+
+For more information on how Anonimatron works and runs, check our [GitHub readme.md](https://github.com/realrolfje/anonimatron/blob/master/README.md).
+
+## Available Anonymizers
+
+Anonimatron comes with the following default anonymizers. Please start Anonimatron with the `-configexample`
+parameter to see how these are configured:
+
+| Name                              | Type                | Input            | Output                                                                   |
+|:----------------------------------|:--------------------|:-----------------|:-------------------------------------------------------------------------|
+| CharacterStringAnonymizer         | RANDOMCHARACTERS    | Any string       | A-Z, same length                                                         |
+| CharacterStringPrefetchAnonymizer | RANDOMCHARACTERS    | Any string       | Characters from all input data, same length                              |
+| CountryCodeAnonymizer             | COUNTRY_CODE        | Any string       | ISO 3166-1 alpha 2 or alpha 3 code                                       |
+| DateAnonymizer                    | DATE                | Valid date       | Date between 31 days before and 32 days after the input date             |
+| DigitStringAnonymizer             | RANDOMDIGITS        | Any string       | 0-9, same length, optional mask                                          | 
+| DutchBankAccountAnononymizer      | DUTCHBANKACCOUNT    | Any string       | 11 proof number, minimal 9 digits                                        | 
+| DutchBSNAnononymizer              | BURGERSERVICENUMMER | Number or string | Valid Dutch "Burger Service Nummer" or "SOFI Nummer" as number or string |
+| DutchZipCodeAnonymizer            | DUTCH_ZIP_CODE      | Any string       | Valid Dutch zip/postal code                                              |
+| ElvenNameGenerator                | ELVEN_NAME          | Any string       | Pronounceable elven name, 2 to 5 syllables                               | 
+| EmailAddressAnonymizer            | EMAIL_ADDRESS       | Any string       | Valid email address in the domain "@example.com"                         |
+| IbanAnonymizer                    | IBAN                | Any string       | Valid International Bank Account Number                                  |
+| RomanNameGenerator                | ROMAN_NAME          | Any string       | Pronounceable Roman name, 2 to 5 syllables                               | 
+| StringAnonymizer                  | STRING              | Any string       | Random hexadecimal string                                                |
+| UkPostCodeAnonymizer              | UK_POST_CODE        | Any string       | Valid Uk Post code                                                       |
+| UUIDAnonymizer                    | UUID                | Any string       | A random UUID                                                            |
diff --git a/src/main/java/com/rolfje/anonimatron/anonymizer/DutchBSNAnononymizer.java b/src/main/java/com/rolfje/anonimatron/anonymizer/DutchBSNAnononymizer.java
@@ -8,7 +8,7 @@
 import java.math.BigInteger;
 
 /**
- * Generates valid Dutch "Burger Service Nummer" or "SOFI Nummer",a social
+ * Generates valid Dutch "Burger Service Nummer" or "SOFI Nummer", a social
  * security number uniquely identifying civilians to the governement.
  * <p>
  * A BSN Number is 9 digits long, can not start with 3 zeroes, the first digit

diff --git a/src/main/java/com/rolfje/anonimatron/anonymizer/PartialDigitsAnonymizer.java b/src/main/java/com/rolfje/anonimatron/anonymizer/PartialDigitsAnonymizer.java
diff --git a/src/test/java/com/rolfje/anonimatron/anonymizer/PartialCharacterAnonymizerTest.java b/src/test/java/com/rolfje/anonimatron/anonymizer/PartialCharacterAnonymizerTest.java