saxon 0.1.0-java

data/lib/saxon/xpath/variable_declaration.rb

@@ -0,0 +1,68 @@
+require_relative '../item_type'
+require_relative '../occurrence_indicator'
+
+module Saxon
+  module XPath
+    # Represents an XPath variable declaration in the static context of a compiled XPath, providing an idiomatic Ruby way to deal with these.
+    class VariableDeclaration
+      # @return [Saxon::QName]
+      attr_reader :qname
+      # @return [Saxon::ItemType]
+      attr_reader :item_type
+      # @return [net.sf.saxon.s9api.OccurrenceIndicator]
+      attr_reader :occurrences
+
+      # @param opts [Hash]
+      # @option opts [Saxon::QName] :qname The name of the variable as a {Saxon::QName}
+      def initialize(opts = {})
+        raise VariableDeclarationError, opts.keys if opts.keys.length > 2
+        @qname = opts.fetch(:qname)
+        @item_type, @occurrences = extract_type_decl(opts.reject { |k, v| k == :qname })
+      end
+
+      # VariableDeclarations compare equal if their qname, item_type, and occurrences are equal
+      # @param other [Saxon::VariableDeclaration]
+      # @return [Boolean]
+      def ==(other)
+        VariableDeclaration === other && qname == other.qname && item_type == other.item_type && occurrences == other.occurrences
+      end
+
+      # @api private
+      def compiler_args
+        [qname.to_java, item_type.to_java, occurrences]
+      end
+
+      private
+
+      def self.valid_opt_keys
+        @valid_opt_keys ||= [:qname] + Saxon::OccurrenceIndicator.indicator_names
+      end
+
+      def extract_type_decl(type_decl)
+        raise VariableDeclarationError, type_decl.keys if type_decl.length > 1
+        unless (type_decl.keys - Saxon::OccurrenceIndicator.indicator_names).empty?
+          raise VariableDeclarationError, type_decl.keys
+        end
+
+        return [Saxon::ItemType.get_type('item()'), Saxon::OccurrenceIndicator.zero_or_more] if type_decl.empty?
+        occurrence, type = type_decl.first
+        [Saxon::ItemType.get_type(type), Saxon::OccurrenceIndicator.send(occurrence)]
+      end
+    end
+
+    # Raised when an attempt to declare a variable is made using an occurrence
+    # indicator that does not exist
+    class VariableDeclarationError < StandardError
+      attr_reader :keys
+
+      def initialize(keys)
+        @keys = keys
+      end
+
+      # reports allowable occurrence indicator keys and what was actually passed in
+      def to_s
+        "requires :qname, and optionally one of #{Saxon::OccurrenceIndicator.indicator_names}, was passed #{keys.join(', ')}"
+      end
+    end
+  end
+end

data/lib/saxon/xslt.rb

@@ -0,0 +1,8 @@
+require_relative './xslt/compiler'
+
+module Saxon
+  # Classes for compiling, configuring, and executing XSLT transformations
+  # against XDM nodes or documents
+  module XSLT
+  end
+end

data/lib/saxon/xslt/compiler.rb

@@ -0,0 +1,61 @@
+require 'forwardable'
+require_relative './static_context'
+# require_relative './executable'
+
+module Saxon
+  module XSLT
+    # Compiles XSLT stylesheets so they can be executed
+    class Compiler
+      # Create a new <tt>XSLT::Compiler</tt> using the supplied Processor.
+      # Passing a block gives access to a DSL for setting up the compiler's
+      # static context.
+      #
+      # @param processor [Saxon::Processor] the {Saxon::Processor} to use
+      # @yield An XSLT compiler DSL block
+      # @return [Saxon::XSLT::Compiler] the new compiler instance
+      def self.create(processor, &block)
+        static_context = XSLT::StaticContext.define(block)
+        new(processor.to_java, static_context)
+      end
+
+      extend Forwardable
+
+      attr_reader :static_context
+      private :static_context
+
+      # @api private
+      # @param s9_processor [net.sf.saxon.s9api.Processor] the Saxon
+      #   <tt>Processor</tt> to wrap
+      # @param static_context [Saxon::XPath::StaticContext] the static context
+      #   XPaths compiled using this compiler will have
+      def initialize(s9_processor, static_context)
+        @s9_processor, @static_context = s9_processor, static_context
+      end
+
+      def_delegators :static_context, :default_collation
+      # @!attribute [r] declared_collations
+      #   @return [Hash<String => java.text.Collator>] declared collations as URI => Collator hash
+      # @!attribute [r] default_collation
+      #   @return [String] the URI of the default declared collation
+
+      # @param expression [String] the  expression to compile
+      # @return [Saxon::XSLT::Executable] the executable query
+      def compile(expression)
+        Saxon::XSLT::Executable.new(new_compiler.compile(expression), static_context)
+      end
+
+      def create(&block)
+        new_static_context = static_context.define(block)
+        self.class.new(@s9_processor, new_static_context)
+      end
+
+      private
+
+      def new_compiler
+        compiler = @s9_processor.newXsltCompiler
+        compiler.declareDefaultCollation(default_collation) unless default_collation.nil?
+        compiler
+      end
+    end
+  end
+end

