gobl 0.1.2

data/data/tax/FR.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://gobl.org/draft-0/tax/region",
+  "name": {
+    "en": "France",
+    "fr": "La France"
+  },
+  "country": "FR",
+  "currency": "EUR",
+  "categories": [
+    {
+      "code": "VAT",
+      "name": {
+        "en": "VAT",
+        "fr": "TVA"
+      },
+      "desc": {
+        "en": "Value Added Tax",
+        "fr": "Taxe sur la Valeur Ajoutée"
+      },
+      "rates": [
+        {
+          "key": "zero",
+          "name": {
+            "en": "Zero Rate"
+          },
+          "values": [
+            {
+              "percent": "0.0%"
+            }
+          ]
+        },
+        {
+          "key": "standard",
+          "name": {
+            "en": "Standard Rate"
+          },
+          "values": [
+            {
+              "since": "2011-01-04",
+              "percent": "20.0%"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/data/tax/GB.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://gobl.org/draft-0/tax/region",
+  "name": {
+    "en": "United Kingdom"
+  },
+  "country": "GB",
+  "currency": "GBP",
+  "categories": [
+    {
+      "code": "VAT",
+      "name": {
+        "en": "VAT"
+      },
+      "desc": {
+        "en": "Value Added Tax"
+      },
+      "rates": [
+        {
+          "key": "zero",
+          "name": {
+            "en": "Zero Rate"
+          },
+          "values": [
+            {
+              "percent": "0.0%"
+            }
+          ]
+        },
+        {
+          "key": "standard",
+          "name": {
+            "en": "Standard Rate"
+          },
+          "values": [
+            {
+              "since": "2011-01-04",
+              "percent": "20.0%"
+            }
+          ]
+        },
+        {
+          "key": "reduced",
+          "name": {
+            "en": "Reduced Rate"
+          },
+          "values": [
+            {
+              "since": "2011-01-04",
+              "percent": "5.0%"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/data/tax/NL.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://gobl.org/draft-0/tax/region",
+  "name": {
+    "en": "The Netherlands",
+    "nl": "Nederland"
+  },
+  "country": "NL",
+  "currency": "EUR",
+  "categories": [
+    {
+      "code": "VAT",
+      "name": {
+        "en": "VAT",
+        "nl": "BTW"
+      },
+      "desc": {
+        "en": "Value Added Tax",
+        "nl": "Belasting Toegevoegde Waarde"
+      },
+      "rates": [
+        {
+          "key": "zero",
+          "name": {
+            "en": "Zero Rate",
+            "nl": "0%-tarief"
+          },
+          "values": [
+            {
+              "percent": "0.0%"
+            }
+          ]
+        },
+        {
+          "key": "standard",
+          "name": {
+            "en": "Standard Rate",
+            "nl": "Standaardtarief"
+          },
+          "values": [
+            {
+              "percent": "21.0%"
+            }
+          ]
+        },
+        {
+          "key": "reduced",
+          "name": {
+            "en": "Reduced Rate",
+            "nl": "Gereduceerd Tarief"
+          },
+          "values": [
+            {
+              "percent": "9.0%"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/home/cavalle/workspace/invopop/gobl.ruby/gobl.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gobl/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'gobl'
+  spec.version = GOBL::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = 'Minimalist ruby version of the GOBL library'
+  spec.homepage = 'https://github.com/invopop/gobl.ruby'
+  spec.license = 'Apache-2.0'
+  spec.authors = ['David Lilue', 'Sam Lown', 'Juanjo Molinero']
+
+  spec.required_ruby_version = '>= 2.7'
+  spec.required_rubygems_version = '>= 3.1.4'
+
+  spec.files = Dir['lib/**/*', 'data/tax/**/*'] + [__FILE__]
+  spec.require_path = 'lib'
+
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.add_dependency('activesupport', '~> 6.1')
+  spec.add_dependency('dry-files', '~> 0.1.0')
+  spec.add_dependency('dry-struct', '~> 1.4.0')
+  spec.add_dependency('dry-types', '~> 1.5.1')
+  spec.add_dependency('json', '~> 2.6.1')
+  spec.add_dependency('zeitwerk', '~> 2.5.1')
+end

data/lib/extensions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Extensions are all defined here so they are auto-loaded by Zeitwerk.
+#
+# Both the instance and class method modules need to be included/extended explicitly here
+# to get YARD parsing them properly.
+
+GOBL::I18n::String.include GOBLExtensions::I18n::ValueKeysHelper
+GOBL::Document.include GOBLExtensions::DocumentHelper
+GOBL::Document.extend GOBLExtensions::DocumentHelper::ClassMethods
+GOBL::Envelope.include GOBLExtensions::EnvelopeHelper
+GOBL::Tax::Region.extend GOBLExtensions::Tax::RegionHelper::ClassMethods

data/lib/gobl/bill/advances.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 Bill
+    # Advances contains an array of advance objects.
+    class Advances < GOBL::Struct
+      extend Forwardable
+      include Enumerable
+
+      # The Schema ID of the GOBL Advances structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Advances'
+
+      attribute :_ary, GOBL::Types::Array.of(GOBL::Pay::Advance)
+
+      # @!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 [GOBL::Pay::Advance] 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<GOBL::Pay::Advance>] 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<GOBL::Pay::Advance>] 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 [Advances] the object created from the given data
+      def self.from_gobl!(data)
+        new(_ary: data&.map { |item| GOBL::Pay::Advance.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 {Advances} object from a given array of structs. The array may
+      # contain {GOBL::Pay::Advance} objects or hashes. If hashes are provided, the constructor
+      # will call `GOBL::Pay::Advance#new` to generate the objects that will be part of the
+      # returned {Advances} object
+      #
+      # @param object [Array<GOBL::Pay::Advance, Hash>] the array containing the structs
+      #
+      # @return [Advances] 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/bill/charge.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Charge represents a surchange applied to the complete document independent from the individual lines.
+    class Charge < GOBL::Struct
+      # The Schema ID of the GOBL Charge structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Charge'
+
+      # @!attribute [r] uuid
+      # Unique identifying for the discount entry
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] i
+      # Line number inside the list of discounts (calculated).
+      # @return [Integer]
+      attribute? :i, GOBL::Types::Int.optional
+
+      # @!attribute [r] ref
+      # Code to used to refer to the this charge
+      # @return [String]
+      attribute? :ref, GOBL::Types::String.optional
+
+      # @!attribute [r] base
+      # Base represents the value used as a base for percent calculations. If not already provided, we'll take the invoices sum before discounts.
+      # @return [GOBL::Num::Amount]
+      attribute? :base, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] percent
+      # Percentage to apply to the invoice's Sum
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] amount
+      # Amount to apply (calculated if percent present)
+      # @return [GOBL::Num::Amount]
+      attribute? :amount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] taxes
+      # List of taxes to apply to the charge
+      # @return [GOBL::Tax::Set]
+      attribute? :taxes, GOBL::Tax::Set.optional
+
+      # @!attribute [r] code
+      # Code for why was this charge applied?
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] reason
+      # Text description as to why the charge was applied
+      # @return [String]
+      attribute? :reason, GOBL::Types::String.optional
+
+      # @!attribute [r] meta
+      # Additional semi-structured 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 [Charge] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          i: data['i'],
+          ref: data['ref'],
+          base: data['base'] || nil,
+          percent: data['percent'] || nil,
+          amount: data['amount'] || nil,
+          taxes: data['taxes'] ? GOBL::Tax::Set.from_gobl!(data['taxes']) : nil,
+          code: data['code'],
+          reason: data['reason'],
+          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
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'i' => attributes[:i],
+          'ref' => attributes[:ref],
+          'base' => attributes[:base]&.to_gobl,
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'taxes' => attributes[:taxes]&.to_gobl,
+          'code' => attributes[:code],
+          'reason' => attributes[:reason],
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Charge} 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 [Charge] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/delivery.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 Bill
+    # Delivery covers the details of the destination for the products described in the invoice body.
+    class Delivery < GOBL::Struct
+      # The Schema ID of the GOBL Delivery structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Delivery'
+
+      # @!attribute [r] receiver
+      # The party who will receive delivery of the goods defined in the invoice and is not responsible for taxes.
+      # @return [GOBL::Org::Party]
+      attribute? :receiver, GOBL::Org::Party.optional
+
+      # @!attribute [r] date
+      # When the goods should be expected
+      # @return [GOBL::Cal::Date]
+      attribute? :date, GOBL::Cal::Date.optional
+
+      # @!attribute [r] start_date
+      # Start of a n invoicing or delivery period
+      # @return [GOBL::Cal::Date]
+      attribute? :start_date, GOBL::Cal::Date.optional
+
+      # @!attribute [r] end_date
+      # End of a n invoicing or delivery period
+      # @return [GOBL::Cal::Date]
+      attribute? :end_date, GOBL::Cal::Date.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Delivery] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          receiver: data['receiver'] ? GOBL::Org::Party.from_gobl!(data['receiver']) : nil,
+          date: data['date'] ? GOBL::Cal::Date.from_gobl!(data['date']) : nil,
+          start_date: data['start_date'] ? GOBL::Cal::Date.from_gobl!(data['start_date']) : nil,
+          end_date: data['end_date'] ? GOBL::Cal::Date.from_gobl!(data['end_date']) : 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
+        {
+          'receiver' => attributes[:receiver]&.to_gobl,
+          'date' => attributes[:date]&.to_gobl,
+          'start_date' => attributes[:start_date]&.to_gobl,
+          'end_date' => attributes[:end_date]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Delivery} 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 [Delivery] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/bill/discount.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Bill
+    # Discount represents an allowance applied to the complete document independent from the individual lines.
+    class Discount < GOBL::Struct
+      # The Schema ID of the GOBL Discount structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Discount'
+
+      # @!attribute [r] uuid
+      # Unique identifying for the discount entry
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] i
+      # Line number inside the list of discounts (calculated)
+      # @return [Integer]
+      attribute? :i, GOBL::Types::Int.optional
+
+      # @!attribute [r] ref
+      # Reference or ID for this Discount
+      # @return [String]
+      attribute? :ref, GOBL::Types::String.optional
+
+      # @!attribute [r] base
+      # Base represents the value used as a base for percent calculations. If not already provided, we'll take the invoices sum.
+      # @return [GOBL::Num::Amount]
+      attribute? :base, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] percent
+      # Percentage to apply to the invoice's Sum.
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] amount
+      # Amount to apply (calculated if percent present).
+      # @return [GOBL::Num::Amount]
+      attribute? :amount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+
+      # @!attribute [r] taxes
+      # List of taxes to apply to the discount
+      # @return [GOBL::Tax::Set]
+      attribute? :taxes, GOBL::Tax::Set.optional
+
+      # @!attribute [r] code
+      # Code for the reason this discount applied
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] reason
+      # Text description as to why the discount was applied
+      # @return [String]
+      attribute? :reason, GOBL::Types::String.optional
+
+      # @!attribute [r] meta
+      # Additional semi-structured 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 [Discount] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          i: data['i'],
+          ref: data['ref'],
+          base: data['base'] || nil,
+          percent: data['percent'] || nil,
+          amount: data['amount'] || nil,
+          taxes: data['taxes'] ? GOBL::Tax::Set.from_gobl!(data['taxes']) : nil,
+          code: data['code'],
+          reason: data['reason'],
+          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
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'i' => attributes[:i],
+          'ref' => attributes[:ref],
+          'base' => attributes[:base]&.to_gobl,
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'taxes' => attributes[:taxes]&.to_gobl,
+          'code' => attributes[:code],
+          'reason' => attributes[:reason],
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Discount} 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 [Discount] the object corresponding to the given input
+    end
+  end
+end