gobl 0.1.2

data/lib/gobl/tax/category.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # Category contains the definition of a general type of tax inside a region.
+    class Category < GOBL::Struct
+      # The Schema ID of the GOBL Category structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Category'
+
+      # @!attribute [r] code
+      # @return [GOBL::Org::Code]
+      attribute :code, GOBL::Org::Code
+
+      # @!attribute [r] name
+      # @return [GOBL::I18n::String]
+      attribute :name, GOBL::I18n::String
+
+      # @!attribute [r] desc
+      # @return [GOBL::I18n::String]
+      attribute? :desc, GOBL::I18n::String.optional
+
+      # @!attribute [r] retained
+      # Retained when true implies that the tax amount will be retained by the buyer on behalf of the supplier, and thus subtracted from the invoice taxable base total. Typically used for taxes related to income.
+      # @return [Boolean]
+      attribute? :retained, GOBL::Types::Bool.optional
+
+      # @!attribute [r] rates
+      # Specific tax definitions inside this category.
+      # @return [Array<Rate>]
+      attribute :rates, GOBL::Types::Array.of(Rate)
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Category] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          code: GOBL::Org::Code.from_gobl!(data['code']),
+          name: GOBL::I18n::String.from_gobl!(data['name']),
+          desc: data['desc'] ? GOBL::I18n::String.from_gobl!(data['desc']) : nil,
+          retained: data['retained'],
+          rates: data['rates']&.map { |item| Rate.from_gobl!(item) }
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'code' => attributes[:code]&.to_gobl,
+          'name' => attributes[:name]&.to_gobl,
+          'desc' => attributes[:desc]&.to_gobl,
+          'retained' => attributes[:retained],
+          'rates' => attributes[:rates]&.map { |item| item&.to_gobl }
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Category} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Category] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/category_total.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # CategoryTotal groups together all rates inside a given category.
+    class CategoryTotal < GOBL::Struct
+      # The Schema ID of the GOBL CategoryTotal structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/CategoryTotal'
+
+      # @!attribute [r] code
+      # @return [GOBL::Org::Code]
+      attribute :code, GOBL::Org::Code
+
+      # @!attribute [r] retained
+      # @return [Boolean]
+      attribute? :retained, GOBL::Types::Bool.optional
+
+      # @!attribute [r] rates
+      # @return [Array<RateTotal>]
+      attribute :rates, GOBL::Types::Array.of(RateTotal)
+
+      # @!attribute [r] base
+      # @return [GOBL::Num::Amount]
+      attribute :base, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] amount
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] surcharge
+      # @return [GOBL::Num::Amount]
+      attribute? :surcharge, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [CategoryTotal] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          code: GOBL::Org::Code.from_gobl!(data['code']),
+          retained: data['retained'],
+          rates: data['rates']&.map { |item| RateTotal.from_gobl!(item) },
+          base: data['base'],
+          amount: data['amount'],
+          surcharge: data['surcharge'] || nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'code' => attributes[:code]&.to_gobl,
+          'retained' => attributes[:retained],
+          'rates' => attributes[:rates]&.map { |item| item&.to_gobl },
+          'base' => attributes[:base]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'surcharge' => attributes[:surcharge]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {CategoryTotal} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [CategoryTotal] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/combo.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # Combo represents the tax combination of a category code and rate key.
+    class Combo < GOBL::Struct
+      # The Schema ID of the GOBL Combo structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/set#/$defs/Combo'
+
+      # @!attribute [r] cat
+      # Tax category code from those available inside a region.
+      # @return [GOBL::Org::Code]
+      attribute :cat, GOBL::Org::Code
+
+      # @!attribute [r] rate
+      # Rate within a category to apply.
+      # @return [GOBL::Org::Key]
+      attribute? :rate, GOBL::Org::Key.optional
+
+      # @!attribute [r] percent
+      # Percent defines the percentage set manually or determined from the rate key (calculated if rate present).
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] surcharge
+      # Some countries require an additional surcharge (calculated if rate present).
+      # @return [GOBL::Num::Percentage]
+      attribute? :surcharge, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Combo] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          cat: GOBL::Org::Code.from_gobl!(data['cat']),
+          rate: data['rate'] ? GOBL::Org::Key.from_gobl!(data['rate']) : nil,
+          percent: data['percent'] || nil,
+          surcharge: data['surcharge'] || nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'cat' => attributes[:cat]&.to_gobl,
+          'rate' => attributes[:rate]&.to_gobl,
+          'percent' => attributes[:percent]&.to_gobl,
+          'surcharge' => attributes[:surcharge]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Combo} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Combo] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/localities.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # Localities stores an array of locality objects used to describe areas sub-divisions inside a region.
+    class Localities < GOBL::Struct
+      extend Forwardable
+      include Enumerable
+
+      # The Schema ID of the GOBL Localities structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Localities'
+
+      attribute :_ary, GOBL::Types::Array.of(Locality)
+
+      # @!method [](*args)
+      #   Returns elements from the array
+      #   @overload [](index)
+      #     Returns the element in a specific position
+      #     @param index [Integer] the position of the object
+      #     @return [Locality] the element in the `index` position
+      #   @overload [](start, length)
+      #     Returns all the elements within a range of positions
+      #     @param start [Integer] start position of the range
+      #     @param length [Integer] length of the range
+      #     @return [Array<Locality>] the elements in the range
+      #   @overload [](range)
+      #     Returns all the elements within a range
+      #     @param range [Range] start and end positions of the range
+      #     @return [Array<Locality>] the elements in the range
+      #
+      # @!method each
+      #   Iterates over the array elements
+      #   @overload each(&block)
+      #     Calls the given block with each element in the array
+      #     @yield [element] element of the array
+      #     @return [self] the object itself
+      #   @overload each
+      #     Returns an Enumerator that iterates over the array elements
+      #     @return [Enumerator] the enumerator of the array elements
+      #
+      # @!method empty?
+      #   Returns `true` if the number of elements in the array is zero, `false` otherwise.
+      #   @return [Boolean] whether the array is empty or not
+      #
+      # @!method length
+      #   Returns the number of elements in the array
+      #   @return [Integer] the number of elements in the array
+      def_delegators :_ary, :[], :each, :empty?, :length
+
+      # Creates a new object from an array of GOBL data
+      #
+      # @param data [Array] an array of GOBL data
+      #
+      # @return [Localities] the object created from the given data
+      def self.from_gobl!(data)
+        new(_ary: data&.map { |item| Locality.from_gobl!(item) })
+      end
+
+      # Returns an array of GOBL data representing the current object
+      #
+      # @return [Array<Hash>] the array of GOBL data that represents the current object
+      def to_gobl
+        _ary.map(&:to_gobl)
+      end
+
+      # Returns a {Localities} object from a given array of structs. The array may
+      # contain {Locality} objects or hashes. If hashes are provided, the constructor
+      # will call `Locality#new` to generate the objects that will be part of the
+      # returned {Localities} object
+      #
+      # @param object [Array<Locality, Hash>] the array containing the structs
+      #
+      # @return [Localities] the object corresponding to the given input
+      def self.new(object)
+        case object
+        when Array
+          super _ary: object
+        else # internal use, not to be used in public calls
+          super
+        end
+      end
+    end
+  end
+end

