gobl 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 922b876883d44b5061b36575f25d4d6fcd4bcc69e7897a1994f822efc07e0037
-  data.tar.gz: e5336560d0e2709307e62d7bd112e6b2ed317c1724e76a2fe2cbd023a79f8186
+  metadata.gz: 260a74838fdcc4fb1f061650fab0f2372d75cc641433e364ace0e6f0c7210341
+  data.tar.gz: 3295ae2a0a090e2a645656ad37e952884d32cec81885af60344e1a93f8d1cec0
 SHA512:
-  metadata.gz: cab22b27eeb9527c00354fd4a8789deb5c1dbfb7222121094a2497425c8fc5cd701ca52482a52aee9a92a3ca939f3e3d7c43a4ca6f287d206f1719219b6683f4
-  data.tar.gz: cfff33363d3e5a6d018be2fdb0b5964002863104ef2ec32983e6596300c65dfd216c5fea3fa6455d942cb8ec8ccd203b66ddf1f51f4982192383d3afb6589ed9
+  metadata.gz: 61d1572d9ab2d1c112b3c3a0138aa6e5e01c8c8e41b416499abc33ed5d400f8a23b8c3dd6b6b14a89df365d2063595c97873d8f15b2b1f05bc732d9c6138820e
+  data.tar.gz: c788ee19f631e61c18ad1acc2db7279bed92c37783f7b192f8b7863a26585d8c8818ab376f6e10a883e1612648ce74e7d51ef5aaa4c913255d79916013e2d16a

data/lib/gobl/extensions/document_helper.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    # 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(_map['$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.new _map.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)
+          new struct.as_json.merge(
+            '$schema' => struct.class::SCHEMA_ID
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gobl/extensions/envelope_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    # Additional methods for the generated {GOBL::Envelope} class
+    module EnvelopeHelper
+      def self.included(klass)
+        klass.alias_method :schema, '$schema'
+        klass.alias_method :schema=, '$schema='
+      end
+
+      # Extracts the GOBL struct embedded in the envelope's document
+      #
+      # @see GOBL::Extensions::DocumentHelper#extract
+      #
+      # @return [GOBL::Struct] the GOBL struct embedded in the envelope's document
+      def extract
+        doc.extract
+      end
+    end
+  end
+end

data/lib/gobl/extensions/i18n/value_keys_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    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 _map.key?(method_name) || _map.key?(method_name.to_s)
+            _map[method_name] || _map[method_name.to_s]
+          else
+            super
+          end
+        end
+
+        # @api private
+        def respond_to_missing?(method_name, *)
+          _map.key?(method_name) || _map.key?(method_name.to_s) || super
+        end
+      end
+    end
+  end
+end

data/lib/gobl/extensions/tax/regime_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GOBL
+  module Extensions
+    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
+end

data/lib/gobl/version.rb

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

data/lib/gobl.rb

@@ -10,10 +10,9 @@ require 'hashme'
 
 require_relative 'ext/hashme'
 
-loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   'gobl' => 'GOBL',
-  'gobl_extensions' => 'GOBLExtensions',
   'uuid' => 'UUID',
   'url' => 'URL',
   'item_id' => 'ItemID',
@@ -22,6 +21,7 @@ loader.inflector.inflect(
   'id' => 'ID',
   'cbc' => 'CBC'
 )
+loader.ignore("#{__dir__}/ext")
 loader.setup
 
 # Main GOBL namespace. It provides direct access to the library's configuration (see
@@ -41,4 +41,13 @@ module GOBL
   end
 end
 
-require_relative 'extensions'
+# Extensions are all defined here so they are auto-loaded by Zeitwerk.
+#
+# Both the instance and class method modules need to be included/extended explicitly here
+# to get YARD parsing them properly.
+
+GOBL::I18n::String.include GOBL::Extensions::I18n::ValueKeysHelper
+GOBL::Document.include GOBL::Extensions::DocumentHelper
+GOBL::Document.extend GOBL::Extensions::DocumentHelper::ClassMethods
+GOBL::Envelope.include GOBL::Extensions::EnvelopeHelper
+GOBL::Tax::Regime.extend GOBL::Extensions::Tax::RegimeHelper::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gobl
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - David Lilue
@@ -66,7 +66,6 @@ files:
 - data/regimes/gb.json
 - data/regimes/nl.json
 - lib/ext/hashme.rb
-- lib/extensions.rb
 - lib/gobl.rb
 - lib/gobl/bill/advances.rb
 - lib/gobl/bill/charge.rb
@@ -101,6 +100,10 @@ files:
 - lib/gobl/dsig/signature.rb
 - lib/gobl/enum.rb
 - lib/gobl/envelope.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/regime_helper.rb
 - lib/gobl/header.rb
 - lib/gobl/i18n/string.rb
 - lib/gobl/id.rb
@@ -155,10 +158,6 @@ files:
 - 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/regime_helper.rb
 homepage: https://github.com/invopop/gobl.ruby
 licenses:
 - Apache-2.0

data/lib/extensions.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-# Extensions are all defined here so they are auto-loaded by Zeitwerk.
-#
-# Both the instance and class method modules need to be included/extended explicitly here
-# to get YARD parsing them properly.
-
-GOBL::I18n::String.include GOBLExtensions::I18n::ValueKeysHelper
-GOBL::Document.include GOBLExtensions::DocumentHelper
-GOBL::Document.extend GOBLExtensions::DocumentHelper::ClassMethods
-GOBL::Envelope.include GOBLExtensions::EnvelopeHelper
-GOBL::Tax::Regime.extend GOBLExtensions::Tax::RegimeHelper::ClassMethods

data/lib/gobl_extensions/document_helper.rb

@@ -1,45 +0,0 @@
-# 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(_map['$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.new _map.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)
-        new struct.as_json.merge(
-          '$schema' => struct.class::SCHEMA_ID
-        )
-      end
-    end
-  end
-end

data/lib/gobl_extensions/envelope_helper.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module GOBLExtensions
-  # Additional methods for the generated {GOBL::Envelope} class
-  module EnvelopeHelper
-    def self.included(klass)
-      klass.alias_method :schema, '$schema'
-      klass.alias_method :schema=, '$schema='
-    end
-
-    # 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

@@ -1,27 +0,0 @@
-# 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 _map.key?(method_name) || _map.key?(method_name.to_s)
-          _map[method_name] || _map[method_name.to_s]
-        else
-          super
-        end
-      end
-
-      # @api private
-      def respond_to_missing?(method_name, *)
-        _map.key?(method_name) || _map.key?(method_name.to_s) || super
-      end
-    end
-  end
-end

data/lib/gobl_extensions/tax/regime_helper.rb

@@ -1,35 +0,0 @@
-# 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