gobl 0.1.2

data/lib/gobl/bill/totals.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Totals contains the summaries of all calculations for the invoice.
+    class Totals < GOBL::Struct
+      # The Schema ID of the GOBL Totals structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Totals'
+
+      # @!attribute [r] sum
+      # Sum of all line item sums
+      # @return [GOBL::Num::Amount]
+      attribute :sum, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] discount
+      # Sum of all document level discounts
+      # @return [GOBL::Num::Amount]
+      attribute? :discount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] charge
+      # Sum of all document level charges
+      # @return [GOBL::Num::Amount]
+      attribute? :charge, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] tax_included
+      # If prices include tax, this is the total tax included in the price.
+      # @return [GOBL::Num::Amount]
+      attribute? :tax_included, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] total
+      # Sum of all line sums minus the discounts, plus the charges, without tax.
+      # @return [GOBL::Num::Amount]
+      attribute :total, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] taxes
+      # Summary of all the taxes included in the invoice.
+      # @return [GOBL::Tax::Total]
+      attribute? :taxes, GOBL::Tax::Total.optional
+
+      # @!attribute [r] tax
+      # Total amount of tax to apply to the invoice.
+      # @return [GOBL::Num::Amount]
+      attribute? :tax, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] total_with_tax
+      # Grand total after all taxes have been applied.
+      # @return [GOBL::Num::Amount]
+      attribute :total_with_tax, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] outlays
+      # Total paid in outlays that need to be reimbursed
+      # @return [GOBL::Num::Amount]
+      attribute? :outlays, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] payable
+      # Total amount to be paid after applying taxes and outlays.
+      # @return [GOBL::Num::Amount]
+      attribute :payable, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] advance
+      # Total amount already paid in advance.
+      # @return [GOBL::Num::Amount]
+      attribute? :advance, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] due
+      # How much actually needs to be paid now.
+      # @return [GOBL::Num::Amount]
+      attribute? :due, 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 [Totals] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          sum: data['sum'],
+          discount: data['discount'] || nil,
+          charge: data['charge'] || nil,
+          tax_included: data['tax_included'] || nil,
+          total: data['total'],
+          taxes: data['taxes'] ? GOBL::Tax::Total.from_gobl!(data['taxes']) : nil,
+          tax: data['tax'] || nil,
+          total_with_tax: data['total_with_tax'],
+          outlays: data['outlays'] || nil,
+          payable: data['payable'],
+          advance: data['advance'] || nil,
+          due: data['due'] || 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
+        {
+          'sum' => attributes[:sum]&.to_gobl,
+          'discount' => attributes[:discount]&.to_gobl,
+          'charge' => attributes[:charge]&.to_gobl,
+          'tax_included' => attributes[:tax_included]&.to_gobl,
+          'total' => attributes[:total]&.to_gobl,
+          'taxes' => attributes[:taxes]&.to_gobl,
+          'tax' => attributes[:tax]&.to_gobl,
+          'total_with_tax' => attributes[:total_with_tax]&.to_gobl,
+          'outlays' => attributes[:outlays]&.to_gobl,
+          'payable' => attributes[:payable]&.to_gobl,
+          'advance' => attributes[:advance]&.to_gobl,
+          'due' => attributes[:due]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Totals} 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 [Totals] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/cal/date.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Cal
+    # Civil date in simplified ISO format, like 2021-05-26
+    class Date < GOBL::Struct
+      # The Schema ID of the GOBL Date structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cal/date'
+
+      attribute :_value, GOBL::Types::String
+      private :_value
+
+      # Creates a new object from a GOBL value
+      #
+      # @param data [String] the GOBL value
+      #
+      # @return [Date] the object created from the given data
+      def self.from_gobl!(data)
+        new(_value: data)
+      end
+
+      # Returns a GOBL value representing the current object
+      #
+      # @return [String] the GOBL value that represents the current object
+      def to_gobl
+        _value
+      end
+
+      # Returns a {Date} that corresponds to a given object. The object can be a
+      # `Symbol`, a `String` or anything coercible into one (via `#to_s`).
+      #
+      # @param object [Symbol, String, #to_s] the value of the object.
+      #
+      # @return [Date] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   date = GOBL::Cal::Date.new(:value)
+      #
+      # @example Instantiating from a string
+      #   date = GOBL::Cal::Date.new('value')
+      def self.new(object)
+        case object
+        when Hash, self # internal use, not to be used in public calls
+          super
+        when Symbol
+          new object.to_s
+        else
+          super _value: object.to_s
+        end
+      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 object is equivalent to a given one. In addition
+      # to {Date} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [Date, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {Date} object
+      #   date = GOBL::Cal::Date.new('value')
+      #   date == GOBL::Cal::Date.new('value') #=> true
+      #   date == GOBL::Cal::Date.new('other') #=> false
+      #
+      # @example Comparing to a string
+      #   date = GOBL::Cal::Date.new('value')
+      #   date == 'value' #=> true
+      #   date == 'other' #=> false
+      #
+      # @example Comparing to a symbol
+      #   date = GOBL::Cal::Date.new('value')
+      #   date == :value #=> true
+      #   date == :other #=> false
+      def ==(other)
+        case other
+        when self.class
+          super
+        when Symbol
+          to_sym == other
+        else
+          to_s == other.to_s
+        end
+      end
+    end
+  end
+end

