gobl 0.1.3 → 0.3.0

data/lib/gobl/bill/invoice_type.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Bill
     # Defines an invoice type according to a subset of the UNTDID 1001 standard list.
-    class InvoiceType < GOBL::Struct
+    class InvoiceType < GOBL::Enum
       # The Schema ID of the GOBL InvoiceType structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/InvoiceType'
 
@@ -24,139 +24,8 @@ module GOBL
         'self-billed' => 'Self billed invoice'
       }.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 [InvoiceType] 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 {InvoiceType} 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 [InvoiceType] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   invoice_type = GOBL::Bill::InvoiceType.new(:proforma)
-      #
-      # @example Instantiating from a string
-      #   invoice_type = GOBL::Bill::InvoiceType.new('proforma')
-      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 {InvoiceType} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [InvoiceType, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {InvoiceType} object
-      #   invoice_type = GOBL::Bill::InvoiceType.new('proforma')
-      #   invoice_type == GOBL::Bill::InvoiceType.new('proforma') #=> true
-      #   invoice_type == GOBL::Bill::InvoiceType.new('simplified') #=> false
-      #
-      # @example Comparing to a string
-      #   invoice_type = GOBL::Bill::InvoiceType.new('proforma')
-      #   invoice_type == 'proforma' #=> true
-      #   invoice_type == 'simplified' #=> false
-      #
-      # @example Comparing to a symbol
-      #   invoice_type = GOBL::Bill::InvoiceType.new('proforma')
-      #   invoice_type == :proforma #=> true
-      #   invoice_type == :simplified #=> 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<InvoiceType>] 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 `InvoiceType#proforma?` 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
-      #   invoice_type = GOBL::Bill::InvoiceType.new('proforma')
-      #   invoice_type.proforma? # => true
-      #   invoice_type.simplified? # => false
-      def method_missing(method_name, *args, &block)
-        if value = self.class.find_by_inquirer(method_name)
-          self == value
-        else
-          super
-        end
+      def strict_enum?
+        true
       end
     end
   end

data/lib/gobl/bill/line.rb

@@ -9,113 +9,61 @@
 module GOBL
   module Bill
     # Line is a single row in an invoice.
-    class Line < GOBL::Struct
+    class Line < GOBL::Object
       # The Schema ID of the GOBL Line structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Line'
 
       # @!attribute [r] uuid
       # Unique identifier for this line
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] i
       # Line number inside the parent (calculated)
       # @return [Integer]
-      attribute? :i, GOBL::Types::Int.optional
+      property :i, Integer
 
       # @!attribute [r] quantity
       # Number of items
       # @return [GOBL::Num::Amount]
-      attribute :quantity, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :quantity, GOBL::Num::Amount
+      validates :quantity, presence: true
 
       # @!attribute [r] item
       # Details about what is being sold
       # @return [GOBL::Org::Item]
-      attribute :item, GOBL::Org::Item
+      property :item, GOBL::Org::Item
+      validates :item, presence: true
 
       # @!attribute [r] sum
       # Result of quantity multiplied by the item's price (calculated)
       # @return [GOBL::Num::Amount]
-      attribute? :sum, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :sum, GOBL::Num::Amount
 
       # @!attribute [r] discounts
       # Discounts applied to this line
       # @return [Array<LineDiscount>]
-      attribute? :discounts, GOBL::Types::Array.of(LineDiscount).optional
+      property :discounts, [LineDiscount]
 
       # @!attribute [r] charges
       # Charges applied to this line
       # @return [Array<LineCharge>]
-      attribute? :charges, GOBL::Types::Array.of(LineCharge).optional
+      property :charges, [LineCharge]
 
       # @!attribute [r] taxes
       # Map of taxes to be applied and used in the invoice totals
       # @return [GOBL::Tax::Set]
-      attribute? :taxes, GOBL::Tax::Set.optional
+      property :taxes, GOBL::Tax::Set
 
       # @!attribute [r] total
       # Total line amount after applying discounts to the sum (calculated).
       # @return [GOBL::Num::Amount]
-      attribute? :total, GOBL::Types.Constructor(GOBL::Num::Amount).optional
+      property :total, GOBL::Num::Amount
 
       # @!attribute [r] notes
       # Set of specific notes for this line that may be required for clarification.
       # @return [Array<GOBL::Org::Note>]
