gobl 0.1.2

data/lib/gobl/org/key.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Text identifier to be used instead of a code for a more verbose but readable identifier.
+    class Key < GOBL::Struct
+      # The Schema ID of the GOBL Key structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/key'
+
+      attribute :_value, GOBL::Types::String
+      private :_value
+
+      # Creates a new object from a GOBL value
+      #
+      # @param data [String] the GOBL value
+      #
+      # @return [Key] 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 {Key} 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 [Key] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   key = GOBL::Org::Key.new(:value)
+      #
+      # @example Instantiating from a string
+      #   key = GOBL::Org::Key.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 {Key} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [Key, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {Key} object
+      #   key = GOBL::Org::Key.new('value')
+      #   key == GOBL::Org::Key.new('value') #=> true
+      #   key == GOBL::Org::Key.new('other') #=> false
+      #
+      # @example Comparing to a string
+      #   key = GOBL::Org::Key.new('value')
+      #   key == 'value' #=> true
+      #   key == 'other' #=> false
+      #
+      # @example Comparing to a symbol
+      #   key = GOBL::Org::Key.new('value')
+      #   key == :value #=> true
+      #   key == :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/org/meta.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Meta defines a structure for data about the data being defined.
+    class Meta < GOBL::Struct
+      extend Forwardable
+      include Enumerable
+
+      # The Schema ID of the GOBL Meta structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/meta'
+
+      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 [Meta] 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
+    end
+  end
+end

