gobl 0.4.1 → 0.5.1

data/lib/gobl/pay/instructions.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -56,8 +56,8 @@ module GOBL
 
       # @!attribute [r] meta
       # Non-structured additional data that may be useful.
-      # @return [GOBL::Org::Meta]
-      property :meta, GOBL::Org::Meta
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
     end
   end
 end

data/lib/gobl/pay/method_key.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/pay/online.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/pay/term_key.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/pay/terms.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/tax/category.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -11,11 +11,11 @@ module GOBL
     # Category contains the definition of a general type of tax inside a region.
     class Category < GOBL::Object
       # The Schema ID of the GOBL Category structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Category'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Category'
 
       # @!attribute [r] code
-      # @return [GOBL::Org::Code]
-      property :code, GOBL::Org::Code
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
       validates :code, presence: true
 
       # @!attribute [r] name

data/lib/gobl/tax/category_total.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -14,8 +14,8 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/CategoryTotal'
 
       # @!attribute [r] code
-      # @return [GOBL::Org::Code]
-      property :code, GOBL::Org::Code
+      # @return [GOBL::CBC::Code]
+      property :code, GOBL::CBC::Code
       validates :code, presence: true
 
       # @!attribute [r] retained

data/lib/gobl/tax/combo.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -15,14 +15,14 @@ module GOBL
 
       # @!attribute [r] cat
       # Tax category code from those available inside a region.
-      # @return [GOBL::Org::Code]
-      property :cat, GOBL::Org::Code
+      # @return [GOBL::CBC::Code]
+      property :cat, GOBL::CBC::Code
       validates :cat, presence: true
 
       # @!attribute [r] rate
       # Rate within a category to apply.
-      # @return [GOBL::Org::Key]
-      property :rate, GOBL::Org::Key
+      # @return [GOBL::CBC::Key]
+      property :rate, GOBL::CBC::Key
 
       # @!attribute [r] percent
       # Percent defines the percentage set manually or determined from the rate key (calculated if rate present).

data/lib/gobl/{org/tax_identity.rb → tax/identity.rb}

@@ -3,15 +3,15 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
-  module Org
-    # TaxIdentity stores the details required to identify an entity for tax purposes.
-    class TaxIdentity < GOBL::Object
-      # The Schema ID of the GOBL TaxIdentity structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/org/tax-identity'
+  module Tax
+    # Identity stores the details required to identify an entity for tax purposes.
+    class Identity < GOBL::Object
+      # The Schema ID of the GOBL Identity structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/identity'
 
       # @!attribute [r] uuid
       # Unique universal identity code for this tax identity.
@@ -24,10 +24,10 @@ module GOBL
       property :country, GOBL::L10n::CountryCode
       validates :country, presence: true
 
-      # @!attribute [r] locality
-      # Where inside a country the identity holder is based for tax purposes, like a city, county, province, state, or combination of various.
+      # @!attribute [r] zone
+      # Where inside the country the tax identity holder is based for tax purposes like a village, town, district, city, county, state or province. For some areas, this could be a regular post or zip code. See the regime packages for specific validation rules.
       # @return [GOBL::L10n::Code]
-      property :locality, GOBL::L10n::Code
+      property :zone, GOBL::L10n::Code
 
       # @!attribute [r] source
       # What is the source document of the tax identity.
@@ -41,8 +41,8 @@ module GOBL
 
       # @!attribute [r] meta
       # Additional details that may be required.
-      # @return [GOBL::Org::Meta]
-      property :meta, GOBL::Org::Meta
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
     end
   end
 end

data/lib/gobl/tax/rate.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -11,12 +11,12 @@ module GOBL
     # Rate defines a single rate inside a category
     class Rate < GOBL::Object
       # The Schema ID of the GOBL Rate structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Rate'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Rate'
 
       # @!attribute [r] key
       # Key identifies this rate within the system
-      # @return [GOBL::Org::Key]
-      property :key, GOBL::Org::Key
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
       validates :key, presence: true
 
       # @!attribute [r] name

data/lib/gobl/tax/rate_total.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -14,8 +14,8 @@ module GOBL
       SCHEMA_ID = 'https://gobl.org/draft-0/tax/total#/$defs/RateTotal'
 
       # @!attribute [r] key
-      # @return [GOBL::Org::Key]
-      property :key, GOBL::Org::Key
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
 
       # @!attribute [r] base
       # @return [GOBL::Num::Amount]

data/lib/gobl/tax/rate_total_surcharge.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/tax/rate_value.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -11,7 +11,7 @@ module GOBL
     # RateValue contains a percentage rate or fixed amount for a given date range.
     class RateValue < GOBL::Object
       # The Schema ID of the GOBL RateValue structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/RateValue'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/RateValue'
 
       # @!attribute [r] since
       # Date from which this value should be applied.

data/lib/gobl/tax/{region.rb → regime.rb}

@@ -3,18 +3,18 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
   module Tax
