gobl 0.1.3 → 0.2.0

data/lib/gobl/pay/method_key.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Pay
     # Method Key describes how a payment should be made
-    class MethodKey < GOBL::Struct
+    class MethodKey < GOBL::Enum
       # The Schema ID of the GOBL MethodKey structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/MethodKey'
 
@@ -24,139 +24,8 @@ module GOBL
         'online' => 'Online or web payment'
       }.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 [MethodKey] 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 {MethodKey} 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 [MethodKey] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   method_key = GOBL::Pay::MethodKey.new(:any)
-      #
-      # @example Instantiating from a string
-      #   method_key = GOBL::Pay::MethodKey.new('any')
-      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 {MethodKey} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [MethodKey, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {MethodKey} object
-      #   method_key = GOBL::Pay::MethodKey.new('any')
-      #   method_key == GOBL::Pay::MethodKey.new('any') #=> true
-      #   method_key == GOBL::Pay::MethodKey.new('card') #=> false
-      #
-      # @example Comparing to a string
-      #   method_key = GOBL::Pay::MethodKey.new('any')
-      #   method_key == 'any' #=> true
-      #   method_key == 'card' #=> false
-      #
-      # @example Comparing to a symbol
-      #   method_key = GOBL::Pay::MethodKey.new('any')
-      #   method_key == :any #=> true
-      #   method_key == :card #=> 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<MethodKey>] 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 `MethodKey#any?` 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
-      #   method_key = GOBL::Pay::MethodKey.new('any')
-      #   method_key.any? # => true
-      #   method_key.card? # => 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/pay/online.rb

@@ -9,57 +9,20 @@
 module GOBL
   module Pay
     # Online provides the details required to make a payment online using a website
-    class Online < GOBL::Struct
+    class Online < GOBL::Object
       # The Schema ID of the GOBL Online structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/Online'
 
       # @!attribute [r] name
       # Descriptive name given to the online provider.
       # @return [String]
-      attribute? :name, GOBL::Types::String.optional
+      property :name, String
 
       # @!attribute [r] addr
       # Full URL to be used for payment.
       # @return [String]
-      attribute :addr, GOBL::Types::String
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Online] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          name: data['name'],
-          addr: data['addr']
-        )
-      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
-        {
-          'name' => attributes[:name],
-          'addr' => attributes[:addr]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Online} 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 [Online] the object corresponding to the given input
+      property :addr, String
+      validates :addr, presence: true
     end
   end
 end

data/lib/gobl/pay/term_key.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Pay
     # Payment terms key
-    class TermKey < GOBL::Struct
+    class TermKey < GOBL::Enum
       # The Schema ID of the GOBL TermKey structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/terms#/$defs/TermKey'
 
@@ -27,139 +27,8 @@ module GOBL
         'delivery' => 'Payment on Delivery'
       }.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 [TermKey] 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 {TermKey} 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 [TermKey] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   term_key = GOBL::Pay::TermKey.new(:)
-      #
-      # @example Instantiating from a string
-      #   term_key = GOBL::Pay::TermKey.new('')
-      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 {TermKey} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [TermKey, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {TermKey} object
-      #   term_key = GOBL::Pay::TermKey.new('')
-      #   term_key == GOBL::Pay::TermKey.new('') #=> true
-      #   term_key == GOBL::Pay::TermKey.new('end-of-month') #=> false
-      #
-      # @example Comparing to a string
-      #   term_key = GOBL::Pay::TermKey.new('')
-      #   term_key == '' #=> true
-      #   term_key == 'end-of-month' #=> false
-      #
-      # @example Comparing to a symbol
-      #   term_key = GOBL::Pay::TermKey.new('')
-      #   term_key == : #=> true
-      #   term_key == :end_of_month #=> 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<TermKey>] 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 `TermKey#?` 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
-      #   term_key = GOBL::Pay::TermKey.new('')
-      #   term_key.? # => true
-      #   term_key.end_of_month? # => 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/pay/terms.rb

@@ -9,71 +9,30 @@
 module GOBL
   module Pay
     # Terms defines when we expect the customer to pay, or have paid, for the contents of the document.
-    class Terms < GOBL::Struct
+    class Terms < GOBL::Object
       # The Schema ID of the GOBL Terms structure
       SCHEMA_ID = 'https://gobl.org/draft-0/pay/terms'
 
       # @!attribute [r] key
       # Type of terms to be applied.
       # @return [TermKey]
-      attribute :key, TermKey
+      property :key, TermKey
+      validates :key, presence: true
 
       # @!attribute [r] detail
       # Text detail of the chosen payment terms.
       # @return [String]
-      attribute? :detail, GOBL::Types::String.optional
+      property :detail, String
 
       # @!attribute [r] due_dates
       # Set of dates for agreed payments.
       # @return [Array<DueDate>]
-      attribute? :due_dates, GOBL::Types::Array.of(DueDate).optional
+      property :due_dates, [DueDate]
 
       # @!attribute [r] notes
       # Description of the conditions for payment.
       # @return [String]
-      attribute? :notes, GOBL::Types::String.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Terms] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          key: TermKey.from_gobl!(data['key']),
-          detail: data['detail'],
-          due_dates: data['due_dates']&.map { |item| DueDate.from_gobl!(item) },
-          notes: data['notes']
-        )
-      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],
-          'due_dates' => attributes[:due_dates]&.map { |item| item&.to_gobl },
-          'notes' => attributes[:notes]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Terms} 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 [Terms] the object corresponding to the given input
+      property :notes, String
     end
   end
 end

data/lib/gobl/stamp.rb

@@ -8,56 +8,20 @@
 
 module GOBL
   # Stamp defines an official seal of approval from a third party like a governmental agency or intermediary and should thus be included in any official envelopes.
