Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/chartjs-java-model/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/chartjs-java-model/issues) or [closed](https://github.com/xdev-software/chartjs-java-model/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/chartjs-java-model/issues) or [closed](https://github.com/xdev-software/chartjs-java-model/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/chartjs-java-model/issues) or [closed](https://github.com/xdev-software/chartjs-java-model/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.github/workflows/check-build.yml

@@ -48,7 +48,7 @@ jobs:
           ${{ runner.os }}-mvn-build-
 
     - name: Build with Maven
-      run: ./mvnw -B clean package
+      run: ./mvnw -B clean package -P run-integration-tests
 
     - name: Check for uncommited changes
       run: |
@@ -75,6 +75,39 @@ jobs:
         path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
         if-no-files-found: error
 
+    - name: Upload screenshots of test failures
+      if: failure()
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-fail-screenshots-${{ matrix.java }}
+        path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/screenshots
+        if-no-files-found: ignore
+
+  # Ensure compatibility with Java 11
+  # See https://github.com/xdev-software/chartjs-java-model/issues/14
+  build-java-11:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+    - uses: actions/checkout@v5
+
+    - name: Set up JDK
+      uses: actions/setup-java@v5
+      with:
+        distribution: temurin
+        java-version: 11
+
+    - name: Cache Maven
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-mvn-build-java-11-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-mvn-build-java-11-
+
+    - name: Build with Maven
+      run: ./mvnw -B clean package -Dmaven.test.skip=true
+
   checkstyle:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}

.github/workflows/release.yml

@@ -37,7 +37,7 @@ jobs:
 
     - name: Build with Maven
       run: ./mvnw -B clean package -T2C
