gobl 0.1.2

data/lib/gobl_extensions/document_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GOBLExtensions
+  # Additional methods for the generated {GOBL::Document} class
+  module DocumentHelper
+    # Returns the Schema ID of the current document
+    #
+    # @return [GOBL::ID] the Schema ID
+    def schema
+      @schema ||= GOBL::ID.new(_value['$schema'])
+    end
+
+    # Extracts the GOBL struct embedded in the document. It determines the type of document
+    # currently embedded by reading the schema and attemps to instantiate the detected
+    # class.
+    #
+    # @return [GOBL::Struct] the GOBL struct embedded in the document
+    def extract
+      raise 'unknown schema' unless schema.gobl?
+
+      typs = ['GOBL']
+      schema.modules.each do |mod|
+        typs << mod.underscore.camelize
+      end
+      typs << schema.name.underscore.camelize
+      klass = typs.join('::').constantize
+
+      # Sanity check
+      raise "#{klass.name}::SCHEMA_ID expected to be '#{schema}'" unless schema == klass::SCHEMA_ID
+
+      klass.from_gobl!(_value.except('$schema'))
+    end
+
+    module ClassMethods
+      # Embeds the given GOBL struct in a new document injecting the proper Schema ID.
+      #
+      # @return [Document] the document embedding the given struct
+      def embed(struct)
+        from_gobl! struct.to_gobl.merge(
+          '$schema' => struct.class::SCHEMA_ID
+        )
+      end
+    end
+  end
+end

data/lib/gobl_extensions/envelope_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GOBLExtensions
+  # Additional methods for the generated {GOBL::Envelope} class
+  module EnvelopeHelper
+    # Extracts the GOBL struct embedded in the envelope's document
+    #
+    # @see GOBLExtensions::DocumentHelper#extract
+    #
+    # @return [GOBL::Struct] the GOBL struct embedded in the envelope's document
+    def extract
+      doc.extract
+    end
+  end
+end

data/lib/gobl_extensions/i18n/value_keys_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GOBLExtensions
+  module I18n
+    # Additional methods for the generated {GOBL::I18n::String} class
+    module ValueKeysHelper
+      # Enables dynamic getter methods for the mapped keys.
+      #
+      # @example
+      #   str = GOBL::I18n::String.new(en: 'Name', es: 'Nombre')
+      #   str.en #=> "Name"
+      #   str.es #=> "Nombre"
+      def method_missing(method_name, *args, &block)
+        if _value.key?(method_name) || _value.key?(method_name.to_s)
+          _value[method_name] || _value[method_name.to_s]
+        else
+          super
+        end
+      end
+
+      # @api private
+      def respond_to_missing?(method_name, *)
+        _value.key?(method_name) || _value.key?(method_name.to_s) || super
+      end
+    end
+  end
+end

data/lib/gobl_extensions/tax/region_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'dry/files'
+
+module GOBLExtensions
+  module Tax
+    # Additional methods for the generated {GOBL::Tax::Region} class
+    module RegionHelper
+      module ClassMethods
+        # Loads a {GOBL::Tax::Region} object identified by the given code with all its data
+        #
+        # @param code [String] the code of the region to load
+        #
+        # @return [Region] the requested region
+        def fetch(code)
+          regions[code] ||= load_region(code)
+        end
+
+        protected
+
+        def files
+          @files ||= Dry::Files.new
+        end
+
+        # map of region ID to region instance
+        def regions
+          @regions ||= {}
+        end
+
+        def load_region(code)
+          path = files.join("#{__dir__}/../../../data/tax", "#{code}.json")
+          msg = "region definition for #{code} does not exist at #{path}"
+          raise StandardError, msg unless files.exist?(path)
+
+          data = files.read(path)
+          from_json!(data)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: gobl
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- David Lilue
+- Sam Lown
+- Juanjo Molinero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: dry-files
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "/home/cavalle/workspace/invopop/gobl.ruby/gobl.gemspec"
+- data/tax/ES.json
+- data/tax/FR.json
+- data/tax/GB.json
+- data/tax/NL.json
+- lib/extensions.rb
+- lib/gobl.rb
+- lib/gobl/bill/advances.rb
+- lib/gobl/bill/charge.rb
+- lib/gobl/bill/delivery.rb
+- lib/gobl/bill/discount.rb
+- lib/gobl/bill/exchange_rates.rb
+- lib/gobl/bill/invoice.rb
+- lib/gobl/bill/invoice_type.rb
+- lib/gobl/bill/line.rb
+- lib/gobl/bill/line_charge.rb
+- lib/gobl/bill/line_discount.rb
+- lib/gobl/bill/ordering.rb
+- lib/gobl/bill/outlay.rb
+- lib/gobl/bill/payment.rb
+- lib/gobl/bill/preceding.rb
+- lib/gobl/bill/scheme_keys.rb
+- lib/gobl/bill/tax.rb
+- lib/gobl/bill/totals.rb
+- lib/gobl/cal/date.rb
+- lib/gobl/cal/period.rb
+- lib/gobl/config.rb
+- lib/gobl/currency/code.rb
+- lib/gobl/currency/exchange_rate.rb
+- lib/gobl/document.rb
+- lib/gobl/dsig/digest.rb
+- lib/gobl/dsig/signature.rb
+- lib/gobl/envelope.rb
+- lib/gobl/header.rb
+- lib/gobl/i18n/string.rb
+- lib/gobl/id.rb
+- lib/gobl/l10n/code.rb
+- lib/gobl/l10n/country_code.rb
+- lib/gobl/note/message.rb
+- lib/gobl/num/amount.rb
+- lib/gobl/num/percentage.rb
+- lib/gobl/operations.rb
+- 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/tax_identity.rb
+- lib/gobl/org/telephone.rb
+- lib/gobl/org/unit.rb
+- lib/gobl/pay/advance.rb
+- lib/gobl/pay/card.rb
+- lib/gobl/pay/credit_transfer.rb
+- lib/gobl/pay/direct_debit.rb
+- lib/gobl/pay/due_date.rb
+- lib/gobl/pay/instructions.rb
+- lib/gobl/pay/method_key.rb
+- lib/gobl/pay/online.rb
+- lib/gobl/pay/term_key.rb
+- lib/gobl/pay/terms.rb
+- lib/gobl/stamp.rb
+- lib/gobl/struct.rb
+- 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/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/scheme.rb
+- lib/gobl/tax/schemes.rb
+- lib/gobl/tax/set.rb
+- lib/gobl/tax/total.rb
+- lib/gobl/types.rb
+- lib/gobl/uuid/uuid.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
+homepage: https://github.com/invopop/gobl.ruby
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Minimalist ruby version of the GOBL library
+test_files: []