gobl 0.1.3 → 0.2.0

data/lib/gobl/envelope.rb

@@ -8,70 +8,31 @@
 
 module GOBL
   # Envelope wraps around a gobl document and provides support for digest creation and digital signatures.
-  class Envelope < GOBL::Struct
+  class Envelope < GOBL::Object
     # The Schema ID of the GOBL Envelope structure
     SCHEMA_ID = 'https://gobl.org/draft-0/envelope'
 
-    # @!attribute [r] schema
+    # @!attribute [r] $schema
     # Schema identifies the schema that should be used to understand this document
     # @return [String]
-    attribute :schema, GOBL::Types::String
+    property :$schema, String
+    validates :$schema, presence: true
 
     # @!attribute [r] head
     # Details on what the contents are
     # @return [Header]
-    attribute :head, Header
+    property :head, Header
+    validates :head, presence: true
 
     # @!attribute [r] doc
     # The data inside the envelope
     # @return [Document]
-    attribute :doc, Document
+    property :doc, Document
+    validates :doc, presence: true
 
     # @!attribute [r] sigs
     # JSON Web Signatures of the header
     # @return [Array<GOBL::DSig::Signature>]
-    attribute? :sigs, GOBL::Types::Array.of(GOBL::DSig::Signature).optional
-
-    # Creates a new object from a hash of GOBL data
-    #
-    # @param data [Hash] a hash of GOBL data
-    #
-    # @return [Envelope] the object created from the given data
-    def self.from_gobl!(data)
-      data = GOBL::Types::Hash[data]
-
-      new(
-        schema: data['$schema'],
-        head: Header.from_gobl!(data['head']),
-        doc: Document.from_gobl!(data['doc']),
-        sigs: data['sigs']&.map { |item| GOBL::DSig::Signature.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
-      {
-        '$schema' => attributes[:schema],
-        'head' => attributes[:head]&.to_gobl,
-        'doc' => attributes[:doc]&.to_gobl,
-        'sigs' => attributes[:sigs]&.map { |item| item&.to_gobl }
-      }.compact
-    end
-
-    # @!method self.new(attrs)
-    #
-    #   Returns a {Envelope} 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 [Envelope] the object corresponding to the given input
+    property :sigs, [GOBL::DSig::Signature]
   end
 end

data/lib/gobl/header.rb

@@ -8,91 +8,45 @@
 
 module GOBL
   # Header defines the meta data of the body.
-  class Header < GOBL::Struct
+  class Header < GOBL::Object
     # The Schema ID of the GOBL Header structure
     SCHEMA_ID = 'https://gobl.org/draft-0/envelope#/$defs/Header'
 
     # @!attribute [r] uuid
     # Unique UUIDv1 identifier for the envelope.
     # @return [GOBL::UUID::UUID]
-    attribute :uuid, GOBL::UUID::UUID
+    property :uuid, GOBL::UUID::UUID
+    validates :uuid, presence: true
 
     # @!attribute [r] dig
     # Digest of the canonical JSON body.
     # @return [GOBL::DSig::Digest]
-    attribute :dig, GOBL::DSig::Digest
+    property :dig, GOBL::DSig::Digest
+    validates :dig, presence: true
 
     # @!attribute [r] stamps
     # Seals of approval from other organisations.
     # @return [Array<Stamp>]
-    attribute? :stamps, GOBL::Types::Array.of(Stamp).optional
+    property :stamps, [Stamp]
 
     # @!attribute [r] tags
     # Set of labels that describe but have no influence on the data.
     # @return [Array<String>]
-    attribute? :tags, GOBL::Types::Array.of(GOBL::Types::String).optional
+    property :tags, [String]
 
     # @!attribute [r] meta
     # Additional semi-structured information about this envelope.
     # @return [GOBL::Org::Meta]
-    attribute? :meta, GOBL::Org::Meta.optional
+    property :meta, GOBL::Org::Meta
 
     # @!attribute [r] notes
     # Any information that may be relevant to other humans about this envelope
     # @return [String]
-    attribute? :notes, GOBL::Types::String.optional
+    property :notes, String
 
     # @!attribute [r] draft
     # When true, implies that this document should not be considered final. Digital signatures are optional.
     # @return [Boolean]
-    attribute? :draft, GOBL::Types::Bool.optional
-
-    # Creates a new object from a hash of GOBL data
-    #
-    # @param data [Hash] a hash of GOBL data
-    #
-    # @return [Header] the object created from the given data
-    def self.from_gobl!(data)
-      data = GOBL::Types::Hash[data]
-
-      new(
-        uuid: GOBL::UUID::UUID.from_gobl!(data['uuid']),
-        dig: GOBL::DSig::Digest.from_gobl!(data['dig']),
-        stamps: data['stamps']&.map { |item| Stamp.from_gobl!(item) },
-        tags: data['tags']&.map { |item| item },
-        meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil,
-        notes: data['notes'],
-        draft: data['draft']
-      )
-    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,
-        'dig' => attributes[:dig]&.to_gobl,
-        'stamps' => attributes[:stamps]&.map { |item| item&.to_gobl },
-        'tags' => attributes[:tags]&.map { |item| item },
-        'meta' => attributes[:meta]&.to_gobl,
-        'notes' => attributes[:notes],
-        'draft' => attributes[:draft]
-      }.compact
-    end
-
-    # @!method self.new(attrs)
-    #
-    #   Returns a {Header} 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 [Header] the object corresponding to the given input
+    property :draft, Boolean
   end
 end

data/lib/gobl/i18n/string.rb

@@ -9,64 +9,7 @@
 module GOBL
   module I18n
     # Map of 2-Letter language codes to their translations.
-    class String < GOBL::Struct
-      extend Forwardable
-      include Enumerable
-
-      # The Schema ID of the GOBL String structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/i18n/string'
-
-      attribute :_value, GOBL::Types::Hash
-
-      # @!method [](key)
-      #   Returns the value associated with the given key
-      #   @param key [Object] the key
-      #   @return [Object] the value associated with the given key
-      #
-      # @!method each
-      #   Iterates over each key-value pair in the map
-      #   @overload each(&block)
-      #     Calls the given block with each key-value pair in the map
-      #     @yield [key, value] a key-value pair of the map
-      #     @return [self] the object itself
-      #   @overload each
-      #     Returns an Enumerator that iterates over the key-value pairs in the map
-      #     @return [Enumerator] the enumerator of the key-value pairs
-      #
-      # @!method empty?
-      #   Returns `true` if the number of entires in the map is zero, `false` otherwise.
-      #   @return [Boolean] whether the map is empty or not
-      #
-      # @!method length
-      #   Returns the number of entries in the map
-      #   @return [Integer] the number of entries in the map
-      #
-      # @!method each_key
-      #   Iterates over each key in the map
-      #   @overload each(&block)
-      #     Calls the given block with each key in the map
-      #     @yield [key] a key of the map
-      #     @return [self] the object itself
-      #   @overload each
-      #     Returns an Enumerator that iterates over the keys in the map
-      #     @return [Enumerator] the enumerator of the keys
-      def_delegators :_value, :[], :each, :empty?, :length, :each_key
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [String] the object created from the given data
-      def self.from_gobl!(data)
-        new(_value: data)
-      end
-
-      # Returns a hash of GOBL data representing the current object
-      #
-      # @return [Hash] the hash of GOBL data that represents the current object
-      def to_gobl
-        _value
-      end
+    class String < GOBL::Map
     end
   end
 end

data/lib/gobl/l10n/code.rb

@@ -9,98 +9,9 @@
 module GOBL
   module L10n
     # Code is used for short identifies like country or state codes.
-    class Code < GOBL::Struct
+    class Code < GOBL::Value
       # The Schema ID of the GOBL Code structure
       SCHEMA_ID = 'https://gobl.org/draft-0/l10n/code'
-
-      attribute :_value, GOBL::Types::String
-      private :_value
-
-      # Creates a new object from a GOBL value
-      #
-      # @param data [String] the GOBL value
-      #
-      # @return [Code] 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 {Code} 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 [Code] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   code = GOBL::L10n::Code.new(:value)
-      #
-      # @example Instantiating from a string
-      #   code = GOBL::L10n::Code.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 {Code} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [Code, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {Code} object
-      #   code = GOBL::L10n::Code.new('value')
-      #   code == GOBL::L10n::Code.new('value') #=> true
-      #   code == GOBL::L10n::Code.new('other') #=> false
-      #
-      # @example Comparing to a string
-      #   code = GOBL::L10n::Code.new('value')
-      #   code == 'value' #=> true
-      #   code == 'other' #=> false
-      #
-      # @example Comparing to a symbol
-      #   code = GOBL::L10n::Code.new('value')
-      #   code == :value #=> true
-      #   code == :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/l10n/country_code.rb

@@ -9,7 +9,7 @@
 module GOBL
   module L10n
     # Defines an ISO 3166-2 country code
-    class CountryCode < GOBL::Struct
+    class CountryCode < GOBL::Enum
       # The Schema ID of the GOBL CountryCode structure
       SCHEMA_ID = 'https://gobl.org/draft-0/l10n/country-code'
 
@@ -266,139 +266,8 @@ module GOBL
         'ZW' => 'Zimbabwe'
       }.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 [CountryCode] 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 {CountryCode} 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 [CountryCode] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   country_code = GOBL::L10n::CountryCode.new(:af)
