saxon 0.2.2-java → 0.4.0-java

data/lib/saxon/xpath/executable.rb

@@ -1,59 +0,0 @@
-require_relative '../xdm_node'
-require_relative '../xdm_atomic_value'
-
-module Saxon
-  module XPath
-    # Represents a compiled XPath query ready to be executed
-    class Executable
-      # @return [XPath::StaticContext] the XPath's static context
-      attr_reader :static_context
-
-      # @api private
-      # @param s9_xpath_executable [net.sf.saxon.s9api.XPathExecutable] the
-      #   Saxon compiled XPath object
-      # @param static_context [XPath::StaticContext] the XPath's static
-      #   context
-      def initialize(s9_xpath_executable, static_context)
-        @s9_xpath_executable, @static_context = s9_xpath_executable, static_context
-      end
-
-      # Run the compiled query using a passed-in node as the context item.
-      # @param context_item [Saxon::XdmNode] the context item node
-      # @return [Saxon::XPath::Result] the result of the query as an
-      #   enumerable
-      def run(context_item, variables = {})
-        selector = to_java.load
-        selector.setContextItem(context_item.to_java)
-        variables.each do |qname_or_string, value|
-          selector.setVariable(static_context.resolve_variable_qname(qname_or_string).to_java, Saxon::XdmAtomicValue.create(value).to_java)
-        end
-        Result.new(selector.iterator)
-      end
-
-      # @return [net.sf.saxon.s9api.XPathExecutable] the underlying Saxon
-      #   <tt>XPathExecutable</tt>
-      def to_java
-        @s9_xpath_executable
-      end
-    end
-
-    # The result of executing an XPath query as an enumerable object
-    class Result
-      include Enumerable
-
-      # @api private
-      # @param result_iterator [java.util.Iterator] the result of calling
-      #   <tt>#iterator</tt> on a Saxon <tt>XPathSelector</tt>
-      def initialize(result_iterator)
-        @result_iterator = result_iterator
-      end
-
-      # Yields <tt>XdmNode</tt>s from the query result. If no block is passed,
-      # returns an <tt>Enumerator</tt> 
-      # @yieldparam xdm_node [Saxon::XdmNode] the name that is yielded
-      def each(&block)
-        @result_iterator.lazy.map { |s9_xdm_node| Saxon::XdmNode.new(s9_xdm_node) }.each(&block)
-      end
-    end
-  end
-end

data/lib/saxon/xpath/static_context.rb

