gobl 0.9.0 → 0.10.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - David Lilue
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,98 +65,97 @@ files:
 - data/regimes/es.json
 - data/regimes/fr.json
 - data/regimes/gb.json
+- data/regimes/it.json
 - data/regimes/nl.json
 - data/regimes/pt.json
+- lib/generated/gobl/bill/charge.rb
+- lib/generated/gobl/bill/delivery.rb
+- lib/generated/gobl/bill/discount.rb
+- lib/generated/gobl/bill/document_reference.rb
+- lib/generated/gobl/bill/invoice.rb
+- lib/generated/gobl/bill/line.rb
+- lib/generated/gobl/bill/line_charge.rb
+- lib/generated/gobl/bill/line_discount.rb
+- lib/generated/gobl/bill/ordering.rb
+- lib/generated/gobl/bill/outlay.rb
+- lib/generated/gobl/bill/payment.rb
+- lib/generated/gobl/bill/preceding.rb
+- lib/generated/gobl/bill/tax.rb
+- lib/generated/gobl/bill/totals.rb
+- lib/generated/gobl/cal/date.rb
+- lib/generated/gobl/cal/period.rb
+- lib/generated/gobl/cbc/code.rb
+- lib/generated/gobl/cbc/key.rb
+- lib/generated/gobl/cbc/meta.rb
+- lib/generated/gobl/cbc/note.rb
+- lib/generated/gobl/cbc/stamp.rb
+- lib/generated/gobl/currency/code.rb
+- lib/generated/gobl/currency/exchange_rate.rb
+- lib/generated/gobl/document.rb
+- lib/generated/gobl/dsig/digest.rb
+- lib/generated/gobl/dsig/signature.rb
+- lib/generated/gobl/envelope.rb
+- lib/generated/gobl/header.rb
+- lib/generated/gobl/i18n/string.rb
+- lib/generated/gobl/l10n/code.rb
+- lib/generated/gobl/l10n/country_code.rb
+- lib/generated/gobl/note/message.rb
+- lib/generated/gobl/org/address.rb
+- lib/generated/gobl/org/coordinates.rb
+- lib/generated/gobl/org/email.rb
+- lib/generated/gobl/org/identity.rb
+- lib/generated/gobl/org/image.rb
+- lib/generated/gobl/org/inbox.rb
+- lib/generated/gobl/org/item.rb
+- lib/generated/gobl/org/name.rb
+- lib/generated/gobl/org/party.rb
+- lib/generated/gobl/org/person.rb
+- lib/generated/gobl/org/registration.rb
+- lib/generated/gobl/org/telephone.rb
+- lib/generated/gobl/org/unit.rb
+- lib/generated/gobl/org/website.rb
+- lib/generated/gobl/pay/advance.rb
+- lib/generated/gobl/pay/card.rb
+- lib/generated/gobl/pay/credit_transfer.rb
+- lib/generated/gobl/pay/direct_debit.rb
+- lib/generated/gobl/pay/due_date.rb
+- lib/generated/gobl/pay/instructions.rb
+- lib/generated/gobl/pay/online.rb
+- lib/generated/gobl/pay/terms.rb
+- lib/generated/gobl/tax/category.rb
+- lib/generated/gobl/tax/category_total.rb
+- lib/generated/gobl/tax/combo.rb
+- lib/generated/gobl/tax/identity.rb
+- lib/generated/gobl/tax/key_definition.rb
+- lib/generated/gobl/tax/preceding_definitions.rb
+- lib/generated/gobl/tax/rate.rb
+- lib/generated/gobl/tax/rate_total.rb
+- lib/generated/gobl/tax/rate_total_surcharge.rb
+- lib/generated/gobl/tax/rate_value.rb
+- lib/generated/gobl/tax/regime.rb
+- lib/generated/gobl/tax/scenario.rb
+- lib/generated/gobl/tax/scenario_set.rb
+- lib/generated/gobl/tax/set.rb
+- lib/generated/gobl/tax/tag.rb
+- lib/generated/gobl/tax/total.rb
+- lib/generated/gobl/tax/zone.rb
+- lib/generated/gobl/uuid/uuid.rb
 - lib/gobl.rb