-    # Region defines the holding structure for a regions categories and subsequent Rates and Values.
-    class Region < GOBL::Object
-      # The Schema ID of the GOBL Region structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region'
+    # Regime defines the holding structure for the definitions of taxes inside a country or territory.
+    class Regime < GOBL::Object
+      # The Schema ID of the GOBL Regime structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime'
 
       # @!attribute [r] name
-      # Name of the region
+      # Name of the country
       # @return [GOBL::I18n::String]
       property :name, GOBL::I18n::String
       validates :name, presence: true
@@ -25,18 +25,18 @@ module GOBL
       property :country, GOBL::L10n::CountryCode
       validates :country, presence: true
 
-      # @!attribute [r] locality
-      # Locality, city, province, county, or similar code inside the country, if needed.
+      # @!attribute [r] zone
+      # Specific Locality, region, city, province, county, or similar code inside the country, if needed.
       # @return [GOBL::L10n::Code]
-      property :locality, GOBL::L10n::Code
+      property :zone, GOBL::L10n::Code
 
-      # @!attribute [r] localities
-      # List of sub-localities inside a region.
-      # @return [Array<Locality>]
-      property :localities, [Locality]
+      # @!attribute [r] zones
+      # List of sub-zones inside a country.
+      # @return [Array<Zone>]
+      property :zones, [Zone]
 
       # @!attribute [r] currency
-      # Currency used by the region for tax purposes.
+      # Currency used by the country.
       # @return [GOBL::Currency::Code]
       property :currency, GOBL::Currency::Code
       validates :currency, presence: true

data/lib/gobl/tax/scheme.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
@@ -11,12 +11,12 @@ module GOBL
     # Scheme contains the definition of a scheme that belongs to a region and can be used to simplify validation processes for document contents.
     class Scheme < GOBL::Object
       # The Schema ID of the GOBL Scheme structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/tax/region#/$defs/Scheme'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Scheme'
 
       # @!attribute [r] key
       # Key used to identify this scheme
-      # @return [GOBL::Org::Key]
-      property :key, GOBL::Org::Key
+      # @return [GOBL::CBC::Key]
+      property :key, GOBL::CBC::Key
       validates :key, presence: true
 
       # @!attribute [r] name
@@ -32,13 +32,13 @@ module GOBL
 
       # @!attribute [r] categories
       # List of tax category codes that can be used when this scheme is applied.
-      # @return [Array<GOBL::Org::Code>]
-      property :categories, [GOBL::Org::Code]
+      # @return [Array<GOBL::CBC::Code>]
+      property :categories, [GOBL::CBC::Code]
 
       # @!attribute [r] note
       # Note defines a message that should be added to a document when this scheme is used.
-      # @return [GOBL::Org::Note]
-      property :note, GOBL::Org::Note
+      # @return [GOBL::CBC::Note]
+      property :note, GOBL::CBC::Note
     end
   end
 end

data/lib/gobl/tax/schemes.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/tax/set.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/{org → tax}/source_key.rb

@@ -3,15 +3,15 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL
-  module Org
+  module Tax
     # SourceKey identifies the source of a tax identity
     class SourceKey < GOBL::Enum
       # The Schema ID of the GOBL SourceKey structure
