gobl 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfea0d56efe6b8768eeb6bb8f0b24ba06f3cb0a92d20bd1b4a82d26eb8ad9339
-  data.tar.gz: 134bd9649596f3abda61cfde20ce93792ff934c824daaf88fe49b10799c2d8bf
+  metadata.gz: 780ae6767cacd14ffee20e56cf54fe7717b4f4ce76fe298709910fc04c53bb3b
+  data.tar.gz: 3af8d8bbb1f70068115f36f6e264e609133e0791b213a4785be9cc2db7a5e046
 SHA512:
-  metadata.gz: a7e6c54e26240d2b44af093e5e9582b82c3dc8997e100752997f0b56cb3d132c0d3b5ccfd441306ae97aae8bac91b2545d13f9cee2a5fe36a985599990a3822e
-  data.tar.gz: 99a36744e2b6485bad7810377eecd01a01694381f29a58e785f68fda4b0d9aa2ddd363448292fdb7b8476c0737b3af349db62098ec66a1f98aadffedfb424721
+  metadata.gz: 7b37e007b00340a53df6bb721085f792038bc1168cc794741df707befb793abf6f2f1cc3b9b883505cf40b7ad10b32fcbedd0a818d529e5904b1e91ffd6445a6
+  data.tar.gz: 80263b62bce2dd2e1fae02d2af6141facd8264c68da2ee4ee5f2d9bd4371fee959d42d5f436d4ed12d05c91d391186a6b55906f7602f06b84e51aa3e9f29b21a

data/data/regimes/pt.json

@@ -128,6 +128,75 @@
     }
   ],
   "currency": "EUR",
+  "tags": [
+    {
+      "key": "invoice-receipt",
+      "name": {
+        "en": "Invoice-receipt",
+        "pt": "Fatura-recibo"
+      }
+    },
+    {
+      "key": "simplified",
+      "name": {
+        "en": "Simplified invoice",
+        "pt": "Fatura simplificada"
+      }
+    }
+  ],
+  "scenarios": [
+    {
+      "schema": "bill/invoice",
+      "list": [
+        {
+          "type": [
+            "standard"
+          ],
+          "meta": {
+            "at-invoice-type": "FT"
+          }
+        },
+        {
+          "type": [
+            "standard"
+          ],
+          "tags": [
+            "simplified"
+          ],
+          "meta": {
+            "at-invoice-type": "FS"
+          }
+        },
+        {
+          "type": [
+            "standard"
+          ],
+          "tags": [
+            "invoice-receipt"
+          ],
+          "meta": {
+            "at-invoice-type": "FR"
+          }
+        },
+        {
+          "type": [
+            "debit-note"
+          ],
+          "meta": {
+            "at-invoice-type": "ND"
+          }
+        },
+        {
+          "type": [
+            "credit-note"
+          ],
+          "meta": {
+            "at-invoice-type": "NC"
+          }
+        }
+      ]
+    }
+  ],
   "preceding": {
     "types": [
       "credit-note"

data/lib/gobl/extensions/bill/invoice_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    module Bill
+      # Additional methods for the generated {GOBL::Bill::Invoice} class
+      module InvoiceHelper
+        # Returns the applicable regime based on the supplier’s tax ID
+        def regime
+          regime_country && GOBL::Tax::Regime.fetch(regime_country)
+        end
+
+        # Returns the invoice’s scenario summary which aggregates the data of
+        # the matching regime’s scenarios
+        def scenario_summary
+          ScenarioSummary.new(matching_scenarios)
+        end
+
+        private
+
+        def regime_country
+          supplier&.tax_id&.country
+        end
+
+        def matching_scenarios
+          return [] unless scenario_set
+
+          scenario_set.list.select do |scenario|
+            matches_scenario?(scenario)
+          end
+        end
+
+        def matches_scenario?(scenario)
+          matches_scenario_tags?(scenario) && matches_scenario_type?(scenario)
+        end
+
+        def matches_scenario_type?(scenario)
+          scenario.type.blank? || scenario.type.include?(type)
+        end
+
+        def matches_scenario_tags?(scenario)
+          scenario_tags = scenario.tags || []
+          tax_tags = tax&.tags || []
+
+          (scenario_tags - tax_tags).empty?
+        end
+
+        def scenario_set
+          regime&.scenarios&.find do |scenario_set|
+            self.class::SCHEMA_ID.include?(scenario_set.schema)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gobl/extensions/bill/scenario_summary.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    module Bill
+      # Aggregates the data of collection of scenarios
+      class ScenarioSummary
+        def initialize(scenarios)
+          @scenarios = scenarios
+        end
+
+        # Returns the aggregated metadata of the scenarios
+        def meta
+          scenarios.inject({}) do |meta, scenario|
+            meta.merge(scenario.meta.to_h)
+          end
+        end
+
+        private
+
+        attr_reader :scenarios
+      end
+    end
+  end
+end

data/lib/gobl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GOBL
-  VERSION = '0.14.0'
+  VERSION = '0.14.1'
 end

data/lib/gobl.rb

@@ -50,3 +50,4 @@ GOBL::Document.include GOBL::Extensions::DocumentHelper
 GOBL::Document.extend GOBL::Extensions::DocumentHelper::ClassMethods
 GOBL::Envelope.include GOBL::Extensions::EnvelopeHelper
 GOBL::Tax::Regime.extend GOBL::Extensions::Tax::RegimeHelper::ClassMethods
+GOBL::Bill::Invoice.include GOBL::Extensions::Bill::InvoiceHelper

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Luismi Cavalle
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,8 @@ files:
 - lib/gobl.rb
 - lib/gobl/config.rb
 - lib/gobl/enum.rb
+- lib/gobl/extensions/bill/invoice_helper.rb
+- lib/gobl/extensions/bill/scenario_summary.rb
 - lib/gobl/extensions/document_helper.rb
 - lib/gobl/extensions/envelope_helper.rb
 - lib/gobl/extensions/i18n/value_keys_helper.rb