data/lib/saxon/xslt/executable.rb

@@ -0,0 +1,127 @@
+require_relative 'static_context'
+require_relative '../serializer'
+require_relative '../xdm_value'
+require_relative '../qname'
+
+module Saxon
+  module XSLT
+    # Represents a compiled XPaGth query ready to be executed
+    class Executable
+      # @return [XSLT::StaticContext] the XPath's static context
+      attr_reader :static_context
+
+      # @api private
+      # @param s9_xslt_executable [net.sf.saxon.s9api.XsltExecutable] the
+      #   Saxon compiled XPath object
+      # @param static_context [XPath::StaticContext] the XPath's static
+      #   context
+      def initialize(s9_xslt_executable, static_context)
+        @s9_xslt_executable, @static_context = s9_xslt_executable, static_context
+      end
+
+      def apply_templates(source, opts = {})
+        transformation(opts).apply_templates(source)
+      end
+
+      def call_template(template_name, opts = {})
+        transformation(opts).call_template(template_name)
+      end
+
+      # @return [net.sf.saxon.s9api.XsltExecutable] the underlying Saxon
+      #   <tt>XsltExecutable</tt>
+      def to_java
+        @s9_xslt_executable
+      end
+
+      private
+
+      def transformation(opts)
+        Transformation.new(opts.merge({
+          s9_transformer: @s9_xslt_executable.load30,
+        }))
+      end
+    end
+
+    class Result
+      attr_reader :xdm_value
+
+      def initialize(xdm_value, s9_transformer)
+        @xdm_value, @s9_transformer = xdm_value, s9_transformer
+      end
+
+      def to_s
+        serializer = Serializer.new(@s9_transformer.newSerializer)
+        serializer.serialize(xdm_value.to_java)
+      end
+    end
+
+    class Transformation
+      attr_reader :s9_transformer, :opts
+
+      def initialize(args)
+        @s9_transformer = args.fetch(:s9_transformer)
+        @destination = args.fetch(:destination, nil)
+        @opts = args.reject { |opt, _|
+          [:s9_transformer, :destination].include?(opt)
+        }
+        @raw = false
+      end
+
+      def apply_templates(source)
+        transformation_result(:applyTemplates, source)
+      end
+
+      def call_template(template_name)
+        transformation_result(:callTemplate, resolve_qname(template_name))
+      end
+
+      private
+
+      def transformation_result(invocation_method, invocation_arg)
+        set_opts!
+        transformer_args = [invocation_method, invocation_arg.to_java, destination].compact
+        Result.new(result_xdm_value(s9_transformer.send(*transformer_args)), s9_transformer)
+      end
+
+      def result_xdm_value(transformer_return_value)
+        XdmValue.wrap_s9_xdm_value(
+          transformer_return_value.nil? ? destination.getXdmNode : transformer_return_value
+        )
+      end
+
+      def destination
+        @destination ||= begin
+          Saxon::S9API::XdmDestination.new unless raw?
+        end
+      end
+
+      def set_opts!
+        opts.each do |opt, value|
+          send(opt, value)
+        end
+      end
+
+      def raw(value)
+        @raw = value
+      end
+
+      def raw?
+        @raw
+      end
+
+      def mode(mode_name)
+        s9_transformer.setInitialMode(resolve_qname(mode_name).to_java)
+      end
+
+      def resolve_qname(qname)
+        case qname
+        when Saxon::QName
+          qname
+        else
+          raise Saxon::QName::PrefixedStringWithoutNSURIError if qname.to_s.include?(':')
+          Saxon::QName.create(local_name: qname.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/saxon/xslt/static_context.rb

@@ -0,0 +1,69 @@
+require_relative '../qname'
+module Saxon
+  module XSLT
+    # Represents the static context for an XSLT compiler. {StaticContext}s are immutable.
+    class StaticContext
+      # methods used by both {StaticContext} and {StaticContext::DSL}
+      module Common
+        # @param args [Hash]
+        # @option args [Hash<String => java.text.Collator>] :declared_collations Hash of URI => Collator bindings
+        # @option args [String] :default_collation URI of the default collation
+        def initialize(args = {})
+          @default_collation = args.fetch(:default_collation, nil).freeze
+        end
+
+        # returns the context details in a hash suitable for initializing a new one
+        # @return [Hash<Symbol => Hash,null>] the args hash
+        def args_hash
+          {
+            default_collation: @default_collation
+          }
+        end
+      end
+
+      # Provides the hooks for constructing a {StaticContext} with a DSL.
+      # @api private
+      class DSL
+        include Common
+
+        # Create an instance based on the args hash, and execute the passed in Proc/lambda against it using <tt>#instance_exec</tt> and return a
+        # new {StaticContext} with the results
+        # @param block [Proc] a Proc/lambda (or <tt>to_proc</tt>'d containing DSL calls
+        # @return [Saxon::XPath::StaticContext]
+        def self.define(block, args = {})
+          dsl = new(args)
+          dsl.instance_exec(&block) unless block.nil?
+          StaticContext.new(dsl.args_hash)
+        end
+
+        # Set the default Collation to use. This should be one of the special
+        # collation URIs Saxon recognises, or one that has been registered
+        # using Saxon::Processor#declare_collations on the Processor that
+        # created the {XSLT::Compiler} this context is for.
+        #
+        # @param collation_uri [String] The URI of the Collation to set as the default
+        def default_collation(collation_uri)
+          @default_collation = collation_uri
+        end
+      end
+
+      include Common
+
+      # Executes the Proc/lambda passed in with a new instance of
+      # {StaticContext} as <tt>self</tt>, allowing the DSL methods to be
+      # called in a DSL-ish way
+      #
+      # @param block [Proc] the block of DSL calls to be executed
+      # @return [Saxon::XSLT::StaticContext] the static context created by the block
+      def self.define(block)
+        DSL.define(block)
+      end
+
+      attr_reader :default_collation
+
+      def define(block)
+        DSL.define(block, args_hash)
+      end
+    end
+  end
+end

data/lib/saxon_jars.rb

@@ -0,0 +1,10 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+begin
+  require 'jar_dependencies'
+rescue LoadError
+  require 'net/sf/saxon/Saxon-HE/9.9.1-2/Saxon-HE-9.9.1-2.jar'
+end
+
+if defined? Jars
+  require_jar 'net.sf.saxon', 'Saxon-HE', '9.9.1-2'
+end

data/saxon.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saxon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'saxon'
+  spec.version       = Saxon::VERSION
+  spec.authors       = ['Matt Patterson']
+  spec.email         = ['matt@werkstatt.io']
+
+  spec.description   = %q{Wraps the Saxon 9.9 XML and XSLT library so you can process, transform, query, and generate XML documents using XSLT 3, XQuery, and XPath 3.1. The HE open-source version is bundled, but you can use the paid-for PE and EE versions of the Java library with this gem as well.
+
+It aims to provide an idiomatic Ruby wrapper around all of Saxon's features.}
+  spec.summary       = %q{Saxon 9.9 for JRuby, with an idiomatic Ruby API}
+  spec.homepage      = "https://github.com/fidothe/saxon-rb"
+  spec.license       = 'MIT'
+  spec.platform      = 'java'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.requirements << 'jar net.sf.saxon, Saxon-HE, 9.9.1-2'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'jar-dependencies'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'addressable', '~> 2.4.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.2'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: saxon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: java
+authors:
+- Matt Patterson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2019-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  name: vcr
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  name: addressable
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  name: webmock
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  name: yard
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: |-
+  Wraps the Saxon 9.9 XML and XSLT library so you can process, transform, query, and generate XML documents using XSLT 3, XQuery, and XPath 3.1. The HE open-source version is bundled, but you can use the paid-for PE and EE versions of the Java library with this gem as well.
+
+  It aims to provide an idiomatic Ruby wrapper around all of Saxon's features.
+email:
+- matt@werkstatt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net/sf/saxon/Saxon-HE/9.9.1-2/Saxon-HE-9.9.1-2.jar
+- lib/saxon.rb
+- lib/saxon/axis_iterator.rb
+- lib/saxon/configuration.rb
+- lib/saxon/document_builder.rb
+- lib/saxon/item_type.rb
+- lib/saxon/jaxp.rb
+- lib/saxon/loader.rb
+- lib/saxon/occurrence_indicator.rb
+- lib/saxon/parse_options.rb
+- lib/saxon/processor.rb
+- lib/saxon/qname.rb
+- lib/saxon/s9api.rb
+- lib/saxon/serializer.rb
+- lib/saxon/source.rb
+- lib/saxon/version.rb
+- lib/saxon/xdm_atomic_value.rb
+- lib/saxon/xdm_node.rb
+- lib/saxon/xdm_value.rb
+- lib/saxon/xpath.rb
+- lib/saxon/xpath/compiler.rb
+- lib/saxon/xpath/executable.rb
+- lib/saxon/xpath/static_context.rb
+- lib/saxon/xpath/variable_declaration.rb
+- lib/saxon/xslt.rb
+- lib/saxon/xslt/compiler.rb
+- lib/saxon/xslt/executable.rb
+- lib/saxon/xslt/static_context.rb
+- lib/saxon_jars.rb
+- saxon.gemspec
+homepage: https://github.com/fidothe/saxon-rb
+licenses:
+- MIT
+metadata: {}
+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:
+- jar net.sf.saxon, Saxon-HE, 9.9.1-2
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Saxon 9.9 for JRuby, with an idiomatic Ruby API
+test_files: []