saxonc-libs 12.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fdef4a62ea21f77af5320cf03e7111e0825fd4ae6f48dfa2d03d8031ae943b2
+  data.tar.gz: de665f07f3d5e79e727259d70dcec972ca68674da06013b4d0ea2abcf5546e34
+SHA512:
+  metadata.gz: ce93dc5784f49652fc5ef67f8644a60f88f8b0a3fc0746901183998e53a878f7d65316213f0908bec62201dca369eb9346c3d99092339ff00ba18d58cbdab077
+  data.tar.gz: 73ba3950646c92563d8a9ec063808f4d84bf92269615363d3c0166c4bb152c14165839a44a145c183c88f489bfae06f64757acefd58ef62d0b3791a451dcccff

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2025 SaxonC Ruby Contributors
+
+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/README.md

@@ -0,0 +1,73 @@
+# SaxonC Libs
+
+SaxonC Libs packages the pre-built SaxonC native libraries for use
+from Ruby gems such as [`saxonc`](../saxon-rb). It offers a single
+command that downloads the official SaxonC distribution for the
+current platform, extracts the `lib`, `include`, and `bin` artifacts,
+and stores them in a predictable location other gems can depend on.
+
+## Versioning
+
+This gem mirrors SaxonC releases using the pattern
+`<saxon-version>.<packaging-patch>`. For example, version `12.9.0`
+wraps SaxonC `12.9` with a first packaging revision. Whenever SaxonC
+publishes a new point release, bump the first two segments and reset
+the packaging patch to zero.
+
+## Usage
+
+```sh
+gem install saxonc-libs
+saxonc-libs install --target vendor/saxonc --edition he
+```
+
+The install command will:
+
+1. Detect the current platform (macOS ARM64, macOS Intel, Linux
+   x86_64, or Windows x86_64 for the initial release).
+2. Read the release manifest for the bundled SaxonC version and
+   edition (`he`, `pe`, or `ee`).
+3. Download the official SaxonC zip archive for that platform.
+4. Extract the relevant files into
+   `vendor/saxonc/<edition>/<platform>`.
+5. Write a manifest JSON file describing the extracted payload.
+
+The CLI accepts `--edition` (defaults to `he`) and `--force` (to
+re-download even if a cached copy exists), which is handy when testing
+different SaxonC editions or refreshing a corrupted cache.
+
+Other gems (such as `saxonc`) can then look up the installation path via:
+
+```ruby
+require "saxonc/libs"
+saxon_home = SaxonC::Libs.install(edition: :he)
+# => /path/to/vendor/saxonc/he/macos-arm64
+```
+
+## Release manifests
+
+The `releases.yml` file in the repo root describes where to download
+each platform artifact. The installer refuses to run unless a manifest
+entry exists for the detected platform and edition. Publishing a new
+packaging release typically involves:
+
+1. Adding/updating the relevant section inside `releases.yml`.
+2. Recording the download URL and SHA256 checksum for each platform.
+3. Updating `lib/saxonc/libs/version.rb` with the new version.
+4. Releasing the gem.
+
+You can populate missing SHA256 values automatically via
+`script/fill_checksums.rb`. Run it without options to download each
+archive and compute its digest, or pass `--source-dir` to point at a
+directory containing previously downloaded zips (useful for PE/EE
+editions that require credentials):
+
+```sh
+bundle exec ruby script/fill_checksums.rb --source-dir ~/Downloads/saxonc
+```
+
+## License
+
+This helper gem is distributed under the MIT license. The downloaded
+SaxonC binaries remain subject to Saxonica's license terms; the
+installer copies their notices alongside the extracted artifacts.

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/exe/saxonc-libs

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "saxonc/libs"
+
+SaxonC::Libs::CLI.start(ARGV)

