gobl 0.9.0 → 0.10.1

data/lib/{gobl → generated/gobl}/tax/category.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
@@ -16,12 +16,12 @@ module GOBL
       # @!attribute [r] code
       # @return [GOBL::CBC::Code]
       property :code, GOBL::CBC::Code
-      validates :code, presence: true
+      validates_presence_of :code
 
       # @!attribute [r] name
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
-      validates :name, presence: true
+      validates_presence_of :name
 
       # @!attribute [r] desc
       # @return [GOBL::I18n::String]
@@ -36,7 +36,17 @@ module GOBL
       # Specific tax definitions inside this category.
       # @return [Array<Rate>]
       property :rates, [Rate]
-      validates :rates, presence: true
+      validates_presence_of :rates
+
+      # @!attribute [r] tags
+      # Tags contains a set of tag definitions that can be applied for this tax category.
+      # @return [Array<Tag>]
+      property :tags, [Tag]
+
+      # @!attribute [r] meta
+      # Meta contains additional information about the category that is relevant for local frequently used formats.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
     end
   end
 end

data/lib/{gobl → generated/gobl}/tax/category_total.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
@@ -16,7 +16,7 @@ module GOBL
       # @!attribute [r] code
       # @return [GOBL::CBC::Code]
       property :code, GOBL::CBC::Code
-      validates :code, presence: true
+      validates_presence_of :code
 
       # @!attribute [r] retained
       # @return [Boolean]
@@ -25,17 +25,17 @@ module GOBL
       # @!attribute [r] rates
       # @return [Array<RateTotal>]
       property :rates, [RateTotal]
-      validates :rates, presence: true
+      validates_presence_of :rates
 
       # @!attribute [r] base
       # @return [GOBL::Num::Amount]
       property :base, GOBL::Num::Amount
-      validates :base, presence: true
+      validates_presence_of :base
 
       # @!attribute [r] amount
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
 
       # @!attribute [r] surcharge
       # @return [GOBL::Num::Amount]

data/lib/{gobl → generated/gobl}/tax/combo.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,7 +17,7 @@ module GOBL
       # Tax category code from those available inside a region.
       # @return [GOBL::CBC::Code]
       property :cat, GOBL::CBC::Code
-      validates :cat, presence: true
+      validates_presence_of :cat
 
       # @!attribute [r] rate
       # Rate within a category to apply.
@@ -33,6 +33,11 @@ module GOBL
       # Some countries require an additional surcharge (calculated if rate present).
       # @return [GOBL::Num::Percentage]
       property :surcharge, GOBL::Num::Percentage
+
+      # @!attribute [r] tags
+      # Additional data may be required in some regimes, the tags property helps reference them.
+      # @return [Array<GOBL::CBC::Key>]
+      property :tags, [GOBL::CBC::Key]
     end
   end
 end

data/lib/{gobl → generated/gobl}/tax/identity.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,22 +22,32 @@ module GOBL
       # ISO country code for Where the tax identity was issued.
       # @return [GOBL::L10n::CountryCode]
       property :country, GOBL::L10n::CountryCode
-      validates :country, presence: true
+      validates_presence_of :country
 
       # @!attribute [r] zone
       # Where inside the country the tax identity holder is based for tax purposes like a village, town, district, city, county, state or province. For some areas, this could be a regular post or zip code. See the regime packages for specific validation rules.
       # @return [GOBL::L10n::Code]
       property :zone, GOBL::L10n::Code
 
+      # Enumeration of possible values for {#source} with their corresponding descriptions
+      SOURCE_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
+
       # @!attribute [r] source
       # What is the source document of the tax identity.
-      # @return [SourceKey]
-      property :source, SourceKey
+      # @return [GOBL::CBC::Key]
+      property :source, GOBL::CBC::Key
+      validates_inclusion_of :source, in: SOURCE_ENUM.keys, allow_blank: true
 
       # @!attribute [r] code
       # Normalized code shown on the original identity document.
-      # @return [String]
-      property :code, String
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
 
       # @!attribute [r] meta
       # Additional details that may be required.

