Prepare for release

CHANGELOG.md

@@ -1,3 +1,21 @@
+Version 0.4.0 (2017-06-01)
+--------------------------
+
+- support bacteria names parsing (#322)
+- support hyphenated genus name with capitalized part (#320)
+- support `Oe` unicode character (#321)
+- handle lowercase subgenus (#328)
+- support input from STDIN and output to STDOUT (#346)
+- add `el` as author's prefix (#305)
+- support author with `'t` (#252, #255)
+- `pv.` (for `pathovar.`) is parsed as rank (#353)
+- socket usage (Ruby example) documentation is improved (#355)
+- parse `von dem` and `v.` (for `von`) as author prefix (#249, #329)
+- names with "satellite(s)" in the end are not parsed as viruses (#246)
+- handle `variety` for rank (#233)
+- all examples are tested during CircleCI build
+- parsing bugs fixes (#332, #330, #327, #326)
+
 Version 0.3.3 (2016-10-05)
 --------------------------
 

README.rst

@@ -22,10 +22,10 @@ Try it as a command line tool under Linux/Mac:
 
 .. code:: bash
 
-    wget https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.3.3/gnparser-0.3.3.zip
-    unzip gnparser-0.3.3.zip
+    wget https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.4.0/gnparser-0.4.0.zip
+    unzip gnparser-0.4.0.zip
     sudo rm -rf /opt/gnparser
-    sudo mv gnparser-0.3.3 /opt/gnparser
+    sudo mv gnparser-0.4.0 /opt/gnparser
     sudo rm -f /usr/local/bin/gnparser
     sudo ln -s /opt/gnparser/bin/gnparser /usr/local/bin
     gnparser name "Homo sapiens Linnaeus"
@@ -47,7 +47,7 @@ Finally, run it right from your SBT console:
 
     $ mkdir -p project
     $ echo 'sbt.version=0.13.12' > project/build.properties
-    $ sbt ';set libraryDependencies += "org.globalnames" %% "gnparser" % "0.3.3";console'
+    $ sbt ';set libraryDependencies += "org.globalnames" %% "gnparser" % "0.4.0";console'
     scala> import org.globalnames.parser.ScientificNameParser.{instance => scientificNameParser}
     scala> scientificNameParser.fromString("Homo sapiens Linnaeus").renderCompactJson
 
@@ -206,7 +206,7 @@ SBT:
 
 .. code:: Scala
 
-    libraryDependencies += "org.globalnames" %% "gnparser" % "0.3.3"
+    libraryDependencies += "org.globalnames" %% "gnparser" % "0.4.0"
 
 Maven:
 
@@ -215,20 +215,20 @@ Maven:
     <dependency>
         <groupId>org.globalnames</groupId>
         <artifactId>gnparser_2.11</artifactId>
-        <version>0.3.3</version>
+        <version>0.4.0</version>
     </dependency>
 
     <dependency>
         <groupId>org.globalnames</groupId>
         <artifactId>gnparser_2.10</artifactId>
-        <version>0.3.3</version>
+        <version>0.4.0</version>
     </dependency>
 
 Release Package
 ---------------
 
 `Release
-package <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.3.3>`_
+package <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.4.0>`_
 should be sufficient for all usages but development. It is not needed
 for including ``gnparser`` into Java or Scala code -- `declare dependency
 instead <#dependency-declaration-for-java-or-scala>`_.
@@ -244,11 +244,11 @@ Released Files
 ===============================   ===============================================
 File                              Description
 ===============================   ===============================================
-``gnparser-assembly-0.3.3.jar``   `Fat Jar <#fat-jar>`_
-``gnparser-0.3.3.zip``            `Command line tool, web and socket
+``gnparser-assembly-0.4.0.jar``   `Fat Jar <#fat-jar>`_
+``gnparser-0.4.0.zip``            `Command line tool, web and socket
                                   server <#command-line-tool-and-socket-server>`_
-``release-0.3.3.zip``             Source code's zip file
-``release-0.3.3.tar.gz``          Source code's tar file
+``release-0.4.0.zip``             Source code's zip file
+``release-0.4.0.tar.gz``          Source code's tar file
 ===============================   ===============================================
 
 Fat Jar
@@ -259,9 +259,9 @@ necessary to run a program. Such a jar would include Scala and all
 required libraries.
 
 `Fat
-jar <https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.3.3/gnparser-assembly-0.3.3.jar>`_
+jar <https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.4.0/gnparser-assembly-0.4.0.jar>`_
 for ``gnparser`` can be found in the `current
-release <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.3.3>`_.
+release <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.4.0>`_.
 
 Command Line Tool and Socket Server
 -----------------------------------
@@ -271,18 +271,18 @@ Installation on Linux/Mac
 
 .. code:: bash
 
-    wget https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.3.3/gnparser-0.3.3.zip
-    unzip gnparser-0.3.3.zip
+    wget https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.4.0/gnparser-0.4.0.zip
+    unzip gnparser-0.4.0.zip
     sudo rm -rf /opt/gnparser
-    sudo mv gnparser-0.3.3 /opt/gnparser
+    sudo mv gnparser-0.4.0 /opt/gnparser
     sudo rm -f /usr/local/bin/gnparser
     sudo ln -s /opt/gnparser/bin/gnparser /usr/local/bin
 
 Installation on Windows
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 1. Download
-   `gnparser-0.3.3.zip <https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.3.3/gnparser-0.3.3.zip>`_
+   `gnparser-0.4.0.zip <https://github.com/GlobalNamesArchitecture/gnparser/releases/download/release-0.4.0/gnparser-0.4.0.zip>`_
 2. Extract it to a place where you usually store program files
 3. Update your `PATH <https://java.com/en/download/help/path.xml>`_ to
    point to bin subdirectory
@@ -425,7 +425,7 @@ To avoid declaring multiple dependencies Jython, JRuby and R need a
 `reference gnparser fat-jar <#fat-jar>`_.
 
 If you decide to follow examples get the code from the
-`release <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.3.3>`_
+`release <https://github.com/GlobalNamesArchitecture/gnparser/releases/tag/release-0.4.0>`_
 or `clone it from GitHub <#getting-code-for-development>`_
 
 Scala
@@ -480,7 +480,7 @@ To run it execute the command:
 .. code:: bash
 
     java -jar $JYTHON_HOME/jython.jar \
-      -Dpython.path=/path/to/gnparser-assembly-0.3.3.jar \
+      -Dpython.path=/path/to/gnparser-assembly-0.4.0.jar \
       examples/jython/parser.py
 
 (JYTHON\_HOME needs to be defined or replaced by path to Jython jar)
@@ -508,7 +508,7 @@ To run it execute the command:
 
 .. code:: bash
 
-    jruby -J-classpath /path/to/gnparser-assembly-0.3.3.jar \
+    jruby -J-classpath /path/to/gnparser-assembly-0.4.0.jar \
       examples/jruby/parser.rb
 
 Getting Code for Development

build.sbt

@@ -1,7 +1,7 @@
 import sbt.Keys._
 
 val commonSettings = Seq(
-  version := "0.3.4-SNAPSHOT",
+  version := "0.4.0",
   scalaVersion := "2.11.8",
   organization in ThisBuild := "org.globalnames",
   homepage := Some(new URL("http://globalnames.org/")),

examples/spark/README.rst

@@ -13,7 +13,7 @@ is an SBT subproject. To run it complete steps as follows:
 
 1. build a fat-jar of the example with ``sbt ";++2.10.6;exampleSpark/assembly"``
 
-2. run it with Spark by executing ``$SPARK_HOME/bin/spark-submit ./examples/spark/target/scala-2.10/gnparser-example-spark-assembly-0.3.3.jar``
+2. run it with Spark by executing ``$SPARK_HOME/bin/spark-submit ./examples/spark/target/scala-2.10/gnparser-example-spark-assembly-0.4.0.jar``
 
 Python
 ~~~~~~
@@ -25,8 +25,8 @@ Python
 .. code:: bash
 
     $SPARK_HOME/bin/pyspark \
-      --jars "`pwd`/spark-python/target/scala-2.10/gnparser-spark-python-assembly-0.3.3.jar" \
-      --driver-class-path="`pwd`/spark-python/target/scala-2.10/gnparser-spark-python-assembly-0.3.3.jar"`
+      --jars "`pwd`/spark-python/target/scala-2.10/gnparser-spark-python-assembly-0.4.0.jar" \
+      --driver-class-path="`pwd`/spark-python/target/scala-2.10/gnparser-spark-python-assembly-0.4.0.jar"`
 
 3. add Python snippet to call the wrapper: