Merge branch 'release/5.5.9'

Author: amedee

.gitignore

@@ -148,3 +148,7 @@ target/
 nbactions*.xml
 *.patch
 *.md.html
+.pmd
+.pmdruleset.xml
+.checkstyle
+.vagrant/

BUILDING.md

@@ -1,18 +1,40 @@
-To build iText, Maven must be installed: http://maven.apache.org/
+To build iText, [Maven][1] must be installed.
 
 Running install without a profile will generate the itextpdf jar:
+```bash
+$ mvn clean install -Dmaven.test.skip=true | tee mvn.log
+```
 
-```mvn install```
+When using the profile `all` also the source and javadoc jars will be generated:
+```bash
+$ mvn clean install -P all -Dmaven.test.skip=true | tee mvn.log
+```
 
-When using the profile 'all' also the source and javadoc jars will be generated:
-
-```mvn install -P all```
-
-If you are in need of the asian font jars, you can run one of the following commands:
-
-```mvn clean install -f itext-asian.pom```    
-```mvn clean install -f itext-asiancmaps.pom```
+If you are in need of the Asian font jars, you can run one of the following commands:
+```bash
+$ mvn clean install -f itextpdf/itext-asian.pom | tee mvn.log
+```
 
 If you need the hyphenation jar, execute:
