gobl 0.1.2 → 0.2.0

data/lib/gobl/tax/category_total.rb

@@ -9,79 +9,37 @@
 module GOBL
   module Tax
     # CategoryTotal groups together all rates inside a given category.
-    class CategoryTotal < GOBL::Struct
+    class CategoryTotal < GOBL::Object
       # The Schema ID of the GOBL CategoryTotal structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/CategoryTotal'
 
       # @!attribute [r] code
       # @return [GOBL::Org::Code]
-      attribute :code, GOBL::Org::Code
+      property :code, GOBL::Org::Code
+      validates :code, presence: true
 
       # @!attribute [r] retained
       # @return [Boolean]
-      attribute? :retained, GOBL::Types::Bool.optional
+      property :retained, Boolean
 
       # @!attribute [r] rates
       # @return [Array<RateTotal>]
-      attribute :rates, GOBL::Types::Array.of(RateTotal)
+      property :rates, [RateTotal]
+      validates :rates, presence: true
 
       # @!attribute [r] base
       # @return [GOBL::Num::Amount]
-      attribute :base, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :base, GOBL::Num::Amount
+      validates :base, presence: true
 
       # @!attribute [r] amount
       # @return [GOBL::Num::Amount]
-      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
 
       # @!attribute [r] surcharge
       # @return [GOBL::Num::Amount]
-      attribute? :surcharge, GOBL::Types.Constructor(GOBL::Num::Amount).optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [CategoryTotal] 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']),
-          retained: data['retained'],
-          rates: data['rates']&.map { |item| RateTotal.from_gobl!(item) },
-          base: data['base'],
-          amount: data['amount'],
-          surcharge: data['surcharge'] || 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
-        {
-          'code' => attributes[:code]&.to_gobl,
-          'retained' => attributes[:retained],
-          'rates' => attributes[:rates]&.map { |item| item&.to_gobl },
-          'base' => attributes[:base]&.to_gobl,
-          'amount' => attributes[:amount]&.to_gobl,
-          'surcharge' => attributes[:surcharge]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {CategoryTotal} 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 [CategoryTotal] the object corresponding to the given input
+      property :surcharge, GOBL::Num::Amount
     end
   end
 end

data/lib/gobl/tax/combo.rb

@@ -9,71 +9,30 @@
 module GOBL
   module Tax
     # Combo represents the tax combination of a category code and rate key.
-    class Combo < GOBL::Struct
+    class Combo < GOBL::Object
       # The Schema ID of the GOBL Combo structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/set#/$defs/Combo'
 
       # @!attribute [r] cat
       # Tax category code from those available inside a region.
       # @return [GOBL::Org::Code]
-      attribute :cat, GOBL::Org::Code
+      property :cat, GOBL::Org::Code
+      validates :cat, presence: true
 
       # @!attribute [r] rate
       # Rate within a category to apply.
       # @return [GOBL::Org::Key]
-      attribute? :rate, GOBL::Org::Key.optional
+      property :rate, GOBL::Org::Key
 
       # @!attribute [r] percent
       # Percent defines the percentage set manually or determined from the rate key (calculated if rate present).
       # @return [GOBL::Num::Percentage]
-      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :percent, GOBL::Num::Percentage
 
       # @!attribute [r] surcharge
       # Some countries require an additional surcharge (calculated if rate present).
       # @return [GOBL::Num::Percentage]
-      attribute? :surcharge, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Combo] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          cat: GOBL::Org::Code.from_gobl!(data['cat']),
-          rate: data['rate'] ? GOBL::Org::Key.from_gobl!(data['rate']) : nil,
-          percent: data['percent'] || nil,
-          surcharge: data['surcharge'] || 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
-        {
-          'cat' => attributes[:cat]&.to_gobl,
-          'rate' => attributes[:rate]&.to_gobl,
-          'percent' => attributes[:percent]&.to_gobl,
-          'surcharge' => attributes[:surcharge]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Combo} 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 [Combo] the object corresponding to the given input
+      property :surcharge, GOBL::Num::Percentage
     end
   end
 end

data/lib/gobl/tax/localities.rb

@@ -9,82 +9,6 @@
 module GOBL
   module Tax
     # Localities stores an array of locality objects used to describe areas sub-divisions inside a region.
