Add docs and refactor classess (#73)

* Add docs

* Add docs

Author: carlosthe19916

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

@@ -21,10 +21,15 @@
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
 
+/**
+ * Clase base para CreditNote y DebitNote.
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @Data
 @SuperBuilder
 @EqualsAndHashCode(callSuper = true)
-public class CreditNote extends BaseDocumentoNota {
+public class CreditNote extends Note {
 
     private List<DocumentoTributarioRelacionado_CreditNote> otrosDocumentosTributariosRelacionados;
 }

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

@@ -21,10 +21,22 @@
 import lombok.Builder;
 import lombok.Data;
 
+/**
+ * Cuota de pago para Invoice
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @Data
 @Builder
 public class CuotaDePago {
 
+    /**
+     * Importe de la cuota
+     */
     private BigDecimal importe;
+
+    /**
+     * Fecha de pago de la cuota
+     */
     private LocalDate fechaPago;
 }

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

@@ -24,7 +24,7 @@
 @Data
 @SuperBuilder
 @EqualsAndHashCode(callSuper = true)
-public class DebitNote extends BaseDocumentoNota {
+public class DebitNote extends Note {
 
     private List<DocumentoTributarioRelacionado_DebitNote> otrosDocumentosTributariosRelacionados;
 }

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

@@ -20,6 +20,11 @@
 import lombok.Builder;
 import lombok.Data;
 
+/**
+ * Detracción asociada a un Invoice
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @Data
 @Builder
 public class Detraccion {

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

@@ -32,27 +32,75 @@
 @SuperBuilder
 public abstract class Document {
 
+    /**
+     * Leyendas asociadas al comprobante
+     */
     @Singular
     private Map<String, String> leyendas;
 
+    /**
+     * Moneda en la que se emite el comprobante
+     */
     private String moneda;
+
+    /**
+     * Tasa del IGV. Ejemplo: 0.18
+     */
     private BigDecimal tasaIgv;
+
+    /**
+     * Tasa del IBC. Ejemplo: 0.2
+     */
     private BigDecimal tasaIcb;
 
+    /**
+     * Serie del comprobante
+     */
     private String serie;
+
+    /**
+     * Número del comprobante
+     */
     private Integer numero;
 
+    /**
+     * Fecha de emisión del comprobante
+     */
     private LocalDate fechaEmision;
+
+    /**
+     * Hora de emisión del comprobante
+     */
     private LocalTime horaEmision;
 
+    /**
+     * Cliente
+     */
     private Cliente cliente;
+
+    /**
+     * Proveedor del bien o servicio
+     */
     private Proveedor proveedor;
+
+    /**
+     * Persona que firma electrónicamente el comprobante
+     */
     private Firmante firmante;
 
+    /**
+     * Total de impuestos a pagar
+     */
     private TotalImpuestos totalImpuestos;
 
+    /**
+     * Detalle del comprobante
+     */
     @Singular
     private List<DocumentoDetalle> detalles;
 
+    /**
+     * Guias de remision relacionadas
+     */
     private List<GuiaRemisionRelacionada> guiasRemisionRelacionadas;
 }

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

