Skip to content

Commit

Permalink
Merge branch 'release/2.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
xfh committed Aug 8, 2017
2 parents 3c47488 + 30f9cc8 commit a9898f3
Show file tree
Hide file tree
Showing 46 changed files with 3,388 additions and 108 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# http://editorconfig.org
root = true

[*.{java,xml}]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

# Kompatibility zu maven-dependency-plugin/maven-release-plugin... und damit zu jgitflow
[pom.xml]
indent_style = space

[*.yml]
indent_style = space
indent_size = 2

[*.sh]
end_of_line = lf
58 changes: 4 additions & 54 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,60 +1,10 @@
#LibreOffice Lockfiles (z.B. beim Bearbeiten von basisreport.xls)
#LibreOffice/Excel Lockfiles (z.B. beim Bearbeiten von basisreport.xls)
.~lock*
.access^

### Maven
target/

### Intellij ###
# Created by https://www.gitignore.io/api/intellij
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff:
.idea/**/workspace.xml
.idea/**/tasks.xml

# Sensitive or high-churn files:
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.xml
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml

# Gradle:
.idea/**/gradle.xml
.idea/**/libraries

# Mongo Explorer plugin:
.idea/**/mongoSettings.xml

## File-based project format:
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

### Intellij Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# End of https://www.gitignore.io/api/intellij
.idea/
*.iml
82 changes: 82 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# 2.0.0 Typing support

## License change
We are open sourcing! This library is now available under the Apache License, Version 2.0

## POI Update
Upgrade from 3.15 to 3.16

## Breaking change
Deprecated code has been removed.

MergeFields and Converters are now using property typings, such that you cannot set mistakingly
the wrong merge value.

If you used excel Merger before, you will have to adjust your MergeField enums.
You can Use the following regular expressions to adjust to the new api.

``
(\w+)\((\w+), Type.SIMPLE\)
$1(new SimpleMergeField<>("$1", $2))
``

``
(\w+)\((\w+), Type.REPEAT_COL\)
$1(new RepeatColMergeField<>("$1", $2))
``

``
(\w+)\((\w+), Type.REPEAT_VAL\)
$1(new RepeatValMergeField<>("$1", $2))
``

``
(\w+)\((\w+), Type.REPEAT_ROW\)
$1(new RepeatRowMergeField("$1"))
``

``
enum (\w+) implements MergeField
enum $1 implements MergeFieldProvider
``

``
import static ch\.dvbern\.lib\.excelmerger\.StandardConverters\.(\w+);
import static ch\.dvbern\.oss\.lib\.excelmerger\.converters\.StandardConverters\.$1;
``

``
import ch\.dvbern\.lib\.excelmerger\.MergeField;
import ch\.dvbern\.oss\.lib\.excelmerger\.mergefields\.MergeField;
``

``
ch\.dvbern\.lib\.excelmerger
ch\.dvbern\.oss\.lib\.excelmerger
``

Please adjust your enum constructors and getters manually.

# 1.1.1 PERCENT_CONVERTER scale issue
- It was possible, that the resulting percentage value was wrongly converted, for
instance when the scale of the input BigDecimal was 0.

# 1.1.0 FZL (kurstool) integration (2017-03-17)

## Changes
- INTEGER_CONVERTER has been deprecated because it is actually a LONG_CONVERTER.
Please migrate to LONG_CONVERTER.

## New Features
- Template-Patters may contain underscore "_"
- **MergeField**
- PAGE_BREAK - can be added in a template to insert a page break
- **Converters**
- STRING_COLORED_CONVERTER - write a string value in the supplied colour
- DATE_WITH_DAY_CONVERTER - prefixes the default date format with the weekday ("EE, dd.MM.yyyy")
- LONG_CONVERTER - superseeds INTEGER_CONVERTER

## Bugfixes
- slf4j-log4j12 should only be included in test scope

# 1.0.0 KitAdmin Excel Merger (2017-03-17)
7 changes: 3 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ include:

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* The use of explicit or offensive language or imagery
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
Expand Down Expand Up @@ -55,7 +54,7 @@ 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 [INSERT EMAIL ADDRESS]. All
reported by contacting the project team at [email protected]. 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.
Expand All @@ -71,4 +70,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[version]: http://contributor-covenant.org/version/1/4/
57 changes: 32 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Contributing

First off, thank you for considering contributing to the library lib-excelmerger!
First off, thank you for considering contributing to the library dvbern-lib-excelmerger!
### 1. Where do I go from here?