-    class Localities < GOBL::Struct
-      extend Forwardable
-      include Enumerable
-
-      # The Schema ID of the GOBL Localities structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Localities'
-
-      attribute :_ary, GOBL::Types::Array.of(Locality)
-
-      # @!method [](*args)
-      #   Returns elements from the array
-      #   @overload [](index)
-      #     Returns the element in a specific position
-      #     @param index [Integer] the position of the object
-      #     @return [Locality] the element in the `index` position
-      #   @overload [](start, length)
-      #     Returns all the elements within a range of positions
-      #     @param start [Integer] start position of the range
-      #     @param length [Integer] length of the range
-      #     @return [Array<Locality>] the elements in the range
-      #   @overload [](range)
-      #     Returns all the elements within a range
-      #     @param range [Range] start and end positions of the range
-      #     @return [Array<Locality>] the elements in the range
-      #
-      # @!method each
-      #   Iterates over the array elements
-      #   @overload each(&block)
-      #     Calls the given block with each element in the array
-      #     @yield [element] element of the array
-      #     @return [self] the object itself
-      #   @overload each
-      #     Returns an Enumerator that iterates over the array elements
-      #     @return [Enumerator] the enumerator of the array elements
-      #
-      # @!method empty?
-      #   Returns `true` if the number of elements in the array is zero, `false` otherwise.
-      #   @return [Boolean] whether the array is empty or not
-      #
-      # @!method length
-      #   Returns the number of elements in the array
-      #   @return [Integer] the number of elements in the array
-      def_delegators :_ary, :[], :each, :empty?, :length
-
-      # Creates a new object from an array of GOBL data
-      #
-      # @param data [Array] an array of GOBL data
-      #
-      # @return [Localities] the object created from the given data
-      def self.from_gobl!(data)
-        new(_ary: data&.map { |item| Locality.from_gobl!(item) })
-      end
-
-      # Returns an array of GOBL data representing the current object
-      #
-      # @return [Array<Hash>] the array of GOBL data that represents the current object
-      def to_gobl
-        _ary.map(&:to_gobl)
-      end
-
-      # Returns a {Localities} object from a given array of structs. The array may
-      # contain {Locality} objects or hashes. If hashes are provided, the constructor
-      # will call `Locality#new` to generate the objects that will be part of the
-      # returned {Localities} object
-      #
-      # @param object [Array<Locality, Hash>] the array containing the structs
-      #
-      # @return [Localities] the object corresponding to the given input
-      def self.new(object)
-        case object
-        when Array
-          super _ary: object
-        else # internal use, not to be used in public calls
-          super
-        end
-      end
-    end
+    Localities = [Locality] # rubocop:disable Naming/ConstantName, Style/MutableConstant
   end
 end

data/lib/gobl/tax/locality.rb

@@ -9,64 +9,26 @@
 module GOBL
   module Tax
     # Locality represents an area inside a region, like a province or a state, which shares the basic definitions of the region, but may vary in some validation rules.
-    class Locality < GOBL::Struct
+    class Locality < GOBL::Object
       # The Schema ID of the GOBL Locality structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Locality'
 
       # @!attribute [r] code
       # Code
       # @return [GOBL::L10n::Code]
-      attribute :code, GOBL::L10n::Code
+      property :code, GOBL::L10n::Code
+      validates :code, presence: true
 
       # @!attribute [r] name
       # Name of the locality with local and hopefully international translations.
       # @return [GOBL::I18n::String]
-      attribute :name, GOBL::I18n::String
+      property :name, GOBL::I18n::String
+      validates :name, presence: true
 
       # @!attribute [r] meta
       # Any additional information
       # @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 [Locality] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          code: GOBL::L10n::Code.from_gobl!(data['code']),
-          name: GOBL::I18n::String.from_gobl!(data['name']),
-          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
-        {
-          'code' => attributes[:code]&.to_gobl,
-          'name' => attributes[:name]&.to_gobl,
-          'meta' => attributes[:meta]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Locality} 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 [Locality] the object corresponding to the given input
+      property :meta, GOBL::Org::Meta
     end
   end
 end

data/lib/gobl/tax/rate.rb

@@ -9,69 +9,30 @@
 module GOBL
   module Tax
     # Rate defines a single rate inside a category
-    class Rate < GOBL::Struct
+    class Rate < GOBL::Object
       # The Schema ID of the GOBL Rate structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Rate'
 
       # @!attribute [r] key
       # Key identifies this rate within the system
       # @return [GOBL::Org::Key]
-      attribute :key, GOBL::Org::Key
+      property :key, GOBL::Org::Key
+      validates :key, 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] values
       # Values contains a list of Value objects that contain the current and historical percentage values for the rate; order is important, newer values should come before older values.
       # @return [Array<RateValue>]
