gobl 0.1.3 → 0.3.0

data/lib/gobl/org/unit.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Org
     # Unit describes how the quantity of the product should be interpreted.
-    class Unit < GOBL::Struct
+    class Unit < GOBL::Enum
       # The Schema ID of the GOBL Unit structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/unit'
 
@@ -64,141 +64,6 @@ module GOBL
         'sheet' => 'Sheets',
         'envelope' => 'Envelopes'
       }.freeze
-
-      attribute :_value, GOBL::Types::String
-      private :_value
-
-      # Creates a new object from a GOBL value
-      #
-      # @param data [String] the GOBL value
-      #
-      # @return [Unit] 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 {Unit} 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 [Unit] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   unit = GOBL::Org::Unit.new(:g)
-      #
-      # @example Instantiating from a string
-      #   unit = GOBL::Org::Unit.new('g')
-      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) || 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 {Unit} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [Unit, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {Unit} object
-      #   unit = GOBL::Org::Unit.new('g')
-      #   unit == GOBL::Org::Unit.new('g') #=> true
-      #   unit == GOBL::Org::Unit.new('kg') #=> false
-      #
-      # @example Comparing to a string
-      #   unit = GOBL::Org::Unit.new('g')
-      #   unit == 'g' #=> true
-      #   unit == 'kg' #=> false
-      #
-      # @example Comparing to a symbol
-      #   unit = GOBL::Org::Unit.new('g')
-      #   unit == :g #=> true
-      #   unit == :kg #=> 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<Unit>] 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 `Unit#g?` 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
-      #   unit = GOBL::Org::Unit.new('g')
-      #   unit.g? # => true
-      #   unit.kg? # => 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

data/lib/gobl/pay/advance.rb

@@ -9,99 +9,51 @@
 module GOBL
   module Pay
     # Advance represents a single payment that has been made already, such as a deposit on an intent to purchase, or as credit from a previous invoice which was later corrected or cancelled.
-    class Advance < GOBL::Struct
+    class Advance < GOBL::Object
       # The Schema ID of the GOBL Advance structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/advance'
 
       # @!attribute [r] uuid
       # Unique identifier for this advance.
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] date
       # When the advance was made.
       # @return [GOBL::Cal::Date]
-      attribute? :date, GOBL::Cal::Date.optional
+      property :date, GOBL::Cal::Date
 
       # @!attribute [r] ref
       # ID or reference for the advance.
       # @return [String]
-      attribute? :ref, GOBL::Types::String.optional
+      property :ref, String
 
       # @!attribute [r] grant
       # If this "advance" payment has come from a public grant or subsidy, set this to true.
       # @return [Boolean]
-      attribute? :grant, GOBL::Types::Bool.optional
+      property :grant, Boolean
 
       # @!attribute [r] desc
       # Details about the advance.
       # @return [String]
-      attribute :desc, GOBL::Types::String
+      property :desc, String
+      validates :desc, presence: true
 
       # @!attribute [r] percent
       # How much as a percentage of the total with tax was paid
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] amount
       # How much was paid.
       # @return [GOBL::Num::Amount]
-      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
 
       # @!attribute [r] currency
       # If different from the parent document's base currency.
       # @return [GOBL::Currency::Code]
-      attribute? :currency, GOBL::Currency::Code.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Advance] 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,
-          date: data['date'] ? GOBL::Cal::Date.from_gobl!(data['date']) : nil,
-          ref: data['ref'],
-          grant: data['grant'],
-          desc: data['desc'],
-          percent: data['percent'] || nil,
-          amount: data['amount'],
-          currency: data['currency'] ? GOBL::Currency::Code.from_gobl!(data['currency']) : 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,
-          'date' => attributes[:date]&.to_gobl,
-          'ref' => attributes[:ref],
-          'grant' => attributes[:grant],
-          'desc' => attributes[:desc],
-          'percent' => attributes[:percent]&.to_gobl,
-          'amount' => attributes[:amount]&.to_gobl,
-          'currency' => attributes[:currency]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Advance} 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 [Advance] the object corresponding to the given input
+      property :currency, GOBL::Currency::Code
     end
   end
 end

data/lib/gobl/pay/card.rb

@@ -9,57 +9,21 @@
 module GOBL
   module Pay
     # Card contains simplified card holder data as a reference for the customer.