data/lib/gobl/cal/period.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 Cal
+    # Period represents two dates with a start and finish.
+    class Period < GOBL::Struct
+      # The Schema ID of the GOBL Period structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/cal/period'
+
+      # @!attribute [r] start
+      # @return [GOBL::Cal::Date]
+      attribute :start, GOBL::Cal::Date
+
+      # @!attribute [r] end
+      # @return [GOBL::Cal::Date]
+      attribute :end, GOBL::Cal::Date
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Period] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          start: GOBL::Cal::Date.from_gobl!(data['start']),
+          end: GOBL::Cal::Date.from_gobl!(data['end'])
+        )
+      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
+        {
+          'start' => attributes[:start]&.to_gobl,
+          'end' => attributes[:end]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Period} 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 [Period] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GOBL
+  # Provides accessors to the library's configuration settings
+  class Config
+    # The host of the GOBL CLI service to use by {GOBL::Operations}
+    # @return [String] the backend service's host
+    attr_accessor :service_host
+
+    # The port of the GOBL CLI service to use by {GOBL::Operations}
+    # @return [String, Integer] the backend service's port
+    attr_accessor :service_port
+  end
+end

data/lib/gobl/currency/code.rb

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Currency
+    # ISO Currency Code
+    class Code < GOBL::Struct
+      # The Schema ID of the GOBL Code structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/currency/code'
+
+      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
+      ENUM = {
+        'AED' => 'UAE Dirham',
+        'AFN' => 'Afghani',
+        'ALL' => 'Lek',
+        'AMD' => 'Armenian Dram',
+        'ANG' => 'Netherlands Antillean Guilder',
+        'AOA' => 'Kwanza',
+        'ARS' => 'Argentine Peso',
+        'AUD' => 'Australian Dollar',
+        'AWG' => 'Aruban Florin',
+        'AZN' => 'Azerbaijan Manat',
+        'BAM' => 'Convertible Mark',
+        'BBD' => 'Barbados Dollar',
+        'BDT' => 'Taka',
+        'BGN' => 'Bulgarian Lev',
+        'BHD' => 'Bahraini Dinar',
+        'BIF' => 'Burundi Franc',
+        'BMD' => 'Bermudian Dollar',
+        'BND' => 'Brunei Dollar',
+        'BOB' => 'Boliviano',
+        'BOV' => 'Mvdol',
+        'BRL' => 'Brazilian Real',
+        'BSD' => 'Bahamian Dollar',
+        'BTN' => 'Ngultrum',
+        'BWP' => 'Pula',
+        'BYN' => 'Belarusian Ruble',
+        'BZD' => 'Belize Dollar',
+        'CAD' => 'Canadian Dollar',
+        'CDF' => 'Congolese Franc',
+        'CHE' => 'WIR Euro',
+        'CHF' => 'Swiss Franc',
+        'CHW' => 'WIR Franc',
+        'CLF' => 'Unidad de Fomento',
+        'CLP' => 'Chilean Peso',
+        'CNY' => 'Yuan Renminbi',
+        'COP' => 'Colombian Peso',
+        'COU' => 'Unidad de Valor Real',
+        'CRC' => 'Costa Rican Colon',
+        'CUC' => 'Peso Convertible',
+        'CUP' => 'Cuban Peso',
+        'CVE' => 'Cabo Verde Escudo',
+        'CZK' => 'Czech Koruna',
+        'DJF' => 'Djibouti Franc',
+        'DKK' => 'Danish Krone',
+        'DOP' => 'Dominican Peso',
+        'DZD' => 'Algerian Dinar',
+        'EGP' => 'Egyptian Pound',
+        'ERN' => 'Nakfa',
+        'ETB' => 'Ethiopian Birr',
+        'EUR' => 'Euro',
+        'FJD' => 'Fiji Dollar',
+        'FKP' => 'Falkland Islands Pound',
+        'GBP' => 'Pound Sterling',
+        'GEL' => 'Lari',
+        'GHS' => 'Ghana Cedi',
+        'GIP' => 'Gibraltar Pound',
+        'GMD' => 'Dalasi',
+        'GNF' => 'Guinean Franc',
+        'GTQ' => 'Quetzal',
+        'GYD' => 'Guyana Dollar',
+        'HKD' => 'Hong Kong Dollar',
+        'HNL' => 'Lempira',
+        'HRK' => 'Kuna',
+        'HTG' => 'Gourde',
+        'HUF' => 'Forint',
+        'IDR' => 'Rupiah',
+        'ILS' => 'New Israeli Sheqel',
+        'INR' => 'Indian Rupee',
+        'IQD' => 'Iraqi Dinar',
+        'IRR' => 'Iranian Rial',
+        'ISK' => 'Iceland Krona',
+        'JMD' => 'Jamaican Dollar',
+        'JOD' => 'Jordanian Dinar',
+        'JPY' => 'Yen',
+        'KES' => 'Kenyan Shilling',
+        'KGS' => 'Som',
+        'KHR' => 'Riel',
+        'KMF' => 'Comorian Franc ',
+        'KPW' => 'North Korean Won',
+        'KRW' => 'Won',
+        'KWD' => 'Kuwaiti Dinar',
+        'KYD' => 'Cayman Islands Dollar',
+        'KZT' => 'Tenge',
+        'LAK' => 'Lao Kip',
+        'LBP' => 'Lebanese Pound',
+        'LKR' => 'Sri Lanka Rupee',
+        'LRD' => 'Liberian Dollar',
+        'LSL' => 'Loti',
+        'LYD' => 'Libyan Dinar',
+        'MAD' => 'Moroccan Dirham',
+        'MDL' => 'Moldovan Leu',
+        'MGA' => 'Malagasy Ariary',
+        'MKD' => 'Denar',
+        'MMK' => 'Kyat',
+        'MNT' => 'Tugrik',
+        'MOP' => 'Pataca',
+        'MRU' => 'Ouguiya',
+        'MUR' => 'Mauritius Rupee',
+        'MVR' => 'Rufiyaa',
+        'MWK' => 'Malawi Kwacha',
+        'MXN' => 'Mexican Peso',
+        'MXV' => 'Mexican Unidad de Inversion (UDI)',
+        'MYR' => 'Malaysian Ringgit',
+        'MZN' => 'Mozambique Metical',
+        'NAD' => 'Namibia Dollar',
+        'NGN' => 'Naira',
+        'NIO' => 'Cordoba Oro',
+        'NOK' => 'Norwegian Krone',
+        'NPR' => 'Nepalese Rupee',
+        'NZD' => 'New Zealand Dollar',
+        'OMR' => 'Rial Omani',
+        'PAB' => 'Balboa',
+        'PEN' => 'Sol',
+        'PGK' => 'Kina',
+        'PHP' => 'Philippine Peso',
+        'PKR' => 'Pakistan Rupee',
+        'PLN' => 'Zloty',
+        'PYG' => 'Guarani',
+        'QAR' => 'Qatari Rial',
+        'RON' => 'Romanian Leu',
+        'RSD' => 'Serbian Dinar',
+        'RUB' => 'Russian Ruble',
+        'RWF' => 'Rwanda Franc',
+        'SAR' => 'Saudi Riyal',
+        'SBD' => 'Solomon Islands Dollar',
+        'SCR' => 'Seychelles Rupee',
+        'SDG' => 'Sudanese Pound',
+        'SEK' => 'Swedish Krona',
+        'SGD' => 'Singapore Dollar',
+        'SHP' => 'Saint Helena Pound',
+        'SLL' => 'Leone',
+        'SOS' => 'Somali Shilling',
+        'SRD' => 'Surinam Dollar',
+        'SSP' => 'South Sudanese Pound',
+        'STN' => 'Dobra',
+        'SVC' => 'El Salvador Colon',
+        'SYP' => 'Syrian Pound',
+        'SZL' => 'Lilangeni',
+        'THB' => 'Baht',
+        'TJS' => 'Somoni',
+        'TMT' => 'Turkmenistan New Manat',
+        'TND' => 'Tunisian Dinar',
+        'TOP' => 'Pa’anga',
+        'TRY' => 'Turkish Lira',
+        'TTD' => 'Trinidad and Tobago Dollar',
+        'TWD' => 'New Taiwan Dollar',
+        'TZS' => 'Tanzanian Shilling',
+        'UAH' => 'Hryvnia',
+        'UGX' => 'Uganda Shilling',
+        'USD' => 'US Dollar',
+        'USN' => 'US Dollar (Next day)',
+        'UYI' => 'Uruguay Peso en Unidades Indexadas (UI)',
+        'UYU' => 'Peso Uruguayo',
+        'UYW' => 'Unidad Previsional',
+        'UZS' => 'Uzbekistan Sum',
+        'VES' => 'Bolívar Soberano',
+        'VND' => 'Dong',
+        'VUV' => 'Vatu',
+        'WST' => 'Tala',
+        'XAF' => 'CFA Franc BEAC',
+        'XCD' => 'East Caribbean Dollar',
+        'XOF' => 'CFA Franc BCEAO',
+        'XPF' => 'CFP Franc',
+        'YER' => 'Yemeni Rial',
+        'ZAR' => 'Rand',
+        'ZMW' => 'Zambian Kwacha',
+        'ZWL' => 'Zimbabwe Dollar'
+      }.freeze
+
+      attribute :_value, GOBL::Types::String.enum(*ENUM.keys)
+      private :_value
+
+      # Creates a new object from a GOBL value
+      #
+      # @param data [String] the GOBL value
+      #
+      # @return [Code] the object created from the given data
+      def self.from_gobl!(data)
+        new(_value: data)
+      end
+
+      # Returns a GOBL value representing the current object
+      #
+      # @return [String] the GOBL value that represents the current object
+      def to_gobl
+        _value
+      end
+
+      # Returns a {Code} that corresponds to a given object. The object can be a
+      # `Symbol`, a `String` or anything coercible into one (via `#to_s`).
+      #
+      # @param object [Symbol, String, #to_s] the value of the object.
+      #
+      # @return [Code] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   code = GOBL::Currency::Code.new(:aed)
+      #
+      # @example Instantiating from a string
+      #   code = GOBL::Currency::Code.new('AED')
+      def self.new(object)
+        case object
+        when Hash, self # internal use, not to be used in public calls
+          super
+        when Symbol
+          new find_by_sym(object)
+        else
+          super _value: object.to_s
+        end
+      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 object is equivalent to a given one. In addition
+      # to {Code} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [Code, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {Code} object
+      #   code = GOBL::Currency::Code.new('AED')
+      #   code == GOBL::Currency::Code.new('AED') #=> true
+      #   code == GOBL::Currency::Code.new('AFN') #=> false
+      #
+      # @example Comparing to a string
+      #   code = GOBL::Currency::Code.new('AED')
+      #   code == 'AED' #=> true
+      #   code == 'AFN' #=> false
+      #
+      # @example Comparing to a symbol
+      #   code = GOBL::Currency::Code.new('AED')
+      #   code == :aed #=> true
+      #   code == :afn #=> false
+      def ==(other)
+        case other
+        when self.class
+          super
+        when Symbol
+          to_sym == other
+        else
+          to_s == other.to_s
+        end
+      end
+
+      # Returns an array with all the enumerated objects of this type
+      #
+      # @return [Array<Code>] the array of enumerated objects
+      def self.all
+        ENUM.keys.map { |key| new(key) }
+      end
+
+      # @api private
+      def self.find_by_sym(sym)
+        all.find { |object| object.to_sym == sym }
+      end
+
+      # @api private
+      def self.find_by_inquirer(method_name)
+        method_name =~ /(.+)\?$/ && find_by_sym(Regexp.last_match(1).to_sym)
+      end
+
+      # Returns the description of the current object
+      #
+      # @return [String] the description of the current object
+      def description
+        ENUM.fetch(_value, _value)
+      end
+
+      # @api private
+      def respond_to_missing?(method_name, include_private = false)
+        self.class.find_by_inquirer(method_name) || super
+      end
+
+      # Enables dynamic value inquirers like `Code#aed?` for
+      # each of the declared enum values (see {ENUM}). Each inquirer returns a
+      # `Boolean` denoting whether the value equals the enquired value (`true`) or
+      # not (`false`)
+      #
+      # @example
+      #   code = GOBL::Currency::Code.new('AED')
+      #   code.aed? # => true
+      #   code.afn? # => false
+      def method_missing(method_name, *args, &block)
+        if value = self.class.find_by_inquirer(method_name)
+          self == value
+        else
+          super
+        end
+      end
+    end
+  end
+end