-      attribute :values, GOBL::Types::Array.of(RateValue)
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [Rate] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          key: GOBL::Org::Key.from_gobl!(data['key']),
-          name: GOBL::I18n::String.from_gobl!(data['name']),
-          desc: data['desc'] ? GOBL::I18n::String.from_gobl!(data['desc']) : nil,
-          values: data['values']&.map { |item| RateValue.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
-        {
-          'key' => attributes[:key]&.to_gobl,
-          'name' => attributes[:name]&.to_gobl,
-          'desc' => attributes[:desc]&.to_gobl,
-          'values' => attributes[:values]&.map { |item| item&.to_gobl }
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {Rate} 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 [Rate] the object corresponding to the given input
+      property :values, [RateValue]
+      validates :values, presence: true
     end
   end
 end

data/lib/gobl/tax/rate_total.rb

@@ -9,74 +9,33 @@
 module GOBL
   module Tax
     # RateTotal contains a sum of all the tax rates in the document with a matching category and rate.
-    class RateTotal < GOBL::Struct
+    class RateTotal < GOBL::Object
       # The Schema ID of the GOBL RateTotal structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotal'
 
       # @!attribute [r] key
       # @return [GOBL::Org::Key]
-      attribute? :key, GOBL::Org::Key.optional
+      property :key, GOBL::Org::Key
 
       # @!attribute [r] base
       # @return [GOBL::Num::Amount]
-      attribute :base, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :base, GOBL::Num::Amount
+      validates :base, presence: true
 
       # @!attribute [r] percent
       # @return [GOBL::Num::Percentage]
-      attribute :percent, GOBL::Types.Constructor(GOBL::Num::Percentage)
+      property :percent, GOBL::Num::Percentage
+      validates :percent, presence: true
 
       # @!attribute [r] amount
       # Total amount of rate, excluding surcharges
       # @return [GOBL::Num::Amount]
-      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
 
       # @!attribute [r] surcharge
       # @return [RateTotalSurcharge]
-      attribute? :surcharge, RateTotalSurcharge.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [RateTotal] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          key: data['key'] ? GOBL::Org::Key.from_gobl!(data['key']) : nil,
-          base: data['base'],
-          percent: data['percent'],
-          amount: data['amount'],
-          surcharge: data['surcharge'] ? RateTotalSurcharge.from_gobl!(data['surcharge']) : 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
-        {
-          'key' => attributes[:key]&.to_gobl,
-          'base' => attributes[:base]&.to_gobl,
-          'percent' => attributes[:percent]&.to_gobl,
-          'amount' => attributes[:amount]&.to_gobl,
-          'surcharge' => attributes[:surcharge]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {RateTotal} 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 [RateTotal] the object corresponding to the given input
+      property :surcharge, RateTotalSurcharge
     end
   end
 end

data/lib/gobl/tax/rate_total_surcharge.rb

@@ -9,55 +9,19 @@
 module GOBL
   module Tax
     # RateTotalSurcharge reflects the sum surcharges inside the rate.
-    class RateTotalSurcharge < GOBL::Struct
+    class RateTotalSurcharge < GOBL::Object
       # The Schema ID of the GOBL RateTotalSurcharge structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotalSurcharge'
 
       # @!attribute [r] percent
       # @return [GOBL::Num::Percentage]
-      attribute :percent, GOBL::Types.Constructor(GOBL::Num::Percentage)
+      property :percent, GOBL::Num::Percentage
+      validates :percent, presence: true
 
       # @!attribute [r] amount
       # @return [GOBL::Num::Amount]
-      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [RateTotalSurcharge] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          percent: data['percent'],
-          amount: data['amount']
-        )
-      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
-        {
-          'percent' => attributes[:percent]&.to_gobl,
-          'amount' => attributes[:amount]&.to_gobl
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {RateTotalSurcharge} 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 [RateTotalSurcharge] the object corresponding to the given input
+      property :amount, GOBL::Num::Amount
+      validates :amount, presence: true
     end
   end
 end

data/lib/gobl/tax/rate_value.rb

@@ -9,71 +9,30 @@
 module GOBL
   module Tax
     # RateValue contains a percentage rate or fixed amount for a given date range.
-    class RateValue < GOBL::Struct
+    class RateValue < GOBL::Object
       # The Schema ID of the GOBL RateValue structure
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/RateValue'
 
       # @!attribute [r] since
       # Date from which this value should be applied.
       # @return [GOBL::Cal::Date]
-      attribute? :since, GOBL::Cal::Date.optional
+      property :since, GOBL::Cal::Date
 
       # @!attribute [r] percent
       # Percent rate that should be applied
       # @return [GOBL::Num::Percentage]
-      attribute :percent, GOBL::Types.Constructor(GOBL::Num::Percentage)
+      property :percent, GOBL::Num::Percentage
+      validates :percent, presence: true
 
       # @!attribute [r] surcharge
       # An additional surcharge to apply.
       # @return [GOBL::Num::Percentage]
-      attribute? :surcharge, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+      property :surcharge, GOBL::Num::Percentage
 
       # @!attribute [r] disabled
       # When true, this value should no longer be used.
       # @return [Boolean]
-      attribute? :disabled, GOBL::Types::Bool.optional
-
-      # Creates a new object from a hash of GOBL data
-      #
-      # @param data [Hash] a hash of GOBL data
-      #
-      # @return [RateValue] the object created from the given data
-      def self.from_gobl!(data)
-        data = GOBL::Types::Hash[data]
-
-        new(
-          since: data['since'] ? GOBL::Cal::Date.from_gobl!(data['since']) : nil,
-          percent: data['percent'],
-          surcharge: data['surcharge'] || nil,
-          disabled: data['disabled']
-        )
-      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
-        {
-          'since' => attributes[:since]&.to_gobl,
-          'percent' => attributes[:percent]&.to_gobl,
-          'surcharge' => attributes[:surcharge]&.to_gobl,
-          'disabled' => attributes[:disabled]
-        }.compact
-      end
-
-      # @!method self.new(attrs)
-      #
-      #   Returns a {RateValue} 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 [RateValue] the object corresponding to the given input
+      property :disabled, Boolean
     end
   end
 end