-      
+
     - name: Check for uncommited changes
       run: |
         if [[ "$(git status --porcelain)" != "" ]]; then

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
-    <module name="template-placeholder-demo" />
+    <module name="chartjs-java-model-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,122 @@
+# 2.9.0
+* Synced `LineOptions` from ChartJS source code #439
+* Updated dependencies
+
+# 2.8.1
+* Migrated deployment to _Sonatype Maven Central Portal_ [#155](https://github.com/xdev-software/standard-maven-template/issues/155)
+
+# 2.8.0
+* Synced ``TooltipOptions`` from ChartJS source code #330
+
+# 2.7.0
+* ``Title``: Make it possible to set custom padding and multi-line text #316
+
+# 2.6.0
+* Synced ``Doughnut/PieOptions`` from ChartJS source code #293
+* Synced ``GridLineConfiguration`` from ChartJS source code / improved Types for more options #289
+* Updated dependencies
+
+# 2.5.0
+* Synced ``Legend`` from ChartJS source code #285
+
+# 2.4.0
+* PointStyle can also contain non-string constants #280
+* Use ``CoreInteractionOptions`` for ``Options#interaction`` and ``Options#hover`` #281
+* Updated dependencies
+
+# 2.3.1
+* Synced ``LineOptions/DataSet`` ``stepped`` and ``tension`` with ChartJS source #262
+* Updated dependencies
+
+# 2.3.0
+* Update available datasets fields from ChartJS source code #244
+* Removed deprecated code
+
+# 2.2.0
+* Improve color handling #238
+  * Change ``Color`` to ``RGBAColor`` as it only handles RGBA
+  * Change all occurrences of ``Color`` to ``Object`` so that other color models (e.g. HSLA or Hex) can be applied
+  * Created ``HSLAColor`` that can be used like ``RGBAColor``
+
+# 2.1.0
+* Charts no longer check if they are drawable #198
+  * ChartJS behavior: If a chart can't be drawn it will render a empty canvas
+  * Deprecated methods: ``Chart#toJsonNative`` and ``Chart#isDrawable``
+* Make ``IndexAxis`` available in all options
+
+# 2.0.2
+_Same as version 2.1.0 - Version was not incremented correctly_
+
+# 2.0.1
+* Restored ``DisplayFormats`` #186
+
+# 2.0.0
+* Scales have been reworked and are now nearly identical to the [types defined in ChartJS](https://github.com/chartjs/Chart.js/blob/v4.4.3/src/types/index.d.ts)
+* The use of ``Color`` for various coloring related options is no longer required. 
+  * It's now possible to use e.g. strings
+
+# 1.5.0
+* Added ``JsonIgnore`` to certain fields to help prevent infinite loops #174
+* Corrected model for ``Title`` and ``Font`` #175
+
+# 1.4.1
+* Use ``Number`` instead of ``BigDecimal`` in some additional places #159 (@aripddev)
+
+# 1.4.0
+* Simplify API by using ``Number`` instead of ``BigDecimal``, ``int`` and ``double`` for ``Datapoints`` #154 (@aripddev)
+
+# 1.3.1
+* Add subtitle option #141 (@aripddev)
+* Add ``PointStyle#rectRounded`` #143 (@aripddev)
+* Add ``BubbleDataset#pointStyle`` #144 (@aripddev)
+* ``reverse`` property should be on the ``Scale`` object #145
+* Added all available properties for ``Legend``
+
+# 1.3.0
+* Allows creation of mixed charts #128
+  * New chart class: ``MixedChart``
+  * Some classes have been renamed
+    * ``Data`` -> ``HomogeneousData``
+    * ``AbstractChart`` -> ``HomogeneousChart``
+* Slim down test dependencies
+
+# 1.2.0
+* Add TimeScale and TimeTicks to allow building linear time charts #90 (@astappiev)
+* Add options for the [Zoom plugin](https://www.chartjs.org/chartjs-plugin-zoom/latest/) #117 (@astappiev)
+* Updated dependencies
+
+# 1.1.3
+* Add ``toJsonNative`` method which doesn't run the ``isDrawable`` check #91
+
+# 1.1.2
+* ⚠️ GroupId changed from ``com.xdev-software`` to ``software.xdev``
+
+# 1.1.1
+* ``AngleLines#lineWidth`` now uses ``BigDecimal`` #76
+* Updated dependencies
+
+# 1.1.0
+* Added support for more [data structures](https://www.chartjs.org/docs/4.4.0/general/data-structures.html) inside ``Dataset#data``
+  * ``Dataset#data`` can now contain ``Object``s
+
+# 1.0.2
+* Support Java 11
+* Updated dependencies
+
+# 1.0.1
+* Added support for [stacked bar chart with groups](https://www.chartjs.org/docs/4.4.0/samples/bar/stacked-groups.html) (@dlemaignent)
+
+# 1.0.0
+Initial release
+
+Support for Chart.js v4
+
+Noteworthy changes compared to [Chart.java](https://github.com/mdewilde/chart):
+* Changed the package to ``software.xdev.chartjs.model``
+* All charts (e.g. ``BarChart``, ``LineChart``, ...) are now inside the ``charts`` package
+* Breaking API changes due to compatibility with Chart.js v4; You may checkout the migration guides
+  * [3.x Migration Guide](https://www.chartjs.org/docs/4.3.0/migration/v3-migration.html)
+  * [4.x Migration Guide](https://www.chartjs.org/docs/4.3.0/migration/v4-migration.html)
+* JSON is no longer pretty printed by default due to performance reasons
+* Implemented integration tests
+* Requires Java 17

CONTRIBUTING.md

@@ -34,10 +34,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/chartjs-java-model/release.yml?branch=master)](https://github.com/xdev-software/chartjs-java-model/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/chartjs-java-model/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

LICENSE

@@ -187,6 +187,7 @@
       identification within third-party archives.
 
    Copyright 2024 XDEV Software
+   Copyright 2020 Marceau Dewilde
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,11 +1,46 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/chartjs-java-model?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/chartjs-java-model)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/chartjs-java-model/check-build.yml?branch=develop)](https://github.com/xdev-software/chartjs-java-model/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![ChartJS Documentation](https://img.shields.io/badge/Chart.js-documentation-ff6384?logo=Chart.js)](https://www.chartjs.org/docs/latest/)
 
-# template-placeholder
+# <img src="https://www.chartjs.org/media/logo.svg" height="38" /> chartjs-java-model
+Provides Java models for [Chart.js](https://www.chartjs.org/) so that e.g. a Java Server can build a chart and then instruct a JavaScript client what needs to be shown.
 
+This repo extends the abandoned [Chart.java](https://github.com/mdewilde/chart) and adds support for Chart.js Version 4+.
+
+> [!NOTE]
+> We try our best to implement the ChartJS v4 API however there are a lot of configuration options.<br/>
+> Therefore some parts might still be missing or use the outdated v2 API from the original repo.<br/>
+> If you think you found a missing or incorrect API please open an issue and/or provide a pull request.
+
+## Usage
+
+Configuring a chart is straight forward and follows a builder like pattern:
+```java
+new BarChart(new BarData()
+  .addLabels("A", "B")
+  .addDataset(new BarDataset()
+    .setLabel("X")
+    .addData(1)
+    .addData(2)))
+  .toJson(); // Do something with the json like sending it to the client
+```
+
+If you need more examples:
+* Have a look at the [demo](./chartjs-java-model-demo/) 
+* or checkout how we do it in our [tests](./chartjs-java-model/src/test/java/software/xdev/chartjs/model/)
+  * there are also [screenshots](./chartjs-java-model/src/test/resources/screenshotReferences/) available
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/chartjs-java-model/releases/latest#Installation)
+
+#### Compatibility with Chart.js
+| Chart.js | ``chartjs-java-model`` version |
+| --- | --- |
+| 4.x | ``1+`` |
+
+#### Integrations
+* Vaadin - You can utilize the library in combination with our [Chart.js Wrapper for Vaadin](https://github.com/xdev-software/vaadin-chartjs-wrapper)
+* [Primefaces's Charts](https://showcase.primefaces.org/ui/chart/bar.xhtml)
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
@@ -14,4 +49,10 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/chartjs-java-model/dependencies)
+
+## Acknowledgment
+* To all [contributors](https://github.com/xdev-software/chartjs-java-model/graphs/contributors) that helped to improve this library
+  * Especially to the devs at [PrimeTek/PrimeFaces](https://www.primefaces.org/) that regularly provide feedback and PRs
+
+<sub>Disclaimer: This is not an official Chart.js product and not associated</sub>