-      #
-      # @example Instantiating from a string
-      #   country_code = GOBL::L10n::CountryCode.new('AF')
-      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 {CountryCode} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [CountryCode, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {CountryCode} object
-      #   country_code = GOBL::L10n::CountryCode.new('AF')
-      #   country_code == GOBL::L10n::CountryCode.new('AF') #=> true
-      #   country_code == GOBL::L10n::CountryCode.new('AX') #=> false
-      #
-      # @example Comparing to a string
-      #   country_code = GOBL::L10n::CountryCode.new('AF')
-      #   country_code == 'AF' #=> true
-      #   country_code == 'AX' #=> false
-      #
-      # @example Comparing to a symbol
-      #   country_code = GOBL::L10n::CountryCode.new('AF')
-      #   country_code == :af #=> true
-      #   country_code == :ax #=> 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<CountryCode>] 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 `CountryCode#af?` 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
-      #   country_code = GOBL::L10n::CountryCode.new('AF')
-      #   country_code.af? # => true
-      #   country_code.ax? # => 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/map.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module GOBL
+  # Base class for map structures in the GOBL Schema. A map is an unconstrained list of
+  # keys and values
+  class Map < Struct
+    extend Forwardable
+    include Enumerable
+
+    # @api private
+    attr_accessor :_map
+
+    # Initializes a new map struct that corresponds to a given Hash
+    #
+    # @param map [Hash] the hash with the map data
+    #
+    # @return [Map] a new map object
+    def initialize(map)
+      super()
+      self._map = map
+    end
+
+    # @api private
+    def as_json(...)
+      _map.as_json(...)
+    end
+
+    # @!method [](key)
+    #   Returns the value associated with the given key
+    #   @param key [Object] the key
+    #   @return [Object] the value associated with the given key
+    #
+    # @!method each
+    #   Iterates over each key-value pair in the map
+    #   @overload each(&block)
+    #     Calls the given block with each key-value pair in the map
+    #     @yield [key, value] a key-value pair of the map
+    #     @return [self] the object itself
+    #   @overload each
+    #     Returns an Enumerator that iterates over the key-value pairs in the map
+    #     @return [Enumerator] the enumerator of the key-value pairs
+    #
+    # @!method empty?
+    #   Returns `true` if the number of entires in the map is zero, `false` otherwise.
+    #   @return [Boolean] whether the map is empty or not
+    #
+    # @!method length
+    #   Returns the number of entries in the map
+    #   @return [Integer] the number of entries in the map
+    #
+    # @!method each_key
+    #   Iterates over each key in the map
+    #   @overload each(&block)
+    #     Calls the given block with each key in the map
+    #     @yield [key] a key of the map
+    #     @return [self] the object itself
+    #   @overload each
+    #     Returns an Enumerator that iterates over the keys in the map
+    #     @return [Enumerator] the enumerator of the keys
+    def_delegators :_map, :[], :each, :empty?, :length, :each_key
+  end
+end

data/lib/gobl/note/message.rb

@@ -9,64 +9,25 @@
 module GOBL
   module Note
     # Message represents the minimum possible contents for a GoBL document type.
-    class Message < GOBL::Struct
+    class Message < GOBL::Object
       # The Schema ID of the GOBL Message structure
       SCHEMA_ID = 'https://gobl.org/draft-0/note/message'
 
       # @!attribute [r] title
       # Summary of the message content
       # @return [String]
-      attribute? :title, GOBL::Types::String.optional
+      property :title, String
 
       # @!attribute [r] content
       # Details of what exactly this message wants to communicate
       # @return [String]
-      attribute :content, GOBL::Types::String
+      property :content, String
+      validates :content, presence: true
 
       # @!attribute [r] meta
       # Any additional semi-structured data that might 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 [Message] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          title: data['title'],
-          content: data['content'],
-          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
-        {
-          'title' => attributes[:title],
-          'content' => attributes[:content],
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Message} 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 [Message] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/num/amount.rb

@@ -3,7 +3,7 @@
 module GOBL
   module Num
     # Represents a numeric quantity with optional decimal places that determine accuracy
-    class Amount
+    class Amount < GOBL::Struct
       # The integer value of the amount
       attr_reader :value
 
@@ -33,40 +33,6 @@ module GOBL
         end
       end
 
-      # Creates a new {Amount} from a GOBL value
-      #
-      # @param data [Hash] a GOBL value
-      #
-      # @return [Amount] the object created from the given data
-      def self.from_gobl!(data)
-        new(data)
-      end
-
-      # Deserializes an {Amount} from a JSON string
-      #
-      # @param json [String] a JSON string
-      #
-      # @return [Amount] the deserialized {Amount}
-      def self.from_json!(json)
-        from_gobl!(JSON.parse(json))
-      end
-
-      # Returns a GOBL value representing the current amount
-      #
-      # @return [String] the GOBL value that represents the current amount
-      def to_gobl
-        to_s
-      end
-
-      # Serializes a GOBL struct into a JSON string
-      #
-      # @param options [#to_h] a Hash-like object to pass to `JSON.generate`
-      #
-      # @return [GOBL::Struct] the JSON string representing the GOBL struct
-      def to_json(options = nil)
-        JSON.generate(to_gobl, options)
-      end
-
       # Returns the string representation of the current amount
       #
       # @return [String] the string representation of the current amount
@@ -222,6 +188,11 @@ module GOBL
         self.class.new(value: -value, exp: exp)
       end
 
+      #  @api private
+      def as_json(*)
+        to_s
+      end
+
       protected
 
       # Extract the value and exponent from the string.