-      attribute? :notes, GOBL::Types::Array.of(GOBL::Org::Note).optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Line] 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'],
-          quantity: data['quantity'],
-          item: GOBL::Org::Item.from_gobl!(data['item']),
-          sum: data['sum'] || nil,
-          discounts: data['discounts']&.map { |item| LineDiscount.from_gobl!(item) },
-          charges: data['charges']&.map { |item| LineCharge.from_gobl!(item) },
-          taxes: data['taxes'] ? GOBL::Tax::Set.from_gobl!(data['taxes']) : nil,
-          total: data['total'] || nil,
-          notes: data['notes']&.map { |item| GOBL::Org::Note.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
-        {
-          'uuid' => attributes[:uuid]&.to_gobl,
-          'i' => attributes[:i],
-          'quantity' => attributes[:quantity]&.to_gobl,
-          'item' => attributes[:item]&.to_gobl,
-          'sum' => attributes[:sum]&.to_gobl,
-          'discounts' => attributes[:discounts]&.map { |item| item&.to_gobl },
-          'charges' => attributes[:charges]&.map { |item| item&.to_gobl },
-          'taxes' => attributes[:taxes]&.to_gobl,
-          'total' => attributes[:total]&.to_gobl,
-          'notes' => attributes[:notes]&.map { |item| item&.to_gobl }
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Line} 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 [Line] the object corresponding to the given input
+      property :notes, [GOBL::Org::Note]
     end
   end
 end

data/lib/gobl/bill/line_charge.rb

@@ -9,71 +9,29 @@
 module GOBL
   module Bill
     # LineCharge represents an amount added to the line, and will be applied before taxes.
-    class LineCharge < GOBL::Struct
+    class LineCharge < GOBL::Object
       # The Schema ID of the GOBL LineCharge structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/LineCharge'
 
       # @!attribute [r] percent
       # Percentage if fixed amount not applied
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] amount
       # Fixed or resulting charge 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] code
       # Reference code.
       # @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
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [LineCharge] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          percent: data['percent'] || nil,
-          amount: data['amount'] || nil,
-          code: data['code'],
-          reason: data['reason']
-        )
-      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,
-          'code' => attributes[:code],
-          'reason' => attributes[:reason]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {LineCharge} 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 [LineCharge] the object corresponding to the given input
+      property :reason, String
     end
   end
 end

data/lib/gobl/bill/line_discount.rb

@@ -9,71 +9,29 @@
 module GOBL
   module Bill
     # LineDiscount represents an amount deducted from the line, and will be applied before taxes.
-    class LineDiscount < GOBL::Struct
+    class LineDiscount < GOBL::Object
       # The Schema ID of the GOBL LineDiscount structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/LineDiscount'
 
       # @!attribute [r] percent
       # Percentage if fixed amount not applied
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] amount
       # Fixed discount 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] code
       # Reason code.
       # @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
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [LineDiscount] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          percent: data['percent'] || nil,
-          amount: data['amount'] || nil,
-          code: data['code'],
-          reason: data['reason']
-        )
-      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,
-          'code' => attributes[:code],
-          'reason' => attributes[:reason]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {LineDiscount} 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 [LineDiscount] the object corresponding to the given input
+      property :reason, String
     end
   end
 end

data/lib/gobl/bill/ordering.rb

@@ -9,50 +9,14 @@
 module GOBL
   module Bill
     # Ordering allows additional order details to be appended
-    class Ordering < GOBL::Struct
+    class Ordering < GOBL::Object
       # The Schema ID of the GOBL Ordering structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Ordering'
 
       # @!attribute [r] seller
       # Party who is selling the goods and is not responsible for taxes
       # @return [GOBL::Org::Party]
-      attribute? :seller, GOBL::Org::Party.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Ordering] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          seller: data['seller'] ? GOBL::Org::Party.from_gobl!(data['seller']) : 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
-        {
-          'seller' => attributes[:seller]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Ordering} 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 [Ordering] the object corresponding to the given input
+      property :seller, GOBL::Org::Party
     end
   end
 end

data/lib/gobl/bill/outlay.rb

@@ -9,99 +9,51 @@
 module GOBL
   module Bill
     # Outlay represents a reimbursable expense that was paid for by the supplier and invoiced separately by the third party directly to the customer.