-    class Card < GOBL::Struct
+    class Card < GOBL::Object
       # The Schema ID of the GOBL Card structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/Card'
 
       # @!attribute [r] last4
       # Last 4 digits of the card's Primary Account Number (PAN).
       # @return [String]
-      attribute :last4, GOBL::Types::String
+      property :last4, String
+      validates :last4, presence: true
 
       # @!attribute [r] holder
       # Name of the person whom the card belongs to.
       # @return [String]
-      attribute :holder, GOBL::Types::String
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Card] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          last4: data['last4'],
-          holder: data['holder']
-        )
-      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
-        {
-          'last4' => attributes[:last4],
-          'holder' => attributes[:holder]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Card} 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 [Card] the object corresponding to the given input
+      property :holder, String
+      validates :holder, presence: true
     end
   end
 end

data/lib/gobl/pay/credit_transfer.rb

@@ -9,78 +9,34 @@
 module GOBL
   module Pay
     # CreditTransfer contains fields that can be used for making payments via a bank transfer or wire.
-    class CreditTransfer < GOBL::Struct
+    class CreditTransfer < GOBL::Object
       # The Schema ID of the GOBL CreditTransfer structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/CreditTransfer'
 
       # @!attribute [r] iban
       # International Bank Account Number
       # @return [String]
-      attribute? :iban, GOBL::Types::String.optional
+      property :iban, String
 
       # @!attribute [r] bic
       # Bank Identifier Code used for international transfers.
       # @return [String]
-      attribute? :bic, GOBL::Types::String.optional
+      property :bic, String
 
       # @!attribute [r] number
       # Account number, if IBAN not available.
       # @return [String]
-      attribute? :number, GOBL::Types::String.optional
+      property :number, String
 
       # @!attribute [r] name
       # Name of the bank.
       # @return [String]
-      attribute? :name, GOBL::Types::String.optional
+      property :name, String
 
       # @!attribute [r] branch
       # Bank office branch address, not normally required.
       # @return [GOBL::Org::Address]
-      attribute? :branch, GOBL::Org::Address.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [CreditTransfer] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          iban: data['iban'],
-          bic: data['bic'],
-          number: data['number'],
-          name: data['name'],
-          branch: data['branch'] ? GOBL::Org::Address.from_gobl!(data['branch']) : 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
-        {
-          'iban' => attributes[:iban],
-          'bic' => attributes[:bic],
-          'number' => attributes[:number],
-          'name' => attributes[:name],
-          'branch' => attributes[:branch]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {CreditTransfer} 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 [CreditTransfer] the object corresponding to the given input
+      property :branch, GOBL::Org::Address
     end
   end
 end

data/lib/gobl/pay/direct_debit.rb

@@ -9,64 +9,24 @@
 module GOBL
   module Pay
     # DirectDebit defines the data that will be used to make the direct debit.
-    class DirectDebit < GOBL::Struct
+    class DirectDebit < GOBL::Object
       # The Schema ID of the GOBL DirectDebit structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/DirectDebit'
 
       # @!attribute [r] ref
       # Unique identifier assigned by the payee for referencing the direct debit.
       # @return [String]
-      attribute? :ref, GOBL::Types::String.optional
+      property :ref, String
 
       # @!attribute [r] creditor
       # Unique banking reference that identifies the payee or seller assigned by the bank.
       # @return [String]
-      attribute? :creditor, GOBL::Types::String.optional
+      property :creditor, String
 
       # @!attribute [r] account
       # Account identifier to be debited by the direct debit.
       # @return [String]
-      attribute? :account, GOBL::Types::String.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [DirectDebit] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          ref: data['ref'],
-          creditor: data['creditor'],
-          account: data['account']
-        )
-      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
-        {
-          'ref' => attributes[:ref],
-          'creditor' => attributes[:creditor],
-          'account' => attributes[:account]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {DirectDebit} 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 [DirectDebit] the object corresponding to the given input
+      property :account, String
     end
   end
 end

data/lib/gobl/pay/due_date.rb

@@ -9,78 +9,36 @@
 module GOBL
   module Pay
     # DueDate contains an amount that should be paid by the given date.
-    class DueDate < GOBL::Struct
+    class DueDate < GOBL::Object
       # The Schema ID of the GOBL DueDate structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/terms#/$defs/DueDate'
 
       # @!attribute [r] date
       # When the payment is due.
       # @return [GOBL::Cal::Date]
-      attribute :date, GOBL::Cal::Date
+      property :date, GOBL::Cal::Date
+      validates :date, presence: true
 
       # @!attribute [r] notes
       # Other details to take into account for the due date.
       # @return [String]
-      attribute? :notes, GOBL::Types::String.optional
+      property :notes, String
 
       # @!attribute [r] amount
       # How much needs to be paid by the date.
       # @return [GOBL::Num::Amount]
-      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
 
       # @!attribute [r] percent
       # Percentage of the total that should be paid by the date.
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] currency
       # If different from the parent document's base currency.
       # @return [GOBL::Currency::Code]