-- lib/gobl/bill/charge.rb
-- lib/gobl/bill/delivery.rb
-- lib/gobl/bill/discount.rb
-- lib/gobl/bill/document_reference.rb
-- lib/gobl/bill/invoice.rb
-- lib/gobl/bill/invoice_type.rb
-- lib/gobl/bill/line.rb
-- lib/gobl/bill/line_charge.rb
-- lib/gobl/bill/line_discount.rb
-- lib/gobl/bill/ordering.rb
-- lib/gobl/bill/outlay.rb
-- lib/gobl/bill/payment.rb
-- lib/gobl/bill/preceding.rb
-- lib/gobl/bill/tax.rb
-- lib/gobl/bill/totals.rb
-- lib/gobl/cal/date.rb
-- lib/gobl/cal/period.rb
-- lib/gobl/cbc/code.rb
-- lib/gobl/cbc/key.rb
-- lib/gobl/cbc/meta.rb
-- lib/gobl/cbc/note.rb
-- lib/gobl/cbc/note_key.rb
-- lib/gobl/cbc/stamp.rb
 - lib/gobl/config.rb
-- lib/gobl/currency/code.rb
-- lib/gobl/currency/exchange_rate.rb
-- lib/gobl/document.rb
-- lib/gobl/dsig/digest.rb
-- lib/gobl/dsig/signature.rb
 - lib/gobl/enum.rb
-- lib/gobl/envelope.rb
 - lib/gobl/extensions/document_helper.rb
 - lib/gobl/extensions/envelope_helper.rb
 - lib/gobl/extensions/i18n/value_keys_helper.rb
 - lib/gobl/extensions/tax/regime_helper.rb
-- lib/gobl/header.rb
-- lib/gobl/i18n/string.rb
 - lib/gobl/id.rb
-- lib/gobl/l10n/code.rb
-- lib/gobl/l10n/country_code.rb
 - lib/gobl/map.rb
-- lib/gobl/note/message.rb
 - lib/gobl/num/amount.rb
 - lib/gobl/num/percentage.rb
 - lib/gobl/object.rb
 - lib/gobl/operations.rb
 - lib/gobl/operations/service_error.rb
 - lib/gobl/operations/validation_result.rb
-- lib/gobl/org/address.rb
-- lib/gobl/org/coordinates.rb
-- lib/gobl/org/email.rb
-- lib/gobl/org/image.rb
-- lib/gobl/org/inbox.rb
-- lib/gobl/org/item.rb
-- lib/gobl/org/item_code.rb
-- lib/gobl/org/name.rb
-- lib/gobl/org/party.rb
-- lib/gobl/org/person.rb
-- lib/gobl/org/registration.rb
-- lib/gobl/org/telephone.rb
-- lib/gobl/org/unit.rb
-- lib/gobl/org/website.rb
-- lib/gobl/pay/advance.rb
-- lib/gobl/pay/card.rb
-- lib/gobl/pay/credit_transfer.rb
-- lib/gobl/pay/direct_debit.rb
-- lib/gobl/pay/due_date.rb
-- lib/gobl/pay/instructions.rb
-- lib/gobl/pay/method_key.rb
-- lib/gobl/pay/online.rb
-- lib/gobl/pay/term_key.rb
-- lib/gobl/pay/terms.rb
 - lib/gobl/struct.rb
-- lib/gobl/tax/category.rb
-- lib/gobl/tax/category_total.rb
-- lib/gobl/tax/combo.rb
-- lib/gobl/tax/identity.rb
-- lib/gobl/tax/rate.rb
-- lib/gobl/tax/rate_total.rb
-- lib/gobl/tax/rate_total_surcharge.rb
-- lib/gobl/tax/rate_value.rb
-- lib/gobl/tax/regime.rb
-- lib/gobl/tax/scheme.rb
-- lib/gobl/tax/set.rb
-- lib/gobl/tax/source_key.rb
-- lib/gobl/tax/total.rb
-- lib/gobl/tax/zone.rb
-- lib/gobl/uuid/uuid.rb
-- lib/gobl/value.rb
 - lib/gobl/version.rb
 homepage: https://github.com/invopop/gobl.ruby
 licenses:

data/lib/gobl/bill/invoice_type.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Bill
-    # Defines an invoice type according to a subset of the UNTDID 1001 standard list.
-    class InvoiceType < GOBL::Enum
-      # The Schema ID of the GOBL InvoiceType structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/InvoiceType'
-
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
-      ENUM = {
-        'proforma' => 'Proforma invoice, for a clients validation before sending a final invoice.',
-        'simplified' => 'Simplified invoice or receipt typically used for small transactions that dont require customer details.t require customer details.',
-        'partial' => 'Partial invoice',
-        'commercial' => 'Commercial invoice, usually cross-border transactions requiring an invoice for customs.',
-        'corrected' => 'Corrected invoice',
-        'credit-note' => 'Credit note',
-        'self-billed' => 'Self billed invoice'
-      }.freeze
-
-      validates_inclusion_of :_value, in: ENUM.keys, message: '"%{value}" is not within the allowed values of the enumeration'
-    end
-  end
-end

data/lib/gobl/cbc/note_key.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module CBC
-    # NoteKey identifies the type of note being edited
-    class NoteKey < GOBL::Enum
-      # The Schema ID of the GOBL NoteKey structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/cbc/note#/$defs/NoteKey'
-
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
-      ENUM = {
-        'goods' => 'Goods Description',
-        'payment' => 'Terms of Payment',
-        'legal' => 'Legal or regulatory information',
-        'dangerous-goods' => 'Dangerous goods additional information',
-        'ack' => 'Acknowledgement Description',
-        'rate' => 'Rate additional information',
-        'reason' => 'Reason',
-        'dispute' => 'Dispute',
-        'customer' => 'Customer remarks',
-        'glossary' => 'Glossary',
-        'customs' => 'Customs declaration information',
-        'general' => 'General information',
-        'handling' => 'Handling instructions',
-        'packaging' => 'Packaging information',
-        'loading' => 'Loading instructions',
-        'price' => 'Price conditions',
-        'priority' => 'Priority information',
-        'regulatory' => 'Regulatory information',
-        'safety' => 'Safety instructions',
-        'ship-line' => 'Ship line',
-        'supplier' => 'Supplier remarks',
-        'transport' => 'Transportation information',
-        'delivery' => 'Delivery information',
-        'quarantine' => 'Quarantine information',
-        'tax' => 'Tax declaration'
-      }.freeze
-
-      validates_inclusion_of :_value, in: ENUM.keys, message: '"%{value}" is not within the allowed values of the enumeration'
-    end
-  end
-end

data/lib/gobl/document.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  # Contents of the envelope that must contain a $schema.
-  class Document < GOBL::Map
-  end
-end

data/lib/gobl/org/item_code.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Org
-    # ItemCode contains a value and optional label property that means additional codes can be added to an item.
-    class ItemCode < GOBL::Object
-      # The Schema ID of the GOBL ItemCode structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/org/item#/$defs/ItemCode'
-
-      # @!attribute [r] label
-      # Local or human reference for the type of code the value represents.
-      # @return [String]
-      property :label, String
-
-      # @!attribute [r] value
-      # The item code's value.
-      # @return [String]
-      property :value, String
-      validates :value, presence: true
-    end
-  end
-end

data/lib/gobl/pay/method_key.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Pay
-    # Method Key describes how a payment should be made
-    class MethodKey < GOBL::Enum
-      # The Schema ID of the GOBL MethodKey structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/MethodKey'
-
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
-      ENUM = {
-        'any' => 'Any method available, no preference',
-        'card' => 'Credit or debit card',
-        'credit-transfer' => 'Sender initiated bank or wire transfer',
-        'debit-transfer' => 'Receiver initiated bank or wire transfer',
-        'cash' => 'Cash',
-        'direct-debit' => 'Direct debit',
-        'online' => 'Online or web payment'
-      }.freeze
-
-      validates_inclusion_of :_value, in: ENUM.keys, message: '"%{value}" is not within the allowed values of the enumeration'
-    end
-  end
-end

data/lib/gobl/pay/term_key.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Pay
-    # Payment terms key
-    class TermKey < GOBL::Enum
-      # The Schema ID of the GOBL TermKey structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/pay/terms#/$defs/TermKey'
-
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
-      ENUM = {
-        '' => 'Not yet defined',
-        'end-of-month' => 'End of month',
-        'due-date' => 'Due on a specific date',
-        'deferred' => 'Deferred until after the due date',
-        'proximo' => 'Month after the present',
-        'instant' => 'On receipt of invoice',
-        'elective' => 'Chosen by the buyer',
-        'pending' => 'Seller to advise buyer in separate transaction',
-        'advance' => 'Payment made in advance',
-        'delivery' => 'Payment on Delivery'
-      }.freeze
-
-      validates_inclusion_of :_value, in: ENUM.keys, message: '"%{value}" is not within the allowed values of the enumeration'
-    end
-  end
-end