@@ -24,7 +24,6 @@
 @Builder
 public class DocumentoDetalle {
 
-    private Integer index;
     private String descripcion;
     private String unidadMedida;
     private BigDecimal cantidad;

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

@@ -20,16 +20,45 @@
 import lombok.EqualsAndHashCode;
 import lombok.experimental.SuperBuilder;
 
+/**
+ * Clase base para CreditNote y DebitNOte.
+ *
+ * @author <a href="mailto:carlosthe19916@gmail.com">Carlos Feria</a>
+ */
 @Data
 @SuperBuilder
 @EqualsAndHashCode(callSuper = true)
-public abstract class BaseDocumentoNota extends Document {
+public abstract class Note extends Document {
 
+    /**
+     * Tipo de nota.
+     * <p>
+     * Nota de Crédito: Catalogo 09.
+     * <p>
+     * Nota de Débito: Catalogo 10.
+     */
     private String tipoNota;
 
+    /**
+     * Serie y número del comprobante al que le aplica la nota de crédito/débito.
+     * Ejemplo: F001-1
+     */
     private String comprobanteAfectadoSerieNumero;
+
+    /**
+     * Tipo de del probante referido en {@link Note#comprobanteAfectadoSerieNumero}.
+     * <p>
+     * Catalogo 01.
+     */
     private String comprobanteAfectadoTipo;
+
+    /**
+     * Texto sustentatorio para la emision de la nota
+     */
     private String sustentoDescripcion;
 
+    /**
+     * Importe total de la nota
+     */
     private TotalImporteNote totalImporte;
 }

src/main/java/io/github/project/openubl/xbuilder/enricher/ContentEnricher.java

@@ -16,10 +16,10 @@
  */
 package io.github.project.openubl.xbuilder.enricher;
 
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumentoNota;
 import io.github.project.openubl.xbuilder.content.models.standard.general.CreditNote;
 import io.github.project.openubl.xbuilder.content.models.standard.general.DebitNote;
 import io.github.project.openubl.xbuilder.content.models.standard.general.Invoice;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Note;
 import io.github.project.openubl.xbuilder.enricher.config.DateProvider;
 import io.github.project.openubl.xbuilder.enricher.config.Defaults;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
@@ -72,7 +72,7 @@ public void enrich(DebitNote input) {
         enrichNote(input);
     }
 
-    private void enrichNote(BaseDocumentoNota input) {
+    private void enrichNote(Note input) {
         LocalDate systemLocalDate = dateProvider.now();
 
         Stream

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

@@ -25,6 +25,7 @@
 import io.github.project.openubl.xbuilder.content.models.utils.UBLRegex;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractBodyRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
+import java.util.Optional;
 import java.util.function.Consumer;
 
 /**
@@ -51,10 +52,10 @@ public void modify(Object object) {
                     comprobanteTipo = Catalog12.BOLETA_DE_VENTA_EMITIDA_POR_ANTICIPOS.getCode();
                 }
             } else {
-                Catalog12 catalog12 = Catalog
-                    .valueOfCode(Catalog12.class, anticipo.getComprobanteTipo())
-                    .orElseThrow(Catalog.invalidCatalogValue);
-                comprobanteTipo = catalog12.getCode();
+                Optional<Catalog12> catalog12 = Catalog.valueOfCode(Catalog12.class, anticipo.getComprobanteTipo());
+                if (catalog12.isPresent()) {
+                    comprobanteTipo = catalog12.get().getCode();
+                }
             }
 
             anticipo.setComprobanteTipo(comprobanteTipo);

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

@@ -20,12 +20,15 @@
 import static io.github.project.openubl.xbuilder.enricher.kie.rules.utils.Helpers.whenNote;
 
 import io.github.project.openubl.xbuilder.content.catalogs.Catalog1;
-import io.github.project.openubl.xbuilder.content.models.standard.general.BaseDocumentoNota;
+import io.github.project.openubl.xbuilder.content.models.standard.general.Note;
 import io.github.project.openubl.xbuilder.content.models.utils.UBLRegex;
 import io.github.project.openubl.xbuilder.enricher.kie.AbstractHeaderRule;
 import io.github.project.openubl.xbuilder.enricher.kie.RulePhase;
 import java.util.function.Consumer;
 
+/**
+ * Rule for {@link Note#comprobanteAfectadoTipo}
+ */
 @RulePhase(type = RulePhase.PhaseType.ENRICH)
 public class ComprobanteAfectadoTipoRule extends AbstractHeaderRule {
 
@@ -39,16 +42,16 @@ public boolean test(Object object) {
 
     @Override
     public void modify(Object object) {
-        Consumer<BaseDocumentoNota> consumer = note -> {
-            String tipoComprobanteAfectado = null;
+        Consumer<Note> consumer = note -> {
+            String comprobanteAfectadoTipo = note.getComprobanteAfectadoTipo();
 
             if (UBLRegex.FACTURA_SERIE_REGEX.matcher(note.getSerie()).matches()) {
-                tipoComprobanteAfectado = Catalog1.FACTURA.getCode();
+                comprobanteAfectadoTipo = Catalog1.FACTURA.getCode();
             } else if (UBLRegex.BOLETA_SERIE_REGEX.matcher(note.getSerie()).matches()) {
-                tipoComprobanteAfectado = Catalog1.BOLETA.getCode();
+                comprobanteAfectadoTipo = Catalog1.BOLETA.getCode();
             }
 
-            note.setComprobanteAfectadoTipo(tipoComprobanteAfectado);
+            note.setComprobanteAfectadoTipo(comprobanteAfectadoTipo);
         };
         whenNote.apply(object).ifPresent(consumer);
     }