If you've noticed a bug or have a question that doesn't belong on the
Expand All @@ -11,9 +11,11 @@ If not, feel free to go ahead and [make one](https://github.com/dvbern/lib-excel

### 2. Did you find a bug?

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/dvbern/lib-excelmerger/issues).
* **Ensure the bug was not already reported** by searching on GitHub under
[Issues](https://github.com/dvbern/lib-excelmerger/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/dvbern/lib-excelmerger/issues/new).
* If you're unable to find an open issue addressing the problem,
[open a new one](https://github.com/dvbern/lib-excelmerger/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not happening.

Expand All @@ -28,23 +30,29 @@ and create a branch with a descriptive name.
A good branch name would be (where issue #325 is the ticket you're working on):

```sh
git checkout -b 325-add-mynewchanges123
git checkout develop
git checkout -b 325-add-mynewchanges
```

### 4. Code of Conduct

By beeing part of our development team and community, please abide the rules in our [Code of Conduct](CODE_OF_CONDUCT.md)!
Further information on how to report inapropriate behaviour by others, check the Enforcements-Section in said Code Of Conduct. Thank you for beeing a nice person!

By being part of our development team and community, please abide the rules in our
[Code of Conduct](CODE_OF_CONDUCT.md)!
Further information on how to report inapropriate behaviour by others, check the Enforcements-Section
in said Code Of Conduct. Thank you for being a nice person!

### 5. Code Styles, Guildlines & Inspections

Since we're trying to keep the code structured, readable and standardised, please check out and implement our Code Styles & Inspections if you are using IntelliJ IDEA.

[Code Styles](https://raw.githubusercontent.com/dvbern/codestyles/master/src!IDE-settings!IntelliJ!DVBern-Conventions-2017-05-29.xml)(Add Scheme under Project Settings > Editor > Code Style)
Since we're trying to keep the code structured, readable and standardised, please check out and implement our
Code Styles & Inspections if you are using IntelliJ IDEA.

[Inspections](https://raw.githubusercontent.com/dvbern/codestyles/master/src!IDE-settings!IntelliJ!DVBern_Inspections_2017_05_19.xml)(Add Profile under Project Settings > Editor > Inspections)
[Code Styles](https://raw.githubusercontent.com/dvbern/codestyles/master/src!IDE-settings!IntelliJ!DVBern-Conventions-2017-05-29.xml)
(Add Scheme under Project Settings > Editor > Code Style)

[Inspections](https://raw.githubusercontent.com/dvbern/codestyles/master/src!IDE-settings!IntelliJ!DVBern_Inspections_2017_05_19.xml)
(Add Profile under Project Settings > Editor > Inspections)

### 6. Make a Pull Request
### 6. Make a pull request

At this point, you should switch back to your master branch and make sure it's
up to date with the master branch:
Expand All @@ -58,18 +66,18 @@ git pull upstream master
Then update your feature branch from your local copy of master, and push it!

```sh
git checkout 325-add-mynewchanges123
git checkout 325-add-mynewchanges
git rebase master
git push --set-upstream origin 325-add-mynewchanges123
git push --set-upstream origin 325-add-mynewchanges
```

Finally, go to GitHub and
[make a Pull Request](https://help.github.com/articles/creating-a-pull-request)


### 7. Keeping your Pull Request updated
### 7. Keeping your pull request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
If a maintainer asks you to "rebase" your pull request, they're saying that a lot of code
has changed, and that you need to update your branch so it's easier to merge.

To learn more about rebasing in Git, there are a lot of
Expand All @@ -78,20 +86,19 @@ To learn more about rebasing in Git, there are a lot of
but here's the suggested workflow:

```sh
git checkout 325-add-mynewchanges123
git pull --rebase upstream master
git push --force-with-lease 325-add-mynewchanges123
git checkout 325-add-mynewchanges
git pull --rebase upstream develop
git push --force-with-lease 325-add-mynewchanges
```

### 8. Merging a Pull Request (maintainers only)
### 8. Merging a pull request (maintainers only)

A Pull Reques can only be merged into master by a maintainer if:
A pull request can only be merged into develop by a maintainer if:

* It is passing the tests.
* It has been approved by at least two maintainers. If it was a maintainer who
opened the Pull Reques, only one extra approval is needed.
opened the pull request, only one extra approval is needed.
* It has no requested changes.
* It is up to date with current master.
* It is up to date with current develop.

Any maintainer is allowed to merge a Pull Reques if all of these conditions are
met.
Any maintainer is allowed to merge a pull request if all of these conditions are met.
44 changes: 19 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,25 @@
# dvbern-lib-excelmerger

This library can be used to generate Excel-Reports using templates.
This Java library can be used to generate Excel-Reports using templates.

## Getting Started

These instructions will get you an overview on how to implement and use the dvbern-lib-excelmerger library. See further down for installing or deployment notes.

### Prerequisites

<What things you need to install the software and how to install them>

```
<example>
```
The template is designed and setup in MS Excel. With this lib, predefined placeholders
are replaced with dynamic values.

### Installing
## Getting Started

<A step by step series of examples to get a development env running>
### Installation

<This step does this>
* Checkout the repository
* run `mvn clean install`
* add the following dependency to your project

```xml
<dependency>
<groupId>ch.dvbern.oss.lib.excelmerger</groupId>
<artifactId>dvbern-lib-excelmerger-impl</artifactId>
<version>(NEWEST_VERSION)</version>
</dependency>
```
<example>
```


## Deployment

Add additional notes about how to deploy this on a live system

## Built With

Expand All @@ -36,17 +28,19 @@ Add additional notes about how to deploy this on a live system

## Contributing Guidelines

Please read [Contributing.md](CONTRIBUTING.md) for the process for submitting pull requests to us.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for the process for submitting pull requests to us.

## Code of Conduct

One healthy social atmospehere is very important to us, wherefore we rate our Code of Conduct high. For details check the file [CodeOfConduct.md](CODE_OF_CONDUCT.md)
One healthy social atmospehere is very important to us, wherefore we rate our Code of Conduct high.
For details check the file [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

## Authors

* **DV Bern AG** - *Initial work* - [dvbern](https://github.com/dvbern)

See also the list of [contributors](https://github.com/dvbern/lib-excelmerger/contributors) who participated in this project.
See also the list of [contributors](https://github.com/dvbern/lib-excelmerger/contributors)
who participated in this project.

## License

Expand Down
Loading

0 comments on commit a9898f3

Please sign in to comment.