gobl 0.15.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3895151963e6e381c356696eb41af65244f6e80f8601528973c3f3b9de517d
-  data.tar.gz: 9d36d0318a22bf9a52c328d042bbba74e687995be459179ab89b7226cee3d37f
+  metadata.gz: a6c8e7f19ff84fd4088b793969af198ee03411e09265071ff3f9b7ec75ff78fc
+  data.tar.gz: 8154a6f7ffd4e2c94dfa5a8ff856fe21abb37b20f3ef651830bd53e8455f7b67
 SHA512:
-  metadata.gz: 12140b4170025db93c81ae5e4f87bb6edbcb9322994d2f979c098e081dd3869865ca0e80a2b3a61e29868acce72dcdc23ca676bded9296266fa194d9466445e2
-  data.tar.gz: a04b534b1e0f6d3e8b712d71232005c4b06f2e2d2d79133bb109752f115e2dc7f3377b1bb2c9f7f87e97b708e136a3341d399421b54c8e96ffc5b0d7041d77d7
+  metadata.gz: 32c5009e9bc9e6bc6aae5f36e3c5f15147d634fad2b2bcbb8d22a4543b2f3cc9f8ef982ae4a48fb8188aa2cc4e509be5d64a32673cd36a4039605b438f77be9e
+  data.tar.gz: a6c1a18a2d275ee6fdfe0aa5677f0f7691271a03af51bdd63b0b397ae71013a2daad978babd1c1a6137aa6ebb69afbee283bc2e38ec2dc3daa354c452f0081df

data/README.md

@@ -81,12 +81,12 @@ GOBL is a JSON format. So, you'll probably need to read or produce valid GOBL JS
 
 ```ruby
 json = '{"$schema":"https://gobl.org/draft-0/note/message", "content":"Hello World!"}'
-document = GOBL::Document.from_json!(json) #=> #<GOBL::Document _value={"$schema"=>"https://gobl.org/draft-0/note/message", "content"=>"Hello World!"}>
+document = GOBL::Schema::Object.from_json!(json) #=> #<GOBL::Schema::Object _value={"$schema"=>"https://gobl.org/draft-0/note/message", "content"=>"Hello World!"}>
 message = document.extract #=> #<GOBL::Note::Message title=nil content="Hello World!" meta=nil>
 message.content #=> "Hello World!"
 ```
 
