gobl 0.1.3 → 0.2.0

data/lib/gobl/org/party.rb

@@ -9,127 +9,70 @@
 module GOBL
   module Org
     # Party represents a person or business entity.
-    class Party < GOBL::Struct
+    class Party < GOBL::Object
       # 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
+      property :id, String
 
       # @!attribute [r] uuid
       # Unique identity code
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!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
+      property :tax_id, GOBL::Org::TaxIdentity
 
       # @!attribute [r] name
       # Legal name or representation of the organization.
       # @return [String]
-      attribute :name, GOBL::Types::String
+      property :name, String
+      validates :name, presence: true
 
       # @!attribute [r] alias
       # Alternate short name.
       # @return [String]
-      attribute? :alias, GOBL::Types::String.optional
+      property :alias, String
 
       # @!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
+      property :people, [GOBL::Org::Person]
 
       # @!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
+      property :inboxes, [GOBL::Org::Inbox]
 
       # @!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
+      property :addresses, [GOBL::Org::Address]
 
       # @!attribute [r] emails
       # Electronic mail addresses
       # @return [Array<GOBL::Org::Email>]
-      attribute? :emails, GOBL::Types::Array.of(GOBL::Org::Email).optional
+      property :emails, [GOBL::Org::Email]
 
       # @!attribute [r] telephones
       # Regular telephone numbers
       # @return [Array<GOBL::Org::Telephone>]
-      attribute? :telephones, GOBL::Types::Array.of(GOBL::Org::Telephone).optional
+      property :telephones, [GOBL::Org::Telephone]
 
       # @!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
+      property :registration, GOBL::Org::Registration
 
       # @!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
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/org/person.rb

@@ -9,92 +9,45 @@
 module GOBL
   module Org
     # Person represents a human, and how to contact them electronically.
-    class Person < GOBL::Struct
+    class Person < GOBL::Object
       # The Schema ID of the GOBL Person structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/person'
 
       # @!attribute [r] id
       # Internal ID used to identify the person inside a document.
       # @return [String]
-      attribute? :id, GOBL::Types::String.optional
+      property :id, String
 
       # @!attribute [r] uuid
       # Unique identity code
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] name
       # Complete details on the name of the person
       # @return [GOBL::Org::Name]
-      attribute :name, GOBL::Org::Name
+      property :name, GOBL::Org::Name
+      validates :name, presence: true
 
       # @!attribute [r] role
       # What they do within an organization
       # @return [String]
-      attribute? :role, GOBL::Types::String.optional
+      property :role, String
 
       # @!attribute [r] emails
       # Electronic mail addresses that belong to the person.
       # @return [Array<GOBL::Org::Email>]
-      attribute? :emails, GOBL::Types::Array.of(GOBL::Org::Email).optional
+      property :emails, [GOBL::Org::Email]
 
       # @!attribute [r] telephones
       # Regular phone or mobile numbers
       # @return [Array<GOBL::Org::Telephone>]
-      attribute? :telephones, GOBL::Types::Array.of(GOBL::Org::Telephone).optional
+      property :telephones, [GOBL::Org::Telephone]
 
       # @!attribute [r] meta
       # Data about the 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 [Person] 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,
-          name: GOBL::Org::Name.from_gobl!(data['name']),
-          role: data['role'],
-          emails: data['emails']&.map { |item| GOBL::Org::Email.from_gobl!(item) },
-          telephones: data['telephones']&.map { |item| GOBL::Org::Telephone.from_gobl!(item) },
-          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,
-          'name' => attributes[:name]&.to_gobl,
-          'role' => attributes[:role],
-          'emails' => attributes[:emails]&.map { |item| item&.to_gobl },
-          'telephones' => attributes[:telephones]&.map { |item| item&.to_gobl },
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Person} 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 [Person] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/org/registration.rb

@@ -9,91 +9,41 @@
 module GOBL
   module Org
     # Registration is used in countries that require additional information to be associated with a company usually related to a specific registration office.
-    class Registration < GOBL::Struct
+    class Registration < GOBL::Object
       # The Schema ID of the GOBL Registration structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/registration'
 
       # @!attribute [r] uuid
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] office
       # @return [String]
-      attribute? :office, GOBL::Types::String.optional
+      property :office, String
 
       # @!attribute [r] book
       # @return [String]
-      attribute? :book, GOBL::Types::String.optional
+      property :book, String
 
       # @!attribute [r] volume
       # @return [String]
-      attribute? :volume, GOBL::Types::String.optional
+      property :volume, String
 
       # @!attribute [r] sheet
       # @return [String]
-      attribute? :sheet, GOBL::Types::String.optional
+      property :sheet, String
 
       # @!attribute [r] section
       # @return [String]
-      attribute? :section, GOBL::Types::String.optional
+      property :section, String
 
       # @!attribute [r] page
       # @return [String]
-      attribute? :page, GOBL::Types::String.optional
+      property :page, String
 
       # @!attribute [r] entry
       # @return [String]
-      attribute? :entry, GOBL::Types::String.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Registration] 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,
-          office: data['office'],
-          book: data['book'],
-          volume: data['volume'],
-          sheet: data['sheet'],
-          section: data['section'],
-          page: data['page'],
-          entry: data['entry']
-        )
-      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,
-          'office' => attributes[:office],
-          'book' => attributes[:book],
-          'volume' => attributes[:volume],
-          'sheet' => attributes[:sheet],
-          'section' => attributes[:section],
-          'page' => attributes[:page],
-          'entry' => attributes[:entry]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Registration} 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 [Registration] the object corresponding to the given input
+      property :entry, String
     end
   end
 end

