gobl 0.1.3 → 0.3.0

data/lib/gobl/bill/preceding.rb

@@ -9,106 +9,56 @@
 module GOBL
   module Bill
     # Preceding allows for information to be provided about a previous invoice that this one will replace or subtract from.
-    class Preceding < GOBL::Struct
+    class Preceding < GOBL::Object
       # The Schema ID of the GOBL Preceding structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Preceding'
 
       # @!attribute [r] uuid
       # Preceding document's UUID if available can be useful for tracing.
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] code
       # Identity code of the previous invoice.
       # @return [String]
-      attribute :code, GOBL::Types::String
+      property :code, String
+      validates :code, presence: true
 
       # @!attribute [r] series
       # Additional identification details
       # @return [String]
-      attribute? :series, GOBL::Types::String.optional
+      property :series, String
 
       # @!attribute [r] issue_date
       # When the preceding invoice was issued.
       # @return [GOBL::Cal::Date]
-      attribute :issue_date, GOBL::Cal::Date
+      property :issue_date, GOBL::Cal::Date
+      validates :issue_date, presence: true
 
       # @!attribute [r] period
       # Tax period in which the previous invoice has an effect.
       # @return [GOBL::Cal::Period]
-      attribute? :period, GOBL::Cal::Period.optional
+      property :period, GOBL::Cal::Period
 
       # @!attribute [r] corrections
       # Specific codes for the corrections made.
       # @return [Array<String>]
-      attribute? :corrections, GOBL::Types::Array.of(GOBL::Types::String).optional
+      property :corrections, [String]
 
       # @!attribute [r] correction_method
       # How has the previous invoice been corrected?
       # @return [String]
-      attribute? :correction_method, GOBL::Types::String.optional
+      property :correction_method, String
 
       # @!attribute [r] notes
       # Additional details regarding preceding invoice
       # @return [String]
-      attribute? :notes, GOBL::Types::String.optional
+      property :notes, String
 
       # @!attribute [r] meta
       # Additional semi-structured data that may be useful in specific regions
       # @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 [Preceding] 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,
-          code: data['code'],
-          series: data['series'],
-          issue_date: GOBL::Cal::Date.from_gobl!(data['issue_date']),
-          period: data['period'] ? GOBL::Cal::Period.from_gobl!(data['period']) : nil,
-          corrections: data['corrections']&.map { |item| item },
-          correction_method: data['correction_method'],
-          notes: data['notes'],
-          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,
-          'code' => attributes[:code],
-          'series' => attributes[:series],
-          'issue_date' => attributes[:issue_date]&.to_gobl,
-          'period' => attributes[:period]&.to_gobl,
-          'corrections' => attributes[:corrections]&.map { |item| item },
-          'correction_method' => attributes[:correction_method],
-          'notes' => attributes[:notes],
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Preceding} 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 [Preceding] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/bill/scheme_keys.rb

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

data/lib/gobl/bill/tax.rb

@@ -9,64 +9,24 @@
 module GOBL
   module Bill
     # Tax defines a summary of the taxes which may be applied to an invoice.
-    class Tax < GOBL::Struct
+    class Tax < GOBL::Object
       # The Schema ID of the GOBL Tax structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Tax'
 
       # @!attribute [r] prices_include
       # Category of the tax already included in the line item prices, especially useful for B2C retailers with customers who prefer final prices inclusive of tax.
       # @return [GOBL::Org::Code]
-      attribute? :prices_include, GOBL::Org::Code.optional
+      property :prices_include, GOBL::Org::Code
 
       # @!attribute [r] schemes
       # Special tax schemes that apply to this invoice according to local requirements.
       # @return [SchemeKeys]
-      attribute? :schemes, SchemeKeys.optional
+      property :schemes, SchemeKeys
 
       # @!attribute [r] meta
       # Any additional data that may be required for processing, but should never be relied upon by recipients.
       # @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 [Tax] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          prices_include: data['prices_include'] ? GOBL::Org::Code.from_gobl!(data['prices_include']) : nil,
-          schemes: data['schemes'] ? SchemeKeys.from_gobl!(data['schemes']) : nil,
-          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
-        {
-          'prices_include' => attributes[:prices_include]&.to_gobl,
-          'schemes' => attributes[:schemes]&.to_gobl,
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Tax} 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 [Tax] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/bill/totals.rb

@@ -9,127 +9,73 @@
 module GOBL
   module Bill
     # Totals contains the summaries of all calculations for the invoice.
-    class Totals < GOBL::Struct
+    class Totals < GOBL::Object
       # 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)
+      property :sum, GOBL::Num::Amount
+      validates :sum, presence: true
 
       # @!attribute [r] discount
       # Sum of all document level discounts
       # @return [GOBL::Num::Amount]
-      attribute? :discount, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :discount, GOBL::Num::Amount
 
       # @!attribute [r] charge
       # Sum of all document level charges
       # @return [GOBL::Num::Amount]
-      attribute? :charge, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :charge, GOBL::Num::Amount
 
       # @!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
+      property :tax_included, GOBL::Num::Amount
 
       # @!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)
+      property :total, GOBL::Num::Amount
+      validates :total, presence: true
 
       # @!attribute [r] taxes
       # Summary of all the taxes included in the invoice.
       # @return [GOBL::Tax::Total]
-      attribute? :taxes, GOBL::Tax::Total.optional
+      property :taxes, GOBL::Tax::Total
 
       # @!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
+      property :tax, GOBL::Num::Amount
 
       # @!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)
+      property :total_with_tax, GOBL::Num::Amount
+      validates :total_with_tax, presence: true
 
       # @!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
+      property :outlays, GOBL::Num::Amount
 
       # @!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)
+      property :payable, GOBL::Num::Amount
+      validates :payable, presence: true
 
       # @!attribute [r] advance
       # Total amount already paid in advance.
       # @return [GOBL::Num::Amount]
-      attribute? :advance, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :advance, GOBL::Num::Amount
 
       # @!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
+      property :due, GOBL::Num::Amount
     end
   end
 end

data/lib/gobl/cal/date.rb

@@ -9,98 +9,9 @@
 module GOBL
   module Cal
     # Civil date in simplified ISO format, like 2021-05-26
-    class Date < GOBL::Struct
+    class Date < GOBL::Value
       # 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

@@ -9,55 +9,19 @@
 module GOBL
   module Cal
     # Period represents two dates with a start and finish.
-    class Period < GOBL::Struct
+    class Period < GOBL::Object
       # 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
+      property :start, GOBL::Cal::Date
+      validates :start, presence: true
 
       # @!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
+      property :end, GOBL::Cal::Date
+      validates :end, presence: true
     end
   end
 end