gobl 0.8.0 → 0.10.0

data/lib/gobl/enum.rb

@@ -3,79 +3,21 @@
 module GOBL
   # Base class for single value structures in the GOBL schema that have a controlled set
   # of values associated to them (i.e., an enumeration) that may constrain them
-  class Enum < Value
-    # Returns an enum 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 [Enum] the enum value instance corresponding to the given value
-    def initialize(value)
-      if value.is_a? Symbol
-        self._value = value_from_sym(value) || value.to_s
-      else
-        super
-      end
-    end
-
-    # Returns the description of the current enum value
-    #
-    # @return [String] the description of the current enum value
-    def description
-      self.class::ENUM.fetch(_value, _value)
-    end
-
-    # Enables dynamic value inquirers for each of the declared enum values. Each inquirer
-    # returns a `Boolean` denoting whether the value equals the enquired value (`true`) or
-    # not (`false`)
-    def method_missing(method_name, *args, &block)
-      if (value = self.class.find_by_inquirer(method_name))
-        self == value
-      else
-        super
-      end
-    end
-
-    # @api private
-    def respond_to_missing?(method_name, include_private = false)
-      self.class.find_by_inquirer(method_name) || super
-    end
+  module Enum
+    def self.included(base)
+      base.include ActiveModel::Validations
 
-    class << self
-      # Returns an array with all the enumerated objects of this type
-      #
-      # @return [Array<#{name}>] the array of enumerated objects
-      def all
-        self::ENUM.keys.map { |key| new(key) }
+      base.class_eval do
+        validate :valid_enum_value, if: :strict_enum?
       end
-
-      # @api private
-      def find_by_sym(sym)
-        all.find { |object| object.to_sym == sym }
-      end
-
-      # @api private
-      def find_by_inquirer(method_name)
-        method_name =~ /(.+)\?$/ && find_by_sym(Regexp.last_match(1).to_sym)
-      end
-    end
-
-    private
-
-    def _value=(value)
-      if strict_enum? && !self.class::ENUM.key?(value)
-        raise TypeError, "\"#{value}\" is not within the valid values of the enumeration"
-      end
-
-      super
     end
 
-    def strict_enum?
-      false
+    def description
+      self.class::ENUM.fetch(self, self)
     end
 
-    def value_from_sym(sym)
-      self.class.find_by_sym(sym)&.to_s
+    def valid_enum_value
+      errors.add(:base, "Value \"#{self}\" is not within the allowed values of the enumeration") unless self.class::ENUM.key?(self)
     end
   end
 end

data/lib/gobl/envelope.rb

@@ -3,11 +3,11 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
-  # Envelope wraps around a gobl document and provides support for digest creation and digital signatures.
+  # Envelope wraps around a document adding headers and digital signatures.
   class Envelope < GOBL::Object
     # The Schema ID of the GOBL Envelope structure
     SCHEMA_ID = 'https://gobl.org/draft-0/envelope'
@@ -16,19 +16,19 @@ module GOBL
     # Schema identifies the schema that should be used to understand this document
     # @return [String]
     property :$schema, String
-    validates :$schema, presence: true
+    validates_presence_of :$schema
 
     # @!attribute [r] head
     # Details on what the contents are
     # @return [Header]
     property :head, Header
-    validates :head, presence: true
+    validates_presence_of :head
 
     # @!attribute [r] doc
     # The data inside the envelope
     # @return [Document]
     property :doc, Document
-    validates :doc, presence: true
+    validates_presence_of :doc
 
     # @!attribute [r] sigs
     # JSON Web Signatures of the header

data/lib/gobl/header.rb

@@ -3,11 +3,11 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
-  # Header defines the meta data of the body.
+  # Header defines the metadata of the body.
   class Header < GOBL::Object
     # The Schema ID of the GOBL Header structure
     SCHEMA_ID = 'https://gobl.org/draft-0/envelope#/$defs/Header'
@@ -16,13 +16,13 @@ module GOBL
     # Unique UUIDv1 identifier for the envelope.
     # @return [GOBL::UUID::UUID]
     property :uuid, GOBL::UUID::UUID
-    validates :uuid, presence: true
+    validates_presence_of :uuid
 
     # @!attribute [r] dig
     # Digest of the canonical JSON body.
     # @return [GOBL::DSig::Digest]
     property :dig, GOBL::DSig::Digest
-    validates :dig, presence: true
+    validates_presence_of :dig
 
     # @!attribute [r] stamps
     # Seals of approval from other organisations.

data/lib/gobl/i18n/string.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL

data/lib/gobl/l10n/code.rb

@@ -3,13 +3,13 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module L10n
     # Code is used for short identifies like country or state codes.
-    class Code < GOBL::Value
+    class Code < String
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/l10n/code'
     end

data/lib/gobl/l10n/country_code.rb

