sepa_rator 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f81f775b9672175eb25c887d1c4d31525b1b218e7e7c4efa36b372bb85010e0
-  data.tar.gz: f64ce6a61f43c39f968bc17ead46ba48370351b440c32f838def6385dd719ca0
+  metadata.gz: 6a31b76a38e117f7875a90c25738f28ec1a433717e800e2225ceedf1c51797af
+  data.tar.gz: 292b6ad1c1ee43c026a4d51c4a3c48d93b7dd4dda50ce7d03f1f046400b83e25
 SHA512:
-  metadata.gz: dc7867b7ecf3f7bd2e19bc0fb557e75d1fb5492cc4ad51b34162fd522e798f7befdc4b47af0d9f52ede7eb0368d154834399466bb1b59b2d70faf6166d1a4a33
-  data.tar.gz: 8b3a5dfd400470eb34d62e263bf429ef4dc2d407ee5a2a7b9e69307c206374169b528f307bb729e1af0fb57c263f4de7cc83ce15c6427249e8333e0d078a3113
+  metadata.gz: c1a17fd1061cf8b46f0ce44df8a1914d6eac61fa1c9fa3c4176ca7149a1dab465493dd578796300204af46b9aa93263a452f35fcf6274d5716f2b825118d43b7
+  data.tar.gz: 8fd4c0a268f30e1a2915536b1f46485fa734b1eb2dd2e84e5a02d7759a44f8b3287c2e094c7a98b1d3dee125a019dc199dda3c3484ab764cffa5ca155a69df87

data/README.md

