Breaking changes in v2.0

[AirQuick]

I'll keep this list updated. Please let us know if something is missing or if you find something bad.

For end users

• Saxon 9.7 is no longer supported
  • 9.8 or later is required
  • 9.9 is recommended
• Oxygen 19.x or older is no longer supported (due to its outdated built-in Saxon version)
  • 20.0 or later is required (add-on configuration)
  • The latest version (22.1) is recommended
• Namespaces require explicit declaration
  • On older versions of XSpec, some namespaces took effect by accident in your test descriptions. You might have been relying on such accidental namespaces without knowing it. On v2.0, you can't rely on such accidental behavior anymore. You need to declare namespaces in your test descriptions as you use them.
  • Example

    • On v1.6.0, this test description without xs declaration works by accident:

      <x:description stylesheet="test-target.xsl"
                     xmlns:x="http://www.jenitennison.com/xslt/xspec">
        <x:scenario label="Test">
          <x:call function="sum">
            <!-- Use `xs` without declaring it -->
            <x:param select="xs:integer('1')" />
          </x:call>
          <x:expect label="Expect" select="1" />
        </x:scenario>
      </x:description>

    • On v2.0, the same test fails:

      C:\xspec>bin\xspec.bat test.xspec
      ...
      Running Tests...
      ...
        XPST0081: Namespace prefix 'xs' has not been declared
      ...
      *** Error running the test suite

      You need to declare xs:

      <x:description stylesheet="test-target.xsl"
                     xmlns:x="http://www.jenitennison.com/xslt/xspec">
        <x:scenario label="Test">
          <x:call function="sum">
            <!-- Declare `xs`. The declaration can be placed in one of the ancestors instead
              (x:call, x:scenario or x:description) -->
            <x:param select="xs:integer('1')"
                     xmlns:xs="http://www.w3.org/2001/XMLSchema" />
          </x:call>
          <x:expect label="Expect" select="1" />
        </x:scenario>
      </x:description>

• x:expect[@test] is interpreted more strictly. (feat: reject suspicious x:expect[attribute(test)] #1245)

  @test	@as | @href | @select | child::node()	v1.6.0	v2.0
  Exists. An instance of xs:boolean.	Exists	@as | @href | @select | child::node() is ignored. XSLT: Warning message (Warn if x:expect is ambiguous (node-selection with boolean test attribute) #309) XQuery: No warning	Fatal error
  Exists. Not an instance of xs:boolean.	Not exists	x:expect is considered to expect an empty sequence	Fatal error

• x:param[@position] is designed more clearly. (attribute(position) works too differently from attribute(name) #1267)
• utils-library-at parameter for XQuery recognizes only #none. (refactor: split src/compiler/generate-*-utils.* #1149)

For those who access XSpec internals

(cc'ing @xspec/xspec, @xspec/maven-plugin, @xspec/oxygen-xml-editor-xspec-support, @vincentml)

• Files in src/compiler/ are renamed and restructured (Reorganize src/compiler/ #948)
  • Master files are renamed (refactor: rename compiler master files #1162)
  • Utils are restructured (refactor: split src/compiler/generate-*-utils.* #1149)
• Schematron XSpec is converted to XSLT in a single stylesheet (perf(schematron): convert Schematron to XSLT in single stylesheet #912)
• In Maven artifact, resource files are stored under io/xspec/xspec/impl/[original directory] (build(maven): put resources under unique root #979)
• iso-schematron/ is moved from src/schematron/ to lib/ (refactor(schematron): move iso-schematron files from src to lib #992)
• Coverage trace listener requires xspec.home or xspec.home.uri Java system property (refactor(xslt): ignore all src files in coverage trace #1142)
• test namespace is removed from the reporters (refactor(report): remove test prefix from reporters #1172)
• The test result report XML is restructured (not drastic)
  • x:expect/@test is reported separately and wrapped in expect-test-wrap (fix(report): report x:expect/attribute(test) separetely in report XML #1109)
    • Example
      • v1.6.0
        • x:expect/@test is mixed with the others
      • v2.0
        • x:expect/@test
        • x:expect except @test
  • x:call and x:context are wrapped in input-wrap (refactor(report): undeclare default ns when copying input to report XML #1113)
    • Example
      • v1.6.0
        • x:context
        • x:call
      • v2.0
        • x:context
        • x:call
  • (x:result|x:expect)/node() are wrapped in content-wrap (fix(report): undeclare default namespace when reporting results in XML #1133)
    • Example
      • v1.6.0
        • x:result
        • x:expect
      • v2.0
        • x:result
        • x:expect
  • test:ws is replaced with x:ws (refactor: replace test:ws with x:ws #1170)
    • Example
      • v1.6.0
      • v2.0

Only for those who might be interested

• Some files are no longer maintained
  • They are moved to misc/archive/

[AirQuick]

No more breaking changes are in sight.

As for the Oxygen XSpec Helper View, I've already made necessary changes in my local fork. I'll submit a pull request to https://github.com/xspec/oXygen-XML-editor-xspec-support/pulls as soon as we release XSpec v2.0. So I hope you won't have to do many things, @xspec/oxygen-xml-editor-xspec-support :)

[AirQuick]

Added #1245.

[AirQuick]

Added #1267.

[AirQuick]

As for the Oxygen XSpec Helper View, I've already made necessary changes in my local fork. I'll submit a pull request to https://github.com/xspec/oXygen-XML-editor-xspec-support/pulls as soon as we release XSpec v2.0. So I hope you won't have to do many things, @xspec/oxygen-xml-editor-xspec-support :)

Done: xspec/oXygen-XML-editor-xspec-support#44