saxon-xslt 0.8.1-java → 0.8.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78d51bc1d1ad929a2a3a9fdfd306d393a071b79f
-  data.tar.gz: f617460d59c5c03e8dea14b09a0b7feee40fb04b
+  metadata.gz: 30d7250ed416d25ff3453a50b044a4c9fb5f9616
+  data.tar.gz: 8510336f672dfa823ac396c433b7427c2b234bc8
 SHA512:
-  metadata.gz: 9c7936845c41ddf3bd624fcb807e552a4b5c593cb29d98fcdde11088661d976be956e2aef5d2dbc14a662ff032333f02e331daaeeef7c36cb13f791f1e592806
-  data.tar.gz: de3633e9baf0ce519f6c1888a6eb7e136d971066c1e7e8fa08481452d7ac3ad0eea469184babf28512a7730ac7bc5f12941ee3133604a49100d67e731c945a75
+  metadata.gz: e2cf95510646c2b98f558ee08f134e7069a9c6e9362f62fa0cc2c27e0ccedeb58f1c6ff70ac8a698700b441b3f71560ef676362472f9305afae84d52011a1d37
+  data.tar.gz: 4c01b6dceb736867f58ac4498e8ad7f6afdedf3b8e55979c41bbe2fcb5a794d504f747731676a2cac0818f7278da2fa881d8667ee0c013e8311e69e8bfd84f36

data/README.md

@@ -1,8 +1,8 @@
 # Saxon::Xslt
 
-Wraps the Saxon 9 HE XSLT processor Java API so it's easy to use from your JRuby project, with an API modelled on Nokogiri's.
+Wraps the Saxon 9 XSLT processor Java API so it's easy to use from your JRuby project, with an API modelled on Nokogiri's.
 
