mnconvert 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db64df9fcc103fb4480fe551d15bee77a84e07befa098ce5ec08677432843de0
+  data.tar.gz: e63588f245166fac64ffcc5850b1105008888d92ac44d82340b3ab1aebf6a2d8
+SHA512:
+  metadata.gz: 07ad349d564d950caea0be739b514828e738aca8c766384fdddbdcd503bee2d2e763fb199c16e0a3a9f10815e6b16a2245adc22143f34f1b6389c771121e4eee
+  data.tar.gz: 888db996e8a0df6dbe086d4771ca1effa769f9065f7ffd6aa2a2362400c85227e3d36a8b9f9bd838f1b7d3ada8d6aa7b1c2a013c588102dc03b82408bcad31f9

data/.github/workflows/rake.yml

@@ -0,0 +1,32 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.github/workflows/release-tag.yml

@@ -0,0 +1,49 @@
+name: release-tag
+
+on:
+  repository_dispatch:
+    types: [ metanorma/mnconvert ]
+
+jobs:
+  tag_repo:
+    runs-on: ubuntu-18.04
+    if: startsWith(github.event.client_payload.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v1
+      - name: Add writable remote
+        run: |
+          git config --global user.name metanorma-ci
+          git config --global user.email "metanorma-ci@users.noreply.github.com"
+          git remote add github https://metanorma-ci:${{ secrets.METANORMA_CI_PAT_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git pull github ${GITHUB_REF} --ff-only
+      - name: Parse mnconvert version
+        env:
+          mnconvert_TAG: ${{ github.event.client_payload.ref }}
+        run: |
+          echo mnconvert_VERSION=${mnconvert_TAG#*/v} >> ${GITHUB_ENV}
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install gem-release
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Update version
+        run: |
+          gem bump --version ${mnconvert_VERSION} --no-commit
+      - name: Update mnconvert.jar
+        run: |
+          rm -f bin/mnconvert.jar
+          rake bin/mnconvert.jar
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Push commit and tag
+        run: |
+          git add -u bin/mnconvert.jar lib/mnconvert/version.rb
+          git commit -m "Bump version to ${mnconvert_VERSION}"
+          git tag v${mnconvert_VERSION}
+          git push github HEAD:${GITHUB_REF} --tags

data/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Update mnconvert.jar
+        run: |
+          rm -f bin/mnconvert.jar
+          rake bin/mnconvert.jar
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
+        run: |
+          gem install gem-release
+          touch ~/.gem/credentials
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          git status
+          gem release

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+/.rubocop-http*
+
+/spec/fixtures/rice-en.cd.mn.xml
+/spec/fixtures/rice-en.final.sts.xml

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

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 ronald.tse@ribose.com. 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://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mnconvert.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.adoc

@@ -0,0 +1,53 @@
+= mnconvert Ruby gem
+
+image:https://img.shields.io/gem/v/mnconvert.svg["Gem Version", link="https://rubygems.org/gems/mnconvert"]
+image:https://github.com/metanorma/mnconvert-ruby/workflows/rake/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/mnconvert-ruby/actions/workflows/rake.yml"]
+image:https://codeclimate.com/github/metanorma/mnconvert-ruby/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/mnconvert-ruby"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/mnconvert-ruby.svg["Pull Requests", link="https://github.com/metanorma/mnconvert-ruby/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/mnconvert-ruby/latest.svg["Commits since latest",link="https://github.com/metanorma/mnconvert-ruby/releases"]
+
+== Purpose
+
+The mnconvert Ruby gem is a wrapper around the Java https://github.com/metanorma/mnconvert[mnconvert]
+which:
+
+* converts Metanorma presentational XML into various output formats, including
+  ISOSTS;
+* converts other formats to Metanorma AsciiDoc or Metanorma XML.
+
+This gem is used to provide mnconvert.jar with mirrored version numbers, to allow
+Ruby code to easily refer to the desired mnconvert version as dependencies.
+
+== Installation
+
+[source,ruby]
+----
+gem install mnconvert
+----
+
+Or include it in your gemspec.
+
+== Usage
+
+[source,ruby]
+----
+require 'mnconvert'
+MnConvert.convert(sample_xml_path, output_pdf_path)
+----
+
+== Updating the gem
+
+Update `lib/mnconvert/version.rb` to the desired version of
+https://github.com/metanorma/mnconvert[mnconvert].
+
+Run `rake` to download the `bin/mnconvert.jar` file:
+
+[source,ruby]
+----
+rm -f bin/mnconvert.jar
+rake bin/mnconvert.jar
+----
+
+Then release the gem with `rake release`.
+
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require_relative 'lib/mnconvert/version'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => ['bin/mnconvert.jar', 'spec/fixtures/rice-en.cd.mn.xml', 'spec/fixtures/rice-en.final.sts.xml', :spec]
+
+def uri_open(url)
+  require 'open-uri'
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5")
+    return open(url)
+  end
+  return URI.open(url)
+end
+
+file 'bin/mnconvert.jar' do |file|
+  ver = MnConvert::MNCONVERT_JAR_VERSION
+  url = "https://github.com/metanorma/mnconvert/releases/download/v#{ver}/mnconvert-#{ver}.jar"
+  File.open(file.name, 'wb') do |file|
+    file.write uri_open(url).read
+  end
+end
+
+file 'spec/fixtures/rice-en.cd.mn.xml' do |file|
+  uri = "https://raw.githubusercontent.com/metanorma/mn-samples-iso/gh-pages/documents/international-standard/rice-en.cd.xml"
+
+  File.open(file.name, "w") do |saved_file|
+    saved_file.write(uri_open(uri).read)
+  end
+end
+
+file 'spec/fixtures/rice-en.final.sts.xml' do |file|
+  uri = "https://raw.githubusercontent.com/metanorma/sts2mn/master/src/test/resources/rice-en.final.sts.xml"
+
+  File.open(file.name, "w") do |saved_file|
+    saved_file.write(uri_open(uri).read)
+  end
+end

data/bin/console

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

@@ -0,0 +1,101 @@
+require "open3"
+require "mnconvert/version"
+
+module MnConvert
+  module InputFormat
+    MN = :metanorma
+    STS = :sts
+  end
+
+  MNCONVERT_JAR_PATH = File.join(File.dirname(__FILE__), "../bin/mnconvert.jar")
+
+  def self.jvm_options
+    options = ["-Xss5m", "-Xmx1024m"]
+
+    if RbConfig::CONFIG["host_os"].match?(/darwin|mac os/)
+      options << "-Dapple.awt.UIElement=true"
+    end
+
+    options
+  end
+
+  def self.help
+    cmd = ["java", *jvm_options, "-jar", MNCONVERT_JAR_PATH].join(" ")
+    message, = Open3.capture3(cmd)
+    message
+  end
+
+  def self.version
+    cmd = ["java", *jvm_options, "-jar", MNCONVERT_JAR_PATH, "-v"].join(" ")
+    message, = Open3.capture3(cmd)
+    message.strip
+  end
+
+  def self.convert(input_file, output_file, input_format, opts = {})
+    validate(opts, input_format)
+
+    cmd = ["java", *jvm_options, "-jar", MNCONVERT_JAR_PATH,
+           input_file, "--input-format", input_format,
+           "--output", output_file, *optional_opts(opts)].join(" ")
+
+    puts cmd if opts[:debug]
+    output_str, error_str, status = Open3.capture3(cmd)
+    p output_str if opts[:debug]
+
+    unless status.success?
+      raise error_str
+    end
+  end
+
+  class << self
+    private
+
+    def validate(opts, input_format)
+      output_format = opts[:output_format]
+
+      case input_format
+      when InputFormat::MN
+        validate_mn(opts, output_format)
+      when InputFormat::STS
+        validate_sts(opts, output_format)
+      else
+        raise StandardError.new("Invalid input format: #{input_format}")
+      end
+    end
+
+    def validate_mn(opts, output_format)
+      unless output_format.nil? || %w(iso niso).include?(output_format.to_s)
+        raise StandardError.new("Invalid output format: #{output_format}")
+      end
+
+      if opts[:split_bibdata]
+        raise StandardError.new("split_bibdata valid only for sts input")
+      end
+
+      if opts[:sts_type]
+        raise StandardError.new("sts_type valid only for sts input")
+      end
+    end
+
+    def validate_sts(_opts, output_format)
+      unless output_format.nil? || %w(xml adoc).include?(output_format.to_s)
+        raise StandardError.new("Invalid output format: #{output_format}")
+      end
+    end
+
+    def optional_opts(opts)
+      result = {
+        sts_type: "--type",
+        imagesdir: "--imagesdir",
+        check_type: "--check-type",
+        output_format: "--output-format",
+        xsl_file: "--xsl-file",
+      }.reject { |k, _| opts[k].nil? }.map { |k, v| "#{v} #{opts[k]}" }
+
+      result << "--debug" if opts[:debug]
+      result << "--split-bibdata" if opts[:split_bibdata]
+
+      result
+    end
+  end
+end

data/lib/mnconvert/version.rb

@@ -0,0 +1,4 @@
+module MnConvert
+  VERSION = "1.8.0"
+  MNCONVERT_JAR_VERSION = VERSION
+end

data/mnconvert.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/mnconvert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mnconvert"
+  spec.version       = MnConvert::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "mnconvert converts Metanorma XML into NISO STS XML."
+  spec.description   = <<~DESCRIPTION
+    mnconvert converts Metanorma XML into NISO STS XML.
+    This gem is a wrapper around mnconvert.jar available from
+    https://github.com/metanorma/mnconvert, with versions matching the JAR file.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/mnconvert-ruby"
+  spec.license       = "BSD-2-Clause"
+
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mnconvert
+version: !ruby/object:Gem::Version
+  version: 1.8.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-08 00:00:00.000000000 Z
+dependencies: []
+description: |
+  mnconvert converts Metanorma XML into NISO STS XML.
+  This gem is a wrapper around mnconvert.jar available from
+  https://github.com/metanorma/mnconvert, with versions matching the JAR file.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".github/workflows/release-tag.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/mnconvert.jar
+- bin/setup
+- lib/mnconvert.rb
+- lib/mnconvert/version.rb
+- mnconvert.gemspec
+homepage: https://github.com/metanorma/mnconvert-ruby
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: mnconvert converts Metanorma XML into NISO STS XML.
+test_files: []