Introduce fluent api (#3)

* introduce fluent API

* remove lombok dependency

* bump version to 2.0.0

Author: embewee

README.md

@@ -40,7 +40,7 @@ Add Gallop to your project via [Maven Central](https://central.sonatype.com/arti
 
 ```groovy
 dependencies {
-    implementation 'de.codebarista:gallop:1.0.1'
+    implementation 'de.codebarista:gallop:2.0.0'
 }
 ```
 
@@ -51,120 +51,99 @@ dependencies {
 <dependency>
     <groupId>de.codebarista</groupId>
     <artifactId>gallop</artifactId>
-    <version>1.0.1</version>
+    <version>2.0.0</version>
 </dependency>
 ```
 
 ### Code example
 
-```java
-import de.codebarista.gallop.xrechnung.model.Invoice;
-import de.codebarista.gallop.xrechnung.model.Item;
-import de.codebarista.gallop.xrechnung.model.InvoiceNote;
-import de.codebarista.gallop.XmlDocumentBuilder;
-
-import java.math.BigDecimal;
-import java.time.OffsetDateTime;
-import java.util.List;
+You find this code in the `BuildInvoiceTest` class.
 
+```java
 public class InvoiceGenerator {
 
-    public byte[] generateInvoice() throws Exception {
-        Invoice invoice = Invoice.builder()
+    public String generateInvoice() throws XRechnungWriterException {
+        Invoice invoice = Invoice.create()
                 .documentTypeCode(InvoiceType.COMMERCIAL_INVOICE.getValue()) // Define invoice type
                 .documentId("INV-2025-1001") // Unique invoice identifier
                 .leitwegId("N/A") // Buyer reference (BT-10)
                 .currency("EUR") // Currency used for the invoice
 
                 // Payment details including method and terms
-                .paymentInstructions(PaymentInstructions.builder()
+                .paymentInstructions(PaymentInstructions.create()
                         .meansType(PaymentCode.CASH)
                         .meansText("Cash on delivery")
                         .paymentTerms("The goods remain our property until full payment is received."
-                                + "\nDate of service corresponds to invoice date.")
-                        .build())
+                                + "\nDate of service corresponds to invoice date."))
 
                 .issueDate(OffsetDateTime.now()) // Invoice issue date
 
                 // Seller details
-                .seller(SellerOrBuyer.builder()
+                .seller(SellerOrBuyer.create()
                         .name("TechNova Solutions GmbH")
-                        .address(PostalAddress.builder()
+                        .address(PostalAddress.create()
                                 .addressLineOne("Innovationsstraße 15")
                                 .city("Berlin")
                                 .zipCode("10115")
-                                .countryIsoCode("DE")
-                                .build())
+                                .countryIsoCode("DE"))
                         .vatId("DE298765432") // Seller VAT ID
                         .electronicAddress("[email protected]") // Electronic address for invoicing
-                        .contact(Contact.builder()
+                        .contact(Contact.create()
                                 .name("Dr. Stefan Wagner")
                                 .phone("+49 (0) 30 987654321")
-                                .email("[email protected]")
-                                .build())
-                        .build())
+                                .email("[email protected]")))
 
                 // Buyer details
-                .buyer(SellerOrBuyer.builder()
+                .buyer(SellerOrBuyer.create()
                         .name("Greenline Retail AG")
-                        .address(PostalAddress.builder()
+                        .address(PostalAddress.create()
                                 .addressLineOne("Einkaufsstraße 78")
                                 .city("Hamburg")
                                 .zipCode("20095")
-                                .countryIsoCode("DE")
-                                .build())
-                        .electronicAddress("[email protected]") // Electronic address for buyer
-                        .build())
+                                .countryIsoCode("DE"))
+                        .electronicAddress("[email protected]")) // Electronic address for buyer
 
                 // Delivery information
-                .deliveryInfo(DeliveryInformation.builder()
+                .deliveryInfo(DeliveryInformation.create()
                         .name("Greenline Retail AG - Warehouse")
-                        .deliveryAddress(PostalAddress.builder()
+                        .deliveryAddress(PostalAddress.create()
                                 .addressLineOne("Lagerstraße 5")
                                 .city("Hamburg")
                                 .zipCode("21079")
-                                .countryIsoCode("DE")
-                                .build())
-                        .build())
+                                .countryIsoCode("DE")))
 
                 // Invoice items
                 .items(List.of(
-                        Item.builder()
+                        Item.create()
                                 .id(1L)
                                 .name("Ergonomic Office Chair")
                                 .sellerAssignedId("CHAIR-ERG-2025") // Seller's internal product ID
                                 .quantity(2L) // Quantity purchased
                                 .unitPrice(new BigDecimal("199.99")) // Price per unit
                                 .itemTotalNetAmount(new BigDecimal("399.98")) // Total price without VAT
                                 .unitCode(UnitCode.PIECE) // Unit of measurement
-                                .vat(Vat.builder()
+                                .vat(Vat.create()
                                         .rate(BigDecimal.valueOf(19)) // VAT rate (19%)
-                                        .category(TaxCategory.STANDARD_RATE)
-                                        .build())
-                                .build(),
-                        Item.builder()
+                                        .category(TaxCategory.STANDARD_RATE)),
+                        Item.create()
                                 .id(2L)
                                 .name("Wireless Mechanical Keyboard")
                                 .sellerAssignedId("KEY-MECH-WL")
                                 .quantity(1L)
                                 .unitPrice(new BigDecimal("129.50"))
                                 .itemTotalNetAmount(new BigDecimal("129.50"))
                                 .unitCode(UnitCode.PIECE)
-                                .vat(Vat.builder()
+                                .vat(Vat.create()
                                         .rate(BigDecimal.valueOf(19))
-                                        .category(TaxCategory.STANDARD_RATE)
-                                        .build())
-                                .build()
-                ))
+                                        .category(TaxCategory.STANDARD_RATE))))
 
                 // VAT breakdown
                 .vatTotals(List.of(
-                        Vat.builder()
+                        Vat.create()
                                 .rate(BigDecimal.valueOf(19))
                                 .category(TaxCategory.STANDARD_RATE)
                                 .taxableAmount(BigDecimal.valueOf(529.48)) // Taxable amount
                                 .taxAmount(BigDecimal.valueOf(100.60)) // VAT amount
-                                .build()
                 ))
 
                 // Invoice totals
@@ -175,13 +154,17 @@ public class InvoiceGenerator {
                 .duePayableAmount(new BigDecimal("630.08")) // Amount due for payment
 
                 // Sales order reference
-                .salesOrderReference("SO-98765")
-
-                .build();
+                .salesOrderReference("SO-98765");
 
+        // Generate the XRechnung XML from the invoice
         byte[] xRechnungXML = XRechnungWriter.generateXRechnungXML(invoice);
+        return new String(xRechnungXML);
     }
 }
 ```
 
-You also find this code in the `BuildInvoiceTest` class.
+### Changelog
+
+- 2.0.0: Gallop no longer relies on lombok, introduce fluent api
+- 1.0.1: Add action to publish to maven central
+- 1.0.0: Initial version

build.gradle

@@ -7,16 +7,13 @@ plugins {
 }
 
 group = 'de.codebarista'
-version = '1.0.1'
+version = '2.0.0'
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    compileOnly 'org.projectlombok:lombok:1.18.36'
-    annotationProcessor 'org.projectlombok:lombok:1.18.36'
-
     testImplementation platform('org.junit:junit-bom:5.10.0')
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation 'com.fasterxml.jackson.core:jackson-databind:2.15.2'

src/main/java/de/codebarista/gallop/xrechnung/XRechnungWriter.java

@@ -15,7 +15,6 @@
 import de.codebarista.gallop.xrechnung.model.PrecedingInvoiceReference;
 import de.codebarista.gallop.xrechnung.model.SellerOrBuyer;
 import de.codebarista.gallop.xrechnung.model.Vat;
-import lombok.NonNull;
 import org.w3c.dom.Element;
 
 import javax.xml.parsers.ParserConfigurationException;
@@ -29,6 +28,7 @@
 import java.time.OffsetDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.List;
+import java.util.Objects;
 
 /**
  * Writes a XRechnung XML with the data of an {@linkplain Invoice} object
@@ -55,18 +55,20 @@ public class XRechnungWriter {
      *
      * @param invoice the invoice to be written, must not be {@code null}
      */
-    public XRechnungWriter(@NonNull Invoice invoice) {
+    public XRechnungWriter(Invoice invoice) {
+        Objects.requireNonNull(invoice, "Invoice must not be null");
         this.invoice = invoice;
     }
 
     /**
      * Convert an invoice to a XRechnung XML
      *
-     * @param invoice the Invoice object to serialize to XML
+     * @param invoice the Invoice object to serialize to XML, must not be {@code null}
      * @return binary XRechnung XML document
      * @throws XRechnungWriterException if the creation of the XRechnung failed
      */
-    public static byte[] generateXRechnungXML(@NonNull Invoice invoice) {
+    public static byte[] generateXRechnungXML(Invoice invoice) {
+        Objects.requireNonNull(invoice, "Invoice must not be null");
         var xmlWriter = new XRechnungWriter(invoice);
         try {
             return xmlWriter.getXML();
@@ -315,17 +317,13 @@ private Element createTradeSettlement(XmlDocumentBuilder builder) {
 
         if (invoice.getChargeTotalAmount() != null) {
             Element chargeTotal = builder.createElement(NS_RAM, "ChargeTotalAmount"); // BT-108
-            if (invoice.getChargeTotalAmount() != null) {
-                chargeTotal.setTextContent(invoice.getChargeTotalAmount().toString());
-            }
+            chargeTotal.setTextContent(invoice.getChargeTotalAmount().toString());
             sum.appendChild(chargeTotal);
         }
 
         if (invoice.getAllowanceTotalAmount() != null) {
             Element allowanceTotal = builder.createElement(NS_RAM, "AllowanceTotalAmount");
-            if (invoice.getAllowanceTotalAmount() != null) {
-                allowanceTotal.setTextContent(invoice.getAllowanceTotalAmount().toString());
-            }
+            allowanceTotal.setTextContent(invoice.getAllowanceTotalAmount().toString());
             sum.appendChild(allowanceTotal);
         }
 
@@ -368,7 +366,7 @@ private Element createPrecedingInvoiceReference(XmlDocumentBuilder builder, Prec
         element.appendChild(issuerAssignedId);
         if (reference.getPrecedingInvoiceIssueDate() != null) { // BT-26, optional
             Element issueDateTime = builder.createElement(NS_RAM, "FormattedIssueDateTime");
-            issueDateTime.appendChild(createDateTimeString(builder, invoice.getIssueDate(), NS_QDT));
+            issueDateTime.appendChild(createDateTimeString(builder, reference.getPrecedingInvoiceIssueDate(), NS_QDT));
             element.appendChild(issueDateTime);
         }
         return element;

src/main/java/de/codebarista/gallop/xrechnung/model/Allowance.java

@@ -1,40 +1,104 @@
 package de.codebarista.gallop.xrechnung.model;
 
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-import lombok.With;
-
 import java.math.BigDecimal;
 
 /**
  * Document Level Allowances (BG-20)
  */
-@Builder
-@With
-@Getter
-@NoArgsConstructor
-@AllArgsConstructor
-public class Allowance implements NetAmount {
+public class Allowance implements NetAmount<Allowance> {
     /**
      * Document level allowance amount (BT-92). The actual amount without taxes.<br>
      * <b>Must be 0 or a positive value.</b>
      */
-    public BigDecimal netAmount;
+    private BigDecimal netAmount;
 
     /**
      * Document level allowance VAT category code (BT-95)
      */
-    public TaxCategory vatCategory;
+    private TaxCategory vatCategory;
 
     /**
      * Document level allowance VAT rate (BT-96)
      */
-    public BigDecimal vatRate;
+    private BigDecimal vatRate;
 
     /**
      * Document level allowance reason (BT-97)
      */
-    public String reason;
+    private String reason;
+
+    /**
+     * Creates a new, empty instance of this class.
+     */
+    public Allowance() {
+    }
+
+    /**
+     * Creates a new, empty instance of this class.
+     *
+     * @return a new, empty instance
+     */
+    public static Allowance create() {
+        return new Allowance();
+    }
+
+    /**
+     * Sets the {@link #netAmount}.
+     */
+    @Override
+    public Allowance netAmount(BigDecimal netAmount) {
+        this.netAmount = netAmount;
+        return this;
+    }
+
+    /**
+     * Sets the {@link #vatCategory}.
+     */
+    public Allowance vatCategory(TaxCategory vatCategory) {
+        this.vatCategory = vatCategory;
+        return this;
+    }
+
+    /**
+     * Sets the {@link #vatRate}.
+     */
+    public Allowance vatRate(BigDecimal vatRate) {
+        this.vatRate = vatRate;
+        return this;
+    }
+
+    /**
+     * Sets the {@link #reason}.
+     */
+    public Allowance reason(String reason) {
+        this.reason = reason;
+        return this;
+    }
+
+    @Override
+    public BigDecimal getNetAmount() {
+        return netAmount;
+    }
+
+    /**
+     * Gets the {@link #vatCategory}.
+     */
+    public TaxCategory getVatCategory() {
+        return vatCategory;
+    }
+
+    /**
+     * Gets the {@link #vatRate}.
+     */
+    @Override
+    public BigDecimal getVatRate() {
+        return vatRate;
+    }
+
+    /**
+     * Gets the {@link #reason}.
+     */
+    public String getReason() {
+        return reason;
+    }
 }