data/lib/gobl/tax/locality.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # Locality represents an area inside a region, like a province or a state, which shares the basic definitions of the region, but may vary in some validation rules.
+    class Locality < GOBL::Struct
+      # The Schema ID of the GOBL Locality structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Locality'
+
+      # @!attribute [r] code
+      # Code
+      # @return [GOBL::L10n::Code]
+      attribute :code, GOBL::L10n::Code
+
+      # @!attribute [r] name
+      # Name of the locality with local and hopefully international translations.
+      # @return [GOBL::I18n::String]
+      attribute :name, GOBL::I18n::String
+
+      # @!attribute [r] meta
+      # Any additional information
+      # @return [GOBL::Org::Meta]
+      attribute? :meta, GOBL::Org::Meta.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Locality] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          code: GOBL::L10n::Code.from_gobl!(data['code']),
+          name: GOBL::I18n::String.from_gobl!(data['name']),
+          meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'code' => attributes[:code]&.to_gobl,
+          'name' => attributes[:name]&.to_gobl,
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Locality} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Locality] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/rate.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # Rate defines a single rate inside a category
+    class Rate < GOBL::Struct
+      # The Schema ID of the GOBL Rate structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Rate'
+
+      # @!attribute [r] key
+      # Key identifies this rate within the system
+      # @return [GOBL::Org::Key]
+      attribute :key, GOBL::Org::Key
+
+      # @!attribute [r] name
+      # @return [GOBL::I18n::String]
+      attribute :name, GOBL::I18n::String
+
+      # @!attribute [r] desc
+      # @return [GOBL::I18n::String]
+      attribute? :desc, GOBL::I18n::String.optional
+
+      # @!attribute [r] values
+      # Values contains a list of Value objects that contain the current and historical percentage values for the rate; order is important, newer values should come before older values.
+      # @return [Array<RateValue>]
+      attribute :values, GOBL::Types::Array.of(RateValue)
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Rate] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          key: GOBL::Org::Key.from_gobl!(data['key']),
+          name: GOBL::I18n::String.from_gobl!(data['name']),
+          desc: data['desc'] ? GOBL::I18n::String.from_gobl!(data['desc']) : nil,
+          values: data['values']&.map { |item| RateValue.from_gobl!(item) }
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'key' => attributes[:key]&.to_gobl,
+          'name' => attributes[:name]&.to_gobl,
+          'desc' => attributes[:desc]&.to_gobl,
+          'values' => attributes[:values]&.map { |item| item&.to_gobl }
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Rate} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Rate] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/rate_total.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # RateTotal contains a sum of all the tax rates in the document with a matching category and rate.
+    class RateTotal < GOBL::Struct
+      # The Schema ID of the GOBL RateTotal structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotal'
+
+      # @!attribute [r] key
+      # @return [GOBL::Org::Key]
+      attribute? :key, GOBL::Org::Key.optional
+
+      # @!attribute [r] base
+      # @return [GOBL::Num::Amount]
+      attribute :base, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] percent
+      # @return [GOBL::Num::Percentage]
+      attribute :percent, GOBL::Types.Constructor(GOBL::Num::Percentage)
+
+      # @!attribute [r] amount
+      # Total amount of rate, excluding surcharges
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] surcharge
+      # @return [RateTotalSurcharge]
+      attribute? :surcharge, RateTotalSurcharge.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [RateTotal] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          key: data['key'] ? GOBL::Org::Key.from_gobl!(data['key']) : nil,
+          base: data['base'],
+          percent: data['percent'],
+          amount: data['amount'],
+          surcharge: data['surcharge'] ? RateTotalSurcharge.from_gobl!(data['surcharge']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'key' => attributes[:key]&.to_gobl,
+          'base' => attributes[:base]&.to_gobl,
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'surcharge' => attributes[:surcharge]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {RateTotal} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [RateTotal] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/tax/rate_total_surcharge.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Tax
+    # RateTotalSurcharge reflects the sum surcharges inside the rate.
+    class RateTotalSurcharge < GOBL::Struct
+      # The Schema ID of the GOBL RateTotalSurcharge structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotalSurcharge'
+
+      # @!attribute [r] percent
+      # @return [GOBL::Num::Percentage]
+      attribute :percent, GOBL::Types.Constructor(GOBL::Num::Percentage)
+
+      # @!attribute [r] amount
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [RateTotalSurcharge] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          percent: data['percent'],
+          amount: data['amount']
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {RateTotalSurcharge} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [RateTotalSurcharge] the object corresponding to the given input
+    end
+  end
+end