-
-```mvn clean install -f itext-hyph-xml.pom```
+```bash
+$ mvn clean install -f itextpdf/itext-hyph-xml.pom | tee mvn.log
+```
+
+To run the tests, [Ghostscript][2] and [Imagemagick][3] must be installed.
+```bash
+$ mvn clean install -Dmaven.test.failure.ignore=false -DgsExec=$(which gs) -DcompareExec=$(which compare) | tee mvn.log
+```
+
+You can use the `Vagrantfile` to get a [Vagrant][4] VM ([Ubuntu][5] 14.04 LTS - Trusty Tahr, with [VirtualBox][6]) with all the required software installed.
+```bash
+$ vagrant box add ubuntu/trusty64
+$ vagrant up
+$ vagrant ssh -- 'cd /vagrant ; mvn clean install -Dmaven.test.skip=true' | tee mvn.log
+```
+
+[1]: http://maven.apache.org/
+[2]: http://www.ghostscript.com/
+[3]: http://www.imagemagick.org/
+[4]: https://www.vagrantup.com/
+[5]: http://www.ubuntu.com/
+[6]: https://www.virtualbox.org/

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at http://itextpdf.com/contact. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -10,43 +10,48 @@ today! Here are the guidelines we'd like you to follow:
  - [Coding Rules](#rules)
  - [Commit Message Guidelines](#commit)
  - [Signing the iCLA](#cla)
- - [Further Info](#info)
+ - [Contributor Code of Conduct](#coc)
 
-## <a name="question"></a> Got a Question or Problem?
+
+## <a name="question">Got a Question or Problem?</a>
 
 If you have questions about how to use iText, please direct these to [StackOverflow][stackoverflow].
 
 If you are a customer with a [support agreement][support], you also have direct access to our JIRA and our developers.
 
-## <a name="issue"></a> Found an Issue?
+
+## <a name="issue">Found an Issue?</a>
 If you find a bug in the source code or a mistake in the documentation, you can help us by
 submitting a [Pull Request][pull] with a fix.
 
 **Please see the [Submission Guidelines](#submit) below**.
 
-## <a name="feature"></a> Want to implement a Feature?
+
+## <a name="feature">Want to implement a Feature?</a>
 If you would like to implement a new feature then consider what kind of change it is:
 
 * **Major Changes** that you wish to contribute to the project should be discussed first so that we can better
 coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully
 accepted into the project.
 * **Small Changes** can be crafted and submitted to the [GitHub Repository][github] as a [Pull Request][pull].
 
-## <a name="submit"></a> Submission Guidelines
 
-### Submitting an Issue
-Before you submit your issue, search [Stack Overflow][stackoverflow], maybe your question was already answered.
+## <a name="submit">Submission Guidelines</a>
+
+### Submitting a Question or an Issue
+Before you submit your question or issue, search [Stack Overflow][stackoverflow], maybe your question was already answered.
 
 If your issue appears to be a bug, and hasn't been reported, ask a question on [Stack Overflow][stackoverflow].
 Help us to maximize the effort we can spend fixing issues and adding new
 features, by not reporting duplicate issues. Providing the following information will increase the
 chances of your issue being dealt with quickly:
 
+* **[How to ask good questions][good-questions]**
 * **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
 * **Motivation for or Use Case** - explain why this is a bug for you
 * **iText Version(s)** - is it a regression?
 * **Operating System** - is this a problem on Windows or Linux, maybe on Mac?
-* **Reproduce the Error** - provide a [Short, Self Contained, Correct (Compilable), Example][sscce].
+* **Reproduce the Error** - provide a [Short, Self Contained, Correct (Compilable), Example][sscce], also known as a [Minimal, Complete, and Verifiable example][mcve].
 * **Related Issues** - has a similar issue been reported before?
 * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
   causing the problem (line of code or commit)
@@ -143,7 +148,8 @@ from the main (upstream) repository:
     git pull --ff upstream develop
     ```
 
-## <a name="rules"></a> Coding Rules
+
+## <a name="rules">Coding Rules</a>
 To ensure consistency throughout the source code, keep these rules in mind as you are working:
 
 * All features or bug fixes **must be tested** by one or more [unit tests][unit-testing].
@@ -153,7 +159,8 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
   [Oracle's Code Conventions for the Java Programming Language][java-style-guide], with these additions:
     * Wrap all code at **100 characters**.
 
-## <a name="commit"></a> Git Commit Guidelines
+
+## <a name="commit">Git Commit Guidelines</a>
 
 We have very precise rules over how our git commit messages can be formatted. This leads to **more
 readable messages** that are easy to follow when looking through the **project history**. But also,
@@ -189,14 +196,23 @@ The body should include the motivation for the change and contrast this with pre
 The footer should contain any information about **Breaking Changes** and is also the place to
 reference JIRA or GitHub issues that this commit **Closes**.
 
-## <a name="cla"></a> Signing the iCLA
+
+## <a name="cla">Signing the iCLA</a>
 
 Please sign the iText Contributor License Agreement (iCLA) before sending pull requests. For any larger code
 changes (more than 20 lines of significant code) to be accepted, the iCLA must be signed. It's a quick process, we promise!
 
 We'll need you to [(digitally) sign and then email, fax or mail the form][cla].
 
 
+## <a name="coc">Contributor Code of Conduct</a>
+Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
+
+We use the StackExchange network for free support and GitHub for code hosting. By using these services, you agree to abide by their terms:
+* StackExchange: http://stackexchange.com/legal
+* Github: https://help.github.com/articles/github-terms-of-service/
+
+
 [cla]: http://itextpdf.com/policy
 [coc]: https://github.com/itext/itextpdf/blob/master/CODE_OF_CONDUCT.md
 [github]: https://github.com/itext/itextpdf
@@ -206,5 +222,7 @@ We'll need you to [(digitally) sign and then email, fax or mail the form][cla].
 [pull]: https://github.com/itext/itextpdf/pulls
 [sscce]: http://sscce.org/
 [stackoverflow]: http://stackoverflow.com/questions/tagged/itext
+[good-questions]: http://stackoverflow.com/help/how-to-ask
+[mcve]: http://stackoverflow.com/help/mcve
 [support]: http://itextpdf.com/support
 [unit-testing]: http://junit.org/

EXTRAJARS.md

@@ -1,15 +1,36 @@
-This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation with the addition of the following permission added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY iText Group NV, iText Group NV DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
-You should have received a copy of the GNU Affero General Public License along with this program; if not, see http://www.gnu.org/licenses or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, 02110-1301 USA, or download the license from the following URL:
-
-http://itextpdf.com/terms-of-use/
-
-The interactive user interfaces in modified source and object code versions of this program must display Appropriate Legal Notices, as required under Section 5 of the GNU Affero General Public License.
-
-In accordance with Section 7(b) of the GNU Affero General Public License, a covered work must retain the producer line in every PDF that is created or manipulated using iText.
-
-You can be released from the requirements of the license by purchasing a commercial license. Buying such a license is mandatory as soon as you develop commercial activities involving the iText software without disclosing the source code of your own applications.
-These activities include: offering paid services to customers as an ASP, serving PDFs on the fly in a web application, shipping iText with a closed source product.
-
-For more information, please contact iText Software Corp. at this address: [email protected]
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License version 3
+    as published by the Free Software Foundation with the addition of the
+    following permission added to Section 15 as permitted in Section 7(a):
+    FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+    ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
+    OF THIRD PARTY RIGHTS
+    
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+    or FITNESS FOR A PARTICULAR PURPOSE.
+    See the GNU Affero General Public License for more details.
+    You should have received a copy of the GNU Affero General Public License
+    along with this program; if not, see http://www.gnu.org/licenses or write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA, 02110-1301 USA, or download the license from the following URL:
+    http://itextpdf.com/terms-of-use/
+    
+    The interactive user interfaces in modified source and object code versions
+    of this program must display Appropriate Legal Notices, as required under
+    Section 5 of the GNU Affero General Public License.
+    
+    In accordance with Section 7(b) of the GNU Affero General Public License,
+    a covered work must retain the producer line in every PDF that is created
+    or manipulated using iText.
+    
+    You can be released from the requirements of the license by purchasing
+    a commercial license. Buying such a license is mandatory as soon as you
+    develop commercial activities involving the iText software without
+    disclosing the source code of your own applications.
+    These activities include: offering paid services to customers as an ASP,
+    serving PDFs on the fly in a web application, shipping iText with a closed
+    source product.
+    
+    For more information, please contact iText Software Corp. at this
+    address: [email protected]

LICENSE.md

@@ -1,30 +1,21 @@
-iText consists of several jars.
+[iText][itext] consists of several jars.
 
 The main iText release contains:
 - ```itextpdf-x.y.z.jar```: the core library
 - ```itext-xtra-x.y.z.jar```: extra functionality (PDF 2!)
 - ```itext-pdfa-x.y.z.jar```: PDF/A-related functionality
+- ```xmlworker-x.y.z.jar```: XML (and HTML) functionality
 
-This project is hosted on https://github.com/itext
+iText is hosted on https://github.com/itext/itextpdf
 
 You can find the latest releases here:
-- https://github.com/itext/itextpdf
-- https://github.com/itext/xtra
-- https://github.com/itext/pdfa
+- http://github.com/itext/itextpdf/releases/latest
 
 You can also [build iText from source][building].
 
-In some cases, you'll need [extra jars][extrajars].
-These jars are bundled in a zip file here:
-http://sourceforge.net/projects/itext/files/extrajars/
-
-For XML (and HTML) functionality, you need this jar:
-- ```xmlworker-x.y.z.jar```
-This project is hosted on https://github.com/itext/xmlworker
-
-Finally, we also have a tool that can help you debug PDFs:
+We also have a tool that can help you debug PDFs:
 - ```itext-rups-x.y.z.jar```
-This project is hosted on https://github.com/itext/rups
+RUPS is hosted on http://github.com/itext/rups
 
 If you have an idea on how to improve iText and you want to submit code,
 please read our [Contribution Guidelines][contributing].
@@ -49,3 +40,4 @@ Contact sales for more info: http://itextpdf.com/sales
 [building]: BUILDING.md
 [contributing]: CONTRIBUTING.md
 [extrajars]: EXTRAJARS.md
+[itext]: http://itextpdf.com/

README.md

@@ -0,0 +1,28 @@
+$script = <<SCRIPT
+#!/usr/bin/env bash
+
+apt-get update
+apt-get -y install dos2unix git git-flow ghostscript imagemagick maven mc openjdk-7-jdk php5-cli screen
+
+git config --global color.ui true
+git config --global core.abbrev 10
+git config --global core.editor nano
+git config --global core.abbrev 10
+git config --global --bool pull.rebase true
+git config --global branch.autosetupmerge always
+git config --global branch.autosetuprebase always
+git config --global core.autocrlf input
+git config --global core.safecrlf false
+git config --global apply.whitespace nowarn
+git config --global push.default simple
+git config --global alias.ignore '!gi() { curl -L -s https://www.gitignore.io/api/$@ ;}; gi'
+SCRIPT
+
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+  config.vm.provision :shell, inline: $script
+  config.ssh.shell = "bash -c 'BASH_ENV=/etc/profile exec bash'"
+  config.vm.provider :virtualbox do |vb|
+    vb.customize ["modifyvm", :id, "--memory", "2048"]
+  end
+end