@@ -3,17 +3,18 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module L10n
     # Defines an ISO 3166-2 country code
-    class CountryCode < GOBL::Enum
+    class CountryCode < String
       # The Schema ID of the GOBL CountryCode structure
       SCHEMA_ID = 'https://gobl.org/draft-0/l10n/country-code'
 
-      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
+      include GOBL::Enum
+
       ENUM = {
         'AF' => 'Afghanistan',
         'AX' => 'Åland Islands',

data/lib/gobl/note/message.rb

@@ -3,12 +3,12 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module Note
-    # Message represents the minimum possible contents for a GoBL document type.
+    # Message represents a simple message object with a title and some content meant.
     class Message < GOBL::Object
       # The Schema ID of the GOBL Message structure
       SCHEMA_ID = 'https://gobl.org/draft-0/note/message'
@@ -19,10 +19,10 @@ module GOBL
       property :title, String
 
       # @!attribute [r] content
-      # Details of what exactly this message wants to communicate
+      # Details of what exactly this message wants to communicate.
       # @return [String]
       property :content, String
-      validates :content, presence: true
+      validates_presence_of :content
 
       # @!attribute [r] meta
       # Any additional semi-structured data that might be useful.

data/lib/gobl/org/address.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -62,7 +62,7 @@ module GOBL
       # Village, town, district, or city, typically inside a region.
       # @return [String]
       property :locality, String
-      validates :locality, presence: true
+      validates_presence_of :locality
 
       # @!attribute [r] region
       # Province, county, or state, inside a country.

data/lib/gobl/org/coordinates.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL

data/lib/gobl/org/email.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -27,7 +27,7 @@ module GOBL
       # Electronic mailing address.
       # @return [String]
       property :addr, String
-      validates :addr, presence: true
+      validates_presence_of :addr
 
       # @!attribute [r] meta
       # Additional fields.

data/lib/gobl/org/identity.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.38.0
+##
+
+module GOBL
+  module Org
+    # Identity is used to define a code for a specific context.
+    class Identity < GOBL::Object
+      # The Schema ID of the GOBL Identity structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/identity'
+
+      # @!attribute [r] uuid
+      # Unique identity for this identity object.
+      # @return [GOBL::UUID::UUID]
+      property :uuid, GOBL::UUID::UUID
+
+      # @!attribute [r] label
+      # Optional label useful for non-standard identities to give a bit more context.
+      # @return [String]
+      property :label, String
+
+      # @!attribute [r] type
+      # The type of Code being represented and usually specific for a particular context, country, or tax regime.
+      # @return [GOBL::CBC::Code]
+      property :type, GOBL::CBC::Code
+
+      # @!attribute [r] code
+      # The actual value of the identity code.
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
+      validates_presence_of :code
+    end
+  end
+end

data/lib/gobl/org/image.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL

data/lib/gobl/org/inbox.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -22,7 +22,7 @@ module GOBL
       # Type of inbox being defined.
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
-      validates :key, presence: true
+      validates_presence_of :key
 
       # @!attribute [r] role
       # Role assigned to this inbox that may be relevant for the consumer.
@@ -38,7 +38,7 @@ module GOBL
       # Actual Code or ID that identifies the Inbox.
       # @return [String]
       property :code, String
-      validates :code, presence: true
+      validates_presence_of :code
     end
   end
 end

data/lib/gobl/org/item.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -14,12 +14,12 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/org/item'
 
       # @!attribute [r] uuid
-      # Unique identify of this item independent of the Supplier IDs
+      # Unique identity of this item
       # @return [GOBL::UUID::UUID]
       property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] ref
-      # Primary reference code that identifies this item. Additional codes can be provided in the 'codes' field.
+      # Primary reference code that identifies this item. Additional codes can be provided in the 'identities' property.
       # @return [String]
       property :ref, String
 
@@ -27,7 +27,12 @@ module GOBL
       # Brief name of the item
       # @return [String]
       property :name, String
-      validates :name, presence: true
+      validates_presence_of :name
+
+      # @!attribute [r] identities
+      # List of additional codes, IDs, or SKUs which can be used to identify the item. They should be agreed upon between supplier and customer.
+      # @return [Array<GOBL::Org::Identity>]
+      property :identities, [GOBL::Org::Identity]
 
       # @!attribute [r] desc
       # Detailed description
@@ -43,18 +48,13 @@ module GOBL
       # Base price of a single unit to be sold.
       # @return [GOBL::Num::Amount]
       property :price, GOBL::Num::Amount
-      validates :price, presence: true
+      validates_presence_of :price
 
       # @!attribute [r] unit
       # Unit of measure.
       # @return [GOBL::Org::Unit]
       property :unit, GOBL::Org::Unit
 