-      attribute? :currency, GOBL::Currency::Code.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [DueDate] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          date: GOBL::Cal::Date.from_gobl!(data['date']),
-          notes: data['notes'],
-          amount: data['amount'],
-          percent: data['percent'] || nil,
-          currency: data['currency'] ? GOBL::Currency::Code.from_gobl!(data['currency']) : 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
-        {
-          'date' => attributes[:date]&.to_gobl,
-          'notes' => attributes[:notes],
-          'amount' => attributes[:amount]&.to_gobl,
-          'percent' => attributes[:percent]&.to_gobl,
-          'currency' => attributes[:currency]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {DueDate} 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 [DueDate] the object corresponding to the given input
+      property :currency, GOBL::Currency::Code
     end
   end
 end

data/lib/gobl/pay/instructions.rb

@@ -9,106 +9,55 @@
 module GOBL
   module Pay
     # Instructions holds a set of instructions that determine how the payment has or should be made.
-    class Instructions < GOBL::Struct
+    class Instructions < GOBL::Object
       # The Schema ID of the GOBL Instructions structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions'
 
       # @!attribute [r] key
       # How payment is expected or has been arranged to be collected
       # @return [MethodKey]
-      attribute :key, MethodKey
+      property :key, MethodKey
+      validates :key, presence: true
 
       # @!attribute [r] detail
       # Optional text description of the payment method
       # @return [String]
-      attribute? :detail, GOBL::Types::String.optional
+      property :detail, String
 
       # @!attribute [r] ref
       # Remittance information, a text value used to link the payment with the invoice.
       # @return [String]
-      attribute? :ref, GOBL::Types::String.optional
+      property :ref, String
 
       # @!attribute [r] credit_transfer
       # Instructions for sending payment via a bank transfer.
       # @return [Array<CreditTransfer>]
-      attribute? :credit_transfer, GOBL::Types::Array.of(CreditTransfer).optional
+      property :credit_transfer, [CreditTransfer]
 
       # @!attribute [r] card
       # Details of the payment that will be made via a credit or debit card.
       # @return [Card]
-      attribute? :card, Card.optional
+      property :card, Card
 
       # @!attribute [r] direct_debit
       # A group of terms that can be used by the customer or payer to consolidate direct debit payments.
       # @return [DirectDebit]
-      attribute? :direct_debit, DirectDebit.optional
+      property :direct_debit, DirectDebit
 
       # @!attribute [r] online
       # Array of online payment options
       # @return [Array<Online>]
-      attribute? :online, GOBL::Types::Array.of(Online).optional
+      property :online, [Online]
 
       # @!attribute [r] notes
       # Any additional instructions that may be required to make the payment.
       # @return [String]
-      attribute? :notes, GOBL::Types::String.optional
+      property :notes, String
 
       # @!attribute [r] meta
       # Non-structured additional data that may be useful.
       # @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 [Instructions] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          key: MethodKey.from_gobl!(data['key']),
-          detail: data['detail'],
-          ref: data['ref'],
-          credit_transfer: data['credit_transfer']&.map { |item| CreditTransfer.from_gobl!(item) },
-          card: data['card'] ? Card.from_gobl!(data['card']) : nil,
-          direct_debit: data['direct_debit'] ? DirectDebit.from_gobl!(data['direct_debit']) : nil,
-          online: data['online']&.map { |item| Online.from_gobl!(item) },
-          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
-        {
-          'key' => attributes[:key]&.to_gobl,
-          'detail' => attributes[:detail],
-          'ref' => attributes[:ref],
-          'credit_transfer' => attributes[:credit_transfer]&.map { |item| item&.to_gobl },
-          'card' => attributes[:card]&.to_gobl,
-          'direct_debit' => attributes[:direct_debit]&.to_gobl,
-          'online' => attributes[:online]&.map { |item| item&.to_gobl },
-          'notes' => attributes[:notes],
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Instructions} 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 [Instructions] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end