-Note that, in the previous example, we parsed the JSON fragment as a document. A [document](https://docs.gobl.org/core/documents) is one of the fundamental entities of GOBL, and it represents a business document in an abstract way. To get the specific document type instantiated –a message, in the example above–, we needed to call the [`#extract`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FDocumentHelper:extract) method of the document object.
+Note that, in the previous example, we parsed the JSON fragment as a document. A [document](https://docs.gobl.org/core/documents) is one of the fundamental entities of GOBL, and it represents a business document in an abstract way. To get the specific document type instantiated –a message, in the example above–, we needed to call the [`#extract`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FSchema%2FObjectHelper:extract) method of the document object.
 
 The previous instantiation method is useful if you don't know the document type in advance. If you do, you could also instantiate the object in this more direct way:
 
@@ -103,15 +103,15 @@ message = GOBL::Note::Message.new(content: 'Hello World!')
 message.to_json #=> "{\"content\":\"Hello World!\"}"
 ```
 
-Note that, in the previous example, the generated JSON doesn't include a `$schema` attribute. This is because the GOBL schema doesn't require that attribute in a standalone message structure. If you want to use that structure as a document, you will need a `$schema` to be present. You can get that from your Ruby code by simply [_embedding_](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FDocumentHelper%2FClassMethods:embed) the struct in a document:
+Note that, in the previous example, the generated JSON doesn't include a `$schema` attribute. This is because the GOBL schema doesn't require that attribute in a standalone message structure. If you want to use that structure as a document, you will need a `$schema` to be present. You can get that from your Ruby code by simply [_embedding_](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FSchema%2FObjectHelper%2FClassMethods:embed) the struct in a document:
 
 ```ruby
 message = GOBL::Note::Message.new(content: 'Hello World!')
-document = GOBL::Document.embed(message)
+document = GOBL::Schema::Object.embed(message)
 document.to_json #=> "{\"content\":\"Hello World!\",\"$schema\":\"https://gobl.org/draft-0/note/message\"}"
 ```
 
-_See also [`GOBL::Struct.from_json!`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FStruct%2Efrom_json!), [`GOBL::Struct#to_json`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FStruct:to_json), [`GOBL::Document#embed`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FDocumentHelper%2FClassMethods:embed), [`GOBL::Document.extract`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FDocumentHelper:extract)_
+_See also [`GOBL::Struct.from_json!`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FStruct%2Efrom_json!), [`GOBL::Struct#to_json`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FStruct:to_json), [`GOBL::Schema::Object#embed`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FSchema%2FObjectHelper%2FClassMethods:embed), [`GOBL::Schema::Object.extract`](https://rubydoc.info/github/invopop/gobl.ruby/GOBL%2FExtensions%2FSchema%2FObjectHelper:extract)_
 
 ### Handling value objects and enumerations
 
@@ -179,7 +179,7 @@ invoice = GOBL::Bill::Invoice.new(
     taxes: [ { cat: 'VAT', rate: :standard } ]
   }]
 )
-document = GOBL::Document.embed(invoice)
+document = GOBL::Schema::Object.embed(invoice)
 calculated_document = GOBL.build(document)
 calculated_invoice = calculated_document.extract
 calculated_invoice.totals.total_with_tax #=> "2178.00"
@@ -213,6 +213,8 @@ You can avoid mage and the docker container if you prefer so. Take a look at the
 
 The command `mage setup` fetches and installs all the required dependencies to use the gem.
 
+If you run into any problems with dependencies, don't forget this is a library, so the Gemfile.lock is not included. Delete any local versions you may already have and re-run.
+
 #### Code generation
 
 Ensure all the GOBL JSON Schema and Regime files are available by manually copying the [base GOBL project](https://github.com/invopop/gobl)'s `build/` path to the `data/` path in this repository. For example, assuming you have GOBL at `../gobl/`, you can run this:

data/data/regimes/co.json

@@ -4,6 +4,7 @@
     "en": "Colombia",
     "es": "Colombia"
   },
+  "time_zone": "America/Bogota",
   "country": "CO",
   "zones": [
     {
@@ -14588,7 +14589,7 @@
         "en": "TIN - Tax Identification Number",
         "es": "NIT - Número de Identificación Tributaria"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "1",
         "dian-company-id": "31"
       }
@@ -14599,7 +14600,7 @@
         "en": "Civil Registry",
         "es": "Registro Civil"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "11"
       }
@@ -14610,7 +14611,7 @@
         "en": "Identity Card",
         "es": "Tarjeta de Identidad"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "12"
       }
@@ -14621,7 +14622,7 @@
         "en": "Citizen Identity Card",
         "es": "Cédula de ciudadanía"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "13"
       }
@@ -14632,7 +14633,7 @@
         "en": "Foreigner Identity Card",
         "es": "Tarjeta de Extranjería"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "21"
       }
@@ -14643,7 +14644,7 @@
         "en": "Foreigner Citizen Identity Card",
         "es": "Cédula de extranjería"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "22"
       }
@@ -14654,7 +14655,7 @@
         "en": "TIN of an individual",
         "es": "NIT de persona natural"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "31"
       }
@@ -14665,7 +14666,7 @@
         "en": "Passport",
         "es": "Pasaporte"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "41"
       }
@@ -14676,7 +14677,7 @@
         "en": "Foreign Document",
         "es": "Documento de identificación extranjero"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "42"
       }
@@ -14687,7 +14688,7 @@
         "en": "PEP - Special Permit to Stay",
         "es": "PEP - Permiso Especial de Permanencia"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "47"
       }
@@ -14698,7 +14699,7 @@
         "en": "Foreign TIN",
         "es": "NIT de otro país"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "1",
         "dian-company-id": "50"
       }
@@ -14709,7 +14710,7 @@
         "en": "NUIP - National Unique Personal Identification Number",
         "es": "NUIP - Número Único de Identificación Personal"
       },
-      "codes": {
+      "map": {
         "dian-additional-account-id": "2",
         "dian-company-id": "91"
       }
@@ -14729,7 +14730,7 @@
           "en": "Partial refund of part of the goods or services.",
           "es": "Devolución de parte de los bienes; no aceptación de partes del servicio."
         },