@@ -34,15 +34,27 @@ For the full per-profile detail (XSD, constraints, capabilities), see [DOCUMENTA
 
 ## Requirements
 
-- Ruby 3.2+
+- Ruby 3.2+ (tested up to 4.0)
 - ActiveModel 7.0+ (tested up to 8.1)
 
 ## Installation
 
 ```ruby
-gem 'sepa_rator', '~> 1.0'
+gem 'sepa_rator', '~> 2.0'
 ```
 
+### Country-specific schemas
+
+The core gem ships only the ISO baseline XSDs, which cover the ISO, EPC, CFONB, GB and NL profiles. Profiles validated against a national XSD variant need a companion gem:
+
+| Profiles | Companion gem |
+|---|---|
+| `at.*` (PSA 🇦🇹) | `gem 'sepa_rator-at'` |
+| `dk.*` (DK/GBIC 🇩🇪) | `gem 'sepa_rator-dk'` |
+| `sps.*` (SPS 🇨🇭) | `gem 'sepa_rator-sps'` |
+
+Bundler auto-requires them; no further setup needed. Without the gem, generating XML for such a profile raises a `SEPA::Error` naming the gem to add. Custom schema directories can also be registered with `SEPA.register_schema_root(path)`.
+
 ## Quick start
 
 ### The simplest possible Credit Transfer

data/lib/sepa_rator/concerns/schema_validation.rb

@@ -6,15 +6,27 @@ module SEPA
   module SchemaValidation
     extend ActiveSupport::Concern
 
-    SCHEMA_DIR = File.expand_path('../../schema', __dir__).freeze
-    # Eagerly-initialised module-level XSD cache, shared across every
-    # class that includes SchemaValidation. Keyed by `profile.xsd_path`
-    # so two profiles that share an ISO schema name but point to
-    # different XSD files (e.g. the ISO baseline and the DK GBIC5
-    # variant) never share a cache entry.
+    DEFAULT_SCHEMA_ROOT = File.expand_path('../../schema', __dir__).freeze
+    # So missing-schema errors can name the companion gem to install.
+    SCHEMA_GEMS = { 'at' => 'sepa_rator-at', 'dk' => 'sepa_rator-dk', 'sps' => 'sepa_rator-sps' }.freeze
+    # Keyed by resolved absolute path so a late-registered root takes
+    # effect immediately.
     SCHEMA_CACHE = {} # rubocop:disable Style/MutableConstant -- intentional cache
     SCHEMA_CACHE_MUTEX = Mutex.new
 
+    class << self
+      def schema_roots
+        @schema_roots ||= [DEFAULT_SCHEMA_ROOT]
+      end
+
+      def register_schema_root(path)
+        expanded = File.expand_path(path)
+        raise ArgumentError, "register_schema_root: #{expanded} is not a directory" unless File.directory?(expanded)
+
+        schema_roots.unshift(expanded) unless schema_roots.include?(expanded)
+      end
+    end
+
     private
 
     def validate_final_document!(document, profile)
@@ -31,23 +43,34 @@ module SEPA
     end
 
     def load_xsd(profile)
-      cache_key = profile.xsd_path
-      cached = SCHEMA_CACHE[cache_key]
+      path = resolve_xsd_path(profile)
+      cached = SCHEMA_CACHE[path]
       return cached if cached
 
       SCHEMA_CACHE_MUTEX.synchronize do
-        SCHEMA_CACHE[cache_key] ||= read_xsd(profile)
+        SCHEMA_CACHE[path] ||= read_xsd(path)
       end
     end
 
-    def read_xsd(profile)
-      path = File.join(SCHEMA_DIR, profile.xsd_path)
+    def resolve_xsd_path(profile)
+      SchemaValidation.schema_roots
+                      .map { |root| File.join(root, profile.xsd_path) }
+                      .find { |candidate| File.file?(candidate) } ||
+        raise_missing_schema!(profile)
+    end
+
+    def read_xsd(path)
       # File.open (not File.read) so Nokogiri can resolve xs:include/xs:redefine
       # relative to the XSD file's directory (needed for AT/PSA schemas).
       File.open(path) { |f| Nokogiri::XML::Schema(f) }
-    rescue Errno::ENOENT => e
+    end
+
+    def raise_missing_schema!(profile)
+      gem_name = SCHEMA_GEMS[profile.xsd_path.split('/').first]
+      hint = gem_name ? " Add gem '#{gem_name}' to your Gemfile to validate profile #{profile.id}." : ''
       raise SEPA::Error,
-            "[#{profile.id}] XSD file not found at #{path} (xsd_path=#{profile.xsd_path.inspect}): #{e.message}"
+            "[#{profile.id}] XSD file #{profile.xsd_path} not found " \
+            "(searched roots: #{SchemaValidation.schema_roots.join(', ')}).#{hint}"
     end
   end
 end

data/lib/sepa_rator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SEPA
-  VERSION = '1.3.1'
+  VERSION = '2.0.0'
 end

data/lib/sepa_rator.rb

@@ -76,3 +76,10 @@ require 'sepa_rator/profiles/nl'
 
 # Country defaults must load AFTER all variant profiles have been defined.
 require 'sepa_rator/profiles/country_defaults'
+
+module SEPA
+  # Entry point for companion schema gems (sepa_rator-at, …) at require time.
+  def self.register_schema_root(path)
+    SchemaValidation.register_schema_root(path)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepa_rator
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -67,22 +67,6 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- lib/schema/at/pain.001.001.03.at.004.xsd
-- lib/schema/at/pain.001.001.03.xsd
-- lib/schema/at/pain.001.001.09.at.005.xsd
-- lib/schema/at/pain.001.001.09.xsd
-- lib/schema/at/pain.001.codelists.xsd
-- lib/schema/at/pain.001_codelists.xsd
-- lib/schema/at/pain.008.001.02.at.004.xsd
-- lib/schema/at/pain.008.001.02.xsd
-- lib/schema/at/pain.008.001.08.at.004.xsd
-- lib/schema/at/pain.008.001.08.xsd
-- lib/schema/at/pain.008.codelists.xsd
-- lib/schema/at/pain.008_codelists.xsd
-- lib/schema/dk/pain.001.001.03_GBIC_3.xsd
-- lib/schema/dk/pain.001.001.09_GBIC_5.xsd
-- lib/schema/dk/pain.008.001.02_GBIC_3.xsd
-- lib/schema/dk/pain.008.001.08_GBIC_5.xsd
 - lib/schema/iso/pain.001.001.03.xsd
 - lib/schema/iso/pain.001.001.09.xsd
 - lib/schema/iso/pain.001.001.13.xsd
@@ -93,8 +77,6 @@ files:
 - lib/schema/iso/pain.008.001.12.xsd
 - lib/schema/iso/pain.008.002.02.xsd
 - lib/schema/iso/pain.008.003.02.xsd
-- lib/schema/sps/pain.001.001.09.ch.03.xsd
-- lib/schema/sps/pain.008.001.02.chsdd.02.xsd
 - lib/sepa_rator.rb
 - lib/sepa_rator/account.rb
 - lib/sepa_rator/account/address.rb