data/lib/gobl/org/source_key.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Org
     # SourceKey identifies the source of a tax identity
-    class SourceKey < GOBL::Struct
+    class SourceKey < GOBL::Enum
       # The Schema ID of the GOBL SourceKey structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/tax-identity#/$defs/SourceKey'
 
@@ -22,139 +22,8 @@ module GOBL
         'other' => 'An other type of source not listed'
       }.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 [SourceKey] 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 {SourceKey} 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 [SourceKey] the object corresponding to the given value.
-      #
-      # @example Instantiating from a symbol
-      #   source_key = GOBL::Org::SourceKey.new(:tax_agency)
-      #
-      # @example Instantiating from a string
-      #   source_key = GOBL::Org::SourceKey.new('tax-agency')
-      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 {SourceKey} objects, the current object can be compared to a `Symbol`, a
-      # `String` or anything coercible into one (via `#to_s`)
-      #
-      # @param other [SourceKey, Symbol, String, #to_s] the other object to compare to
-      #
-      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
-      #
-      # @example Comparing to another {SourceKey} object
-      #   source_key = GOBL::Org::SourceKey.new('tax-agency')
-      #   source_key == GOBL::Org::SourceKey.new('tax-agency') #=> true
-      #   source_key == GOBL::Org::SourceKey.new('passport') #=> false
-      #
-      # @example Comparing to a string
-      #   source_key = GOBL::Org::SourceKey.new('tax-agency')
-      #   source_key == 'tax-agency' #=> true
-      #   source_key == 'passport' #=> false
-      #
-      # @example Comparing to a symbol
-      #   source_key = GOBL::Org::SourceKey.new('tax-agency')
-      #   source_key == :tax_agency #=> true
-      #   source_key == :passport #=> 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<SourceKey>] 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 `SourceKey#tax_agency?` 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
-      #   source_key = GOBL::Org::SourceKey.new('tax-agency')
-      #   source_key.tax_agency? # => true
-      #   source_key.passport? # => 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/org/tax_identity.rb

@@ -9,85 +9,40 @@
 module GOBL
   module Org
     # TaxIdentity stores the details required to identify an entity for tax purposes.
-    class TaxIdentity < GOBL::Struct
+    class TaxIdentity < GOBL::Object
       # The Schema ID of the GOBL TaxIdentity structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/tax-identity'
 
       # @!attribute [r] uuid
       # Unique universal identity code.
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] country
       # ISO country code for Where the tax identity was issued.
       # @return [GOBL::L10n::CountryCode]
-      attribute :country, GOBL::L10n::CountryCode
+      property :country, GOBL::L10n::CountryCode
+      validates :country, presence: true
 
       # @!attribute [r] locality
       # Where inside a country the Tax ID was issued, if required.
       # @return [GOBL::L10n::Code]
-      attribute? :locality, GOBL::L10n::Code.optional
+      property :locality, GOBL::L10n::Code
 
       # @!attribute [r] source
       # What is the source document of this tax identity.
       # @return [SourceKey]
-      attribute? :source, SourceKey.optional
+      property :source, SourceKey
 
       # @!attribute [r] code
       # Tax identity Code
       # @return [String]
-      attribute? :code, GOBL::Types::String.optional
+      property :code, String
 
       # @!attribute [r] meta
       # Additional details that may be required.
       # @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 [TaxIdentity] 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,
-          country: GOBL::L10n::CountryCode.from_gobl!(data['country']),
-          locality: data['locality'] ? GOBL::L10n::Code.from_gobl!(data['locality']) : nil,
-          source: data['source'] ? SourceKey.from_gobl!(data['source']) : nil,
-          code: data['code'],
-          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,
-          'country' => attributes[:country]&.to_gobl,
-          'locality' => attributes[:locality]&.to_gobl,
-          'source' => attributes[:source]&.to_gobl,
-          'code' => attributes[:code],
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {TaxIdentity} 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 [TaxIdentity] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/org/telephone.rb

@@ -9,64 +9,25 @@
 module GOBL
   module Org
     # Telephone describes what is expected for a telephone number.
-    class Telephone < GOBL::Struct
+    class Telephone < GOBL::Object
       # The Schema ID of the GOBL Telephone structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/telephone'
 
       # @!attribute [r] uuid
       # Unique identity code
       # @return [GOBL::UUID::UUID]
-      attribute? :uuid, GOBL::UUID::UUID.optional
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] label
       # Identifier for this number.
       # @return [String]
-      attribute? :label, GOBL::Types::String.optional
+      property :label, String
 
       # @!attribute [r] num
       # The number to be dialed in ITU E.164 international format.
       # @return [String]
-      attribute :num, GOBL::Types::String
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Telephone] 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,
-          label: data['label'],
-          num: data['num']
-        )
-      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,
-          'label' => attributes[:label],
-          'num' => attributes[:num]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Telephone} 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 [Telephone] the object corresponding to the given input
+      property :num, String
+      validates :num, presence: true
     end
   end
 end