facturx-schematron 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38cb4b9f11f3396868e5efb28abba143340cae9132f0d621aeeb105b24a97eb3
+  data.tar.gz: 66e24e5f6fed9532cca684886d4ec52ed6a4c7991254dc65bcd7d97e69c4bffa
+SHA512:
+  metadata.gz: 42645236157a7a28ba20bdc11635a7f9a87d048d2f4d02290a1e92ad067cdb3aad80723056b45b2a5d36d0b9e4baf4e13631d2092f1270a3a7c987c109356b42
+  data.tar.gz: 38fe45c13001f394e7433f72117c04dd183040967f823cd8b433f51ba3ca254f66eb459a66632a0dc63aec87edb809c62788c245a541e22af3a5f279996298af

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2026 AdVitam (https://www.advitam.fr)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NOTICE.md

@@ -0,0 +1,17 @@
+# Third-party notices
+
+## Factur-X Schematron validation artifacts
+
+This gem includes the compiled XSLT 2.0 stylesheets and adjacent code databases
+for the MINIMUM, BASIC WL, BASIC, EN 16931, and EXTENDED profiles from the
+official Factur-X 1.09.2 / ZUGFeRD 2.5.2 English package.
+
+FeRD publishes these technical artifacts under the Apache License 2.0. Its text
+is included in `lib/facturx/schematron/rules/LICENSE-APACHE-2.0.txt`. The ten
+files under `rules/1.09.2/` are byte-for-byte copies of their upstream
+counterparts; their SHA-256 digests are recorded in `rules/SHA256SUMS`.
+
+Sources:
+
+- https://www.ferd-net.de/en/downloads/publications/details/zugferd-252-english
+- https://www.ferd-net.de/en/ueber-uns/ressourcen-1/veroeffentlichungen/disclaimer-and-rights-of-use-zugferd

data/lib/facturx/schematron/error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Facturx
+  module Schematron
+    class Error < Facturx::Error; end
+    class UnavailableError < Error; end
+    class ExecutionError < Error; end
+    class InvalidOutputError < ExecutionError; end
+    class RulePackError < ExecutionError; end
+  end
+end

data/lib/facturx/schematron/locator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+require_relative 'version_probe'
+
+module Facturx
+  module Schematron
+    class Locator
+      ENV_KEY = 'FACTURX_SAXONC_TRANSFORM'
+      BINARY_NAME = 'Transform'
+      private_constant :ENV_KEY, :BINARY_NAME
+
+      def initialize(runner:, env: ENV)
+        @env = env
+        @version_probe = VersionProbe.new(runner:)
+      end
+
+      def preflight!
+        @preflight ||= begin
+          binary = resolve_binary
+          raise_missing unless binary
+
+          @version_probe.call(binary)
+          binary
+        end
+      end
+
+      private
+
+      def resolve_binary
+        configured = @env[ENV_KEY]
+        return find_executable(configured) if configured && !configured.empty?
+
+        find_executable(BINARY_NAME)
+      end
+
+      def find_executable(value)
+        path = value.to_s
+        return executable_file(path) if path.include?(File::SEPARATOR) || alt_separator?(path)
+
+        executable_names(path).each do |name|
+          search_paths.each do |directory|
+            executable = executable_file(File.join(directory, name))
+            return executable if executable
+          end
+        end
+        nil
+      end
+
+      def executable_names(name)
+        return [name] unless Gem.win_platform? && File.extname(name).empty?
+
+        extensions = @env.fetch('PATHEXT', '.COM;.EXE;.BAT;.CMD').split(';')
+        [name, *extensions.map { |extension| "#{name}#{extension.downcase}" }]
+      end
+
+      def search_paths
+        @env.fetch('PATH', '').split(File::PATH_SEPARATOR).reject(&:empty?)
+      end
+
+      def executable_file(path)
+        expanded = File.expand_path(path)
+        expanded if File.file?(expanded) && File.executable?(expanded)
+      end
+
+      def alt_separator?(path)
+        File::ALT_SEPARATOR && path.include?(File::ALT_SEPARATOR)
+      end
+
+      def raise_missing
+        raise UnavailableError.new(
+          'Schematron validation is unavailable: SaxonC Transform was not found',
+          reason: :missing_binary,
+          environment_variable: ENV_KEY
+        )
+      end
+    end
+  end
+end

data/lib/facturx/schematron/registry.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Facturx
+  module Schematron
+    class Registry
+      RuleSet = Data.define(:directory, :stylesheet, :code_db)
+      RULES_ROOT = File.expand_path('rules/1.09.2', __dir__)
+      ENTRIES = {
+        minimum: %w[minimum FACTUR-X_MINIMUM],
+        basic_wl: %w[basic-wl FACTUR-X_BASIC-WL],
+        basic: %w[basic FACTUR-X_BASIC],
+        en16931: %w[en16931 FACTUR-X_EN16931],
+        extended: %w[extended FACTUR-X_EXTENDED]
+      }.freeze
+      private_constant :RULES_ROOT, :ENTRIES
+
+      def initialize
+        @rule_sets = {}
+        @mutex = Mutex.new
+      end
+
+      def fetch(profile)
+        @rule_sets[profile.id] || @mutex.synchronize do
+          @rule_sets[profile.id] ||= build(profile)
+        end
+      end
+
+      private
+
+      def build(profile)
+        directory_name, basename = ENTRIES.fetch(profile.id) { raise_unknown_profile(profile) }
+        directory = File.join(RULES_ROOT, directory_name)
+        rule_set = RuleSet.new(
+          directory:,
+          stylesheet: File.join(directory, "#{basename}.xslt"),
+          code_db: File.join(directory, "#{basename}_codedb.xml")
+        )
+        ensure_readable!(rule_set, profile)
+      end
+
+      def ensure_readable!(rule_set, profile)
+        missing = missing_artifacts(rule_set)
+        return rule_set if missing.empty?
+
+        raise RulePackError.new(
+          "The Factur-X #{profile.id} Schematron rule pack is incomplete",
+          reason: :missing_artifacts,
+          profile: profile.id,
+          missing:
+        )
+      end
+
+      def missing_artifacts(rule_set)
+        %i[stylesheet code_db].reject { |name| readable?(rule_set.public_send(name)) }
+      end
+
+      def readable?(path)
+        File.file?(path) && File.readable?(path)
+      end
+
+      def raise_unknown_profile(profile)
+        raise RulePackError.new(
+          "No Schematron rule pack is registered for Factur-X profile #{profile.id.inspect}",
+          reason: :unknown_profile,
+          profile: profile.id
+        )
+      end
+    end
+  end
+end