Add docs - Anticipo (#59)

* Add docs - anticipo

* Add docs - anticipo

Author: carlosthe19916

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/Anticipo.java

@@ -20,12 +20,38 @@
 import lombok.Builder;
 import lombok.Data;
 
+/**
+ * Anticipo realizado.
+ * <p>
+ * Un anticipo se realiza cuando el cliente a entregado al proveedor un pago por anticipado a la prestación del servicio o la entrega.
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @Data
 @Builder
 public class Anticipo {
 
+    /**
+     * Tipo de anticipo realizado.
+     * <p>
+     * Catalogo 53.
+     * <p>
+     * Valores válidos: "04", "05", "06"
+     */
     private String tipo;
-    private String comprobanteTipo;
+
+    /**
+     * Serie y número de comprobante del anticipo, por ejemplo "F123-4"
+     */
     private String comprobanteSerieNumero;
+
+    /**
+     * Código de tipo de documento del {@link #comprobanteSerieNumero}.
+     */
+    private String comprobanteTipo;
+
+    /**
+     * Monto prepagado o anticipado
+     */
     private BigDecimal monto;
 }

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/BaseDocumentoNota.java

@@ -23,7 +23,7 @@
 @Data
 @SuperBuilder
 @EqualsAndHashCode(callSuper = true)
-public abstract class BaseDocumentoNota extends BaseDocumento {
+public abstract class BaseDocumentoNota extends Document {
 
     private String tipoNota;
 

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/BaseDocumento.java renamed to src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/Document.java

@@ -30,7 +30,7 @@
 
 @Data
 @SuperBuilder
-public abstract class BaseDocumento {
+public abstract class Document {
 
     @Singular
     private Map<String, String> leyendas;

src/main/java/io/github/project/openubl/xbuilder/content/models/standard/general/Invoice.java

@@ -29,7 +29,7 @@
 @SuperBuilder
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)
-public class Invoice extends BaseDocumento {
+public class Invoice extends Document {
 
     private LocalDate fechaVencimiento;
     private String tipoComprobante;
@@ -45,6 +45,9 @@ public class Invoice extends BaseDocumento {
     private Detraccion detraccion;
     private Percepcion percepcion;
 
+    /**
+     * Anticipos asociados al comprobante
+     */
     @Singular
     private List<Anticipo> anticipos;
 

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/body/anticipo/ComprobanteTipoRule.java renamed to src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/body/anticipo/ComprobanteTipoAnticipoRule.java

@@ -27,8 +27,13 @@
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
 
+/**
+ * Rule for: {@link Anticipo#comprobanteTipo}
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @RulePhase(type = RulePhase.PhaseType.ENRICH)
-public class ComprobanteTipoRule extends AbstractBodyRule {
+public class ComprobanteTipoAnticipoRule extends AbstractBodyRule {
 
     @Override
     public boolean test(Object object) {

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/body/anticipo/TipoAnticipoRule.java

@@ -26,6 +26,11 @@
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
 
+/**
+ * Rule for: {@link Anticipo#tipo}
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @RulePhase(type = RulePhase.PhaseType.ENRICH)
 public class TipoAnticipoRule extends AbstractBodyRule {
 

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/ClienteTipoDocumentoRule.java

@@ -21,7 +21,7 @@
 
 import io.github.project.openubl.xbuilder.content.catalogs.Catalog;
 import io.github.project.openubl.xbuilder.content.catalogs.Catalog6;
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumento;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Document;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
@@ -44,7 +44,7 @@ public boolean test(Object object) {
 
     @Override
     public void modify(Object object) {
-        Consumer<BaseDocumento> consumer = document -> {
+        Consumer<Document> consumer = document -> {
             Catalog6 catalog6 = Catalog
                 .valueOfCode(Catalog6.class, document.getCliente().getTipoDocumentoIdentidad())
                 .orElseThrow(Catalog.invalidCatalogValue);

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/FechaEmisionRule.java

@@ -19,7 +19,7 @@
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.isBaseDocumento;
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.whenBaseDocumento;
 
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumento;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Document;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
@@ -37,7 +37,7 @@ public boolean test(Object object) {
 
     @Override
     public void modify(Object object) {
-        Consumer<BaseDocumento> consumer = document -> document.setFechaEmision(getRuleContext().getLocalDate());
+        Consumer<Document> consumer = document -> document.setFechaEmision(getRuleContext().getLocalDate());
         whenBaseDocumento.apply(object).ifPresent(consumer);
     }
 }

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/FirmanteRule.java

@@ -20,7 +20,7 @@
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.whenBaseDocumento;
 
 import io.github.project.openubl.xbuilder.content.models.common.Firmante;
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumento;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Document;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
@@ -38,7 +38,7 @@ public boolean test(Object object) {
 
     @Override
     public void modify(Object object) {
-        Consumer<BaseDocumento> consumer = document -> {
+        Consumer<Document> consumer = document -> {
             if (document.getFirmante() == null) {
                 document.setFirmante(Firmante.builder().build());
             }

src/main/java/io/github/project/openubl/xbuilder/enricher/kie/rules/enrich/header/MonedaRule.java

@@ -19,7 +19,7 @@
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.isBaseDocumento;
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.whenBaseDocumento;
 
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumento;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Document;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
@@ -37,7 +37,7 @@ public boolean test(Object object) {
 
     @Override
     public void modify(Object object) {
-        Consumer<BaseDocumento> consumer = document -> document.setMoneda(getDefaults().getMoneda());
+        Consumer<Document> consumer = document -> document.setMoneda(getDefaults().getMoneda());
         whenBaseDocumento.apply(object).ifPresent(consumer);
     }
 }