simple-xspec-wrapper 0.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3e02b434fbafea411396df460c7e471e81d81ebc9af452e2f227b3298405090
+  data.tar.gz: 9a1b5e3a6159228e6c28182949f5c1989a427e80b9b67f3bcff6082c6945cbc7
+SHA512:
+  metadata.gz: f34e2b402aa6410f23fee5c4c93ff34a803fb112c4797ed4642a187a711724bbe7881ab3b8159fd464d32b91a6ef7a518f5b45df73cce7ad420d8669a6fac788
+  data.tar.gz: 0c3a85b753a2f9bbe8b1fd9af63789ecae7c5ec0c918098e2655a754fb4113efd2c362240c86b7ffca7f96aafb17f7ac6830aef1be458b1afa855d9688b54f8a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.2.0.0

data/.travis.yml

@@ -0,0 +1,11 @@
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - jruby-9.1.15.0
+  - jruby-1.7.27
+jdk:
+  - oraclejdk8
+  - openjdk7
+cache: bundler
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@reprocessed.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple-xspec-wrapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    simple-xspec-wrapper (0.1.0-java)
+      saxon-xslt (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    saxon-xslt (0.8.2.1-java)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simple-xspec-wrapper!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matt Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Simple Xspec Wrapper
+
+A simple wrapper around Xspec to run, independently, all .xspec files in a folder hierarchy.
+
+It assumes XSLT.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-xspec-wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-xspec-wrapper
+
+## Usage
+
+    $ xspec /path/to/xspec
+
+It will run all `.xspec` files under the path you passed in.
+
+If you use Saxon PE or EE, then drop run the command from the directory your `saxon-license.lic` file is in and it'll pick that up and look in the `$SAXON_HOME` environment variable to find your copy of Saxon PE/EE (defaulting to `/opt/saxon` if that isn't set).
+
+    $ SAXON_HOME=/path/to/saxon_dir xspec /path/to/specs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fidothe/simple-xspec-wrapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). This gem bundles XSpec, which is released under the MIT License. A few parts of the XSpec codebase are released under the [Mozilla Public License](http://www.mozilla.org/MPL/).
+
+## Code of Conduct
+
+Everyone interacting in the Simple Xspec Wrapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fidothe/simple-xspec-wrapper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xspec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/xspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+
+require 'pathname'
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+require_relative '../lib/xspec'
+
+compiler = XSpec::Compiler.new
+suite = XSpec::Suite.new(compiler, ARGV[0])
+suite.run!
+exit 1 if suite.failures_or_errors?
+exit 0

data/lib/xspec/version.rb

@@ -0,0 +1,3 @@
+module XSpec
+  VERSION = "0.1.0"
+end

data/lib/xspec.rb

@@ -0,0 +1,256 @@
+require 'pathname'
+require 'saxon/xml'
+require 'saxon/xslt'
+
+module XSpec
+  XSPEC_DIR = Pathname.new(__dir__).join('../vendor/xspec-1.0.0')
+  XSPEC_CLASSPATH_ADDITION = XSPEC_DIR.join('java')
+
+  class Compiler
+    def processor
+      @processor ||= SaxonProcessorFactory.processor
+    end
+
+    def compile(xspec_path)
+      xspec_path = Pathname.new(xspec_path)
+      begin
+        SpecFile.new(processor, xspec_path, transformer(xspec_path))
+      rescue Exception => e
+        puts "Problem compiling XSpec file #{xspec_path}"
+        puts e
+        puts e.backtrace
+        nil
+      end
+    end
+
+    def transformer(xspec_path)
+      Saxon::XSLT::Stylesheet.new(compiled_xml(xspec_path))
+    end
+
+    def compiled_xml(xspec_path)
+      compiler.transform(processor.XML(xspec_path.open('r:utf-8')))
+    end
+
+    private
+
+    def compiler_path
+      @compiler_path ||= XSPEC_DIR.join('src/compiler/generate-xspec-tests.xsl')
+    end
+
+    def compiler
+      @compiler ||= processor.XSLT(compiler_path.open('r:utf-8'))
+    end
+  end
+
+  class Suite
+    attr_reader :compiler, :path
+
+    def initialize(compiler, path)
+      @compiler, @path = compiler, Pathname.new(path).realpath
+    end
+
+    def spec_files
+      @spec_files ||= Pathname.glob(path.join('**/*.xspec').to_s).map { |spec_path| compiler.compile(spec_path.realpath) }.compact
+    end
+
+    def run!
+      unless successful.empty?
+        puts "SUCCESSFUL:"
+        successful.each do |spec_file|
+          puts "+ #{simple_path(spec_file)}"
+        end
+      end
+      unless errors.empty?
+        puts "ERRORED:"
+        errors.each do |spec_file|
+          puts "+ #{simple_path(spec_file)}"
+          puts "    #{spec_file.error.split("\n").join("\n    ")}"
+        end
+      end
+      unless failures.empty?
+        puts "FAILURES:"
+        failures.each do |spec_file|
+          puts "+ #{simple_path(spec_file)}"
+          spec_file.failures.each do |failure|
+            puts "  - #{failure}"
+          end
+        end
+      end
+      errors.empty? && failures.empty?
+    end
+
+    def failures_or_errors?
+     !clean?
+    end
+
+    def clean?
+      failures.empty? && errors.empty?
+    end
+
+    private
+
+    def simple_path(spec_file)
+      spec_file.path.relative_path_from(Pathname.pwd)
+    end
+
+    def ensure_ran!
+      spec_files.each do |spec_file|
+        spec_file.run!
+      end
+    end
+
+    def failures
+      @failures ||= begin
+        ensure_ran!
+        spec_files.select { |spec_file| spec_file.failures? }
+      end
+    end
+
+    def errors
+      @errors ||= begin
+        ensure_ran!
+        spec_files.select { |spec_file| spec_file.errored? }
+      end
+    end
+
+    def successful
+      @successful ||= begin
+        ensure_ran!
+        spec_files.select { |spec_file| spec_file.successful? }
+      end
+    end
+  end
+
+  class SpecFile
+    attr_reader :processor, :path, :compiled_xspec, :failures, :error
+
+    def initialize(processor, path, compiled_xspec)
+      @processor, @path, @compiled_xspec = processor, path, compiled_xspec
+      @ran = false
+      @errored = false
+      @failures = []
+      @error = ''
+    end
+
+    def not_run?
+      !@ran
+    end
+
+    def ran?
+      @ran
+    end
+
+    def failures?
+      !@failures.empty?
+    end
+
+    def errored?
+      @errored
+    end
+
+    def successful?
+      !(failures? || errored?)
+    end
+
+    def run!
+      if not_run?
+        begin
+          @ran = true
+          output = compiled_xspec.transform_with_named_template(Saxon::S9API::QName.fromClarkName('{http://www.jenitennison.com/xslt/xspec}main'))
+          check_failures(output).each do |failure|
+            @failures << test_label(failure)
+          end
+        rescue Exception => e
+          @errored = true
+          @error = e.to_s
+        end
+      end
+    end
+
+    private
+
+    def check_failures(output)
+      output.xpath("//x:test[@successful = 'false']", 'x' => 'http://www.jenitennison.com/xslt/xspec').map { |failure|
+        Saxon::XML::Document.new(failure, processor)
+      }
+    end
+
+    def test_label(failure_node)
+      failure_node.xpath('ancestor-or-self::x:*[x:label]', 'x' => 'http://www.jenitennison.com/xslt/xspec').map { |label_parent|
+        Saxon::XML::Document.new(label_parent, processor).xpath('x:label/text()', 'x' => 'http://www.jenitennison.com/xslt/xspec').map { |label_node| label_node.to_s.strip }
+      }.reverse.join(' ')
+    end
+  end
+end
+
+class SaxonProcessorFactory
+  def self.processor
+    new.processor
+  end
+
+  def saxon_conf
+    license_file_path = Pathname.pwd.join('saxon-license.lic')
+    if license_file_path.file?
+      Saxon::Loader.load!(ENV['SAXON_HOME'] || '/opt/saxon')
+      Saxon::Configuration.create_licensed(license_file_path.to_s)
+    else
+      nil
+    end
+  end
+
+  def processor
+    Saxon::Processor.create(saxon_conf)
+  end
+end
+
+class Saxon::XSLT::Stylesheet
+  def xslt_transformer
+    ct = Thread.current
+    thread_instance_var_key = :"xslt_transformer_#{object_id}"
+    return ct.thread_variable_get(thread_instance_var_key) if ct.thread_variable?(thread_instance_var_key)
+    ct.thread_variable_set(thread_instance_var_key, @xslt.load)
+  end
+
+  def setup_and_run(document, params, output, transformer)
+    transformer.setInitialContextNode(document.to_java)
+    transformer.setDestination(output)
+    set_params(transformer, document, params)
+    transformer.transform
+  end
+
+  def transform(document, params = {})
+    output = Saxon::S9API::XdmDestination.new
+    setup_and_run(document, params, output, xslt_transformer)
+    doc = Saxon::XML::Document.new(output.getXdmNode, processor)
+    output.close
+    doc
+  end
+
+  def setup_and_run_template(template_qname, params, output, transformer)
+    transformer.setInitialTemplate(template_qname)
+    transformer.setDestination(output)
+    params_document = Saxon::XML('<empty/>')
+    set_params(transformer, params_document, params)
+    transformer.transform
+  end
+
+  def transform_with_named_template(template_qname, params = {})
+    output = Saxon::S9API::XdmDestination.new
+    setup_and_run_template(template_qname, params, output, xslt_transformer)
+    doc = Saxon::XML::Document.new(output.getXdmNode, processor)
+    output.close
+    doc
+  end
+end
+
+class Saxon::XML::Document
+  def xpath(expr, ns = {})
+    compiler = processor.to_java.new_xpath_compiler
+    ns.each do |prefix, url|
+      compiler.declareNamespace(prefix, url)
+    end
+    compiler.evaluate(expr, @xdm_document)
+  end
+end
+
+$CLASSPATH << XSpec::XSPEC_CLASSPATH_ADDITION.to_s

data/simple-xspec-wrapper.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-xspec-wrapper"
+  spec.version       = XSpec::VERSION
+  spec.authors       = ["Matt Patterson"]
+  spec.email         = ["matt@reprocessed.org"]
+
+  spec.summary       = %q{A simple wrapper to run a suite of XSpec tests independently}
+  spec.homepage      = "https://github.com/fidothe/simple-xspec-wrapper"
+  spec.license       = "MIT"
+
+  spec.platform      = 'java'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|\.ruby-version)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "saxon-xslt", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end