schematronium 0.0.0-java

data/lib/schematronium.rb

@@ -0,0 +1,55 @@
+require 'saxon-xslt'
+require 'nokogiri' # Used for output parsing - there doesn't seem to be a clean way to manipulate Saxon::XML documents
+
+# Library for running Schematron validators over XML documents
+class Schematronium
+  # Constructor for schematron checker
+  #
+  # @param [String, IO, File] schematron A schematron document, as either an IO object responding to #read,
+  #   a filename, or a [String]
+  def initialize(schematron)
+    stages = %w|iso_dsdl_include.xsl
+                iso_abstract_expand.xsl
+                iso_svrl_for_xslt2.xsl|.map{|s| iso_file s}
+
+    schematron = case schematron
+                 when IO
+                   Saxon.XML(schematron.read)
+                 when String
+                   if File.file? schematron
+                     Saxon.XML(File.open(schematron))
+                   else
+                     Saxon.XML(schematron)
+                   end
+                 end
+
+    # Run schematron through each stage of the iso_schematron pipeline
+    #    then stringify the final result because Saxon.XSLT can't take
+    #    an XML doc as input
+    @sch_script = Saxon.XSLT(
+      stages.reduce(schematron) do |result, stage|
+        stage.transform(result)
+      end.to_s
+    )
+  end
+
+  # Run schematron over xml document, returning the resulting XML
+  #
+  # @param [Saxon::XML::Document, IO, File] xml An XML document
+  # @return [Nokogiri::XML::Document]
+  def check(xml)
+    xml = Saxon.XML(xml) unless xml.is_a? Saxon::XML::Document
+    xml = Nokogiri::XML(@sch_script.transform(xml).to_s)
+  end
+
+  private
+
+  # Helper method returning stages of iso_schematron XSLT transform
+  #
+  # @param [String] fname The filename of a stage in the iso_schematron XSLT
+  # @return [Saxon::XSLT::Stylesheet]
+  def iso_file(fname)
+    Saxon.XSLT(File.open(File.join(File.dirname(File.expand_path(__FILE__)), 'iso-schematron-xslt2', fname)))
+  end
+
+end

data/schematronium.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |gem|
+  gem.name = 'schematronium'
+  gem.version = '0.0.0'
+  gem.date = '2015-07-27'
+  gem.summary = 'Tool for running schematron against XML strings/files'
+  gem.description = 'Wraps the saxon-xslt wrapper for Saxon 9 HE, providing a simple (one function) interface for running a schematron against an XML string or file'
+  gem.authors = ['Dave Mayo']
+  gem.email = 'dave_mayo@harvard.edu'
+  gem.platform      = 'java'
+  gem.require_paths = ["lib"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test)/})
+
+  gem.homepage = 'http://github.com/harvard-library/schematronium'
+  gem.license = 'GPLv3'
+
+  # Runtime dependencies
+  gem.add_runtime_dependency "saxon-xslt", '~> 0.7'
+  gem.add_runtime_dependency "nokogiri", '~> 1.6'
+
+  gem.add_development_dependency "rake", '~> 10.4'
+  gem.add_development_dependency "minitest"
+
+end

data/test/test_data/schematron/test.sch

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema xmlns="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
+  <pattern>
+    <rule context="*:test">
+      <report test="*:testable">
+        There should be 'testable' elements within 'test's.
+      </report>
+    </rule>
+    <rule context="*:test/*:testable">
+      <assert test="@test-attr">Testables must have have the 'test-attr' attribute.</assert>
+    </rule>
+  </pattern>
+</schema>

data/test/test_data/xml/test.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<tests>
+  <test>
+    <testable test-attr="pass" />
+  </test>
+  <test>
+    <testable id="test1" />
+  </test>
+  <test/>
+</tests>

data/test/test_schematronium.rb

@@ -0,0 +1,22 @@
+require 'schematronium'
+require 'minitest'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+class SchematroniumTest < MiniTest::Test
+  def td(*path_segments)
+    File.join(File.expand_path(File.dirname(__FILE__)), 'test_data', *path_segments)
+  end
+
+  def setup
+    @stron = Schematronium.new(td('schematron', 'test.sch'))
+  end
+
+  def test_check_with_file
+    results = @stron.check(File.open(td('xml', 'test.xml')))
+    results.remove_namespaces!
+    assert_equal 1, results.xpath("//failed-assert").count, "Expects one failure"
+    assert_equal 2, results.xpath("//successful-report").count, "Expects two reports"
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: schematronium
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: java
+authors:
+- Dave Mayo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  name: saxon-xslt
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  name: nokogiri
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: minitest
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps the saxon-xslt wrapper for Saxon 9 HE, providing a simple (one function) interface for running a schematron against an XML string or file
+email: dave_mayo@harvard.edu
+executables:
+- schematronium
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/schematronium
+- lib/iso-schematron-xslt2/ExtractSchFromRNG-2.xsl
+- lib/iso-schematron-xslt2/ExtractSchFromXSD-2.xsl
+- lib/iso-schematron-xslt2/iso_abstract_expand.xsl
+- lib/iso-schematron-xslt2/iso_dsdl_include.xsl
+- lib/iso-schematron-xslt2/iso_schematron_message_xslt2.xsl
+- lib/iso-schematron-xslt2/iso_schematron_skeleton_for_saxon.xsl
+- lib/iso-schematron-xslt2/iso_svrl_for_xslt2.xsl
+- lib/iso-schematron-xslt2/readme.txt
+- lib/iso-schematron-xslt2/sch-messages-cs.xhtml
+- lib/iso-schematron-xslt2/sch-messages-de.xhtml
+- lib/iso-schematron-xslt2/sch-messages-en.xhtml
+- lib/iso-schematron-xslt2/sch-messages-fr.xhtml
+- lib/iso-schematron-xslt2/sch-messages-nl.xhtml
+- lib/iso-schematron-xslt2/schematron-skeleton-api.htm
+- lib/schematronium.rb
+- schematronium.gemspec
+- test/test_data/schematron/test.sch
+- test/test_data/xml/test.xml
+- test/test_schematronium.rb
+homepage: http://github.com/harvard-library/schematronium
+licenses:
+- GPLv3
+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: []
+rubyforge_project:
+rubygems_version: 2.4.6
+signing_key:
+specification_version: 4
+summary: Tool for running schematron against XML strings/files
+test_files:
+- test/test_data/schematron/test.sch
+- test/test_data/xml/test.xml
+- test/test_schematronium.rb