-      # @!attribute [r] codes
-      # List of additional codes, IDs, or SKUs which can be used to identify the item. The should be agreed upon between supplier and customer.
-      # @return [Array<ItemCode>]
-      property :codes, [ItemCode]
-
       # @!attribute [r] origin
       # Country code of where this item was from originally.
       # @return [GOBL::L10n::CountryCode]

data/lib/gobl/org/name.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -32,7 +32,7 @@ module GOBL
       # Person's given or first name
       # @return [String]
       property :given, String
-      validates :given, presence: true
+      validates_presence_of :given
 
       # @!attribute [r] middle
       # Middle names or initials
@@ -43,7 +43,7 @@ module GOBL
       # Second or Family name.
       # @return [String]
       property :surname, String
-      validates :surname, presence: true
+      validates_presence_of :surname
 
       # @!attribute [r] surname2
       # Additional second of family name.

data/lib/gobl/org/party.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -13,11 +13,6 @@ module GOBL
       # The Schema ID of the GOBL Party structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/party'
 
-      # @!attribute [r] id
-      # Internal ID used to identify the party inside a document.
-      # @return [String]
-      property :id, String
-
       # @!attribute [r] uuid
       # Unique identity code
       # @return [GOBL::UUID::UUID]
@@ -28,11 +23,16 @@ module GOBL
       # @return [GOBL::Tax::Identity]
       property :tax_id, GOBL::Tax::Identity
 
+      # @!attribute [r] identities
+      # Set of codes used to identify the party in other systems.
+      # @return [Array<GOBL::Org::Identity>]
+      property :identities, [GOBL::Org::Identity]
+
       # @!attribute [r] name
       # Legal name or representation of the organization.
       # @return [String]
       property :name, String
-      validates :name, presence: true
+      validates_presence_of :name
 
       # @!attribute [r] alias
       # Alternate short name.

data/lib/gobl/org/person.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -13,11 +13,6 @@ module GOBL
       # The Schema ID of the GOBL Person structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/person'
 
-      # @!attribute [r] id
-      # Internal ID used to identify the person inside a document.
-      # @return [String]
-      property :id, String
-
       # @!attribute [r] uuid
       # Unique identity code
       # @return [GOBL::UUID::UUID]
@@ -27,7 +22,7 @@ module GOBL
       # Complete details on the name of the person
       # @return [GOBL::Org::Name]
       property :name, GOBL::Org::Name
-      validates :name, presence: true
+      validates_presence_of :name
 
       # @!attribute [r] role
       # What they do within an organization

data/lib/gobl/org/registration.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL

data/lib/gobl/org/telephone.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -27,7 +27,7 @@ module GOBL
       # The number to be dialed in ITU E.164 international format.
       # @return [String]
       property :num, String
-      validates :num, presence: true
+      validates_presence_of :num
     end
   end
 end

data/lib/gobl/org/unit.rb

@@ -3,17 +3,18 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
   module Org
     # Unit describes how the quantity of the product should be interpreted.
-    class Unit < GOBL::Enum
+    class Unit < String
       # The Schema ID of the GOBL Unit structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/unit'
 
-      # The enumeration of values of the object and their descriptions (Values different to these are also allowed)
+      include GOBL::Enum
+
       ENUM = {
         'g' => 'Metric grams',
         'kg' => 'Metric kilograms',
@@ -64,6 +65,10 @@ module GOBL
         'sheet' => 'Sheets',
         'envelope' => 'Envelopes'
       }.freeze
+
+      def strict_enum?
+        false
+      end
     end
   end
 end

data/lib/gobl/org/website.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -32,7 +32,7 @@ module GOBL
       # URL for the website.
       # @return [String]
       property :url, String
-      validates :url, presence: true
+      validates_presence_of :url
     end
   end
 end

data/lib/gobl/pay/advance.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -37,7 +37,7 @@ module GOBL
       # Details about the advance.
       # @return [String]
       property :desc, String
-      validates :desc, presence: true
+      validates_presence_of :desc
 
       # @!attribute [r] percent
       # How much as a percentage of the total with tax was paid
@@ -48,7 +48,7 @@ module GOBL
       # How much was paid.
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
 
       # @!attribute [r] currency
       # If different from the parent document's base currency.

data/lib/gobl/pay/card.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL
@@ -17,13 +17,13 @@ module GOBL
       # Last 4 digits of the card's Primary Account Number (PAN).
       # @return [String]
       property :last4, String
-      validates :last4, presence: true
+      validates_presence_of :last4
 
       # @!attribute [r] holder
       # Name of the person whom the card belongs to.
       # @return [String]
       property :holder, String
-      validates :holder, presence: true
+      validates_presence_of :holder
     end
   end
 end

data/lib/gobl/pay/credit_transfer.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL

data/lib/gobl/pay/direct_debit.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.36.0
+## Generated with GOBL v0.38.0
 ##
 
 module GOBL