gobl 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14bd34289a0ba3fff84bdefe4fd1fedb84fcf914f446c1c6f2911aa322909154
-  data.tar.gz: fff37f189098fa49e3f01cb526cf1985321c068e99bd424fd1d21642daac299e
+  metadata.gz: 63b2dd9fcdb9215de25168e5aac158d06b54eaec29af7a347d72dc5709cc1f0f
+  data.tar.gz: 5c83ab6304a80028904d96a5152bd4a10e38fe84fccf2d8e058314df08d1a676
 SHA512:
-  metadata.gz: c48f0af106b03682ccabd1191db9ee2c00205719c8dfa809e4fb1437c9bc3b8340ca76e0989ac4743b25e14479995feeb6cce6ac3394cbe147d8ef958a9a17ec
-  data.tar.gz: 0a4a47d068d70aa46717be6a34a50f3a694a1bc2de618e46c6005be1059a9ab1a696e10116ce59bdd6335d097d418ad936b973bfcc7d4880c5d7691fbe1c56d7
+  metadata.gz: 5b32311778224d58772f77eea900e7b35984048832ca49bd33d59cc1128e27985d08304eaf655863a55d19854446a4abef306d96dc8d2359c76a778145b4ee71
+  data.tar.gz: ac1836afe39e78a07854767590cd08f0bbc720eeaa4d25f5ce7b582d5db0fe3b1ad263759be07485363e519034c8e51e2dfac07bcd930bfa681d1fe376c4e317

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,13 +213,17 @@ 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:
 
 ```bash
 rm -rf ./data/*
-cp -r ../gobl/build/* ./data
+cd ../gobl
+find ./data -name '*.json' -type f | cpio -pdm ../gobl.ruby/
+cd ../gobl.ruby
 ```
 
 Please note that `schemas` is _.gitignored_ as we only need it to generate the code. However, the previous command also copies `regimes` which content is used by the library and so, it is part of the git repo and the gem.

data/data/regimes/ca.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://gobl.org/draft-0/tax/regime",
+  "name": {
+    "en": "Canada"
+  },
+  "time_zone": "America/Toronto",
+  "country": "CA",
+  "currency": "CAD",
+  "categories": [
+    {
+      "code": "GST",
+      "name": {
+        "en": "GST"
+      },
+      "title": {
+        "en": "General Sales Tax"
+      },
+      "rates": [
+        {
+          "key": "zero",
+          "name": {
+            "en": "Zero Rate"
+          },
+          "desc": {
+            "en": "Some supplies are zero-rated under the GST, mainly: basic groceries, agricultural products, farm livestock, most fishery products such, prescription drugs and drug-dispensing services, certain medical devices, feminine hygiene products, exports, many transportation services where the origin or destination is outside Canada"
+          },
+          "values": [
+            {
+              "percent": "0.0%"
+            }
+          ]
+        },
+        {
+          "key": "standard",
+          "name": {
+            "en": "Standard rate"
+          },
+          "desc": {
+            "en": "For the majority of sales of goods and services: it applies to all products or services for which no other rate is expressly provided."
+          },
+          "values": [
+            {
+              "since": "2022-01-01",
+              "percent": "5%"
+            }
+          ]
+        }
+      ],
+      "sources": [
+        {
+          "title": {
+            "en": "GST/HST provincial rates table"
+          },
+          "url": "https://www.canada.ca/en/revenue-agency/services/tax/businesses/topics/gst-hst-businesses/charge-collect-which-rate/calculator.html"
+        }
+      ]
+    },
+    {
+      "code": "HST",
+      "name": {
+        "en": "HST"
+      },
+      "title": {
+        "en": "Harmonized Sales Tax"
+      }
+    },
+    {
+      "code": "PST",
+      "name": {
+        "en": "PST"
+      },
+      "title": {
+        "en": "Provincial Sales Tax"
+      }
+    }
+  ]
+}