-Saxon HE is a Java library, so saxon-xslt only runs under JRuby.
+Saxon is a Java library, so saxon-xslt only runs under JRuby.
 
 [![Gem Version](https://badge.fury.io/rb/saxon-xslt.svg)](http://badge.fury.io/rb/saxon-xslt)
 [![Build Status](https://travis-ci.org/fidothe/saxon-xslt.png)](https://travis-ci.org/fidothe/saxon-xslt)
@@ -54,16 +54,13 @@ For those familiar with the Saxon API, names are passed directly to the QName co
 Values are evaluated as XPath expressions in context of the document being transformed; this means
 that, to pass a string, you must pass an XPath that resolves to a string, i.e. "'You must wrap strings in quotes'"
 
-## Saxon version
-`saxon-xslt` 0.7 includes Saxon HE 9.5.1.7
-
 ## Differences between Saxon and Nokogiri
 
 Saxon uses a `Processor` class as its central object: it holds configuration information and acts as a Factory for creating documents or XSLT stylesheet compilers. Unless you need to tweak the config you don't need to worry about this – `saxon-xslt` creates a shared instance behind the scenes when you call `Saxon.XSLT` or `Saxon.XML`. If you need to change the configuration you can create your own instance of `Saxon::Processor` and pass it an open `File` pointing at a Saxon configuration file. (See http://www.saxonica.com/documentation/index.html#!configuration/configuration-file for details of the configuration file.) Once you have a `Saxon::Processor` instance you can call the `XML` and `XSLT` methods on it directly:
 
 ```ruby
 require 'saxon-xslt'
-processor = Saxon::Processor.new(File.open('/path/to/config.xml'))
+processor = Saxon::Processor.create(File.open('/path/to/config.xml'))
 transformer = processor.XSLT(File.open('/path/to/your.xsl'))
 input = processor.XML(File.open('/path/to/your.xml'))
 output = transformer.transform(input)
@@ -88,6 +85,24 @@ xslt = Saxon.XSLT("<xsl:stylesheet>...</xsl:stylesheet>",
 
 So, if you have other XSLT stylesheets in `/path/to/resources/` then your dynamically generated XSLT can refer to them with import statements like `<xsl:import href="other_stylesheet.xsl"/>`.
 
+## Saxon versions (HE, PE, EE)
+`saxon-xslt` 0.8.2 includes Saxon HE 9.8.0.6 - you don't need to download Saxon yourself. Saxon PE and EE are paid-for versions with more features.
+
+If you have a license for Saxon PE or EE, then you can use them by passing their location and the location of your `.lic` license file in as follows:
+
+```ruby
+require 'saxon-xslt'
+
+# Tell us where your Saxon Jars are.
+Saxon::Loader.load!('/path/to/dir/containing/saxon-jars')
+# Create a licensed Configuration object
+config = Saxon::Configuration.create_licensed('/path/to/saxon-license.lic')
+# Create a Processor from your licensed Configuration
+processor = Saxon::Processor.create(config)
+# Go!
+transformer = processor.XSLT(File.open('/path/to/your.xsl'))
+```
+
 ## Contributing
 
 1. Fork it

data/lib/saxon/loader.rb

@@ -9,6 +9,8 @@ module Saxon
   module Loader
     LOAD_SEMAPHORE = Mutex.new
 
+    # Error raised if Saxon::Loader.load! is called but the path handed
+    # in does not exist or is not a directory
     class NoJarsError < StandardError
       def initialize(path)
         @path = path
@@ -19,6 +21,8 @@ module Saxon
       end
     end
 
+    # Error raised if Saxon::Loader.load! is called but the path handed
+    # in does not contain the Saxon .jars
     class MissingJarError < StandardError
       def initialize(path)
         @path = path
@@ -29,25 +33,10 @@ module Saxon
       end
     end
 
-    def self.main_jar(path)
-      ['saxon9he.jar', 'saxon9pe.jar', 'saxon9ee.jar'].map { |jar| path.join(jar) }.find { |jar| jar.file? }
-    end
-
-    def self.extra_jars(path)
-      optional = ['saxon9-unpack.jar', 'saxon9-sql.jar'].map { |jar| path.join(jar) }.select { |jar| jar.file? }
-      icu = path.children.find { |jar| jar.extname == '.jar' && !jar.basename.to_s.match(/^saxon-icu|^icu4j/).nil? }
-      ([icu] + optional).compact
-    end
-
-    def self.jars_not_on_classpath?
-      begin
-        Java::net.sf.saxon.s9api.Processor
-        false
-      rescue
-        true
-      end
-    end
-
+    # @param saxon_home [String, Pathname] the path to the dir containing
+    #   Saxon's .jars. Defaults to the vendored Saxon HE
+    # @return [true, false] Returns true if Saxon had not been loaded and
+    #   is now, and false if Saxon was already loaded
     def self.load!(saxon_home = File.expand_path('../../../vendor/saxonica', __FILE__))
       return false if @saxon_loaded
       LOAD_SEMAPHORE.synchronize do
@@ -73,6 +62,25 @@ module Saxon
 
     private
 
+    def self.main_jar(path)
+      ['saxon9he.jar', 'saxon9pe.jar', 'saxon9ee.jar'].map { |jar| path.join(jar) }.find { |jar| jar.file? }
+    end
+
+    def self.extra_jars(path)
+      optional = ['saxon9-unpack.jar', 'saxon9-sql.jar'].map { |jar| path.join(jar) }.select { |jar| jar.file? }
+      icu = path.children.find { |jar| jar.extname == '.jar' && !jar.basename.to_s.match(/^saxon-icu|^icu4j/).nil? }
+      ([icu] + optional).compact
+    end
+
+    def self.jars_not_on_classpath?
+      begin
+        Java::net.sf.saxon.s9api.Processor
+        false
+      rescue
+        true
+      end
+    end
+
     def self.add_jars_to_classpath!(saxon_home, jars)
       jars.each do |jar|
         $CLASSPATH << jar.to_s

data/lib/saxon/xslt.rb

@@ -91,17 +91,30 @@ module Saxon
 
       private
 
-      def set_params(transformer, document, params)
+      def resolve_q_name(q_name_or_string)
+        case q_name_or_string
+        when S9API::QName
+          q_name_or_string
+        else
+          S9API::QName.new(q_name_or_string.to_s)
+        end
+      end
+
+      def params_as_kv_pairs(params)
         case params
         when Hash
-          params.each do |k,v|
-            transformer.setParameter(S9API::QName.new(k.to_s), document.xpath(v))
-          end
+          params
         when Array
-          params.each_slice(2) do |k,v|
+          params.each_slice(2).map { |k,v|
             raise ArgumentError.new("Odd number of values passed as params: #{params}") if v.nil?
-            transformer.setParameter(S9API::QName.new(k.to_s), document.xpath(v))
-          end
+            [k, v]
+          }
+        end
+      end
+
+      def set_params(transformer, document, params)
+        params_as_kv_pairs(params).each do |k,v|
+          transformer.setParameter(resolve_q_name(k), document.xpath(v))
         end
       end
     end

data/lib/saxon/xslt/version.rb

@@ -1,5 +1,5 @@
 module Saxon
   module XSLT
-    VERSION = "0.8.1"
+    VERSION = "0.8.2"
   end
 end

data/spec/fixtures/params-eg.xsl

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:eg="http://example.org/ns" version="2.0" exclude-result-prefixes="eg">
   <xsl:param name="testparam">default</xsl:param>
+  <xsl:param name="eg:qname-param" select="false()"/>
   <xsl:template match="input">
     <xsl:choose>
       <xsl:when test="$testparam = 'default'">
@@ -17,5 +18,8 @@
         </output>
       </xsl:otherwise>
     </xsl:choose>
+    <xsl:if test="$eg:qname-param">
+      <qname-param/>
+    </xsl:if>
   </xsl:template>
 </xsl:stylesheet>

data/spec/saxon/xslt_spec.rb

@@ -101,7 +101,20 @@ describe Saxon::XSLT do
           let(:result) { xsl.transform(xml, ["testparam", "local-name(/input)"]) }
 
           it "should contain the name of the tag" do
-          expect(result.to_s.strip).to include('Select works')
+            expect(result.to_s.strip).to include('Select works')
+          end
+        end
+
+        context "passing a QName-using param" do
+          let(:result) { xsl.transform(xml, {Saxon::S9API::QName.fromClarkName('{http://example.org/ns}qname-param') =>  "true()"}) }
+
+          it "should not contain the qname-related output when the param isn't passed" do
+            result = xsl.transform(xml)
+            expect(result.to_s.strip).to_not include('<qname-param/>')
+          end
+
+          it "should contain the qname-related outputtag" do
+            expect(result.to_s.strip).to include('<qname-param/>')
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saxon-xslt
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: java
 authors:
 - Matt Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement