gobl 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391b7c41048a093675706f63dea56b6af72cf2210bf8c26c2f0003d1e2104199
-  data.tar.gz: c5e540e189fc75bdb9614ebf86b1a8acd2a7c26dededa0ec4bdab24c35d4ee3e
+  metadata.gz: e52ec878de6b32774a12c296cd33c914373d6af02f8aa60f02320876b124f47f
+  data.tar.gz: 8a610c8a3758bcd87d31d9062b46921ae56c91f834259430a3befab7f4c04551
 SHA512:
-  metadata.gz: 9c53b9655f57d77a985805932fc300b2bbef8448fe9405eb225573b0dc7f63ced83bc6687304604d21db07c6ec9c0c0a7007ef132c8f8d7991804402075fba09
-  data.tar.gz: 291df0d284de97f552d91831b43c9968dd4eea5be653c7efc883c2b1e0699b2e53048f3191501f63b6fe82fb87f40672e93baa12d627ec5b088fd54cb686c944
+  metadata.gz: 3d9feadf8a8233343c9a97103991ccd7bc9a9312c66f904dcaf29b60915de5dc73d604c2b11021a18ef11000b5c2d525c2af3c4f9d325fe8d882cf7c881d9169
+  data.tar.gz: 07a08ffd6bcc9a6fe5c8419d9869e8c1e046348b3226971dd38057d2728c704dd3e4e70a3d18335d4dd0a74c28db84264add27d888d9373ad0216249b13e9e56

data/lib/ext/hashme.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+raise 'The `hashme` library version has changed. Review if this extension still applies' if Hashme::VERSION != '0.2.6'
+
+# Temporary extensions for the `hashme` gem. To be removed when the library supports them.
+# @api private
+module Hashme
+  # Adds an URI helper class to the Hashme namespace so that properties referencing them
+  # typecast to URI objects in Ruby standard library.
+  class URI
+    def self.new(value)
+      URI(value)
+    end
+  end
+
+  # TrueClass typecasts to a boolean in Hashme. We alias it to `Boolean` for clarity
+  Boolean = TrueClass
+
+  class CastedArray
+    # Provides access to the whole Enumerable set of methods
+    include Enumerable
+
+    # Fixes equality between CastedArray objects
+    def ==(other)
+      @_array == other.to_a
+    end
+  end
+end

data/lib/gobl/bill/advances.rb

@@ -9,82 +9,6 @@
 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
+    Advances = [GOBL::Pay::Advance] # rubocop:disable Naming/ConstantName, Style/MutableConstant
   end
 end

data/lib/gobl/bill/charge.rb

@@ -9,113 +9,59 @@
 module GOBL
   module Bill
     # Charge represents a surchange applied to the complete document independent from the individual lines.
-    class Charge < GOBL::Struct
+    class Charge < GOBL::Object
       # 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
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] i
       # Line number inside the list of discounts (calculated).
       # @return [Integer]
-      attribute? :i, GOBL::Types::Int.optional
+      property :i, Integer
 
       # @!attribute [r] ref
       # Code to used to refer to the this charge
       # @return [String]
-      attribute? :ref, GOBL::Types::String.optional
+      property :ref, String
 
       # @!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
+      property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
       # Percentage to apply to the invoice's Sum
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] amount
       # Amount to apply (calculated if percent present)
       # @return [GOBL::Num::Amount]
-      attribute? :amount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :amount, GOBL::Num::Amount
 
       # @!attribute [r] taxes
       # List of taxes to apply to the charge
       # @return [GOBL::Tax::Set]
-      attribute? :taxes, GOBL::Tax::Set.optional
+      property :taxes, GOBL::Tax::Set
 
       # @!attribute [r] code
       # Code for why was this charge applied?
       # @return [String]
-      attribute? :code, GOBL::Types::String.optional
+      property :code, String
 
       # @!attribute [r] reason
       # Text description as to why the charge was applied
       # @return [String]
-      attribute? :reason, GOBL::Types::String.optional
+      property :reason, String
 
       # @!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
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/bill/delivery.rb

@@ -9,71 +9,29 @@
 module GOBL
   module Bill
     # Delivery covers the details of the destination for the products described in the invoice body.
-    class Delivery < GOBL::Struct
+    class Delivery < GOBL::Object
       # 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
+      property :receiver, GOBL::Org::Party
 
       # @!attribute [r] date
       # When the goods should be expected
       # @return [GOBL::Cal::Date]
-      attribute? :date, GOBL::Cal::Date.optional
+      property :date, GOBL::Cal::Date
 
       # @!attribute [r] start_date
       # Start of a n invoicing or delivery period
       # @return [GOBL::Cal::Date]
-      attribute? :start_date, GOBL::Cal::Date.optional
+      property :start_date, GOBL::Cal::Date
 
       # @!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
+      property :end_date, GOBL::Cal::Date
     end
   end
 end

data/lib/gobl/bill/discount.rb

@@ -9,113 +9,59 @@
 module GOBL
   module Bill
     # Discount represents an allowance applied to the complete document independent from the individual lines.
-    class Discount < GOBL::Struct
+    class Discount < GOBL::Object
       # 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
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] i
       # Line number inside the list of discounts (calculated)
       # @return [Integer]
-      attribute? :i, GOBL::Types::Int.optional
+      property :i, Integer
 
       # @!attribute [r] ref
       # Reference or ID for this Discount
       # @return [String]
-      attribute? :ref, GOBL::Types::String.optional
+      property :ref, String
 
       # @!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
+      property :base, GOBL::Num::Amount
 
       # @!attribute [r] percent
       # Percentage to apply to the invoice's Sum.
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] amount
       # Amount to apply (calculated if percent present).
       # @return [GOBL::Num::Amount]
-      attribute? :amount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :amount, GOBL::Num::Amount
 
       # @!attribute [r] taxes
       # List of taxes to apply to the discount
       # @return [GOBL::Tax::Set]
-      attribute? :taxes, GOBL::Tax::Set.optional
+      property :taxes, GOBL::Tax::Set
 
       # @!attribute [r] code
       # Code for the reason this discount applied
       # @return [String]
-      attribute? :code, GOBL::Types::String.optional
+      property :code, String
 
       # @!attribute [r] reason
       # Text description as to why the discount was applied
       # @return [String]
-      attribute? :reason, GOBL::Types::String.optional
+      property :reason, String
 
       # @!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
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/bill/exchange_rates.rb

@@ -9,82 +9,6 @@
 module GOBL
   module Bill
     # ExchangeRates represents an array of currency exchange rates.
-    class ExchangeRates < GOBL::Struct
-      extend Forwardable
-      include Enumerable
-
-      # The Schema ID of the GOBL ExchangeRates structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/ExchangeRates'
-
-      attribute :_ary, GOBL::Types::Array.of(GOBL::Currency::ExchangeRate)
-
-      # @!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::Currency::ExchangeRate] 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::Currency::ExchangeRate>] 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::Currency::ExchangeRate>] 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 [ExchangeRates] the object created from the given data
-      def self.from_gobl!(data)
-        new(_ary: data&.map { |item| GOBL::Currency::ExchangeRate.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 {ExchangeRates} object from a given array of structs. The array may
-      # contain {GOBL::Currency::ExchangeRate} objects or hashes. If hashes are provided, the constructor
-      # will call `GOBL::Currency::ExchangeRate#new` to generate the objects that will be part of the
-      # returned {ExchangeRates} object
-      #
-      # @param object [Array<GOBL::Currency::ExchangeRate, Hash>] the array containing the structs
-      #
-      # @return [ExchangeRates] 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
+    ExchangeRates = [GOBL::Currency::ExchangeRate] # rubocop:disable Naming/ConstantName, Style/MutableConstant
   end
 end