-    class Outlay < GOBL::Struct
+    class Outlay < GOBL::Object
       # The Schema ID of the GOBL Outlay structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Outlay'
 
       # @!attribute [r] uuid
       # Unique identity for this outlay.
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] i
       # Outlay number index inside the invoice for ordering (calculated).
       # @return [Integer]
-      attribute? :i, GOBL::Types::Int.optional
+      property :i, Integer
 
       # @!attribute [r] date
       # When was the outlay made.
       # @return [GOBL::Cal::Date]
-      attribute? :date, GOBL::Cal::Date.optional
+      property :date, GOBL::Cal::Date
 
       # @!attribute [r] code
       # Invoice number or other reference detail used to identify the outlay.
       # @return [String]
-      attribute? :code, GOBL::Types::String.optional
+      property :code, String
 
       # @!attribute [r] series
       # Series of the outlay invoice.
       # @return [String]
-      attribute? :series, GOBL::Types::String.optional
+      property :series, String
 
       # @!attribute [r] desc
       # Details on what the outlay was.
       # @return [String]
-      attribute :desc, GOBL::Types::String
+      property :desc, String
+      validates :desc, presence: true
 
       # @!attribute [r] supplier
       # Who was the supplier of the outlay
       # @return [GOBL::Org::Party]
-      attribute? :supplier, GOBL::Org::Party.optional
+      property :supplier, GOBL::Org::Party
 
       # @!attribute [r] amount
       # Amount paid by the supplier.
       # @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 [Outlay] 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'],
-          date: data['date'] ? GOBL::Cal::Date.from_gobl!(data['date']) : nil,
-          code: data['code'],
-          series: data['series'],
-          desc: data['desc'],
-          supplier: data['supplier'] ? GOBL::Org::Party.from_gobl!(data['supplier']) : nil,
-          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
-        {
-          'uuid' => attributes[:uuid]&.to_gobl,
-          'i' => attributes[:i],
-          'date' => attributes[:date]&.to_gobl,
-          'code' => attributes[:code],
-          'series' => attributes[:series],
-          'desc' => attributes[:desc],
-          'supplier' => attributes[:supplier]&.to_gobl,
-          'amount' => attributes[:amount]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Outlay} 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 [Outlay] the object corresponding to the given input
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
     end
   end
 end

data/lib/gobl/bill/payment.rb

@@ -9,71 +9,29 @@
 module GOBL
   module Bill
     # Payment contains details as to how the invoice should be paid.
-    class Payment < GOBL::Struct
+    class Payment < GOBL::Object
       # The Schema ID of the GOBL Payment structure
       SCHEMA_ID = 'https://gobl.org/draft-0/bill/invoice#/$defs/Payment'
 
       # @!attribute [r] payer
       # The party responsible for paying for the invoice, if not the customer.
       # @return [GOBL::Org::Party]
-      attribute? :payer, GOBL::Org::Party.optional
+      property :payer, GOBL::Org::Party
 
       # @!attribute [r] terms
       # Payment terms or conditions.
       # @return [GOBL::Pay::Terms]
-      attribute? :terms, GOBL::Pay::Terms.optional
+      property :terms, GOBL::Pay::Terms
 
       # @!attribute [r] advances
       # Any amounts that have been paid in advance and should be deducted from the amount due.
       # @return [Advances]
-      attribute? :advances, Advances.optional
+      property :advances, Advances
 
       # @!attribute [r] instructions
       # Details on how payment should be made.
       # @return [GOBL::Pay::Instructions]
-      attribute? :instructions, GOBL::Pay::Instructions.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Payment] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          payer: data['payer'] ? GOBL::Org::Party.from_gobl!(data['payer']) : nil,
-          terms: data['terms'] ? GOBL::Pay::Terms.from_gobl!(data['terms']) : nil,
-          advances: data['advances'] ? Advances.from_gobl!(data['advances']) : nil,
-          instructions: data['instructions'] ? GOBL::Pay::Instructions.from_gobl!(data['instructions']) : 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
-        {
-          'payer' => attributes[:payer]&.to_gobl,
-          'terms' => attributes[:terms]&.to_gobl,
-          'advances' => attributes[:advances]&.to_gobl,
-          'instructions' => attributes[:instructions]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Payment} 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 [Payment] the object corresponding to the given input
+      property :instructions, GOBL::Pay::Instructions
     end
   end
 end