-        "codes": {
+        "map": {
           "dian": "1"
         }
       },
@@ -14739,7 +14740,7 @@
           "en": "Previous document has been completely cancelled.",
           "es": "Anulación de la factura anterior."
         },
-        "codes": {
+        "map": {
           "dian": "2"
         }
       },
@@ -14749,7 +14750,7 @@
           "en": "Partial or total discount.",
           "es": "Rebaja o descuento parcial o total."
         },
-        "codes": {
+        "map": {
           "dian": "3"
         }
       },
@@ -14759,7 +14760,7 @@
           "en": "Ajuste de precio.",
           "es": "Price adjustment."
         },
-        "codes": {
+        "map": {
           "dian": "4"
         }
       },
@@ -14769,7 +14770,7 @@
           "en": "Otros.",
           "es": "Other."
         },
-        "codes": {
+        "map": {
           "dian": "5"
         }
       }

data/data/regimes/es.json

@@ -4,6 +4,7 @@
     "en": "Spain",
     "es": "España"
   },
+  "time_zone": "Europe/Madrid",
   "country": "ES",
   "zones": [
     {
@@ -596,7 +597,7 @@
         "en": "National Tax Identity",
         "es": "Número de Identificación Fiscal"
       },
-      "codes": {
+      "map": {
         "ticketbai-id-type": "02"
       }
     },
@@ -606,7 +607,7 @@
         "en": "Passport",
         "es": "Pasaporte"
       },
-      "codes": {
+      "map": {
         "ticketbai-id-type": "03"
       }
     },
@@ -616,7 +617,7 @@
         "en": "National ID Card or similar from a foreign country",
         "es": "Documento oficial de identificación expedido por el país o territorio de residencia"
       },
-      "codes": {
+      "map": {
         "ticketbai-id-type": "04"
       }
     },
@@ -626,7 +627,7 @@
         "en": "Residential permit",
         "es": "Certificado de residencia"
       },
-      "codes": {
+      "map": {
         "ticketbai-id-type": "05"
       }
     },
@@ -636,11 +637,64 @@
         "en": "An other type of source not listed",
         "es": "Otro documento probatorio"
       },
-      "codes": {
+      "map": {
         "ticketbai-id-type": "06"
       }
     }
   ],
+  "extensions": [
+    {
+      "key": "es-tbai-exemption",
+      "name": {
+        "en": "TicketBAI Exemption code",
+        "es": "Código de Exención de TicketBAI"
+      },
+      "codes": [
+        {
+          "code": "E1",
+          "name": {
+            "en": "Exempt pursuant to Article 20 of the Foral VAT Law",
+            "es": "Exenta por el artículo 20 de la Norma Foral del IVA"
+          }
+        },
+        {
+          "code": "E2",
+          "name": {
+            "en": "Exempt pursuant to Article 21 of the Foral VAT Law",
+            "es": "Exenta por el artículo 21 de la Norma Foral del IVA"
+          }
+        },
+        {
+          "code": "E3",
+          "name": {
+            "en": "Exempt pursuant to Article 22 of the Foral VAT Law",
+            "es": "Exenta por el artículo 22 de la Norma Foral del IVA"
+          }
+        },
+        {
+          "code": "E4",
+          "name": {
+            "en": "Exempt pursuant to Articles 23 and 24 of the Foral VAT Law",
+            "es": "Exenta por el artículos 23 y 24 de la Norma Foral del IVA"
+          }
+        },
+        {
+          "code": "E5",
+          "name": {
+            "en": "Exempt pursuant to Article 25 of the Foral VAT law",
+            "es": "Exenta por el artículo 25 de la Norma Foral del IVA"
+          }
+        },
+        {
+          "code": "E6",
+          "name": {
+            "en": "Exempt pursuant to other reasons",
+            "es": "Exenta por otra causa"
+          }
+        }
+      ]
+    }
+  ],
   "item_keys": [
     {
       "key": "resale",
@@ -845,7 +899,7 @@
           "en": "Invoice code",
           "es": "Número de la factura"
         },
-        "codes": {
+        "map": {
           "facturae": "01"
         }
       },
@@ -855,7 +909,7 @@
           "en": "Invoice series",
           "es": "Serie de la factura"
         },
-        "codes": {
+        "map": {
           "facturae": "02"
         }
       },
