saxon-rb 0.4.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 438d4b8ef09160fb03c5e6d4d03ef3577ab31052c26bd73d74826fda6ac26132
+  data.tar.gz: c3ca6f0bea6dd55f650074e02b7d81f9821a1677d45fe53c919f5d7163e47534
+SHA512:
+  metadata.gz: ebc091905a83b8733e9a1959970721b378160edabe6013043dd1f815393b3674781df53162b7d2e09f2140f6f7c8e258352ab15a114dbda17e1ca5e954425145
+  data.tar.gz: 0acc6ecd8b6e48bbe45da3b1405e13fde93db3eb62c4a191b4462ab493e31013bdf3ea3d0c48119422b49e906ec76891f44ee6dc631774109ea1cdada07196fa

data/.circleci/config.yml

@@ -0,0 +1,62 @@
+version: 2
+jobs:
+  test_vendored_saxon:
+    environment:
+      BUNDLE_JOBS: 3
+      BUNDLE_RETRY: 3
+      BUNDLE_PATH: vendor/bundle
+      JRUBY_OPTS: "--dev --debug"
+    docker:
+      - image: circleci/jruby:9.2.8.0-jdk
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - run:
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec spec --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  test_saxon_98:
+    environment:
+      BUNDLE_JOBS: 3
+      BUNDLE_RETRY: 3
+      BUNDLE_PATH: vendor/bundle
+      ALTERNATE_SAXON_HOME: /tmp/saxon
+      JRUBY_OPTS: "--dev --debug"
+    docker:
+      - image: circleci/jruby:9.2.8.0-jdk
+    steps:
+      - checkout
+      - run:
+          name: Download Saxon 9.8
+          command: |
+            mkdir /tmp/saxon
+            cd /tmp/saxon
+            curl -L -O https://sourceforge.net/projects/saxon/files/Saxon-HE/9.8/SaxonHE9-8-0-15J.zip
+            unzip SaxonHE9-8-0-15J.zip
+            rm -f SaxonHE9-8-0-15J.zip
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - run:
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec spec --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+workflows:
+  version: 2
+  build_and_test:
+    jobs:
+      - test_vendored_saxon
+      - test_saxon_98

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.2.6.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 saxon.gemspec
+gemspec name: 'saxon-rb'

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,43 @@
+# Saxon
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/saxon`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saxon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install saxon
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/saxon. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Saxon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/saxon/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+#require 'bundler/gem_tasks'
+require 'bundler/gem_helper'
+require 'rspec/core/rake_task'
+require 'jars/installer'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Install JAR dependencies"
+task :install_jars do
+  Jars::Installer.vendor_jars!
+end
+
+namespace :new_saxon do
+  Bundler::GemHelper.install_tasks(name: 'saxon-rb')
+end
+namespace :old_saxon do
+  Bundler::GemHelper.install_tasks(name: 'saxon')
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "saxon"
+
+# 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/lib/saxon.rb

@@ -0,0 +1,6 @@
+require_relative 'saxon/version'
+require_relative 'saxon/processor'
+
+# An idiomatic Ruby wrapper around the Saxon XML processing library.
+module Saxon
+end

data/lib/saxon/axis_iterator.rb

@@ -0,0 +1,31 @@
+require_relative 's9api'
+
+module Saxon
+  # An XPath Data Model Node object, representing an XML document, or an element or one of the other node chunks in the XDM.
+  class AxisIterator
+    include Enumerable
+
+    attr_reader :s9_xdm_node, :s9_axis
+    private :s9_xdm_node, :s9_axis
+
+    def initialize(xdm_node, axis)
+      @s9_xdm_node = xdm_node.to_java
+      @s9_axis = Saxon::S9API::Axis.const_get(axis.to_s.upcase.to_sym)
+    end
+
+    # @return [Saxon::S9API::XdmSequenceIterator] A new Saxon Java XDM sequence iterator.
+    def to_java
+      s9_sequence_iterator
+    end
+
+    def each(&block)
+      s9_sequence_iterator.lazy.map { |s9_xdm_node| Saxon::XDM::Node.new(s9_xdm_node) }.each(&block)
+    end
+
+    private
+
+    def s9_sequence_iterator
+      s9_xdm_node.axisIterator(s9_axis)
+    end
+  end
+end

data/lib/saxon/configuration.rb

@@ -0,0 +1,116 @@
+require 'saxon/s9api'
+require 'saxon/parse_options'
+
+module Saxon
+  # Wraps the <tt>net.saxon.Configuration</tt> class. See
+  # http://saxonica.com/documentation9.5/javadoc/net/sf/saxon/Configuration.html
+  # for details of what configuration options are available and what values
+  # they accept. See
+  # http://saxonica.com/documentation9.5/javadoc/net/sf/saxon/lib/FeatureKeys.html
+  # for details of the constant names used to access the values
+  class Configuration
+    DEFAULT_SEMAPHORE = Mutex.new
+
+    # Provides a processor with default configuration. Essentially a singleton
+    # instance
+    # @return [Saxon::Configuration]
+    def self.default
+      DEFAULT_SEMAPHORE.synchronize do
+        @config ||= create
+      end
+    end
+
+    # @param processor [Saxon::Processor] a Saxon::Processor instance
+    # @return [Saxon::Configuration]
+    def self.create(processor = nil)
+      Saxon::Loader.load!
+      if processor
+        config = processor.to_java.underlying_configuration
+      else
+        config = Saxon::S9API::Configuration.new
+      end
+      new(config)
+    end
+
+    # @param license_path [String] the absolute path to a Saxon PE or EE
+    #   license file
+    # @return [Saxon::Configuration]
+    def self.create_licensed(license_path)
+      Saxon::Loader.load!
+      java_config = Saxon::S9API::Configuration.makeLicensedConfiguration(nil, nil)
+      config = new(java_config)
+      config[:LICENSE_FILE_LOCATION] = license_path
+      config
+    end
+
+    # Set a already-created Licensed Configuration object as the default
+    # configuration
+    def self.set_licensed_default!(licensed_configuration)
+      DEFAULT_SEMAPHORE.synchronize do
+        @config = licensed_configuration
+      end
+    end
+
+    # @api private
+    # @param config [net.sf.saxon.Configuration] The Saxon Configuration
+    #   instance to wrap
+    def initialize(config)
+      @config = config
+    end
+
+    # Get a configuration option value
+    # See https://www.saxonica.com/html/documentation/javadoc/net/sf/saxon/lib/FeatureKeys.html
+    # for details of the available options. Use the constant name as a string
+    # or symbol as the option
+    #
+    # @param option [String, Symbol]
+    # @return [Object] the value of the configuration option
+    # @raise [NameError] if the option name does not exist
+    def [](option)
+      @config.getConfigurationProperty(option_url(option))
+    end
+
+    # Get a configuration option value
+    # See http://saxonica.com/documentation9.5/javadoc/net/sf/saxon/lib/FeatureKeys.html
+    # for details of the available options. Use the constant name as a string
+    # or symbol as the option
+    #
+    # @param option [String, Symbol]
+    # @param value [Object] the value of the configuration option
+    # @return [Object] the value you passed in
+    # @raise [NameError] if the option name does not exist
+    def []=(option, value)
+      url = option_url(option)
+      @config.setConfigurationProperty(url, value)
+    end
+
+    # Return the current ParseOptions object
+    # See https://www.saxonica.com/documentation/index.html#!javadoc/net.sf.saxon.lib/ParseOptions
+    # for details. This allows you to set JAXP features and properties to be
+    # passed to the parser
+    #
+    # @return [Saxon::ParseOptions] the ParseOptions object
+    def parse_options
+      ParseOptions.new(@config.getParseOptions)
+    end
+
+    # @return [net.sf.saxon.Configuration] The underlying Saxon Configuration
+    def to_java
+      @config
+    end
+
+    private
+
+    def feature_keys
+      @feature_keys ||= Saxon::S9API::FeatureKeys.java_class
+    end
+
+    def option_url(option)
+      feature_keys.field(normalize_option_name(option)).static_value
+    end
+
+    def normalize_option_name(option)
+      option.to_s.upcase
+    end
+  end
+end