data/lib/generated/gobl/tax/key_definition.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 Tax
+    # KeyDefinition defines properties of a key that is specific for a regime.
+    class KeyDefinition < GOBL::Object
+      # The Schema ID of the GOBL KeyDefinition structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/KeyDefinition'
+
+      # @!attribute [r] key
+      # Actual key value.
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+      validates_presence_of :key
+
+      # @!attribute [r] name
+      # Short name for the key, if relevant.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+
+      # @!attribute [r] desc
+      # Description offering more details about when the key should be used.
+      # @return [GOBL::I18n::String]
+      property :desc, GOBL::I18n::String
+
+      # @!attribute [r] meta
+      # Any additional data that might be relevant in some regimes?
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/generated/gobl/tax/preceding_definitions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.38.0
+##
+
+module GOBL
+  module Tax
+    # PrecedingDefinitions contains details about what can be defined in Invoice preceding document data.
+    class PrecedingDefinitions < GOBL::Object
+      # The Schema ID of the GOBL PrecedingDefinitions structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/PrecedingDefinitions'
+
+      # @!attribute [r] corrections
+      # Corrections contains a list of all the keys that can be used to identify a correction.
+      # @return [Array<KeyDefinition>]
+      property :corrections, [KeyDefinition]
+
+      # @!attribute [r] correction_methods
+      # CorrectionMethods describe the methods used to correct an invoice.
+      # @return [Array<KeyDefinition>]
+      property :correction_methods, [KeyDefinition]
+    end
+  end
+end

data/lib/{gobl → generated/gobl}/tax/rate.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,14 +17,16 @@ module GOBL
       # Key identifies this rate within the system
       # @return [GOBL::CBC::Key]
       property :key, GOBL::CBC::Key
-      validates :key, presence: true
+      validates_presence_of :key
 
       # @!attribute [r] name
+      # Human name of the rate
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
-      validates :name, presence: true
+      validates_presence_of :name
 
       # @!attribute [r] desc
+      # Useful description of the rate.
       # @return [GOBL::I18n::String]
       property :desc, GOBL::I18n::String
 
@@ -32,7 +34,12 @@ module GOBL
       # Values contains a list of Value objects that contain the current and historical percentage values for the rate and additional filters. Order is important, newer values should come before older values.
       # @return [Array<RateValue>]
       property :values, [RateValue]
-      validates :values, presence: true
+      validates_presence_of :values
+
+      # @!attribute [r] meta
+      # Meta contains additional information about the rate that is relevant for local frequently used implementations.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
     end
   end
 end

data/lib/{gobl → generated/gobl}/tax/rate_total.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
@@ -20,18 +20,18 @@ module GOBL
       # @!attribute [r] base
       # @return [GOBL::Num::Amount]
       property :base, GOBL::Num::Amount
-      validates :base, presence: true
+      validates_presence_of :base
 
       # @!attribute [r] percent
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
-      validates :percent, presence: true
+      validates_presence_of :percent
 
       # @!attribute [r] amount
       # Total amount of rate, excluding surcharges
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
 
       # @!attribute [r] surcharge
       # @return [RateTotalSurcharge]

data/lib/{gobl → generated/gobl}/tax/rate_total_surcharge.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
@@ -16,12 +16,12 @@ module GOBL
       # @!attribute [r] percent
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
-      validates :percent, presence: true
+      validates_presence_of :percent
 
       # @!attribute [r] amount
       # @return [GOBL::Num::Amount]
       property :amount, GOBL::Num::Amount
-      validates :amount, presence: true
+      validates_presence_of :amount
     end
   end
 end

data/lib/{gobl → generated/gobl}/tax/rate_value.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
       # Percent rate that should be applied
       # @return [GOBL::Num::Percentage]
       property :percent, GOBL::Num::Percentage
-      validates :percent, presence: true
+      validates_presence_of :percent
 
       # @!attribute [r] surcharge
       # An additional surcharge to apply.

data/lib/{gobl → generated/gobl}/tax/regime.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
       # Name of the country
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
-      validates :name, presence: true
+      validates_presence_of :name
 
       # @!attribute [r] country
       # Country code for the region
       # @return [GOBL::L10n::CountryCode]
       property :country, GOBL::L10n::CountryCode
-      validates :country, presence: true
+      validates_presence_of :country
 
       # @!attribute [r] zone
       # Specific Locality, region, city, province, county, or similar code inside the country, if needed.
@@ -39,18 +39,28 @@ module GOBL
       # Currency used by the country.
       # @return [GOBL::Currency::Code]
       property :currency, GOBL::Currency::Code
-      validates :currency, presence: true
+      validates_presence_of :currency
 
