epi_doc_validator 0.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31eba4f9eb1f3c5c9555a156f20fec249019d1f0323ecef39f28cf261682703c
+  data.tar.gz: 1f21040118e078e75fffa4e6d9e450bfef09855d630d54debfefeb5e9b370440
+SHA512:
+  metadata.gz: 6849499c88ab0de5683dad81afa76a96d81466b05906467cc11058a40c205f59e96b19ef890ef60f1f694066a1e777188c9c0f9012985020b40ef6aa0268ed51
+  data.tar.gz: 8e842cae8f40b099d9b3e5d123cdb48db253b2bd9006ff0c9382b4f7995f72b6992221d5ba547feedecf173ca89fa441cd77f712777f49fed2d473b3a372d684

data/.github/funding.yml

@@ -0,0 +1 @@
+custom: "https://tuftsgiving.org/giving-form.html?id=7&showarea=AR001037&areaid=601&recurring=true"

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Run tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['jruby', 'jruby-9.2.9.0']
+    name: Ruby ${{ matrix.ruby }} test
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Lint code
+        run: bundle exec rubocop

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/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_gem:
+  gnar-style:
+    - rubocop/rubocop_gem.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Max: 120
+  Severity: refactor
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/MutableConstant:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby jruby-9.2.11.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in the Perseids Project and
+its associated community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 within project spaces and when
+an individual is officially 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 perseids@tufts.edu. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'gnar-style'
+gem 'rake'
+gem 'rspec'
+gem 'rspec-its'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    epi_doc_validator (0.1.0-java)
+      nokogiri (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    gnar-style (0.13.0)
+      rubocop (>= 1.0.0, < 2.0)
+      rubocop-performance
+      rubocop-rails (~> 2.2.0)
+      thor
+    nokogiri (1.11.1-java)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2-java)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.2.1)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  epi_doc_validator!
+  gnar-style
+  rake
+  rspec
+  rspec-its
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 The Perseids Project
+
+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,101 @@
+# EpiDoc Validator
+
+JRuby library for validating [EpiDoc XML](https://sourceforge.net/p/epidoc/wiki/Home/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epi_doc_validator'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install epi_doc_validator
+```
+
+## Requirements
+
+* JRuby >= 9.2.9
+
+## Usage
+
+```ruby
+require 'epi_doc_validator'
+
+validator = EpiDocValidator::Validator.new
+xml = File.read('my-epi-doc-file.xml')
+
+# Validate against latest schema
+validator.valid?(xml) # => `true` or `false`
+
+# Validate against a specific schema version
+validator.valid?(xml, version: '9.1') # => `true` or `false`
+                                      # => raises exception if version doesn't exist
+
+# Get list of versions
+validator.versions # => `["8", "8-rc1", "8.2", ... , "dev", "latest"]`
+
+# Validate and return a list of errors
+validator.valid?(xml) # => array of errors (`[]` if valid)
+
+# Validate and return a list of errors for a specific schema version
+validator.valid?(xml, version: '9.1') # => array of errors (`[]` if valid)
+                                      # => raises exception if version doesn't exist
+```
+
+## Development
+
+### Setup
+
+* `bundle install`
+
+### Running tests
+
+* `bundle exec rspec`
+
+### Linting the code
+
+* `bundle exec rubocop`
+
+### Updating schemas
+
+* `bash scripts/update-schema.sh` (requires `wget`)
+
+### Publishing
+
+* Bump version in `lib/epi_doc_validator/version.rb`
+* Commit and push to GitHub
+* On GitHub, create a new release
+* Run `gem build epi_doc_validator.gemspec`
+* Run `gem push epi_doc_validator-X.Y.Z-java.gem`
+
+## Notes
+
+Currently, the library only works with JRuby.
+All of the code in *this* repository works with both Ruby MRI and JRuby.
+In the future we hope to release a version that works with Ruby MRI.
+
+The problem is that the EpiDoc schema is written in something called RELAX NG.
+Nokogiri, the main XML processing library for Ruby, uses `libxml2` with Ruby MRI
+and `jing` with JRuby. `jing` works correctly, but there are at least two long-standing
+bugs in `libxml2`'s RELAX NG validation code.
+Until these are fixed, this library is too unstable with Ruby MRI to release.
+
+List of (known) bugs:
+
+* 2008: "RNG internal error trying to compile notAllowed" warning is printed multiple times ([link](https://mail.gnome.org/archives/xml/2008-June/msg00087.html))
+* 2012: Validation never terminates on occasion ([link](https://github.com/sparklemotion/nokogiri/issues/806))
+
+For a more detailed explanation of this problem in a slightly different domain,
+see Hugh Cayless's post [Experiment: is the JavaScript port of libxml2 viable?](https://github.com/hcayless/brackets/blob/master/experiment_1.md):
+
+> Result: Inconclusive; lean towards endless screaming.

data/Rakefile

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

data/epi_doc_validator.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/epi_doc_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'epi_doc_validator'
+  spec.version       = EpiDocValidator::VERSION
+  spec.authors       = ['Perseids Project']
+  spec.email         = ['perseids@tufts.edu']
+
+  spec.summary       = 'Library for validating EpiDoc XML'
+  spec.description   = 'Library for validating EpiDoc XML'
+  spec.homepage      = 'https://github.com/perseids-tools/epi-doc-validator-rb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4')
+
+  spec.metadata['homepage_uri'] = 'https://github.com/perseids-tools/epi-doc-validator-rb'
+  spec.metadata['source_code_uri'] = 'https://github.com/perseids-tools/epi-doc-validator-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/perseids-tools/epi-doc-validator-rb/releases'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin|scripts)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.platform = 'java'
+
+  spec.add_dependency 'nokogiri', '~> 1.10'
+end

data/lib/epi_doc_validator.rb

@@ -0,0 +1,5 @@
+require 'epi_doc_validator/version'
+require 'epi_doc_validator/validator'
+
+module EpiDocValidator
+end

data/lib/epi_doc_validator/errors.rb

@@ -0,0 +1,7 @@
+module EpiDocValidator
+  class Error < StandardError
+  end
+
+  class VersionNotFoundError < Error
+  end
+end

data/lib/epi_doc_validator/sem_ver.rb

@@ -0,0 +1,60 @@
+module EpiDocValidator
+  class SemVer
+    def self.sort(versions)
+      versions.map { |v| new(v) }.sort.map(&:semver)
+    end
+
+    def initialize(semver)
+      @semver = semver
+
+      numbers, @patch = *semver.split('-')
+
+      if semver.match?(/\A\d/)
+        @components = numbers.split('.').map(&:to_i)
+      end
+    end
+
+    def <=>(other)
+      return 0 if semver == other.semver
+
+      return compare_strings(other) if string? || other.string?
+
+      compare_components(other)
+    end
+
+    attr_reader :semver
+
+    protected
+
+    attr_reader :components
+
+    def patch
+      @patch || ''
+    end
+
+    def string?
+      components.nil?
+    end
+
+    def value_at(index)
+      components[index] || 0
+    end
+
+    private
+
+    def compare_strings(other)
+      return 1 if string? && !other.string?
+      return -1 if !string? && other.string?
+
+      semver <=> other.semver if string? && other.string?
+    end
+
+    def compare_components(other, index = 0)
+      return patch <=> other.patch if !components[index] && !other.components[index]
+      return -1 if value_at(index) < other.value_at(index)
+      return 1 if value_at(index) > other.value_at(index)
+
+      compare_components(other, index + 1)
+    end
+  end
+end