sts2mn 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d0c61e1a614f6a902b358555775dba82fb7c3cf4011585bc8793ef4be7a3f70
+  data.tar.gz: 55b6e31498540d084b0e72d1e93c472c8405174937e539e5d5f38de8e402e162
+SHA512:
+  metadata.gz: 1c7d5abe6eb7d567bc399a795def6005e504d8c06c9261789ddebc04b073258dc714648313297a03f964270fa230a7bd9f5aff7a470c0fa89dee0b8efb72b49c
+  data.tar.gz: 521a002871ff644394795f60befac6722c082e17e5c654515db885df328a42b050c5d51e816d0f0ff967b955668d805ca2cbe05dbb6a78c8ff8b73d3ffd9011c

data/.github/workflows/macos.yml

@@ -0,0 +1,39 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

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

@@ -0,0 +1,49 @@
+name: release-tag
+
+on:
+  repository_dispatch:
+    types: [ metanorma/sts2mn ]
+
+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 "${GITHUB_ACTOR}"
+          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+          git remote add github https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git pull github ${GITHUB_REF} --ff-only
+      - name: Parse sts2mn version
+        env:
+          sts2mn_TAG: ${{ github.event.client_payload.ref }}
+        run: |
+          echo "::set-env name=sts2mn_VERSION::${sts2mn_TAG#*/v}"
+      - 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 ${sts2mn_VERSION} --no-commit
+      - name: Update sts2mn.jar
+        run: |
+          rm -f bin/sts2mn.jar
+          rake bin/sts2mn.jar
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Push commit and tag
+        run: |
+          git add -u bin/sts2mn.jar lib/sts2mn/version.rb
+          git commit -m "Bump version to ${sts2mn_VERSION}"
+          git tag v${sts2mn_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 sts2mn.jar
+        run: |
+          rm -f bin/sts2mn.jar
+          rake bin/sts2mn.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/.github/workflows/ubuntu.yml

@@ -0,0 +1,53 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake
+      - name: Trigger dependent repositories
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+        env:
+          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
+          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+        run: |
+          curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
+          [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
+          for repo in $DEPENDENT_REPOS
+          do
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
+          done

data/.github/workflows/windows.yml

@@ -0,0 +1,41 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.gitignore

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

data/.rspec

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

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 sts2mn.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/README.adoc

@@ -0,0 +1,60 @@
+= sts2mn Ruby gem
+
+image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
+image:https://github.com/metanorma/sts2mn-ruby/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/sts2mn-ruby/actions?query=workflow%3Aubuntu"]
+image:https://github.com/metanorma/sts2mn-ruby/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/sts2mn-ruby/actions?query=workflow%3Amacos"]
+image:https://github.com/metanorma/sts2mn-ruby/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/sts2mn-ruby/actions?query=workflow%3Awindows"]
+image:https://codeclimate.com/github/metanorma/sts2mn-ruby/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/sts2mn-ruby"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/sts2mn-ruby.svg["Pull Requests", link="https://github.com/metanorma/sts2mn-ruby/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/sts2mn-ruby/latest.svg["Commits since latest",link="https://github.com/metanorma/sts2mn-ruby/releases"]
+
+== Purpose
+
+The sts2mn Ruby gem is a wrapper around the Java https://github.com/metanorma/sts2mn[sts2mn]
+which converts NISO STS and ISOSTS into Metanorma XML and AsciiDoc files.
+
+This gem is used to provide sts2mn.jar with mirrored version numbers, to allow
+Ruby code to easily refer to the desired sts2mn version as dependencies.
+
+== Installation
+
+[source,ruby]
+----
+gem install sts2mn
+----
+
+Or include it in your gemspec.
+
+== Usage
+
+[source,ruby]
+----
+require 'sts2mn'
+Sts2mn.convert(input: 'test/sts.xml')
+# => generates 'test/sts.adoc', in Metanorma AsciiDoc
+
+Sts2mn.convert(input: 'test/sts.xml', output: 'another/path/mn.xml', format: 'xml')
+# => generates 'another/path/mn.xml' in Metanorma XML
+
+Sts2mn.convert(input: 'test/sts.xml', output: 'another/path/mn.adoc', format: 'adoc')
+# => generates 'another/path/mn.adoc' in Metanorma AsciiDoc
+
+Sts2mn.split_bibdata('test/sts.xml')
+# => generates 'test/sts.rxl' (Relaton XML) and 'test/mn.adoc' (Metanorma AsciiDoc)
+----
+
+== Updating the gem
+
+Update `lib/sts2mn/version.rb` to the desired version of https://github.com/metanorma/sts2mn[sts2mn].
+
+Run `rake` to download the `bin/sts2mn.jar` file:
+
+[source,ruby]
+----
+rm -f bin/sts2mn.jar
+rake bin/sts2mn.jar
+----
+
+Then release the gem with `rake release`.
+
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require_relative 'lib/sts2mn/version'
+require 'open-uri'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => ['bin/sts2mn.jar', 'spec/fixtures/rice-en.final.sts.xml', :spec]
+
+require 'open-uri'
+
+file 'bin/sts2mn.jar' do |file|
+  ver = Sts2mn::STS2MN_JAR_VERSION
+  url = "https://github.com/metanorma/sts2mn/releases/download/v#{ver}/sts2mn-#{ver}.jar"
+  File.open(file.name, 'wb') do |file|
+    file.write open(url).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|
+    # the following "open" is provided by open-uri
+    open(uri, "r") do |read_file|
+      saved_file.write(read_file.read)
+    end
+  end
+
+end

data/bin/console

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

@@ -0,0 +1,61 @@
+require 'open3'
+require 'sts2mn/version'
+
+module Sts2mn
+  STS2MN_JAR_PATH = File.join(File.dirname(__FILE__), '../bin/sts2mn.jar')
+
+  def self.help
+    cmd = ['java', '-jar', STS2MN_JAR_PATH].join(' ')
+    message, error_str, status = Open3.capture3(cmd)
+    message
+  end
+
+  def self.version
+    cmd = ['java', '-jar', STS2MN_JAR_PATH, '-v'].join(' ')
+    message, error_str, status = Open3.capture3(cmd)
+    message.strip
+  end
+
+  def self.split_bibdata(input_path)
+    return if input_path.nil?
+
+    cmd = ['java', '-Xss5m', '-Xmx1024m', '-jar', STS2MN_JAR_PATH,
+           '--split-bibdata', input_path].join(' ')
+    # puts cmd
+    _, error_str, status = Open3.capture3(cmd)
+
+    unless status.success?
+      warn error_str
+      raise error_str
+    end
+  end
+
+  def self.convert(input:, output: nil, format: nil)
+    return if input.nil?
+
+    cmd = ['java', '-Xss5m', '-Xmx1024m', '-jar', STS2MN_JAR_PATH]
+
+    case format.to_s
+    when 'xml', 'adoc'
+      cmd << ['--format', format.to_s]
+    else
+      raise 'Unknown format option provided to Sts2mn.convert'
+    end unless format.nil?
+
+    unless output.nil?
+      cmd << ['--output', output.to_s]
+    end
+
+    cmd << [input.to_s]
+
+    cmd = cmd.join(' ')
+    # puts cmd
+    _, error_str, status = Open3.capture3(cmd)
+
+    unless status.success?
+      warn error_str
+      raise error_str
+    end
+  end
+
+end

data/lib/sts2mn/version.rb

@@ -0,0 +1,4 @@
+module Sts2mn
+  STS2MN_JAR_VERSION = '1.0'
+  VERSION = "#{STS2MN_JAR_VERSION}.0"
+end

data/mn2sts.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/sts2mn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sts2mn"
+  spec.version       = Sts2mn::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "sts2mn converts NISO STS XML into Metanorma XML."
+  spec.description   = <<~DESCRIPTION
+    sts2mn converts NISO STS XML into Metanorma XML.
+    This gem is a wrapper around sts2mn.jar available from
+    https://github.com/metanorma/sts2mn, with versions matching the JAR file.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/metanorma/sts2mn-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: sts2mn
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-29 00:00:00.000000000 Z
+dependencies: []
+description: |
+  sts2mn converts NISO STS XML into Metanorma XML.
+  This gem is a wrapper around sts2mn.jar available from
+  https://github.com/metanorma/sts2mn, with versions matching the JAR file.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/macos.yml"
+- ".github/workflows/release-tag.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ubuntu.yml"
+- ".github/workflows/windows.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sts2mn.jar
+- lib/sts2mn.rb
+- lib/sts2mn/version.rb
+- mn2sts.gemspec
+homepage: https://github.com/metanorma/sts2mn-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
+signing_key: 
+specification_version: 4
+summary: sts2mn converts NISO STS XML into Metanorma XML.
+test_files: []