@@ -1,161 +0,0 @@
-require_relative '../qname'
-require_relative './variable_declaration'
-module Saxon
-  module XPath
-    # Raised when an attempt to declare a variable is made using a string for
-    # the qname with a namespace prefix that has not been declared in the
-    # context yet
-    class MissingVariableNamespaceError < StandardError
-      def initialize(variable_name, prefix)
-        @variable_name, @prefix = variable_name, prefix
-      end
-
-      def to_s
-        "Namespace prefix ‘#{@prefix}’ for variable name ‘#{@variable_name}’ is not bound to a URI"
-      end
-    end
-
-    # Represents the static context for a compiled XPath. {StaticContext}s are immutable.
-    class StaticContext
-      # methods used by both {StaticContext} and {StaticContext::DSL}
-      module Common
-        # @param args [Hash]
-        # @option args [Hash<Saxon::QName => Saxon::XPath::VariableDeclaration>] :declared_variables Hash of declared variables
-        # @option args [Hash<String => String>] :declared_namespaces Hash of namespace bindings prefix => URI
-        # @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 = {})
-          @declared_variables = args.fetch(:declared_variables, {}).freeze
-          @declared_namespaces = args.fetch(:declared_namespaces, {}).freeze
-          @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
-          {
-            declared_namespaces: @declared_namespaces,
-            declared_variables: @declared_variables,
-            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 {XPath::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
-
-        # Bind prefixes to namespace URIs
-        #
-        # @param namespaces [Hash{String, Symbol => String}]
-        def namespace(namespaces = {})
-          @declared_namespaces = @declared_namespaces.merge(namespaces.transform_keys(&:to_s)).freeze
-        end
-
-        # Declare a XPath variable's existence in the context
-        #
-        # @param qname [String, Saxon::QName] The name of the variable as
-        # explicit QName or prefix:name string form. The string form requires
-        # the namespace prefix to have already been declared with {#namespace}
-        # @param type [String, Hash{Symbol => String, Class}, null] The type of the
-        # variable, either as a string using the same form as an XSLT
-        # <tt>as=""</tt> type definition, or as a hash of one key/value where
-        # that key is a Symbol taken from {Saxon::OccurenceIndicator} and the
-        # value is either a Class that {Saxon::ItemType} can convert to its
-        # XDM equivalent (e.g. {::String}), or a string that {Saxon::ItemType}
-        # can parse into an XDM type (e.g. <tt>xs:string</tthat
-        # {Saxon::ItemType} can parse into an XDM type (e.g.
-        # <tt>xs:string</tt> or <tt>element()</tt>).
-        # If it's nil, then the default <tt>item()*</tt> – anything – type declaration is used
-        def variable(qname, type = nil)
-          qname = resolve_variable_qname(qname)
-          @declared_variables = @declared_variables.merge({
-            qname => resolve_variable_declaration(qname, type)
-          }).freeze
-        end
-
-        private
-
-        def resolve_variable_qname(qname_or_string)
-          Saxon::QName.resolve(qname_or_string, @declared_namespaces)
-        end
-
-        def resolve_variable_type_decl(type_decl)
-          case type_decl
-          when String
-            occurence_char = type_decl[-1]
-            occurence = case occurence_char
-            when '?'
-              {zero_or_one: type_decl[0..-2]}
-            when '+'
-              {one_or_more: type_decl[0..-2]}
-            when '*'
-              {zero_or_more: type_decl[0..-2]}
-            else
-              {one: type_decl}
-            end
-          when Hash
-            type_decl
-          end
-        end
-
-        def resolve_variable_declaration(qname, type)
-          args_hash = resolve_variable_type_decl(type) || {}
-          args_hash[:qname] = qname
-          Saxon::XPath::VariableDeclaration.new(args_hash)
-        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::XPath::StaticContext] the static context created by the block
-      def self.define(block)
-        DSL.define(block)
-      end
-
-      attr_reader :declared_variables, :declared_namespaces, :default_collation
-
-      # @return [Saxon::QName]
-      # @overload resolve_variable_qname(qname)
-      #   returns the QName
-      #   @param qname_or_string [Saxon::QName] the name as a QName
-      # @overload resolve_variable_qname(string)
-      #   resolve the <tt>prefix:local_name</tt> string into a proper QName by
-      #   looking up the prefix in the {#declared_namespaces}
-      #   @param qname_or_string [String] the name as a string
-      def resolve_variable_qname(qname_or_string)
-        Resolver.resolve_variable_qname(qname_or_string, declared_namespaces)
-      end
-
-      def define(block)
-        DSL.define(block, args_hash)
-      end
-    end
-  end
-end

data/lib/saxon/xpath/variable_declaration.rb

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

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

@@ -1,70 +0,0 @@
-require 'forwardable'
-require_relative './evaluation_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)
-        evaluation_context = XSLT::EvaluationContext.define(block)
-        new(processor.to_java, evaluation_context)
-      end
-
-      extend Forwardable
-
-      attr_reader :evaluation_context
-      private :evaluation_context
-
-      # @api private
-      # @param s9_processor [net.sf.saxon.s9api.Processor] the Saxon
-      #   <tt>Processor</tt> to wrap
-      # @param evaluation_context [Saxon::XSLT::EvaluationContext] the static context
-      #   XPaths compiled using this compiler will have
-      def initialize(s9_processor, evaluation_context)
-        @s9_processor, @evaluation_context = s9_processor, evaluation_context
-      end
-
-      def_delegators :evaluation_context, :default_collation, :static_parameters, :global_parameters, :initial_template_parameters, :initial_template_tunnel_parameters
-      # @!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
-      # @!attribute [r] static_parameters
-      #   @return [Hash<Saxon::QName => Saxon::XdmValue, Saxon::XdmNode,
-      #   Saxon::XdmAtomicValue>] parameters required at compile time as QName => value hash
-
-      # @param expression [Saxon::Source] the Source to compile
-      # @return [Saxon::XSLT::Executable] the executable stylesheet
-      def compile(source, &block)
-        Saxon::XSLT::Executable.new(
-          new_compiler.compile(source.to_java),
-          evaluation_context.define(block)
-        )
-      end
-
-      def create(&block)
-        new_evaluation_context = evaluation_context.define(block)
-        self.class.new(@s9_processor, new_evaluation_context)
-      end
-
-      private
-
-      def new_compiler
-        compiler = @s9_processor.newXsltCompiler
-        compiler.declareDefaultCollation(default_collation) unless default_collation.nil?
-        static_parameters.each do |qname, value|
-          compiler.setParameter(qname.to_java, value.to_java)
-        end
-        compiler
-      end
-    end
-  end
-end

data/lib/saxon/xslt/evaluation_context.rb

@@ -1,174 +0,0 @@
-require 'set'
-require_relative '../qname'
-
-module Saxon
-  module XSLT
-    # Represents the evaluation context for an XSLT compiler, and stylesheets
-    # compiled using one. {EvaluationContext}s are immutable.
-    class EvaluationContext
-      # methods used by both {EvaluationContext} and {EvaluationContext::DSL}
-      module Common
-        # @param args [Hash]
-        # @option args [String] default_collation URI of the default collation
-        # @option args [Hash<String,Symbol,Saxon::QName =>
-        #   Object,Saxon::XdmValue] static_parameters Hash of QName => value
-        #   bindings for static (compile-time) parameters for this compiler
-        def initialize(args = {})
-          @default_collation = args.fetch(:default_collation, nil).freeze
-          @static_parameters = args.fetch(:static_parameters, {}).freeze
-          @global_parameters = args.fetch(:global_parameters, {}).freeze
-          @initial_template_parameters = args.fetch(:initial_template_parameters, {}).freeze
-          @initial_template_tunnel_parameters = args.fetch(:initial_template_tunnel_parameters, {}).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
-          check_for_clashing_parameters!
-          {
-            default_collation: @default_collation,
-            static_parameters: @static_parameters,
-            global_parameters: @global_parameters,
-            initial_template_parameters: @initial_template_parameters,
-            initial_template_tunnel_parameters: @initial_template_tunnel_parameters
-          }
-        end
-
-        private
-
-        def check_for_clashing_parameters!
-          @checked ||= begin
-            if Set.new(@static_parameters.keys).intersect?(Set.new(@global_parameters.keys))
-              raise GlobalAndStaticParameterClashError
-            else
-              true
-            end
-          end
-        end
-      end
-
-      # Provides the hooks for constructing a {EvaluationContext} 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 {EvaluationContext} with the results
-        # @param block [Proc] a Proc/lambda (or <tt>to_proc</tt>'d containing DSL calls
-        # @return [Saxon::XSLT::EvaluationContext]
-        def self.define(block, args = {})
-          dsl = new(args)
-          dsl.instance_exec(&block) unless block.nil?
-          EvaluationContext.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
-
-        # Set the value for static parameters (those that must be known at
-        # compile-time to avoid an error), as a hash of QName => Value pairs.
-        # Parameter QNames can be declared as Strings or Symbols if they are
-        # not in any namespace, otherwise an explicit {Saxon::QName} must be
-        # used. Values can be provided as explicit XdmValues:
-        # {Saxon::XdmValue}, {Saxon::XdmNode}, and {Saxon::XdmAtomicValue}, or
-        # as Ruby objects which will be converted to {Saxon::XdmAtomicValue}s
-        # in the usual way.
-        #
-        # @param parameters [Hash<String,Symbol,Saxon::QName =>
-        #   Object,Saxon::XdmValue>] Hash of QName => value
-        def static_parameters(parameters = {})
-          @static_parameters = @static_parameters.merge(process_parameters(parameters)).freeze
-        end
-
-        # Set the values for global parameters (those that are available to all templates and functions).
-        #
-        # @see EvaluationContext#static_parameters for details of the argument format
-        #
-        # @param parameters [Hash<String,Symbol,Saxon::QName =>
-        #   Object,Saxon::XdmValue>] Hash of QName => value
-        def global_parameters(parameters = {})
-          @global_parameters = @global_parameters.merge(process_parameters(parameters)).freeze
-        end
-
-        # Set the values for parameters made available only to the initial
-        # template invoked (either via apply_templates or call_template),
-        # effectively as if <tt><xsl:with-param tunnel="no"></tt> was being used.
-        #
-        # @see EvaluationContext#static_parameters for details of the argument format
-        #
-        # @param parameters [Hash<String,Symbol,Saxon::QName =>
-        #   Object,Saxon::XdmValue>] Hash of QName => value
-        def initial_template_parameters(parameters = {})
-          @initial_template_parameters = @initial_template_parameters.merge(process_parameters(parameters))
-        end
-
-        # Set the values for tunneling parameters made available only to the initial
-        # template invoked (either via apply_templates or call_template),
-        # effectively as if <tt><xsl:with-param tunnel="yes"></tt> was being used.
-        #
-        # @see EvaluationContext#static_parameters for details of the argument format
-        #
-        # @param parameters [Hash<String,Symbol,Saxon::QName =>
-        #   Object,Saxon::XdmValue>] Hash of QName => value
-        def initial_template_tunnel_parameters(parameters = {})
-          @initial_template_tunnel_parameters = @initial_template_tunnel_parameters.merge(process_parameters(parameters))
-        end
-
-        private
-
-        def process_parameters(parameters)
-          XSLT::ParameterHelper.process_parameters(parameters)
-        end
-      end
-
-      include Common
-
-      # Executes the Proc/lambda passed in with a new instance of
-      # {EvaluationContext} 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::EvaluationContext] the static context created by the block
-      def self.define(block)
-        DSL.define(block)
-      end
-
-      attr_reader :default_collation, :static_parameters, :global_parameters, :initial_template_parameters, :initial_template_tunnel_parameters
-
-      def define(block)
-        block.nil? ? self : DSL.define(block, args_hash)
-      end
-    end
-
-    class GlobalAndStaticParameterClashError < StandardError
-    end
-
-    module ParameterHelper
-      def self.process_parameters(parameters)
-        Hash[parameters.map { |qname, value|
-          [Saxon::QName.resolve(qname), process_xdm_value(value)]
-        }]
-      end
-
-      def self.process_xdm_value(value)
-        case value
-        when Saxon::XdmValue, Saxon::XdmNode, Saxon::XdmAtomicValue
-          value
-        else
-          Saxon::XdmAtomicValue.create(value)
-        end
-      end
-
-      def self.to_java(parameters)
-        Hash[parameters.map { |k,v| [k.to_java, v.to_java] }].to_java
-      end
-    end
-  end
-end