-  class Stamp < GOBL::Struct
+  class Stamp < GOBL::Object
     # The Schema ID of the GOBL Stamp structure
     SCHEMA_ID = 'https://gobl.org/draft-0/envelope#/$defs/Stamp'
 
     # @!attribute [r] prv
     # Identity of the agency used to create the stamp usually defined by each region.
     # @return [GOBL::Org::Key]
-    attribute :prv, GOBL::Org::Key
+    property :prv, GOBL::Org::Key
+    validates :prv, presence: true
 
     # @!attribute [r] val
     # The serialized stamp value generated for or by the external agency
     # @return [String]
-    attribute :val, GOBL::Types::String
-
-    # Creates a new object from a hash of GOBL data
-    #
-    # @param data [Hash] a hash of GOBL data
-    #
-    # @return [Stamp] the object created from the given data
-    def self.from_gobl!(data)
-      data = GOBL::Types::Hash[data]
-
-      new(
-        prv: GOBL::Org::Key.from_gobl!(data['prv']),
-        val: data['val']
-      )
-    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
-      {
-        'prv' => attributes[:prv]&.to_gobl,
-        'val' => attributes[:val]
-      }.compact
-    end
-
-    # @!method self.new(attrs)
-    #
-    #   Returns a {Stamp} 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 [Stamp] the object corresponding to the given input
+    property :val, String
+    validates :val, presence: true
   end
 end

data/lib/gobl/struct.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
 
 module GOBL
-  # Base class for any GOBL structure
-  class Struct < Dry::Struct
+  # Base class for any structure present in the GOBL Schema
+  class Struct
     # Returns a new GOBL struct from a hash of GOBL data. The type of the returned struct
     # is determined from the `$schema` attribute.
     #
-    # This method is usually overwritten at sub-class level, where the `$schema` attribute
-    # isn't necessary since the type is determined by the sub-class itself.
-    #
     # @param data [Hash] the hash of GOBL data
     #
     # @return [GOBL::Struct] the created GOBL struct
-    def self.from_gobl!(data)
+    def self.from_data(data)
       raise ArgumentError, 'Schema not present in the given data' unless data&.key?('$schema')
 
       schema = GOBL::ID.new(data['$schema'])
@@ -21,9 +18,9 @@ module GOBL
       # being an envelope is considered to be a document as these are the only two structures
       # that are required to specify its schema.
       if schema.name == 'envelope'
-        GOBL::Envelope.from_gobl! data
+        GOBL::Envelope.new data
       else
-        GOBL::Document.from_gobl! data
+        GOBL::Document.new data
       end
     end
 
@@ -33,16 +30,19 @@ module GOBL
     #
     # @return [GOBL::Struct] the deserialized GOBL struct
     def self.from_json!(json)
-      from_gobl!(JSON.parse(json))
+      new JSON.parse(json)
     end
 
-    # Serializes a GOBL struct into a JSON string
-    #
-    # @param options [#to_h] a Hash-like object to pass to `JSON.generate`
+    # Serializes the current GOBL struct into a JSON string
     #
-    # @return [GOBL::Struct] the JSON string representing the GOBL struct
-    def to_json(options = nil)
-      JSON.generate(to_gobl, options)
+    # @return [String] the JSON string representing the struct
+    def to_json(...)
+      as_json.to_json(...)
+    end
+
+    # @api private
+    def as_json
+      raise NotImplementedError, 'Subclasses are expected to overload'
     end
   end
 end

data/lib/gobl/tax/category.rb

@@ -9,75 +9,34 @@
 module GOBL
   module Tax
     # Category contains the definition of a general type of tax inside a region.
-    class Category < GOBL::Struct
+    class Category < GOBL::Object
       # The Schema ID of the GOBL Category structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Category'
 
       # @!attribute [r] code
       # @return [GOBL::Org::Code]
-      attribute :code, GOBL::Org::Code
+      property :code, GOBL::Org::Code
+      validates :code, presence: true
 
       # @!attribute [r] name
       # @return [GOBL::I18n::String]
-      attribute :name, GOBL::I18n::String
+      property :name, GOBL::I18n::String
+      validates :name, presence: true
 
       # @!attribute [r] desc
       # @return [GOBL::I18n::String]
-      attribute? :desc, GOBL::I18n::String.optional
+      property :desc, GOBL::I18n::String
 
       # @!attribute [r] retained
       # Retained when true implies that the tax amount will be retained by the buyer on behalf of the supplier, and thus subtracted from the invoice taxable base total. Typically used for taxes related to income.
       # @return [Boolean]
-      attribute? :retained, GOBL::Types::Bool.optional
+      property :retained, Boolean
 
       # @!attribute [r] rates
       # Specific tax definitions inside this category.
       # @return [Array<Rate>]
-      attribute :rates, GOBL::Types::Array.of(Rate)
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Category] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          code: GOBL::Org::Code.from_gobl!(data['code']),
-          name: GOBL::I18n::String.from_gobl!(data['name']),
-          desc: data['desc'] ? GOBL::I18n::String.from_gobl!(data['desc']) : nil,
-          retained: data['retained'],
-          rates: data['rates']&.map { |item| Rate.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
-        {
-          'code' => attributes[:code]&.to_gobl,
-          'name' => attributes[:name]&.to_gobl,
-          'desc' => attributes[:desc]&.to_gobl,
-          'retained' => attributes[:retained],
-          'rates' => attributes[:rates]&.map { |item| item&.to_gobl }
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Category} 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 [Category] the object corresponding to the given input
+      property :rates, [Rate]
+      validates :rates, presence: true
     end
   end
 end