gobl 0.1.3 → 0.2.0

data/lib/gobl/org/item_code.rb

@@ -9,57 +9,20 @@
 module GOBL
   module Org
     # ItemCode contains a value and optional label property that means additional codes can be added to an item.
-    class ItemCode < GOBL::Struct
+    class ItemCode < GOBL::Object
       # The Schema ID of the GOBL ItemCode structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/item#/$defs/ItemCode'
 
       # @!attribute [r] label
       # Local or human reference for the type of code the value represents.
       # @return [String]
-      attribute? :label, GOBL::Types::String.optional
+      property :label, String
 
       # @!attribute [r] value
       # The item code's value.
       # @return [String]
-      attribute :value, GOBL::Types::String
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [ItemCode] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          label: data['label'],
-          value: data['value']
-        )
-      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
-        {
-          'label' => attributes[:label],
-          'value' => attributes[:value]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {ItemCode} 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 [ItemCode] the object corresponding to the given input
+      property :value, String
+      validates :value, presence: true
     end
   end
 end

data/lib/gobl/org/key.rb

@@ -9,98 +9,9 @@
 module GOBL
   module Org
     # Text identifier to be used instead of a code for a more verbose but readable identifier.
-    class Key < GOBL::Struct
+    class Key < GOBL::Value
       # 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

@@ -9,64 +9,7 @@
 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
+    class Meta < GOBL::Map
     end
   end
 end

data/lib/gobl/org/name.rb

@@ -9,106 +9,56 @@
 module GOBL
   module Org
     # Name represents what a human is called.
-    class Name < GOBL::Struct
+    class Name < GOBL::Object
       # 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
+      property :uuid, GOBL::UUID::UUID
 
       # @!attribute [r] alias
       # What the person would like to be called
       # @return [String]
-      attribute? :alias, GOBL::Types::String.optional
+      property :alias, String
 
       # @!attribute [r] prefix
       # Additional prefix to add to name, like Mrs. or Mr.
       # @return [String]
-      attribute? :prefix, GOBL::Types::String.optional
+      property :prefix, String
 
       # @!attribute [r] given
       # Person's given or first name
       # @return [String]
-      attribute :given, GOBL::Types::String
+      property :given, String
+      validates :given, presence: true
 
       # @!attribute [r] middle
       # Middle names or initials
       # @return [String]
-      attribute? :middle, GOBL::Types::String.optional
+      property :middle, String
 
       # @!attribute [r] surname
       # Second or Family name.
       # @return [String]
-      attribute :surname, GOBL::Types::String
+      property :surname, String
+      validates :surname, presence: true
 
       # @!attribute [r] surname2
       # Additional second of family name.
       # @return [String]
-      attribute? :surname2, GOBL::Types::String.optional
+      property :surname2, String
 
       # @!attribute [r] suffix
       # Titles to include after the name.
       # @return [String]
-      attribute? :suffix, GOBL::Types::String.optional
+      property :suffix, String
 
       # @!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
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/org/note.rb

@@ -9,71 +9,30 @@
 module GOBL
   module Org
     # Note represents a free text of additional information that may be added to a document.
-    class Note < GOBL::Struct
+    class Note < GOBL::Object
       # 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
+      property :key, NoteKey
 
       # @!attribute [r] code
       # Code used for additional data that may be required to identify the note.
       # @return [String]
-      attribute? :code, GOBL::Types::String.optional
+      property :code, String
 
       # @!attribute [r] src
       # Source of this note, especially useful when auto-generated.
       # @return [String]
-      attribute? :src, GOBL::Types::String.optional
+      property :src, String
 
       # @!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
+      property :text, String
+      validates :text, presence: true
     end
   end
 end

data/lib/gobl/org/note_key.rb

@@ -9,7 +9,7 @@
 module GOBL
   module Org
     # NoteKey identifies the type of note being edited
-    class NoteKey < GOBL::Struct
+    class NoteKey < GOBL::Enum
       # The Schema ID of the GOBL NoteKey structure
       SCHEMA_ID = 'https://gobl.org/draft-0/org/note#/$defs/NoteKey'
 
@@ -42,139 +42,8 @@ module GOBL
         '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
+      def strict_enum?
+        true
       end
     end
   end