data/lib/gobl/org/name.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Name represents what a human is called.
+    class Name < GOBL::Struct
+      # The Schema ID of the GOBL Name structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/name'
+
+      # @!attribute [r] uuid
+      # Unique identity code
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] alias
+      # What the person would like to be called
+      # @return [String]
+      attribute? :alias, GOBL::Types::String.optional
+
+      # @!attribute [r] prefix
+      # Additional prefix to add to name, like Mrs. or Mr.
+      # @return [String]
+      attribute? :prefix, GOBL::Types::String.optional
+
+      # @!attribute [r] given
+      # Person's given or first name
+      # @return [String]
+      attribute :given, GOBL::Types::String
+
+      # @!attribute [r] middle
+      # Middle names or initials
+      # @return [String]
+      attribute? :middle, GOBL::Types::String.optional
+
+      # @!attribute [r] surname
+      # Second or Family name.
+      # @return [String]
+      attribute :surname, GOBL::Types::String
+
+      # @!attribute [r] surname2
+      # Additional second of family name.
+      # @return [String]
+      attribute? :surname2, GOBL::Types::String.optional
+
+      # @!attribute [r] suffix
+      # Titles to include after the name.
+      # @return [String]
+      attribute? :suffix, GOBL::Types::String.optional
+
+      # @!attribute [r] meta
+      # Any additional useful data.
+      # @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 [Name] 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,
+          alias: data['alias'],
+          prefix: data['prefix'],
+          given: data['given'],
+          middle: data['middle'],
+          surname: data['surname'],
+          surname2: data['surname2'],
+          suffix: data['suffix'],
+          meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'alias' => attributes[:alias],
+          'prefix' => attributes[:prefix],
+          'given' => attributes[:given],
+          'middle' => attributes[:middle],
+          'surname' => attributes[:surname],
+          'surname2' => attributes[:surname2],
+          'suffix' => attributes[:suffix],
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Name} 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 [Name] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/note.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Note represents a free text of additional information that may be added to a document.
+    class Note < GOBL::Struct
+      # The Schema ID of the GOBL Note structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/note'
+
+      # @!attribute [r] key
+      # Key specifying subject of the text
+      # @return [NoteKey]
+      attribute? :key, NoteKey.optional
+
+      # @!attribute [r] code
+      # Code used for additional data that may be required to identify the note.
+      # @return [String]
+      attribute? :code, GOBL::Types::String.optional
+
+      # @!attribute [r] src
+      # Source of this note, especially useful when auto-generated.
+      # @return [String]
+      attribute? :src, GOBL::Types::String.optional
+
+      # @!attribute [r] text
+      # The contents of the note
+      # @return [String]
+      attribute :text, GOBL::Types::String
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Note] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          key: data['key'] ? NoteKey.from_gobl!(data['key']) : nil,
+          code: data['code'],
+          src: data['src'],
+          text: data['text']
+        )
+      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,
+          'code' => attributes[:code],
+          'src' => attributes[:src],
+          'text' => attributes[:text]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Note} 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 [Note] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/org/note_key.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # NoteKey identifies the type of note being edited
+    class NoteKey < GOBL::Struct
+      # The Schema ID of the GOBL NoteKey structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/note#/$defs/NoteKey'
+
+      # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
+      ENUM = {
+        'goods' => 'Goods Description',
+        'payment' => 'Terms of Payment',
+        'legal' => 'Legal or regulatory information',
+        'dangerous-goods' => 'Dangerous goods additional information',
+        'ack' => 'Acknowledgement Description',
+        'rate' => 'Rate additional information',
+        'reason' => 'Reason',
+        'dispute' => 'Dispute',
+        'customer' => 'Customer remarks',
+        'glossary' => 'Glossary',
+        'customs' => 'Customs declaration information',
+        'general' => 'General information',
+        'handling' => 'Handling instructions',
+        'packaging' => 'Packaging information',
+        'loading' => 'Loading instructions',
+        'price' => 'Price conditions',
+        'priority' => 'Priority information',
+        'regulatory' => 'Regulatory information',
+        'safety' => 'Safety instructions',
+        'ship-line' => 'Ship line',
+        'supplier' => 'Supplier remarks',
+        'transport' => 'Transportation information',
+        'delivery' => 'Delivery information',
+        'quarantine' => 'Quarantine information',
+        'tax' => 'Tax declaration'
+      }.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 [NoteKey] 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 {NoteKey} 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 [NoteKey] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   note_key = GOBL::Org::NoteKey.new(:goods)
+      #
+      # @example Instantiating from a string
+      #   note_key = GOBL::Org::NoteKey.new('goods')
+      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 {NoteKey} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [NoteKey, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {NoteKey} object
+      #   note_key = GOBL::Org::NoteKey.new('goods')
+      #   note_key == GOBL::Org::NoteKey.new('goods') #=> true
+      #   note_key == GOBL::Org::NoteKey.new('payment') #=> false
+      #
+      # @example Comparing to a string
+      #   note_key = GOBL::Org::NoteKey.new('goods')
+      #   note_key == 'goods' #=> true
+      #   note_key == 'payment' #=> false
+      #
+      # @example Comparing to a symbol
+      #   note_key = GOBL::Org::NoteKey.new('goods')
+      #   note_key == :goods #=> true
+      #   note_key == :payment #=> 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<NoteKey>] 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 `NoteKey#goods?` 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
+      #   note_key = GOBL::Org::NoteKey.new('goods')
+      #   note_key.goods? # => true
+      #   note_key.payment? # => 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/org/party.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Party represents a person or business entity.
+    class Party < GOBL::Struct
+      # The Schema ID of the GOBL Party structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/party'
+
+      # @!attribute [r] id
+      # Internal ID used to identify the party inside a document.
+      # @return [String]
+      attribute? :id, GOBL::Types::String.optional
+
+      # @!attribute [r] uuid
+      # Unique identity code
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] tax_id
+      # The entity's legal ID code used for tax purposes. They may have other numbers, but we're only interested in those valid for tax purposes.
+      # @return [GOBL::Org::TaxIdentity]
+      attribute? :tax_id, GOBL::Org::TaxIdentity.optional
+
+      # @!attribute [r] name
+      # Legal name or representation of the organization.
+      # @return [String]
+      attribute :name, GOBL::Types::String
+
+      # @!attribute [r] alias
+      # Alternate short name.
+      # @return [String]
+      attribute? :alias, GOBL::Types::String.optional
+
+      # @!attribute [r] people
+      # Details of physical people who represent the party.
+      # @return [Array<GOBL::Org::Person>]
+      attribute? :people, GOBL::Types::Array.of(GOBL::Org::Person).optional
+
+      # @!attribute [r] inboxes
+      # Digital inboxes used for forwarding electronic versions of documents
+      # @return [Array<GOBL::Org::Inbox>]
+      attribute? :inboxes, GOBL::Types::Array.of(GOBL::Org::Inbox).optional
+
+      # @!attribute [r] addresses
+      # Regular post addresses for where information should be sent if needed.
+      # @return [Array<GOBL::Org::Address>]
+      attribute? :addresses, GOBL::Types::Array.of(GOBL::Org::Address).optional
+
+      # @!attribute [r] emails
+      # Electronic mail addresses
+      # @return [Array<GOBL::Org::Email>]
+      attribute? :emails, GOBL::Types::Array.of(GOBL::Org::Email).optional
+
+      # @!attribute [r] telephones
+      # Regular telephone numbers
+      # @return [Array<GOBL::Org::Telephone>]
+      attribute? :telephones, GOBL::Types::Array.of(GOBL::Org::Telephone).optional
+
+      # @!attribute [r] registration
+      # Additional registration details about the company that may need to be included in a document.
+      # @return [GOBL::Org::Registration]
+      attribute? :registration, GOBL::Org::Registration.optional
+
+      # @!attribute [r] meta
+      # Any additional semi-structured information that does not fit into the rest of the party.
+      # @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 [Party] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          id: data['id'],
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          tax_id: data['tax_id'] ? GOBL::Org::TaxIdentity.from_gobl!(data['tax_id']) : nil,
+          name: data['name'],
+          alias: data['alias'],
+          people: data['people']&.map { |item| GOBL::Org::Person.from_gobl!(item) },
+          inboxes: data['inboxes']&.map { |item| GOBL::Org::Inbox.from_gobl!(item) },
+          addresses: data['addresses']&.map { |item| GOBL::Org::Address.from_gobl!(item) },
+          emails: data['emails']&.map { |item| GOBL::Org::Email.from_gobl!(item) },
+          telephones: data['telephones']&.map { |item| GOBL::Org::Telephone.from_gobl!(item) },
+          registration: data['registration'] ? GOBL::Org::Registration.from_gobl!(data['registration']) : nil,
+          meta: data['meta'] ? GOBL::Org::Meta.from_gobl!(data['meta']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'id' => attributes[:id],
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'tax_id' => attributes[:tax_id]&.to_gobl,
+          'name' => attributes[:name],
+          'alias' => attributes[:alias],
+          'people' => attributes[:people]&.map { |item| item&.to_gobl },
+          'inboxes' => attributes[:inboxes]&.map { |item| item&.to_gobl },
+          'addresses' => attributes[:addresses]&.map { |item| item&.to_gobl },
+          'emails' => attributes[:emails]&.map { |item| item&.to_gobl },
+          'telephones' => attributes[:telephones]&.map { |item| item&.to_gobl },
+          'registration' => attributes[:registration]&.to_gobl,
+          'meta' => attributes[:meta]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Party} 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 [Party] the object corresponding to the given input
+    end
+  end
+end