@@ -865,7 +919,7 @@
           "en": "Issue date",
           "es": "Fecha expedición"
         },
-        "codes": {
+        "map": {
           "facturae": "03"
         }
       },
@@ -875,7 +929,7 @@
           "en": "Name and surnames/Corporate name – Issuer (Sender)",
           "es": "Nombre y apellidos/Razón Social-Emisor"
         },
-        "codes": {
+        "map": {
           "facturae": "04"
         }
       },
@@ -885,7 +939,7 @@
           "en": "Name and surnames/Corporate name - Receiver",
           "es": "Nombre y apellidos/Razón Social-Receptor"
         },
-        "codes": {
+        "map": {
           "facturae": "05"
         }
       },
@@ -895,7 +949,7 @@
           "en": "Issuer's Tax Identification Number",
           "es": "Identificación fiscal Emisor/obligado"
         },
-        "codes": {
+        "map": {
           "facturae": "06"
         }
       },
@@ -905,7 +959,7 @@
           "en": "Receiver's Tax Identification Number",
           "es": "Identificación fiscal Receptor"
         },
-        "codes": {
+        "map": {
           "facturae": "07"
         }
       },
@@ -915,7 +969,7 @@
           "en": "Issuer's address",
           "es": "Domicilio Emisor/Obligado"
         },
-        "codes": {
+        "map": {
           "facturae": "08"
         }
       },
@@ -925,7 +979,7 @@
           "en": "Receiver's address",
           "es": "Domicilio Receptor"
         },
-        "codes": {
+        "map": {
           "facturae": "09"
         }
       },
@@ -935,7 +989,7 @@
           "en": "Item line",
           "es": "Detalle Operación"
         },
-        "codes": {
+        "map": {
           "facturae": "10"
         }
       },
@@ -945,7 +999,7 @@
           "en": "Applicable Tax Rate",
           "es": "Porcentaje impositivo a aplicar"
         },
-        "codes": {
+        "map": {
           "facturae": "11"
         }
       },
@@ -955,7 +1009,7 @@
           "en": "Applicable Tax Amount",
           "es": "Cuota tributaria a aplicar"
         },
-        "codes": {
+        "map": {
           "facturae": "12"
         }
       },
@@ -965,7 +1019,7 @@
           "en": "Applicable Date/Period",
           "es": "Fecha/Periodo a aplicar"
         },
-        "codes": {
+        "map": {
           "facturae": "13"
         }
       },
@@ -975,7 +1029,7 @@
           "en": "Invoice Class",
           "es": "Clase de factura"
         },
-        "codes": {
+        "map": {
           "facturae": "14"
         }
       },
@@ -985,7 +1039,7 @@
           "en": "Legal literals",
           "es": "Literales legales"
         },
-        "codes": {
+        "map": {
           "facturae": "15"
         }
       },
@@ -995,7 +1049,7 @@
           "en": "Taxable Base",
           "es": "Base imponible"
         },
-        "codes": {
+        "map": {
           "facturae": "16"
         }
       },
@@ -1005,7 +1059,7 @@
           "en": "Calculation of tax outputs",
           "es": "Cálculo de cuotas repercutidas"
         },
-        "codes": {
+        "map": {
           "facturae": "80"
         }
       },
@@ -1015,7 +1069,7 @@
           "en": "Calculation of tax inputs",
           "es": "Cálculo de cuotas retenidas"
         },
-        "codes": {
+        "map": {
           "facturae": "81"
         }
       },
@@ -1025,7 +1079,7 @@
           "en": "Taxable Base modified due to return of packages and packaging materials",
           "es": "Base imponible modificada por devolución de envases / embalajes"
         },
-        "codes": {
+        "map": {
           "facturae": "82"
         }
       },
@@ -1035,7 +1089,7 @@
           "en": "Taxable Base modified due to discounts and rebates",
           "es": "Base imponible modificada por descuentos y bonificaciones"
         },
-        "codes": {
+        "map": {
           "facturae": "83"
         }
       },
@@ -1045,7 +1099,7 @@
           "en": "Taxable Base modified due to firm court ruling or administrative decision",
           "es": "Base imponible modificada por resolución firme, judicial o administrativa"
         },
-        "codes": {
+        "map": {
           "facturae": "84"
         }
       },