-      # @!attribute [r] schemes
-      # Set of specific scheme definitions inside the region.
-      # @return [Array<Scheme>]
-      property :schemes, [Scheme]
+      # @!attribute [r] tags
+      # Tags that can be applied at the document level to identify additional considerations.
+      # @return [Array<Tag>]
+      property :tags, [Tag]
+
+      # @!attribute [r] scenarios
+      # Sets of scenario definitions for the regime.
+      # @return [Array<ScenarioSet>]
+      property :scenarios, [ScenarioSet]
+
+      # @!attribute [r] preceding
+      # Configuration details for preceding options.
+      # @return [PrecedingDefinitions]
+      property :preceding, PrecedingDefinitions
 
       # @!attribute [r] categories
       # List of tax categories.
       # @return [Array<Category>]
       property :categories, [Category]
-      validates :categories, presence: true
+      validates_presence_of :categories
     end
   end
 end

data/lib/generated/gobl/tax/scenario.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.38.0
+##
+
+module GOBL
+  module Tax
+    # Scenario is used to describe a tax scenario of a document based on the combination of document type and tag used.
+    class Scenario < GOBL::Object
+      # The Schema ID of the GOBL Scenario structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Scenario'
+
+      # @!attribute [r] type
+      # Type of document, if present.
+      # @return [Array<GOBL::CBC::Key>]
+      property :type, [GOBL::CBC::Key]
+
+      # @!attribute [r] tags
+      # Tag that was applied to the document
+      # @return [Array<GOBL::CBC::Key>]
+      property :tags, [GOBL::CBC::Key]
+
+      # @!attribute [r] note
+      # A note to be added to the document if the scenario is applied.
+      # @return [GOBL::CBC::Note]
+      property :note, GOBL::CBC::Note
+
+      # @!attribute [r] meta
+      # Any additional local meta data that may be useful in integrations.
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/generated/gobl/tax/scenario_set.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.38.0
+##
+
+module GOBL
+  module Tax
+    # ScenarioSet is a collection of tax scenarios for a given schema that can be used to determine special codes or notes that need to be included in the final document.
+    class ScenarioSet < GOBL::Object
+      # The Schema ID of the GOBL ScenarioSet structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/ScenarioSet'
+
+      # @!attribute [r] schema
+      # Partial or complete schema URL for the document type
+      # @return [String]
+      property :schema, String
+      validates_presence_of :schema
+
+      # @!attribute [r] list
+      # List of scenarios for the schema
+      # @return [Array<Scenario>]
+      property :list, [Scenario]
+      validates_presence_of :list
+    end
+  end
+end

data/lib/{gobl → generated/gobl}/tax/set.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/generated/gobl/tax/tag.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.38.0
+##
+
+module GOBL
+  module Tax
+    # Tag describes a tax tag that can be used to identify additional requirements in an electronic invoice.
+    class Tag < GOBL::Object
+      # The Schema ID of the GOBL Tag structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Tag'
+
+      # @!attribute [r] key
+      # Key used to identify the tag
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
+      validates_presence_of :key
+
+      # @!attribute [r] name
+      # Name of this tag.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+
+      # @!attribute [r] meta
+      # Additional local
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/{gobl → generated/gobl}/tax/total.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
       # Total value of all the taxes applied.
       # @return [GOBL::Num::Amount]
       property :sum, GOBL::Num::Amount
-      validates :sum, presence: true
+      validates_presence_of :sum
     end
   end
 end

data/lib/{gobl → generated/gobl}/tax/zone.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,7 +17,7 @@ module GOBL
       # Unique zone code.
       # @return [GOBL::L10n::Code]
       property :code, GOBL::L10n::Code
-      validates :code, presence: true
+      validates_presence_of :code
 
       # @!attribute [r] name
       # Name of the zone to be use if a locality or region is not applicable.

data/lib/{gobl → generated/gobl}/uuid/uuid.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 UUID
     # Universally Unique Identifier. We only recommend using versions 1 and 4 within GOBL.
-    class UUID < GOBL::Value
+    class UUID < String
       # The Schema ID of the GOBL UUID structure
       SCHEMA_ID = 'https://gobl.org/draft-0/uuid/uuid'
     end

data/lib/gobl/enum.rb

@@ -3,69 +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
-    include ActiveModel::Validations
+  module Enum
+    def self.included(base)
+      base.include ActiveModel::Validations
 
-    # 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
+      base.class_eval do
+        validate :valid_enum_value, if: :strict_enum?
       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)
+      self.class::ENUM.fetch(self, self)
     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
-
-    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) }
-      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_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/version.rb

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

data/lib/gobl.rb

@@ -9,6 +9,7 @@ require 'base64'
 require 'hashme'
 
 loader = Zeitwerk::Loader.for_gem
+loader.push_dir("#{__dir__}/generated")
 loader.inflector.inflect(
   'gobl' => 'GOBL',
   'uuid' => 'UUID',