-      SCHEMA_ID = 'https://gobl.org/draft-0/org/tax-identity#/$defs/SourceKey'
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/identity#/$defs/SourceKey'
 
       # The enumeration of values of the object and their descriptions (Values different to these are not allowed)
       ENUM = {

data/lib/gobl/tax/total.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/tax/zone.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.34.0
+##
+
+module GOBL
+  module Tax
+    # Zone represents an area inside a country, like a province or a state, which shares the basic definitions of the country, but may vary in some validation rules.
+    class Zone < GOBL::Object
+      # The Schema ID of the GOBL Zone structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/tax/regime#/$defs/Zone'
+
+      # @!attribute [r] code
+      # Unique zone code.
+      # @return [GOBL::L10n::Code]
+      property :code, GOBL::L10n::Code
+      validates :code, presence: true
+
+      # @!attribute [r] name
+      # Name of the zone to be use if a locality or region is not applicable.
+      # @return [GOBL::I18n::String]
+      property :name, GOBL::I18n::String
+
+      # @!attribute [r] locality
+      # Village, town, district, or city name which should coincide with address data.
+      # @return [GOBL::I18n::String]
+      property :locality, GOBL::I18n::String
+
+      # @!attribute [r] region
+      # Province, county, or state which should match address data.
+      # @return [GOBL::I18n::String]
+      property :region, GOBL::I18n::String
+
+      # @!attribute [r] meta
+      # Any additional information
+      # @return [GOBL::CBC::Meta]
+      property :meta, GOBL::CBC::Meta
+    end
+  end
+end

data/lib/gobl/uuid/uuid.rb

@@ -3,7 +3,7 @@
 ##
 ## DO NOT EDIT - This file was generated automatically.
 ##
-## Generated with GOBL v0.32.0
+## Generated with GOBL v0.34.1
 ##
 
 module GOBL

data/lib/gobl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GOBL
-  VERSION = '0.4.1'
+  VERSION = '0.5.1'
 end

data/lib/gobl.rb

@@ -19,7 +19,8 @@ loader.inflector.inflect(
   'item_id' => 'ItemID',
   'tax_id' => 'TaxID',
   'dsig' => 'DSig',
-  'id' => 'ID'
+  'id' => 'ID',
+  'cbc' => 'CBC'
 )
 loader.setup
 

data/lib/gobl_extensions/tax/regime_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GOBLExtensions
+  module Tax
+    # Additional methods for the generated {GOBL::Tax::Regime} class
+    module RegimeHelper
+      module ClassMethods
+        # Loads a {GOBL::Tax::Regime} object identified by the given code with all its data
+        #
+        # @param code [String] the code of the regime to load
+        #
+        # @return [Regime] the requested regime
+        def fetch(code)
+          regimes[code] ||= load_regime(code)
+        end
+
+        protected
+
+        # map of regime ID to regime instance
+        def regimes
+          @regimes ||= {}
+        end
+
+        def load_regime(code)
+          path = File.join("#{__dir__}/../../../data/regimes", "#{code.to_s.downcase}.json")
+          msg = "regime definition for #{code} does not exist at #{path}"
+          raise StandardError, msg unless File.exist?(path)
+
+          data = File.read(path)
+          from_json!(data)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - David Lilue
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,11 +74,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- data/tax/CO.json
-- data/tax/ES.json
-- data/tax/FR.json
-- data/tax/GB.json
-- data/tax/NL.json
+- data/regimes/co.json
+- data/regimes/es.json
+- data/regimes/fr.json
+- data/regimes/gb.json
+- data/regimes/nl.json
 - lib/ext/hashme.rb
 - lib/extensions.rb
 - lib/gobl.rb
@@ -101,6 +101,12 @@ files:
 - lib/gobl/bill/totals.rb
 - lib/gobl/cal/date.rb
 - lib/gobl/cal/period.rb
+- lib/gobl/cbc/code.rb
+- lib/gobl/cbc/key.rb
+- lib/gobl/cbc/meta.rb
+- lib/gobl/cbc/note.rb
+- lib/gobl/cbc/note_key.rb
+- lib/gobl/cbc/stamp.rb
 - lib/gobl/config.rb
 - lib/gobl/currency/code.rb
 - lib/gobl/currency/exchange_rate.rb
@@ -123,23 +129,15 @@ files:
 - lib/gobl/operations/service_error.rb
 - lib/gobl/operations/validation_result.rb
 - lib/gobl/org/address.rb
-- lib/gobl/org/code.rb
 - lib/gobl/org/coordinates.rb
 - lib/gobl/org/email.rb
 - lib/gobl/org/inbox.rb
 - lib/gobl/org/item.rb
 - lib/gobl/org/item_code.rb
-- lib/gobl/org/key.rb
-- lib/gobl/org/meta.rb
 - lib/gobl/org/name.rb
-- lib/gobl/org/note.rb
-- lib/gobl/org/note_key.rb
 - lib/gobl/org/party.rb
 - lib/gobl/org/person.rb
 - lib/gobl/org/registration.rb
-- lib/gobl/org/source_key.rb
-- lib/gobl/org/stamp.rb
-- lib/gobl/org/tax_identity.rb
 - lib/gobl/org/telephone.rb
 - lib/gobl/org/unit.rb
 - lib/gobl/pay/advance.rb
@@ -156,24 +154,25 @@ files:
 - lib/gobl/tax/category.rb
 - lib/gobl/tax/category_total.rb
 - lib/gobl/tax/combo.rb
-- lib/gobl/tax/localities.rb
-- lib/gobl/tax/locality.rb
+- lib/gobl/tax/identity.rb
 - lib/gobl/tax/rate.rb
 - lib/gobl/tax/rate_total.rb
 - lib/gobl/tax/rate_total_surcharge.rb
 - lib/gobl/tax/rate_value.rb
-- lib/gobl/tax/region.rb
+- lib/gobl/tax/regime.rb
 - lib/gobl/tax/scheme.rb
 - lib/gobl/tax/schemes.rb
 - lib/gobl/tax/set.rb
+- lib/gobl/tax/source_key.rb
 - lib/gobl/tax/total.rb
+- lib/gobl/tax/zone.rb
 - lib/gobl/uuid/uuid.rb
 - lib/gobl/value.rb
 - lib/gobl/version.rb
 - lib/gobl_extensions/document_helper.rb
 - lib/gobl_extensions/envelope_helper.rb
 - lib/gobl_extensions/i18n/value_keys_helper.rb
-- lib/gobl_extensions/tax/region_helper.rb
+- lib/gobl_extensions/tax/regime_helper.rb
 homepage: https://github.com/invopop/gobl.ruby
 licenses:
 - Apache-2.0