@@ -1055,7 +1109,7 @@
           "en": "Taxable Base modified due to unpaid outputs where there is a judgement opening insolvency proceedings",
           "es": "Base imponible modificada cuotas repercutidas no satisfechas. Auto de declaración de concurso"
         },
-        "codes": {
+        "map": {
           "facturae": "85"
         }
       }
@@ -1067,7 +1121,7 @@
           "en": "Complete",
           "es": "Rectificaticón íntegra"
         },
-        "codes": {
+        "map": {
           "facturae": "01"
         }
       },
@@ -1077,7 +1131,7 @@
           "en": "Corrected items only",
           "es": "Rectificación por diferencias"
         },
-        "codes": {
+        "map": {
           "facturae": "02"
         }
       },
@@ -1087,7 +1141,7 @@
           "en": "Bulk deal in a given period",
           "es": "Rectificación por descuento por volumen de operaciones durante un periodo"
         },
-        "codes": {
+        "map": {
           "facturae": "03"
         }
       },
@@ -1097,7 +1151,7 @@
           "en": "Authorized by the Tax Agency",
           "es": "Autorizadas por la Agencia Tributaria"
         },
-        "codes": {
+        "map": {
           "facturae": "04"
         }
       }
@@ -1247,73 +1301,18 @@
           ]
         },
         {
-          "key": "exempt+article-20",
+          "key": "exempt",
           "name": {
-            "en": "Exempt pursuant to Article 20 of the Foral VAT Law",
-            "es": "Exenta por el artículo 20 de la Norma Foral del IVA"
+            "en": "Exempt",
+            "es": "Exenta"
           },
           "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E1"
-          }
-        },
-        {
-          "key": "exempt+article-21",
-          "name": {
-            "en": "Exempt pursuant to Article 21 of the Foral VAT Law",
-            "es": "Exenta por el artículo 21 de la Norma Foral del IVA"
-          },
-          "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E2"
-          }
-        },
-        {
-          "key": "exempt+article-22",
-          "name": {
-            "en": "Exempt pursuant to Article 22 of the Foral VAT Law",
-            "es": "Exenta por el artículo 22 de la Norma Foral del IVA"
-          },
-          "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E3"
-          }
-        },
-        {
-          "key": "exempt+article-23",
-          "name": {
-            "en": "Exempt pursuant to Articles 23 and 24 of the Foral VAT Law",
-            "es": "Exenta por el artículos 23 y 24 de la Norma Foral del IVA"
-          },
-          "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E4"
-          }
-        },
-        {
-          "key": "exempt+article-25",
-          "name": {
-            "en": "Exempt pursuant to Article 25 of the Foral VAT law",
-            "es": "Exenta por el artículo 25 de la Norma Foral del IVA"
-          },
-          "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E5"
-          }
-        },
-        {
-          "key": "exempt+other",
-          "name": {
-            "en": "Exempt pursuant to other reasons",
-            "es": "Exenta por otra causa"
-          },
-          "exempt": true,
-          "codes": {
-            "ticketbai-causa-exencion": "E6"
-          }
+          "extensions": [
+            "es-tbai-exemption"
+          ]
         }
       ],
-      "codes": {
+      "map": {
         "facturae-tax-type-code": "01"
       }
     },
@@ -1365,7 +1364,7 @@
           ]
         }
       ],
-      "codes": {
+      "map": {
         "facturae-tax-type-code": "03"
       }
     },
@@ -1379,7 +1378,7 @@
         "en": "Production, Services, and Import Tax",
         "es": "Impuesto sobre la Producción, los Servicios y la Importación"
       },
-      "codes": {
+      "map": {
         "facturae-tax-type-code": "02"
       }
     },
@@ -1460,7 +1459,7 @@
           ]
         }
       ],
-      "codes": {
+      "map": {
         "facturae-tax-type-code": "04"
       }
     }

data/data/regimes/fr.json

@@ -4,6 +4,7 @@
     "en": "France",
     "fr": "La France"
   },
+  "time_zone": "Europe/Paris",
   "country": "FR",
   "currency": "EUR",
   "tags": [

data/data/regimes/gb.json

@@ -3,6 +3,7 @@
   "name": {
     "en": "United Kingdom"
   },
+  "time_zone": "Europe/London",
   "country": "GB",
   "currency": "GBP",
   "categories": [