data/lib/saxonc/libs/cli.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module SaxonC
+  module Libs
+    # Very small command-line interface that exposes the installer.
+    class CLI
+      def self.start(argv)
+        new(argv).run
+      end
+
+      def initialize(argv)
+        @argv = argv.dup
+        @options = { target: Installer.default_installation_dir, edition: :he, force: false }
+      end
+
+      def run
+        parser.parse!(@argv)
+        command = @argv.shift || "install"
+
+        case command
+        when "install"
+          Installer.new(target: @options[:target], edition: @options[:edition]).install(force: @options[:force])
+        else
+          warn "Unknown command: #{command}"
+          warn parser
+          exit 1
+        end
+      end
+
+      private
+
+      def parser
+        @parser ||= OptionParser.new do |opts|
+          opts.banner = "Usage: saxonc-libs [install] [options]"
+          opts.on("-t", "--target=DIR", "Directory to extract the runtime into") do |dir|
+            @options[:target] = File.expand_path(dir)
+          end
+          opts.on("-e", "--edition=EDITION", "Saxon edition to install (he, pe, ee)") do |value|
+            @options[:edition] = value.downcase.to_sym
+          end
+          opts.on("-f", "--force", "Re-download even if already installed") do
+            @options[:force] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/saxonc/libs/download.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "tempfile"
+require "digest"
+
+module SaxonC
+  module Libs
+    # Streams a remote archive to disk and verifies its checksum.
+    class Download
+      CHUNK_SIZE = 1024 * 1024
+
+      def initialize(url, checksum: nil)
+        @url = URI.parse(url)
+        @checksum = checksum
+      end
+
+      def fetch
+        tempfile = Tempfile.new(["saxonc", File.extname(@url.path)])
+        tempfile.binmode
+        digest = Digest::SHA256.new if @checksum
+
+        Net::HTTP.start(@url.host, @url.port, use_ssl: @url.scheme == "https") do |http|
+          request = Net::HTTP::Get.new(@url)
+          http.request(request) do |response|
+            unless response.is_a?(Net::HTTPSuccess)
+              raise "Failed to download #{@url} (#{response.code})"
+            end
+
+            response.read_body do |chunk|
+              tempfile.write(chunk)
+              digest&.update(chunk)
+            end
+          end
+        end
+
+        tempfile.flush
+        tempfile.rewind
+        verify_checksum(digest)
+        path = tempfile.path
+        tempfile.close
+        path
+      ensure
+        tempfile&.close unless tempfile.nil? || tempfile.closed?
+      end
+
+      private
+
+      def verify_checksum(digest)
+        return unless @checksum
+
+        actual = digest.hexdigest
+        return if actual == @checksum.downcase
+
+        raise "Checksum mismatch for #{@url}: expected #{@checksum}, got #{actual}"
+      end
+    end
+  end
+end