data/lib/gobl/tax/scheme.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Tax
-    # Scheme contains the definition of a scheme that belongs to a region and can be used to simplify validation processes for document contents.
-    class Scheme < GOBL::Object
-      # The Schema ID of the GOBL Scheme structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Scheme'
-
-      # @!attribute [r] key
-      # Key used to identify this scheme
-      # @return [GOBL::CBC::Key]
-      property :key, GOBL::CBC::Key
-      validates :key, presence: true
-
-      # @!attribute [r] name
-      # Name of this scheme.
-      # @return [GOBL::I18n::String]
-      property :name, GOBL::I18n::String
-      validates :name, presence: true
-
-      # @!attribute [r] description
-      # Human details describing what this scheme is used for.
-      # @return [GOBL::I18n::String]
-      property :description, GOBL::I18n::String
-
-      # @!attribute [r] categories
-      # List of tax category codes that can be used when this scheme is applied.
-      # @return [Array<GOBL::CBC::Code>]
-      property :categories, [GOBL::CBC::Code]
-
-      # @!attribute [r] note
-      # Note defines a message that should be added to a document when this scheme is used.
-      # @return [GOBL::CBC::Note]
-      property :note, GOBL::CBC::Note
-    end
-  end
-end

data/lib/gobl/tax/source_key.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-##
-## DO NOT EDIT - This file was generated automatically.
-##
-## Generated with GOBL v0.36.0
-##
-
-module GOBL
-  module Tax
-    # SourceKey identifies the source of a tax identity
-    class SourceKey < GOBL::Enum
-      # The Schema ID of the GOBL SourceKey structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/identity#/$defs/SourceKey'
-
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
-      ENUM = {
-        'tax-agency' => 'Sourced directly from a tax agency',
-        'passport' => 'A passport document',
-        'national' => 'National ID Card or similar',
-        'permit' => 'Residential or similar permit',
-        'other' => 'An other type of source not listed'
-      }.freeze
-
-      validates_inclusion_of :_value, in: ENUM.keys, message: '"%{value}" is not within the allowed values of the enumeration'
-    end
-  end
-end

data/lib/gobl/value.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module GOBL
-  # Base class for single value structs in the GOBL Schema
-  class Value < Struct
-    # Initializes a new value object that corresponds to a given value. The value can be a
-    # `Symbol`, a `String` or anything coercible into one (via `#to_s`).
-    #
-    # @param value [Symbol, String, #to_s] the value of the object.
-    #
-    # @return [Value] the value object corresponding to the given value.
-    def initialize(value)
-      super()
-      self._value = value.to_s
-    end
-
-    # Returns the string representation of the current object
-    #
-    # @return [String] the string representation of the current object
-    def to_s
-      _value.to_s
-    end
-
-    # Returns the symbol representation of the current object
-    #
-    # @return [Symbol] the symbol representation of the current object
-    def to_sym
-      to_s.parameterize.underscore.to_sym
-    end
-
-    # Returns whether the current value is equal to a given one. In addition to
-    # objects of the same type, the current object can be compared to a `Symbol`, a
-    # `String` or anything coercible into one (via `#to_s`)
-    #
-    # @param other [Value, Symbol, String, #to_s] the other value to compare with
-    #
-    # @return [Boolean] `true` if the values are equal, `false` otherwise
-    def ==(other)
-      case other
-      when self.class
-        _value == other._value
-      when Symbol
-        to_sym == other
-      else
-        to_s == other.to_s
-      end
-    end
-
-    # Returns whether the current value is equal to a given one, unlike `#==`, without
-    # doing any coercion. That is, the other object must be of the same class to return
-    # true.
-    #
-    # @param other [Object] the other value to compare with
-    #
-    # @return [Boolean] `true` if the values are equal, `false` otherwise
-    def eql?(other)
-      self.class == other.class && _value.eql?(other._value)
-    end
-
-    # Returns a integer hash code of the current value that respects the following
-    # property: Given objects `a` and `b`. If `a.eql?(b)`, then `a.hash == b.hash`.
-    #
-    # @return [Integer] hash code of the current value
-    def hash
-      [self.class.name, _value].hash
-    end
-
-    # @api private
-    def as_json(...)
-      _value.as_json(...)
-    end
-
-    protected
-
-    attr_accessor :_value
-  end
-end