data/lib/saxonc/libs/installer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "json"
+require "time"
+require "zip"
+
+require_relative "platform"
+require_relative "releases"
+require_relative "download"
+
+module SaxonC
+  module Libs
+    # Coordinates download and extraction of the SaxonC distribution release.
+    class Installer
+      attr_reader :target_dir, :platform, :release, :edition
+
+      def self.default_installation_dir
+        File.expand_path("../../vendor/saxonc", __dir__)
+      end
+
+      def initialize(target: self.class.default_installation_dir, platform: Platform.detect, edition: :he)
+        @target_dir = File.expand_path(target)
+        @platform = platform
+        @edition = edition.to_sym
+        @release = Releases.new(@edition)
+      end
+
+      def install(force: false)
+        return platform_dir if installed? && !force
+
+        FileUtils.mkdir_p(File.dirname(platform_dir))
+        release = release.release_for(platform.key)
+        url = release.fetch("url")
+        checksum = release["sha256"]
+
+        puts "Downloading #{url}..."
+        release_path = Download.new(url, checksum: checksum).fetch
+        puts "Extracting to #{platform_dir}..."
+        extract_release(release_path)
+        File.delete(release_path) if File.exist?(release_path)
+        write_release(release)
+        puts "SaxonC runtime ready in #{platform_dir}"
+        platform_dir
+      end
+
+      def installed?
+        Dir.exist?(File.join(platform_dir, "lib")) && File.exist?(File.join(platform_dir, "release.json"))
+      end
+
+      def platform_dir
+        File.join(target_dir, edition.to_s, platform.key)
+      end
+
+      private
+
+      def extract_release(release_path)
+        FileUtils.rm_rf(platform_dir)
+        FileUtils.mkdir_p(platform_dir)
+
+        Zip::File.open(release_path) do |zip_file|
+          zip_file.each do |entry|
+            next unless entry.file?
+
+            relative_path = case entry.name
+                            when /^SaxonCHE\//
+                              entry.name.sub(/^SaxonCHE\//, "")
+                            when /^notices\//
+                              entry.name
+                            when /^README/i
+                              entry.name
+                            else
+                              next
+                            end
+
+            next if relative_path.empty?
+
+            destination = File.join(platform_dir, relative_path)
+            FileUtils.mkdir_p(File.dirname(destination))
+            entry.extract(destination) { true }
+          end
+        end
+      end
+
+      def write_release(release)
+        release_data = {
+          platform: platform.key,
+          saxon_version: SaxonC::Libs::SAXON_VERSION,
+          edition: edition.to_s,
+          release_url: release.fetch("url"),
+          extracted_at: Time.now.utc.iso8601
+        }
+
+        File.write(File.join(platform_dir, "release.json"), JSON.pretty_generate(release_data))
+      end
+    end
+  end
+end

data/lib/saxonc/libs/platform.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+
+module SaxonC
+  module Libs
+    # Detects and normalizes the current runtime platform.
+    class Platform
+      PLATFORM_MAP = {
+        "macos-arm64" => ->(os, cpu) { os =~ /darwin/ && cpu =~ /arm|aarch64/ },
+        "macos-x86_64" => ->(os, cpu) { os =~ /darwin/ && cpu =~ /x86_64|amd64/ },
+        "linux-x86_64" => ->(os, cpu) { os =~ /linux/ && cpu =~ /x86_64|amd64/ },
+        "windows-x86_64" => ->(os, cpu) { os =~ /mswin|mingw|cygwin/ && cpu =~ /x86_64|amd64/ }
+      }.freeze
+
+      attr_reader :key
+
+      def self.detect
+        host_os = RbConfig::CONFIG["host_os"].downcase
+        host_cpu = RbConfig::CONFIG["host_cpu"].downcase
+
+        key = PLATFORM_MAP.find { |_name, predicate| predicate.call(host_os, host_cpu) }&.first
+        raise "Unsupported SaxonC platform for #{host_os}/#{host_cpu}" unless key
+
+        new(key)
+      end
+
+      def initialize(key)
+        @key = key
+      end
+
+      def to_s
+        key
+      end
+    end
+  end
+end

data/lib/saxonc/libs/releases.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "pathname"
+
+module SaxonC
+  module Libs
+    # Loads the releases.yml describing where to download platform release.
+    class Releases
+      attr_reader :saxon_version, :saxon_edition
+
+      def initialize(saxon_edition = :he)
+        @saxon_edition = saxon_edition.to_sym
+      end
+
+      def archive_for(platform_key)
+        data = releases_data
+        data_for_edition = data.fetch(saxon_edition) do
+          raise KeyError, "No release defined for Saxon edition #{saxon_edition} in #{release_path}"
+        end
+        data_for_edition.fetch(platform_key) do
+          raise KeyError, "No archive defined for #{platform_key} in #{release_path}"
+        end
+      end
+
+      def version
+        @saxon_version ||= releases_data.fetch("version")
+      end
+
+      private
+
+      def releases_data
+        @releases_data ||= begin
+          unless releases_path.exist?
+            raise IOError, "Missing releases: #{releases_path}"
+          end
+
+          YAML.load_file(releases_path)
+        end
+      end
+
+      def releases_path
+        Pathname.new(__dir__).join("..", "..", "..", "releases.yml").expand_path
+      end
+    end
+  end
+end

data/lib/saxonc/libs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module SaxonC
+  module Libs
+    VERSION = "12.9.1"
+    SAXON_VERSION = VERSION.split(".")[0..1].join(".")
+  end
+end

data/lib/saxonc/libs.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "libs/version"
+require_relative "libs/installer"
+require_relative "libs/cli"
+
+module SaxonC
+  # Top-level namespace for the runtime helper gem.
+  module Libs
+    class << self
+      def install(**options)
+        Installer.new(**options).install
+      end
+
+      def ensure_installed(**options)
+        install(**options)
+      end
+
+      def find_installation(edition: :he, target: Installer.default_installation_dir, platform: nil)
+        resolved_platform = platform || SaxonC::Libs::Platform.detect
+        installer = Installer.new(target: target, edition: edition, platform: resolved_platform)
+        installer.platform_dir if installer.installed?
+      end
+
+      def default_installation_dir
+        Installer.default_installation_dir
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: saxonc-libs
+version: !ruby/object:Gem::Version
+  version: 12.9.1
+platform: ruby
+authors:
+- Jakob Kofoed Janot
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Downloads and installs the official SaxonC runtime files so other Ruby
+  gems can link against them.
+email:
+- jakob@janot.dk
+executables:
+- saxonc-libs
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/saxonc-libs
+- lib/saxonc/libs.rb
+- lib/saxonc/libs/cli.rb
+- lib/saxonc/libs/download.rb
+- lib/saxonc/libs/installer.rb
+- lib/saxonc/libs/platform.rb
+- lib/saxonc/libs/releases.rb
+- lib/saxonc/libs/version.rb
+homepage: https://github.com/jakobjanot/ruby-saxonc-libs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jakobjanot/ruby-saxonc-libs
+  source_code_uri: https://github.com/jakobjanot/ruby-saxonc-libs
+  changelog_uri: https://github.com/jakobjanot/ruby-saxonc-libs/blob/main/saxonc-libs/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Platform-specific SaxonC binaries for Ruby projects
+test_files: []